X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/0ac754a3a1133fcb39c1a1ecb1a68649939c76ce..c4de3b4124781ae066e774981efb0a6ef8c857ed:/src/xbt/config.cpp diff --git a/src/xbt/config.cpp b/src/xbt/config.cpp index a172a49155..07d839f327 100644 --- a/src/xbt/config.cpp +++ b/src/xbt/config.cpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2004-2019. 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. */ @@ -19,6 +19,7 @@ #include #include +#include "simgrid/Exception.hpp" #include "simgrid/sg_config.hpp" #include "xbt/dynar.h" #include "xbt/log.h" @@ -26,7 +27,6 @@ #include "xbt/sysdep.h" #include #include -#include XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_cfg, xbt, "configuration support"); @@ -143,9 +143,8 @@ public: /* Callback */ xbt_cfg_cb_t old_callback = nullptr; - ConfigurationElement(const char* key, const char* desc) : key(key ? key : ""), desc(desc ? desc : "") {} - ConfigurationElement(const char* key, const char* desc, xbt_cfg_cb_t cb) - : key(key ? key : ""), desc(desc ? desc : ""), old_callback(cb) {} + ConfigurationElement(std::string key, std::string desc) : key(key), desc(desc) {} + ConfigurationElement(std::string key, std::string desc, xbt_cfg_cb_t cb) : key(key), desc(desc), old_callback(cb) {} virtual ~ConfigurationElement() = default; @@ -182,13 +181,13 @@ private: std::function callback; public: - TypedConfigurationElement(const char* key, const char* desc, T value = T()) - : ConfigurationElement(key, desc), content(std::move(value)) + TypedConfigurationElement(std::string key, std::string desc, T value = T()) + : ConfigurationElement(key, desc), content(std::move(value)) {} - TypedConfigurationElement(const char* key, const char* desc, T value, xbt_cfg_cb_t cb) + TypedConfigurationElement(std::string key, std::string desc, T value, xbt_cfg_cb_t cb) : ConfigurationElement(key, desc, cb), content(std::move(value)) {} - TypedConfigurationElement(const char* key, const char* desc, T value, std::function callback) + TypedConfigurationElement(std::string key, std::string desc, T value, std::function callback) : ConfigurationElement(key, desc), content(std::move(value)), callback(std::move(callback)) {} ~TypedConfigurationElement() = default; @@ -263,15 +262,16 @@ public: Config(Config const&) = delete; Config& operator=(Config const&) = delete; - ConfigurationElement& operator[](const char* name); - void alias(const char* realname, const char* aliasname); + ConfigurationElement& operator[](std::string name); + void alias(std::string realname, std::string aliasname); template - simgrid::config::TypedConfigurationElement* register_option(const char* name, A&&... a) + simgrid::config::TypedConfigurationElement* register_option(std::string name, A&&... a) { - xbt_assert(options.find(name) == options.end(), "Refusing to register the config element '%s' twice.", name); + xbt_assert(options.find(name) == options.end(), "Refusing to register the config element '%s' twice.", + name.c_str()); TypedConfigurationElement* variable = new TypedConfigurationElement(name, std::forward(a)...); - XBT_DEBUG("Register cfg elm %s (%s) of type %s @%p in set %p)", name, variable->get_description().c_str(), + XBT_DEBUG("Register cfg elm %s (%s) of type %s @%p in set %p)", name.c_str(), variable->get_description().c_str(), variable->get_type_name(), variable, this); options.insert({name, variable}); variable->update(); @@ -284,7 +284,7 @@ public: void help(); protected: - ConfigurationElement* get_dict_element(const char* name); + ConfigurationElement* get_dict_element(std::string name); }; Config::Config() @@ -298,7 +298,7 @@ Config::~Config() delete elm.second; } -inline ConfigurationElement* Config::get_dict_element(const char* name) +inline ConfigurationElement* Config::get_dict_element(std::string name) { auto opt = options.find(name); if (opt != options.end()) { @@ -308,24 +308,24 @@ inline ConfigurationElement* Config::get_dict_element(const char* name) if (als != aliases.end()) { ConfigurationElement* res = als->second; if (warn_for_aliases) - XBT_INFO("Option %s has been renamed to %s. Consider switching.", name, res->get_key().c_str()); + XBT_INFO("Option %s has been renamed to %s. Consider switching.", name.c_str(), res->get_key().c_str()); return res; } else { - THROWF(not_found_error, 0, "Bad config key: %s", name); + THROWF(not_found_error, 0, "Bad config key: %s", name.c_str()); } } } -inline ConfigurationElement& Config::operator[](const char* name) +inline ConfigurationElement& Config::operator[](std::string name) { return *(get_dict_element(name)); } -void Config::alias(const char* realname, const char* aliasname) +void Config::alias(std::string realname, std::string aliasname) { - xbt_assert(aliases.find(aliasname) == aliases.end(), "Alias '%s' already.", aliasname); + xbt_assert(aliases.find(aliasname) == aliases.end(), "Alias '%s' already.", aliasname.c_str()); ConfigurationElement* element = this->get_dict_element(realname); - xbt_assert(element, "Cannot define an alias to the non-existing option '%s'.", realname); + xbt_assert(element, "Cannot define an alias to the non-existing option '%s'.", realname.c_str()); this->aliases.insert({aliasname, element}); } @@ -366,17 +366,84 @@ void Config::help() } } -// ***** get_config ***** +// ***** set_default ***** + +template XBT_PUBLIC void set_default(const char* name, T value) +{ + (*simgrid_config)[name].set_default_value(std::move(value)); +} + +template XBT_PUBLIC void set_default(const char* name, int value); +template XBT_PUBLIC void set_default(const char* name, double value); +template XBT_PUBLIC void set_default(const char* name, bool value); +template XBT_PUBLIC void set_default(const char* name, std::string value); + +bool is_default(const char* name) +{ + return (*simgrid_config)[name].is_default(); +} + +// ***** set_value ***** + +template XBT_PUBLIC void set_value(const char* name, T value) +{ + (*simgrid_config)[name].set_value(std::move(value)); +} + +template XBT_PUBLIC void set_value(const char* name, int value); +template XBT_PUBLIC void set_value(const char* name, double value); +template XBT_PUBLIC void set_value(const char* name, bool value); +template XBT_PUBLIC void set_value(const char* name, std::string value); + +void set_as_string(const char* name, const std::string& value) +{ + (*simgrid_config)[name].set_string_value(value.c_str()); +} + +void set_parse(std::string options) +{ + XBT_DEBUG("List to parse and set:'%s'", options.c_str()); + while (not options.empty()) { + XBT_DEBUG("Still to parse and set: '%s'", options.c_str()); + + // skip separators + size_t pos = options.find_first_not_of(" \t\n,"); + options.erase(0, pos); + // find option + pos = options.find_first_of(" \t\n,"); + std::string name = options.substr(0, pos); + options.erase(0, pos); + XBT_DEBUG("parse now:'%s'; parse later:'%s'", name.c_str(), options.c_str()); + + if (name.empty()) + continue; + + pos = name.find(':'); + xbt_assert(pos != std::string::npos, "Option '%s' badly formatted. Should be of the form 'name:value'", + name.c_str()); + + std::string val = name.substr(pos + 1); + name.erase(pos); + + const std::string path("path"); + if (name.compare(0, path.length(), path) != 0) + XBT_INFO("Configuration change: Set '%s' to '%s'", name.c_str(), val.c_str()); + + set_as_string(name.c_str(), val); + } +} + +// ***** get_value ***** -template XBT_PUBLIC T const& get_config(const char* name) +template XBT_PUBLIC T const& get_value(std::string name) { return (*simgrid_config)[name].get_value(); } -template XBT_PUBLIC int const& get_config(const char* name); -template XBT_PUBLIC double const& get_config(const char* name); -template XBT_PUBLIC bool const& get_config(const char* name); -template XBT_PUBLIC std::string const& get_config(const char* name); +template XBT_PUBLIC int const& get_value(std::string name); +template XBT_PUBLIC double const& get_value(std::string name); +template XBT_PUBLIC bool const& get_value(std::string name); +template XBT_PUBLIC std::string const& get_value(std::string name); // ***** alias ***** @@ -386,24 +453,40 @@ void alias(const char* realname, std::initializer_list aliases) simgrid_config->alias(realname, aliasname); } -// ***** declareFlag ***** +// ***** declare_flag ***** template -XBT_PUBLIC void declareFlag(const char* name, const char* description, T value, std::function callback) +XBT_PUBLIC void declare_flag(std::string name, std::string description, T value, std::function callback) { if (simgrid_config == nullptr) - simgrid_config = xbt_cfg_new(); + simgrid_config = new simgrid::config::Config(); simgrid_config->register_option(name, description, std::move(value), std::move(callback)); } -template XBT_PUBLIC void declareFlag(const char* name, const char* description, int value, - std::function callback); -template XBT_PUBLIC void declareFlag(const char* name, const char* description, double value, - std::function callback); -template XBT_PUBLIC void declareFlag(const char* name, const char* description, bool value, - std::function callback); -template XBT_PUBLIC void declareFlag(const char* name, const char* description, std::string value, - std::function callback); +template XBT_PUBLIC void declare_flag(std::string name, std::string description, int value, + std::function callback); +template XBT_PUBLIC void declare_flag(std::string name, std::string description, double value, + std::function callback); +template XBT_PUBLIC void declare_flag(std::string name, std::string description, bool value, + std::function callback); +template XBT_PUBLIC void declare_flag(std::string name, std::string description, std::string value, + std::function callback); + +void finalize() +{ + delete simgrid_config; + simgrid_config = nullptr; +} + +void show_aliases() +{ + simgrid_config->show_aliases(); +} + +void help() +{ + simgrid_config->help(); +} } } @@ -426,35 +509,35 @@ void xbt_cfg_register_double(const char *name, double default_value, xbt_cfg_cb_t cb_set, const char *desc) { if (simgrid_config == nullptr) - simgrid_config = xbt_cfg_new(); + simgrid_config = new simgrid::config::Config(); simgrid_config->register_option(name, desc, default_value, cb_set); } void xbt_cfg_register_int(const char *name, int default_value,xbt_cfg_cb_t cb_set, const char *desc) { if (simgrid_config == nullptr) - simgrid_config = xbt_cfg_new(); + simgrid_config = new simgrid::config::Config(); simgrid_config->register_option(name, desc, default_value, cb_set); } void xbt_cfg_register_string(const char *name, const char *default_value, xbt_cfg_cb_t cb_set, const char *desc) { if (simgrid_config == nullptr) - simgrid_config = xbt_cfg_new(); + simgrid_config = new simgrid::config::Config(); simgrid_config->register_option(name, desc, default_value ? default_value : "", cb_set); } void xbt_cfg_register_boolean(const char *name, const char*default_value,xbt_cfg_cb_t cb_set, const char *desc) { if (simgrid_config == nullptr) - simgrid_config = xbt_cfg_new(); + simgrid_config = new simgrid::config::Config(); simgrid_config->register_option(name, desc, simgrid::config::parse_bool(default_value), cb_set); } void xbt_cfg_register_alias(const char *realname, const char *aliasname) { if (simgrid_config == nullptr) - simgrid_config = xbt_cfg_new(); + simgrid_config = new simgrid::config::Config(); simgrid_config->alias(realname, aliasname); } @@ -479,40 +562,8 @@ void xbt_cfg_help() */ void xbt_cfg_set_parse(const char *options) { - if (not options || not strlen(options)) { /* nothing to do */ - return; - } - - XBT_DEBUG("List to parse and set:'%s'", options); - std::string optionlist(options); - while (not optionlist.empty()) { - XBT_DEBUG("Still to parse and set: '%s'", optionlist.c_str()); - - // skip separators - size_t pos = optionlist.find_first_not_of(" \t\n,"); - optionlist.erase(0, pos); - // find option - pos = optionlist.find_first_of(" \t\n,"); - std::string name = optionlist.substr(0, pos); - optionlist.erase(0, pos); - XBT_DEBUG("parse now:'%s'; parse later:'%s'", name.c_str(), optionlist.c_str()); - - if (name.empty()) - continue; - - pos = name.find(':'); - xbt_assert(pos != std::string::npos, "Option '%s' badly formatted. Should be of the form 'name:value'", - name.c_str()); - - std::string val = name.substr(pos + 1); - name.erase(pos); - - const std::string path("path"); - if (name.compare(0, path.length(), path) != 0) - XBT_INFO("Configuration change: Set '%s' to '%s'", name.c_str(), val.c_str()); - - (*simgrid_config)[name.c_str()].set_string_value(val.c_str()); - } + if (options && strlen(options) > 0) + simgrid::config::set_parse(std::string(options)); } /** @brief Set the value of a variable, using the string representation of that value @@ -663,90 +714,3 @@ int xbt_cfg_get_boolean(const char *key) { return (*simgrid_config)[key].get_value() ? 1 : 0; } - -#ifdef SIMGRID_TEST - -#include - -#include "xbt.h" -#include "xbt/ex.h" -#include - -#include - -XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_cfg); - -XBT_TEST_SUITE("config", "Configuration support"); - -XBT_PUBLIC_DATA xbt_cfg_t simgrid_config; - -static void make_set() -{ - simgrid_config = nullptr; - xbt_log_threshold_set(&_XBT_LOGV(xbt_cfg), xbt_log_priority_critical); - simgrid::config::declareFlag("speed", "description", 0); - simgrid::config::declareFlag("peername", "description", ""); - simgrid::config::declareFlag("user", "description", ""); -} /* end_of_make_set */ - -XBT_TEST_UNIT("memuse", test_config_memuse, "Alloc and free a config set") -{ - auto temp = simgrid_config; - make_set(); - xbt_test_add("Alloc and free a config set"); - xbt_cfg_set_parse("peername:veloce user:bidule"); - xbt_cfg_free(&simgrid_config); - simgrid_config = temp; -} - -XBT_TEST_UNIT("use", test_config_use, "Data retrieving tests") -{ - auto temp = simgrid_config; - make_set(); - xbt_test_add("Get a single value"); - { - /* get_single_value */ - xbt_cfg_set_parse("peername:toto:42 speed:42"); - int ival = xbt_cfg_get_int("speed"); - if (ival != 42) - xbt_test_fail("Speed value = %d, I expected 42", ival); - } - - xbt_test_add("Access to a non-existant entry"); - { - try { - xbt_cfg_set_parse("color:blue"); - } catch(xbt_ex& e) { - if (e.category != not_found_error) - xbt_test_exception(e); - } - } - xbt_cfg_free(&simgrid_config); - simgrid_config = temp; -} - -XBT_TEST_UNIT("c++flags", test_config_cxx_flags, "C++ flags") -{ - auto temp = simgrid_config; - make_set(); - xbt_test_add("C++ declaration of flags"); - - simgrid::config::Flag int_flag("int", "", 0); - simgrid::config::Flag string_flag("string", "", "foo"); - simgrid::config::Flag double_flag("double", "", 0.32); - simgrid::config::Flag bool_flag1("bool1", "", false); - simgrid::config::Flag bool_flag2("bool2", "", true); - - xbt_test_add("Parse values"); - xbt_cfg_set_parse("int:42 string:bar double:8.0 bool1:true bool2:false"); - xbt_test_assert(int_flag == 42, "Check int flag"); - xbt_test_assert(string_flag == "bar", "Check string flag"); - xbt_test_assert(double_flag == 8.0, "Check double flag"); - xbt_test_assert(bool_flag1, "Check bool1 flag"); - xbt_test_assert(not bool_flag2, "Check bool2 flag"); - - xbt_cfg_free(&simgrid_config); - simgrid_config = temp; -} - -#endif /* SIMGRID_TEST */