Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
make MSG_config public, document it, and implement it properly, not through a crude...
[simgrid.git] / include / xbt / config.h
1 /* config - Dictionary where the type of each cell is provided.            */
2
3 /* This is useful to build named structs, like option or property sets.     */
4
5 /* Copyright (c) 2004, 2005, 2006, 2007, 2009, 2010. The SimGrid Team.
6  * All rights reserved.                                                     */
7
8 /* This program is free software; you can redistribute it and/or modify it
9  * under the terms of the license (GNU LGPL) which comes with this package. */
10
11 #ifndef _XBT_CONFIG_H_
12 #define _XBT_CONFIG_H_
13
14 #include <stdarg.h>
15 #include "xbt/dynar.h"
16
17 SG_BEGIN_DECL()
18
19 /** @addtogroup XBT_config
20  *  @brief Changing the configuration of SimGrid components (grounding feature)
21  *
22  *  All modules of the SimGrid toolkit can be configured with this API.
23  *  User modules and libraries can also use these facilities to handle
24  *  their own configuration.
25  *
26  *  A configuration set contain several \e variables which have a unique name
27  *  in the set and can take a given type of value. For example, it may
28  *  contain a \a size variable, accepting \e int values.
29  *
30  *  It is impossible to set a value to a variable which has not been registered before.
31  *  Usually, the module registers all the options it accepts in the configuration set,
32  *  during its initialization and user code then set and unset values.
33  *
34  *  The easiest way to register a variable is to use the xbt_str_register_str function,
35  *  which accepts a string representation of the config element descriptor. The syntax
36  *  is the following: \verbatim <name>:<min nb>_to_<max nb>_<type>\endverbatim
37  *
38  *  For example, <tt>size:1_to_1_int</tt> describes a variable called \e size which
39  *  must take exactly one value, and the value being an integer. Set the maximum to 0 to
40  *  disable the upper bound on data count.
41  *
42  *  Another example could be <tt>outputfiles:0_to_10_string</tt> which describes a variable
43  *  called \e outputfiles and which can take between 0 and 10 strings as value.
44  *
45  *  To some extend, configuration sets can be seen as typed hash structures.
46  *
47  *
48  *  \section XBT_cfg_ex Example of use
49  *
50  *  \dontinclude config.c
51  *
52  *  First, let's create a configuration set with some registered variables.
53  *  This must be done by the configurable library before the user interactions.
54  *
55  *  \skip make_set
56  *  \until end_of_make_set
57  *
58  *  Now, set and get a single value
59  *  \skip get_single_value
60  *  \skip int
61  *  \until cfg_free
62  *
63  *  And now, set and get a multiple value
64  *  \skip get_multiple_value
65  *  \skip dyn
66  *  \until cfg_free
67  *
68  *  All those functions throws mismatch_error if asked to deal with an
69  *  unregistered variable.
70  *  \skip myset
71  *  \until cfg_free
72  *
73  */
74 /** @defgroup XBT_cfg_use User interface: changing values
75  *  @ingroup XBT_config
76  *
77  * This is the only interface you should use unless you want to let your
78  * own code become configurable with this.
79  *
80  * If the variable accept at most one value, those functions replace the
81  * current value with the provided one. If max>1, the provided value is
82  * appended to the list.
83  *
84  * string values are strdup'ed before use, so you can (and should) free
85  * your copy
86  *
87  * @{
88  */
89 /** @brief Configuration set's data type is opaque. */
90 typedef void* xbt_cfg_t;
91
92 XBT_PUBLIC(void) xbt_cfg_set(xbt_cfg_t cfg, const char *name, ...);
93 XBT_PUBLIC(void) xbt_cfg_set_vargs(xbt_cfg_t cfg, const char *name,
94                                    va_list pa);
95 XBT_PUBLIC(void) xbt_cfg_set_parse(xbt_cfg_t cfg, const char *options);
96
97
98 /*
99   Set the value of the cell \a name in \a cfg with the provided value.
100  */
101 XBT_PUBLIC(void) xbt_cfg_set_int(xbt_cfg_t cfg, const char *name, int val);
102 XBT_PUBLIC(void) xbt_cfg_set_double(xbt_cfg_t cfg, const char *name,
103                                     double val);
104 XBT_PUBLIC(void) xbt_cfg_set_string(xbt_cfg_t cfg, const char *name,
105                                     const char *val);
106 XBT_PUBLIC(void) xbt_cfg_set_peer(xbt_cfg_t cfg, const char *name,
107                                   const char *peer, int port);
108 XBT_PUBLIC(void*) xbt_cfg_set_as_string(xbt_cfg_t cfg, const char *name, const char *val);
109
110 /*
111   Set the default value of the cell \a name in \a cfg with the provided value.
112   If it was already set to something (possibly from the command line), do nothing.
113  */
114 XBT_PUBLIC(void) xbt_cfg_setdefault_int(xbt_cfg_t cfg, const char *name,
115                                         int val);
116 XBT_PUBLIC(void) xbt_cfg_setdefault_double(xbt_cfg_t cfg, const char *name,
117                                            double val);
118 XBT_PUBLIC(void) xbt_cfg_setdefault_string(xbt_cfg_t cfg, const char *name,
119                                            const char *val);
120 XBT_PUBLIC(void) xbt_cfg_setdefault_peer(xbt_cfg_t cfg, const char *name,
121                                          const char *host, int port);
122
123
124 /*
125  Remove the provided value from the cell @name in @cfg.
126  */
127 XBT_PUBLIC(void) xbt_cfg_rm_int(xbt_cfg_t cfg, const char *name, int val);
128 XBT_PUBLIC(void) xbt_cfg_rm_double(xbt_cfg_t cfg, const char *name,
129                                    double val);
130 XBT_PUBLIC(void) xbt_cfg_rm_string(xbt_cfg_t cfg, const char *name,
131                                    const char *val);
132 XBT_PUBLIC(void) xbt_cfg_rm_peer(xbt_cfg_t cfg, const char *name,
133                                  const char *peer, int port);
134
135 /*
136  Remove the value at position \e pos from the config \e cfg
137  */
138 XBT_PUBLIC(void) xbt_cfg_rm_at(xbt_cfg_t cfg, const char *name, int pos);
139
140 /* rm every values */
141 XBT_PUBLIC(void) xbt_cfg_empty(xbt_cfg_t cfg, const char *name);
142
143 /* Return if configuration is set by default*/
144 XBT_PUBLIC(int) xbt_cfg_is_default_value(xbt_cfg_t cfg, const char *name);
145
146 /* @} */
147
148 /** @defgroup XBT_cfg_decl Configuration type declaration and memory management
149  *  @ingroup XBT_config
150  *
151  *  @{
152  */
153
154   /** @brief possible content of each configuration cell */
155 typedef enum {
156   xbt_cfgelm_int = 0,
157                        /**< int */
158   xbt_cfgelm_double,
159                        /**< double */
160   xbt_cfgelm_string,
161                        /**< char* */
162   xbt_cfgelm_peer,     /**< both a char* (representing the peername) and an integer (representing the port) */
163
164   xbt_cfgelm_any,               /* not shown to users to prevent errors */
165   xbt_cfgelm_type_count
166 } e_xbt_cfgelm_type_t;
167
168 /** \brief Callback types. They get the name of the modified entry, and the position of the changed value */
169 typedef void (*xbt_cfg_cb_t) (const char *, int);
170
171 XBT_PUBLIC(xbt_cfg_t) xbt_cfg_new(void);
172 XBT_PUBLIC(void) xbt_cfg_cpy(xbt_cfg_t tocopy,  /* OUT */
173                              xbt_cfg_t * whereto);
174 XBT_PUBLIC(void) xbt_cfg_free(xbt_cfg_t * cfg);
175 XBT_PUBLIC(void) xbt_cfg_dump(const char *name, const char *indent,
176                               xbt_cfg_t cfg);
177
178  /** @} */
179
180 /** @defgroup XBT_cfg_register  Registering stuff
181  *  @ingroup XBT_config
182  *
183  *  This how to add new variables to an existing configuration set. Use it to make your code
184  *  configurable.
185  *
186  *  @{
187  */
188 XBT_PUBLIC(void) xbt_cfg_register(xbt_cfg_t * cfg,
189                                   const char *name,
190                                   const char *description,
191                                   e_xbt_cfgelm_type_t type,
192                                   void *default_value, int min, int max,
193                                   xbt_cfg_cb_t cb_set, xbt_cfg_cb_t cb_rm);
194 XBT_PUBLIC(void) xbt_cfg_unregister(xbt_cfg_t cfg, const char *name);
195 XBT_PUBLIC(void) xbt_cfg_register_str(xbt_cfg_t * cfg, const char *entry);
196 XBT_PUBLIC(void) xbt_cfg_help(xbt_cfg_t cfg);
197 XBT_PUBLIC(void) xbt_cfg_check(xbt_cfg_t cfg);
198 XBT_PUBLIC(e_xbt_cfgelm_type_t) xbt_cfg_get_type(xbt_cfg_t cfg,
199                                                  const char *name);
200 /*  @} */
201 /** @defgroup XBT_cfg_get Getting the stored values
202  *  @ingroup XBT_config
203  *
204  * This is how to retrieve the values stored in the configuration set. This is only
205  * intended to configurable code, naturally.
206  *
207  * Note that those function return a pointer to the values actually stored
208  * in the set. Do not modify them unless you really know what you're doing.
209  * Likewise, do not free the strings after use, they are not copy of the data,
210  * but the data themselves.
211  *
212  *  @{
213  */
214
215 XBT_PUBLIC(int) xbt_cfg_get_int(xbt_cfg_t cfg, const char *name);
216 XBT_PUBLIC(double) xbt_cfg_get_double(xbt_cfg_t cfg, const char *name);
217 XBT_PUBLIC(char *) xbt_cfg_get_string(xbt_cfg_t cfg, const char *name);
218 XBT_PUBLIC(void) xbt_cfg_get_peer(xbt_cfg_t cfg, const char *name,
219                                   char **peer, int *port);
220 XBT_PUBLIC(xbt_dynar_t) xbt_cfg_get_dynar(xbt_cfg_t cfg, const char *name);
221
222 XBT_PUBLIC(int) xbt_cfg_get_int_at(xbt_cfg_t cfg, const char *name,
223                                    int pos);
224 XBT_PUBLIC(double) xbt_cfg_get_double_at(xbt_cfg_t cfg, const char *name,
225                                          int pos);
226 XBT_PUBLIC(char *) xbt_cfg_get_string_at(xbt_cfg_t cfg, const char *name,
227                                          int pos);
228 XBT_PUBLIC(void) xbt_cfg_get_peer_at(xbt_cfg_t cfg, const char *name,
229                                      int pos, char **peer, int *port);
230
231 /** @} */
232
233 SG_END_DECL()
234 #endif                          /* _XBT_CONFIG_H_ */