-/* 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. */
#include <functional>
#include <map>
+#include <memory>
#include <stdexcept>
#include <string>
#include <string>
#include <typeinfo>
#include <vector>
+#include "simgrid/Exception.hpp"
#include "simgrid/sg_config.hpp"
#include "xbt/dynar.h"
#include "xbt/log.h"
#include "xbt/sysdep.h"
#include <xbt/config.h>
#include <xbt/config.hpp>
-#include <xbt/ex.hpp>
XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_cfg, xbt, "configuration support");
/* 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;
template <class T> T const& get_value() const
{
- return dynamic_cast<const TypedConfigurationElement<T>&>(*this).get_value();
+ return static_cast<const TypedConfigurationElement<T>&>(*this).get_value();
}
template <class T> void set_value(T value)
{
- dynamic_cast<TypedConfigurationElement<T>&>(*this).set_value(std::move(value));
+ static_cast<TypedConfigurationElement<T>&>(*this).set_value(std::move(value));
}
template <class T> void set_default_value(T value)
{
- dynamic_cast<TypedConfigurationElement<T>&>(*this).set_default_value(std::move(value));
+ static_cast<TypedConfigurationElement<T>&>(*this).set_default_value(std::move(value));
}
void unset_default() { isdefault = false; }
bool is_default() const { return isdefault; }
std::function<void(T&)> 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<void(T&)> callback)
+ TypedConfigurationElement(const std::string& key, const std::string& desc, T value, std::function<void(T&)> callback)
: ConfigurationElement(key, desc), content(std::move(value)), callback(std::move(callback))
{}
~TypedConfigurationElement() = default;
class Config {
private:
// name -> ConfigElement:
- std::map<std::string, simgrid::config::ConfigurationElement*> options;
+ std::map<std::string, std::unique_ptr<ConfigurationElement>> options;
// alias -> ConfigElement from options:
- std::map<std::string, simgrid::config::ConfigurationElement*> aliases;
+ std::map<std::string, ConfigurationElement*> 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 <class T, class... A>
- simgrid::config::TypedConfigurationElement<T>* register_option(const char* name, A&&... a)
+ template <class T, class... A> TypedConfigurationElement<T>* 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<T>* variable = new TypedConfigurationElement<T>(name, std::forward<A>(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;
}
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});
}
*/
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 <class T> XBT_PUBLIC T const& get_config(const char* name)
-{
- return (*simgrid_config)[name].get_value<T>();
-}
-
-template XBT_PUBLIC int const& get_config<int>(const char* name);
-template XBT_PUBLIC double const& get_config<double>(const char* name);
-template XBT_PUBLIC bool const& get_config<bool>(const char* name);
-template XBT_PUBLIC std::string const& get_config<std::string>(const char* name);
-
-// ***** alias *****
-
-void alias(const char* realname, std::initializer_list<const char*> aliases)
-{
- for (auto const& aliasname : aliases)
- simgrid_config->alias(realname, aliasname);
-}
-
-// ***** declare_flag *****
-
-template <class T>
-XBT_PUBLIC void declare_flag(const char* name, const char* description, T value, std::function<void(const T&)> callback)
-{
- if (simgrid_config == nullptr)
- simgrid_config = xbt_cfg_new();
- simgrid_config->register_option<T>(name, description, std::move(value), std::move(callback));
-}
-
-template XBT_PUBLIC void declare_flag(const char* name, const char* description, int value,
- std::function<void(int const&)> callback);
-template XBT_PUBLIC void declare_flag(const char* name, const char* description, double value,
- std::function<void(double const&)> callback);
-template XBT_PUBLIC void declare_flag(const char* name, const char* description, bool value,
- std::function<void(bool const&)> callback);
-template XBT_PUBLIC void declare_flag(const char* name, const char* description, std::string value,
- std::function<void(std::string const&)> 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 <class T> XBT_PUBLIC void set_default(const char* name, T value)
{
- cfg->dump(name, indent);
+ (*simgrid_config)[name].set_default_value<T>(std::move(value));
}
-/*----[ Registering stuff ]-----------------------------------------------*/
+template XBT_PUBLIC void set_default<int>(const char* name, int value);
+template XBT_PUBLIC void set_default<double>(const char* name, double value);
+template XBT_PUBLIC void set_default<bool>(const char* name, bool value);
+template XBT_PUBLIC void set_default<std::string>(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<double>(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<int>(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<std::string>(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 <class T> XBT_PUBLIC void set_value(const char* name, T value)
{
- if (simgrid_config == nullptr)
- simgrid_config = xbt_cfg_new();
- simgrid_config->register_option<bool>(name, desc, simgrid::config::parse_bool(default_value), cb_set);
+ (*simgrid_config)[name].set_value<T>(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<int>(const char* name, int value);
+template XBT_PUBLIC void set_value<double>(const char* name, double value);
+template XBT_PUBLIC void set_value<bool>(const char* name, bool value);
+template XBT_PUBLIC void set_value<std::string>(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;
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 <class T> XBT_PUBLIC T const& get_value(const std::string& name)
{
- (*simgrid_config)[key].set_string_value(value);
+ return (*simgrid_config)[name].get_value<T>();
}
-/** @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<int>(const std::string& name);
+template XBT_PUBLIC double const& get_value<double>(const std::string& name);
+template XBT_PUBLIC bool const& get_value<bool>(const std::string& name);
+template XBT_PUBLIC std::string const& get_value<std::string>(const std::string& name);
+
+// ***** alias *****
+
+void alias(const char* realname, std::initializer_list<const char*> aliases)
{
- (*simgrid_config)[key].set_default_value<int>(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 <class T>
+XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, T value,
+ std::function<void(const T&)> callback)
{
- (*simgrid_config)[key].set_default_value<double>(value);
+ if (simgrid_config == nullptr)
+ simgrid_config = new simgrid::config::Config();
+ simgrid_config->register_option<T>(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<void(int const&)> callback);
+template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, double value,
+ std::function<void(double const&)> callback);
+template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, bool value,
+ std::function<void(bool const&)> callback);
+template XBT_PUBLIC void declare_flag(const std::string& name, const std::string& description, std::string value,
+ std::function<void(std::string const&)> callback);
+
+void finalize()
{
- (*simgrid_config)[key].set_default_value<std::string>(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<bool>(simgrid::config::parse_bool(value));
+ simgrid_config->help();
+}
}
+}
+
+/*----[ Setting ]---------------------------------------------------------*/
/** @brief Set an integer value to \a name within \a cfg
*
(*simgrid_config)[key].set_value<bool>(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)
*
return (*simgrid_config)[key].get_value<double>();
}
-/** @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<std::string>();
-}
-
/** @brief Retrieve a boolean value of a variable (get a warning if not uniq)
*
* @param key the name of the variable
{
return (*simgrid_config)[key].get_value<bool>() ? 1 : 0;
}
-
-#ifdef SIMGRID_TEST
-
-#include <string>
-
-#include "xbt.h"
-#include "xbt/ex.h"
-#include <xbt/ex.hpp>
-
-#include <xbt/config.hpp>
-
-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<int>("speed", "description", 0);
- simgrid::config::declare_flag<std::string>("peername", "description", "");
- simgrid::config::declare_flag<std::string>("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> int_flag("int", "", 0);
- simgrid::config::Flag<std::string> string_flag("string", "", "foo");
- simgrid::config::Flag<double> double_flag("double", "", 0.32);
- simgrid::config::Flag<bool> bool_flag1("bool1", "", false);
- simgrid::config::Flag<bool> 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 */
