-/* Copyright (c) 2004-2014,2016. The SimGrid Team.
- * All rights reserved. */
+/* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved. */
-#include <stdio.h>
+/* 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 <cstdio>
+
+#include <algorithm>
#include <cerrno>
#include <cstring>
#include <climits>
+
#include <functional>
+#include <map>
#include <stdexcept>
#include <string>
#include <type_traits>
+#include <typeinfo>
+#include <vector>
+#include <xbt/ex.hpp>
#include <xbt/config.h>
#include <xbt/config.hpp>
#include "xbt/misc.h"
#include "xbt/sysdep.h"
#include "xbt/log.h"
-#include "xbt/ex.h"
#include "xbt/dynar.h"
-#include "xbt/dict.h"
-
-// *****
XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_cfg, xbt, "configuration support");
-XBT_EXPORT_NO_IMPORT(xbt_cfg_t) simgrid_config = NULL;
+XBT_EXPORT_NO_IMPORT(xbt_cfg_t) simgrid_config = nullptr;
+extern "C" {
+ XBT_PUBLIC(void) sg_config_finalize();
+}
-/** @brief possible content of each configuration cell */
-typedef enum {
- xbt_cfgelm_int = 0, /**< int */
- xbt_cfgelm_double, /**< double */
- xbt_cfgelm_string, /**< char* */
- xbt_cfgelm_boolean, /**< int */
- //! @cond
- xbt_cfgelm_any, /* not shown to users to prevent errors */
- xbt_cfgelm_type_count
- //! @endcond
-} e_xbt_cfgelm_type_t;
+namespace simgrid {
+namespace config {
+missing_key_error::~missing_key_error() = default;
namespace {
-static inline
-void increment(e_xbt_cfgelm_type_t& type)
+const char* true_values[] = {
+ "yes", "on", "true", "1"
+};
+const char* false_values[] = {
+ "no", "off", "false", "0"
+};
+
+static bool parseBool(const char* value)
{
- typedef std::underlying_type<e_xbt_cfgelm_type_t>::type underlying_type;
- type = (e_xbt_cfgelm_type_t) ((underlying_type) type + 1);
+ for (const char* const& true_value : true_values)
+ if (std::strcmp(true_value, value) == 0)
+ return true;
+ for (const char* const& false_value : false_values)
+ if (std::strcmp(false_value, value) == 0)
+ return false;
+ throw std::range_error("not a boolean");
}
+static double parseDouble(const char* value)
+{
+ char* end;
+ errno = 0;
+ double res = std::strtod(value, &end);
+ if (errno == ERANGE)
+ throw std::range_error("out of range");
+ else if (errno)
+ xbt_die("Unexpected errno");
+ if (end == value || *end != '\0')
+ throw std::range_error("invalid double");
+ else
+ return res;
}
-static const char *xbt_cfgelm_type_name[xbt_cfgelm_type_count] = {
- "int", "double", "string", "boolean", "any"
-};
+static long int parseLong(const char* value)
+{
+ char* end;
+ errno = 0;
+ long int res = std::strtol(value, &end, 0);
+ if (errno) {
+ if (res == LONG_MIN && errno == ERANGE)
+ throw std::range_error("underflow");
+ else if (res == LONG_MAX && errno == ERANGE)
+ throw std::range_error("overflow");
+ xbt_die("Unexpected errno");
+ }
+ if (end == value || *end != '\0')
+ throw std::range_error("invalid integer");
+ else
+ return res;
+}
-/** Boolean possible values **/
-struct xbt_boolean_couple {
- const char *true_val;
- const char *false_val;
-};
+// ***** ConfigType *****
-const struct xbt_boolean_couple xbt_cfgelm_boolean_values[] = {
- { "yes", "no"},
- { "on", "off"},
- {"true", "false"},
- { "1", "0"},
- { NULL, NULL}
+/// A trait which define possible options types:
+template <class T> class ConfigType;
+
+template <> class ConfigType<int> {
+public:
+ static constexpr const char* type_name = "int";
+ static inline double parse(const char* value)
+ {
+ return parseLong(value);
+ }
+};
+template <> class ConfigType<double> {
+public:
+ static constexpr const char* type_name = "double";
+ static inline double parse(const char* value)
+ {
+ return parseDouble(value);
+ }
+};
+template <> class ConfigType<std::string> {
+public:
+ static constexpr const char* type_name = "string";
+ static inline std::string parse(const char* value)
+ {
+ return std::string(value);
+ }
+};
+template <> class ConfigType<bool> {
+public:
+ static constexpr const char* type_name = "boolean";
+ static inline bool parse(const char* value)
+ {
+ return parseBool(value);
+ }
};
-namespace simgrid {
-namespace config {
- struct ConfigurationElement ;
- class Config;
-}
-}
+// **** Forward declarations ****
-/* Retrieve the variable we'll modify */
-static simgrid::config::ConfigurationElement* xbt_cfgelm_get(xbt_cfg_t cfg, const char *name, e_xbt_cfgelm_type_t type);
+class ConfigurationElement ;
+template<class T> class TypedConfigurationElement;
-namespace simgrid {
-namespace config {
+// **** ConfigurationElement ****
-// A configuration variable:
-struct ConfigurationElement {
- /* Description */
+class ConfigurationElement {
+private:
+ std::string key;
std::string desc;
-
- /* Allowed type of the variable */
- e_xbt_cfgelm_type_t type;
bool isdefault = true;
+public:
/* Callback */
- xbt_cfg_cb_t cb_set = nullptr;
+ 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) {}
- /* Advanced callback (for xbt_cfgelm_string only) */
- std::function<void(const char* value)> callback;
+ virtual ~ConfigurationElement()=default;
- union {
- int int_content;
- double double_content;
- char* string_content;
- bool boolean_content;
- };
+ virtual std::string getStringValue() = 0;
+ virtual void setStringValue(const char* value) = 0;
+ virtual const char* getTypeName() = 0;
- ~ConfigurationElement()
+ template<class T>
+ T const& getValue() const
{
- XBT_DEBUG("Frees cfgelm %p", this);
- switch(this->type) {
- case xbt_cfgelm_int:
- case xbt_cfgelm_double:
- case xbt_cfgelm_boolean:
- break;
- case xbt_cfgelm_string:
- free(string_content);
- break;
- default:
- xbt_die("Unexpected config type");
- }
+ return dynamic_cast<const TypedConfigurationElement<T>&>(*this).getValue();
+ }
+ template<class T>
+ void setValue(T value)
+ {
+ dynamic_cast<TypedConfigurationElement<T>&>(*this).setValue(std::move(value));
+ }
+ template<class T>
+ void setDefaultValue(T value)
+ {
+ dynamic_cast<TypedConfigurationElement<T>&>(*this).setDefaultValue(std::move(value));
+ }
+ void unsetDefault() { isdefault = false; }
+ bool isDefault() const { return isdefault; }
+
+ std::string const& getDescription() const { return desc; }
+ std::string const& getKey() const { return key; }
+};
+
+// **** TypedConfigurationElement<T> ****
+
+// TODO, could we use boost::any with some Type* reference?
+template<class T>
+class TypedConfigurationElement : public ConfigurationElement {
+private:
+ T content;
+ 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 char* key, const char* 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)
+ : ConfigurationElement(key, desc), content(std::move(value)), callback(std::move(callback))
+ {}
+ ~TypedConfigurationElement() = default;
+
+ std::string getStringValue() override;
+ const char* getTypeName() override;
+ void setStringValue(const char* value) override;
+
+ void update()
+ {
+ if (old_callback)
+ this->old_callback(getKey().c_str());
+ if (this->callback)
+ this->callback(this->content);
+ }
+
+ T const& getValue() const { return content; }
+
+ void setValue(T value)
+ {
+ this->content = std::move(value);
+ this->update();
}
+ void setDefaultValue(T value)
+ {
+ 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.",
+ getKey().c_str(), to_string(value).c_str());
+ }
+ }
};
+template<class T>
+std::string TypedConfigurationElement<T>::getStringValue() // override
+{
+ return to_string(content);
+}
+
+template<class T>
+void TypedConfigurationElement<T>::setStringValue(const char* value) // override
+{
+ this->content = ConfigType<T>::parse(value);
+ this->unsetDefault();
+ this->update();
+}
+
+template<class T>
+const char* TypedConfigurationElement<T>::getTypeName() // override
+{
+ return ConfigType<T>::type_name;
+}
+
+} // end of anonymous namespace
+
+// **** Config ****
+
class Config {
+private:
// name -> ConfigElement:
- xbt_dict_t options;
+ std::map<std::string, simgrid::config::ConfigurationElement*> options;
// alias -> xbt_dict_elm_t from options:
- xbt_dict_t aliases;
+ std::map<std::string, simgrid::config::ConfigurationElement*> aliases;
+ bool warn_for_aliases = true;
public:
- Config();
+ Config() = default;
~Config();
// No copy:
Config(Config const&) = delete;
Config& operator=(Config const&) = delete;
- xbt_dictelm_t getElement(const char* name);
- ConfigurationElement* operator[](const char* name);
+ ConfigurationElement& operator[](const char* name);
+ template<class T>
+ TypedConfigurationElement<T>& getTyped(const char* name);
void alias(const char* realname, const char* aliasname);
- simgrid::config::ConfigurationElement* registerOption(
- const char *name, const char *desc, e_xbt_cfgelm_type_t type,
- xbt_cfg_cb_t cb_set);
+ template<class T, class... A>
+ simgrid::config::TypedConfigurationElement<T>*
+ registerOption(const char* name, A&&... a)
+ {
+ xbt_assert(options.find(name) == options.end(), "Refusing to register the config element '%s' twice.", name);
+ 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->getDescription().c_str(),
+ variable->getTypeName(), variable, this);
+ options.insert({name, variable});
+ variable->update();
+ return variable;
+ }
// Debug:
void dump(const char *name, const char *indent);
void showAliases();
void help();
-};
-/* Internal stuff used in cache to free a variable */
-static void xbt_cfgelm_free(void *data)
-{
- if (data)
- delete (simgrid::config::ConfigurationElement*) data;
-}
-
-Config::Config() :
- options(xbt_dict_new_homogeneous(xbt_cfgelm_free)),
- aliases(xbt_dict_new_homogeneous(NULL))
-{}
+protected:
+ ConfigurationElement* getDictElement(const char* name);
+};
Config::~Config()
{
XBT_DEBUG("Frees cfg set %p", this);
- xbt_dict_free(&this->options);
- xbt_dict_free(&this->aliases);
-}
-
-inline
-xbt_dictelm_t Config::getElement(const char* name)
-{
- // We are interested in the options dictelm:
- xbt_dictelm_t res = xbt_dict_get_elm_or_null(options, name);
- if (res)
- return res;
- // The aliases dict stores pointers to the options dictelm:
- res = (xbt_dictelm_t) xbt_dict_get_or_null(aliases, name);
- if (res)
- XBT_INFO("Option %s has been renamed to %s. Consider switching.", name, res->key);
- return res;
+ for (auto const& elm : options)
+ delete elm.second;
+}
+
+inline ConfigurationElement* Config::getDictElement(const char* 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;
+ } else {
+ throw simgrid::config::missing_key_error(std::string("Bad config key: ") + name);
+ }
+ }
}
-inline
-ConfigurationElement* Config::operator[](const char* name)
+inline ConfigurationElement& Config::operator[](const char* name)
{
- xbt_dictelm_t elm = getElement(name);
- if (elm)
- return (ConfigurationElement*) elm->content;
- else
- return nullptr;
+ return *(getDictElement(name));
}
void Config::alias(const char* realname, const char* aliasname)
{
- xbt_assert(this->getElement(aliasname) == nullptr, "Alias '%s' already.", aliasname);
- xbt_dictelm_t element = this->getElement(realname);
+ xbt_assert(aliases.find(aliasname) == aliases.end(), "Alias '%s' already.", aliasname);
+ ConfigurationElement* element = this->getDictElement(realname);
xbt_assert(element, "Cannot define an alias to the non-existing option '%s'.", realname);
- xbt_dict_set(this->aliases, aliasname, element, NULL);
+ this->aliases.insert({aliasname, element});
}
/** @brief Dump a config set for debuging purpose
*/
void Config::dump(const char *name, const char *indent)
{
- xbt_dict_t dict = this->options;
- xbt_dict_cursor_t cursor = NULL;
- simgrid::config::ConfigurationElement* variable = NULL;
- char *key = NULL;
-
if (name)
printf("%s>> Dumping of the config set '%s':\n", indent, name);
- xbt_dict_foreach(dict, cursor, key, variable) {
- const char* type_name = xbt_cfgelm_type_name[variable->type];
- switch (variable->type) {
- case xbt_cfgelm_int:
- printf("%s %s: ()%s) %i", indent, key, type_name, variable->int_content);
- break;
- case xbt_cfgelm_double:
- printf("%s %s: ()%s) %f", indent, key, type_name, variable->double_content);
- break;
- case xbt_cfgelm_string:
- printf("%s %s: ()%s) %s", indent, key, type_name, variable->string_content);
- break;
- case xbt_cfgelm_boolean:
- printf("%s %s: ()%s) %s", indent, key, type_name,
- variable->boolean_content ? "true" : "false");
- break;
- default:
- printf("%s Invalid type!!\n", indent);
- break;
- }
- }
+ for (auto const& elm : options)
+ printf("%s %s: ()%s) %s", indent, elm.first.c_str(), elm.second->getTypeName(),
+ elm.second->getStringValue().c_str());
if (name)
printf("%s<< End of the config set '%s'\n", indent, name);
fflush(stdout);
-
- xbt_dict_cursor_free(&cursor);
-}
-
-simgrid::config::ConfigurationElement* Config::registerOption(
- const char *name, const char *desc, e_xbt_cfgelm_type_t type, xbt_cfg_cb_t cb_set)
-{
- xbt_assert(type >= xbt_cfgelm_int && type <= xbt_cfgelm_boolean,
- "type of %s not valid (%d should be between %d and %d)",
- name, (int)type, xbt_cfgelm_int, xbt_cfgelm_boolean);
-
- simgrid::config::ConfigurationElement* res = (simgrid::config::ConfigurationElement*) xbt_dict_get_or_null(this->options, name);
- xbt_assert(NULL == res, "Refusing to register the config element '%s' twice.", name);
-
- res = new simgrid::config::ConfigurationElement();
- XBT_DEBUG("Register cfg elm %s (%s) (%s (=%d) @%p in set %p)",
- name, desc, xbt_cfgelm_type_name[type], (int)type, res, this);
- res->type = type;
- res->cb_set = cb_set;
- if (desc)
- res->desc = desc;
-
- // Set a default default value:
- switch (type) {
- case xbt_cfgelm_int:
- res->int_content = 0;
- break;
- case xbt_cfgelm_double:
- res->double_content = 0.0;
- break;
- case xbt_cfgelm_string:
- res->string_content = nullptr;
- break;
- case xbt_cfgelm_boolean:
- res->boolean_content = false;
- break;
- default:
- XBT_ERROR("%d is an invalid type code", (int)type);
- break;
- }
-
- xbt_dict_set(this->options, name, res, NULL);
- return res;
}
/** @brief Displays the declared aliases and their description */
void Config::showAliases()
{
- xbt_dict_cursor_t dict_cursor;
- unsigned int dynar_cursor;
- xbt_dictelm_t dictel;
- char *name;
- xbt_dynar_t names = xbt_dynar_new(sizeof(char *), NULL);
-
- xbt_dict_foreach(this->aliases, dict_cursor, name, dictel)
- xbt_dynar_push(names, &name);
- xbt_dynar_sort_strings(names);
-
- xbt_dynar_foreach(names, dynar_cursor, name) {
- simgrid::config::ConfigurationElement* variable = (*this)[name];
- if (variable)
- printf(" %s: %s\n", name, variable->desc.c_str());
- }
+ bool old_warn_for_aliases = false;
+ std::swap(warn_for_aliases, old_warn_for_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);
}
/** @brief Displays the declared options and their description */
void Config::help()
{
- xbt_dict_cursor_t dict_cursor;
- unsigned int dynar_cursor;
- simgrid::config::ConfigurationElement* variable;
- char *name;
- xbt_dynar_t names = xbt_dynar_new(sizeof(char *), NULL);
+ 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());
+ }
+}
+
+// ***** getConfig *****
+
+template<class T>
+XBT_PUBLIC(T const&) getConfig(const char* name)
+{
+ return (*simgrid_config)[name].getValue<T>();
+}
- xbt_dict_foreach(this->options, dict_cursor, name, variable)
- xbt_dynar_push(names, &name);
- xbt_dynar_sort_strings(names);
+template XBT_PUBLIC(int const&) getConfig<int>(const char* name);
+template XBT_PUBLIC(double const&) getConfig<double>(const char* name);
+template XBT_PUBLIC(bool const&) getConfig<bool>(const char* name);
+template XBT_PUBLIC(std::string const&) getConfig<std::string>(const char* name);
- xbt_dynar_foreach(names, dynar_cursor, name) {
- variable = (simgrid::config::ConfigurationElement*) xbt_dict_get(this->options, name);
+// ***** alias *****
- printf(" %s: %s\n", name, variable->desc.c_str());
- printf(" Type: %s; ", xbt_cfgelm_type_name[variable->type]);
- printf("Current value: ");
+void alias(const char* realname, const char* aliasname)
+{
+ simgrid_config->alias(realname, aliasname);
+}
- switch (variable->type) {
- case xbt_cfgelm_int:
- printf("%d\n", variable->int_content);
- break;
- case xbt_cfgelm_double:
- printf("%f\n", variable->double_content);
- break;
- case xbt_cfgelm_string:
- printf("'%s'\n", variable->string_content);
- break;
- case xbt_cfgelm_boolean:
- printf("'%s'\n", variable->boolean_content ? "true" : "false");
- break;
- default:
- printf("Invalid type!!\n");
- break;
- }
+// ***** declareFlag *****
+template<class T>
+XBT_PUBLIC(void) declareFlag(const char* name, const char* description,
+ T value, std::function<void(const T&)> callback)
+{
+ if (simgrid_config == nullptr) {
+ simgrid_config = xbt_cfg_new();
+ atexit(sg_config_finalize);
}
- xbt_dynar_free(&names);
+ simgrid_config->registerOption<T>(
+ name, description, std::move(value), std::move(callback));
}
+template XBT_PUBLIC(void) declareFlag(const char* name,
+ const char* description, int value, std::function<void(int const &)> callback);
+template XBT_PUBLIC(void) declareFlag(const char* name,
+ const char* description, double value, std::function<void(double const &)> callback);
+template XBT_PUBLIC(void) declareFlag(const char* name,
+ const char* description, bool value, std::function<void(bool const &)> callback);
+template XBT_PUBLIC(void) declareFlag(const char* name,
+ const char* description, std::string value, std::function<void(std::string const &)> callback);
+
}
}
-// C bindings:
+// ***** C bindings *****
-/** @brief Constructor */
-xbt_cfg_t xbt_cfg_new(void) { return new simgrid::config::Config(); }
-/** @brief Destructor */
+xbt_cfg_t xbt_cfg_new() { 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)
}
/*----[ Registering stuff ]-----------------------------------------------*/
-/** @brief Register an element within a config set
- *
- * @param cfg the config set
- * @param name the name of the config element
- * @param desc a description for this item (used by xbt_cfg_help())
- * @param type the type of the config element
- * @param cb_set callback function called when a value is set
- */
-static simgrid::config::ConfigurationElement* xbt_cfg_register(
- xbt_cfg_t * cfg, const char *name, const char *desc, e_xbt_cfgelm_type_t type, xbt_cfg_cb_t cb_set)
-{
- if (*cfg == NULL)
- *cfg = xbt_cfg_new();
- return (*cfg)->registerOption(name, desc, type, cb_set);
-}
-void xbt_cfg_register_double(const char *name, double default_value,xbt_cfg_cb_t cb_set, const char *desc)
+void xbt_cfg_register_double(const char *name, double default_value,
+ xbt_cfg_cb_t cb_set, const char *desc)
{
- xbt_cfg_register(&simgrid_config, name, desc, xbt_cfgelm_double, cb_set);
- xbt_cfg_setdefault_double(name, default_value);
+ if (simgrid_config == nullptr)
+ simgrid_config = xbt_cfg_new();
+ simgrid_config->registerOption<double>(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)
{
- xbt_cfg_register(&simgrid_config, name, desc, xbt_cfgelm_int, cb_set);
- xbt_cfg_setdefault_int(name, default_value);
+ if (simgrid_config == nullptr) {
+ simgrid_config = xbt_cfg_new();
+ atexit(&sg_config_finalize);
+ }
+ simgrid_config->registerOption<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)
{
- xbt_cfg_register(&simgrid_config,name,desc,xbt_cfgelm_string,cb_set);
- xbt_cfg_setdefault_string(name, default_value);
+ if (simgrid_config == nullptr) {
+ simgrid_config = xbt_cfg_new();
+ atexit(sg_config_finalize);
+ }
+ simgrid_config->registerOption<std::string>(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)
{
- xbt_cfg_register(&simgrid_config,name,desc,xbt_cfgelm_boolean,cb_set);
- xbt_cfg_setdefault_boolean(name, default_value);
+ if (simgrid_config == nullptr) {
+ simgrid_config = xbt_cfg_new();
+ atexit(sg_config_finalize);
+ }
+ simgrid_config->registerOption<bool>(name, desc, simgrid::config::parseBool(default_value), cb_set);
}
void xbt_cfg_register_alias(const char *realname, const char *aliasname)
{
- if (simgrid_config == NULL)
+ if (simgrid_config == nullptr) {
simgrid_config = xbt_cfg_new();
+ atexit(sg_config_finalize);
+ }
simgrid_config->alias(realname, aliasname);
}
-/**
- * @brief Parse a string and register the stuff described.
- *
- * @param cfg the config set
- * @param entry a string describing the element to register
- *
- * The string may consist in several variable descriptions separated by a space.
- * Each of them must use the following syntax: \<name\>:\<type\>
- * with type being one of 'string','int','bool' or 'double'.
- *
- * Note that this does not allow to set the description, so you should prefer the other interface
- */
-void xbt_cfg_register_str(xbt_cfg_t * cfg, const char *entry)
-{
- char *entrycpy = xbt_strdup(entry);
- char *tok;
-
- e_xbt_cfgelm_type_t type;
- XBT_DEBUG("Register string '%s'", entry);
-
- tok = strchr(entrycpy, ':');
- xbt_assert(tok, "Invalid config element descriptor: %s; Should be <name>:<type>", entry);
- *(tok++) = '\0';
-
- for (type = (e_xbt_cfgelm_type_t)0; type < xbt_cfgelm_type_count && strcmp(tok, xbt_cfgelm_type_name[type]); increment(type));
- xbt_assert(type < xbt_cfgelm_type_count,
- "Invalid type in config element descriptor: %s; Should be one of 'string', 'int' or 'double'.", entry);
-
- xbt_cfg_register(cfg, entrycpy, NULL, type, NULL);
-
- free(entrycpy); /* strdup'ed by dict mechanism, but cannot be const */
-}
-
-void xbt_cfg_aliases(void) { simgrid_config->showAliases(); }
-void xbt_cfg_help(void) { simgrid_config->help(); }
-
-static simgrid::config::ConfigurationElement* xbt_cfgelm_get(xbt_cfg_t cfg, const char *name, e_xbt_cfgelm_type_t type)
-{
- simgrid::config::ConfigurationElement* res = (*cfg)[name];
-
- if (!res) {
- xbt_cfg_help();
- fflush(stdout);
- THROWF(not_found_error, 0, "No registered variable '%s' in this config set.", name);
- }
-
- xbt_assert(type == xbt_cfgelm_any || res->type == type,
- "You tried to access to the config element %s as an %s, but its type is %s.",
- name, xbt_cfgelm_type_name[type], xbt_cfgelm_type_name[res->type]);
- return res;
-}
+void xbt_cfg_aliases() { simgrid_config->showAliases(); }
+void xbt_cfg_help() { simgrid_config->help(); }
/*----[ Setting ]---------------------------------------------------------*/
*/
void xbt_cfg_set_parse(const char *options)
{
- if (!options || !strlen(options)) { /* nothing to do */
+ 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 (!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++;
+ 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());
+
+ try {
+ (*simgrid_config)[name.c_str()].setStringValue(val.c_str());
}
- if (option - name == len) {
- XBT_DEBUG("Boundary=EOL");
- option = NULL; /* 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 = NULL; /* don't do next iteration */
+ catch (simgrid::config::missing_key_error& e) {
+ goto on_missing_key;
}
- XBT_DEBUG("parse now:'%s'; parse later:'%s'", name, option);
-
- if (name[0] == ' ' || name[0] == '\n' || name[0] == '\t')
- continue;
- if (!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';
-
- if (strncmp(name, "contexts/", strlen("contexts/")) && strncmp(name, "path", strlen("path")))
- XBT_INFO("Configuration change: Set '%s' to '%s'", name, val);
-
- TRY {
- xbt_cfg_set_as_string(name,val);
- } CATCH_ANONYMOUS {
- free(optionlist_cpy);
- RETHROW;
+ catch (...) {
+ 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:
+ THROWF(not_found_error, 0, "Could not set variables %s", options);
+on_exception:
+ THROWF(unknown_error, 0, "Could not set variables %s", options);
}
+// Horrible mess to translate C++ exceptions to C exceptions:
+// Exit from the catch block (and do the correct exception cleaning) before attempting to THROWF.
+#define TRANSLATE_EXCEPTIONS(...) \
+ catch(simgrid::config::missing_key_error& e) { THROWF(not_found_error, 0, __VA_ARGS__); abort(); } \
+ catch(...) { THROWF(not_found_error, 0, __VA_ARGS__); abort(); }
+
/** @brief Set the value of a variable, using the string representation of that value
*
* @param key name of the variable to modify
void xbt_cfg_set_as_string(const char *key, const char *value)
{
- simgrid::config::ConfigurationElement* variable = (*simgrid_config)[key];
- if (variable == nullptr)
- THROWF(not_found_error, 0, "No registered variable corresponding to '%s'.", key);
-
- char *ret;
- int i;
- double d;
-
- switch (variable->type) {
- case xbt_cfgelm_string:
- xbt_cfg_set_string(key, value); /* throws */
- break;
- case xbt_cfgelm_int:
- i = strtol(value, &ret, 0);
- if (ret == value || *ret != '\0')
- xbt_die("Value of option %s not valid. Should be an integer", key);
- xbt_cfg_set_int(key, i); /* throws */
- break;
- case xbt_cfgelm_double:
- d = strtod(value, &ret);
- if (ret == value || *ret != '\0')
- xbt_die("Value of option %s not valid. Should be a double", key);
- xbt_cfg_set_double(key, d); /* throws */
- break;
- case xbt_cfgelm_boolean:
- xbt_cfg_set_boolean(key, value); /* throws */
- break;
- default:
- THROWF(unknown_error, 0, "Type of config element %s is not valid.", key);
- break;
+ try {
+ (*simgrid_config)[key].setStringValue(value);
+ return;
}
+ TRANSLATE_EXCEPTIONS("Could not set variable %s as string %s", key, 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 *name, int val)
+void xbt_cfg_setdefault_int(const char *key, int value)
{
- simgrid::config::ConfigurationElement* variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_int);
-
- if (variable->isdefault){
- xbt_cfg_set_int(name, val);
- variable->isdefault = true;
- } else
- XBT_DEBUG("Do not override configuration variable '%s' with value '%d' because it was already set.", name, val);
+ try {
+ (*simgrid_config)[key].setDefaultValue<int>(value);
+ return;
+ }
+ TRANSLATE_EXCEPTIONS("Could not set variable %s to default integer %i", key, 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_double(const char *name, double val)
+void xbt_cfg_setdefault_double(const char *key, double value)
{
- simgrid::config::ConfigurationElement* variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_double);
-
- if (variable->isdefault) {
- xbt_cfg_set_double(name, val);
- variable->isdefault = true;
- } else
- XBT_DEBUG("Do not override configuration variable '%s' with value '%f' because it was already set.", name, val);
+ try {
+ (*simgrid_config)[key].setDefaultValue<double>(value);
+ return;
+ }
+ TRANSLATE_EXCEPTIONS("Could not set variable %s to default double %f", key, value);
}
/** @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 *name, const char *val)
+void xbt_cfg_setdefault_string(const char *key, const char *value)
{
- simgrid::config::ConfigurationElement* variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_string);
-
- if (variable->isdefault){
- xbt_cfg_set_string(name, val);
- variable->isdefault = true;
- } else
- XBT_DEBUG("Do not override configuration variable '%s' with value '%s' because it was already set.", name, val);
+ try {
+ (*simgrid_config)[key].setDefaultValue<std::string>(value ? value : "");
+ return;
+ }
+ TRANSLATE_EXCEPTIONS("Could not set variable %s to default string %s", key, value);
}
/** @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 *name, const char *val)
+void xbt_cfg_setdefault_boolean(const char *key, const char *value)
{
- simgrid::config::ConfigurationElement* variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_boolean);
-
- if (variable->isdefault){
- xbt_cfg_set_boolean(name, val);
- variable->isdefault = true;
+ try {
+ (*simgrid_config)[key].setDefaultValue<bool>(simgrid::config::parseBool(value));
+ return;
}
- else
- XBT_DEBUG("Do not override configuration variable '%s' with value '%s' because it was already set.", name, val);
+ TRANSLATE_EXCEPTIONS("Could not set variable %s to default boolean %s", key, value);
}
/** @brief Set an integer value to \a name within \a cfg
*
- * @param name the name of the variable
- * @param val the value of the variable
+ * @param key the name of the variable
+ * @param value the value of the variable
*/
-void xbt_cfg_set_int(const char *name, int val)
+void xbt_cfg_set_int(const char *key, int value)
{
- simgrid::config::ConfigurationElement* variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_int);
- variable->int_content = val;
- if (variable->cb_set)
- variable->cb_set(name);
- variable->isdefault = false;
+ try {
+ (*simgrid_config)[key].setValue<int>(value);
+ return;
+ }
+ TRANSLATE_EXCEPTIONS("Could not set variable %s to integer %i", key, value);
}
/** @brief Set or add a double value to \a name within \a cfg
*
- * @param name the name of the variable
- * @param val the double to set
+ * @param key the name of the variable
+ * @param value the double to set
*/
-void xbt_cfg_set_double(const char *name, double val)
+void xbt_cfg_set_double(const char *key, double value)
{
- simgrid::config::ConfigurationElement* variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_double);
- variable->double_content = val;
- if (variable->cb_set)
- variable->cb_set(name);
- variable->isdefault = false;
+ try {
+ (*simgrid_config)[key].setValue<double>(value);
+ return;
+ }
+ TRANSLATE_EXCEPTIONS("Could not set variable %s to double %f", key, value);
}
/** @brief Set or add a string value to \a name within \a cfg
*
- * @param cfg the config set
- * @param name the name of the variable
- * @param val the value to be added
+ * @param key the name of the variable
+ * @param value the value to be added
*
*/
-void xbt_cfg_set_string(const char *name, const char *val)
+void xbt_cfg_set_string(const char *key, const char *value)
{
- simgrid::config::ConfigurationElement* variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_string);
- free(variable->string_content);
- variable->string_content = xbt_strdup(val);
- if (variable->cb_set)
- variable->cb_set(name);
- variable->isdefault = false;
-
- if (variable->callback) {
- try {
- variable->callback(val);
- }
- catch(std::range_error& e) {
- xbt_die("Invalid flag %s=%s: %s", val, name, e.what());
- }
- catch(std::exception& e) {
- xbt_die("Error for flag %s=%s: %s", val, name, e.what());
- }
- catch(...) {
- xbt_die("Error for flag %s=%s", val, name);
- }
+ try {
+ (*simgrid_config)[key].setValue<std::string>(value ? value : "");
+ return;
}
+ TRANSLATE_EXCEPTIONS("Could not set variable %s to string %s", key, value);
}
/** @brief Set or add a boolean value to \a name within \a cfg
*
- * @param name the name of the variable
- * @param val the value of the variable
+ * @param key the name of the variable
+ * @param value the value of the variable
*/
-void xbt_cfg_set_boolean(const char *name, const char *val)
+void xbt_cfg_set_boolean(const char *key, const char *value)
{
- int bval=-1;
- simgrid::config::ConfigurationElement* variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_boolean);
-
- for (int i = 0; xbt_cfgelm_boolean_values[i].true_val != NULL; i++) {
- if (strcmp(val, xbt_cfgelm_boolean_values[i].true_val) == 0){
- bval = 1;
- break;
- }
- if (strcmp(val, xbt_cfgelm_boolean_values[i].false_val) == 0){
- bval = 0;
- break;
- }
+ try {
+ (*simgrid_config)[key].setValue<bool>(simgrid::config::parseBool(value));
+ return;
}
- xbt_assert(bval != -1, "Value of option '%s' not valid. Should be a boolean (yes,no,on,off,true,false,0,1)", val);
- variable->boolean_content = bval;
- if (variable->cb_set)
- variable->cb_set(name);
- variable->isdefault = false;
+ TRANSLATE_EXCEPTIONS("Could not set variable %s to boolean %s", key, value);
}
/* Say if the value is the default value */
-int xbt_cfg_is_default_value(const char *name)
+int xbt_cfg_is_default_value(const char *key)
{
- simgrid::config::ConfigurationElement* variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_any);
- return variable->isdefault;
+ try {
+ return (*simgrid_config)[key].isDefault() ? 1 : 0;
+ }
+ TRANSLATE_EXCEPTIONS("Could not get variable %s", key);
}
/*----[ Getting ]---------------------------------------------------------*/
/** @brief Retrieve an integer value of a variable (get a warning if not uniq)
*
- * @param name the name of the variable
+ * @param key the name of the variable
*
* Returns the first value from the config set under the given name.
*/
-int xbt_cfg_get_int(const char *name)
+int xbt_cfg_get_int(const char *key)
{
- simgrid::config::ConfigurationElement* variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_int);
- return variable->int_content;
+ try {
+ return (*simgrid_config)[key].getValue<int>();
+ }
+ TRANSLATE_EXCEPTIONS("Could not get variable %s", key);
}
/** @brief Retrieve a double value of a variable (get a warning if not uniq)
*
- * @param cfg the config set
- * @param name the name of the variable
+ * @param key the name of the variable
*
* Returns the first value from the config set under the given name.
*/
-double xbt_cfg_get_double(const char *name)
+double xbt_cfg_get_double(const char *key)
{
- simgrid::config::ConfigurationElement* variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_double);
- return variable->double_content;
+ try {
+ return (*simgrid_config)[key].getValue<double>();
+ }
+ TRANSLATE_EXCEPTIONS("Could not get variable %s", key);
}
/** @brief Retrieve a string value of a variable (get a warning if not uniq)
*
- * @param cfg the config set
- * @param name the name of the variable
+ * @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 NULL if there is no value.
+ * Returns nullptr if there is no value.
*
* \warning the returned value is the actual content of the config set
*/
-char *xbt_cfg_get_string(const char *name)
+char *xbt_cfg_get_string(const char *key)
{
- simgrid::config::ConfigurationElement* variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_string);
- return variable->string_content;
+ try {
+ return (char*) (*simgrid_config)[key].getValue<std::string>().c_str();
+ }
+ TRANSLATE_EXCEPTIONS("Could not get variable %s", key);
}
/** @brief Retrieve a boolean value of a variable (get a warning if not uniq)
*
- * @param cfg the config set
- * @param name the name of the variable
+ * @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.
*/
-int xbt_cfg_get_boolean(const char *name)
-{
- simgrid::config::ConfigurationElement* variable = xbt_cfgelm_get(simgrid_config, name, xbt_cfgelm_boolean);
- return variable->boolean_content;
-}
-
-namespace simgrid {
-namespace config {
-
-bool parseBool(const char* value)
-{
- for (int i = 0; xbt_cfgelm_boolean_values[i].true_val != NULL; i++) {
- if (std::strcmp(value, xbt_cfgelm_boolean_values[i].true_val) == 0)
- return true;
- if (std::strcmp(value, xbt_cfgelm_boolean_values[i].false_val) == 0)
- return false;
- }
- throw std::range_error("not a boolean");
-}
-
-double parseDouble(const char* value)
-{
- char* end;
- errno = 0;
- double res = std::strtod(value, &end);
- if (errno == ERANGE)
- throw std::range_error("out of range");
- else if (errno)
- xbt_die("Unexpected errno");
- if (end == value || *end != '\0')
- throw std::range_error("invalid double");
- else
- return res;
-}
-
-long int parseLong(const char* value)
+int xbt_cfg_get_boolean(const char *key)
{
- char* end;
- errno = 0;
- long int res = std::strtol(value, &end, 0);
- if (errno) {
- if (res == LONG_MIN && errno == ERANGE)
- throw std::range_error("underflow");
- else if (res == LONG_MAX && errno == ERANGE)
- throw std::range_error("overflow");
- xbt_die("Unexpected errno");
+ try {
+ return (*simgrid_config)[key].getValue<bool>() ? 1 : 0;
}
- if (end == value || *end != '\0')
- throw std::range_error("invalid integer");
- else
- return res;
-}
-
-void declareFlag(const char* name, const char* description,
- std::function<void(const char* value)> callback)
-{
- simgrid::config::ConfigurationElement* e = xbt_cfg_register(
- &simgrid_config, name, description, xbt_cfgelm_string, NULL);
- e->callback = std::move(callback);
-}
-
-}
+ TRANSLATE_EXCEPTIONS("Could not get variable %s", key);
}
#ifdef SIMGRID_TEST
#include "xbt.h"
#include "xbt/ex.h"
+#include <xbt/ex.hpp>
#include <xbt/config.hpp>
XBT_TEST_SUITE("config", "Configuration support");
-static xbt_cfg_t make_set()
-{
- xbt_cfg_t set = NULL;
+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);
- xbt_cfg_register_str(&set, "speed:int");
- xbt_cfg_register_str(&set, "peername:string");
- xbt_cfg_register_str(&set, "user:string");
-
- return set;
+ xbt_cfg_register_int("speed", 0, nullptr, "");
+ xbt_cfg_register_string("peername", "", nullptr, "");
+ xbt_cfg_register_string("user", "", nullptr, "");
} /* end_of_make_set */
-XBT_PUBLIC_DATA(xbt_cfg_t) simgrid_config;
-
XBT_TEST_UNIT("memuse", test_config_memuse, "Alloc and free a config set")
{
- simgrid_config = make_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")
{
- simgrid_config = make_set();
+ auto temp = simgrid_config;
+ make_set();
xbt_test_add("Get a single value");
{
/* get_single_value */
- int ival;
-
xbt_cfg_set_parse("peername:toto:42 speed:42");
- ival = xbt_cfg_get_int("speed");
+ 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");
{
- xbt_ex_t e;
-
- TRY {
+ try {
xbt_cfg_set_parse("color:blue");
- } CATCH(e) {
+ } catch(xbt_ex& e) {
if (e.category != not_found_error)
xbt_test_exception(e);
- xbt_ex_free(e);
}
}
xbt_cfg_free(&simgrid_config);
+ simgrid_config = temp;
}
XBT_TEST_UNIT("c++flags", test_config_cxx_flags, "C++ flags")
{
- simgrid_config = make_set();
+ auto temp = simgrid_config;
+ make_set();
xbt_test_add("C++ declaration of flags");
simgrid::config::Flag<int> int_flag("int", "", 0);
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(!bool_flag2, "Check bool2 flag");
+ xbt_test_assert(not bool_flag2, "Check bool2 flag");
xbt_cfg_free(&simgrid_config);
+ simgrid_config = temp;
}
#endif /* SIMGRID_TEST */
