-/* $Id$ */
-
/* config - Dictionnary where the type of each variable is provided. */
/* This is useful to build named structs, like option or property sets. */
-/* Copyright (c) 2001,2002,2003,2004 Martin Quinson. All rights reserved. */
+/* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. 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. */
defend my thesis. */
typedef struct {
+ /* Description */
+ char *desc;
+
/* Allowed type of the variable */
e_xbt_cfgelm_type_t type;
int min, max;
+ int isdefault:1;
/* Callbacks */
xbt_cfg_cb_t cb_set;
xbt_assert0(tocopy, "cannot copy NULL config");
xbt_dict_foreach((xbt_dict_t) tocopy, cursor, name, variable) {
- xbt_cfg_register(*whereto, name, variable->type, variable->min,
- variable->max, variable->cb_set, variable->cb_rm);
+ xbt_cfg_register(whereto, name, variable->desc, variable->type, NULL,
+ variable->min, variable->max, variable->cb_set,
+ variable->cb_rm);
}
}
DEBUG1("Frees cfgelm %p", c);
if (!c)
return;
+ xbt_free(c->desc);
xbt_dynar_free(&(c->content));
free(c);
}
*/
void
-xbt_cfg_register(xbt_cfg_t cfg,
- const char *name, e_xbt_cfgelm_type_t type,
- int min, int max, xbt_cfg_cb_t cb_set, xbt_cfg_cb_t cb_rm)
+xbt_cfg_register(xbt_cfg_t * cfg,
+ const char *name, const char *desc, e_xbt_cfgelm_type_t type,
+ void *default_value, int min, int max, xbt_cfg_cb_t cb_set,
+ xbt_cfg_cb_t cb_rm)
{
xbt_cfgelm_t res;
- xbt_assert(cfg);
+ if (*cfg == NULL)
+ *cfg = xbt_cfg_new();
xbt_assert4(type >= xbt_cfgelm_int && type <= xbt_cfgelm_peer,
"type of %s not valid (%d should be between %d and %d)",
name, type, xbt_cfgelm_int, xbt_cfgelm_peer);
- res = xbt_dict_get_or_null((xbt_dict_t) cfg, name);
+ res = xbt_dict_get_or_null((xbt_dict_t) * cfg, name);
if (res) {
WARN1("Config elem %s registered twice.", name);
}
res = xbt_new(s_xbt_cfgelm_t, 1);
- DEBUG7("Register cfg elm %s (%d to %d %s (=%d) @%p in set %p)",
- name, min, max, xbt_cfgelm_type_name[type], type, res, cfg);
+ DEBUG8("Register cfg elm %s (%s) (%d to %d %s (=%d) @%p in set %p)",
+ name, desc, min, max, xbt_cfgelm_type_name[type], type, res, *cfg);
+ res->desc = xbt_strdup(desc);
res->type = type;
res->min = min;
res->max = max;
res->cb_set = cb_set;
res->cb_rm = cb_rm;
+ res->isdefault = 1;
switch (type) {
case xbt_cfgelm_int:
res->content = xbt_dynar_new(sizeof(int), NULL);
+ if (default_value)
+ xbt_dynar_push(res->content, default_value);
break;
case xbt_cfgelm_double:
res->content = xbt_dynar_new(sizeof(double), NULL);
+ if (default_value)
+ xbt_dynar_push(res->content, default_value);
break;
case xbt_cfgelm_string:
res->content = xbt_dynar_new(sizeof(char *), xbt_free_ref);
+ if (default_value)
+ xbt_dynar_push(res->content, default_value);
break;
case xbt_cfgelm_peer:
res->content = xbt_dynar_new(sizeof(xbt_peer_t), xbt_peer_free_voidp);
+ if (default_value)
+ xbt_dynar_push(res->content, default_value);
break;
default:
ERROR1("%d is an invalide type code", type);
}
- xbt_dict_set((xbt_dict_t) cfg, name, res, &xbt_cfgelm_free);
+ xbt_dict_set((xbt_dict_t) * cfg, name, res, &xbt_cfgelm_free);
}
/** @brief Unregister an element from a config set.
* The string may consist in several variable descriptions separated by a space.
* Each of them must use the following syntax: \<name\>:\<min nb\>_to_\<max nb\>_\<type\>
* with type being one of 'string','int', 'peer' or 'double'.
+ *
+ * @fixme: this does not allow to set the description
*/
-void xbt_cfg_register_str(xbt_cfg_t cfg, const char *entry)
+void xbt_cfg_register_str(xbt_cfg_t * cfg, const char *entry)
{
char *entrycpy = xbt_strdup(entry);
char *tok;
"Invalid type in config element descriptor: %s%s", entry,
"; Should be one of 'string', 'int', 'peer' or 'double'.");
- xbt_cfg_register(cfg, entrycpy, type, min, max, NULL, NULL);
+ xbt_cfg_register(cfg, entrycpy, NULL, type, NULL, min, max, NULL, NULL);
free(entrycpy); /* strdup'ed by dict mechanism, but cannot be const */
}
-/** @brief Check that each variable have the right amount of values */
+/** @brief Displays the declared options and their description */
+void xbt_cfg_help(xbt_cfg_t cfg)
+{
+ xbt_dict_cursor_t cursor;
+ xbt_cfgelm_t variable;
+ char *name;
+
+ int i;
+ int size;
+
+ xbt_dict_foreach((xbt_dict_t) cfg, cursor, name, variable) {
+ printf(" %s: %s\n", name, variable->desc);
+ printf(" Type: %s; ", xbt_cfgelm_type_name[variable->type]);
+ if (variable->min != 1 || variable->max != 1) {
+ if (variable->min == 0 && variable->max == 0)
+ printf("Arity: no bound; ");
+ else
+ printf("Arity: min:%d to max:%d; ", variable->min, variable->max);
+ }
+ printf("Current value: ");
+ size = xbt_dynar_length(variable->content);
+
+ switch (variable->type) {
+ int ival;
+ char *sval;
+ double dval;
+ xbt_peer_t hval;
+
+ case xbt_cfgelm_int:
+ for (i = 0; i < size; i++) {
+ ival = xbt_dynar_get_as(variable->content, i, int);
+ printf("%s%d\n", (i == 0 ? "" : " "), ival);
+ }
+ break;
+
+ case xbt_cfgelm_double:
+ for (i = 0; i < size; i++) {
+ dval = xbt_dynar_get_as(variable->content, i, double);
+ printf("%s%f\n", (i == 0 ? "" : " "), dval);
+ }
+ break;
+
+ case xbt_cfgelm_string:
+ for (i = 0; i < size; i++) {
+ sval = xbt_dynar_get_as(variable->content, i, char *);
+ printf("%s'%s'\n", (i == 0 ? "" : " "), sval);
+ }
+ break;
+ case xbt_cfgelm_peer:
+ for (i = 0; i < size; i++) {
+ hval = xbt_dynar_get_as(variable->content, i, xbt_peer_t);
+ printf("%s%s:%d\n", (i == 0 ? "" : " "), hval->name,
+ hval->port);
+ }
+ break;
+
+ default:
+ printf("Invalid type!!\n");
+ }
+
+ }
+}
+
+/** @brief Check that each variable have the right amount of values */
void xbt_cfg_check(xbt_cfg_t cfg)
{
xbt_dict_cursor_t cursor;
xbt_cfgelm_t res = NULL;
res = xbt_dict_get_or_null((xbt_dict_t) cfg, name);
- if (!res)
+ if (!res) {
+ xbt_cfg_help(cfg);
THROW1(not_found_error, 0,
"No registered variable '%s' in this config set", name);
+ }
xbt_assert3(type == xbt_cfgelm_any || res->type == type,
"You tried to access to the config element %s as an %s, but its type is %s.",
*
* \arg cfg config set to fill
* \arg options a string containing the content to add to the config set. This
- * is a '\\t',' ' or '\\n' separated list of variables. Each individual variable is
+ * 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 registred
* variable, and [value] conforms to the data type under which this variable was
* registred.
/* Pass the value */
while (option - name <= (len - 1) && *option != ' ' && *option != '\n'
- && *option != '\t') {
+ && *option != '\t' && *option != ',') {
DEBUG1("Take %c.", *option);
option++;
}
}
*(val++) = '\0';
- DEBUG2("name='%s';val='%s'", name, val);
+ INFO2("Configuration change: Set '%s' to '%s'", name, val);
TRY {
variable = xbt_dict_get((xbt_dict_t) cfg, name);
if (e.category == not_found_error) {
xbt_ex_free(e);
THROW1(not_found_error, 0,
- "No registrated variable corresponding to '%s'.", name);
+ "No registered variable corresponding to '%s'.", name);
}
RETHROW;
}
}
+/** @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(xbt_cfg_t cfg, const char *name, int val) {
+ xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_int);
+
+ if (variable->isdefault)
+ xbt_cfg_set_int(cfg, name,val);
+ else
+ DEBUG2("Do not override configuration variable '%s' with value '%d' because it was already set.",name,val);
+}
+/** @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(xbt_cfg_t cfg, const char *name, double val) {
+ xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_double);
+
+ if (variable->isdefault)
+ xbt_cfg_set_double(cfg, name, val);
+ else
+ DEBUG2("Do not override configuration variable '%s' with value '%lf' because it was already set.",name,val);
+}
+/** @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(xbt_cfg_t cfg, const char *name, const char* val) {
+ xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_string);
+
+ if (variable->isdefault)
+ xbt_cfg_set_string(cfg, name,val);
+ else
+ DEBUG2("Do not override configuration variable '%s' with value '%s' because it was already set.",name,val);
+}
+/** @brief Set a peer 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_peer(xbt_cfg_t cfg, const char *name, const char* host, int port) {
+ xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_peer);
+
+ if (variable->isdefault)
+ xbt_cfg_set_peer(cfg, name, host, port);
+ else
+ DEBUG3("Do not override configuration variable '%s' with value '%s:%d' because it was already set.",
+ name,host,port);
+}
+
/** @brief Set or add an integer value to \a name within \a cfg
*
* \arg cfg the config set
if (variable->cb_set)
(*variable->cb_set) (name, xbt_dynar_length(variable->content) - 1);
+ variable->isdefault = 0;
}
/** @brief Set or add a double value to \a name within \a cfg
if (variable->cb_set)
(*variable->cb_set) (name, xbt_dynar_length(variable->content) - 1);
+ variable->isdefault = 0;
}
/** @brief Set or add a string value to \a name within \a cfg
if (variable->cb_set)
(*variable->cb_set) (name, xbt_dynar_length(variable->content) - 1);
+ variable->isdefault = 0;
}
/** @brief Set or add an peer value to \a name within \a cfg
if (variable->cb_set)
(*variable->cb_set) (name, xbt_dynar_length(variable->content) - 1);
+ variable->isdefault = 0;
}
/* ---- [ Removing ] ---- */
*
* Returns the first value from the config set under the given name.
* If there is more than one value, it will issue a warning. Consider using
- * xbt_cfg_get_dynar() instead.
+ * xbt_cfg_get_dynar() instead. Returns NULL if there is no value.
*
* \warning the returned value is the actual content of the config set
*/
WARN2
("You asked for the first value of the config element '%s', but there is %lu values\n",
name, xbt_dynar_length(variable->content));
+ } else if (xbt_dynar_length(variable->content) == 0) {
+ return NULL;
}
return xbt_dynar_get_as(variable->content, 0, char *);
#include "xbt.h"
#include "xbt/ex.h"
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_cfg, xbt, "configuration support");
+
XBT_TEST_SUITE("config", "Configuration support");
static xbt_cfg_t make_set()
{
xbt_cfg_t set = NULL;
- set = xbt_cfg_new();
- xbt_cfg_register_str(set, "speed:1_to_2_int");
- xbt_cfg_register_str(set, "peername:1_to_1_string");
- xbt_cfg_register_str(set, "user:1_to_10_string");
+ xbt_log_threshold_set(&_XBT_LOGV(xbt_cfg), xbt_log_priority_critical);
+ xbt_cfg_register_str(&set, "speed:1_to_2_int");
+ xbt_cfg_register_str(&set, "peername:1_to_1_string");
+ xbt_cfg_register_str(&set, "user:1_to_10_string");
return set;
} /* end_of_make_set */