Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Throw std::out_of_range.
[simgrid.git] / src / xbt / config.cpp
index 6d7db52..f70eec1 100644 (file)
@@ -12,6 +12,7 @@
 
 #include <functional>
 #include <map>
+#include <memory>
 #include <stdexcept>
 #include <string>
 #include <string>
@@ -143,9 +144,9 @@ public:
   /* Callback */
   xbt_cfg_cb_t old_callback = nullptr;
 
-  ConfigurationElement(std::string key, std::string desc) : key(std::move(key)), desc(std::move(desc)) {}
-  ConfigurationElement(std::string key, std::string desc, xbt_cfg_cb_t cb)
-      : key(std::move(key)), desc(std::move(desc)), old_callback(cb)
+  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)
   {
   }
 
@@ -157,15 +158,15 @@ public:
 
   template <class T> T const& get_value() const
   {
-    return dynamic_cast<const TypedConfigurationElement<T>&>(*this).get_value();
+    return static_cast<const TypedConfigurationElement<T>&>(*this).get_value();
   }
   template <class T> void set_value(T value)
   {
-    dynamic_cast<TypedConfigurationElement<T>&>(*this).set_value(std::move(value));
+    static_cast<TypedConfigurationElement<T>&>(*this).set_value(std::move(value));
   }
   template <class T> void set_default_value(T value)
   {
-    dynamic_cast<TypedConfigurationElement<T>&>(*this).set_default_value(std::move(value));
+    static_cast<TypedConfigurationElement<T>&>(*this).set_default_value(std::move(value));
   }
   void unset_default() { isdefault = false; }
   bool is_default() const { return isdefault; }
@@ -184,14 +185,14 @@ private:
   std::function<void(T&)> callback;
 
 public:
-  TypedConfigurationElement(std::string key, std::string desc, T value = T())
-      : ConfigurationElement(std::move(key), std::move(desc)), content(std::move(value))
+  TypedConfigurationElement(const std::string& key, const std::string& desc, T value = T())
+      : ConfigurationElement(key, desc), content(std::move(value))
   {}
-  TypedConfigurationElement(std::string key, std::string desc, T value, xbt_cfg_cb_t cb)
-      : ConfigurationElement(std::move(key), std::move(desc), cb), 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(std::string key, std::string desc, T value, std::function<void(T&)> callback)
-      : ConfigurationElement(std::move(key), std::move(desc)), content(std::move(value)), callback(std::move(callback))
+  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;
 
@@ -252,14 +253,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,15 +268,14 @@ 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)...);
     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;
   }
@@ -294,18 +293,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 +307,7 @@ 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());
+      throw std::out_of_range("Bad config key: " + name);
     }
   }
 }
@@ -339,33 +332,32 @@ void Config::alias(const std::string& realname, const std::string& aliasname)
  */
 void Config::dump(const char *name, const char *indent)
 {
+  XBT_LOG_DEFAULT_CATEGORY(xbt_help);
   if (name)
-    printf("%s>> Dumping of the config set '%s':\n", indent, name);
+    XBT_VERB("%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_VERB("%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_VERB("%s<< End of the config set '%s'", indent, name);
 }
 
 /** @brief Displays the declared aliases and their replacement */
 void Config::show_aliases()
 {
   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()
 {
   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());
   }
 }
 
@@ -403,8 +395,9 @@ void set_as_string(const char* name, const std::string& value)
   (*simgrid_config)[name].set_string_value(value.c_str());
 }
 
-void set_parse(std::string options)
+void set_parse(const std::string& opt)
 {
+  std::string options(opt);
   XBT_DEBUG("List to parse and set:'%s'", options.c_str());
   while (not options.empty()) {
     XBT_DEBUG("Still to parse and set: '%s'", options.c_str());
@@ -459,21 +452,21 @@ void alias(const char* realname, std::initializer_list<const char*> aliases)
 // ***** declare_flag *****
 
 template <class T>
-XBT_PUBLIC void declare_flag(const std::string& name, std::string description, T value,
+XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, T value,
                              std::function<void(const T&)> callback)
 {
   if (simgrid_config == nullptr)
     simgrid_config = new simgrid::config::Config();
-  simgrid_config->register_option<T>(name, std::move(description), std::move(value), std::move(callback));
+  simgrid_config->register_option<T>(name, description, std::move(value), std::move(callback));
 }
 
-template XBT_PUBLIC void declare_flag(const std::string& name, std::string description, int value,
+template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, int value,
                                       std::function<void(int const&)> callback);
-template XBT_PUBLIC void declare_flag(const std::string& name, std::string description, double value,
+template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, double value,
                                       std::function<void(double const&)> callback);
-template XBT_PUBLIC void declare_flag(const std::string& name, std::string description, bool value,
+template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, bool value,
                                       std::function<void(bool const&)> callback);
-template XBT_PUBLIC void declare_flag(const std::string& name, std::string description, std::string value,
+template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, std::string value,
                                       std::function<void(std::string const&)> callback);
 
 void finalize()
@@ -494,133 +487,8 @@ 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
@@ -662,13 +530,6 @@ void xbt_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)
  *
@@ -692,21 +553,6 @@ double xbt_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