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 BEGIN_DECL()
  18
  19 /** @addtogroup XBT_config
  20  *
  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.
  24  *
  25  *  A configuration set contain several \e variables which have a unique 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  *
  29  *  It is impossible to set a value to a variable which has not been registered before.
  30  *  Usually, the module registers all the options it accepts in the configuration set,
  31  *  during its initialization and user code then set and unset values.
  32  *
  33  *  The easiest way to register a variable is to use the xbt_str_register_str function,
  34  *  which accepts a string representation of the config element descriptor. The syntax
  35  *  is the following: \verbatim <name>:<min nb>_to_<max nb>_<type>\endverbatim
  36  *
  37  *  For example, <tt>size:1_to_1_int</tt> describes a variable called \e size which
  38  *  must take exactly one value, and the value being an integer.
  39  *
  40  *  Another example could be <tt>outputfiles:0_to_10_string</tt> which describes a variable
  41  *  called \e outputfiles and which can take between 0 and 10 strings as value.
  42  *
  43  *  To some extend, configuration sets can be seen as typed hash structures.
  44  *
  45  *  \todo This great mechanism is not used in SimGrid yet...
  46  *
  47  *  \todo We need a callback mechanism so that the configurable code get
  48  *  notified of configuration changes.
  49  *
  50  *  \section XBT_cfg_ex Example
  51  *
  52  *  \dontinclude config_usage.c
  53  *
  54  *  First, let's create a configuration set with some registered variables.
  55  *  This must be done by the configurable library before the user interactions.
  56  *
  57  *  \skip make_set
  58  *  \until end_of_make_set
  59  *
  60  *  Now, set and get a single value
  61  *  \skip get_single_value
  62  *  \skip int
  63  *  \until cfg_free
  64  *
  65  *  And now, set and get a multiple value
  66  *  \skip get_multiple_value
  67  *  \skip dyn
  68  *  \until cfg_free
  69  *
  70  *  All those functions throws mismatch_error if asked to deal with an
  71  *  unregistered variable.
  72  *  \skip myset
  73  *  \until cfg_free
  74  *  @{
  75  */
  76
  77 /** @name 1. Type declaration and memory management
  78  *
  79  *
  80  *
  81  *  @{
  82  */
  83   /** @brief Configuration set are only special dynars. But don't rely on it, it may change. */
  84   typedef xbt_dynar_t xbt_cfg_t;
  85
  86   /** @brief possible content of each configuration cell */
  87   typedef enum {
  88     xbt_cfgelm_int=0,  /**< int */
  89     xbt_cfgelm_double, /**< double */
  90     xbt_cfgelm_string, /**< char* */
  91     xbt_cfgelm_host,   /**< both a char* (representing the hostname) and an integer (representing the port) */
  92     xbt_cfgelm_type_count
  93   } e_xbt_cfgelm_type_t;
  94
  95   xbt_cfg_t xbt_cfg_new (void);
  96   void xbt_cfg_cpy(xbt_cfg_t tocopy, /* OUT */ xbt_cfg_t *whereto);
  97   void xbt_cfg_free(xbt_cfg_t *cfg);
  98   void xbt_cfg_dump(const char *name,const char*indent,xbt_cfg_t cfg);
  99
 100  /** @} */
 101
 102 /** @name 2. User interface: changing values
 103  *
 104  * This is the only interface you should use unless you want to let your
 105  * own code become configurable with this.
 106  *
 107  * If the variable accept at most one value, those functions replace the
 108  * current value with the provided one. If max>1, the provided value is
 109  * appended to the list.
 110  *
 111  * string values are strdup'ed before use, so you can (and should) free
 112  * your copy
 113  *
 114  * @{
 115  */
 116
 117   xbt_error_t xbt_cfg_set(xbt_cfg_t cfg, ...);
 118   xbt_error_t xbt_cfg_set_vargs(xbt_cfg_t cfg, va_list pa);
 119   xbt_error_t xbt_cfg_set_parse(xbt_cfg_t cfg, const char *options);
 120
 121
 122 /*
 123   Set the value of the cell \a name in \a cfg with the provided value.
 124  */
 125 xbt_error_t xbt_cfg_set_int   (xbt_cfg_t cfg, const char *name,
 126                                  int val);
 127 xbt_error_t xbt_cfg_set_double(xbt_cfg_t cfg, const char *name,
 128                                  double val);
 129 xbt_error_t xbt_cfg_set_string(xbt_cfg_t cfg, const char *name,
 130                                  const char *val);
 131 xbt_error_t xbt_cfg_set_host  (xbt_cfg_t cfg, const char *name,
 132                                  const char *host,int port);
 133
 134 /*
 135  Remove the provided value from the cell @name in @cfg.
 136  */
 137 xbt_error_t xbt_cfg_rm_int   (xbt_cfg_t cfg, const char *name,
 138                                 int val);
 139 xbt_error_t xbt_cfg_rm_double(xbt_cfg_t cfg, const char *name,
 140                                 double val);
 141 xbt_error_t xbt_cfg_rm_string(xbt_cfg_t cfg, const char *name,
 142                                 const char *val);
 143 xbt_error_t xbt_cfg_rm_host  (xbt_cfg_t cfg, const char *name,
 144                                 const char *host,int port);
 145
 146 /* rm every values */
 147 xbt_error_t xbt_cfg_empty(xbt_cfg_t cfg, const char *name);
 148
 149 /* @} */
 150 /** @name 3.  Registering stuff
 151  *
 152  *  This how to add new variables to an existing configuration set. Use it to make your code
 153  *  configurable.
 154  *
 155  *  @{
 156  */
 157   void xbt_cfg_register(xbt_cfg_t cfg,
 158                         const char *name, e_xbt_cfgelm_type_t type,
 159                         int min, int max);
 160   xbt_error_t xbt_cfg_unregister(xbt_cfg_t cfg, const char *name);
 161   xbt_error_t xbt_cfg_register_str(xbt_cfg_t cfg, const char *entry);
 162   xbt_error_t xbt_cfg_check(xbt_cfg_t cfg);
 163   xbt_error_t xbt_cfg_get_type(xbt_cfg_t cfg, const char *name,
 164                                /* OUT */ e_xbt_cfgelm_type_t *type);
 165 /*  @} */
 166 /** @name 4. Getting the stored values
 167  *
 168  * This is how to retrieve the values stored in the configuration set. This is only
 169  * intended to configurable code, naturally.
 170  *
 171  * Note that those function return a pointer to the values actually stored
 172  * in the set. Do not modify them unless you really know what you're doing.
 173  *
 174  *  @{
 175  */
 176
 177   xbt_error_t xbt_cfg_get_int   (xbt_cfg_t cfg, const char *name, int    *val);
 178   xbt_error_t xbt_cfg_get_double(xbt_cfg_t cfg, const char *name, double *val);
 179   xbt_error_t xbt_cfg_get_string(xbt_cfg_t cfg, const char *name, char  **val);
 180   xbt_error_t xbt_cfg_get_host  (xbt_cfg_t cfg, const char *name, char  **host, int *port);
 181   xbt_error_t xbt_cfg_get_dynar (xbt_cfg_t cfg, const char *name, xbt_dynar_t *dynar);
 182
 183 /** @} */
 184 /** @} */
 185 END_DECL()
 186
 187 #endif /* _XBT_CONFIG_H_ */