make MSG_config public, document it, and implement it properly, not through a crude...

[simgrid.git] / include / xbt / config.h

diff --git a/include/xbt/config.h b/include/xbt/config.h
index 43bf825..67c25bc 100644 (file)
--- a/include/xbt/config.h
+++ b/include/xbt/config.h
@@ -1,10 +1,9 @@
-/* $Id$ */
-
 /* config - Dictionary where the type of each cell is provided.            */
 
 /* This is useful to build named structs, like option or property sets.     */
 
-/* Copyright (c) 2001,2002,2003,2004 Martin Quinson. All rights reserved.   */
+/* Copyright (c) 2004, 2005, 2006, 2007, 2009, 2010. The SimGrid Team.
+ * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -45,8 +44,6 @@ SG_BEGIN_DECL()
  *
  *  To some extend, configuration sets can be seen as typed hash structures.
  *
- *  \todo This great mechanism is not used in SimGrid yet...
- *
  *
  *  \section XBT_cfg_ex Example of use
  *
@@ -89,8 +86,8 @@ SG_BEGIN_DECL()
  *
  * @{
  */
-  /** @brief Configuration set are only special dynars. But don't rely on it, it may change. */
-     typedef xbt_dynar_t xbt_cfg_t;
+/** @brief Configuration set's data type is opaque. */
+typedef void* xbt_cfg_t;
 
 XBT_PUBLIC(void) xbt_cfg_set(xbt_cfg_t cfg, const char *name, ...);
 XBT_PUBLIC(void) xbt_cfg_set_vargs(xbt_cfg_t cfg, const char *name,
@@ -108,15 +105,20 @@ XBT_PUBLIC(void) xbt_cfg_set_string(xbt_cfg_t cfg, const char *name,
                                     const char *val);
 XBT_PUBLIC(void) xbt_cfg_set_peer(xbt_cfg_t cfg, const char *name,
                                   const char *peer, int port);
+XBT_PUBLIC(void*) xbt_cfg_set_as_string(xbt_cfg_t cfg, const char *name, const char *val);
 
 /*
   Set the default value of the cell \a name in \a cfg with the provided value.
   If it was already set to something (possibly from the command line), do nothing.
  */
-XBT_PUBLIC(void) xbt_cfg_setdefault_int(xbt_cfg_t cfg, const char *name, int val);
-XBT_PUBLIC(void) xbt_cfg_setdefault_double(xbt_cfg_t cfg, const char *name, double val);
-XBT_PUBLIC(void) xbt_cfg_setdefault_string(xbt_cfg_t cfg, const char *name, const char* val);
-XBT_PUBLIC(void) xbt_cfg_setdefault_peer(xbt_cfg_t cfg, const char *name, const char* host, int port);
+XBT_PUBLIC(void) xbt_cfg_setdefault_int(xbt_cfg_t cfg, const char *name,
+                                        int val);
+XBT_PUBLIC(void) xbt_cfg_setdefault_double(xbt_cfg_t cfg, const char *name,
+                                           double val);
+XBT_PUBLIC(void) xbt_cfg_setdefault_string(xbt_cfg_t cfg, const char *name,
+                                           const char *val);
+XBT_PUBLIC(void) xbt_cfg_setdefault_peer(xbt_cfg_t cfg, const char *name,
+                                         const char *host, int port);
 
 
 /*
@@ -138,6 +140,9 @@ XBT_PUBLIC(void) xbt_cfg_rm_at(xbt_cfg_t cfg, const char *name, int pos);
 /* rm every values */
 XBT_PUBLIC(void) xbt_cfg_empty(xbt_cfg_t cfg, const char *name);
 
+/* Return if configuration is set by default*/
+XBT_PUBLIC(int) xbt_cfg_is_default_value(xbt_cfg_t cfg, const char *name);
+
 /* @} */
 
 /** @defgroup XBT_cfg_decl Configuration type declaration and memory management
@@ -147,24 +152,25 @@ XBT_PUBLIC(void) xbt_cfg_empty(xbt_cfg_t cfg, const char *name);
  */
 
   /** @brief possible content of each configuration cell */
-     typedef enum {
-       xbt_cfgelm_int = 0,
+typedef enum {
+  xbt_cfgelm_int = 0,
                        /**< int */
-       xbt_cfgelm_double,
+  xbt_cfgelm_double,
                        /**< double */
-       xbt_cfgelm_string,
+  xbt_cfgelm_string,
                        /**< char* */
-       xbt_cfgelm_peer,/**< both a char* (representing the peername) and an integer (representing the port) */
+  xbt_cfgelm_peer,     /**< both a char* (representing the peername) 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;
+  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);
+/** \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_PUBLIC(xbt_cfg_t) xbt_cfg_new(void);
-XBT_PUBLIC(void) xbt_cfg_cpy(xbt_cfg_t tocopy, /* OUT */ xbt_cfg_t * whereto);
+XBT_PUBLIC(void) xbt_cfg_cpy(xbt_cfg_t tocopy,  /* OUT */
+                             xbt_cfg_t * whereto);
 XBT_PUBLIC(void) xbt_cfg_free(xbt_cfg_t * cfg);
 XBT_PUBLIC(void) xbt_cfg_dump(const char *name, const char *indent,
                               xbt_cfg_t cfg);
@@ -180,7 +186,8 @@ XBT_PUBLIC(void) xbt_cfg_dump(const char *name, const char *indent,
  *  @{
  */
 XBT_PUBLIC(void) xbt_cfg_register(xbt_cfg_t * cfg,
-                                  const char *name, const char *description,
+                                  const char *name,
+                                  const char *description,
                                   e_xbt_cfgelm_type_t type,
                                   void *default_value, int min, int max,
                                   xbt_cfg_cb_t cb_set, xbt_cfg_cb_t cb_rm);
@@ -212,15 +219,16 @@ XBT_PUBLIC(void) xbt_cfg_get_peer(xbt_cfg_t cfg, const char *name,
                                   char **peer, int *port);
 XBT_PUBLIC(xbt_dynar_t) xbt_cfg_get_dynar(xbt_cfg_t cfg, const char *name);
 
-XBT_PUBLIC(int) xbt_cfg_get_int_at(xbt_cfg_t cfg, const char *name, int pos);
+XBT_PUBLIC(int) xbt_cfg_get_int_at(xbt_cfg_t cfg, const char *name,
+                                   int pos);
 XBT_PUBLIC(double) xbt_cfg_get_double_at(xbt_cfg_t cfg, const char *name,
                                          int pos);
 XBT_PUBLIC(char *) xbt_cfg_get_string_at(xbt_cfg_t cfg, const char *name,
                                          int pos);
-XBT_PUBLIC(void) xbt_cfg_get_peer_at(xbt_cfg_t cfg, const char *name, int pos,
-                                     char **peer, int *port);
+XBT_PUBLIC(void) xbt_cfg_get_peer_at(xbt_cfg_t cfg, const char *name,
+                                     int pos, char **peer, int *port);
 
 /** @} */
 
 SG_END_DECL()
-#endif /* _XBT_CONFIG_H_ */
+#endif                          /* _XBT_CONFIG_H_ */