X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/707e365f2ebe9132b004da4995f4a705df9e5582..9d0bdd2e04d23fbcc1db6e7e525cf79979c4643b:/include/xbt/config.h diff --git a/include/xbt/config.h b/include/xbt/config.h index ec201ab4ef..a5ab70f931 100644 --- a/include/xbt/config.h +++ b/include/xbt/config.h @@ -1,10 +1,9 @@ -/* $Id$ */ - -/* config - Dictionnary where the type of each cell is provided. */ +/* config - Dictionary where the type of each cell is provided. */ /* This is useful to build named structs, like option or property sets. */ -/* Copyright (c) 2001,2002,2003,2004 Martin Quinson. All rights reserved. */ +/* Copyright (c) 2004-2007, 2009-2014. The SimGrid Team. + * All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ @@ -13,44 +12,38 @@ #define _XBT_CONFIG_H_ #include "xbt/dynar.h" +#include -BEGIN_DECL() +SG_BEGIN_DECL() /** @addtogroup XBT_config - * - * 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. + * @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. * - * A configuration set contain several \e variables which have a uniq 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. - * Moreover, of 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. + * 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. - * - * \todo This great mecanism is not used in SimGrid yet... * - * \todo We need a callback mecanism so that the configurable code get - * notified of configuration changes. + * \section XBT_cfg_ex Example of use * - * \section XBT_cfg_ex Example - * - * \dontinclude config_usage.c + * \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. @@ -68,121 +61,121 @@ 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 - * @{ - */ - -/** @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_type_count - } e_xbt_cfgelm_type_t; - - 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. + * 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 * * @{ */ +/** @brief Configuration set's data type is opaque. */ +typedef void* xbt_cfg_t; - xbt_error_t xbt_cfg_set(xbt_cfg_t cfg, ...); - xbt_error_t xbt_cfg_set_vargs(xbt_cfg_t cfg, va_list pa); - xbt_error_t xbt_cfg_set_parse(xbt_cfg_t cfg, const char *options); +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(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_string (const char *name, const char *val); +XBT_PUBLIC(void) xbt_cfg_set_boolean (const char *name, const char *val); +XBT_PUBLIC(void*) xbt_cfg_set_as_string(const char *name, const char *val); /* - Set the 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_error_t xbt_cfg_set_int (xbt_cfg_t cfg, const char *name, - int val); -xbt_error_t xbt_cfg_set_double(xbt_cfg_t cfg, const char *name, - double val); -xbt_error_t xbt_cfg_set_string(xbt_cfg_t cfg, const char *name, - const char *val); -xbt_error_t xbt_cfg_set_host (xbt_cfg_t cfg, const char *name, - const char *host,int port); +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); -/* - Remove the provided value from the cell @name in @cfg. - */ -xbt_error_t xbt_cfg_rm_int (xbt_cfg_t cfg, const char *name, - int val); -xbt_error_t xbt_cfg_rm_double(xbt_cfg_t cfg, const char *name, - double val); -xbt_error_t xbt_cfg_rm_string(xbt_cfg_t cfg, const char *name, - const char *val); -xbt_error_t xbt_cfg_rm_host (xbt_cfg_t cfg, const char *name, - const char *host,int port); - -/* rm every values */ -xbt_error_t xbt_cfg_empty(xbt_cfg_t cfg, const char *name); +/** @brief Return if configuration is set by default*/ +XBT_PUBLIC(int) xbt_cfg_is_default_value(const char *name); /* @} */ -/** @name 3. Registering stuff + +/** @defgroup XBT_cfg_decl Configuration type declaration and memory management + * @ingroup XBT_config * - * This how to add new variables to an existing configuration set. Use it to make your code - * configurable. + * @{ + */ + + /** @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_alias, /**< redirection from a deprecated name to a better one */ + //! @cond + xbt_cfgelm_any, /* not shown to users to prevent errors */ + xbt_cfgelm_type_count + //! @endcond +} e_xbt_cfgelm_type_t; + +/** Boolean possible values **/ +struct xbt_boolean_couple { + const char *true_val; + const char *false_val; +}; + +/** \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(void); +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, - const char *name, e_xbt_cfgelm_type_t type, - int min, int max); - xbt_error_t xbt_cfg_unregister(xbt_cfg_t cfg, const char *name); - xbt_error_t xbt_cfg_register_str(xbt_cfg_t cfg, const char *entry); - xbt_error_t xbt_cfg_check(xbt_cfg_t cfg); - xbt_error_t xbt_cfg_get_type(xbt_cfg_t cfg, const char *name, - /* OUT */ e_xbt_cfgelm_type_t *type); +XBT_PUBLIC(void) xbt_cfg_register_double (const char *name, double default_val, xbt_cfg_cb_t cb_set, const char *desc); +XBT_PUBLIC(void) xbt_cfg_register_int (const char *name, int default_val, xbt_cfg_cb_t cb_set, const char *desc); +XBT_PUBLIC(void) xbt_cfg_register_string (const char *name, const char*default_val,xbt_cfg_cb_t cb_set, const char *desc); +XBT_PUBLIC(void) xbt_cfg_register_boolean(const char *name, const char*default_val,xbt_cfg_cb_t cb_set, const char *desc); +XBT_PUBLIC(void) xbt_cfg_register_alias(const char *newname, const char *oldname); +XBT_PUBLIC(void) xbt_cfg_register_str(xbt_cfg_t * cfg, const char *entry); + +XBT_PUBLIC(void) xbt_cfg_aliases(void); +XBT_PUBLIC(void) xbt_cfg_help(void); +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. + * 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. + * 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. * * @{ */ - xbt_error_t xbt_cfg_get_int (xbt_cfg_t cfg, const char *name, int *val); - xbt_error_t xbt_cfg_get_double(xbt_cfg_t cfg, const char *name, double *val); - xbt_error_t xbt_cfg_get_string(xbt_cfg_t cfg, const char *name, char **val); - xbt_error_t xbt_cfg_get_host (xbt_cfg_t cfg, const char *name, char **host, int *port); - xbt_error_t xbt_cfg_get_dynar (xbt_cfg_t cfg, const char *name, xbt_dynar_t *dynar); +XBT_PUBLIC(int) xbt_cfg_get_int(const char *name); +XBT_PUBLIC(double) xbt_cfg_get_double(const char *name); +XBT_PUBLIC(char *) xbt_cfg_get_string(const char *name); +XBT_PUBLIC(int) xbt_cfg_get_boolean(const char *name); /** @} */ -/** @} */ -END_DECL() - -#endif /* _XBT_CONFIG_H_ */ + +SG_END_DECL() +#endif /* _XBT_CONFIG_H_ */