X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/494616a1d79ab04ce6f0309a5cbb29ee5876c379..66d97e68ea51b5514594e5818f75c7d844586eae:/include/xbt/config.h diff --git a/include/xbt/config.h b/include/xbt/config.h index dfd08b24e7..05e49ebc14 100644 --- a/include/xbt/config.h +++ b/include/xbt/config.h @@ -17,7 +17,8 @@ SG_BEGIN_DECL() /** @addtogroup XBT_config - * + * @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. @@ -45,9 +46,10 @@ SG_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 +71,11 @@ SG_BEGIN_DECL() * unregistered variable. * \skip myset * \until cfg_free - * @{ - */ - -/** @name 1. Type declaration and memory management - * - * - * - * @{ + * */ - /** @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 +/** @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. @@ -117,61 +90,94 @@ SG_BEGIN_DECL() * @{ */ - 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); + /** @brief Configuration set are only special dynars. But don't rely on it, it may change. */ + typedef xbt_dynar_t xbt_cfg_t; + + 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. */ -void xbt_cfg_set_int (xbt_cfg_t cfg, const char *name, +XBT_PUBLIC(void) xbt_cfg_set_int (xbt_cfg_t cfg, const char *name, int val); -void xbt_cfg_set_double(xbt_cfg_t cfg, const char *name, +XBT_PUBLIC(void) xbt_cfg_set_double(xbt_cfg_t cfg, const char *name, double val); -void xbt_cfg_set_string(xbt_cfg_t cfg, const char *name, +XBT_PUBLIC(void) xbt_cfg_set_string(xbt_cfg_t cfg, const char *name, const char *val); -void xbt_cfg_set_host (xbt_cfg_t cfg, const char *name, - const char *host,int port); +XBT_PUBLIC(void) xbt_cfg_set_peer (xbt_cfg_t cfg, const char *name, + const char *peer,int port); /* Remove the provided value from the cell @name in @cfg. */ -void xbt_cfg_rm_int (xbt_cfg_t cfg, const char *name, +XBT_PUBLIC(void) xbt_cfg_rm_int (xbt_cfg_t cfg, const char *name, int val); -void xbt_cfg_rm_double(xbt_cfg_t cfg, const char *name, +XBT_PUBLIC(void) xbt_cfg_rm_double(xbt_cfg_t cfg, const char *name, double val); -void xbt_cfg_rm_string(xbt_cfg_t cfg, const char *name, +XBT_PUBLIC(void) xbt_cfg_rm_string(xbt_cfg_t cfg, const char *name, const char *val); -void xbt_cfg_rm_host (xbt_cfg_t cfg, const char *name, - const char *host,int port); +XBT_PUBLIC(void) xbt_cfg_rm_peer (xbt_cfg_t cfg, const char *name, + const char *peer,int port); /* Remove the value at position \e pos from the config \e cfg */ -void xbt_cfg_rm_at (xbt_cfg_t cfg, const char *name, int pos); +XBT_PUBLIC(void) xbt_cfg_rm_at (xbt_cfg_t cfg, const char *name, int pos); /* rm every values */ -void xbt_cfg_empty(xbt_cfg_t cfg, const char *name); +XBT_PUBLIC(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 + * + * @{ + */ + + /** @brief possible content of each configuration cell */ + typedef enum { + xbt_cfgelm_int=0, /**< int */ + xbt_cfgelm_double, /**< double */ + xbt_cfgelm_string, /**< char* */ + xbt_cfgelm_peer, /**< both a char* (representing the peername) 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_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_free(xbt_cfg_t *cfg); + XBT_PUBLIC(void) xbt_cfg_dump(const char *name,const char*indent,xbt_cfg_t cfg); + + /** @} */ + +/** @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. * * @{ */ - void xbt_cfg_register(xbt_cfg_t cfg, + XBT_PUBLIC(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); - void xbt_cfg_unregister(xbt_cfg_t cfg, const char *name); - void xbt_cfg_register_str(xbt_cfg_t cfg, const char *entry); - void xbt_cfg_check(xbt_cfg_t cfg); - e_xbt_cfgelm_type_t xbt_cfg_get_type(xbt_cfg_t cfg, const char *name); + XBT_PUBLIC(void) xbt_cfg_unregister(xbt_cfg_t cfg, const char *name); + XBT_PUBLIC(void) xbt_cfg_register_str(xbt_cfg_t cfg, const char *entry); + XBT_PUBLIC(void) xbt_cfg_check(xbt_cfg_t cfg); + XBT_PUBLIC(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 * * This is how to retrieve the values stored in the configuration set. This is only * intended to configurable code, naturally. @@ -184,19 +190,19 @@ void xbt_cfg_empty(xbt_cfg_t cfg, const char *name); * @{ */ - int xbt_cfg_get_int (xbt_cfg_t cfg, const char *name); - double xbt_cfg_get_double(xbt_cfg_t cfg, const char *name); - char* xbt_cfg_get_string(xbt_cfg_t cfg, const char *name); - void xbt_cfg_get_host (xbt_cfg_t cfg, const char *name, char **host, int *port); - xbt_dynar_t xbt_cfg_get_dynar (xbt_cfg_t cfg, const char *name); + XBT_PUBLIC(int) xbt_cfg_get_int (xbt_cfg_t cfg, const char *name); + XBT_PUBLIC(double) xbt_cfg_get_double(xbt_cfg_t cfg, const char *name); + XBT_PUBLIC(char*) xbt_cfg_get_string(xbt_cfg_t cfg, const char *name); + XBT_PUBLIC(void) xbt_cfg_get_peer (xbt_cfg_t cfg, const char *name, char **peer, int *port); + XBT_PUBLIC(xbt_dynar_t) xbt_cfg_get_dynar (xbt_cfg_t cfg, const char *name); - int xbt_cfg_get_int_at (xbt_cfg_t cfg, const char *name, int pos); - double xbt_cfg_get_double_at(xbt_cfg_t cfg, const char *name, int pos); - char* xbt_cfg_get_string_at(xbt_cfg_t cfg, const char *name, int pos); - void xbt_cfg_get_host_at (xbt_cfg_t cfg, const char *name, int pos, char **host, int *port); + XBT_PUBLIC(int) xbt_cfg_get_int_at (xbt_cfg_t cfg, const char *name, int pos); + XBT_PUBLIC(double) xbt_cfg_get_double_at(xbt_cfg_t cfg, const char *name, int pos); + XBT_PUBLIC(char*) xbt_cfg_get_string_at(xbt_cfg_t cfg, const char *name, int pos); + XBT_PUBLIC(void) xbt_cfg_get_peer_at (xbt_cfg_t cfg, const char *name, int pos, char **peer, int *port); /** @} */ -/** @} */ + SG_END_DECL() #endif /* _XBT_CONFIG_H_ */