1 /* Copyright (c) 2016-2021. The SimGrid Team. All rights reserved. */
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. */
14 #include <initializer_list>
18 #include <type_traits>
22 #include <xbt/sysdep.h>
29 template<class T> inline
30 std::string to_string(T&& value)
32 return std::to_string(std::forward<T>(value));
34 inline std::string const& to_string(std::string& value)
38 inline std::string const& to_string(std::string const& value)
42 inline std::string to_string(std::string&& value)
44 return std::move(value);
49 template <class T> XBT_PUBLIC void set_default(const char* name, T value);
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);
56 XBT_PUBLIC bool is_default(const char* name);
60 template <class T> XBT_PUBLIC void set_value(const char* name, T value);
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);
67 XBT_PUBLIC void set_as_string(const char* name, const std::string& value);
68 XBT_PUBLIC void set_parse(const std::string& options);
72 template <class T> XBT_PUBLIC T const& get_value(const std::string& name);
74 extern template XBT_PUBLIC int const& get_value<int>(const std::string& name);
75 extern template XBT_PUBLIC double const& get_value<double>(const std::string& name);
76 extern template XBT_PUBLIC bool const& get_value<bool>(const std::string& name);
77 extern template XBT_PUBLIC std::string const& get_value<std::string>(const std::string& name);
81 /** Register a configuration flag
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
89 XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, T value,
90 std::function<void(const T&)> callback = std::function<void(const T&)>());
92 extern template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, int value,
93 std::function<void(int const&)> callback);
94 extern template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, double value,
95 std::function<void(double const&)> callback);
96 extern template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, bool value,
97 std::function<void(bool const&)> callback);
98 extern template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, std::string value,
99 std::function<void(std::string const&)> callback);
103 XBT_PUBLIC void alias(const char* realname, std::initializer_list<const char*> aliases);
105 /** Bind a variable to configuration flag
107 * @param value Bound variable
108 * @param name Flag name
109 * @param description Option description
111 template <class T> void bind_flag(T& value, const char* name, const char* description)
113 declare_flag<T>(name, description, value, [&value](T const& val) { value = val; });
117 void bind_flag(T& value, const char* name, std::initializer_list<const char*> aliases, const char* description)
119 bind_flag(value, name, description);
120 alias(name, aliases);
123 /** Bind a variable to configuration flag
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)")
133 // F is a checker, F : T& -> ()
134 template <class T, class F>
135 typename std::enable_if_t<std::is_same<void, decltype(std::declval<F>()(std::declval<const T&>()))>::value, void>
136 bind_flag(T& value, const char* name, const char* description, F callback)
138 declare_flag(name, description, value, std::function<void(const T&)>([&value, callback](const T& val) {
140 value = std::move(val);
144 template <class T, class F>
145 typename std::enable_if_t<std::is_same<void, decltype(std::declval<F>()(std::declval<const T&>()))>::value, void>
146 bind_flag(T& value, const char* name, std::initializer_list<const char*> aliases, const char* description, F callback)
148 bind_flag(value, name, description, std::move(callback));
149 alias(name, aliases);
153 typename std::enable_if_t<std::is_same<void, decltype(std::declval<F>()(std::declval<const std::string&>()))>::value,
155 bind_flag(std::string& value, const char* name, const char* description,
156 const std::map<std::string, std::string, std::less<>>& valid_values, F callback)
158 declare_flag(name, description, value,
159 std::function<void(const std::string&)>([&value, name, valid_values, callback](const std::string& val) {
161 if (valid_values.find(val) != valid_values.end()) {
165 std::string mesg = "\n";
167 mesg += std::string("Possible values for option ") + name + ":\n";
169 mesg += std::string("Invalid value '") + val + "' for option " + name + ". Possible values:\n";
170 for (auto const& kv : valid_values)
171 mesg += " - '" + kv.first + "': " + kv.second + (kv.first == value ? " <=== DEFAULT" : "") + "\n";
172 xbt_die("%s", mesg.c_str());
176 typename std::enable_if_t<std::is_same<void, decltype(std::declval<F>()(std::declval<const std::string&>()))>::value,
178 bind_flag(std::string& value, const char* name, std::initializer_list<const char*> aliases, const char* description,
179 const std::map<std::string, std::string, std::less<>>& valid_values, F callback)
181 bind_flag(value, name, description, valid_values, std::move(callback));
182 alias(name, aliases);
185 /** Bind a variable to configuration flag
189 * simgrid::config::bind_flag(a, "x", [](int x) { return x > 0; });
192 // F is a predicate, F : T const& -> bool
193 template <class T, class F>
194 typename std::enable_if_t<std::is_same<bool, decltype(std::declval<F>()(std::declval<const T&>()))>::value, void>
195 bind_flag(T& value, const char* name, const char* description, F callback)
197 declare_flag(name, description, value, std::function<void(const T&)>([&value, callback](const T& val) {
198 if (not callback(val))
199 throw std::range_error("invalid value.");
200 value = std::move(val);
204 /** A variable bound to a CLI option
207 * static simgrid::config::flag<int> answer("answer", "Expected answer", 42);
208 * static simgrid::config::flag<std::string> name("name", "Ford Perfect", "John Doe");
209 * static simgrid::config::flag<double> gamma("gamma", "Gamma factor", 1.987);
220 * @param name Flag name
221 * @param desc Flag description
222 * @param value Flag initial/default value
224 Flag(const char* name, const char* desc, T value) : value_(value), name_(name)
226 simgrid::config::bind_flag(value_, name, desc);
229 /** Constructor taking also an array of aliases for name */
230 Flag(const char* name, std::initializer_list<const char*> aliases, const char* desc, T value)
231 : value_(value), name_(name)
233 simgrid::config::bind_flag(value_, name, aliases, desc);
236 /* A constructor accepting a callback that will be passed the parameter.
237 * It can either return a boolean (informing whether the parameter is valid), or returning void.
239 template <class F> Flag(const char* name, const char* desc, T value, F callback) : value_(value), name_(name)
241 simgrid::config::bind_flag(value_, name, desc, std::move(callback));
245 Flag(const char* name, std::initializer_list<const char*> aliases, const char* desc, T value, F callback)
246 : value_(value), name_(name)
248 simgrid::config::bind_flag(value_, name, aliases, desc, std::move(callback));
251 /* A constructor accepting a map of valid values -> their description,
252 * and producing an informative error message when an invalid value is passed, or when help is passed as a value.
255 Flag(const char* name, const char* desc, T value, const std::map<std::string, std::string, std::less<>>& valid_values,
257 : value_(value), name_(name)
259 simgrid::config::bind_flag(value_, name, desc, valid_values, std::move(callback));
262 /* A constructor with everything */
264 Flag(const char* name, std::initializer_list<const char*> aliases, const char* desc, T value,
265 const std::map<std::string, std::string, std::less<>>& valid_values, F callback)
266 : value_(value), name_(name)
268 simgrid::config::bind_flag(value_, name, aliases, desc, valid_values, std::move(callback));
272 Flag(Flag const&) = delete;
273 Flag& operator=(Flag const&) = delete;
275 // Get the underlying value:
276 T& get() { return value_; }
277 T const& get() const { return value_; }
279 const std::string& get_name() const { return name_; }
280 // Implicit conversion to the underlying type:
281 operator T&() { return value_; }
282 operator T const&() const{ return value_; }
284 // Basic interop with T:
286 Flag& operator=(U const& that) { value_ = that; return *this; }
288 Flag& operator=(U&& that) { value_ = std::forward<U>(that); return *this; }
290 bool operator==(U const& that) const { return value_ == that; }
292 bool operator!=(U const& that) const { return value_ != that; }
294 bool operator<(U const& that) const { return value_ < that; }
296 bool operator>(U const& that) const { return value_ > that; }
298 bool operator<=(U const& that) const { return value_ <= that; }
300 bool operator>=(U const& that) const { return value_ >= that; }
303 XBT_PUBLIC void finalize();
304 XBT_PUBLIC void show_aliases();
305 XBT_PUBLIC void help();
306 } // namespace config
307 } // namespace simgrid