Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge pull request #302 from mpoquet/rename-s4u-synchro-examples
[simgrid.git] / 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/sysdep.h>
23
24 namespace simgrid {
25 namespace config {
26
27 class Config;
28
29 template<class T> inline
30 std::string to_string(T&& value)
31 {
32   return std::to_string(std::forward<T>(value));
33 }
34 inline std::string const& to_string(std::string& value)
35 {
36   return value;
37 }
38 inline std::string const& to_string(std::string const& value)
39 {
40   return value;
41 }
42 inline std::string to_string(std::string&& value)
43 {
44   return std::move(value);
45 }
46
47 // Set default
48
49 template <class T> XBT_PUBLIC void set_default(const char* name, T value);
50
51 extern template XBT_PUBLIC void set_default<int>(const char* name, int value);
52 extern template XBT_PUBLIC void set_default<double>(const char* name, double value);
53 extern template XBT_PUBLIC void set_default<bool>(const char* name, bool value);
54 extern template XBT_PUBLIC void set_default<std::string>(const char* name, std::string value);
55
56 XBT_PUBLIC bool is_default(const char* name);
57
58 // Set config
59
60 template <class T> XBT_PUBLIC void set_value(const char* name, T value);
61
62 extern template XBT_PUBLIC void set_value<int>(const char* name, int value);
63 extern template XBT_PUBLIC void set_value<double>(const char* name, double value);
64 extern template XBT_PUBLIC void set_value<bool>(const char* name, bool value);
65 extern template XBT_PUBLIC void set_value<std::string>(const char* name, std::string value);
66
67 XBT_PUBLIC void set_as_string(const char* name, const std::string& value);
68 XBT_PUBLIC void set_parse(std::string options);
69
70 // Get config
71
72 template <class T> XBT_PUBLIC T const& get_value(std::string name);
73
74 extern template XBT_PUBLIC int const& get_value<int>(std::string name);
75 extern template XBT_PUBLIC double const& get_value<double>(std::string name);
76 extern template XBT_PUBLIC bool const& get_value<bool>(std::string name);
77 extern template XBT_PUBLIC std::string const& get_value<std::string>(std::string name);
78
79 // Register:
80
81 /** Register a configuration flag
82  *
83  *  @param name        name of the option
84  *  @param description Description of the option
85  *  @param value       Initial/default value
86  *  @param callback    called with the option value
87  */
88 template <class T>
89 XBT_PUBLIC void declare_flag(std::string name, std::string description, T value,
90                              std::function<void(const T&)> callback = std::function<void(const T&)>());
91
92 extern template XBT_PUBLIC void declare_flag(std::string name, std::string description, int value,
93                                              std::function<void(int const&)> callback);
94 extern template XBT_PUBLIC void declare_flag(std::string name, std::string description, double value,
95                                              std::function<void(double const&)> callback);
96 extern template XBT_PUBLIC void declare_flag(std::string name, std::string description, bool value,
97                                              std::function<void(bool const&)> callback);
98 extern template XBT_PUBLIC void declare_flag(std::string name, std::string description, std::string value,
99                                              std::function<void(std::string const&)> callback);
100
101 // ***** alias *****
102
103 XBT_PUBLIC void alias(const char* realname, std::initializer_list<const char*> aliases);
104
105 /** Bind a variable to configuration flag
106  *
107  *  @param value Bound variable
108  *  @param name  Flag name
109  *  @param description Option description
110  */
111 template <class T> void bind_flag(T& value, const char* name, const char* description)
112 {
113   declare_flag<T>(name, description, value, [&value](T const& val) { value = val; });
114 }
115
116 template <class T>
117 void bind_flag(T& value, const char* name, std::initializer_list<const char*> aliases, const char* description)
118 {
119   bind_flag(value, name, description);
120   alias(name, std::move(aliases));
121 }
122
123 /** Bind a variable to configuration flag
124  *
125  *  <pre><code>
126  *  static int x;
127  *  simgrid::config::bind_flag(a, "x", [](int x) {
128  *    if (x < x_min || x => x_max)
129  *      throw std::range_error("must be in [x_min, x_max)")
130  *  });
131  *  </code></pre>
132  */
133 // F is a checker, F : T& -> ()
134 template <class T, class F>
135 typename std::enable_if<std::is_same<void, decltype(std::declval<F>()(std::declval<const T&>()))>::value, void>::type
136 bind_flag(T& value, const char* name, const char* description, F callback)
137 {
138   declare_flag(name, description, value, std::function<void(const T&)>([&value, callback](const T& val) {
139                  callback(val);
140                  value = std::move(val);
141                }));
142 }
143
144 template <class T, class F>
145 typename std::enable_if<std::is_same<void, decltype(std::declval<F>()(std::declval<const T&>()))>::value, void>::type
146 bind_flag(T& value, const char* name, std::initializer_list<const char*> aliases, const char* description, F callback)
147 {
148   bind_flag(value, name, description, std::move(callback));
149   alias(name, std::move(aliases));
150 }
151
152 template <class T, class F>
153 typename std::enable_if<std::is_same<void, decltype(std::declval<F>()(std::declval<const T&>()))>::value, void>::type
154 bind_flag(T& value, const char* name, const char* description, std::map<T, std::string> valid_values, F callback)
155 {
156   declare_flag(name, description, value,
157                std::function<void(const T&)>([&value, name, valid_values, callback](const T& val) {
158                  callback(val);
159                  bool found = false;
160                  for (auto kv : valid_values) {
161                    if (kv.first == val)
162                      found = true;
163                  }
164                  if (not found || std::string(val) == "help") {
165                    std::string mesg = std::string("\n");
166                    if (std::string(val) == "help")
167                      mesg += std::string("Possible values for option ") + name + ":\n";
168                    else
169                      mesg += std::string("Invalid value '") + val + "' for option " + name + ". Possible values:\n";
170                    for (auto kv : valid_values)
171                      mesg += "  - '" + std::string(kv.first) + "': " + kv.second +
172                              (kv.first == value ? "  <=== DEFAULT" : "") + "\n";
173                    xbt_die("%s", mesg.c_str());
174                  }
175                  value = std::move(val);
176                }));
177 }
178 template <class T, class F>
179 typename std::enable_if<std::is_same<void, decltype(std::declval<F>()(std::declval<const T&>()))>::value, void>::type
180 bind_flag(T& value, const char* name, std::initializer_list<const char*> aliases, const char* description,
181           std::map<T, std::string> valid_values, F callback)
182 {
183   bind_flag(value, name, description, std::move(valid_values), std::move(callback));
184   alias(name, std::move(aliases));
185 }
186
187 /** Bind a variable to configuration flag
188  *
189  *  <pre><code>
190  *  static int x;
191  *  simgrid::config::bind_flag(a, "x", [](int x) { return x > 0; });
192  *  </code></pre>
193  */
194 // F is a predicate, F : T const& -> bool
195 template <class T, class F>
196 typename std::enable_if<std::is_same<bool, decltype(std::declval<F>()(std::declval<const T&>()))>::value, void>::type
197 bind_flag(T& value, const char* name, const char* description, F callback)
198 {
199   declare_flag(name, description, value, std::function<void(const T&)>([&value, callback](const T& val) {
200                  if (not callback(val))
201                    throw std::range_error("invalid value.");
202                  value = std::move(val);
203                }));
204 }
205
206 /** A variable bound to a CLI option
207  *
208  *  <pre><code>
209  *  static simgrid::config::flag<int> answer("answer", "Expected answer", 42);
210  *  static simgrid::config::flag<std::string> name("name", "Ford Perfect", "John Doe");
211  *  static simgrid::config::flag<double> gamma("gamma", "Gamma factor", 1.987);
212  *  </code></pre>
213  */
214 template<class T>
215 class Flag {
216   T value_;
217   std::string name_;
218
219 public:
220
221   /** Constructor
222    *
223    *  @param name  Flag name
224    *  @param desc  Flag description
225    *  @param value Flag initial/default value
226    */
227   Flag(const char* name, const char* desc, T value) : value_(value), name_(name)
228   {
229     simgrid::config::bind_flag(value_, name, desc);
230   }
231
232   /** Constructor taking also an array of aliases for name */
233   Flag(const char* name, std::initializer_list<const char*> aliases, const char* desc, T value)
234       : value_(value), name_(name)
235   {
236     simgrid::config::bind_flag(value_, name, std::move(aliases), desc);
237   }
238
239   /* A constructor accepting a callback that will be passed the parameter.
240    * It can either return a boolean (informing whether the parameter is valid), or returning void.
241    */
242   template <class F> Flag(const char* name, const char* desc, T value, F callback) : value_(value), name_(name)
243   {
244     simgrid::config::bind_flag(value_, name, desc, std::move(callback));
245   }
246
247   template <class F>
248   Flag(const char* name, std::initializer_list<const char*> aliases, const char* desc, T value, F callback)
249       : value_(value), name_(name)
250   {
251     simgrid::config::bind_flag(value_, name, std::move(aliases), desc, std::move(callback));
252   }
253
254   /* A constructor accepting a map of valid values -> their description,
255    * and producing an informative error message when an invalid value is passed, or when help is passed as a value.
256    */
257   template <class F>
258   Flag(const char* name, const char* desc, T value, std::map<T, std::string> valid_values, F callback)
259       : value_(value), name_(name)
260   {
261     simgrid::config::bind_flag(value_, name, desc, std::move(valid_values), std::move(callback));
262   }
263
264   /* A constructor with everything */
265   template <class F>
266   Flag(const char* name, std::initializer_list<const char*> aliases, const char* desc, T value,
267        std::map<T, std::string> valid_values, F callback)
268       : value_(value), name_(name)
269   {
270     simgrid::config::bind_flag(value_, name, std::move(aliases), desc, std::move(valid_values), std::move(callback));
271   }
272
273   // No copy:
274   Flag(Flag const&) = delete;
275   Flag& operator=(Flag const&) = delete;
276
277   // Get the underlying value:
278   T& get() { return value_; }
279   T const& get() const { return value_; }
280
281   std::string get_name() const { return name_; }
282   // Implicit conversion to the underlying type:
283   operator T&() { return value_; }
284   operator T const&() const{ return value_; }
285
286   // Basic interop with T:
287   template<class U>
288   Flag& operator=(U const& that) { value_ = that; return *this; }
289   template<class U>
290   Flag& operator=(U && that)     { value_ = that; return *this; }
291   template<class U>
292   bool operator==(U const& that) const { return value_ == that; }
293   template<class U>
294   bool operator!=(U const& that) const { return value_ != that; }
295   template<class U>
296   bool operator<(U const& that) const { return value_ < that; }
297   template<class U>
298   bool operator>(U const& that) const { return value_ > that; }
299   template<class U>
300   bool operator<=(U const& that) const { return value_ <= that; }
301   template<class U>
302   bool operator>=(U const& that) const { return value_ >= that; }
303 };
304
305 XBT_PUBLIC void finalize();
306 XBT_PUBLIC void show_aliases();
307 XBT_PUBLIC void help();
308 }
309 }
310 XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::get_value<std::string>") XBT_PUBLIC std::string
311     xbt_cfg_get_string(const char* name);
312
313 #endif