X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/531a3f117d88940a49a6f2b6406bdcc55223f5f4..3297da9f47ce18371941b2b48a2f4018b4793ced:/include/xbt/config.h diff --git a/include/xbt/config.h b/include/xbt/config.h index 6c4219acf0..81389f4149 100644 --- a/include/xbt/config.h +++ b/include/xbt/config.h @@ -18,8 +18,8 @@ * 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. * - * 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 @@ -27,17 +27,17 @@ * * 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 + * @verbatim :_to__@endverbatim * - * For example, size:1_to_1_int describes a variable called \e size which must take exactly one value, and + * 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 + * 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 + * @section XBT_cfg_ex Example of use * * TBD */ @@ -55,11 +55,7 @@ */ /** @brief Configuration set's data type is opaque. */ #ifdef __cplusplus -namespace simgrid { -namespace config { -class Config; -} -} +#include typedef simgrid::config::Config* xbt_cfg_t; #else typedef void* xbt_cfg_t; @@ -67,26 +63,37 @@ typedef void* xbt_cfg_t; SG_BEGIN_DECL() -XBT_PUBLIC void xbt_cfg_set_parse(const char* options); - -/* Set the value of the cell \a name in \a cfg with the provided value.*/ -XBT_PUBLIC void xbt_cfg_set_int(const char* name, int val); -XBT_PUBLIC void xbt_cfg_set_double(const char* name, double val); -XBT_PUBLIC void xbt_cfg_set_boolean(const char* name, const char* val); -XBT_PUBLIC void xbt_cfg_set_string(const char* name, const char* val); -XBT_PUBLIC void xbt_cfg_set_as_string(const char* name, const char* val); +XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::set_parse") XBT_PUBLIC + void xbt_cfg_set_parse(const char* options); + +/* Set the value of the cell @a name in @a cfg with the provided value.*/ +XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::set_value") XBT_PUBLIC + void xbt_cfg_set_int(const char* name, int val); +XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::set_value") XBT_PUBLIC + void xbt_cfg_set_double(const char* name, double val); +XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::set_value") XBT_PUBLIC + void xbt_cfg_set_boolean(const char* name, const char* val); +XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::set_value") XBT_PUBLIC + void xbt_cfg_set_string(const char* name, const char* val); +XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::set_as_string") XBT_PUBLIC + void xbt_cfg_set_as_string(const char* name, const char* val); /* - Set the default value of the cell \a name in \a cfg with the provided value. + Set the default value of the cell @a name in @a cfg with the provided value. If it was already set to something (possibly from the command line), do nothing. */ -XBT_PUBLIC void xbt_cfg_setdefault_int(const char* name, int val); -XBT_PUBLIC void xbt_cfg_setdefault_double(const char* name, double val); -XBT_PUBLIC void xbt_cfg_setdefault_string(const char* name, const char* val); -XBT_PUBLIC void xbt_cfg_setdefault_boolean(const char* name, const char* val); +XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::set_default") XBT_PUBLIC + void xbt_cfg_setdefault_int(const char* name, int val); +XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::set_default") XBT_PUBLIC + void xbt_cfg_setdefault_double(const char* name, double val); +XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::set_default") XBT_PUBLIC + void xbt_cfg_setdefault_boolean(const char* name, const char* val); +XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::set_default") XBT_PUBLIC + void xbt_cfg_setdefault_string(const char* name, const char* val); /** @brief Return if configuration is set by default*/ -XBT_PUBLIC int xbt_cfg_is_default_value(const char* name); +XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::is_default") XBT_PUBLIC + int xbt_cfg_is_default_value(const char* name); /* @} */ @@ -96,12 +103,13 @@ XBT_PUBLIC int xbt_cfg_is_default_value(const char* name); * @{ */ -/** \brief Callback types. They get the name of the modified entry, and the position of the changed value */ +/** @brief Callback types. They get the name of the modified entry, and the position of the changed value */ typedef void (*xbt_cfg_cb_t)(const char* name); -XBT_PUBLIC xbt_cfg_t xbt_cfg_new(); -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); +XBT_ATTRIB_DEPRECATED_v323("Please don't use it") XBT_PUBLIC xbt_cfg_t xbt_cfg_new(); +XBT_ATTRIB_DEPRECATED_v323("Please don't use it") XBT_PUBLIC void xbt_cfg_free(xbt_cfg_t* cfg); +XBT_ATTRIB_DEPRECATED_v323("Please don't use it") XBT_PUBLIC + void xbt_cfg_dump(const char* name, const char* indent, xbt_cfg_t cfg); /** @} */ @@ -123,8 +131,8 @@ XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::declare_flag") XBT XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::alias") XBT_PUBLIC void xbt_cfg_register_alias(const char* newname, const char* oldname); -XBT_PUBLIC void xbt_cfg_aliases(); -XBT_PUBLIC void xbt_cfg_help(); +XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::show_aliases") XBT_PUBLIC void xbt_cfg_aliases(); +XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::help") XBT_PUBLIC void xbt_cfg_help(); /* @} */ /** @defgroup XBT_cfg_get Getting the stored values @@ -140,11 +148,11 @@ XBT_PUBLIC void xbt_cfg_help(); * @{ */ -XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::get_config") XBT_PUBLIC +XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::get_value") XBT_PUBLIC int xbt_cfg_get_int(const char* name); -XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::get_config") XBT_PUBLIC +XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::get_value") XBT_PUBLIC double xbt_cfg_get_double(const char* name); -XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::get_config") XBT_PUBLIC +XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::get_value") XBT_PUBLIC int xbt_cfg_get_boolean(const char* name); /** @} */