include/xbt/config.h

   1 /* config - Dictionary where the type of each cell is provided.             */
   2 /* This is useful to build named structs, like option or property sets.     */
   3
   4 /* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved.          */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9 #ifndef XBT_CONFIG_H
  10 #define XBT_CONFIG_H
  11
  12 #include <stdarg.h>
  13 #include <xbt/base.h>
  14
  15 /** @addtogroup XBT_config
  16  *  @brief Changing the configuration of SimGrid components (grounding feature)
  17  *
  18  *  All modules of the SimGrid toolkit can be configured with this API.
  19  *  User modules and libraries can also use these facilities to handle their own configuration.
  20  *
  21  *  A configuration set contain several \e variables which have a unique name in the set and can take a given type of
  22  *  value. For example, it may contain a \a size variable, accepting \e int values.
  23  *
  24  *  It is impossible to set a value to a variable which has not been registered before.
  25  *  Usually, the module registers all the options it accepts in the configuration set, during its initialization and
  26  *  user code then set and unset values.
  27  *
  28  *  The easiest way to register a variable is to use the xbt_str_register_str function, which accepts a string
  29  *  representation of the config element descriptor. The syntax is the following:
  30  *  \verbatim <name>:<min nb>_to_<max nb>_<type>\endverbatim
  31  *
  32  *  For example, <tt>size:1_to_1_int</tt> describes a variable called \e size which must take exactly one value, and
  33  *  the value being an integer. Set the maximum to 0 to disable the upper bound on data count.
  34  *
  35  *  Another example could be <tt>outputfiles:0_to_10_string</tt> which describes a variable called \e outputfiles and
  36  *  which can take between 0 and 10 strings as value.
  37  *
  38  *  To some extend, configuration sets can be seen as typed hash structures.
  39  *
  40  *  \section XBT_cfg_ex Example of use
  41  *
  42  *  TBD
  43  */
  44 /** @defgroup XBT_cfg_use User interface: changing values
  45  *  @ingroup XBT_config
  46  *
  47  * This is the only interface you should use unless you want to let your own code become configurable with this.
  48  *
  49  * If the variable accept at most one value, those functions replace the current value with the provided one. If max>1,
  50  * the provided value is appended to the list.
  51  *
  52  * string values are strdup'ed before use, so you can (and should) free your copy
  53  *
  54  * @{
  55  */
  56 /** @brief Configuration set's data type is opaque. */
  57 #ifdef __cplusplus
  58 namespace simgrid {
  59 namespace config {
  60 class Config;
  61 }
  62 }
  63 typedef simgrid::config::Config* xbt_cfg_t;
  64 #else
  65 typedef void* xbt_cfg_t;
  66 #endif
  67
  68 SG_BEGIN_DECL()
  69
  70 XBT_PUBLIC(void) xbt_cfg_set_parse(const char *options);
  71
  72 /* Set the value of the cell \a name in \a cfg with the provided value.*/
  73 XBT_PUBLIC(void) xbt_cfg_set_int       (const char *name, int val);
  74 XBT_PUBLIC(void) xbt_cfg_set_double    (const char *name, double val);
  75 XBT_PUBLIC(void) xbt_cfg_set_boolean   (const char *name, const char *val);
  76 XBT_PUBLIC(void) xbt_cfg_set_as_string(const char *name, const char *val);
  77
  78 /*
  79   Set the default value of the cell \a name in \a cfg with the provided value.
  80   If it was already set to something (possibly from the command line), do nothing.
  81  */
  82 XBT_PUBLIC(void) xbt_cfg_setdefault_int    (const char *name, int val);
  83 XBT_PUBLIC(void) xbt_cfg_setdefault_double (const char *name, double val);
  84 XBT_PUBLIC(void) xbt_cfg_setdefault_string (const char *name, const char *val);
  85 XBT_PUBLIC(void) xbt_cfg_setdefault_boolean(const char *name, const char *val);
  86
  87 /** @brief Return if configuration is set by default*/
  88 XBT_PUBLIC(int) xbt_cfg_is_default_value(const char *name);
  89
  90 /* @} */
  91
  92 /** @defgroup XBT_cfg_decl Configuration type declaration and memory management
  93  *  @ingroup XBT_config
  94  *
  95  *  @{
  96  */
  97
  98 /** \brief Callback types. They get the name of the modified entry, and the position of the changed value */
  99 typedef void (*xbt_cfg_cb_t) (const char * name);
 100
 101 XBT_PUBLIC(xbt_cfg_t) xbt_cfg_new();
 102 XBT_PUBLIC(void) xbt_cfg_free(xbt_cfg_t * cfg);
 103 XBT_PUBLIC(void) xbt_cfg_dump(const char *name, const char *indent, xbt_cfg_t cfg);
 104
 105  /** @} */
 106
 107 /** @defgroup XBT_cfg_register  Registering stuff
 108  *  @ingroup XBT_config
 109  *
 110  *  This how to add new variables to an existing configuration set. Use it to make your code configurable.
 111  *
 112  *  @{
 113  */
 114 XBT_PUBLIC(void) xbt_cfg_register_double (const char *name, double default_val,    xbt_cfg_cb_t cb_set, const char *desc);
 115 XBT_PUBLIC(void) xbt_cfg_register_int    (const char *name, int default_val,       xbt_cfg_cb_t cb_set, const char *desc);
 116 XBT_PUBLIC(void) xbt_cfg_register_string (const char *name, const char*default_val,xbt_cfg_cb_t cb_set, const char *desc);
 117 XBT_PUBLIC(void) xbt_cfg_register_boolean(const char *name, const char*default_val,xbt_cfg_cb_t cb_set, const char *desc);
 118 XBT_PUBLIC(void) xbt_cfg_register_alias(const char *newname, const char *oldname);
 119
 120 XBT_PUBLIC(void) xbt_cfg_aliases();
 121 XBT_PUBLIC(void) xbt_cfg_help();
 122
 123 /*  @} */
 124 /** @defgroup XBT_cfg_get Getting the stored values
 125  *  @ingroup XBT_config
 126  *
 127  * This is how to retrieve the values stored in the configuration set. This is only intended to configurable code,
 128  * naturally.
 129  *
 130  * Note that those function return a pointer to the values actually stored in the set. Do not modify them unless you
 131  * really know what you're doing. Likewise, do not free the strings after use, they are not copy of the data, but the
 132  * data themselves.
 133  *
 134  *  @{
 135  */
 136
 137 XBT_PUBLIC(int)    xbt_cfg_get_int(const char *name);
 138 XBT_PUBLIC(double) xbt_cfg_get_double(const char *name);
 139 XBT_PUBLIC(int)    xbt_cfg_get_boolean(const char *name);
 140
 141 /** @} */
 142
 143 SG_END_DECL()
 144 #endif /* XBT_CONFIG_H */