X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/524de5f4ae0694f650b58ce80c901db748c9fe93..1340b2bc2a098a7e87fa45ff31591d32c864dc7a:/src/xbt/config.cpp diff --git a/src/xbt/config.cpp b/src/xbt/config.cpp index f451949b43..16c47dc636 100644 --- a/src/xbt/config.cpp +++ b/src/xbt/config.cpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2004-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. */ @@ -14,32 +14,29 @@ #include #include #include +#include #include #include #include -#include -#include -#include +#include "simgrid/sg_config.hpp" +#include "xbt/dynar.h" +#include "xbt/log.h" #include "xbt/misc.h" #include "xbt/sysdep.h" -#include "xbt/log.h" -#include "xbt/dynar.h" +#include +#include +#include XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_cfg, xbt, "configuration support"); -XBT_EXPORT_NO_IMPORT(xbt_cfg_t) simgrid_config = nullptr; -extern "C" { - XBT_PUBLIC(void) sg_config_finalize(); -} +XBT_EXPORT_NO_IMPORT xbt_cfg_t simgrid_config = nullptr; namespace simgrid { namespace config { missing_key_error::~missing_key_error() = default; -class Config; - namespace { const char* true_values[] = { @@ -51,10 +48,10 @@ const char* false_values[] = { static bool parseBool(const char* value) { - for (const char* true_value : true_values) + for (const char* const& true_value : true_values) if (std::strcmp(true_value, value) == 0) return true; - for (const char* false_value : false_values) + for (const char* const& false_value : false_values) if (std::strcmp(false_value, value) == 0) return false; throw std::range_error("not a boolean"); @@ -96,30 +93,34 @@ static long int parseLong(const char* value) // ***** ConfigType ***** /// A trait which define possible options types: -template struct ConfigType; +template class ConfigType; -template<> struct ConfigType { +template <> class ConfigType { +public: static constexpr const char* type_name = "int"; static inline double parse(const char* value) { return parseLong(value); } }; -template<> struct ConfigType { +template <> class ConfigType { +public: static constexpr const char* type_name = "double"; static inline double parse(const char* value) { return parseDouble(value); } }; -template<> struct ConfigType { +template <> class ConfigType { +public: static constexpr const char* type_name = "string"; static inline std::string parse(const char* value) { return std::string(value); } }; -template<> struct ConfigType { +template <> class ConfigType { +public: static constexpr const char* type_name = "boolean"; static inline bool parse(const char* value) { @@ -135,7 +136,7 @@ template class TypedConfigurationElement; // **** ConfigurationElement **** class ConfigurationElement { -protected: +private: std::string key; std::string desc; bool isdefault = true; @@ -144,8 +145,7 @@ 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) : 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) {} @@ -170,6 +170,7 @@ public: { dynamic_cast&>(*this).setDefaultValue(std::move(value)); } + void unsetDefault() { isdefault = false; } bool isDefault() const { return isdefault; } std::string const& getDescription() const { return desc; } @@ -204,7 +205,7 @@ public: void update() { if (old_callback) - this->old_callback(key.c_str()); + this->old_callback(getKey().c_str()); if (this->callback) this->callback(this->content); } @@ -219,12 +220,12 @@ public: void setDefaultValue(T value) { - if (this->isdefault) { + if (this->isDefault()) { this->content = std::move(value); this->update(); } else { - XBT_DEBUG("Do not override configuration variable '%s' with value '%s' because it was already set.", key.c_str(), - to_string(value).c_str()); + XBT_DEBUG("Do not override configuration variable '%s' with value '%s' because it was already set.", + getKey().c_str(), to_string(value).c_str()); } } }; @@ -239,7 +240,7 @@ template void TypedConfigurationElement::setStringValue(const char* value) // override { this->content = ConfigType::parse(value); - this->isdefault = false; + this->unsetDefault(); this->update(); } @@ -257,7 +258,7 @@ class Config { private: // name -> ConfigElement: std::map options; - // alias -> xbt_dict_elm_t from options: + // alias -> ConfigElement from options: std::map aliases; bool warn_for_aliases = true; @@ -299,21 +300,23 @@ protected: Config::~Config() { XBT_DEBUG("Frees cfg set %p", this); - for (auto elm : options) + for (auto const& elm : options) delete elm.second; } inline ConfigurationElement* Config::getDictElement(const char* name) { - try { - return options.at(name); - } catch (std::out_of_range& unfound) { - try { - ConfigurationElement* res = aliases.at(name); + auto opt = options.find(name); + if (opt != options.end()) { + return opt->second; + } 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->getKey().c_str()); return res; - } catch (std::out_of_range& missing_key) { + } else { throw simgrid::config::missing_key_error(std::string("Bad config key: ") + name); } } @@ -342,7 +345,7 @@ void Config::dump(const char *name, const char *indent) if (name) printf("%s>> Dumping of the config set '%s':\n", indent, name); - for (auto elm : options) + for (auto const& elm : options) printf("%s %s: ()%s) %s", indent, elm.first.c_str(), elm.second->getTypeName(), elm.second->getStringValue().c_str()); @@ -356,7 +359,7 @@ void Config::showAliases() { bool old_warn_for_aliases = false; std::swap(warn_for_aliases, old_warn_for_aliases); - for (auto elm : aliases) + for (auto const& elm : aliases) printf(" %s: %s\n", elm.first.c_str(), (*this)[elm.first.c_str()].getDescription().c_str()); std::swap(warn_for_aliases, old_warn_for_aliases); } @@ -364,7 +367,7 @@ void Config::showAliases() /** @brief Displays the declared options and their description */ void Config::help() { - for (auto elm : options) { + 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()); @@ -374,16 +377,15 @@ void Config::help() // ***** getConfig ***** -template -XBT_PUBLIC(T const&) getConfig(const char* name) +template XBT_PUBLIC T const& getConfig(const char* name) { return (*simgrid_config)[name].getValue(); } -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& 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); // ***** alias ***** @@ -394,33 +396,33 @@ void alias(const char* realname, const char* aliasname) // ***** declareFlag ***** -template -XBT_PUBLIC(void) declareFlag(const char* name, const char* description, - T value, std::function callback) +template +XBT_PUBLIC void declareFlag(const char* name, const char* description, T value, std::function callback) { - if (simgrid_config == nullptr) { + if (simgrid_config == nullptr) simgrid_config = xbt_cfg_new(); - atexit(sg_config_finalize); - } simgrid_config->registerOption( 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 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); } } // ***** C bindings ***** -xbt_cfg_t xbt_cfg_new() { return new simgrid::config::Config(); } +xbt_cfg_t xbt_cfg_new() +{ + atexit(&sg_config_finalize); + return new simgrid::config::Config(); +} void xbt_cfg_free(xbt_cfg_t * cfg) { delete *cfg; } void xbt_cfg_dump(const char *name, const char *indent, xbt_cfg_t cfg) @@ -440,38 +442,29 @@ void xbt_cfg_register_double(const char *name, double default_value, void xbt_cfg_register_int(const char *name, int default_value,xbt_cfg_cb_t cb_set, const char *desc) { - if (simgrid_config == nullptr) { + if (simgrid_config == nullptr) simgrid_config = xbt_cfg_new(); - atexit(&sg_config_finalize); - } simgrid_config->registerOption(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) { + if (simgrid_config == nullptr) simgrid_config = xbt_cfg_new(); - atexit(sg_config_finalize); - } - simgrid_config->registerOption(name, desc, - default_value ? default_value : "", cb_set); + simgrid_config->registerOption(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) { + if (simgrid_config == nullptr) simgrid_config = xbt_cfg_new(); - atexit(sg_config_finalize); - } simgrid_config->registerOption(name, desc, simgrid::config::parseBool(default_value), cb_set); } void xbt_cfg_register_alias(const char *realname, const char *aliasname) { - if (simgrid_config == nullptr) { + if (simgrid_config == nullptr) simgrid_config = xbt_cfg_new(); - atexit(sg_config_finalize); - } simgrid_config->alias(realname, aliasname); } @@ -493,53 +486,37 @@ void xbt_cfg_set_parse(const char *options) if (not options || not strlen(options)) { /* nothing to do */ return; } - char *optionlist_cpy = xbt_strdup(options); XBT_DEBUG("List to parse and set:'%s'", options); - char *option = optionlist_cpy; - while (1) { /* breaks in the code */ - if (not option) - break; - char *name = option; - int len = strlen(name); - XBT_DEBUG("Still to parse and set: '%s'. len=%d; option-name=%ld", name, len, (long) (option - name)); - - /* Pass the value */ - while (option - name <= (len - 1) && *option != ' ' && *option != '\n' && *option != '\t' && *option != ',') { - XBT_DEBUG("Take %c.", *option); - option++; - } - if (option - name == len) { - XBT_DEBUG("Boundary=EOL"); - option = nullptr; /* don't do next iteration */ - } else { - XBT_DEBUG("Boundary on '%c'. len=%d;option-name=%ld", *option, len, (long) (option - name)); - /* Pass the following blank chars */ - *(option++) = '\0'; - while (option - name < (len - 1) && (*option == ' ' || *option == '\n' || *option == '\t')) { - /* fprintf(stderr,"Ignore a blank char.\n"); */ - option++; - } - if (option - name == len - 1) - option = nullptr; /* don't do next iteration */ - } - XBT_DEBUG("parse now:'%s'; parse later:'%s'", name, option); - - if (name[0] == ' ' || name[0] == '\n' || name[0] == '\t') + 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; - if (not strlen(name)) - break; - char *val = strchr(name, ':'); - xbt_assert(val, "Option '%s' badly formatted. Should be of the form 'name:value'", name); - /* don't free(optionlist_cpy) if the assert fails, 'name' points inside it */ - *(val++) = '\0'; + 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); - if (strncmp(name, "path", strlen("path"))) - XBT_INFO("Configuration change: Set '%s' to '%s'", name, val); + 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()); try { - (*simgrid_config)[name].setStringValue(val); + (*simgrid_config)[name.c_str()].setStringValue(val.c_str()); } catch (simgrid::config::missing_key_error& e) { goto on_missing_key; @@ -548,17 +525,12 @@ void xbt_cfg_set_parse(const char *options) goto on_exception; } } - - free(optionlist_cpy); return; /* Do not THROWF from a C++ exception catching context, or some cleanups will be missing */ on_missing_key: - free(optionlist_cpy); THROWF(not_found_error, 0, "Could not set variables %s", options); - return; on_exception: - free(optionlist_cpy); THROWF(unknown_error, 0, "Could not set variables %s", options); } @@ -673,10 +645,10 @@ void xbt_cfg_set_double(const char *key, double value) * @param value the value to be added * */ -void xbt_cfg_set_string(const char *key, const char *value) +void xbt_cfg_set_string(const char* key, const char* value) { try { - (*simgrid_config)[key].setValue(value ? value : ""); + (*simgrid_config)[key].setValue(value); return; } TRANSLATE_EXCEPTIONS("Could not set variable %s to string %s", key, value); @@ -745,10 +717,10 @@ double xbt_cfg_get_double(const char *key) * * \warning the returned value is the actual content of the config set */ -char *xbt_cfg_get_string(const char *key) +std::string xbt_cfg_get_string(const char* key) { try { - return (char*) (*simgrid_config)[key].getValue().c_str(); + return (*simgrid_config)[key].getValue(); } TRANSLATE_EXCEPTIONS("Could not get variable %s", key); } @@ -782,7 +754,7 @@ XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_cfg); XBT_TEST_SUITE("config", "Configuration support"); -XBT_PUBLIC_DATA(xbt_cfg_t) simgrid_config; +XBT_PUBLIC_DATA xbt_cfg_t simgrid_config; static void make_set() {