1 /* config - Dictionary where the type of each cell is provided. */
2 /* This is useful to build named structs, like option or property sets. */
4 /* Copyright (c) 2004-2023. The SimGrid Team. All rights reserved. */
6 /* This program is free software; you can redistribute it and/or modify it
7 * under the terms of the license (GNU LGPL) which comes with this package. */
15 /** @addtogroup XBT_config
16 * @brief Changing the configuration of SimGrid components (grounding feature)
18 * All modules of the SimGrid toolkit can be configured with this API.
19 * User modules and libraries can also use these facilities to handle their own configuration.
21 * A configuration set contain several @e variables which have a unique name in the set and can take a given type of
22 * value. For example, it may contain a @a size variable, accepting @e int values.
24 * It is impossible to set a value to a variable which has not been registered before.
25 * Usually, the module registers all the options it accepts in the configuration set, during its initialization and
26 * user code then set and unset values.
28 * The easiest way to register a variable is to use the xbt_str_register_str function, which accepts a string
29 * representation of the config element descriptor. The syntax is the following:
30 * @verbatim <name>:<min nb>_to_<max nb>_<type>@endverbatim
32 * For example, <tt>size:1_to_1_int</tt> describes a variable called @e size which must take exactly one value, and
33 * the value being an integer. Set the maximum to 0 to disable the upper bound on data count.
35 * Another example could be <tt>outputfiles:0_to_10_string</tt> which describes a variable called @e outputfiles and
36 * which can take between 0 and 10 strings as value.
38 * To some extend, configuration sets can be seen as typed hash structures.
40 * @section XBT_cfg_ex Example of use
44 /** @defgroup XBT_cfg_use User interface: changing values
47 * This is the only interface you should use unless you want to let your own code become configurable with this.
49 * If the variable accept at most one value, those functions replace the current value with the provided one. If max>1,
50 * the provided value is appended to the list.
52 * string values are strdup'ed before use, so you can (and should) free your copy
56 /** @brief Configuration set's data type is opaque. */
58 #include <xbt/config.hpp>
59 using xbt_cfg_t = simgrid::config::Config*;
61 typedef void* xbt_cfg_t;
66 /* Set the value of the cell @a name in @a cfg with the provided value.*/
67 XBT_PUBLIC void sg_cfg_set_int(const char* name, int val);
68 XBT_PUBLIC void sg_cfg_set_double(const char* name, double val);
69 XBT_PUBLIC void sg_cfg_set_boolean(const char* name, const char* val);
70 XBT_PUBLIC void sg_cfg_set_string(const char* name, const char* val);
73 /** @defgroup XBT_cfg_get Getting the stored values
76 * This is how to retrieve the values stored in the configuration set. This is only intended to configurable code,
79 * Note that those function return a pointer to the values actually stored in the set. Do not modify them unless you
80 * really know what you're doing. Likewise, do not free the strings after use, they are not copy of the data, but the
86 XBT_PUBLIC int sg_cfg_get_int(const char* name);
87 XBT_PUBLIC double sg_cfg_get_double(const char* name);
88 XBT_PUBLIC int sg_cfg_get_boolean(const char* name);
92 #endif /* XBT_CONFIG_H */