Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Prefer using "try_emplace" (sonar, c++17).
[simgrid.git] / src / xbt / config.cpp
index 60d5f21..c2a5fdb 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved.     */
+/* Copyright (c) 2004-2022. 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. */
@@ -16,8 +16,6 @@
 #include <stdexcept>
 #include <string>
 #include <string>
-#include <type_traits>
-#include <typeinfo>
 #include <vector>
 
 #include "simgrid/Exception.hpp"
@@ -38,55 +36,41 @@ 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;
   double res = std::strtod(value, &end);
   if (errno == ERANGE)
     throw std::range_error("out of range");
-  else if (errno)
-    xbt_die("Unexpected errno");
+  xbt_assert(errno == 0, "Unexpected errno: %d", errno);
   if (end == value || *end != '\0')
     throw std::range_error("invalid double");
-  else
-    return res;
+  return res;
 }
 
-static long int parse_long(const char* value)
+long int parse_long(const char* value)
 {
   char* end;
   errno = 0;
   long int res = std::strtol(value, &end, 0);
-  if (errno) {
-    if (res == LONG_MIN && errno == ERANGE)
-      throw std::range_error("underflow");
-    else if (res == LONG_MAX && errno == ERANGE)
-      throw std::range_error("overflow");
-    xbt_die("Unexpected errno");
-  }
+  if (errno == ERANGE)
+    throw std::range_error(res == LONG_MIN ? "underflow" : "overflow");
+  xbt_assert(errno == 0, "Unexpected errno: %d", errno);
   if (end == value || *end != '\0')
     throw std::range_error("invalid integer");
-  else
-    return res;
+  return res;
 }
 
 // ***** ConfigType *****
@@ -97,9 +81,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> {
@@ -141,14 +130,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;
 
@@ -188,13 +170,9 @@ 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;
 
   std::string get_string_value() override;
   const char* get_type_name() override;
@@ -202,8 +180,6 @@ public:
 
   void update()
   {
-    if (old_callback)
-      this->old_callback(get_key().c_str());
     if (this->callback)
       this->callback(this->content);
   }
@@ -224,7 +200,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());
     }
   }
 };
@@ -234,6 +210,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);
@@ -253,9 +235,9 @@ template <class T> const char* TypedConfigurationElement<T>::get_type_name() //
 class Config {
 private:
   // name -> ConfigElement:
-  std::map<std::string, std::unique_ptr<ConfigurationElement>> options;
+  std::map<std::string, std::unique_ptr<ConfigurationElement>, std::less<>> options;
   // alias -> ConfigElement from options:
-  std::map<std::string, ConfigurationElement*> aliases;
+  std::map<std::string, ConfigurationElement*, std::less<>> aliases;
   bool warn_for_aliases = true;
 
 public:
@@ -272,7 +254,7 @@ public:
   {
     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[name].reset(variable);
@@ -280,10 +262,8 @@ public:
     return variable;
   }
 
-  // Debug:
-  void dump(const char *name, const char *indent);
-  void show_aliases();
-  void help();
+  void show_aliases() const;
+  void help() const;
 
 protected:
   ConfigurationElement* get_dict_element(const std::string& name);
@@ -307,7 +287,12 @@ 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 {
-      std::string msg = "Bad config key: " + name + "\nExisting config keys:\n";
+      std::string msg   = "Bad config key: " + name + "\n";
+      std::string kebab = name;
+      std::replace(begin(kebab), end(kebab), '_', '-'); // convert from snake_case to kebab-case
+      if (options.count(kebab) > 0)
+        msg += "Did you mean '" + kebab + "'?\n";
+      msg += "Existing 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);
@@ -325,37 +310,18 @@ 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);
   xbt_assert(element, "Cannot define an alias to the non-existing option '%s'.", realname.c_str());
-  this->aliases.insert({aliasname, element});
-}
-
-/** @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)
-{
-  XBT_LOG_DEFAULT_CATEGORY(xbt_help);
-  if (name)
-    XBT_VERB("%s>> Dumping of the config set '%s':", indent, name);
-
-  for (auto const& elm : options)
-    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)
-    XBT_VERB("%s<< End of the config set '%s'", indent, name);
+  this->aliases.try_emplace(aliasname, element);
 }
 
 /** @brief Displays the declared aliases and their replacement */
-void Config::show_aliases()
+void Config::show_aliases() const
 {
   for (auto const& elm : aliases)
     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 = elm.second.get();