-/* $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. */
-/* Authors: Martin Quinson */
-/* Copyright (C) 2001,2002,2003,2004 the OURAGAN project. */
+/* 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. */
-
-#ifndef _GRAS_CONFIG_H_
-#define _GRAS_CONFIG_H_
+ * under the terms of the license (GNU LGPL) which comes with this package. */
-/* For now, a config is only a special dynar. But don't rely on it, */
-/* it may change in the future. */
-typedef gras_dynar_t gras_cfg_t;
+#ifndef XBT_CONFIG_H
+#define XBT_CONFIG_H
-/* type of a typed hash cell */
-typedef enum {
- gras_cfgelm_int=0, gras_cfgelm_double, gras_cfgelm_string, gras_cfgelm_host,
- gras_cfgelm_type_count
-} gras_cfgelm_type_t;
+#include <stdarg.h>
+#include <xbt/base.h>
-/*----[ Memory management ]-----------------------------------------------*/
-gras_cfg_t *gras_cfg_new (void);
-void gras_cfg_cpy(gras_cfg_t **whereto, gras_cfg_t *tocopy);
-void gras_cfg_free(gras_cfg_t **cfg);
-void gras_cfg_dump(const char *name,const char*indent,gras_cfg_t *cfg);
+/** @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.
+ *
+ * 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.
+ *
+ * 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
+ *
+ * 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
+ * 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
+ *
+ * TBD
+ */
+/** @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.
+ *
+ * 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
+ *
+ * @{
+ */
+/** @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
+
+SG_BEGIN_DECL()
+
+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_v325("Please use simgrid::config::set_value<int>") XBT_PUBLIC
+ void xbt_cfg_set_int(const char* name, int val);
+XBT_ATTRIB_DEPRECATED_v325("Please use simgrid::config::set_value<double>") XBT_PUBLIC
+ void xbt_cfg_set_double(const char* name, double val);
+XBT_ATTRIB_DEPRECATED_v325("Please use simgrid::config::set_value<bool>") 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>") 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);
-/*----[ Registering stuff ]-----------------------------------------------*/
-/* Register a possible cell */
-void gras_cfg_register(gras_cfg_t *cfg,
- const char *name, gras_cfgelm_type_t type,
- int min, int max);
-/* Unregister a possible cell */
-gras_error_t gras_cfg_unregister(gras_cfg_t *cfg, const char *name);
+/*
+ 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_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_ATTRIB_DEPRECATED_v323("Please use simgrid::config::is_default") XBT_PUBLIC
+ int xbt_cfg_is_default_value(const char* name);
+
+/* @} */
+
+/** @defgroup XBT_cfg_decl Configuration type declaration and memory management
+ * @ingroup XBT_config
+ *
+ * @{
+ */
-/* Parse the configuration descriptor and register it */
-/* Should be of the form "<name>:<min nb>_to_<max nb>_<type>", */
-/* with type being one of 'string','int', 'host' or 'double' */
-gras_error_t gras_cfg_register_str(gras_cfg_t *cfg, const char *entry);
+/** @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);
-/* Check that each cell have the right amount of elements */
-gras_error_t gras_cfg_check(gras_cfg_t *cfg);
+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);
-/* Get the type of this option in that repository */
-gras_error_t gras_cfg_get_type(gras_cfg_t *cfg, const char *name,
- /* OUT */ gras_cfgelm_type_t *type);
+/** @} */
-/*----[ Setting ]---------------------------------------------------------
- * gras_cfg_set_* functions.
+/** @defgroup XBT_cfg_register Registering stuff
+ * @ingroup XBT_config
*
- * If the registered maximum is equal to 1, those functions remplace the
- * current value with the provided one. If max>1, the provided value is
- * appended to the list.
+ * This how to add new variables to an existing configuration set. Use it to make your code configurable.
*
- * string values are strdup'ed before use, so you have to free your copy */
-
-gras_error_t gras_cfg_set_vargs(gras_cfg_t *cfg, va_list pa);
-gras_error_t gras_cfg_set(gras_cfg_t *cfg, ...);
-
-/*
- Add the cells described in a string to a typed hash.
+ * @{
+ */
+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
+ *
+ * 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. Likewise, do not free the strings after use, they are not copy of the data, but the
+ * data themselves.
+ *
+ * @{
*/
-gras_error_t gras_cfg_set_parse(gras_cfg_t *cfg, const char *options);
+XBT_ATTRIB_DEPRECATED_v325("Please use simgrid::config::get_value<int>") XBT_PUBLIC
+ int xbt_cfg_get_int(const char* name);
+XBT_ATTRIB_DEPRECATED_v325("Please use simgrid::config::get_value<double>") XBT_PUBLIC
+ double xbt_cfg_get_double(const char* name);
+XBT_ATTRIB_DEPRECATED_v325("Please use simgrid::config::get_value<bool>") XBT_PUBLIC
+ int xbt_cfg_get_boolean(const char* name);
-/*
- Set the value of the cell @name in @cfg with the provided value.
- */
-gras_error_t gras_cfg_set_int (gras_cfg_t *cfg, const char *name,
- int val);
-gras_error_t gras_cfg_set_double(gras_cfg_t *cfg, const char *name,
- double val);
-gras_error_t gras_cfg_set_string(gras_cfg_t *cfg, const char *name,
- const char *val);
-gras_error_t gras_cfg_set_host (gras_cfg_t *cfg, const char *name,
- const char *host,int port);
+/** @} */
-/*
- Remove the provided value from the cell @name in @cfg.
- */
-gras_error_t gras_cfg_rm_int (gras_cfg_t *cfg, const char *name,
- int val);
-gras_error_t gras_cfg_rm_double(gras_cfg_t *cfg, const char *name,
- double val);
-gras_error_t gras_cfg_rm_string(gras_cfg_t *cfg, const char *name,
- const char *val);
-gras_error_t gras_cfg_rm_host (gras_cfg_t *cfg, const char *name,
- const char *host,int port);
-
-/* rm every values */
-gras_error_t gras_cfg_empty(gras_cfg_t *cfg, const char *name);
-
-/*----[ Getting ]---------------------------------------------------------*/
-/* Returns a pointer to the values actually stored in the cache. Do not */
-/* modify them unless you really know what you're doing. */
-gras_error_t gras_cfg_get_int (gras_cfg_t *cfg,
- const char *name,
- int *val);
-gras_error_t gras_cfg_get_double(gras_cfg_t *cfg,
- const char *name,
- double *val);
-gras_error_t gras_cfg_get_string(gras_cfg_t *cfg,
- const char *name,
- char **val);
-gras_error_t gras_cfg_get_host (gras_cfg_t *cfg,
- const char *name,
- char **host,
- int *port);
-gras_error_t gras_cfg_get_dynar (gras_cfg_t *cfg,
- const char *name,
- gras_dynar_t **dynar);
-
-
-#endif /* _GRAS_CONFIG_H_ */
+SG_END_DECL()
+#endif /* XBT_CONFIG_H */
