X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/f9541e9299d8464d8a4d13ada458a7883a36a9d5..52ce912c49d61c252e301393740350f4f0e41d8b:/include/xbt/config.h diff --git a/include/xbt/config.h b/include/xbt/config.h index b5df791099..a555624466 100644 --- a/include/xbt/config.h +++ b/include/xbt/config.h @@ -1,20 +1,16 @@ -/* config - Dictionary 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) 2004-2007, 2009-2014. The SimGrid Team. - * All rights reserved. */ +/* Copyright (c) 2004-2018. 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. */ -#ifndef _XBT_CONFIG_H_ -#define _XBT_CONFIG_H_ +#ifndef XBT_CONFIG_H +#define XBT_CONFIG_H -#include "xbt/dynar.h" #include - -SG_BEGIN_DECL() +#include /** @addtogroup XBT_config * @brief Changing the configuration of SimGrid components (grounding feature) @@ -43,27 +39,7 @@ SG_BEGIN_DECL() * * \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. - * - * \skip make_set - * \until end_of_make_set - * - * Now, set and get a single value - * \skip get_single_value - * \skip int - * \until cfg_free - * - * And now, set and get a multiple value - * \skip get_multiple_value - * \skip dyn - * \until cfg_free - * - * All those functions throws mismatch_error if asked to deal with an unregistered variable. - * \skip myset - * \until cfg_free + * TBD */ /** @defgroup XBT_cfg_use User interface: changing values * @ingroup XBT_config @@ -89,26 +65,28 @@ typedef simgrid::config::Config* xbt_cfg_t; typedef void* xbt_cfg_t; #endif -XBT_PUBLIC(void) xbt_cfg_set_parse(const char *options); +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_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); +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); /* 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_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); /** @brief Return if configuration is set by default*/ -XBT_PUBLIC(int) xbt_cfg_is_default_value(const char *name); +XBT_PUBLIC int xbt_cfg_is_default_value(const char* name); /* @} */ @@ -119,13 +97,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 */ -typedef void (*xbt_cfg_cb_t) (const char * name); +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); +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); - /** @} */ +/** @} */ /** @defgroup XBT_cfg_register Registering stuff * @ingroup XBT_config @@ -134,14 +112,19 @@ XBT_PUBLIC(void) xbt_cfg_dump(const char *name, const char *indent, xbt_cfg_t cf * * @{ */ -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_aliases(void); -XBT_PUBLIC(void) xbt_cfg_help(void); +XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::declare_flag") XBT_PUBLIC + void xbt_cfg_register_double(const char* name, double default_val, xbt_cfg_cb_t cb_set, const char* desc); +XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::declare_flag") XBT_PUBLIC + void xbt_cfg_register_int(const char* name, int default_val, xbt_cfg_cb_t cb_set, const char* desc); +XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::declare_flag") XBT_PUBLIC + void xbt_cfg_register_string(const char* name, const char* default_val, xbt_cfg_cb_t cb_set, const char* desc); +XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::declare_flag") XBT_PUBLIC + void xbt_cfg_register_boolean(const char* name, const char* default_val, xbt_cfg_cb_t cb_set, const char* desc); +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(); /* @} */ /** @defgroup XBT_cfg_get Getting the stored values @@ -157,12 +140,11 @@ XBT_PUBLIC(void) xbt_cfg_help(void); * @{ */ -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); +XBT_PUBLIC int xbt_cfg_get_int(const char* name); +XBT_PUBLIC double xbt_cfg_get_double(const char* name); +XBT_PUBLIC int xbt_cfg_get_boolean(const char* name); /** @} */ SG_END_DECL() -#endif /* _XBT_CONFIG_H_ */ +#endif /* XBT_CONFIG_H */