X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/0a9b604048c4568bb2c2709f3b824da719a7e737..8e8adb4298d76faafc4947256f0719c8aedc8508:/include/xbt/config.hpp

diff --git a/include/xbt/config.hpp b/include/xbt/config.hpp
index b5b3e9d7e9..701b5b39ca 100644
--- a/include/xbt/config.hpp
+++ b/include/xbt/config.hpp
@@ -1,11 +1,10 @@
-/* Copyright (c) 2016. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2016-2018. 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. */
 
-#ifndef _XBT_CONFIG_HPP_
-#define _XBT_CONFIG_HPP_
+#ifndef XBT_CONFIG_HPP
+#define XBT_CONFIG_HPP
 
 #include <xbt/base.h>
 
@@ -13,6 +12,7 @@
 
 #include <functional>
 #include <initializer_list>
+#include <map>
 #include <stdexcept>
 #include <string>
 #include <type_traits>
@@ -20,19 +20,11 @@
 
 #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();
-};
-
 template<class T> inline
 std::string to_string(T&& value)
 {
@@ -53,13 +45,12 @@ inline std::string to_string(std::string&& value)
 
 // Get config
 
-template<class T>
-XBT_PUBLIC(T const&) getConfig(const char* name);
+template <class T> XBT_PUBLIC T const& getConfig(const char* name);
 
-extern template XBT_PUBLIC(int const&) getConfig<int>(const char* name);
-extern template XBT_PUBLIC(double const&) getConfig<double>(const char* name);
-extern template XBT_PUBLIC(bool const&) getConfig<bool>(const char* name);
-extern template XBT_PUBLIC(std::string const&) getConfig<std::string>(const char* name);
+extern template XBT_PUBLIC int const& getConfig<int>(const char* name);
+extern template XBT_PUBLIC double const& getConfig<double>(const char* name);
+extern template XBT_PUBLIC bool const& getConfig<bool>(const char* name);
+extern template XBT_PUBLIC std::string const& getConfig<std::string>(const char* name);
 
 // Register:
 
@@ -70,22 +61,22 @@ extern template XBT_PUBLIC(std::string const&) getConfig<std::string>(const char
  *  @param value       Initial/default value
  *  @param callback    called with the option value
  */
-template<class T>
-XBT_PUBLIC(void) declareFlag(const char* name, const char* description,
-  T value, std::function<void(const T&)> callback = std::function<void(const T&)>());
-
-extern template XBT_PUBLIC(void) declareFlag(const char* name,
-  const char* description, int value, std::function<void(int const &)> callback);
-extern template XBT_PUBLIC(void) declareFlag(const char* name,
-  const char* description, double value, std::function<void(double const &)> callback);
-extern template XBT_PUBLIC(void) declareFlag(const char* name,
-  const char* description, bool value, std::function<void(bool const &)> callback);
-extern template XBT_PUBLIC(void) declareFlag(const char* name,
-  const char* description, std::string value, std::function<void(std::string const &)> callback);
+template <class T>
+XBT_PUBLIC void declareFlag(const char* name, const char* description, T value,
+                            std::function<void(const T&)> callback = std::function<void(const T&)>());
+
+extern template XBT_PUBLIC void declareFlag(const char* name, const char* description, int value,
+                                            std::function<void(int const&)> callback);
+extern template XBT_PUBLIC void declareFlag(const char* name, const char* description, double value,
+                                            std::function<void(double const&)> callback);
+extern template XBT_PUBLIC void declareFlag(const char* name, const char* description, bool value,
+                                            std::function<void(bool const&)> callback);
+extern template XBT_PUBLIC void declareFlag(const char* name, const char* description, std::string value,
+                                            std::function<void(std::string const&)> callback);
 
 // ***** alias *****
 
-XBT_PUBLIC(void) alias(const char* realname, const char* aliasname);
+XBT_PUBLIC void alias(const char* realname, const char* aliasname);
 
 inline
 void alias(std::initializer_list<const char*> names)
@@ -104,7 +95,6 @@ void alias(std::initializer_list<const char*> names)
 template<class T>
 void bindFlag(T& value, const char* name, const char* description)
 {
-  using namespace std;
   declareFlag<T>(name, description, value, [&value](T const& val) {
     value = val;
   });
@@ -125,41 +115,59 @@ void bindFlag(T& value, std::initializer_list<const char*> names, const char* de
  *    if (x < x_min || x => x_max)
  *      throw std::range_error("must be in [x_min, x_max)")
  *  });
- *  </pre><code>
+ *  </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, std::initializer_list<const char*> names, const char* description, F callback)
 {
-  declareFlag(name, description, value, [&value,callback](const T& val) {
-    callback(val);
-    value = std::move(val);
-  });
+  bindFlag(value, *names.begin(), description, std::move(callback));
+  alias(names);
 }
 
+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; });
- *  </pre><code>
+ *  simgrid::config::bindFlag(a, "x", [](int x) { return x > 0; });
+ *  </code></pre>
  */
 // F is a predicate, F : T const& -> bool
 template<class T, class F>
@@ -170,18 +178,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 (!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>
  */
@@ -201,12 +209,30 @@ public:
     simgrid::config::bindFlag(value_, name, desc);
   }
 
+  /** Constructor taking an array of aliases as name */
+  Flag(std::initializer_list<const char*> names, const char* desc, T value) : value_(value)
+  {
+    simgrid::config::bindFlag(value_, names, 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));
   }
 
+  /* 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;
@@ -220,17 +246,26 @@ public:
   operator T const&() const{ return value_; }
 
   // Basic interop with T:
-  Flag& operator=(T const& that) { value_ = that; return *this; }
-  Flag& operator=(T && that)     { value_ = that; return *this; }
-  bool operator==(T const& that) const { return value_ == that; }
-  bool operator!=(T const& that) const { return value_ != that; }
-  bool operator<(T const& that) const { return value_ < that; }
-  bool operator>(T const& that) const { return value_ > that; }
-  bool operator<=(T const& that) const { return value_ <= that; }
-  bool operator>=(T const& that) const { return value_ >= that; }
+  template<class U>
+  Flag& operator=(U const& that) { value_ = that; return *this; }
+  template<class U>
+  Flag& operator=(U && that)     { value_ = that; return *this; }
+  template<class U>
+  bool operator==(U const& that) const { return value_ == that; }
+  template<class U>
+  bool operator!=(U const& that) const { return value_ != that; }
+  template<class U>
+  bool operator<(U const& that) const { return value_ < that; }
+  template<class U>
+  bool operator>(U const& that) const { return value_ > that; }
+  template<class U>
+  bool operator<=(U const& that) const { return value_ <= that; }
+  template<class U>
+  bool operator>=(U const& that) const { return value_ >= that; }
 };
 
 }
 }
+XBT_PUBLIC std::string xbt_cfg_get_string(const char* name);
 
 #endif