Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add missing constructor for simgrid::config::Flag.
[simgrid.git] / include / xbt / config.hpp
index 5585106..5c2f098 100644 (file)
@@ -12,6 +12,7 @@
 
 #include <functional>
 #include <initializer_list>
+#include <map>
 #include <stdexcept>
 #include <string>
 #include <type_traits>
 
 #include <xbt/base.h>
 #include <xbt/config.h>
+#include <xbt/sysdep.h>
 
 namespace simgrid {
 namespace config {
 
-XBT_PUBLIC_CLASS missing_key_error : public std::runtime_error {
-public:
-  explicit missing_key_error(const std::string& what)
-    : std::runtime_error(what) {}
-  explicit missing_key_error(const char* what)
-    : std::runtime_error(what) {}
-  ~missing_key_error() override;
-};
-
 template<class T> inline
 std::string to_string(T&& value)
 {
@@ -83,15 +76,7 @@ extern template XBT_PUBLIC void declareFlag(const char* name, const char* descri
 
 // ***** alias *****
 
-XBT_PUBLIC void alias(const char* realname, const char* aliasname);
-
-inline
-void alias(std::initializer_list<const char*> names)
-{
-  auto i = names.begin();
-  for (++i; i != names.end(); ++i)
-    alias(*names.begin(), *i);
-}
+XBT_PUBLIC void alias(const char* realname, std::initializer_list<const char*> aliases);
 
 /** Bind a variable to configuration flag
  *
@@ -107,11 +92,11 @@ void bindFlag(T& value, const char* name, const char* description)
   });
 }
 
-template<class T>
-void bindFlag(T& value, std::initializer_list<const char*> names, const char* description)
+template <class T>
+void bindFlag(T& value, const char* name, std::initializer_list<const char*> aliases, const char* description)
 {
-  bindFlag(value, *names.begin(), description);
-  alias(names);
+  bindFlag(value, name, description);
+  alias(name, std::move(aliases));
 }
 
 /** Bind a variable to configuration flag
@@ -125,37 +110,55 @@ void bindFlag(T& value, std::initializer_list<const char*> names, const char* de
  *  </code></pre>
  */
 // 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
-bindFlag(T& value, std::initializer_list<const char*> names, 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
+bindFlag(T& value, const char* name, const char* description, F callback)
 {
-  bindFlag(value, *names.begin(), description);
-  alias(names);
+  declareFlag(name, description, value, std::function<void(const T&)>([&value, callback](const T& val) {
+                callback(val);
+                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
-bindFlag(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
+bindFlag(T& value, const char* name, std::initializer_list<const char*> aliases, const char* description, F callback)
 {
-  declareFlag(name, description, value, [&value,callback](const T& val) {
-    callback(val);
-    value = std::move(val);
-  });
+  bindFlag(value, name, description, std::move(callback));
+  alias(name, std::move(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
+bindFlag(T& value, const char* name, const char* description, std::map<T, std::string> valid_values, F callback)
+{
+  declareFlag(name, description, value,
+              std::function<void(const T&)>([&value, name, valid_values, callback](const T& 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;
+                  if (std::string(val) == "help")
+                    mesg = std::string("\nPossible values for option ") + name + ":\n";
+                  else
+                    mesg = std::string("\nInvalid 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());
+                }
+                value = std::move(val);
+              }));
+}
 /** Bind a variable to configuration flag
  *
  *  <pre><code>
  *  static int x;
- *  simgrid::config::bindFlag(a, "x", [](int x) { return return x > 0; });
+ *  simgrid::config::bindFlag(a, "x", [](int x) { return x > 0; });
  *  </code></pre>
  */
 // F is a predicate, F : T const& -> bool
@@ -167,18 +170,18 @@ typename std::enable_if<std::is_same<
 bindFlag(T& value, const char* name, const char* description,
   F callback)
 {
-  declareFlag(name, description, value, [&value, callback](const T& val) {
-    if (not callback(val))
-      throw std::range_error("invalid value");
-    value = std::move(val);
-  });
+  declareFlag(name, description, value, std::function<void(const T&)>([&value, callback](const T& val) {
+                if (not callback(val))
+                  throw std::range_error("invalid value.");
+                value = std::move(val);
+              }));
 }
 
 /** A variable bound to a CLI option
  *
  *  <pre><code>
  *  static simgrid::config::flag<int> answer("answer", "Expected answer", 42);
- *  static simgrid::config::flag<std::string> name("name", "Ford Prefect", "John Doe");
+ *  static simgrid::config::flag<std::string> name("name", "Ford Perfect", "John Doe");
  *  static simgrid::config::flag<double> gamma("gamma", "Gamma factor", 1.987);
  *  </code></pre>
  */
@@ -198,12 +201,37 @@ public:
     simgrid::config::bindFlag(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)
+  {
+    simgrid::config::bindFlag(value_, name, std::move(aliases), desc);
+  }
+
+  /* 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)
   {
     simgrid::config::bindFlag(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)
+  {
+    simgrid::config::bindFlag(value_, name, std::move(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) : value_(value)
+  {
+    simgrid::config::bindFlag(value_, name, desc, std::move(valid_values), std::move(callback));
+  }
+
   // No copy:
   Flag(Flag const&) = delete;
   Flag& operator=(Flag const&) = delete;