Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
IIUC return std::move(...) is discouraged.
[simgrid.git] / include / xbt / config.hpp
index 92ecb49..1a04a57 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2016-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2016-2019. 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. */
 #include <utility>
 
 #include <xbt/base.h>
-#include <xbt/config.h>
 #include <xbt/sysdep.h>
 
 namespace simgrid {
 namespace config {
 
+class Config;
+
 template<class T> inline
 std::string to_string(T&& value)
 {
@@ -40,17 +41,40 @@ inline std::string const& to_string(std::string const& value)
 }
 inline std::string to_string(std::string&& value)
 {
-  return std::move(value);
+  return value;
 }
 
+// Set default
+
+template <class T> XBT_PUBLIC void set_default(const char* name, T value);
+
+extern template XBT_PUBLIC void set_default<int>(const char* name, int value);
+extern template XBT_PUBLIC void set_default<double>(const char* name, double value);
+extern template XBT_PUBLIC void set_default<bool>(const char* name, bool value);
+extern template XBT_PUBLIC void set_default<std::string>(const char* name, std::string value);
+
+XBT_PUBLIC bool is_default(const char* name);
+
+// Set config
+
+template <class T> XBT_PUBLIC void set_value(const char* name, T value);
+
+extern template XBT_PUBLIC void set_value<int>(const char* name, int value);
+extern template XBT_PUBLIC void set_value<double>(const char* name, double value);
+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(const std::string& options);
+
 // Get config
 
-template <class T> XBT_PUBLIC T const& get_config(const char* name);
+template <class T> XBT_PUBLIC T const& get_value(const std::string& name);
 
-extern template XBT_PUBLIC int const& get_config<int>(const char* name);
-extern template XBT_PUBLIC double const& get_config<double>(const char* name);
-extern template XBT_PUBLIC bool const& get_config<bool>(const char* name);
-extern template XBT_PUBLIC std::string const& get_config<std::string>(const char* 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:
 
@@ -62,16 +86,16 @@ extern template XBT_PUBLIC std::string const& get_config<std::string>(const char
  *  @param callback    called with the option value
  */
 template <class T>
-XBT_PUBLIC void declare_flag(const char* name, const char* 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(const char* name, const char* 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(const char* name, const char* 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(const char* name, const char* 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(const char* name, const char* 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 *****
@@ -138,11 +162,11 @@ bind_flag(T& value, const char* name, const char* description, std::map<T, std::
                      found = true;
                  }
                  if (not found || std::string(val) == "help") {
-                   std::string mesg;
+                   std::string mesg = std::string("\n");
                    if (std::string(val) == "help")
-                     mesg = std::string("\nPossible values for option ") + name + ":\n";
+                     mesg += std::string("Possible values for option ") + name + ":\n";
                    else
-                     mesg = std::string("\nInvalid value '") + val + "' for option " + name + ". Possible values:\n";
+                     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";
@@ -151,6 +175,15 @@ bind_flag(T& value, const char* name, const char* description, std::map<T, std::
                  value = std::move(val);
                }));
 }
+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)
+{
+  bind_flag(value, name, description, std::move(valid_values), std::move(callback));
+  alias(name, std::move(aliases));
+}
+
 /** Bind a variable to configuration flag
  *
  *  <pre><code>
@@ -181,6 +214,8 @@ bind_flag(T& value, const char* name, const char* description, F callback)
 template<class T>
 class Flag {
   T value_;
+  std::string name_;
+
 public:
 
   /** Constructor
@@ -189,13 +224,14 @@ public:
    *  @param desc  Flag description
    *  @param value Flag initial/default value
    */
-  Flag(const char* name, const char* desc, T value) : value_(value)
+  Flag(const char* name, const char* desc, T value) : value_(value), name_(name)
   {
     simgrid::config::bind_flag(value_, name, desc);
   }
 
   /** Constructor taking also an array of aliases for name */
-  Flag(const char* name, std::initializer_list<const char*> aliases, const char* desc, T value) : value_(value)
+  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);
   }
@@ -203,15 +239,14 @@ public:
   /* A constructor accepting a callback that will be passed the parameter.
    * It can either return a boolean (informing whether the parameter is valid), or returning void.
    */
-  template<class F>
-  Flag(const char* name, const char* desc, T value, F callback) : value_(value)
+  template <class F> Flag(const char* name, const char* desc, T value, F callback) : value_(value), name_(name)
   {
     simgrid::config::bind_flag(value_, name, desc, std::move(callback));
   }
 
   template <class F>
   Flag(const char* name, std::initializer_list<const char*> aliases, const char* desc, T value, F callback)
-      : value_(value)
+      : value_(value), name_(name)
   {
     simgrid::config::bind_flag(value_, name, std::move(aliases), desc, std::move(callback));
   }
@@ -220,11 +255,21 @@ public:
    * 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) : value_(value)
+  Flag(const char* name, const char* desc, T value, std::map<T, std::string> valid_values, F callback)
+      : value_(value), name_(name)
   {
     simgrid::config::bind_flag(value_, name, desc, std::move(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)
+      : value_(value), name_(name)
+  {
+    simgrid::config::bind_flag(value_, name, std::move(aliases), desc, std::move(valid_values), std::move(callback));
+  }
+
   // No copy:
   Flag(Flag const&) = delete;
   Flag& operator=(Flag const&) = delete;
@@ -233,6 +278,7 @@ public:
   T& get() { return value_; }
   T const& get() const { return value_; }
 
+  const std::string& get_name() const { return name_; }
   // Implicit conversion to the underlying type:
   operator T&() { return value_; }
   operator T const&() const{ return value_; }
@@ -256,8 +302,12 @@ public:
   bool operator>=(U const& that) const { return value_ >= that; }
 };
 
+XBT_PUBLIC void finalize();
+XBT_PUBLIC void show_aliases();
+XBT_PUBLIC void help();
 }
 }
-XBT_PUBLIC std::string xbt_cfg_get_string(const char* name);
+XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::get_value<std::string>") XBT_PUBLIC std::string
+    xbt_cfg_get_string(const char* name);
 
 #endif