X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/4a6b0a991a67e6f2f67c03fed43529e078da7115..4667db33a753d88cbcd186f191fb1e65f49f4bd6:/include/xbt/config.h diff --git a/include/xbt/config.h b/include/xbt/config.h index 296aa3fbba..cfef4ffd59 100644 --- a/include/xbt/config.h +++ b/include/xbt/config.h @@ -20,31 +20,27 @@ SG_BEGIN_DECL() * @brief Changing the configuration of SimGrid components (grounding feature) * * All modules of the SimGrid toolkit can be configured with this API. - * User modules and libraries can also use these facilities to handle - * their own configuration. + * User modules and libraries can also use these facilities to handle their own configuration. * - * A configuration set contain several \e variables which have a unique name - * in the set and can take a given type of value. For example, it may - * contain a \a size variable, accepting \e int values. + * A configuration set contain several \e variables which have a unique name in the set and can take a given type of + * value. For example, it may contain a \a size variable, accepting \e int values. * * It is impossible to set a value to a variable which has not been registered before. - * Usually, the module registers all the options it accepts in the configuration set, - * during its initialization and user code then set and unset values. + * Usually, the module registers all the options it accepts in the configuration set, during its initialization and + * user code then set and unset values. * - * The easiest way to register a variable is to use the xbt_str_register_str function, - * which accepts a string representation of the config element descriptor. The syntax - * is the following: \verbatim :_to__\endverbatim + * The easiest way to register a variable is to use the xbt_str_register_str function, which accepts a string + * representation of the config element descriptor. The syntax is the following: + * \verbatim :_to__\endverbatim * - * For example, size:1_to_1_int describes a variable called \e size which - * must take exactly one value, and the value being an integer. Set the maximum to 0 to - * disable the upper bound on data count. + * For example, size:1_to_1_int describes a variable called \e size which must take exactly one value, and + * the value being an integer. Set the maximum to 0 to disable the upper bound on data count. * - * Another example could be outputfiles:0_to_10_string which describes a variable - * called \e outputfiles and which can take between 0 and 10 strings as value. + * Another example could be outputfiles:0_to_10_string which describes a variable called \e outputfiles and + * which can take between 0 and 10 strings as value. * * To some extend, configuration sets can be seen as typed hash structures. * - * * \section XBT_cfg_ex Example of use * * \dontinclude config.c @@ -65,24 +61,19 @@ SG_BEGIN_DECL() * \skip dyn * \until cfg_free * - * All those functions throws mismatch_error if asked to deal with an - * unregistered variable. + * All those functions throws mismatch_error if asked to deal with an unregistered variable. * \skip myset * \until cfg_free - * */ /** @defgroup XBT_cfg_use User interface: changing values * @ingroup XBT_config * - * This is the only interface you should use unless you want to let your - * own code become configurable with this. + * This is the only interface you should use unless you want to let your own code become configurable with this. * - * If the variable accept at most one value, those functions replace the - * current value with the provided one. If max>1, the provided value is - * appended to the list. + * If the variable accept at most one value, those functions replace the current value with the provided one. If max>1, + * the provided value is appended to the list. * - * string values are strdup'ed before use, so you can (and should) free - * your copy + * string values are strdup'ed before use, so you can (and should) free your copy * * @{ */ @@ -93,10 +84,7 @@ XBT_PUBLIC(void) xbt_cfg_set(xbt_cfg_t cfg, const char *name, ...); XBT_PUBLIC(void) xbt_cfg_set_vargs(xbt_cfg_t cfg, const char *name, va_list pa); XBT_PUBLIC(void) xbt_cfg_set_parse(xbt_cfg_t cfg, const char *options); - -/* - Set the value of the cell \a name in \a cfg with the provided value. - */ +/* Set the value of the cell \a name in \a cfg with the provided value.*/ XBT_PUBLIC(void) xbt_cfg_set_int(xbt_cfg_t cfg, const char *name, int val); XBT_PUBLIC(void) xbt_cfg_set_double(xbt_cfg_t cfg, const char *name, double val); XBT_PUBLIC(void) xbt_cfg_set_string(xbt_cfg_t cfg, const char *name, const char *val); @@ -137,13 +125,10 @@ XBT_PUBLIC(int) xbt_cfg_is_default_value(xbt_cfg_t cfg, const char *name); /** @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 */ + xbt_cfgelm_int = 0, /**< int */ + xbt_cfgelm_double, /**< double */ + xbt_cfgelm_string, /**< char* */ + xbt_cfgelm_boolean, /**< int */ xbt_cfgelm_alias, /**< redirection from a deprecated name to a better one */ //! @cond xbt_cfgelm_any, /* not shown to users to prevent errors */ @@ -152,7 +137,6 @@ typedef enum { } e_xbt_cfgelm_type_t; /** Boolean possible values **/ - struct xbt_boolean_couple { const char *true_val; const char *false_val; @@ -162,8 +146,7 @@ struct xbt_boolean_couple { typedef void (*xbt_cfg_cb_t) (const char *, int); XBT_PUBLIC(xbt_cfg_t) xbt_cfg_new(void); -XBT_PUBLIC(void) xbt_cfg_cpy(xbt_cfg_t tocopy, /* OUT */ - xbt_cfg_t * whereto); +XBT_PUBLIC(void) xbt_cfg_cpy(xbt_cfg_t tocopy, /* OUT */xbt_cfg_t * whereto); XBT_PUBLIC(void) xbt_cfg_free(xbt_cfg_t * cfg); XBT_PUBLIC(void) xbt_cfg_dump(const char *name, const char *indent, xbt_cfg_t cfg); @@ -172,8 +155,7 @@ XBT_PUBLIC(void) xbt_cfg_dump(const char *name, const char *indent, xbt_cfg_t cf /** @defgroup XBT_cfg_register Registering stuff * @ingroup XBT_config * - * This how to add new variables to an existing configuration set. Use it to make your code - * configurable. + * This how to add new variables to an existing configuration set. Use it to make your code configurable. * * @{ */ @@ -190,13 +172,12 @@ XBT_PUBLIC(e_xbt_cfgelm_type_t) xbt_cfg_get_type(xbt_cfg_t cfg, const char *name /** @defgroup XBT_cfg_get Getting the stored values * @ingroup XBT_config * - * This is how to retrieve the values stored in the configuration set. This is only - * intended to configurable code, naturally. + * This is how to retrieve the values stored in the configuration set. This is only intended to configurable code, + * naturally. * - * Note that those function return a pointer to the values actually stored - * in the set. Do not modify them unless you really know what you're doing. - * Likewise, do not free the strings after use, they are not copy of the data, - * but the data themselves. + * Note that those function return a pointer to the values actually stored in the set. Do not modify them unless you + * really know what you're doing. Likewise, do not free the strings after use, they are not copy of the data, but the + * data themselves. * * @{ */