X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/5b0c3d15701a47a90fe0897407470e5f271f4d3e..83a986331633ba19391ce14e6605a5b423311ad7:/src/xbt/config.cpp diff --git a/src/xbt/config.cpp b/src/xbt/config.cpp index deb5fc34c8..4c3b69eba1 100644 --- a/src/xbt/config.cpp +++ b/src/xbt/config.cpp @@ -44,7 +44,7 @@ const char* false_values[] = { "no", "off", "false", "0" }; -static bool parseBool(const char* value) +static bool parse_bool(const char* value) { for (const char* const& true_value : true_values) if (std::strcmp(true_value, value) == 0) @@ -55,7 +55,7 @@ static bool parseBool(const char* value) throw std::range_error("not a boolean"); } -static double parseDouble(const char* value) +static double parse_double(const char* value) { char* end; errno = 0; @@ -70,7 +70,7 @@ static double parseDouble(const char* value) return res; } -static long int parseLong(const char* value) +static long int parse_long(const char* value) { char* end; errno = 0; @@ -98,7 +98,7 @@ public: static constexpr const char* type_name = "int"; static inline double parse(const char* value) { - return parseLong(value); + return parse_long(value); } }; template <> class ConfigType { @@ -106,7 +106,7 @@ public: static constexpr const char* type_name = "double"; static inline double parse(const char* value) { - return parseDouble(value); + return parse_double(value); } }; template <> class ConfigType { @@ -122,7 +122,7 @@ public: static constexpr const char* type_name = "boolean"; static inline bool parse(const char* value) { - return parseBool(value); + return parse_bool(value); } }; @@ -147,32 +147,29 @@ public: ConfigurationElement(const char* key, const char* desc, xbt_cfg_cb_t cb) : key(key ? key : ""), desc(desc ? desc : ""), old_callback(cb) {} - virtual ~ConfigurationElement()=default; + virtual ~ConfigurationElement() = default; - virtual std::string getStringValue() = 0; - virtual void setStringValue(const char* value) = 0; - virtual const char* getTypeName() = 0; + virtual std::string get_string_value() = 0; + virtual void set_string_value(const char* value) = 0; + virtual const char* get_type_name() = 0; - template - T const& getValue() const + template T const& get_value() const { - return dynamic_cast&>(*this).getValue(); + return dynamic_cast&>(*this).get_value(); } - template - void setValue(T value) + template void set_value(T value) { - dynamic_cast&>(*this).setValue(std::move(value)); + dynamic_cast&>(*this).set_value(std::move(value)); } - template - void setDefaultValue(T value) + template void set_default_value(T value) { - dynamic_cast&>(*this).setDefaultValue(std::move(value)); + dynamic_cast&>(*this).set_default_value(std::move(value)); } - void unsetDefault() { isdefault = false; } - bool isDefault() const { return isdefault; } + void unset_default() { isdefault = false; } + bool is_default() const { return isdefault; } - std::string const& getDescription() const { return desc; } - std::string const& getKey() const { return key; } + std::string const& get_description() const { return desc; } + std::string const& get_key() const { return key; } }; // **** TypedConfigurationElement **** @@ -196,55 +193,52 @@ public: {} ~TypedConfigurationElement() = default; - std::string getStringValue() override; - const char* getTypeName() override; - void setStringValue(const char* value) override; + std::string get_string_value() override; + const char* get_type_name() override; + void set_string_value(const char* value) override; void update() { if (old_callback) - this->old_callback(getKey().c_str()); + this->old_callback(get_key().c_str()); if (this->callback) this->callback(this->content); } - T const& getValue() const { return content; } + T const& get_value() const { return content; } - void setValue(T value) + void set_value(T value) { this->content = std::move(value); this->update(); - this->unsetDefault(); + this->unset_default(); } - void setDefaultValue(T value) + void set_default_value(T value) { - if (this->isDefault()) { + if (this->is_default()) { this->content = std::move(value); this->update(); } else { XBT_DEBUG("Do not override configuration variable '%s' with value '%s' because it was already set.", - getKey().c_str(), to_string(value).c_str()); + get_key().c_str(), to_string(value).c_str()); } } }; -template -std::string TypedConfigurationElement::getStringValue() // override +template std::string TypedConfigurationElement::get_string_value() // override { return to_string(content); } -template -void TypedConfigurationElement::setStringValue(const char* value) // override +template void TypedConfigurationElement::set_string_value(const char* value) // override { this->content = ConfigType::parse(value); - this->unsetDefault(); + this->unset_default(); this->update(); } -template -const char* TypedConfigurationElement::getTypeName() // override +template const char* TypedConfigurationElement::get_type_name() // override { return ConfigType::type_name; } @@ -270,18 +264,15 @@ public: Config& operator=(Config const&) = delete; ConfigurationElement& operator[](const char* name); - template - TypedConfigurationElement& getTyped(const char* name); void alias(const char* realname, const char* aliasname); - template - simgrid::config::TypedConfigurationElement* - registerOption(const char* name, A&&... a) + template + simgrid::config::TypedConfigurationElement* register_option(const char* name, A&&... a) { xbt_assert(options.find(name) == options.end(), "Refusing to register the config element '%s' twice.", name); TypedConfigurationElement* variable = new TypedConfigurationElement(name, std::forward(a)...); - XBT_DEBUG("Register cfg elm %s (%s) of type %s @%p in set %p)", name, variable->getDescription().c_str(), - variable->getTypeName(), variable, this); + XBT_DEBUG("Register cfg elm %s (%s) of type %s @%p in set %p)", name, variable->get_description().c_str(), + variable->get_type_name(), variable, this); options.insert({name, variable}); variable->update(); return variable; @@ -289,11 +280,11 @@ public: // Debug: void dump(const char *name, const char *indent); - void showAliases(); + void show_aliases(); void help(); protected: - ConfigurationElement* getDictElement(const char* name); + ConfigurationElement* get_dict_element(const char* name); }; Config::Config() @@ -307,7 +298,7 @@ Config::~Config() delete elm.second; } -inline ConfigurationElement* Config::getDictElement(const char* name) +inline ConfigurationElement* Config::get_dict_element(const char* name) { auto opt = options.find(name); if (opt != options.end()) { @@ -317,7 +308,7 @@ inline ConfigurationElement* Config::getDictElement(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->getKey().c_str()); + XBT_INFO("Option %s has been renamed to %s. Consider switching.", name, res->get_key().c_str()); return res; } else { THROWF(not_found_error, 0, "Bad config key: %s", name); @@ -327,13 +318,13 @@ inline ConfigurationElement* Config::getDictElement(const char* name) inline ConfigurationElement& Config::operator[](const char* name) { - return *(getDictElement(name)); + return *(get_dict_element(name)); } void Config::alias(const char* realname, const char* aliasname) { xbt_assert(aliases.find(aliasname) == aliases.end(), "Alias '%s' already.", aliasname); - ConfigurationElement* element = this->getDictElement(realname); + ConfigurationElement* element = this->get_dict_element(realname); xbt_assert(element, "Cannot define an alias to the non-existing option '%s'.", realname); this->aliases.insert({aliasname, element}); } @@ -349,8 +340,8 @@ void Config::dump(const char *name, const char *indent) printf("%s>> Dumping of the config set '%s':\n", indent, name); for (auto const& elm : options) - printf("%s %s: ()%s) %s", indent, elm.first.c_str(), elm.second->getTypeName(), - elm.second->getStringValue().c_str()); + printf("%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); @@ -358,10 +349,10 @@ void Config::dump(const char *name, const char *indent) } /** @brief Displays the declared aliases and their replacement */ -void Config::showAliases() +void Config::show_aliases() { for (auto const& elm : aliases) - printf(" %-40s %s\n", elm.first.c_str(), elm.second->getKey().c_str()); + printf(" %-40s %s\n", elm.first.c_str(), elm.second->get_key().c_str()); } /** @brief Displays the declared options and their description */ @@ -369,23 +360,90 @@ 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->getDescription().c_str()); - printf(" Type: %s; ", variable->getTypeName()); - printf("Current value: %s\n", variable->getStringValue().c_str()); + 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()); + } +} + +// ***** 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); } } -// ***** getConfig ***** +// ***** get_value ***** -template XBT_PUBLIC T const& getConfig(const char* name) +template XBT_PUBLIC T const& get_value(const char* name) { - return (*simgrid_config)[name].getValue(); + return (*simgrid_config)[name].get_value(); } -template XBT_PUBLIC int const& getConfig(const char* name); -template XBT_PUBLIC double const& getConfig(const char* name); -template XBT_PUBLIC bool const& getConfig(const char* name); -template XBT_PUBLIC std::string const& getConfig(const char* name); +template XBT_PUBLIC int const& get_value(const char* name); +template XBT_PUBLIC double const& get_value(const char* name); +template XBT_PUBLIC bool const& get_value(const char* name); +template XBT_PUBLIC std::string const& get_value(const char* name); // ***** alias ***** @@ -395,25 +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(const char* name, const char* description, T value, std::function callback) { if (simgrid_config == nullptr) - simgrid_config = xbt_cfg_new(); - simgrid_config->registerOption( - name, description, std::move(value), std::move(callback)); + 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(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); + +void finalize() +{ + delete simgrid_config; + simgrid_config = nullptr; +} + +void show_aliases() +{ + simgrid_config->show_aliases(); +} + +void help() +{ + simgrid_config->help(); +} } } @@ -436,40 +509,46 @@ 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->registerOption(name, desc, default_value, cb_set); + 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->registerOption(name, desc, default_value, cb_set); + 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->registerOption(name, desc, default_value ? default_value : "", cb_set); + 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->registerOption(name, desc, simgrid::config::parseBool(default_value), cb_set); + 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); } -void xbt_cfg_aliases() { simgrid_config->showAliases(); } -void xbt_cfg_help() { simgrid_config->help(); } +void xbt_cfg_aliases() +{ + simgrid_config->show_aliases(); +} +void xbt_cfg_help() +{ + simgrid_config->help(); +} /*----[ Setting ]---------------------------------------------------------*/ @@ -483,40 +562,8 @@ void xbt_cfg_help() { simgrid_config->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()].setStringValue(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 @@ -527,7 +574,7 @@ void xbt_cfg_set_parse(const char *options) void xbt_cfg_set_as_string(const char *key, const char *value) { - (*simgrid_config)[key].setStringValue(value); + (*simgrid_config)[key].set_string_value(value); } /** @brief Set an integer value to \a name within \a cfg if it wasn't changed yet @@ -537,7 +584,7 @@ void xbt_cfg_set_as_string(const char *key, const char *value) */ void xbt_cfg_setdefault_int(const char *key, int value) { - (*simgrid_config)[key].setDefaultValue(value); + (*simgrid_config)[key].set_default_value(value); } /** @brief Set an integer value to \a name within \a cfg if it wasn't changed yet @@ -547,7 +594,7 @@ void xbt_cfg_setdefault_int(const char *key, int value) */ void xbt_cfg_setdefault_double(const char *key, double value) { - (*simgrid_config)[key].setDefaultValue(value); + (*simgrid_config)[key].set_default_value(value); } /** @brief Set a string value to \a name within \a cfg if it wasn't changed yet @@ -557,7 +604,7 @@ void xbt_cfg_setdefault_double(const char *key, double value) */ void xbt_cfg_setdefault_string(const char *key, const char *value) { - (*simgrid_config)[key].setDefaultValue(value ? value : ""); + (*simgrid_config)[key].set_default_value(value ? value : ""); } /** @brief Set an boolean value to \a name within \a cfg if it wasn't changed yet @@ -567,7 +614,7 @@ void xbt_cfg_setdefault_string(const char *key, const char *value) */ void xbt_cfg_setdefault_boolean(const char *key, const char *value) { - (*simgrid_config)[key].setDefaultValue(simgrid::config::parseBool(value)); + (*simgrid_config)[key].set_default_value(simgrid::config::parse_bool(value)); } /** @brief Set an integer value to \a name within \a cfg @@ -577,7 +624,7 @@ void xbt_cfg_setdefault_boolean(const char *key, const char *value) */ void xbt_cfg_set_int(const char *key, int value) { - (*simgrid_config)[key].setValue(value); + (*simgrid_config)[key].set_value(value); } /** @brief Set or add a double value to \a name within \a cfg @@ -587,7 +634,7 @@ void xbt_cfg_set_int(const char *key, int value) */ void xbt_cfg_set_double(const char *key, double value) { - (*simgrid_config)[key].setValue(value); + (*simgrid_config)[key].set_value(value); } /** @brief Set or add a string value to \a name within \a cfg @@ -598,7 +645,7 @@ void xbt_cfg_set_double(const char *key, double value) */ void xbt_cfg_set_string(const char* key, const char* value) { - (*simgrid_config)[key].setValue(value); + (*simgrid_config)[key].set_value(value); } /** @brief Set or add a boolean value to \a name within \a cfg @@ -608,14 +655,14 @@ void xbt_cfg_set_string(const char* key, const char* value) */ void xbt_cfg_set_boolean(const char *key, const char *value) { - (*simgrid_config)[key].setValue(simgrid::config::parseBool(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].isDefault() ? 1 : 0; + return (*simgrid_config)[key].is_default() ? 1 : 0; } /*----[ Getting ]---------------------------------------------------------*/ @@ -627,7 +674,7 @@ int xbt_cfg_is_default_value(const char *key) */ int xbt_cfg_get_int(const char *key) { - return (*simgrid_config)[key].getValue(); + return (*simgrid_config)[key].get_value(); } /** @brief Retrieve a double value of a variable (get a warning if not uniq) @@ -638,7 +685,7 @@ int xbt_cfg_get_int(const char *key) */ double xbt_cfg_get_double(const char *key) { - return (*simgrid_config)[key].getValue(); + return (*simgrid_config)[key].get_value(); } /** @brief Retrieve a string value of a variable (get a warning if not uniq) @@ -653,7 +700,7 @@ double xbt_cfg_get_double(const char *key) */ std::string xbt_cfg_get_string(const char* key) { - return (*simgrid_config)[key].getValue(); + return (*simgrid_config)[key].get_value(); } /** @brief Retrieve a boolean value of a variable (get a warning if not uniq) @@ -665,7 +712,7 @@ std::string xbt_cfg_get_string(const char* key) */ int xbt_cfg_get_boolean(const char *key) { - return (*simgrid_config)[key].getValue() ? 1 : 0; + return (*simgrid_config)[key].get_value() ? 1 : 0; } #ifdef SIMGRID_TEST @@ -682,15 +729,15 @@ XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_cfg); XBT_TEST_SUITE("config", "Configuration support"); -XBT_PUBLIC_DATA xbt_cfg_t simgrid_config; +XBT_PUBLIC_DATA simgrid::config::Config* simgrid_config; static void make_set() { simgrid_config = nullptr; xbt_log_threshold_set(&_XBT_LOGV(xbt_cfg), xbt_log_priority_critical); - xbt_cfg_register_int("speed", 0, nullptr, ""); - xbt_cfg_register_string("peername", "", nullptr, ""); - xbt_cfg_register_string("user", "", nullptr, ""); + 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") @@ -698,8 +745,8 @@ 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::set_parse("peername:veloce user:bidule"); + simgrid::config::finalize(); simgrid_config = temp; } @@ -710,8 +757,8 @@ XBT_TEST_UNIT("use", test_config_use, "Data retrieving tests") 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"); + simgrid::config::set_parse("peername:toto:42 speed:42"); + int ival = simgrid::config::get_value("speed"); if (ival != 42) xbt_test_fail("Speed value = %d, I expected 42", ival); } @@ -719,13 +766,13 @@ XBT_TEST_UNIT("use", test_config_use, "Data retrieving tests") xbt_test_add("Access to a non-existant entry"); { try { - xbt_cfg_set_parse("color:blue"); + simgrid::config::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::finalize(); simgrid_config = temp; } @@ -742,14 +789,14 @@ XBT_TEST_UNIT("c++flags", test_config_cxx_flags, "C++ flags") 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"); + simgrid::config::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::finalize(); simgrid_config = temp; }