Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix --help-aliases to match the description.
[simgrid.git] / src / xbt / config.cpp
index f7d8d81..deb5fc3 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved.     */
+/* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved.     */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 #include <map>
 #include <stdexcept>
 #include <string>
+#include <string>
 #include <type_traits>
 #include <typeinfo>
 #include <vector>
 
-#include <xbt/ex.hpp>
-#include <xbt/config.h>
-#include <xbt/config.hpp>
+#include "simgrid/sg_config.hpp"
+#include "xbt/dynar.h"
+#include "xbt/log.h"
 #include "xbt/misc.h"
 #include "xbt/sysdep.h"
-#include "xbt/log.h"
-#include "xbt/dynar.h"
+#include <xbt/config.h>
+#include <xbt/config.hpp>
+#include <xbt/ex.hpp>
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_cfg, xbt, "configuration support");
 
-XBT_EXPORT_NO_IMPORT(xbt_cfg_t) simgrid_config = nullptr;
-extern "C" {
-  XBT_PUBLIC(void) sg_config_finalize();
-}
+XBT_EXPORT_NO_IMPORT xbt_cfg_t simgrid_config = nullptr;
 
 namespace simgrid {
 namespace config {
 
-missing_key_error::~missing_key_error() = default;
-
-class Config;
-
 namespace {
 
 const char* true_values[] = {
@@ -148,8 +143,7 @@ public:
   /* Callback */
   xbt_cfg_cb_t old_callback = nullptr;
 
-  ConfigurationElement(const char* key, const char* desc)
-    : key(key ? key : ""), desc(desc ? desc : "") {}
+  ConfigurationElement(const char* key, const char* desc) : key(key ? key : ""), desc(desc ? desc : "") {}
   ConfigurationElement(const char* key, const char* desc, xbt_cfg_cb_t cb)
     : key(key ? key : ""), desc(desc ? desc : ""), old_callback(cb) {}
 
@@ -220,6 +214,7 @@ public:
   {
     this->content = std::move(value);
     this->update();
+    this->unsetDefault();
   }
 
   void setDefaultValue(T value)
@@ -262,12 +257,12 @@ class Config {
 private:
   // name -> ConfigElement:
   std::map<std::string, simgrid::config::ConfigurationElement*> options;
-  // alias -> xbt_dict_elm_t from options:
+  // alias -> ConfigElement from options:
   std::map<std::string, simgrid::config::ConfigurationElement*> aliases;
   bool warn_for_aliases = true;
 
 public:
-  Config() = default;
+  Config();
   ~Config();
 
   // No copy:
@@ -301,6 +296,10 @@ protected:
   ConfigurationElement* getDictElement(const char* name);
 };
 
+Config::Config()
+{
+  atexit(&sg_config_finalize);
+}
 Config::~Config()
 {
   XBT_DEBUG("Frees cfg set %p", this);
@@ -321,7 +320,7 @@ inline ConfigurationElement* Config::getDictElement(const char* name)
         XBT_INFO("Option %s has been renamed to %s. Consider switching.", name, res->getKey().c_str());
       return res;
     } else {
-      throw simgrid::config::missing_key_error(std::string("Bad config key: ") + name);
+      THROWF(not_found_error, 0, "Bad config key: %s", name);
     }
   }
 }
@@ -358,14 +357,11 @@ void Config::dump(const char *name, const char *indent)
   fflush(stdout);
 }
 
-/** @brief Displays the declared aliases and their description */
+/** @brief Displays the declared aliases and their replacement */
 void Config::showAliases()
 {
-  bool old_warn_for_aliases = false;
-  std::swap(warn_for_aliases, old_warn_for_aliases);
   for (auto const& elm : aliases)
-    printf("   %s: %s\n", elm.first.c_str(), (*this)[elm.first.c_str()].getDescription().c_str());
-  std::swap(warn_for_aliases, old_warn_for_aliases);
+    printf("   %-40s %s\n", elm.first.c_str(), elm.second->getKey().c_str());
 }
 
 /** @brief Displays the declared options and their description */
@@ -381,53 +377,52 @@ void Config::help()
 
 // ***** getConfig *****
 
-template<class T>
-XBT_PUBLIC(T const&) getConfig(const char* name)
+template <class T> XBT_PUBLIC T const& getConfig(const char* name)
 {
   return (*simgrid_config)[name].getValue<T>();
 }
 
-template XBT_PUBLIC(int const&) getConfig<int>(const char* name);
-template XBT_PUBLIC(double const&) getConfig<double>(const char* name);
-template XBT_PUBLIC(bool const&) getConfig<bool>(const char* name);
-template XBT_PUBLIC(std::string const&) getConfig<std::string>(const char* name);
+template XBT_PUBLIC int const& getConfig<int>(const char* name);
+template XBT_PUBLIC double const& getConfig<double>(const char* name);
+template XBT_PUBLIC bool const& getConfig<bool>(const char* name);
+template XBT_PUBLIC std::string const& getConfig<std::string>(const char* name);
 
 // ***** alias *****
 
-void alias(const char* realname, const char* aliasname)
+void alias(const char* realname, std::initializer_list<const char*> aliases)
 {
-  simgrid_config->alias(realname, aliasname);
+  for (auto const& aliasname : aliases)
+    simgrid_config->alias(realname, aliasname);
 }
 
 // ***** declareFlag *****
 
-template<class T>
-XBT_PUBLIC(void) declareFlag(const char* name, const char* description,
-  T value, std::function<void(const T&)> callback)
+template <class T>
+XBT_PUBLIC void declareFlag(const char* name, const char* description, T value, std::function<void(const T&)> callback)
 {
-  if (simgrid_config == nullptr) {
+  if (simgrid_config == nullptr)
     simgrid_config = xbt_cfg_new();
-    atexit(sg_config_finalize);
-  }
   simgrid_config->registerOption<T>(
     name, description, std::move(value), std::move(callback));
 }
 
-template XBT_PUBLIC(void) declareFlag(const char* name,
-  const char* description, int value, std::function<void(int const &)> callback);
-template XBT_PUBLIC(void) declareFlag(const char* name,
-  const char* description, double value, std::function<void(double const &)> callback);
-template XBT_PUBLIC(void) declareFlag(const char* name,
-  const char* description, bool value, std::function<void(bool const &)> callback);
-template XBT_PUBLIC(void) declareFlag(const char* name,
-  const char* description, std::string value, std::function<void(std::string const &)> callback);
-
+template XBT_PUBLIC void declareFlag(const char* name, const char* description, int value,
+                                     std::function<void(int const&)> callback);
+template XBT_PUBLIC void declareFlag(const char* name, const char* description, double value,
+                                     std::function<void(double const&)> callback);
+template XBT_PUBLIC void declareFlag(const char* name, const char* description, bool value,
+                                     std::function<void(bool const&)> callback);
+template XBT_PUBLIC void declareFlag(const char* name, const char* description, std::string value,
+                                     std::function<void(std::string const&)> callback);
 }
 }
 
 // ***** C bindings *****
 
-xbt_cfg_t xbt_cfg_new()        { return new simgrid::config::Config(); }
+xbt_cfg_t xbt_cfg_new()
+{
+  return new simgrid::config::Config();
+}
 void xbt_cfg_free(xbt_cfg_t * cfg) { delete *cfg; }
 
 void xbt_cfg_dump(const char *name, const char *indent, xbt_cfg_t cfg)
@@ -447,38 +442,29 @@ void xbt_cfg_register_double(const char *name, double default_value,
 
 void xbt_cfg_register_int(const char *name, int default_value,xbt_cfg_cb_t cb_set, const char *desc)
 {
-  if (simgrid_config == nullptr) {
+  if (simgrid_config == nullptr)
     simgrid_config = xbt_cfg_new();
-    atexit(&sg_config_finalize);
-  }
   simgrid_config->registerOption<int>(name, desc, default_value, cb_set);
 }
 
 void xbt_cfg_register_string(const char *name, const char *default_value, xbt_cfg_cb_t cb_set, const char *desc)
 {
-  if (simgrid_config == nullptr) {
+  if (simgrid_config == nullptr)
     simgrid_config = xbt_cfg_new();
-    atexit(sg_config_finalize);
-  }
-  simgrid_config->registerOption<std::string>(name, desc,
-    default_value ? default_value : "", cb_set);
+  simgrid_config->registerOption<std::string>(name, desc, default_value ? default_value : "", cb_set);
 }
 
 void xbt_cfg_register_boolean(const char *name, const char*default_value,xbt_cfg_cb_t cb_set, const char *desc)
 {
-  if (simgrid_config == nullptr) {
+  if (simgrid_config == nullptr)
     simgrid_config = xbt_cfg_new();
-    atexit(sg_config_finalize);
-  }
   simgrid_config->registerOption<bool>(name, desc, simgrid::config::parseBool(default_value), cb_set);
 }
 
 void xbt_cfg_register_alias(const char *realname, const char *aliasname)
 {
-  if (simgrid_config == nullptr) {
+  if (simgrid_config == nullptr)
     simgrid_config = xbt_cfg_new();
-    atexit(sg_config_finalize);
-  }
   simgrid_config->alias(realname, aliasname);
 }
 
@@ -500,80 +486,39 @@ void xbt_cfg_set_parse(const char *options)
   if (not options || not strlen(options)) { /* nothing to do */
     return;
   }
-  char *optionlist_cpy = xbt_strdup(options);
 
   XBT_DEBUG("List to parse and set:'%s'", options);
-  char *option = optionlist_cpy;
-  while (1) {                   /* breaks in the code */
-    if (not option)
-      break;
-    char *name = option;
-    int len = strlen(name);
-    XBT_DEBUG("Still to parse and set: '%s'. len=%d; option-name=%ld", name, len, (long) (option - name));
-
-    /* Pass the value */
-    while (option - name <= (len - 1) && *option != ' ' && *option != '\n' && *option != '\t' && *option != ',') {
-      XBT_DEBUG("Take %c.", *option);
-      option++;
-    }
-    if (option - name == len) {
-      XBT_DEBUG("Boundary=EOL");
-      option = nullptr;            /* don't do next iteration */
-    } else {
-      XBT_DEBUG("Boundary on '%c'. len=%d;option-name=%ld", *option, len, (long) (option - name));
-      /* Pass the following blank chars */
-      *(option++) = '\0';
-      while (option - name < (len - 1) && (*option == ' ' || *option == '\n' || *option == '\t')) {
-        option++;
-      }
-      if (option - name == len - 1)
-        option = nullptr;          /* don't do next iteration */
-    }
-    XBT_DEBUG("parse now:'%s'; parse later:'%s'", name, option);
-
-    if (name[0] == ' ' || name[0] == '\n' || name[0] == '\t')
+  std::string optionlist(options);
+  while (not optionlist.empty()) {
+    XBT_DEBUG("Still to parse and set: '%s'", optionlist.c_str());
+
+    // skip separators
+    size_t pos = optionlist.find_first_not_of(" \t\n,");
+    optionlist.erase(0, pos);
+    // find option
+    pos              = optionlist.find_first_of(" \t\n,");
+    std::string name = optionlist.substr(0, pos);
+    optionlist.erase(0, pos);
+    XBT_DEBUG("parse now:'%s'; parse later:'%s'", name.c_str(), optionlist.c_str());
+
+    if (name.empty())
       continue;
-    if (not strlen(name))
-      break;
 
-    char *val = strchr(name, ':');
-    xbt_assert(val, "Option '%s' badly formatted. Should be of the form 'name:value'", name);
-    /* don't free(optionlist_cpy) if the assert fails, 'name' points inside it */
-    *(val++) = '\0';
+    pos = name.find(':');
+    xbt_assert(pos != std::string::npos, "Option '%s' badly formatted. Should be of the form 'name:value'",
+               name.c_str());
 
-    if (strncmp(name, "path", strlen("path")))
-      XBT_INFO("Configuration change: Set '%s' to '%s'", name, val);
+    std::string val = name.substr(pos + 1);
+    name.erase(pos);
 
-    try {
-      (*simgrid_config)[name].setStringValue(val);
-    }
-    catch (simgrid::config::missing_key_error& e) {
-      goto on_missing_key;
-    }
-    catch (...) {
-      goto on_exception;
-    }
-  }
+    const std::string path("path");
+    if (name.compare(0, path.length(), path) != 0)
+      XBT_INFO("Configuration change: Set '%s' to '%s'", name.c_str(), val.c_str());
 
-  free(optionlist_cpy);
-  return;
-
-  /* Do not THROWF from a C++ exception catching context, or some cleanups will be missing */
-on_missing_key:
-  free(optionlist_cpy);
-  THROWF(not_found_error, 0, "Could not set variables %s", options);
-  return;
-on_exception:
-  free(optionlist_cpy);
-  THROWF(unknown_error, 0, "Could not set variables %s", options);
+    (*simgrid_config)[name.c_str()].setStringValue(val.c_str());
+  }
 }
 
-// Horrible mess to translate C++ exceptions to C exceptions:
-// Exit from the catch block (and do the correct exception cleaning) before attempting to THROWF.
-#define TRANSLATE_EXCEPTIONS(...) \
-  catch(simgrid::config::missing_key_error& e) { THROWF(not_found_error, 0, __VA_ARGS__); abort(); } \
-  catch(...) { THROWF(not_found_error, 0, __VA_ARGS__); abort(); }
-
 /** @brief Set the value of a variable, using the string representation of that value
  *
  * @param key name of the variable to modify
@@ -582,11 +527,7 @@ on_exception:
 
 void xbt_cfg_set_as_string(const char *key, const char *value)
 {
-  try {
-    (*simgrid_config)[key].setStringValue(value);
-    return;
-  }
-  TRANSLATE_EXCEPTIONS("Could not set variable %s as string %s", key, value);
+  (*simgrid_config)[key].setStringValue(value);
 }
 
 /** @brief Set an integer value to \a name within \a cfg if it wasn't changed yet
@@ -596,11 +537,7 @@ void xbt_cfg_set_as_string(const char *key, const char *value)
  */
 void xbt_cfg_setdefault_int(const char *key, int value)
 {
-  try {
-    (*simgrid_config)[key].setDefaultValue<int>(value);
-    return;
-  }
-  TRANSLATE_EXCEPTIONS("Could not set variable %s to default integer %i", key, value);
+  (*simgrid_config)[key].setDefaultValue<int>(value);
 }
 
 /** @brief Set an integer value to \a name within \a cfg if it wasn't changed yet
@@ -610,11 +547,7 @@ void xbt_cfg_setdefault_int(const char *key, int value)
  */
 void xbt_cfg_setdefault_double(const char *key, double value)
 {
-  try {
-    (*simgrid_config)[key].setDefaultValue<double>(value);
-    return;
-  }
-  TRANSLATE_EXCEPTIONS("Could not set variable %s to default double %f", key, value);
+  (*simgrid_config)[key].setDefaultValue<double>(value);
 }
 
 /** @brief Set a string value to \a name within \a cfg if it wasn't changed yet
@@ -624,11 +557,7 @@ void xbt_cfg_setdefault_double(const char *key, double value)
  */
 void xbt_cfg_setdefault_string(const char *key, const char *value)
 {
-  try {
-    (*simgrid_config)[key].setDefaultValue<std::string>(value ? value : "");
-    return;
-  }
-  TRANSLATE_EXCEPTIONS("Could not set variable %s to default string %s", key, value);
+  (*simgrid_config)[key].setDefaultValue<std::string>(value ? value : "");
 }
 
 /** @brief Set an boolean value to \a name within \a cfg if it wasn't changed yet
@@ -638,11 +567,7 @@ void xbt_cfg_setdefault_string(const char *key, const char *value)
  */
 void xbt_cfg_setdefault_boolean(const char *key, const char *value)
 {
-  try {
-    (*simgrid_config)[key].setDefaultValue<bool>(simgrid::config::parseBool(value));
-    return;
-  }
-  TRANSLATE_EXCEPTIONS("Could not set variable %s to default boolean %s", key, value);
+  (*simgrid_config)[key].setDefaultValue<bool>(simgrid::config::parseBool(value));
 }
 
 /** @brief Set an integer value to \a name within \a cfg
@@ -652,11 +577,7 @@ void xbt_cfg_setdefault_boolean(const char *key, const char *value)
  */
 void xbt_cfg_set_int(const char *key, int value)
 {
-  try {
-    (*simgrid_config)[key].setValue<int>(value);
-    return;
-  }
-  TRANSLATE_EXCEPTIONS("Could not set variable %s to integer %i", key, value);
+  (*simgrid_config)[key].setValue<int>(value);
 }
 
 /** @brief Set or add a double value to \a name within \a cfg
@@ -666,11 +587,7 @@ void xbt_cfg_set_int(const char *key, int value)
  */
 void xbt_cfg_set_double(const char *key, double value)
 {
-  try {
-    (*simgrid_config)[key].setValue<double>(value);
-    return;
-  }
-  TRANSLATE_EXCEPTIONS("Could not set variable %s to double %f", key, value);
+  (*simgrid_config)[key].setValue<double>(value);
 }
 
 /** @brief Set or add a string value to \a name within \a cfg
@@ -679,13 +596,9 @@ void xbt_cfg_set_double(const char *key, double value)
  * @param value the value to be added
  *
  */
-void xbt_cfg_set_string(const char *key, const char *value)
+void xbt_cfg_set_string(const char* key, const char* value)
 {
-  try {
-    (*simgrid_config)[key].setValue<std::string>(value ? value : "");
-    return;
-  }
-  TRANSLATE_EXCEPTIONS("Could not set variable %s to string %s", key, value);
+  (*simgrid_config)[key].setValue<std::string>(value);
 }
 
 /** @brief Set or add a boolean value to \a name within \a cfg
@@ -695,21 +608,14 @@ void xbt_cfg_set_string(const char *key, const char *value)
  */
 void xbt_cfg_set_boolean(const char *key, const char *value)
 {
-  try {
-    (*simgrid_config)[key].setValue<bool>(simgrid::config::parseBool(value));
-    return;
-  }
-  TRANSLATE_EXCEPTIONS("Could not set variable %s to boolean %s", key, value);
+  (*simgrid_config)[key].setValue<bool>(simgrid::config::parseBool(value));
 }
 
 
 /* Say if the value is the default value */
 int xbt_cfg_is_default_value(const char *key)
 {
-  try {
-    return (*simgrid_config)[key].isDefault() ? 1 : 0;
-  }
-  TRANSLATE_EXCEPTIONS("Could not get variable %s", key);
+  return (*simgrid_config)[key].isDefault() ? 1 : 0;
 }
 
 /*----[ Getting ]---------------------------------------------------------*/
@@ -721,10 +627,7 @@ int xbt_cfg_is_default_value(const char *key)
  */
 int xbt_cfg_get_int(const char *key)
 {
-  try {
-    return (*simgrid_config)[key].getValue<int>();
-  }
-  TRANSLATE_EXCEPTIONS("Could not get variable %s", key);
+  return (*simgrid_config)[key].getValue<int>();
 }
 
 /** @brief Retrieve a double value of a variable (get a warning if not uniq)
@@ -735,10 +638,7 @@ int xbt_cfg_get_int(const char *key)
  */
 double xbt_cfg_get_double(const char *key)
 {
-  try {
-    return (*simgrid_config)[key].getValue<double>();
-  }
-  TRANSLATE_EXCEPTIONS("Could not get variable %s", key);
+  return (*simgrid_config)[key].getValue<double>();
 }
 
 /** @brief Retrieve a string value of a variable (get a warning if not uniq)
@@ -751,12 +651,9 @@ double xbt_cfg_get_double(const char *key)
  *
  * \warning the returned value is the actual content of the config set
  */
-char *xbt_cfg_get_string(const char *key)
+std::string xbt_cfg_get_string(const char* key)
 {
-  try {
-    return (char*) (*simgrid_config)[key].getValue<std::string>().c_str();
-  }
-  TRANSLATE_EXCEPTIONS("Could not get variable %s", key);
+  return (*simgrid_config)[key].getValue<std::string>();
 }
 
 /** @brief Retrieve a boolean value of a variable (get a warning if not uniq)
@@ -768,10 +665,7 @@ char *xbt_cfg_get_string(const char *key)
  */
 int xbt_cfg_get_boolean(const char *key)
 {
-  try {
-    return (*simgrid_config)[key].getValue<bool>() ? 1 : 0;
-  }
-  TRANSLATE_EXCEPTIONS("Could not get variable %s", key);
+  return (*simgrid_config)[key].getValue<bool>() ? 1 : 0;
 }
 
 #ifdef SIMGRID_TEST
@@ -788,7 +682,7 @@ XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_cfg);
 
 XBT_TEST_SUITE("config", "Configuration support");
 
-XBT_PUBLIC_DATA(xbt_cfg_t) simgrid_config;
+XBT_PUBLIC_DATA xbt_cfg_t simgrid_config;
 
 static void make_set()
 {