Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Update copyright lines for 2022.
[simgrid.git] / include / xbt / config.hpp
index ebcdd65..ac6c292 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2016-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2016-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. */
@@ -65,16 +65,16 @@ extern template XBT_PUBLIC void set_value<bool>(const char* name, bool value);
 extern template XBT_PUBLIC void set_value<std::string>(const char* name, std::string value);
 
 XBT_PUBLIC void set_as_string(const char* name, const std::string& value);
-XBT_PUBLIC void set_parse(std::string options);
+XBT_PUBLIC void set_parse(const std::string& options);
 
 // Get config
 
-template <class T> XBT_PUBLIC T const& get_value(std::string name);
+template <class T> XBT_PUBLIC T const& get_value(const std::string& name);
 
-extern template XBT_PUBLIC int const& get_value<int>(std::string name);
-extern template XBT_PUBLIC double const& get_value<double>(std::string name);
-extern template XBT_PUBLIC bool const& get_value<bool>(std::string name);
-extern template XBT_PUBLIC std::string const& get_value<std::string>(std::string name);
+extern template XBT_PUBLIC int const& get_value<int>(const std::string& name);
+extern template XBT_PUBLIC double const& get_value<double>(const std::string& name);
+extern template XBT_PUBLIC bool const& get_value<bool>(const std::string& name);
+extern template XBT_PUBLIC std::string const& get_value<std::string>(const std::string& name);
 
 // Register:
 
@@ -86,16 +86,16 @@ extern template XBT_PUBLIC std::string const& get_value<std::string>(std::string
  *  @param callback    called with the option value
  */
 template <class T>
-XBT_PUBLIC void declare_flag(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 = std::function<void(const T&)>());
 
-extern template XBT_PUBLIC void declare_flag(std::string name, std::string description, int value,
+extern template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, int value,
                                              std::function<void(int const&)> callback);
-extern template XBT_PUBLIC void declare_flag(std::string name, std::string description, double value,
+extern template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, double value,
                                              std::function<void(double const&)> callback);
-extern template XBT_PUBLIC void declare_flag(std::string name, std::string description, bool value,
+extern template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, bool value,
                                              std::function<void(bool const&)> callback);
-extern template XBT_PUBLIC void declare_flag(std::string name, std::string description, std::string value,
+extern template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, std::string value,
                                              std::function<void(std::string const&)> callback);
 
 // ***** alias *****
@@ -117,7 +117,7 @@ template <class T>
 void bind_flag(T& value, const char* name, std::initializer_list<const char*> aliases, const char* description)
 {
   bind_flag(value, name, description);
-  alias(name, std::move(aliases));
+  alias(name, aliases);
 }
 
 /** Bind a variable to configuration flag
@@ -132,7 +132,7 @@ void bind_flag(T& value, const char* name, std::initializer_list<const char*> al
  */
 // F is a checker, F : T& -> ()
 template <class T, class F>
-typename std::enable_if<std::is_same<void, decltype(std::declval<F>()(std::declval<const T&>()))>::value, void>::type
+typename std::enable_if_t<std::is_same<void, decltype(std::declval<F>()(std::declval<const T&>()))>::value, void>
 bind_flag(T& value, const char* name, const char* description, F callback)
 {
   declare_flag(name, description, value, std::function<void(const T&)>([&value, callback](const T& val) {
@@ -142,46 +142,44 @@ bind_flag(T& value, const char* name, const char* description, F callback)
 }
 
 template <class T, class F>
-typename std::enable_if<std::is_same<void, decltype(std::declval<F>()(std::declval<const T&>()))>::value, void>::type
+typename std::enable_if_t<std::is_same<void, decltype(std::declval<F>()(std::declval<const T&>()))>::value, void>
 bind_flag(T& value, const char* name, std::initializer_list<const char*> aliases, const char* description, F callback)
 {
   bind_flag(value, name, description, std::move(callback));
-  alias(name, std::move(aliases));
+  alias(name, aliases);
 }
 
-template <class T, class F>
-typename std::enable_if<std::is_same<void, decltype(std::declval<F>()(std::declval<const T&>()))>::value, void>::type
-bind_flag(T& value, const char* name, const char* description, std::map<T, std::string> valid_values, F callback)
+template <class F>
+typename std::enable_if_t<std::is_same<void, decltype(std::declval<F>()(std::declval<const std::string&>()))>::value,
+                          void>
+bind_flag(std::string& value, const char* name, const char* description,
+          const std::map<std::string, std::string, std::less<>>& valid_values, F callback)
 {
   declare_flag(name, description, value,
-               std::function<void(const T&)>([&value, name, valid_values, callback](const T& val) {
+               std::function<void(const std::string&)>([&value, name, valid_values, callback](const std::string& val) {
                  callback(val);
-                 bool found = false;
-                 for (auto kv : valid_values) {
-                   if (kv.first == val)
-                     found = true;
-                 }
-                 if (not found || std::string(val) == "help") {
-                   std::string mesg = std::string("\n");
-                   if (std::string(val) == "help")
-                     mesg += std::string("Possible values for option ") + name + ":\n";
-                   else
-                     mesg += std::string("Invalid value '") + val + "' for option " + name + ". Possible values:\n";
-                   for (auto kv : valid_values)
-                     mesg += "  - '" + std::string(kv.first) + "': " + kv.second +
-                             (kv.first == value ? "  <=== DEFAULT" : "") + "\n";
-                   xbt_die("%s", mesg.c_str());
+                 if (valid_values.find(val) != valid_values.end()) {
+                   value = val;
+                   return;
                  }
-                 value = std::move(val);
+                 std::string mesg = "\n";
+                 if (val == "help")
+                   mesg += std::string("Possible values for option ") + name + ":\n";
+                 else
+                   mesg += std::string("Invalid value '") + val + "' for option " + name + ". Possible values:\n";
+                 for (auto const& kv : valid_values)
+                   mesg += "  - '" + kv.first + "': " + kv.second + (kv.first == value ? "  <=== DEFAULT" : "") + "\n";
+                 xbt_die("%s", mesg.c_str());
                }));
 }
-template <class T, class F>
-typename std::enable_if<std::is_same<void, decltype(std::declval<F>()(std::declval<const T&>()))>::value, void>::type
-bind_flag(T& value, const char* name, std::initializer_list<const char*> aliases, const char* description,
-          std::map<T, std::string> valid_values, F callback)
+template <class F>
+typename std::enable_if_t<std::is_same<void, decltype(std::declval<F>()(std::declval<const std::string&>()))>::value,
+                          void>
+bind_flag(std::string& value, const char* name, std::initializer_list<const char*> aliases, const char* description,
+          const std::map<std::string, std::string, std::less<>>& valid_values, F callback)
 {
-  bind_flag(value, name, description, std::move(valid_values), std::move(callback));
-  alias(name, std::move(aliases));
+  bind_flag(value, name, description, valid_values, std::move(callback));
+  alias(name, aliases);
 }
 
 /** Bind a variable to configuration flag
@@ -193,7 +191,7 @@ bind_flag(T& value, const char* name, std::initializer_list<const char*> aliases
  */
 // F is a predicate, F : T const& -> bool
 template <class T, class F>
-typename std::enable_if<std::is_same<bool, decltype(std::declval<F>()(std::declval<const T&>()))>::value, void>::type
+typename std::enable_if_t<std::is_same<bool, decltype(std::declval<F>()(std::declval<const T&>()))>::value, void>
 bind_flag(T& value, const char* name, const char* description, F callback)
 {
   declare_flag(name, description, value, std::function<void(const T&)>([&value, callback](const T& val) {
@@ -217,7 +215,6 @@ class Flag {
   std::string name_;
 
 public:
-
   /** Constructor
    *
    *  @param name  Flag name
@@ -233,7 +230,7 @@ public:
   Flag(const char* name, std::initializer_list<const char*> aliases, const char* desc, T value)
       : value_(value), name_(name)
   {
-    simgrid::config::bind_flag(value_, name, std::move(aliases), desc);
+    simgrid::config::bind_flag(value_, name, aliases, desc);
   }
 
   /* A constructor accepting a callback that will be passed the parameter.
@@ -248,26 +245,27 @@ public:
   Flag(const char* name, std::initializer_list<const char*> aliases, const char* desc, T value, F callback)
       : value_(value), name_(name)
   {
-    simgrid::config::bind_flag(value_, name, std::move(aliases), desc, std::move(callback));
+    simgrid::config::bind_flag(value_, name, aliases, desc, std::move(callback));
   }
 
   /* A constructor accepting a map of valid values -> their description,
    * and producing an informative error message when an invalid value is passed, or when help is passed as a value.
    */
   template <class F>
-  Flag(const char* name, const char* desc, T value, std::map<T, std::string> valid_values, F callback)
+  Flag(const char* name, const char* desc, T value, const std::map<std::string, std::string, std::less<>>& valid_values,
+       F callback)
       : value_(value), name_(name)
   {
-    simgrid::config::bind_flag(value_, name, desc, std::move(valid_values), std::move(callback));
+    simgrid::config::bind_flag(value_, name, desc, valid_values, std::move(callback));
   }
 
   /* A constructor with everything */
   template <class F>
   Flag(const char* name, std::initializer_list<const char*> aliases, const char* desc, T value,
-       std::map<T, std::string> valid_values, F callback)
+       const std::map<std::string, std::string, std::less<>>& valid_values, F callback)
       : value_(value), name_(name)
   {
-    simgrid::config::bind_flag(value_, name, std::move(aliases), desc, std::move(valid_values), std::move(callback));
+    simgrid::config::bind_flag(value_, name, aliases, desc, valid_values, std::move(callback));
   }
 
   // No copy:
@@ -278,7 +276,7 @@ public:
   T& get() { return value_; }
   T const& get() const { return value_; }
 
-  std::string get_name() const { return name_; }
+  const std::string& get_name() const { return name_; }
   // Implicit conversion to the underlying type:
   operator T&() { return value_; }
   operator T const&() const{ return value_; }
@@ -287,7 +285,7 @@ public:
   template<class U>
   Flag& operator=(U const& that) { value_ = that; return *this; }
   template<class U>
-  Flag& operator=(U && that)     { value_ = that; return *this; }
+  Flag& operator=(U&& that) { value_ = std::forward<U>(that); return *this; }
   template<class U>
   bool operator==(U const& that) const { return value_ == that; }
   template<class U>
@@ -305,9 +303,7 @@ public:
 XBT_PUBLIC void finalize();
 XBT_PUBLIC void show_aliases();
 XBT_PUBLIC void help();
-}
-}
-XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::get_value<std::string>") XBT_PUBLIC std::string
-    xbt_cfg_get_string(const char* name);
+} // namespace config
+} // namespace simgrid
 
 #endif