Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of https://framagit.org/simgrid/simgrid
[simgrid.git] / src / xbt / config.cpp
index 762a5ec..416dfbb 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved.     */
+/* Copyright (c) 2004-2020. 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. */
@@ -12,6 +12,7 @@
 
 #include <functional>
 #include <map>
+#include <memory>
 #include <stdexcept>
 #include <string>
 #include <string>
@@ -37,25 +38,18 @@ namespace config {
 
 namespace {
 
-const char* true_values[] = {
-  "yes", "on", "true", "1"
-};
-const char* false_values[] = {
-  "no", "off", "false", "0"
-};
-
-static bool parse_bool(const char* value)
+bool parse_bool(const char* value)
 {
-  for (const char* const& true_value : true_values)
+  for (const char* true_value : {"yes", "on", "true", "1"})
     if (std::strcmp(true_value, value) == 0)
       return true;
-  for (const char* const& false_value : false_values)
+  for (const char* false_value : {"no", "off", "false", "0"})
     if (std::strcmp(false_value, value) == 0)
       return false;
   throw std::range_error("not a boolean");
 }
 
-static double parse_double(const char* value)
+double parse_double(const char* value)
 {
   char* end;
   errno = 0;
@@ -70,7 +64,7 @@ static double parse_double(const char* value)
     return res;
 }
 
-static long int parse_long(const char* value)
+long int parse_long(const char* value)
 {
   char* end;
   errno = 0;
@@ -96,9 +90,14 @@ template <class T> class ConfigType;
 template <> class ConfigType<int> {
 public:
   static constexpr const char* type_name = "int";
-  static inline double parse(const char* value)
+  static inline int parse(const char* value)
   {
-    return parse_long(value);
+    long val = parse_long(value);
+    if (val < INT_MIN)
+      throw std::range_error("underflow");
+    if (val > INT_MAX)
+      throw std::range_error("overflow");
+    return static_cast<int>(val);
   }
 };
 template <> class ConfigType<double> {
@@ -140,14 +139,7 @@ private:
   bool isdefault = true;
 
 public:
-  /* Callback */
-  xbt_cfg_cb_t old_callback = nullptr;
-
   ConfigurationElement(const std::string& key, const std::string& desc) : key(key), desc(desc) {}
-  ConfigurationElement(const std::string& key, const std::string& desc, xbt_cfg_cb_t cb)
-      : key(key), desc(desc), old_callback(cb)
-  {
-  }
 
   virtual ~ConfigurationElement() = default;
 
@@ -187,13 +179,10 @@ public:
   TypedConfigurationElement(const std::string& key, const std::string& desc, T value = T())
       : ConfigurationElement(key, desc), content(std::move(value))
   {}
-  TypedConfigurationElement(const std::string& key, const std::string& desc, T value, xbt_cfg_cb_t cb)
-      : ConfigurationElement(key, desc, cb), content(std::move(value))
-  {}
   TypedConfigurationElement(const std::string& key, const std::string& desc, T value, std::function<void(T&)> callback)
       : ConfigurationElement(key, desc), content(std::move(value)), callback(std::move(callback))
   {}
-  ~TypedConfigurationElement() = default;
+  ~TypedConfigurationElement() override = default;
 
   std::string get_string_value() override;
   const char* get_type_name() override;
@@ -201,8 +190,6 @@ public:
 
   void update()
   {
-    if (old_callback)
-      this->old_callback(get_key().c_str());
     if (this->callback)
       this->callback(this->content);
   }
@@ -223,7 +210,7 @@ public:
       this->update();
     } else {
       XBT_DEBUG("Do not override configuration variable '%s' with value '%s' because it was already set.",
-                get_key().c_str(), to_string(value).c_str());
+                get_key().c_str(), get_string_value().c_str());
     }
   }
 };
@@ -233,6 +220,12 @@ template <class T> std::string TypedConfigurationElement<T>::get_string_value()
   return to_string(content);
 }
 
+template <> std::string TypedConfigurationElement<double>::get_string_value() // override
+{
+  // don't want std::to_string which uses %f, and formats very small values as 0.000000
+  return xbt::string_printf("%g", content);
+}
+
 template <class T> void TypedConfigurationElement<T>::set_string_value(const char* value) // override
 {
   this->content = ConfigType<T>::parse(value);
@@ -252,14 +245,13 @@ template <class T> const char* TypedConfigurationElement<T>::get_type_name() //
 class Config {
 private:
   // name -> ConfigElement:
-  std::map<std::string, simgrid::config::ConfigurationElement*> options;
+  std::map<std::string, std::unique_ptr<ConfigurationElement>> options;
   // alias -> ConfigElement from options:
-  std::map<std::string, simgrid::config::ConfigurationElement*> aliases;
+  std::map<std::string, ConfigurationElement*> aliases;
   bool warn_for_aliases = true;
 
 public:
   Config();
-  ~Config();
 
   // No copy:
   Config(Config const&) = delete;
@@ -268,23 +260,22 @@ public:
   ConfigurationElement& operator[](const std::string& name);
   void alias(const std::string& realname, const std::string& aliasname);
 
-  template <class T, class... A>
-  simgrid::config::TypedConfigurationElement<T>* register_option(const std::string& name, A&&... a)
+  template <class T, class... A> TypedConfigurationElement<T>* register_option(const std::string& name, A&&... a)
   {
     xbt_assert(options.find(name) == options.end(), "Refusing to register the config element '%s' twice.",
                name.c_str());
-    TypedConfigurationElement<T>* variable = new TypedConfigurationElement<T>(name, std::forward<A>(a)...);
+    auto* variable = new TypedConfigurationElement<T>(name, std::forward<A>(a)...);
     XBT_DEBUG("Register cfg elm %s (%s) of type %s @%p in set %p)", name.c_str(), variable->get_description().c_str(),
               variable->get_type_name(), variable, this);
-    options.insert({name, variable});
+    options[name].reset(variable);
     variable->update();
     return variable;
   }
 
   // Debug:
-  void dump(const char *name, const char *indent);
-  void show_aliases();
-  void help();
+  void dump(const char* name, const char* indent) const;
+  void show_aliases() const;
+  void help() const;
 
 protected:
   ConfigurationElement* get_dict_element(const std::string& name);
@@ -294,18 +285,12 @@ Config::Config()
 {
   atexit(&sg_config_finalize);
 }
-Config::~Config()
-{
-  XBT_DEBUG("Frees cfg set %p", this);
-  for (auto const& elm : options)
-    delete elm.second;
-}
 
 inline ConfigurationElement* Config::get_dict_element(const std::string& name)
 {
   auto opt = options.find(name);
   if (opt != options.end()) {
-    return opt->second;
+    return opt->second.get();
   } else {
     auto als = aliases.find(name);
     if (als != aliases.end()) {
@@ -314,7 +299,10 @@ inline ConfigurationElement* Config::get_dict_element(const std::string& name)
         XBT_INFO("Option %s has been renamed to %s. Consider switching.", name.c_str(), res->get_key().c_str());
       return res;
     } else {
-      THROWF(not_found_error, 0, "Bad config key: %s", name.c_str());
+      std::string msg = "Bad config key: " + name + "\nExisting config keys:\n";
+      for (auto const& elm : options)
+        msg += "  " + elm.first + ": (" + elm.second->get_type_name() + ")" + elm.second->get_string_value() + "\n";
+      throw std::out_of_range(msg);
     }
   }
 }
@@ -332,40 +320,38 @@ void Config::alias(const std::string& realname, const std::string& aliasname)
   this->aliases.insert({aliasname, element});
 }
 
-/** @brief Dump a config set for debuging purpose
+/** @brief Dump a config set for debugging purpose
  *
  * @param name The name to give to this config set
  * @param indent what to write at the beginning of each line (right number of spaces)
  */
-void Config::dump(const char *name, const char *indent)
+void Config::dump(const char* name, const char* indent) const
 {
   if (name)
-    printf("%s>> Dumping of the config set '%s':\n", indent, name);
+    XBT_CVERB(xbt_help, "%s>> Dumping of the config set '%s':", indent, name);
 
   for (auto const& elm : options)
-    printf("%s  %s: ()%s) %s", indent, elm.first.c_str(), elm.second->get_type_name(),
-           elm.second->get_string_value().c_str());
+    XBT_CVERB(xbt_help, "%s  %s: ()%s) %s", indent, elm.first.c_str(), elm.second->get_type_name(),
+              elm.second->get_string_value().c_str());
 
   if (name)
-    printf("%s<< End of the config set '%s'\n", indent, name);
-  fflush(stdout);
+    XBT_CVERB(xbt_help, "%s<< End of the config set '%s'", indent, name);
 }
 
 /** @brief Displays the declared aliases and their replacement */
-void Config::show_aliases()
+void Config::show_aliases() const
 {
   for (auto const& elm : aliases)
-    printf("   %-40s %s\n", elm.first.c_str(), elm.second->get_key().c_str());
+    XBT_HELP("   %-40s %s", elm.first.c_str(), elm.second->get_key().c_str());
 }
 
 /** @brief Displays the declared options and their description */
-void Config::help()
+void Config::help() const
 {
   for (auto const& elm : options) {
-    simgrid::config::ConfigurationElement* variable = this->options.at(elm.first);
-    printf("   %s: %s\n", elm.first.c_str(), variable->get_description().c_str());
-    printf("       Type: %s; ", variable->get_type_name());
-    printf("Current value: %s\n", variable->get_string_value().c_str());
+    simgrid::config::ConfigurationElement* variable = elm.second.get();
+    XBT_HELP("   %s: %s", elm.first.c_str(), variable->get_description().c_str());
+    XBT_HELP("       Type: %s; Current value: %s", variable->get_type_name(), variable->get_string_value().c_str());
   }
 }
 
@@ -495,139 +481,14 @@ void help()
 }
 }
 
-// ***** C bindings *****
-
-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)
-{
-  cfg->dump(name, indent);
-}
-
-/*----[ Registering stuff ]-----------------------------------------------*/
-
-void xbt_cfg_register_double(const char *name, double default_value,
-  xbt_cfg_cb_t cb_set, const char *desc)
-{
-  if (simgrid_config == nullptr)
-    simgrid_config = new simgrid::config::Config();
-  simgrid_config->register_option<double>(name, desc, default_value, cb_set);
-}
-
-void xbt_cfg_register_int(const char *name, int default_value,xbt_cfg_cb_t cb_set, const char *desc)
-{
-  if (simgrid_config == nullptr)
-    simgrid_config = new simgrid::config::Config();
-  simgrid_config->register_option<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)
-    simgrid_config = new simgrid::config::Config();
-  simgrid_config->register_option<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)
-    simgrid_config = new simgrid::config::Config();
-  simgrid_config->register_option<bool>(name, desc, simgrid::config::parse_bool(default_value), cb_set);
-}
-
-void xbt_cfg_register_alias(const char *realname, const char *aliasname)
-{
-  if (simgrid_config == nullptr)
-    simgrid_config = new simgrid::config::Config();
-  simgrid_config->alias(realname, aliasname);
-}
-
-void xbt_cfg_aliases()
-{
-  simgrid_config->show_aliases();
-}
-void xbt_cfg_help()
-{
-  simgrid_config->help();
-}
-
 /*----[ Setting ]---------------------------------------------------------*/
 
-/** @brief Add values parsed from a string into a config set
- *
- * @param options a string containing the content to add to the config set. This is a '\\t',' ' or '\\n' or ','
- * separated list of variables. Each individual variable is like "[name]:[value]" where [name] is the name of an
- * already registered variable, and [value] conforms to the data type under which this variable was registered.
- *
- * @todo This is a crude manual parser, it should be a proper lexer.
- */
-void xbt_cfg_set_parse(const char *options)
-{
-  if (options && strlen(options) > 0)
-    simgrid::config::set_parse(std::string(options));
-}
-
-/** @brief Set the value of a variable, using the string representation of that value
- *
- * @param key name of the variable to modify
- * @param value string representation of the value to set
- */
-
-void xbt_cfg_set_as_string(const char *key, const char *value)
-{
-  (*simgrid_config)[key].set_string_value(value);
-}
-
-/** @brief Set an integer value to \a name within \a cfg if it wasn't changed yet
- *
- * This is useful to change the default value of a variable while allowing
- * users to override it with command line arguments
- */
-void xbt_cfg_setdefault_int(const char *key, int value)
-{
-  (*simgrid_config)[key].set_default_value<int>(value);
-}
-
-/** @brief Set an integer value to \a name within \a cfg if it wasn't changed yet
- *
- * This is useful to change the default value of a variable while allowing
- * users to override it with command line arguments
- */
-void xbt_cfg_setdefault_double(const char *key, double value)
-{
-  (*simgrid_config)[key].set_default_value<double>(value);
-}
-
-/** @brief Set a string value to \a name within \a cfg if it wasn't changed yet
- *
- * This is useful to change the default value of a variable while allowing
- * users to override it with command line arguments
- */
-void xbt_cfg_setdefault_string(const char *key, const char *value)
-{
-  (*simgrid_config)[key].set_default_value<std::string>(value ? value : "");
-}
-
-/** @brief Set an boolean value to \a name within \a cfg if it wasn't changed yet
- *
- * This is useful to change the default value of a variable while allowing
- * users to override it with command line arguments
- */
-void xbt_cfg_setdefault_boolean(const char *key, const char *value)
-{
-  (*simgrid_config)[key].set_default_value<bool>(simgrid::config::parse_bool(value));
-}
-
 /** @brief Set an integer value to \a name within \a cfg
  *
  * @param key the name of the variable
  * @param value the value of the variable
  */
-void xbt_cfg_set_int(const char *key, int value)
+void sg_cfg_set_int(const char* key, int value)
 {
   (*simgrid_config)[key].set_value<int>(value);
 }
@@ -637,7 +498,7 @@ void xbt_cfg_set_int(const char *key, int value)
  * @param key the name of the variable
  * @param value the double to set
  */
-void xbt_cfg_set_double(const char *key, double value)
+void sg_cfg_set_double(const char* key, double value)
 {
   (*simgrid_config)[key].set_value<double>(value);
 }
@@ -648,7 +509,7 @@ 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 sg_cfg_set_string(const char* key, const char* value)
 {
   (*simgrid_config)[key].set_value<std::string>(value);
 }
@@ -658,18 +519,11 @@ void xbt_cfg_set_string(const char* key, const char* value)
  * @param key the name of the variable
  * @param value the value of the variable
  */
-void xbt_cfg_set_boolean(const char *key, const char *value)
+void sg_cfg_set_boolean(const char* key, const char* value)
 {
   (*simgrid_config)[key].set_value<bool>(simgrid::config::parse_bool(value));
 }
 
-
-/* Say if the value is the default value */
-int xbt_cfg_is_default_value(const char *key)
-{
-  return (*simgrid_config)[key].is_default() ? 1 : 0;
-}
-
 /*----[ Getting ]---------------------------------------------------------*/
 /** @brief Retrieve an integer value of a variable (get a warning if not uniq)
  *
@@ -677,7 +531,7 @@ int xbt_cfg_is_default_value(const char *key)
  *
  * Returns the first value from the config set under the given name.
  */
-int xbt_cfg_get_int(const char *key)
+int sg_cfg_get_int(const char* key)
 {
   return (*simgrid_config)[key].get_value<int>();
 }
@@ -688,26 +542,11 @@ int xbt_cfg_get_int(const char *key)
  *
  * Returns the first value from the config set under the given name.
  */
-double xbt_cfg_get_double(const char *key)
+double sg_cfg_get_double(const char* key)
 {
   return (*simgrid_config)[key].get_value<double>();
 }
 
-/** @brief Retrieve a string value of a variable (get a warning if not uniq)
- *
- * @param key the name of the variable
- *
- * Returns the first value from the config set under the given name.
- * If there is more than one value, it will issue a warning.
- * Returns nullptr if there is no value.
- *
- * \warning the returned value is the actual content of the config set
- */
-std::string xbt_cfg_get_string(const char* key)
-{
-  return (*simgrid_config)[key].get_value<std::string>();
-}
-
 /** @brief Retrieve a boolean value of a variable (get a warning if not uniq)
  *
  * @param key the name of the variable
@@ -715,7 +554,7 @@ std::string xbt_cfg_get_string(const char* key)
  * Returns the first value from the config set under the given name.
  * If there is more than one value, it will issue a warning.
  */
-int xbt_cfg_get_boolean(const char *key)
+int sg_cfg_get_boolean(const char* key)
 {
   return (*simgrid_config)[key].get_value<bool>() ? 1 : 0;
 }