-/* Copyright (c) 2016-2017. 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. */
#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)
{
return std::move(value);
}
+// Set default
+
+template <class T> XBT_PUBLIC void set_default(const char* name, T value);
+
+extern template XBT_PUBLIC void set_default<int>(const char* name, int value);
+extern template XBT_PUBLIC void set_default<double>(const char* name, double value);
+extern template XBT_PUBLIC void set_default<bool>(const char* name, bool value);
+extern template XBT_PUBLIC void set_default<std::string>(const char* name, std::string value);
+
+// Set config
+
+template <class T> XBT_PUBLIC void set_value(const char* name, T value);
+
+extern template XBT_PUBLIC void set_value<int>(const char* name, int value);
+extern template XBT_PUBLIC void set_value<double>(const char* name, double value);
+extern template XBT_PUBLIC void set_value<bool>(const char* name, bool value);
+extern template XBT_PUBLIC void set_value<std::string>(const char* name, std::string value);
+
// Get config
-template<class T>
-XBT_PUBLIC(T const&) getConfig(const char* name);
+template <class T> XBT_PUBLIC T const& get_value(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& get_value<int>(const char* name);
+extern template XBT_PUBLIC double const& get_value<double>(const char* name);
+extern template XBT_PUBLIC bool const& get_value<bool>(const char* name);
+extern template XBT_PUBLIC std::string const& get_value<std::string>(const char* name);
// Register:
* @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 declare_flag(const char* name, const char* description, T value,
+ std::function<void(const T&)> callback = std::function<void(const T&)>());
+
+extern template XBT_PUBLIC void declare_flag(const char* name, const char* description, int value,
+ std::function<void(int const&)> callback);
+extern template XBT_PUBLIC void declare_flag(const char* name, const char* description, double value,
+ std::function<void(double const&)> callback);
+extern template XBT_PUBLIC void declare_flag(const char* name, const char* description, bool value,
+ std::function<void(bool const&)> callback);
+extern template XBT_PUBLIC void declare_flag(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);
-
-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
*
* @param name Flag name
* @param description Option description
*/
-template<class T>
-void bindFlag(T& value, const char* name, const char* description)
+template <class T> void bind_flag(T& value, const char* name, const char* description)
{
- declareFlag<T>(name, description, value, [&value](T const& val) {
- value = val;
- });
+ declare_flag<T>(name, description, value, [&value](T const& val) { value = val; });
}
-template<class T>
-void bindFlag(T& value, std::initializer_list<const char*> names, const char* description)
+template <class T>
+void bind_flag(T& value, const char* name, std::initializer_list<const char*> aliases, const char* description)
{
- bindFlag(value, *names.begin(), description);
- alias(names);
+ bind_flag(value, name, description);
+ alias(name, std::move(aliases));
}
/** Bind a variable to configuration flag
*
* <pre><code>
* static int x;
- * simgrid::config::bindFlag(a, "x", [](int x) {
+ * simgrid::config::bind_flag(a, "x", [](int x) {
* if (x < x_min || x => x_max)
* throw std::range_error("must be in [x_min, x_max)")
* });
* </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
+bind_flag(T& value, const char* name, const char* description, F callback)
{
- bindFlag(value, *names.begin(), description);
- alias(names);
+ declare_flag(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
+bind_flag(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);
- });
+ bind_flag(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
+bind_flag(T& value, const char* name, const char* description, std::map<T, std::string> valid_values, F callback)
+{
+ declare_flag(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::bind_flag(a, "x", [](int x) { return x > 0; });
* </code></pre>
*/
// F is a predicate, F : T const& -> bool
-template<class T, class F>
-typename std::enable_if<std::is_same<
- bool,
- 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<bool, decltype(std::declval<F>()(std::declval<const T&>()))>::value, void>::type
+bind_flag(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);
- });
+ declare_flag(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>
*/
*/
Flag(const char* name, const char* desc, T value) : value_(value)
{
- simgrid::config::bindFlag(value_, name, desc);
+ simgrid::config::bind_flag(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::bind_flag(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));
+ simgrid::config::bind_flag(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::bind_flag(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::bind_flag(value_, name, desc, std::move(valid_values), std::move(callback));
}
// No copy:
}
}
-XBT_PUBLIC(std::string) xbt_cfg_get_string(const char* name);
-XBT_PUBLIC(void) xbt_cfg_set_string(const char* name, std::string val);
+XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::get_value<std::string>") XBT_PUBLIC std::string
+ xbt_cfg_get_string(const char* name);
#endif
