* 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.
+ * 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.
*
* \todo This great mechanism is not used in SimGrid yet...
*
- * \todo We need a callback mechanism so that the configurable code get
- * notified of configuration changes.
- *
* \section XBT_cfg_ex Example
*
* \dontinclude config_usage.c
xbt_cfgelm_double, /**< double */
xbt_cfgelm_string, /**< char* */
xbt_cfgelm_host, /**< both a char* (representing the hostname) and an integer (representing the port) */
+
+ xbt_cfgelm_any, /* not shown to users to prevent errors */
xbt_cfgelm_type_count
} e_xbt_cfgelm_type_t;
+
+ /** \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*, int);
xbt_cfg_t xbt_cfg_new (void);
void xbt_cfg_cpy(xbt_cfg_t tocopy, /* OUT */ xbt_cfg_t *whereto);
* @{
*/
- xbt_error_t xbt_cfg_set(xbt_cfg_t cfg, ...);
- xbt_error_t xbt_cfg_set_vargs(xbt_cfg_t cfg, va_list pa);
- xbt_error_t xbt_cfg_set_parse(xbt_cfg_t cfg, const char *options);
+ void xbt_cfg_set(xbt_cfg_t cfg, const char *name, ...);
+ void xbt_cfg_set_vargs(xbt_cfg_t cfg, const char *name, va_list pa);
+ void xbt_cfg_set_parse(xbt_cfg_t cfg, const char *options);
/*
Set the value of the cell \a name in \a cfg with the provided value.
*/
-xbt_error_t xbt_cfg_set_int (xbt_cfg_t cfg, const char *name,
- int val);
-xbt_error_t xbt_cfg_set_double(xbt_cfg_t cfg, const char *name,
- double val);
-xbt_error_t xbt_cfg_set_string(xbt_cfg_t cfg, const char *name,
- const char *val);
-xbt_error_t xbt_cfg_set_host (xbt_cfg_t cfg, const char *name,
- const char *host,int port);
+void xbt_cfg_set_int (xbt_cfg_t cfg, const char *name,
+ int val);
+void xbt_cfg_set_double(xbt_cfg_t cfg, const char *name,
+ double val);
+void xbt_cfg_set_string(xbt_cfg_t cfg, const char *name,
+ const char *val);
+void xbt_cfg_set_host (xbt_cfg_t cfg, const char *name,
+ const char *host,int port);
/*
Remove the provided value from the cell @name in @cfg.
*/
-xbt_error_t xbt_cfg_rm_int (xbt_cfg_t cfg, const char *name,
- int val);
-xbt_error_t xbt_cfg_rm_double(xbt_cfg_t cfg, const char *name,
- double val);
-xbt_error_t xbt_cfg_rm_string(xbt_cfg_t cfg, const char *name,
- const char *val);
-xbt_error_t xbt_cfg_rm_host (xbt_cfg_t cfg, const char *name,
- const char *host,int port);
+void xbt_cfg_rm_int (xbt_cfg_t cfg, const char *name,
+ int val);
+void xbt_cfg_rm_double(xbt_cfg_t cfg, const char *name,
+ double val);
+void xbt_cfg_rm_string(xbt_cfg_t cfg, const char *name,
+ const char *val);
+void xbt_cfg_rm_host (xbt_cfg_t cfg, const char *name,
+ const char *host,int port);
+
+/*
+ Remove the value at position \e pos from the config \e cfg
+ */
+void xbt_cfg_rm_at (xbt_cfg_t cfg, const char *name, int pos);
/* rm every values */
-xbt_error_t xbt_cfg_empty(xbt_cfg_t cfg, const char *name);
+void xbt_cfg_empty(xbt_cfg_t cfg, const char *name);
/* @} */
/** @name 3. Registering stuff
*/
void xbt_cfg_register(xbt_cfg_t cfg,
const char *name, e_xbt_cfgelm_type_t type,
- int min, int max);
- xbt_error_t xbt_cfg_unregister(xbt_cfg_t cfg, const char *name);
+ int min, int max,
+ xbt_cfg_cb_t cb_set, xbt_cfg_cb_t cb_rm);
+ void xbt_cfg_unregister(xbt_cfg_t cfg, const char *name);
xbt_error_t xbt_cfg_register_str(xbt_cfg_t cfg, const char *entry);
xbt_error_t xbt_cfg_check(xbt_cfg_t cfg);
- xbt_error_t xbt_cfg_get_type(xbt_cfg_t cfg, const char *name,
- /* OUT */ e_xbt_cfgelm_type_t *type);
+ e_xbt_cfgelm_type_t xbt_cfg_get_type(xbt_cfg_t cfg, const char *name);
/* @} */
/** @name 4. Getting the stored values
*
* 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.
+ * 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.
*
* @{
*/
- xbt_error_t xbt_cfg_get_int (xbt_cfg_t cfg, const char *name, int *val);
- xbt_error_t xbt_cfg_get_double(xbt_cfg_t cfg, const char *name, double *val);
- xbt_error_t xbt_cfg_get_string(xbt_cfg_t cfg, const char *name, char **val);
- xbt_error_t xbt_cfg_get_host (xbt_cfg_t cfg, const char *name, char **host, int *port);
- xbt_error_t xbt_cfg_get_dynar (xbt_cfg_t cfg, const char *name, xbt_dynar_t *dynar);
+ int xbt_cfg_get_int (xbt_cfg_t cfg, const char *name);
+ double xbt_cfg_get_double(xbt_cfg_t cfg, const char *name);
+ char* xbt_cfg_get_string(xbt_cfg_t cfg, const char *name);
+ void xbt_cfg_get_host (xbt_cfg_t cfg, const char *name, char **host, int *port);
+ xbt_dynar_t xbt_cfg_get_dynar (xbt_cfg_t cfg, const char *name);
+
+ int xbt_cfg_get_int_at (xbt_cfg_t cfg, const char *name, int pos);
+ double xbt_cfg_get_double_at(xbt_cfg_t cfg, const char *name, int pos);
+ char* xbt_cfg_get_string_at(xbt_cfg_t cfg, const char *name, int pos);
+ void xbt_cfg_get_host_at (xbt_cfg_t cfg, const char *name, int pos, char **host, int *port);
/** @} */
/** @} */