XBT_EXPORT_NO_IMPORT(xbt_cfg_t) simgrid_config = NULL;
+/** @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 {
static inline
}
+static const char *xbt_cfgelm_type_name[xbt_cfgelm_type_count] = {
+ "int", "double", "string", "boolean", "any"
+};
+
+/** Boolean possible values **/
+struct xbt_boolean_couple {
+ const char *true_val;
+ const char *false_val;
+};
+
+const struct xbt_boolean_couple xbt_cfgelm_boolean_values[] = {
+ { "yes", "no"},
+ { "on", "off"},
+ {"true", "false"},
+ { "1", "0"},
+ { NULL, NULL}
+};
+
+namespace simgrid {
+namespace config {
+ struct ConfigurationElement ;
+ class Config;
+}
+}
+
+/* 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);
+
namespace simgrid {
namespace config {
case xbt_cfgelm_boolean:
break;
case xbt_cfgelm_string:
- case xbt_cfgelm_alias:
free(string_content);
break;
default:
};
-struct Config {
+class Config {
+ // name -> ConfigElement:
xbt_dict_t options;
+ // alias -> xbt_dict_elm_t from options:
+ xbt_dict_t aliases;
+public:
Config();
~Config();
// No copy:
Config(Config const&) = delete;
Config& operator=(Config const&) = delete;
+
+ xbt_dictelm_t getElement(const char* name);
+ ConfigurationElement* operator[](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);
+
+ // Debug:
+ void dump(const char *name, const char *indent);
+ void showAliases();
+ void help();
};
/* Internal stuff used in cache to free a variable */
}
Config::Config() :
- options(xbt_dict_new_homogeneous(xbt_cfgelm_free))
+ options(xbt_dict_new_homogeneous(xbt_cfgelm_free)),
+ aliases(xbt_dict_new_homogeneous(NULL))
{}
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;
}
-}
-
-static const char *xbt_cfgelm_type_name[xbt_cfgelm_type_count] = { "int", "double", "string", "boolean", "any", "outofbound" };
-const struct xbt_boolean_couple xbt_cfgelm_boolean_values[] = {
- { "yes", "no"},
- { "on", "off"},
- {"true", "false"},
- { "1", "0"},
- { NULL, NULL}
-};
-
-/* 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);
-
-/*----[ Memory management ]-----------------------------------------------*/
-/** @brief Constructor
- *
- * Initialise a config set
- */
-xbt_cfg_t xbt_cfg_new(void)
+inline
+ConfigurationElement* Config::operator[](const char* name)
{
- return new simgrid::config::Config();
+ xbt_dictelm_t elm = getElement(name);
+ if (elm)
+ return (ConfigurationElement*) elm->content;
+ else
+ return nullptr;
}
-/** @brief Destructor */
-void xbt_cfg_free(xbt_cfg_t * cfg)
+void Config::alias(const char* realname, const char* aliasname)
{
- delete *cfg;
+ xbt_assert(this->getElement(aliasname) == nullptr, "Alias '%s' already.", aliasname);
+ xbt_dictelm_t element = this->getElement(realname);
+ xbt_assert(element, "Cannot define an alias to the non-existing option '%s'.", realname);
+ xbt_dict_set(this->aliases, aliasname, element, NULL);
}
/** @brief Dump a config set for debuging purpose
*
* @param name The name to give to this config set
* @param indent what to write at the beginning of each line (right number of spaces)
- * @param cfg the config set
*/
-void xbt_cfg_dump(const char *name, const char *indent, xbt_cfg_t cfg)
+void Config::dump(const char *name, const char *indent)
{
- xbt_dict_t dict = cfg->options;
+ xbt_dict_t dict = this->options;
xbt_dict_cursor_t cursor = NULL;
simgrid::config::ConfigurationElement* variable = NULL;
char *key = NULL;
printf("%s %s: ()%s) %s", indent, key, type_name,
variable->boolean_content ? "true" : "false");
break;
- case xbt_cfgelm_alias:
- /* no content */
- break;
default:
printf("%s Invalid type!!\n", indent);
break;
xbt_dict_cursor_free(&cursor);
}
-/*----[ 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)
+simgrid::config::ConfigurationElement* Config::registerOption(
+ 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();
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((*cfg)->options, name);
+ 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, *cfg);
+ name, desc, xbt_cfgelm_type_name[type], (int)type, res, this);
res->type = type;
res->cb_set = cb_set;
if (desc)
break;
}
- xbt_dict_set((*cfg)->options, name, res, NULL);
+ xbt_dict_set(this->options, name, res, NULL);
return res;
}
-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);
-}
-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);
-}
-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);
-}
-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);
-}
-
-void xbt_cfg_register_alias(const char *newname, const char *oldname)
-{
- if (simgrid_config == NULL)
- simgrid_config = xbt_cfg_new();
-
- simgrid::config::ConfigurationElement* res = (simgrid::config::ConfigurationElement*) xbt_dict_get_or_null(simgrid_config->options, oldname);
- xbt_assert(NULL == res, "Refusing to register the option '%s' twice.", oldname);
-
- res = (simgrid::config::ConfigurationElement*) xbt_dict_get_or_null(simgrid_config->options, newname);
- xbt_assert(res, "Cannot define an alias to the non-existing option '%s'.", newname);
-
- res = new simgrid::config::ConfigurationElement();
- XBT_DEBUG("Register cfg alias %s -> %s)",oldname,newname);
-
- res->desc = std::string("Deprecated alias for ")+std::string(newname);
- res->type = xbt_cfgelm_alias;
- res->string_content = xbt_strdup(newname);
-
- xbt_dict_set(simgrid_config->options, oldname, res, NULL);
-}
-
-/**
- * @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 */
-}
-
/** @brief Displays the declared aliases and their description */
-void xbt_cfg_aliases(void)
+void Config::showAliases()
{
xbt_dict_cursor_t dict_cursor;
unsigned int dynar_cursor;
- simgrid::config::ConfigurationElement* variable;
+ xbt_dictelm_t dictel;
char *name;
xbt_dynar_t names = xbt_dynar_new(sizeof(char *), NULL);
- xbt_dict_foreach(simgrid_config->options, dict_cursor, name, variable)
+ 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) {
- variable = (simgrid::config::ConfigurationElement*) xbt_dict_get(simgrid_config->options, name);
-
- if (variable->type == xbt_cfgelm_alias)
+ simgrid::config::ConfigurationElement* variable = (*this)[name];
+ if (variable)
printf(" %s: %s\n", name, variable->desc.c_str());
}
}
/** @brief Displays the declared options and their description */
-void xbt_cfg_help(void)
+void Config::help()
{
xbt_dict_cursor_t dict_cursor;
unsigned int dynar_cursor;
char *name;
xbt_dynar_t names = xbt_dynar_new(sizeof(char *), NULL);
- xbt_dict_foreach(simgrid_config->options, dict_cursor, name, variable)
+ xbt_dict_foreach(this->options, dict_cursor, name, variable)
xbt_dynar_push(names, &name);
xbt_dynar_sort_strings(names);
xbt_dynar_foreach(names, dynar_cursor, name) {
- variable = (simgrid::config::ConfigurationElement*) xbt_dict_get(simgrid_config->options, name);
- if (variable->type == xbt_cfgelm_alias)
- continue;
+ variable = (simgrid::config::ConfigurationElement*) xbt_dict_get(this->options, name);
printf(" %s: %s\n", name, variable->desc.c_str());
printf(" Type: %s; ", xbt_cfgelm_type_name[variable->type]);
xbt_dynar_free(&names);
}
-static simgrid::config::ConfigurationElement* xbt_cfgelm_get(xbt_cfg_t cfg, const char *name, e_xbt_cfgelm_type_t type)
-{
- simgrid::config::ConfigurationElement* res = (simgrid::config::ConfigurationElement*) xbt_dict_get_or_null(cfg->options, name);
+}
+}
- // The user used the old name. Switch to the new one after a short warning
- while (res && res->type == xbt_cfgelm_alias) {
- const char* newname = res->string_content;
- XBT_INFO("Option %s has been renamed to %s. Consider switching.", name, newname);
- res = xbt_cfgelm_get(cfg, newname, type);
- }
+// C bindings:
- if (!res) {
- xbt_cfg_help();
- fflush(stdout);
- THROWF(not_found_error, 0, "No registered variable '%s' in this config set.", name);
- }
+/** @brief Constructor */
+xbt_cfg_t xbt_cfg_new(void) { return new simgrid::config::Config(); }
+/** @brief Destructor */
+void xbt_cfg_free(xbt_cfg_t * cfg) { delete *cfg; }
- 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_dump(const char *name, const char *indent, xbt_cfg_t cfg)
+{
+ cfg->dump(name, indent);
}
-/** @brief Get the type of this variable in that configuration set
- *
- * @param cfg the config set
- * @param name the name of the element
+/*----[ Registering stuff ]-----------------------------------------------*/
+/** @brief Register an element within a config set
*
- * @return the type of the given element
+ * @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
*/
-e_xbt_cfgelm_type_t xbt_cfg_get_type(xbt_cfg_t cfg, const char *name)
+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)
{
- simgrid::config::ConfigurationElement* variable = NULL;
+ if (*cfg == NULL)
+ *cfg = xbt_cfg_new();
+ return (*cfg)->registerOption(name, desc, type, cb_set);
+}
- variable = (simgrid::config::ConfigurationElement*) xbt_dict_get_or_null(cfg->options, name);
- if (!variable)
- THROWF(not_found_error, 0, "Can't get the type of '%s' since this variable does not exist", name);
+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);
+}
+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);
+}
+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);
+}
+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);
+}
- XBT_DEBUG("type in variable = %d", (int)variable->type);
- return variable->type;
+void xbt_cfg_register_alias(const char *realname, const char *aliasname)
+{
+ if (simgrid_config == NULL)
+ simgrid_config = xbt_cfg_new();
+ simgrid_config->alias(realname, aliasname);
}
-/*----[ Setting ]---------------------------------------------------------*/
-/** @brief va_args version of xbt_cfg_set
+/**
+ * @brief Parse a string and register the stuff described.
*
- * @param cfg config set to fill
- * @param name variable name
- * @param pa variable value
+ * @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'.
*
- * Add some values to the config set.
+ * Note that this does not allow to set the description, so you should prefer the other interface
*/
-void xbt_cfg_set_vargs(xbt_cfg_t cfg, const char *name, va_list pa)
+void xbt_cfg_register_str(xbt_cfg_t * cfg, const char *entry)
{
- char *str;
- int i;
- double d;
- e_xbt_cfgelm_type_t type = xbt_cfgelm_type_count; /* Set a dummy value to make gcc happy. It cannot get uninitialized */
+ char *entrycpy = xbt_strdup(entry);
+ char *tok;
- xbt_ex_t e;
+ e_xbt_cfgelm_type_t type;
+ XBT_DEBUG("Register string '%s'", entry);
- TRY {
- type = xbt_cfg_get_type(cfg, name);
- }
- CATCH(e) {
- if (e.category == not_found_error) {
- xbt_ex_free(e);
- THROWF(not_found_error, 0, "Can't set the property '%s' since it's not registered", name);
- }
- RETHROW;
- }
+ tok = strchr(entrycpy, ':');
+ xbt_assert(tok, "Invalid config element descriptor: %s; Should be <name>:<type>", entry);
+ *(tok++) = '\0';
- switch (type) {
- case xbt_cfgelm_string:
- str = va_arg(pa, char *);
- xbt_cfg_set_string(name, str);
- break;
- case xbt_cfgelm_int:
- i = va_arg(pa, int);
- xbt_cfg_set_int(name, i);
- break;
- case xbt_cfgelm_double:
- d = va_arg(pa, double);
- xbt_cfg_set_double(name, d);
- break;
- case xbt_cfgelm_boolean:
- str = va_arg(pa, char *);
- xbt_cfg_set_boolean(name, str);
- break;
- default:
- xbt_die("Config element variable %s not valid (type=%d)", name, (int)type);
- }
+ 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 */
}
-/** @brief Add a NULL-terminated list of pairs {(char*)key, value} to the set
- *
- * @param cfg config set to fill
- * @param name variable name
- * @param ... variable value
- */
-void xbt_cfg_set(xbt_cfg_t cfg, const char *name, ...)
+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)
{
- va_list pa;
+ simgrid::config::ConfigurationElement* res = (*cfg)[name];
- va_start(pa, name);
- xbt_cfg_set_vargs(cfg, name, pa);
- va_end(pa);
+ 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;
}
+/*----[ 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 ','
* @return the first char after the parsed value in val
*/
-void *xbt_cfg_set_as_string(const char *key, const char *value) {
- xbt_ex_t e;
+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;
- volatile simgrid::config::ConfigurationElement* variable = NULL;
int i;
double d;
- TRY {
- while (variable == NULL) {
- variable = (simgrid::config::ConfigurationElement*) xbt_dict_get(simgrid_config->options, key);
- if (variable->type == xbt_cfgelm_alias) {
- const char *newname = variable->string_content;
- XBT_INFO("Note: configuration '%s' is deprecated. Please use '%s' instead.", key, newname);
- key = newname;
- variable = NULL;
- }
- }
- } CATCH(e) {
- if (e.category == not_found_error) {
- xbt_ex_free(e);
- THROWF(not_found_error, 0, "No registered variable corresponding to '%s'.", key);
- }
- RETHROW;
- }
-
switch (variable->type) {
case xbt_cfgelm_string:
xbt_cfg_set_string(key, value); /* throws */
