Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
implement some more getters in surf::Link and s4u::Link
[simgrid.git] / include / xbt / config.h
index 090fa45..4ad8e1f 100644 (file)
@@ -1,20 +1,16 @@
-/* config - Dictionary where the type of each cell is provided.            */
-
+/* config - Dictionary where the type of each cell is provided.             */
 /* This is useful to build named structs, like option or property sets.     */
 
-/* Copyright (c) 2004-2007, 2009-2014. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2004-2017. 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. */
 
-#ifndef _XBT_CONFIG_H_
-#define _XBT_CONFIG_H_
+#ifndef XBT_CONFIG_H
+#define XBT_CONFIG_H
 
-#include "xbt/dynar.h"
 #include <stdarg.h>
-
-SG_BEGIN_DECL()
+#include <xbt/base.h>
 
 /** @addtogroup XBT_config
  *  @brief Changing the configuration of SimGrid components (grounding feature)
@@ -43,27 +39,7 @@ SG_BEGIN_DECL()
  *
  *  \section XBT_cfg_ex Example of use
  *
- *  \dontinclude config.c
- *
- *  First, let's create a configuration set with some registered variables.
- *  This must be done by the configurable library before the user interactions.
- *
- *  \skip make_set
- *  \until end_of_make_set
- *
- *  Now, set and get a single value
- *  \skip get_single_value
- *  \skip int
- *  \until cfg_free
- *
- *  And now, set and get a multiple value
- *  \skip get_multiple_value
- *  \skip dyn
- *  \until cfg_free
- *
- *  All those functions throws mismatch_error if asked to deal with an  unregistered variable.
- *  \skip myset
- *  \until cfg_free
+ *  TBD
  */
 /** @defgroup XBT_cfg_use User interface: changing values
  *  @ingroup XBT_config
@@ -78,18 +54,27 @@ SG_BEGIN_DECL()
  * @{
  */
 /** @brief Configuration set's data type is opaque. */
+#ifdef __cplusplus
+namespace simgrid {
+namespace config {
+class Config;
+}
+}
+typedef simgrid::config::Config* xbt_cfg_t;
+#else
 typedef void* xbt_cfg_t;
+#endif
+
+SG_BEGIN_DECL()
 
-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, va_list pa);
 XBT_PUBLIC(void) xbt_cfg_set_parse(const char *options);
 
 /* Set the value of the cell \a name in \a cfg with the provided value.*/
 XBT_PUBLIC(void) xbt_cfg_set_int       (const char *name, int val);
 XBT_PUBLIC(void) xbt_cfg_set_double    (const char *name, double val);
-XBT_PUBLIC(void) xbt_cfg_set_string    (const char *name, const char *val);
 XBT_PUBLIC(void) xbt_cfg_set_boolean   (const char *name, const char *val);
-XBT_PUBLIC(void*) xbt_cfg_set_as_string(const char *name, const char *val);
+XBT_PUBLIC(void) xbt_cfg_set_string(const char* name, const char* val);
+XBT_PUBLIC(void) xbt_cfg_set_as_string(const char *name, const char *val);
 
 /*
   Set the default value of the cell \a name in \a cfg with the provided value.
@@ -111,30 +96,10 @@ XBT_PUBLIC(int) xbt_cfg_is_default_value(const char *name);
  *  @{
  */
 
-  /** @brief possible content of each configuration cell */
-typedef enum {
-  xbt_cfgelm_int = 0,                    /**< int */
-  xbt_cfgelm_double,                     /**< double */
-  xbt_cfgelm_string,                    /**< char* */
-  xbt_cfgelm_boolean,                   /**< int */
-  xbt_cfgelm_alias,    /**< redirection from a deprecated name to a better one */
-  //! @cond
-  xbt_cfgelm_any,               /* not shown to users to prevent errors */
-  xbt_cfgelm_type_count
-  //! @endcond
-} e_xbt_cfgelm_type_t;
-
-/** Boolean possible values **/
-struct xbt_boolean_couple {
-  const char *true_val;
-  const char *false_val;
-};
-
 /** \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 *);
+typedef void (*xbt_cfg_cb_t) (const char * name);
 
-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(xbt_cfg_t) xbt_cfg_new();
 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);
 
@@ -147,16 +112,15 @@ XBT_PUBLIC(void) xbt_cfg_dump(const char *name, const char *indent, xbt_cfg_t cf
  *
  *  @{
  */
-XBT_PUBLIC(void) xbt_cfg_register_double (const char *name, const char *desc, double default_val,    xbt_cfg_cb_t cb_set);
-XBT_PUBLIC(void) xbt_cfg_register_int    (const char *name, const char *desc, int default_val,       xbt_cfg_cb_t cb_set);
-XBT_PUBLIC(void) xbt_cfg_register_string (const char *name, const char *desc, const char*default_val,xbt_cfg_cb_t cb_set);
-XBT_PUBLIC(void) xbt_cfg_register_boolean(const char *name, const char *desc, const char*default_val,xbt_cfg_cb_t cb_set);
+XBT_PUBLIC(void) xbt_cfg_register_double (const char *name, double default_val,    xbt_cfg_cb_t cb_set, const char *desc);
+XBT_PUBLIC(void) xbt_cfg_register_int    (const char *name, int default_val,       xbt_cfg_cb_t cb_set, const char *desc);
+XBT_PUBLIC(void) xbt_cfg_register_string (const char *name, const char*default_val,xbt_cfg_cb_t cb_set, const char *desc);
+XBT_PUBLIC(void) xbt_cfg_register_boolean(const char *name, const char*default_val,xbt_cfg_cb_t cb_set, const char *desc);
 XBT_PUBLIC(void) xbt_cfg_register_alias(const char *newname, const char *oldname);
-XBT_PUBLIC(void) xbt_cfg_register_str(xbt_cfg_t * cfg, const char *entry);
 
-XBT_PUBLIC(void) xbt_cfg_aliases(void);
-XBT_PUBLIC(void) xbt_cfg_help(void);
-XBT_PUBLIC(e_xbt_cfgelm_type_t) xbt_cfg_get_type(xbt_cfg_t cfg, const char *name);
+XBT_PUBLIC(void) xbt_cfg_aliases();
+XBT_PUBLIC(void) xbt_cfg_help();
+
 /*  @} */
 /** @defgroup XBT_cfg_get Getting the stored values
  *  @ingroup XBT_config
@@ -173,10 +137,9 @@ XBT_PUBLIC(e_xbt_cfgelm_type_t) xbt_cfg_get_type(xbt_cfg_t cfg, const char *name
 
 XBT_PUBLIC(int)    xbt_cfg_get_int(const char *name);
 XBT_PUBLIC(double) xbt_cfg_get_double(const char *name);
-XBT_PUBLIC(char *) xbt_cfg_get_string(const char *name);
 XBT_PUBLIC(int)    xbt_cfg_get_boolean(const char *name);
 
 /** @} */
 
 SG_END_DECL()
-#endif                          /* _XBT_CONFIG_H_ */
+#endif /* XBT_CONFIG_H */