X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/ebc5f7ed172f242031fc644120ce45f690b619bc..95199f4ffa751d3614a07fefe6b3caa6deca1b97:/include/xbt/config.hpp diff --git a/include/xbt/config.hpp b/include/xbt/config.hpp index f87f525c38..236d87f962 100644 --- a/include/xbt/config.hpp +++ b/include/xbt/config.hpp @@ -1,15 +1,21 @@ -/* Copyright (c) 2016. 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. */ -#ifndef _XBT_CONFIG_HPP_ -#define _XBT_CONFIG_HPP_ +#ifndef XBT_CONFIG_HPP +#define XBT_CONFIG_HPP + +#include + +#include #include +#include +#include #include #include +#include #include #include @@ -17,93 +23,41 @@ namespace simgrid { namespace config { -/** Get the base type of a e_xbt_cfgelm_type_t - * - * * `type` is the type used in the config framework to store - * the values of this type; - * - * * `get()` is used to get such a value from the configuration. - */ -template -struct base_type; -template<> struct base_type { - typedef bool type; - static inline bool get(const char* name) - { - return xbt_cfg_get_boolean(name) ? true : false; - } -}; -template<> struct base_type { - typedef int type; - static inline int get(const char* name) - { - return xbt_cfg_get_int(name); - } -}; -template<> struct base_type { - typedef double type; - static inline double get(const char* name) - { - return xbt_cfg_get_double(name); - } -}; -template<> struct base_type { - typedef std::string type; - static inline std::string get(const char* name) - { - char* value = xbt_cfg_get_string(name); - return value != nullptr ? value : ""; - } +class XBT_PUBLIC 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; }; -/** Associate the e_xbt_cfgelm_type_t to use for a given type */ -template -struct cfgelm_type : public std::integral_constant::value ? xbt_cfgelm_boolean : - std::is_integral::value ? xbt_cfgelm_int : - std::is_floating_point::value ? xbt_cfgelm_double : - xbt_cfgelm_string> -{}; - -/** Get a value of a given type from the configuration */ -template inline -T get(const char* name) -{ - return T(base_type::value>::get(name)); -} template inline -T get(std::string const& name) -{ - return T(base_type::value>::get(name.c_str())); -} - -inline void setDefault(const char* name, int value) -{ - xbt_cfg_setdefault_int(name, value); -} -inline void setDefault(const char* name, double value) +std::string to_string(T&& value) { - xbt_cfg_setdefault_double(name, value); + return std::to_string(std::forward(value)); } -inline void setDefault(const char* name, const char* value) +inline std::string const& to_string(std::string& value) { - xbt_cfg_setdefault_string(name, value); + return value; } -inline void setDefault(const char* name, std::string const& value) +inline std::string const& to_string(std::string const& value) { - xbt_cfg_setdefault_string(name, value.c_str()); + return value; } -inline void setDefault(const char* name, bool value) +inline std::string to_string(std::string&& value) { - xbt_cfg_setdefault_boolean(name, value ? "yes" : "no"); + return std::move(value); } -/** Set the default value of a given configuration option */ -template inline -void setDefault(const char* name, T value) -{ - setDefault(name, base_type::value>::type(value)); -} +// Get config + +template XBT_PUBLIC T const& getConfig(const char* name); + +extern template XBT_PUBLIC int const& getConfig(const char* name); +extern template XBT_PUBLIC double const& getConfig(const char* name); +extern template XBT_PUBLIC bool const& getConfig(const char* name); +extern template XBT_PUBLIC std::string const& getConfig(const char* name); // Register: @@ -111,12 +65,33 @@ void setDefault(const char* name, T value) * * @param name name of the option * @param description Description of the option - * @param type config storage type for the option - * @param callback called with the option name (expected to use `simgrid::config::get`) + * @param value Initial/default value + * @param callback called with the option value */ -XBT_PUBLIC(void) registerConfig(const char* name, const char* description, - e_xbt_cfgelm_type_t type, - std::function callback); +template +XBT_PUBLIC void declareFlag(const char* name, const char* description, T value, + std::function callback = std::function()); + +extern template XBT_PUBLIC void declareFlag(const char* name, const char* description, int value, + std::function callback); +extern template XBT_PUBLIC void declareFlag(const char* name, const char* description, double value, + std::function callback); +extern template XBT_PUBLIC void declareFlag(const char* name, const char* description, bool value, + std::function callback); +extern template XBT_PUBLIC void declareFlag(const char* name, const char* description, std::string value, + std::function callback); + +// ***** alias ***** + +XBT_PUBLIC void alias(const char* realname, const char* aliasname); + +inline +void alias(std::initializer_list names) +{ + auto i = names.begin(); + for (++i; i != names.end(); ++i) + alias(*names.begin(), *i); +} /** Bind a variable to configuration flag * @@ -125,42 +100,94 @@ XBT_PUBLIC(void) registerConfig(const char* name, const char* description, * @param description Option description */ template -void declareFlag(T& value, const char* name, const char* description) +void bindFlag(T& value, const char* name, const char* description) +{ + declareFlag(name, description, value, [&value](T const& val) { + value = val; + }); +} + +template +void bindFlag(T& value, std::initializer_list names, const char* description) { - registerConfig(name, description, cfgelm_type::value, - [&value](const char* name) { - value = simgrid::config::get(name); - }); - setDefault(name, value); + bindFlag(value, *names.begin(), description); + alias(names); } /** Bind a variable to configuration flag * - * @param value Bound variable - * @param name Flag name - * @param description Option description - * @f Callback (called with the option name) providing the value + *

+ *  static int x;
+ *  simgrid::config::bindFlag(a, "x", [](int x) {
+ *    if (x < x_min || x => x_max)
+ *      throw std::range_error("must be in [x_min, x_max)")
+ *  });
+ *  
+ */ +// F is a checker, F : T& -> () +template +typename std::enable_if()(std::declval()) ) +>::value, void>::type +bindFlag(T& value, std::initializer_list names, const char* description, + F callback) +{ + bindFlag(value, *names.begin(), description); + alias(names); +} + +template +typename std::enable_if()(std::declval()) ) +>::value, void>::type +bindFlag(T& value, const char* name, const char* description, + F callback) +{ + declareFlag(name, description, value, + std::function([&value,callback](const T& val) { + callback(val); + value = std::move(val); + } + )); +} + +/** Bind a variable to configuration flag + * + *

+ *  static int x;
+ *  simgrid::config::bindFlag(a, "x", [](int x) { return x > 0; });
+ *  
*/ +// F is a predicate, F : T const& -> bool template -void declareFlag(T& value, const char* name, const char* description, F f) +typename std::enable_if()(std::declval()) ) +>::value, void>::type +bindFlag(T& value, const char* name, const char* description, + F callback) { - registerConfig(name, description, cfgelm_type::value, - [&value,f](const char* name) { - value = f(name); - }); - setDefault(name, value); + declareFlag(name, description, value, + std::function([&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 * *

  *  static simgrid::config::flag answer("answer", "Expected answer", 42);
- *  static simgrid::config::flag name("name", "Ford Prefect", "John Doe");
+ *  static simgrid::config::flag name("name", "Ford Perfect", "John Doe");
  *  static simgrid::config::flag gamma("gamma", "Gamma factor", 1.987);
  *  
*/ template -class flag { +class Flag { T value_; public: @@ -170,14 +197,20 @@ public: * @param desc Flag description * @param value Flag initial/default value */ - flag(const char* name, const char* desc, T value) : value_(value) + Flag(const char* name, const char* desc, T value) : value_(value) { - declareFlag(value_, name, desc); + simgrid::config::bindFlag(value_, name, desc); + } + + template + Flag(const char* name, const char* desc, T value, F callback) : value_(value) + { + simgrid::config::bindFlag(value_, name, desc, std::move(callback)); } // No copy: - flag(flag const&) = delete; - flag& operator=(flag const&) = delete; + Flag(Flag const&) = delete; + Flag& operator=(Flag const&) = delete; // Get the underlying value: T& get() { return value_; } @@ -186,9 +219,28 @@ public: // Implicit conversion to the underlying type: operator T&() { return value_; } operator T const&() const{ return value_; } + + // Basic interop with T: + template + Flag& operator=(U const& that) { value_ = that; return *this; } + template + Flag& operator=(U && that) { value_ = that; return *this; } + template + bool operator==(U const& that) const { return value_ == that; } + template + bool operator!=(U const& that) const { return value_ != that; } + template + bool operator<(U const& that) const { return value_ < that; } + template + bool operator>(U const& that) const { return value_ > that; } + template + bool operator<=(U const& that) const { return value_ <= that; } + template + bool operator>=(U const& that) const { return value_ >= that; } }; } } +XBT_PUBLIC std::string xbt_cfg_get_string(const char* name); #endif