/* This is useful to build named structs, like option or property sets. */
-/* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
+/* Copyright (c) 2004-2013. The SimGrid Team.
* All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
/** \brief Copy an existing configuration set
*
- * \arg whereto the config set to be created
- * \arg tocopy the source data
+ * @param whereto the config set to be created
+ * @param tocopy the source data
*
* This only copy the registrations, not the actual content
*/
xbt_assert(tocopy, "cannot copy NULL config");
xbt_dict_foreach((xbt_dict_t) tocopy, cursor, name, variable) {
- xbt_cfg_register(whereto, name, variable->desc, variable->type, NULL,
+ xbt_cfg_register(whereto, name, variable->desc, variable->type,
variable->min, variable->max, variable->cb_set,
variable->cb_rm);
}
/** @brief Dump a config set for debuging purpose
*
- * \arg name The name to give to this config set
- * \arg indent what to write at the begining of each line (right number of spaces)
- * \arg cfg the config set
+ * @param name The name to give to this config set
+ * @param indent what to write at the begining 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)
{
/** @brief Register an element within a config set
*
- * @arg cfg the config set
- * @arg type the type of the config element
- * @arg min the minimum
- * @arg max the maximum
+ * @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 min the minimum number of values for this config element
+ * @param max the maximum number of values for this config element
+ * @param cb_set callback function called when a value is set
+ * @param cb_rm callback function called when a value is removed
*/
void
xbt_cfg_register(xbt_cfg_t * cfg,
const char *name, const char *desc,
- e_xbt_cfgelm_type_t type, void *default_value, int min,
+ e_xbt_cfgelm_type_t type, int min,
int max, xbt_cfg_cb_t cb_set, xbt_cfg_cb_t cb_rm)
{
xbt_cfgelm_t res;
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_boolean:
res->content = xbt_dynar_new(sizeof(int), NULL);
- 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:
/** @brief Unregister an element from a config set.
*
- * @arg cfg the config set
- * @arg name the name of the elem to be freed
+ * @param cfg the config set
+ * @param name the name of the elem to be freed
*
* Note that it removes both the description and the actual content.
* Throws not_found when no such element exists.
/**
* @brief Parse a string and register the stuff described.
*
- * @arg cfg the config set
- * @arg entry a string describing the element to register
+ * @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\>:\<min nb\>_to_\<max nb\>_\<type\>
"Invalid type in config element descriptor: %s%s", entry,
"; Should be one of 'string', 'int', 'peer' or 'double'.");
- xbt_cfg_register(cfg, entrycpy, NULL, type, NULL, min, max, NULL, NULL);
+ xbt_cfg_register(cfg, entrycpy, NULL, type, min, max, NULL, NULL);
free(entrycpy); /* strdup'ed by dict mechanism, but cannot be const */
}
printf("'%s'%s", xbt_dynar_get_as(variable->content, i, char *), sep);
break;
- case xbt_cfgelm_boolean:
- printf("'%d'%s", xbt_dynar_get_as(variable->content, i, int), sep);
+ case xbt_cfgelm_boolean: {
+ int b = xbt_dynar_get_as(variable->content, i, int);
+ const char *bs = b ? xbt_cfgelm_boolean_values[0].true_val
+ : xbt_cfgelm_boolean_values[0].false_val;
+ if (b == 0 || b == 1)
+ printf("'%s'%s", bs, sep);
+ else
+ printf("'%s/%d'%s", bs, b, sep);
break;
+ }
case xbt_cfgelm_peer: {
xbt_peer_t hval = xbt_dynar_get_as(variable->content, i, xbt_peer_t);
/** @brief Get the type of this variable in that configuration set
*
- * \arg cfg the config set
- * \arg name the name of the element
- * \arg type the result
+ * @param cfg the config set
+ * @param name the name of the element
*
+ * @return the type of the given element
*/
e_xbt_cfgelm_type_t xbt_cfg_get_type(xbt_cfg_t cfg, const char *name)
/*----[ Setting ]---------------------------------------------------------*/
/** @brief va_args version of xbt_cfg_set
*
- * \arg cfg config set to fill
- * \arg n variable name
- * \arg pa variable value
+ * @param cfg config set to fill
+ * @param name variable name
+ * @param pa variable value
*
* Add some values to the config set.
*/
/** @brief Add a NULL-terminated list of pairs {(char*)key, value} to the set
*
- * \arg cfg config set to fill
- * \arg name variable name
- * \arg varargs variable value
+ * @param cfg config set to fill
+ * @param name variable name
+ * @param ... variable value
*
*/
void xbt_cfg_set(xbt_cfg_t cfg, const char *name, ...)
/** @brief Add values parsed from a string into a config set
*
- * \arg cfg config set to fill
- * \arg options a string containing the content to add to the config set. This
+ * @param cfg config set to fill
+ * @param options a string containing the content to add to the config set. This
* is a '\\t',' ' or '\\n' or ',' separated list of variables. Each individual variable is
* like "[name]:[value]" where [name] is the name of an already registred
* variable, and [value] conforms to the data type under which this variable was
val = strchr(name, ':');
if (!val) {
- free(optionlist_cpy);
+ /* don't free(optionlist_cpy) here, 'name' points inside it */
xbt_die("Option '%s' badly formated. Should be of the form 'name:value'",
name);
}
/** @brief Set the value of a variable, using the string representation of that value
*
- * @arg cfg config set to modify
- * @arg key name of the variable to modify
- * @arg value string representation of the value to set
+ * @param cfg config set to modify
+ * @param key name of the variable to modify
+ * @param value string representation of the value to set
*
* @return the first char after the parsed value in val
*/
/** @brief Set or add an integer value to \a name within \a cfg
*
- * \arg cfg the config set
- * \arg name the name of the variable
- * \arg val the value of the variable
+ * @param cfg the config set
+ * @param name the name of the variable
+ * @param val the value of the variable
*/
void xbt_cfg_set_int(xbt_cfg_t cfg, const char *name, int val)
{
/** @brief Set or add a double value to \a name within \a cfg
*
- * \arg cfg the config set
- * \arg name the name of the variable
- * \arg val the doule to set
+ * @param cfg the config set
+ * @param name the name of the variable
+ * @param val the doule to set
*/
void xbt_cfg_set_double(xbt_cfg_t cfg, const char *name, double val)
/** @brief Set or add a string value to \a name within \a cfg
*
- * \arg cfg the config set
- * \arg name the name of the variable
- * \arg val the value to be added
+ * @param cfg the config set
+ * @param name the name of the variable
+ * @param val the value to be added
*
*/
/** @brief Set or add a boolean value to \a name within \a cfg
*
- * \arg cfg the config set
- * \arg name the name of the variable
- * \arg val the value of the variable
+ * @param cfg the config set
+ * @param name the name of the variable
+ * @param val the value of the variable
*/
void xbt_cfg_set_boolean(xbt_cfg_t cfg, const char *name, const char *val)
{
/** @brief Set or add an peer value to \a name within \a cfg
*
- * \arg cfg the config set
- * \arg name the name of the variable
- * \arg peer the peer
- * \arg port the port number
+ * @param cfg the config set
+ * @param name the name of the variable
+ * @param peer the peer
+ * @param port the port number
*
* \e peer values are composed of a string (peername) and an integer (port)
*/
/** @brief Remove the provided \e val integer value from a variable
*
- * \arg cfg the config set
- * \arg name the name of the variable
- * \arg val the value to be removed
+ * @param cfg the config set
+ * @param name the name of the variable
+ * @param val the value to be removed
*/
void xbt_cfg_rm_int(xbt_cfg_t cfg, const char *name, int val)
{
/** @brief Remove the provided \e val double value from a variable
*
- * \arg cfg the config set
- * \arg name the name of the variable
- * \arg val the value to be removed
+ * @param cfg the config set
+ * @param name the name of the variable
+ * @param val the value to be removed
*/
void xbt_cfg_rm_double(xbt_cfg_t cfg, const char *name, double val)
/** @brief Remove the provided \e val string value from a variable
*
- * \arg cfg the config set
- * \arg name the name of the variable
- * \arg val the value of the string which will be removed
+ * @param cfg the config set
+ * @param name the name of the variable
+ * @param val the value of the string which will be removed
*/
void xbt_cfg_rm_string(xbt_cfg_t cfg, const char *name, const char *val)
{
/** @brief Remove the provided \e val boolean value from a variable
*
- * \arg cfg the config set
- * \arg name the name of the variable
- * \arg val the value to be removed
+ * @param cfg the config set
+ * @param name the name of the variable
+ * @param val the value to be removed
*/
void xbt_cfg_rm_boolean(xbt_cfg_t cfg, const char *name, int val)
{
/** @brief Remove the provided \e val peer value from a variable
*
- * \arg cfg the config set
- * \arg name the name of the variable
- * \arg peer the peername
- * \arg port the port number
+ * @param cfg the config set
+ * @param name the name of the variable
+ * @param peer the peername
+ * @param port the port number
*/
void
/** @brief Remove all the values from a variable
*
- * \arg cfg the config set
- * \arg name the name of the variable
+ * @param cfg the config set
+ * @param name the name of the variable
*/
void xbt_cfg_empty(xbt_cfg_t cfg, const char *name)
/** @brief Retrieve an integer value of a variable (get a warning if not uniq)
*
- * \arg cfg the config set
- * \arg name the name of the variable
- * \arg val the wanted value
+ * @param cfg the config set
+ * @param name 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. Consider using
/** @brief Retrieve a double value of a variable (get a warning if not uniq)
*
- * \arg cfg the config set
- * \arg name the name of the variable
- * \arg val the wanted value
+ * @param cfg the config set
+ * @param name 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. Consider using
/** @brief Retrieve a string value of a variable (get a warning if not uniq)
*
- * \arg th the config set
- * \arg name the name of the variable
- * \arg val the wanted value
+ * @param cfg the config set
+ * @param name 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. Consider using
/** @brief Retrieve a boolean value of a variable (get a warning if not uniq)
*
- * \arg cfg the config set
- * \arg name the name of the variable
- * \arg val the wanted value
+ * @param cfg the config set
+ * @param name 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. Consider using
/** @brief Retrieve an peer value of a variable (get a warning if not uniq)
*
- * \arg cfg the config set
- * \arg name the name of the variable
- * \arg peer the peer
- * \arg port the port number
+ * @param cfg the config set
+ * @param name the name of the variable
+ * @param peer the peer
+ * @param port the port number
*
* 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
/** @brief Retrieve the dynar of all the values stored in a variable
*
- * \arg cfg where to search in
- * \arg name what to search for
- * \arg dynar result
+ * @param cfg where to search in
+ * @param name what to search for
*
* Get the data stored in the config set.
*
