Logo AND Algorithmique Numérique Distribuée

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