Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[sonar] Use a logger for help messages.
[simgrid.git] / src / xbt / config.cpp
index f8aee5d..6c2cc3a 100644 (file)
@@ -143,8 +143,11 @@ public:
   /* Callback */
   xbt_cfg_cb_t old_callback = nullptr;
 
-  ConfigurationElement(std::string key, std::string desc) : key(key), desc(desc) {}
-  ConfigurationElement(std::string key, std::string desc, xbt_cfg_cb_t cb) : key(key), desc(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)
+  {
+  }
 
   virtual ~ConfigurationElement() = default;
 
@@ -154,15 +157,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; }
@@ -181,13 +184,13 @@ private:
   std::function<void(T&)> callback;
 
 public:
-  TypedConfigurationElement(std::string key, std::string desc, T value = T())
+  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)
+  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)
+  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;
@@ -262,8 +265,8 @@ public:
   Config(Config const&) = delete;
   Config& operator=(Config const&) = delete;
 
-  ConfigurationElement& operator[](std::string name);
-  void alias(std::string realname, std::string aliasname);
+  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)
@@ -284,7 +287,7 @@ public:
   void help();
 
 protected:
-  ConfigurationElement* get_dict_element(std::string name);
+  ConfigurationElement* get_dict_element(const std::string& name);
 };
 
 Config::Config()
@@ -298,7 +301,7 @@ Config::~Config()
     delete elm.second;
 }
 
-inline ConfigurationElement* Config::get_dict_element(std::string name)
+inline ConfigurationElement* Config::get_dict_element(const std::string& name)
 {
   auto opt = options.find(name);
   if (opt != options.end()) {
@@ -316,12 +319,12 @@ inline ConfigurationElement* Config::get_dict_element(std::string name)
   }
 }
 
-inline ConfigurationElement& Config::operator[](std::string name)
+inline ConfigurationElement& Config::operator[](const std::string& name)
 {
   return *(get_dict_element(name));
 }
 
-void Config::alias(std::string realname, std::string aliasname)
+void Config::alias(const std::string& realname, const std::string& aliasname)
 {
   xbt_assert(aliases.find(aliasname) == aliases.end(), "Alias '%s' already.", aliasname.c_str());
   ConfigurationElement* element = this->get_dict_element(realname);
@@ -336,23 +339,23 @@ void Config::alias(std::string realname, 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 */
@@ -360,9 +363,8 @@ 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());
+    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());
   }
 }
 
@@ -400,8 +402,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());
@@ -456,21 +459,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()
@@ -491,133 +494,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
@@ -659,13 +537,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)
  *
@@ -689,21 +560,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