-/* Copyright (c) 2004-2014,2016. 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. */
-#include <stdio.h>
+#include <cstdio>
#include <algorithm>
#include <cerrno>
#include <climits>
#include <functional>
+#include <map>
#include <stdexcept>
#include <string>
+#include <string>
#include <type_traits>
#include <typeinfo>
-#include <unordered_map>
#include <vector>
-#include <xbt/ex.hpp>
-#include <xbt/config.h>
-#include <xbt/config.hpp>
+#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 <xbt/config.h>
+#include <xbt/config.hpp>
+#include <xbt/ex.hpp>
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[] = {
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");
// ***** ConfigType *****
/// A trait which define possible options types:
-template<class T> struct ConfigType;
+template <class T> class ConfigType;
-template<> struct ConfigType<int> {
+template <> class ConfigType<int> {
+public:
static constexpr const char* type_name = "int";
static inline double parse(const char* value)
{
return parseLong(value);
}
};
-template<> struct ConfigType<double> {
+template <> class ConfigType<double> {
+public:
static constexpr const char* type_name = "double";
static inline double parse(const char* value)
{
return parseDouble(value);
}
};
-template<> struct ConfigType<std::string> {
+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<> struct ConfigType<bool> {
+template <> class ConfigType<bool> {
+public:
static constexpr const char* type_name = "boolean";
static inline bool parse(const char* value)
{
// **** ConfigurationElement ****
class ConfigurationElement {
-protected:
+private:
std::string key;
std::string desc;
bool isdefault = true;
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) {}
{
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; }
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, 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(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;
+ ~TypedConfigurationElement() = default;
std::string getStringValue() override;
const char* getTypeName() override;
void update()
{
if (old_callback)
- this->old_callback(key.c_str());
+ this->old_callback(getKey().c_str());
if (this->callback)
this->callback(this->content);
}
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());
}
}
};
void TypedConfigurationElement<T>::setStringValue(const char* value) // override
{
this->content = ConfigType<T>::parse(value);
- this->isdefault = false;
+ this->unsetDefault();
this->update();
}
class Config {
private:
// name -> ConfigElement:
- std::unordered_map<std::string, simgrid::config::ConfigurationElement*> options;
- // alias -> xbt_dict_elm_t from options:
- std::unordered_map<std::string, simgrid::config::ConfigurationElement*> aliases;
+ std::map<std::string, simgrid::config::ConfigurationElement*> options;
+ // alias -> ConfigElement from options:
+ std::map<std::string, simgrid::config::ConfigurationElement*> aliases;
+ bool warn_for_aliases = true;
public:
- Config() = default;
+ Config();
~Config();
// No copy:
ConfigurationElement* getDictElement(const char* name);
};
+Config::Config()
+{
+ atexit(&sg_config_finalize);
+}
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);
- XBT_INFO("Option %s has been renamed to %s. Consider switching.", name, res->getKey().c_str());
+ 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);
}
}
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());
/** @brief Displays the declared aliases and their description */
void Config::showAliases()
{
- std::vector<std::string> names;
-
- for (auto elm : aliases)
- names.push_back(elm.first);
- std::sort(names.begin(), names.end());
-
- for (auto name : names)
- printf(" %s: %s\n", name.c_str(), (*this)[name.c_str()].getDescription().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()
{
- std::vector<std::string> names;
-
- for (auto elm : options)
- names.push_back(elm.first);
- std::sort(names.begin(), names.end());
-
- for (auto name : names) {
- simgrid::config::ConfigurationElement* variable = this->options.at(name);
- printf(" %s: %s\n", name.c_str(), variable->getDescription().c_str());
+ 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)
+template <class T> XBT_PUBLIC T const& getConfig(const char* name)
{
return (*simgrid_config)[name].getValue<T>();
}
-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);
+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);
// ***** alias *****
// ***** declareFlag *****
-template<class T>
-XBT_PUBLIC(void) declareFlag(const char* name, const char* description,
- T value, std::function<void(const T&)> callback)
+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) {
+ if (simgrid_config == nullptr)
simgrid_config = xbt_cfg_new();
- atexit(sg_config_finalize);
- }
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);
-
+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 *****
-xbt_cfg_t xbt_cfg_new() { return new simgrid::config::Config(); }
+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)
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<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) {
+ 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);
+ 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)
{
- if (simgrid_config == nullptr) {
+ 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 == nullptr) {
+ if (simgrid_config == nullptr)
simgrid_config = xbt_cfg_new();
- atexit(sg_config_finalize);
- }
simgrid_config->alias(realname, aliasname);
}
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;
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);
}
// Horrible mess to translate C++ exceptions to C exceptions:
-// Exit from the catch blog (and do the correct exceptio cleaning)
-// before attempting to THROWF.
+// 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(); }
(*simgrid_config)[key].setDefaultValue<int>(value);
return;
}
- TRANSLATE_EXCEPTIONS("Could not set variable %s to default integer %i",
- key, value);
+ 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
(*simgrid_config)[key].setDefaultValue<double>(value);
return;
}
- TRANSLATE_EXCEPTIONS("Could not set variable %s to default double %f",
- key, value);
+ 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
(*simgrid_config)[key].setDefaultValue<std::string>(value ? value : "");
return;
}
- TRANSLATE_EXCEPTIONS("Could not set variable %s to default string %s",
- key, value);
+ 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
(*simgrid_config)[key].setDefaultValue<bool>(simgrid::config::parseBool(value));
return;
}
- TRANSLATE_EXCEPTIONS("Could not set variable %s to default boolean %s",
- key, value);
+ TRANSLATE_EXCEPTIONS("Could not set variable %s to default boolean %s", key, value);
}
/** @brief Set an integer value to \a name within \a cfg
(*simgrid_config)[key].setValue<int>(value);
return;
}
- TRANSLATE_EXCEPTIONS("Could not set variable %s to integer %i",
- key, value);
+ 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
(*simgrid_config)[key].setValue<double>(value);
return;
}
- TRANSLATE_EXCEPTIONS("Could not set variable %s to double %f",
- key, value);
+ 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 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<std::string>(value ? value : "");
+ (*simgrid_config)[key].setValue<std::string>(value);
return;
}
- TRANSLATE_EXCEPTIONS("Could not set variable %s to string %s",
- key, value);
+ 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
(*simgrid_config)[key].setValue<bool>(simgrid::config::parseBool(value));
return;
}
- TRANSLATE_EXCEPTIONS("Could not set variable %s to boolean %s",
- key, value);
+ TRANSLATE_EXCEPTIONS("Could not set variable %s to boolean %s", key, value);
}
*
* \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<std::string>().c_str();
+ return (*simgrid_config)[key].getValue<std::string>();
}
TRANSLATE_EXCEPTIONS("Could not get variable %s", key);
}
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()
{
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);
}
