include/xbt/config.hpp

   1 /* Copyright (c) 2016-2018. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef XBT_CONFIG_HPP
   7 #define XBT_CONFIG_HPP
   8
   9 #include <xbt/base.h>
  10
  11 #include <cstdlib>
  12
  13 #include <functional>
  14 #include <initializer_list>
  15 #include <map>
  16 #include <stdexcept>
  17 #include <string>
  18 #include <type_traits>
  19 #include <utility>
  20
  21 #include <xbt/base.h>
  22 #include <xbt/config.h>
  23 #include <xbt/sysdep.h>
  24
  25 namespace simgrid {
  26 namespace config {
  27
  28 template<class T> inline
  29 std::string to_string(T&& value)
  30 {
  31   return std::to_string(std::forward<T>(value));
  32 }
  33 inline std::string const& to_string(std::string& value)
  34 {
  35   return value;
  36 }
  37 inline std::string const& to_string(std::string const& value)
  38 {
  39   return value;
  40 }
  41 inline std::string to_string(std::string&& value)
  42 {
  43   return std::move(value);
  44 }
  45
  46 // Get config
  47
  48 template <class T> XBT_PUBLIC T const& getConfig(const char* name);
  49
  50 extern template XBT_PUBLIC int const& getConfig<int>(const char* name);
  51 extern template XBT_PUBLIC double const& getConfig<double>(const char* name);
  52 extern template XBT_PUBLIC bool const& getConfig<bool>(const char* name);
  53 extern template XBT_PUBLIC std::string const& getConfig<std::string>(const char* name);
  54
  55 // Register:
  56
  57 /** Register a configuration flag
  58  *
  59  *  @param name        name of the option
  60  *  @param description Description of the option
  61  *  @param value       Initial/default value
  62  *  @param callback    called with the option value
  63  */
  64 template <class T>
  65 XBT_PUBLIC void declareFlag(const char* name, const char* description, T value,
  66                             std::function<void(const T&)> callback = std::function<void(const T&)>());
  67
  68 extern template XBT_PUBLIC void declareFlag(const char* name, const char* description, int value,
  69                                             std::function<void(int const&)> callback);
  70 extern template XBT_PUBLIC void declareFlag(const char* name, const char* description, double value,
  71                                             std::function<void(double const&)> callback);
  72 extern template XBT_PUBLIC void declareFlag(const char* name, const char* description, bool value,
  73                                             std::function<void(bool const&)> callback);
  74 extern template XBT_PUBLIC void declareFlag(const char* name, const char* description, std::string value,
  75                                             std::function<void(std::string const&)> callback);
  76
  77 // ***** alias *****
  78
  79 XBT_PUBLIC void alias(const char* realname, const char* aliasname);
  80
  81 inline
  82 void alias(std::initializer_list<const char*> names)
  83 {
  84   auto i = names.begin();
  85   for (++i; i != names.end(); ++i)
  86     alias(*names.begin(), *i);
  87 }
  88
  89 /** Bind a variable to configuration flag
  90  *
  91  *  @param value Bound variable
  92  *  @param name  Flag name
  93  *  @param description Option description
  94  */
  95 template<class T>
  96 void bindFlag(T& value, const char* name, const char* description)
  97 {
  98   declareFlag<T>(name, description, value, [&value](T const& val) {
  99     value = val;
 100   });
 101 }
 102
 103 template<class T>
 104 void bindFlag(T& value, std::initializer_list<const char*> names, const char* description)
 105 {
 106   bindFlag(value, *names.begin(), description);
 107   alias(names);
 108 }
 109
 110 /** Bind a variable to configuration flag
 111  *
 112  *  <pre><code>
 113  *  static int x;
 114  *  simgrid::config::bindFlag(a, "x", [](int x) {
 115  *    if (x < x_min || x => x_max)
 116  *      throw std::range_error("must be in [x_min, x_max)")
 117  *  });
 118  *  </code></pre>
 119  */
 120 // F is a checker, F : T& -> ()
 121 template <class T, class F>
 122 typename std::enable_if<std::is_same<void, decltype(std::declval<F>()(std::declval<const T&>()))>::value, void>::type
 123 bindFlag(T& value, const char* name, const char* description, F callback)
 124 {
 125   declareFlag(name, description, value, std::function<void(const T&)>([&value, callback](const T& val) {
 126                 callback(val);
 127                 value = std::move(val);
 128               }));
 129 }
 130
 131 template <class T, class F>
 132 typename std::enable_if<std::is_same<void, decltype(std::declval<F>()(std::declval<const T&>()))>::value, void>::type
 133 bindFlag(T& value, std::initializer_list<const char*> names, const char* description, F callback)
 134 {
 135   bindFlag(value, *names.begin(), description, std::move(callback));
 136   alias(names);
 137 }
 138
 139 template <class T, class F>
 140 typename std::enable_if<std::is_same<void, decltype(std::declval<F>()(std::declval<const T&>()))>::value, void>::type
 141 bindFlag(T& value, const char* name, const char* description, std::map<T, std::string> valid_values, F callback)
 142 {
 143   declareFlag(name, description, value,
 144               std::function<void(const T&)>([&value, name, valid_values, callback](const T& val) {
 145                 callback(val);
 146                 bool found = false;
 147                 for (auto kv : valid_values) {
 148                   if (kv.first == val)
 149                     found = true;
 150                 }
 151                 if (not found || std::string(val) == "help") {
 152                   std::string mesg;
 153                   if (std::string(val) == "help")
 154                     mesg = std::string("\nPossible values for option ") + name + ":\n";
 155                   else
 156                     mesg = std::string("\nInvalid value '") + val + "' for option " + name + ". Possible values:\n";
 157                   for (auto kv : valid_values)
 158                     mesg += "  - '" + std::string(kv.first) + "': " + kv.second +
 159                             (kv.first == value ? "  <=== DEFAULT" : "") + "\n";
 160                   xbt_die("%s", mesg.c_str());
 161                 }
 162                 value = std::move(val);
 163               }));
 164 }
 165 /** Bind a variable to configuration flag
 166  *
 167  *  <pre><code>
 168  *  static int x;
 169  *  simgrid::config::bindFlag(a, "x", [](int x) { return x > 0; });
 170  *  </code></pre>
 171  */
 172 // F is a predicate, F : T const& -> bool
 173 template<class T, class F>
 174 typename std::enable_if<std::is_same<
 175   bool,
 176   decltype( std::declval<F>()(std::declval<const T&>()) )
 177 >::value, void>::type
 178 bindFlag(T& value, const char* name, const char* description,
 179   F callback)
 180 {
 181   declareFlag(name, description, value, std::function<void(const T&)>([&value, callback](const T& val) {
 182                 if (not callback(val))
 183                   throw std::range_error("invalid value.");
 184                 value = std::move(val);
 185               }));
 186 }
 187
 188 /** A variable bound to a CLI option
 189  *
 190  *  <pre><code>
 191  *  static simgrid::config::flag<int> answer("answer", "Expected answer", 42);
 192  *  static simgrid::config::flag<std::string> name("name", "Ford Perfect", "John Doe");
 193  *  static simgrid::config::flag<double> gamma("gamma", "Gamma factor", 1.987);
 194  *  </code></pre>
 195  */
 196 template<class T>
 197 class Flag {
 198   T value_;
 199 public:
 200
 201   /** Constructor
 202    *
 203    *  @param name  Flag name
 204    *  @param desc  Flag description
 205    *  @param value Flag initial/default value
 206    */
 207   Flag(const char* name, const char* desc, T value) : value_(value)
 208   {
 209     simgrid::config::bindFlag(value_, name, desc);
 210   }
 211
 212   /** Constructor taking an array of aliases as name */
 213   Flag(std::initializer_list<const char*> names, const char* desc, T value) : value_(value)
 214   {
 215     simgrid::config::bindFlag(value_, names, desc);
 216   }
 217
 218   /* A constructor accepting a callback that will be passed the parameter.
 219    * It can either return a boolean (informing whether the parameter is valid), or returning void.
 220    */
 221   template<class F>
 222   Flag(const char* name, const char* desc, T value, F callback) : value_(value)
 223   {
 224     simgrid::config::bindFlag(value_, name, desc, std::move(callback));
 225   }
 226
 227   /* A constructor accepting a map of valid values -> their description,
 228    * and producing an informative error message when an invalid value is passed, or when help is passed as a value.
 229    */
 230   template <class F>
 231   Flag(const char* name, const char* desc, T value, std::map<T, std::string> valid_values, F callback) : value_(value)
 232   {
 233     simgrid::config::bindFlag(value_, name, desc, std::move(valid_values), std::move(callback));
 234   }
 235
 236   // No copy:
 237   Flag(Flag const&) = delete;
 238   Flag& operator=(Flag const&) = delete;
 239
 240   // Get the underlying value:
 241   T& get() { return value_; }
 242   T const& get() const { return value_; }
 243
 244   // Implicit conversion to the underlying type:
 245   operator T&() { return value_; }
 246   operator T const&() const{ return value_; }
 247
 248   // Basic interop with T:
 249   template<class U>
 250   Flag& operator=(U const& that) { value_ = that; return *this; }
 251   template<class U>
 252   Flag& operator=(U && that)     { value_ = that; return *this; }
 253   template<class U>
 254   bool operator==(U const& that) const { return value_ == that; }
 255   template<class U>
 256   bool operator!=(U const& that) const { return value_ != that; }
 257   template<class U>
 258   bool operator<(U const& that) const { return value_ < that; }
 259   template<class U>
 260   bool operator>(U const& that) const { return value_ > that; }
 261   template<class U>
 262   bool operator<=(U const& that) const { return value_ <= that; }
 263   template<class U>
 264   bool operator>=(U const& that) const { return value_ >= that; }
 265 };
 266
 267 }
 268 }
 269 XBT_PUBLIC std::string xbt_cfg_get_string(const char* name);
 270
 271 #endif