X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/96cedde3cdbc0b8ffc3f096a1b65d021b0226f99..cc2b1c368ba0d6b499b4f65db23d9f0b6d098aac:/include/xbt/config.hpp?ds=sidebyside diff --git a/include/xbt/config.hpp b/include/xbt/config.hpp index ebcdd6512f..397870e61c 100644 --- a/include/xbt/config.hpp +++ b/include/xbt/config.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2016-2019. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2016-2022. 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. */ @@ -20,6 +20,7 @@ #include #include +#include namespace simgrid { namespace config { @@ -65,16 +66,20 @@ extern template XBT_PUBLIC void set_value(const char* name, bool value); extern template XBT_PUBLIC void set_value(const char* name, std::string value); XBT_PUBLIC void set_as_string(const char* name, const std::string& value); -XBT_PUBLIC void set_parse(std::string options); +XBT_PUBLIC void set_parse(const std::string& options); // Get config -template XBT_PUBLIC T const& get_value(std::string name); +template XBT_PUBLIC T const& get_value(const std::string& name); -extern template XBT_PUBLIC int const& get_value(std::string name); -extern template XBT_PUBLIC double const& get_value(std::string name); -extern template XBT_PUBLIC bool const& get_value(std::string name); -extern template XBT_PUBLIC std::string const& get_value(std::string name); +extern template XBT_PUBLIC int const& get_value(const std::string& name); +extern template XBT_PUBLIC double const& get_value(const std::string& name); +extern template XBT_PUBLIC bool const& get_value(const std::string& name); +extern template XBT_PUBLIC std::string const& get_value(const std::string& name); + +// ***** alias ***** + +XBT_PUBLIC void alias(const char* realname, std::initializer_list aliases); // Register: @@ -86,22 +91,25 @@ extern template XBT_PUBLIC std::string const& get_value(std::string * @param callback called with the option value */ template -XBT_PUBLIC void declare_flag(std::string name, std::string description, T value, +XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, T value, std::function callback = std::function()); +template +void declare_flag(const std::string& name, std::initializer_list aliases, const std::string& description, + T value, std::function callback = std::function()) +{ + declare_flag(name, description, std::move(value), std::move(callback)); + alias(name.c_str(), aliases); +} -extern template XBT_PUBLIC void declare_flag(std::string name, std::string description, int value, +extern template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, int value, std::function callback); -extern template XBT_PUBLIC void declare_flag(std::string name, std::string description, double value, +extern template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, double value, std::function callback); -extern template XBT_PUBLIC void declare_flag(std::string name, std::string description, bool value, +extern template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, bool value, std::function callback); -extern template XBT_PUBLIC void declare_flag(std::string name, std::string description, std::string value, +extern template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, std::string value, std::function callback); -// ***** alias ***** - -XBT_PUBLIC void alias(const char* realname, std::initializer_list aliases); - /** Bind a variable to configuration flag * * @param value Bound variable @@ -117,7 +125,7 @@ template void bind_flag(T& value, const char* name, std::initializer_list aliases, const char* description) { bind_flag(value, name, description); - alias(name, std::move(aliases)); + alias(name, aliases); } /** Bind a variable to configuration flag @@ -132,7 +140,7 @@ void bind_flag(T& value, const char* name, std::initializer_list al */ // F is a checker, F : T& -> () template -typename std::enable_if()(std::declval()))>::value, void>::type +typename std::enable_if_t()(std::declval()))>::value, void> bind_flag(T& value, const char* name, const char* description, F callback) { declare_flag(name, description, value, std::function([&value, callback](const T& val) { @@ -142,46 +150,44 @@ bind_flag(T& value, const char* name, const char* description, F callback) } template -typename std::enable_if()(std::declval()))>::value, void>::type +typename std::enable_if_t()(std::declval()))>::value, void> bind_flag(T& value, const char* name, std::initializer_list aliases, const char* description, F callback) { bind_flag(value, name, description, std::move(callback)); - alias(name, std::move(aliases)); + alias(name, aliases); } -template -typename std::enable_if()(std::declval()))>::value, void>::type -bind_flag(T& value, const char* name, const char* description, std::map valid_values, F callback) +template +typename std::enable_if_t()(std::declval()))>::value, + void> +bind_flag(std::string& value, const char* name, const char* description, + const std::map>& valid_values, F callback) { declare_flag(name, description, value, - std::function([&value, name, valid_values, callback](const T& val) { + std::function([&value, name, valid_values, callback](const std::string& 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 = std::string("\n"); - if (std::string(val) == "help") - mesg += std::string("Possible values for option ") + name + ":\n"; - else - mesg += std::string("Invalid 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()); + if (valid_values.find(val) != valid_values.end()) { + value = val; + return; } - value = std::move(val); + std::string mesg = "\n"; + if (val == "help") + mesg += std::string("Possible values for option ") + name + ":\n"; + else + mesg += std::string("Invalid value '") + val + "' for option " + name + ". Possible values:\n"; + for (auto const& kv : valid_values) + mesg += " - '" + kv.first + "': " + kv.second + (kv.first == value ? " <=== DEFAULT" : "") + "\n"; + xbt_die("%s", mesg.c_str()); })); } -template -typename std::enable_if()(std::declval()))>::value, void>::type -bind_flag(T& value, const char* name, std::initializer_list aliases, const char* description, - std::map valid_values, F callback) +template +typename std::enable_if_t()(std::declval()))>::value, + void> +bind_flag(std::string& value, const char* name, std::initializer_list aliases, const char* description, + const std::map>& valid_values, F callback) { - bind_flag(value, name, description, std::move(valid_values), std::move(callback)); - alias(name, std::move(aliases)); + bind_flag(value, name, description, valid_values, std::move(callback)); + alias(name, aliases); } /** Bind a variable to configuration flag @@ -193,7 +199,7 @@ bind_flag(T& value, const char* name, std::initializer_list aliases */ // F is a predicate, F : T const& -> bool template -typename std::enable_if()(std::declval()))>::value, void>::type +typename std::enable_if_t()(std::declval()))>::value, void> bind_flag(T& value, const char* name, const char* description, F callback) { declare_flag(name, description, value, std::function([&value, callback](const T& val) { @@ -206,9 +212,9 @@ bind_flag(T& value, const char* name, const char* description, F callback) /** A variable bound to a CLI option * *

- *  static simgrid::config::flag answer("answer", "Expected answer", 42);
- *  static simgrid::config::flag name("name", "Ford Perfect", "John Doe");
- *  static simgrid::config::flag gamma("gamma", "Gamma factor", 1.987);
+ *  static simgrid::config::Flag answer("answer", "Expected answer", 42);
+ *  static simgrid::config::Flag name("name", "Ford Perfect", "John Doe");
+ *  static simgrid::config::Flag gamma("gamma", "Gamma factor", 1.987);
  *  
*/ template @@ -217,57 +223,59 @@ class Flag { std::string name_; public: - /** Constructor * * @param name Flag name * @param desc Flag description * @param value Flag initial/default value */ - Flag(const char* name, const char* desc, T value) : value_(value), name_(name) + Flag(const char* name, const char* desc, xbt::type_identity_t value) : value_(value), name_(name) { simgrid::config::bind_flag(value_, name, desc); } /** Constructor taking also an array of aliases for name */ - Flag(const char* name, std::initializer_list aliases, const char* desc, T value) + Flag(const char* name, std::initializer_list aliases, const char* desc, xbt::type_identity_t value) : value_(value), name_(name) { - simgrid::config::bind_flag(value_, name, std::move(aliases), desc); + simgrid::config::bind_flag(value_, name, 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 Flag(const char* name, const char* desc, T value, F callback) : value_(value), name_(name) + template + Flag(const char* name, const char* desc, xbt::type_identity_t value, F callback) : value_(value), name_(name) { simgrid::config::bind_flag(value_, name, desc, std::move(callback)); } template - Flag(const char* name, std::initializer_list aliases, const char* desc, T value, F callback) + Flag(const char* name, std::initializer_list aliases, const char* desc, xbt::type_identity_t value, + F callback) : value_(value), name_(name) { - simgrid::config::bind_flag(value_, name, std::move(aliases), desc, std::move(callback)); + simgrid::config::bind_flag(value_, name, 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 - Flag(const char* name, const char* desc, T value, std::map valid_values, F callback) + Flag(const char* name, const char* desc, xbt::type_identity_t value, + const std::map>& valid_values, F callback) : value_(value), name_(name) { - simgrid::config::bind_flag(value_, name, desc, std::move(valid_values), std::move(callback)); + simgrid::config::bind_flag(value_, name, desc, valid_values, std::move(callback)); } /* A constructor with everything */ template - Flag(const char* name, std::initializer_list aliases, const char* desc, T value, - std::map valid_values, F callback) + Flag(const char* name, std::initializer_list aliases, const char* desc, xbt::type_identity_t value, + const std::map>& valid_values, F callback) : value_(value), name_(name) { - simgrid::config::bind_flag(value_, name, std::move(aliases), desc, std::move(valid_values), std::move(callback)); + simgrid::config::bind_flag(value_, name, aliases, desc, valid_values, std::move(callback)); } // No copy: @@ -278,7 +286,7 @@ public: T& get() { return value_; } T const& get() const { return value_; } - std::string get_name() const { return name_; } + const std::string& get_name() const { return name_; } // Implicit conversion to the underlying type: operator T&() { return value_; } operator T const&() const{ return value_; } @@ -287,7 +295,7 @@ public: template Flag& operator=(U const& that) { value_ = that; return *this; } template - Flag& operator=(U && that) { value_ = that; return *this; } + Flag& operator=(U&& that) { value_ = std::forward(that); return *this; } template bool operator==(U const& that) const { return value_ == that; } template @@ -305,9 +313,8 @@ public: XBT_PUBLIC void finalize(); XBT_PUBLIC void show_aliases(); XBT_PUBLIC void help(); -} -} -XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::get_value") XBT_PUBLIC std::string - xbt_cfg_get_string(const char* name); + +} // namespace config +} // namespace simgrid #endif