3 /* config - Dictionnary where the type of each cell is provided. */
5 /* This is useful to build named structs, like option or property sets. */
7 /* Copyright (c) 2001,2002,2003,2004 Martin Quinson. All rights reserved. */
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. */
12 #ifndef _XBT_CONFIG_H_
13 #define _XBT_CONFIG_H_
15 #include "xbt/dynar.h"
19 /** @addtogroup XBT_config
21 * All modules of the SimGrid toolkit can be configured with this API.
22 * User modules and libraries can also use these facilities to handle
23 * their own configuration.
25 * A configuration set contain several \e variables which have a uniq name
26 * in the set and can take a given type of value. For example, it may
27 * contain a \a size variable, accepting \e int values.
28 * Moreover, of values.
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.
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
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.
41 * Another example could be <tt>outputfiles:0_to_10_string</tt> which describes a variable
42 * called \e outputfiles and which can take between 0 and 10 strings as value.
44 * To some extend, configuration sets can be seen as typed hash structures.
46 * \todo This great mecanism is not used in SimGrid yet...
48 * \todo We need a callback mecanism so that the configurable code get
49 * notified of configuration changes.
51 * \section XBT_cfg_ex Example
53 * \dontinclude config_usage.c
55 * First, let's create a configuration set with some registered variables.
56 * This must be done by the configurable library before the user interactions.
59 * \until end_of_make_set
61 * Now, set and get a single value
62 * \skip get_single_value
66 * And now, set and get a multiple value
67 * \skip get_multiple_value
71 * All those functions throws mismatch_error if asked to deal with an
72 * unregistered variable.
78 /** @name 1. Type declaration and memory management
84 /** @brief Configuration set are only special dynars. But don't rely on it, it may change. */
85 typedef xbt_dynar_t xbt_cfg_t;
87 /** @brief possible content of each configuration cell */
89 xbt_cfgelm_int=0, /**< int */
90 xbt_cfgelm_double, /**< double */
91 xbt_cfgelm_string, /**< char* */
92 xbt_cfgelm_host, /**< both a char* (representing the hostname) and an integer (representing the port) */
94 } e_xbt_cfgelm_type_t;
96 xbt_cfg_t xbt_cfg_new (void);
97 void xbt_cfg_cpy(xbt_cfg_t tocopy, /* OUT */ xbt_cfg_t *whereto);
98 void xbt_cfg_free(xbt_cfg_t *cfg);
99 void xbt_cfg_dump(const char *name,const char*indent,xbt_cfg_t cfg);
103 /** @name 2. User interface: changing values
105 * This is the only interface you should use unless you want to let your
106 * own code become configurable with this.
108 * If the variable accept at most one value, those functions replace the
109 * current value with the provided one. If max>1, the provided value is
110 * appended to the list.
112 * string values are strdup'ed before use, so you can (and should) free
118 xbt_error_t xbt_cfg_set(xbt_cfg_t cfg, ...);
119 xbt_error_t xbt_cfg_set_vargs(xbt_cfg_t cfg, va_list pa);
120 xbt_error_t xbt_cfg_set_parse(xbt_cfg_t cfg, const char *options);
124 Set the value of the cell \a name in \a cfg with the provided value.
126 xbt_error_t xbt_cfg_set_int (xbt_cfg_t cfg, const char *name,
128 xbt_error_t xbt_cfg_set_double(xbt_cfg_t cfg, const char *name,
130 xbt_error_t xbt_cfg_set_string(xbt_cfg_t cfg, const char *name,
132 xbt_error_t xbt_cfg_set_host (xbt_cfg_t cfg, const char *name,
133 const char *host,int port);
136 Remove the provided value from the cell @name in @cfg.
138 xbt_error_t xbt_cfg_rm_int (xbt_cfg_t cfg, const char *name,
140 xbt_error_t xbt_cfg_rm_double(xbt_cfg_t cfg, const char *name,
142 xbt_error_t xbt_cfg_rm_string(xbt_cfg_t cfg, const char *name,
144 xbt_error_t xbt_cfg_rm_host (xbt_cfg_t cfg, const char *name,
145 const char *host,int port);
147 /* rm every values */
148 xbt_error_t xbt_cfg_empty(xbt_cfg_t cfg, const char *name);
151 /** @name 3. Registering stuff
153 * This how to add new variables to an existing configuration set. Use it to make your code
158 void xbt_cfg_register(xbt_cfg_t cfg,
159 const char *name, e_xbt_cfgelm_type_t type,
161 xbt_error_t xbt_cfg_unregister(xbt_cfg_t cfg, const char *name);
162 xbt_error_t xbt_cfg_register_str(xbt_cfg_t cfg, const char *entry);
163 xbt_error_t xbt_cfg_check(xbt_cfg_t cfg);
164 xbt_error_t xbt_cfg_get_type(xbt_cfg_t cfg, const char *name,
165 /* OUT */ e_xbt_cfgelm_type_t *type);
167 /** @name 4. Getting the stored values
169 * This is how to retrieve the values stored in the configuration set. This is only
170 * intended to configurable code, naturally.
172 * Note that those function return a pointer to the values actually stored
173 * in the set. Do not modify them unless you really know what you're doing.
178 xbt_error_t xbt_cfg_get_int (xbt_cfg_t cfg, const char *name, int *val);
179 xbt_error_t xbt_cfg_get_double(xbt_cfg_t cfg, const char *name, double *val);
180 xbt_error_t xbt_cfg_get_string(xbt_cfg_t cfg, const char *name, char **val);
181 xbt_error_t xbt_cfg_get_host (xbt_cfg_t cfg, const char *name, char **host, int *port);
182 xbt_error_t xbt_cfg_get_dynar (xbt_cfg_t cfg, const char *name, xbt_dynar_t *dynar);
188 #endif /* _XBT_CONFIG_H_ */