X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/f365d61a634d854a3244979c0524de3cf3a74f72..2e060bcd7eac791d931940bcc68dbac1c63bebbc:/include/xbt/config.h diff --git a/include/xbt/config.h b/include/xbt/config.h index 0ddcff72ca..296aa3fbba 100644 --- a/include/xbt/config.h +++ b/include/xbt/config.h @@ -2,7 +2,7 @@ /* This is useful to build named structs, like option or property sets. */ -/* Copyright (c) 2004, 2005, 2006, 2007, 2009, 2010. The SimGrid Team. +/* 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 @@ -11,8 +11,8 @@ #ifndef _XBT_CONFIG_H_ #define _XBT_CONFIG_H_ -#include #include "xbt/dynar.h" +#include SG_BEGIN_DECL() @@ -44,8 +44,6 @@ SG_BEGIN_DECL() * * To some extend, configuration sets can be seen as typed hash structures. * - * \todo This great mechanism is not used in SimGrid yet... - * * * \section XBT_cfg_ex Example of use * @@ -92,8 +90,7 @@ SG_BEGIN_DECL() typedef void* 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_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); @@ -101,47 +98,33 @@ 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. */ 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); -XBT_PUBLIC(void) xbt_cfg_set_peer(xbt_cfg_t cfg, const char *name, - const char *peer, int port); +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); +XBT_PUBLIC(void) xbt_cfg_set_boolean(xbt_cfg_t cfg, const char *name, const char *val); +XBT_PUBLIC(void*) xbt_cfg_set_as_string(xbt_cfg_t cfg, const char *name, const char *val); /* 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(xbt_cfg_t cfg, const char *name, - int val); -XBT_PUBLIC(void) xbt_cfg_setdefault_double(xbt_cfg_t cfg, const char *name, - double val); -XBT_PUBLIC(void) xbt_cfg_setdefault_string(xbt_cfg_t cfg, const char *name, - const char *val); -XBT_PUBLIC(void) xbt_cfg_setdefault_peer(xbt_cfg_t cfg, const char *name, - const char *host, int port); +XBT_PUBLIC(void) xbt_cfg_setdefault_int(xbt_cfg_t cfg, const char *name, int val); +XBT_PUBLIC(void) xbt_cfg_setdefault_double(xbt_cfg_t cfg, const char *name, double val); +XBT_PUBLIC(void) xbt_cfg_setdefault_string(xbt_cfg_t cfg, const char *name, const char *val); +XBT_PUBLIC(void) xbt_cfg_setdefault_boolean(xbt_cfg_t cfg, const char *name, const char *val); - -/* - Remove the provided value from the cell @name in @cfg. - */ +/** @brief Remove the provided value from the cell #name in #cfg. */ XBT_PUBLIC(void) xbt_cfg_rm_int(xbt_cfg_t cfg, const char *name, int val); -XBT_PUBLIC(void) xbt_cfg_rm_double(xbt_cfg_t cfg, const char *name, - double val); -XBT_PUBLIC(void) xbt_cfg_rm_string(xbt_cfg_t cfg, const char *name, - const char *val); -XBT_PUBLIC(void) xbt_cfg_rm_peer(xbt_cfg_t cfg, const char *name, - const char *peer, int port); +XBT_PUBLIC(void) xbt_cfg_rm_double(xbt_cfg_t cfg, const char *name, double val); +XBT_PUBLIC(void) xbt_cfg_rm_string(xbt_cfg_t cfg, const char *name, const char *val); +XBT_PUBLIC(void) xbt_cfg_rm_boolean(xbt_cfg_t cfg, const char *name, int val); -/* - Remove the value at position \e pos from the config \e cfg - */ +/** @brief Remove the value at position \e pos from the config \e cfg */ XBT_PUBLIC(void) xbt_cfg_rm_at(xbt_cfg_t cfg, const char *name, int pos); -/* rm every values */ +/** @brief rm every values */ XBT_PUBLIC(void) xbt_cfg_empty(xbt_cfg_t cfg, const char *name); -/* Return if configuration is set by default*/ +/** @brief Return if configuration is set by default*/ XBT_PUBLIC(int) xbt_cfg_is_default_value(xbt_cfg_t cfg, const char *name); /* @} */ @@ -160,12 +143,21 @@ typedef enum { /**< double */ xbt_cfgelm_string, /**< char* */ - xbt_cfgelm_peer, /**< both a char* (representing the peername) and an integer (representing the port) */ - + 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 *, int); @@ -173,8 +165,7 @@ 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); +XBT_PUBLIC(void) xbt_cfg_dump(const char *name, const char *indent, xbt_cfg_t cfg); /** @} */ @@ -186,18 +177,15 @@ XBT_PUBLIC(void) xbt_cfg_dump(const char *name, const char *indent, * * @{ */ -XBT_PUBLIC(void) xbt_cfg_register(xbt_cfg_t * cfg, - const char *name, - const char *description, - e_xbt_cfgelm_type_t type, - void *default_value, int min, int max, - xbt_cfg_cb_t cb_set, xbt_cfg_cb_t cb_rm); +XBT_PUBLIC(void) xbt_cfg_register(xbt_cfg_t * cfg, const char *name, const char *description, + e_xbt_cfgelm_type_t type, int min, int max, xbt_cfg_cb_t cb_set); +XBT_PUBLIC(void) xbt_cfg_register_alias(xbt_cfg_t * cfg, const char *newname, const char *oldname); 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_aliases(xbt_cfg_t cfg); XBT_PUBLIC(void) xbt_cfg_help(xbt_cfg_t cfg); 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); +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 @@ -216,18 +204,13 @@ XBT_PUBLIC(e_xbt_cfgelm_type_t) xbt_cfg_get_type(xbt_cfg_t cfg, 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(int) xbt_cfg_get_boolean(xbt_cfg_t cfg, const char *name); XBT_PUBLIC(xbt_dynar_t) xbt_cfg_get_dynar(xbt_cfg_t cfg, const char *name); -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); +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(int) xbt_cfg_get_boolean_at(xbt_cfg_t cfg, const char *name, int pos); /** @} */