X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/52ce912c49d61c252e301393740350f4f0e41d8b..0a98e0dd953ca1a907d77f3c4eabdce39e62c1e5:/src/xbt/config.cpp diff --git a/src/xbt/config.cpp b/src/xbt/config.cpp index 8e7084e30a..f70eec1947 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. */ @@ -12,6 +12,7 @@ #include #include +#include #include #include #include @@ -19,6 +20,7 @@ #include #include +#include "simgrid/Exception.hpp" #include "simgrid/sg_config.hpp" #include "xbt/dynar.h" #include "xbt/log.h" @@ -26,7 +28,6 @@ #include "xbt/sysdep.h" #include #include -#include XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_cfg, xbt, "configuration support"); @@ -143,9 +144,11 @@ 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(const std::string& key, const std::string& desc) : key(key), desc(desc) {} + ConfigurationElement(const std::string& key, const std::string& desc, xbt_cfg_cb_t cb) + : key(key), desc(desc), old_callback(cb) + { + } virtual ~ConfigurationElement() = default; @@ -155,15 +158,15 @@ public: template T const& get_value() const { - return dynamic_cast&>(*this).get_value(); + return static_cast&>(*this).get_value(); } template void set_value(T value) { - dynamic_cast&>(*this).set_value(std::move(value)); + static_cast&>(*this).set_value(std::move(value)); } template void set_default_value(T value) { - dynamic_cast&>(*this).set_default_value(std::move(value)); + static_cast&>(*this).set_default_value(std::move(value)); } void unset_default() { isdefault = false; } bool is_default() const { return isdefault; } @@ -182,13 +185,13 @@ private: std::function callback; public: - TypedConfigurationElement(const char* key, const char* desc, T value = T()) - : ConfigurationElement(key, desc), content(std::move(value)) + TypedConfigurationElement(const std::string& key, const 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(const std::string& key, const 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(const std::string& key, const std::string& desc, T value, std::function callback) : ConfigurationElement(key, desc), content(std::move(value)), callback(std::move(callback)) {} ~TypedConfigurationElement() = default; @@ -250,30 +253,29 @@ template const char* TypedConfigurationElement::get_type_name() // class Config { private: // name -> ConfigElement: - std::map options; + std::map> options; // alias -> ConfigElement from options: - std::map aliases; + std::map aliases; bool warn_for_aliases = true; public: Config(); - ~Config(); // No copy: Config(Config const&) = delete; Config& operator=(Config const&) = delete; - ConfigurationElement& operator[](const char* name); - void alias(const char* realname, const char* aliasname); + ConfigurationElement& operator[](const std::string& name); + void alias(const std::string& realname, const std::string& aliasname); - template - simgrid::config::TypedConfigurationElement* register_option(const char* name, A&&... a) + template TypedConfigurationElement* register_option(const 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}); + options[name].reset(variable); variable->update(); return variable; } @@ -284,48 +286,42 @@ public: void help(); protected: - ConfigurationElement* get_dict_element(const char* name); + ConfigurationElement* get_dict_element(const std::string& name); }; Config::Config() { atexit(&sg_config_finalize); } -Config::~Config() -{ - XBT_DEBUG("Frees cfg set %p", this); - for (auto const& elm : options) - delete elm.second; -} -inline ConfigurationElement* Config::get_dict_element(const char* name) +inline ConfigurationElement* Config::get_dict_element(const std::string& name) { auto opt = options.find(name); if (opt != options.end()) { - return opt->second; + return opt->second.get(); } else { auto als = aliases.find(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); + throw std::out_of_range("Bad config key: " + name); } } } -inline ConfigurationElement& Config::operator[](const char* name) +inline ConfigurationElement& Config::operator[](const std::string& name) { return *(get_dict_element(name)); } -void Config::alias(const char* realname, const char* aliasname) +void Config::alias(const std::string& realname, const 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}); } @@ -336,166 +332,84 @@ void Config::alias(const char* realname, const char* aliasname) */ void Config::dump(const char *name, const char *indent) { + XBT_LOG_DEFAULT_CATEGORY(xbt_help); if (name) - printf("%s>> Dumping of the config set '%s':\n", indent, name); + XBT_VERB("%s>> Dumping of the config set '%s':", indent, name); for (auto const& elm : options) - printf("%s %s: ()%s) %s", indent, elm.first.c_str(), elm.second->get_type_name(), - elm.second->get_string_value().c_str()); + XBT_VERB("%s %s: ()%s) %s", indent, elm.first.c_str(), elm.second->get_type_name(), + elm.second->get_string_value().c_str()); if (name) - printf("%s<< End of the config set '%s'\n", indent, name); - fflush(stdout); + XBT_VERB("%s<< End of the config set '%s'", indent, name); } /** @brief Displays the declared aliases and their replacement */ void Config::show_aliases() { for (auto const& elm : aliases) - printf(" %-40s %s\n", elm.first.c_str(), elm.second->get_key().c_str()); + XBT_HELP(" %-40s %s", elm.first.c_str(), elm.second->get_key().c_str()); } /** @brief Displays the declared options and their description */ void Config::help() { for (auto const& elm : options) { - simgrid::config::ConfigurationElement* variable = this->options.at(elm.first); - printf(" %s: %s\n", elm.first.c_str(), variable->get_description().c_str()); - printf(" Type: %s; ", variable->get_type_name()); - printf("Current value: %s\n", variable->get_string_value().c_str()); + simgrid::config::ConfigurationElement* variable = elm.second.get(); + XBT_HELP(" %s: %s", elm.first.c_str(), variable->get_description().c_str()); + XBT_HELP(" Type: %s; Current value: %s", variable->get_type_name(), variable->get_string_value().c_str()); } } -// ***** get_config ***** - -template XBT_PUBLIC T const& get_config(const char* 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); - -// ***** alias ***** - -void alias(const char* realname, std::initializer_list aliases) -{ - for (auto const& aliasname : aliases) - simgrid_config->alias(realname, aliasname); -} - -// ***** declare_flag ***** - -template -XBT_PUBLIC void declare_flag(const char* name, const char* description, T value, std::function callback) -{ - if (simgrid_config == nullptr) - simgrid_config = xbt_cfg_new(); - simgrid_config->register_option(name, description, std::move(value), std::move(callback)); -} - -template XBT_PUBLIC void declare_flag(const char* name, const char* description, int value, - std::function callback); -template XBT_PUBLIC void declare_flag(const char* name, const char* description, double value, - std::function callback); -template XBT_PUBLIC void declare_flag(const char* name, const char* description, bool value, - std::function callback); -template XBT_PUBLIC void declare_flag(const char* name, const char* description, std::string value, - std::function callback); -} -} - -// ***** C bindings ***** - -xbt_cfg_t xbt_cfg_new() -{ - return new simgrid::config::Config(); -} -void xbt_cfg_free(xbt_cfg_t * cfg) { delete *cfg; } +// ***** set_default ***** -void xbt_cfg_dump(const char *name, const char *indent, xbt_cfg_t cfg) +template XBT_PUBLIC void set_default(const char* name, T value) { - cfg->dump(name, indent); + (*simgrid_config)[name].set_default_value(std::move(value)); } -/*----[ Registering stuff ]-----------------------------------------------*/ +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); -void xbt_cfg_register_double(const char *name, double default_value, - xbt_cfg_cb_t cb_set, const char *desc) +bool is_default(const char* name) { - if (simgrid_config == nullptr) - simgrid_config = xbt_cfg_new(); - simgrid_config->register_option(name, desc, default_value, cb_set); + return (*simgrid_config)[name].is_default(); } -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->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->register_option(name, desc, default_value ? default_value : "", cb_set); -} +// ***** set_value ***** -void xbt_cfg_register_boolean(const char *name, const char*default_value,xbt_cfg_cb_t cb_set, const char *desc) +template XBT_PUBLIC void set_value(const char* name, T value) { - if (simgrid_config == nullptr) - simgrid_config = xbt_cfg_new(); - simgrid_config->register_option(name, desc, simgrid::config::parse_bool(default_value), cb_set); + (*simgrid_config)[name].set_value(std::move(value)); } -void xbt_cfg_register_alias(const char *realname, const char *aliasname) -{ - if (simgrid_config == nullptr) - simgrid_config = xbt_cfg_new(); - simgrid_config->alias(realname, aliasname); -} +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 xbt_cfg_aliases() +void set_as_string(const char* name, const std::string& value) { - simgrid_config->show_aliases(); -} -void xbt_cfg_help() -{ - simgrid_config->help(); + (*simgrid_config)[name].set_string_value(value.c_str()); } -/*----[ Setting ]---------------------------------------------------------*/ - -/** @brief Add values parsed from a string into a config set - * - * @param options a string containing the content to add to the config set. This is a '\\t',' ' or '\\n' or ',' - * separated list of variables. Each individual variable is like "[name]:[value]" where [name] is the name of an - * already registered variable, and [value] conforms to the data type under which this variable was registered. - * - * @todo This is a crude manual parser, it should be a proper lexer. - */ -void xbt_cfg_set_parse(const char *options) +void set_parse(const std::string& opt) { - 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()); + std::string options(opt); + 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 = optionlist.find_first_not_of(" \t\n,"); - optionlist.erase(0, pos); + size_t pos = options.find_first_not_of(" \t\n,"); + options.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()); + 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; @@ -511,60 +425,69 @@ void xbt_cfg_set_parse(const char *options) 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()); + set_as_string(name.c_str(), val); } } -/** @brief Set the value of a variable, using the string representation of that value - * - * @param key name of the variable to modify - * @param value string representation of the value to set - */ +// ***** get_value ***** -void xbt_cfg_set_as_string(const char *key, const char *value) +template XBT_PUBLIC T const& get_value(const std::string& name) { - (*simgrid_config)[key].set_string_value(value); + return (*simgrid_config)[name].get_value(); } -/** @brief Set an integer value to \a name within \a cfg if it wasn't changed yet - * - * This is useful to change the default value of a variable while allowing - * users to override it with command line arguments - */ -void xbt_cfg_setdefault_int(const char *key, int value) +template XBT_PUBLIC int const& get_value(const std::string& name); +template XBT_PUBLIC double const& get_value(const std::string& name); +template XBT_PUBLIC bool const& get_value(const std::string& name); +template XBT_PUBLIC std::string const& get_value(const std::string& name); + +// ***** alias ***** + +void alias(const char* realname, std::initializer_list aliases) { - (*simgrid_config)[key].set_default_value(value); + for (auto const& aliasname : aliases) + simgrid_config->alias(realname, aliasname); } -/** @brief Set an integer value to \a name within \a cfg if it wasn't changed yet - * - * This is useful to change the default value of a variable while allowing - * users to override it with command line arguments - */ -void xbt_cfg_setdefault_double(const char *key, double value) +// ***** declare_flag ***** + +template +XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, T value, + std::function callback) { - (*simgrid_config)[key].set_default_value(value); + if (simgrid_config == nullptr) + simgrid_config = new simgrid::config::Config(); + simgrid_config->register_option(name, description, std::move(value), std::move(callback)); } -/** @brief Set a string value to \a name within \a cfg if it wasn't changed yet - * - * This is useful to change the default value of a variable while allowing - * users to override it with command line arguments - */ -void xbt_cfg_setdefault_string(const char *key, const char *value) +template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, int value, + std::function callback); +template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, double value, + std::function callback); +template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, bool value, + std::function callback); +template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, std::string value, + std::function callback); + +void finalize() { - (*simgrid_config)[key].set_default_value(value ? value : ""); + delete simgrid_config; + simgrid_config = nullptr; } -/** @brief Set an boolean value to \a name within \a cfg if it wasn't changed yet - * - * This is useful to change the default value of a variable while allowing - * users to override it with command line arguments - */ -void xbt_cfg_setdefault_boolean(const char *key, const char *value) +void show_aliases() +{ + simgrid_config->show_aliases(); +} + +void help() { - (*simgrid_config)[key].set_default_value(simgrid::config::parse_bool(value)); + simgrid_config->help(); +} } +} + +/*----[ Setting ]---------------------------------------------------------*/ /** @brief Set an integer value to \a name within \a cfg * @@ -607,13 +530,6 @@ void xbt_cfg_set_boolean(const char *key, const char *value) (*simgrid_config)[key].set_value(simgrid::config::parse_bool(value)); } - -/* Say if the value is the default value */ -int xbt_cfg_is_default_value(const char *key) -{ - return (*simgrid_config)[key].is_default() ? 1 : 0; -} - /*----[ Getting ]---------------------------------------------------------*/ /** @brief Retrieve an integer value of a variable (get a warning if not uniq) * @@ -637,21 +553,6 @@ double xbt_cfg_get_double(const char *key) return (*simgrid_config)[key].get_value(); } -/** @brief Retrieve a string value of a variable (get a warning if not uniq) - * - * @param key the name of the variable - * - * Returns the first value from the config set under the given name. - * If there is more than one value, it will issue a warning. - * Returns nullptr if there is no value. - * - * \warning the returned value is the actual content of the config set - */ -std::string xbt_cfg_get_string(const char* key) -{ - return (*simgrid_config)[key].get_value(); -} - /** @brief Retrieve a boolean value of a variable (get a warning if not uniq) * * @param key the name of the variable @@ -663,90 +564,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::declare_flag("speed", "description", 0); - simgrid::config::declare_flag("peername", "description", ""); - simgrid::config::declare_flag("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 */