/* 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-2018. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2004-2019. 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. */
* 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
+ * @section XBT_cfg_ex Example of use
*
* TBD
*/
*/
/** @brief Configuration set's data type is opaque. */
#ifdef __cplusplus
-namespace simgrid {
-namespace config {
-class Config;
-}
-}
+#include <xbt/config.hpp>
typedef simgrid::config::Config* xbt_cfg_t;
#else
typedef void* xbt_cfg_t;
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_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);
-
-/** @brief Return if configuration is set by default*/
-XBT_PUBLIC int xbt_cfg_is_default_value(const char* name);
-
+/* Set the value of the cell @a name in @a cfg with the provided value.*/
+XBT_ATTRIB_DEPRECATED_v325("Please use simgrid::config::set_value<int> or sg_cfg_set_int") XBT_PUBLIC
+ void xbt_cfg_set_int(const char* name, int val);
+XBT_ATTRIB_DEPRECATED_v325("Please use simgrid::config::set_value<double> or sg_cfg_set_double") XBT_PUBLIC
+ void xbt_cfg_set_double(const char* name, double val);
+XBT_ATTRIB_DEPRECATED_v325("Please use simgrid::config::set_value<bool> or sg_cfg_set_boolean") XBT_PUBLIC
+ void xbt_cfg_set_boolean(const char* name, const char* val);
+XBT_ATTRIB_DEPRECATED_v325("Please use simgrid::config::set_value<std::string>or sg_cfg_set_string") XBT_PUBLIC
+ void xbt_cfg_set_string(const char* name, const char* val);
+
+XBT_PUBLIC void sg_cfg_set_int(const char* name, int val);
+XBT_PUBLIC void sg_cfg_set_double(const char* name, double val);
+XBT_PUBLIC void sg_cfg_set_boolean(const char* name, const char* val);
+XBT_PUBLIC void sg_cfg_set_string(const char* name, const char* val);
/* @} */
/** @defgroup XBT_cfg_decl Configuration type declaration and memory management
* @{
*/
-/** \brief Callback types. They get the name of the modified entry, and the position of the changed value */
+/** @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();
-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.
- *
- * @{
- */
-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();
-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 int xbt_cfg_get_boolean(const char* name);
+XBT_ATTRIB_DEPRECATED_v325("Please use simgrid::config::get_value<int> or sg_cfg_get_int") XBT_PUBLIC
+ int xbt_cfg_get_int(const char* name);
+XBT_ATTRIB_DEPRECATED_v325("Please use simgrid::config::get_value<double> or sg_cfg_get_double") XBT_PUBLIC
+ double xbt_cfg_get_double(const char* name);
+XBT_ATTRIB_DEPRECATED_v325("Please use simgrid::config::get_value<bool> or sg_cfg_get_boolean") XBT_PUBLIC
+ int xbt_cfg_get_boolean(const char* name);
+XBT_PUBLIC int sg_cfg_get_int(const char* name);
+XBT_PUBLIC double sg_cfg_get_double(const char* name);
+XBT_PUBLIC int sg_cfg_get_boolean(const char* name);
/** @} */
SG_END_DECL()
