-/* 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 <stdarg.h>
-
-SG_BEGIN_DECL()
+#include <xbt/base.h>
/** @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.
*
- * 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.
+ * 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
*
* 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 <name>:<min nb>_to_<max nb>_<type>\endverbatim
+ * @verbatim <name>:<min nb>_to_<max nb>_<type>@endverbatim
*
- * For example, <tt>size:1_to_1_int</tt> describes a variable called \e size which must take exactly one value, and
+ * For example, <tt>size:1_to_1_int</tt> 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 <tt>outputfiles:0_to_10_string</tt> which describes a variable called \e outputfiles and
+ * Another example could be <tt>outputfiles:0_to_10_string</tt> 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.
*
- * \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
+ * @section XBT_cfg_ex Example of use
*
- * 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
* @{
*/
/** @brief Configuration set's data type is opaque. */
+#ifdef __cplusplus
+#include <xbt/config.hpp>
+typedef simgrid::config::Config* xbt_cfg_t;
+#else
typedef void* xbt_cfg_t;
+#endif
-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);
+SG_BEGIN_DECL()
-/* 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_ATTRIB_DEPRECATED_v323("Please use simgrid::config::set_parse") 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_ATTRIB_DEPRECATED_v323("Please use simgrid::config::set_value<int>") XBT_PUBLIC
+ void xbt_cfg_set_int(const char* name, int val);
+XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::set_value<double>") XBT_PUBLIC
+ void xbt_cfg_set_double(const char* name, double val);
+XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::set_value<bool>") XBT_PUBLIC
+ void xbt_cfg_set_boolean(const char* name, const char* val);
+XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::set_value<std::string>") XBT_PUBLIC
+ void xbt_cfg_set_string(const char* name, const char* val);
+XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::set_as_string") 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.
+ 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_ATTRIB_DEPRECATED_v323("Please use simgrid::config::set_default<int>") XBT_PUBLIC
+ void xbt_cfg_setdefault_int(const char* name, int val);
+XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::set_default<double>") XBT_PUBLIC
+ void xbt_cfg_setdefault_double(const char* name, double val);
+XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::set_default<bool>") XBT_PUBLIC
+ void xbt_cfg_setdefault_boolean(const char* name, const char* val);
+XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::set_default<std::string>") XBT_PUBLIC
+ void xbt_cfg_setdefault_string(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_ATTRIB_DEPRECATED_v323("Please use simgrid::config::is_default") XBT_PUBLIC
+ int xbt_cfg_is_default_value(const char* name);
/* @} */
* @{
*/
- /** @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 *, 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);
-
- /** @} */
+/** @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_ATTRIB_DEPRECATED_v323("Please don't use it") XBT_PUBLIC xbt_cfg_t xbt_cfg_new();
+XBT_ATTRIB_DEPRECATED_v323("Please don't use it") XBT_PUBLIC void xbt_cfg_free(xbt_cfg_t* cfg);
+XBT_ATTRIB_DEPRECATED_v323("Please don't use it") 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
*
* @{
*/
-XBT_PUBLIC(void) xbt_cfg_register(xbt_cfg_t * cfg, const char *name, const char *description,
- e_xbt_cfgelm_type_t type, int min, xbt_cfg_cb_t cb_set);
-XBT_PUBLIC(void) xbt_cfg_register_double (const char *name, const char *desc, double default_val, xbt_cfg_cb_t cb_set);
-XBT_PUBLIC(void) xbt_cfg_register_int (const char *name, const char *desc, int default_val, xbt_cfg_cb_t cb_set);
-XBT_PUBLIC(void) xbt_cfg_register_string (const char *name, const char *desc, const char*default_val,xbt_cfg_cb_t cb_set);
-XBT_PUBLIC(void) xbt_cfg_register_boolean(const char *name, const char *desc, const char*default_val,xbt_cfg_cb_t cb_set);
-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(xbt_cfg_t cfg);
-XBT_PUBLIC(void) xbt_cfg_help(xbt_cfg_t cfg);
-XBT_PUBLIC(void) xbt_cfg_check(void);
-XBT_PUBLIC(e_xbt_cfgelm_type_t) xbt_cfg_get_type(xbt_cfg_t cfg, const char *name);
+XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::declare_flag<double>") 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<int>") 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<std::string>") 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<bool>") 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_ATTRIB_DEPRECATED_v323("Please use simgrid::config::show_aliases") XBT_PUBLIC void xbt_cfg_aliases();
+XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::help") XBT_PUBLIC void xbt_cfg_help();
+
/* @} */
/** @defgroup XBT_cfg_get Getting the stored values
* @ingroup XBT_config
* @{
*/
-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(xbt_dynar_t) xbt_cfg_get_dynar(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(int) xbt_cfg_get_boolean_at(xbt_cfg_t cfg, const char *name, int pos);
+XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::get_value<int>") XBT_PUBLIC
+ int xbt_cfg_get_int(const char* name);
+XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::get_value<double>") XBT_PUBLIC
+ double xbt_cfg_get_double(const char* name);
+XBT_ATTRIB_DEPRECATED_v323("Please use simgrid::config::get_value<bool>") XBT_PUBLIC
+ int xbt_cfg_get_boolean(const char* name);
/** @} */
SG_END_DECL()
-#endif /* _XBT_CONFIG_H_ */
+#endif /* XBT_CONFIG_H */
