X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/9786429920715b35e1f1275cf5ff50111d18b2c4..85897b1307bb68f05f31385803f1b3a5b806a73f:/include/xbt/config.h diff --git a/include/xbt/config.h b/include/xbt/config.h index fa317a41e4..27b927a744 100644 --- a/include/xbt/config.h +++ b/include/xbt/config.h @@ -14,10 +14,16 @@ #include "xbt/dynar.h" -BEGIN_DECL() +SG_BEGIN_DECL() /** @addtogroup XBT_config - * + * @brief Changing the configuration of SimGrid components (grounding feature) + * + *
Top [\ref index]::[\ref XBT_API] + *
Prev [\ref XBT_error] + *
Next [\ref XBT_dynar] + *
Down [\ref XBT_cfg_use]
+ * * 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. @@ -45,9 +51,10 @@ BEGIN_DECL() * * \todo This great mechanism is not used in SimGrid yet... * - * \section XBT_cfg_ex Example * - * \dontinclude config_usage.c + * \section XBT_cfg_ex Example of use + * + * \dontinclude config.c * * First, let's create a configuration set with some registered variables. * This must be done by the configurable library before the user interactions. @@ -69,40 +76,15 @@ BEGIN_DECL() * unregistered variable. * \skip myset * \until cfg_free - * @{ + * */ -/** @name 1. Type declaration and memory management - * - * +/** @defgroup XBT_cfg_use User interface: changing values + * @ingroup XBT_config * - * @{ - */ - /** @brief Configuration set are only special dynars. But don't rely on it, it may change. */ - typedef xbt_dynar_t xbt_cfg_t; - - /** @brief possible content of each configuration cell */ - typedef enum { - xbt_cfgelm_int=0, /**< int */ - xbt_cfgelm_double, /**< double */ - xbt_cfgelm_string, /**< char* */ - xbt_cfgelm_host, /**< both a char* (representing the hostname) and an integer (representing the port) */ - - xbt_cfgelm_any, /* not shown to users to prevent errors */ - xbt_cfgelm_type_count - } e_xbt_cfgelm_type_t; - - /** \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*, int); - - xbt_cfg_t xbt_cfg_new (void); - void xbt_cfg_cpy(xbt_cfg_t tocopy, /* OUT */ xbt_cfg_t *whereto); - void xbt_cfg_free(xbt_cfg_t *cfg); - void xbt_cfg_dump(const char *name,const char*indent,xbt_cfg_t cfg); - - /** @} */ - -/** @name 2. User interface: changing values + *
Top [\ref index]::[\ref XBT_API]::[\ref XBT_config] + *
Prev + *
Next [\ref XBT_cfg_decl]
* * This is the only interface you should use unless you want to let your * own code become configurable with this. @@ -117,6 +99,9 @@ BEGIN_DECL() * @{ */ + /** @brief Configuration set are only special dynars. But don't rely on it, it may change. */ + typedef xbt_dynar_t xbt_cfg_t; + void xbt_cfg_set(xbt_cfg_t cfg, const char *name, ...); void xbt_cfg_set_vargs(xbt_cfg_t cfg, const char *name, va_list pa); void xbt_cfg_set_parse(xbt_cfg_t cfg, const char *options); @@ -155,7 +140,44 @@ void xbt_cfg_rm_at (xbt_cfg_t cfg, const char *name, int pos); void xbt_cfg_empty(xbt_cfg_t cfg, const char *name); /* @} */ -/** @name 3. Registering stuff + +/** @defgroup XBT_cfg_decl Configuration type declaration and memory management + * @ingroup XBT_config + * + *
Top [\ref index]::[\ref XBT_API]::[\ref XBT_config] + *
Prev [\ref XBT_cfg_use] + *
Next [\ref XBT_cfg_register]
+ * + * @{ + */ + + /** @brief possible content of each configuration cell */ + typedef enum { + xbt_cfgelm_int=0, /**< int */ + xbt_cfgelm_double, /**< double */ + xbt_cfgelm_string, /**< char* */ + xbt_cfgelm_host, /**< both a char* (representing the hostname) and an integer (representing the port) */ + + xbt_cfgelm_any, /* not shown to users to prevent errors */ + xbt_cfgelm_type_count + } e_xbt_cfgelm_type_t; + + /** \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*, int); + + xbt_cfg_t xbt_cfg_new (void); + void xbt_cfg_cpy(xbt_cfg_t tocopy, /* OUT */ xbt_cfg_t *whereto); + void xbt_cfg_free(xbt_cfg_t *cfg); + void xbt_cfg_dump(const char *name,const char*indent,xbt_cfg_t cfg); + + /** @} */ + +/** @defgroup XBT_cfg_register Registering stuff + * @ingroup XBT_config + * + *
Top [\ref index]::[\ref XBT_API]::[\ref XBT_config] + *
Prev [\ref XBT_cfg_decl] + *
Next [\ref XBT_cfg_get]
* * This how to add new variables to an existing configuration set. Use it to make your code * configurable. @@ -171,7 +193,12 @@ void xbt_cfg_empty(xbt_cfg_t cfg, const char *name); void xbt_cfg_check(xbt_cfg_t cfg); e_xbt_cfgelm_type_t xbt_cfg_get_type(xbt_cfg_t cfg, const char *name); /* @} */ -/** @name 4. Getting the stored values +/** @defgroup XBT_cfg_get Getting the stored values + * @ingroup XBT_config + * + *
Top [\ref index]::[\ref XBT_API]::[\ref XBT_config] + *
Prev [\ref XBT_cfg_register] + *
Next
* * This is how to retrieve the values stored in the configuration set. This is only * intended to configurable code, naturally. @@ -196,7 +223,7 @@ void xbt_cfg_empty(xbt_cfg_t cfg, const char *name); void xbt_cfg_get_host_at (xbt_cfg_t cfg, const char *name, int pos, char **host, int *port); /** @} */ -/** @} */ -END_DECL() + +SG_END_DECL() #endif /* _XBT_CONFIG_H_ */