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-2019. 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 #include <xbt/config.hpp>
  59 typedef simgrid::config::Config* xbt_cfg_t;
  60 #else
  61 typedef void* xbt_cfg_t;
  62 #endif
  63
  64 SG_BEGIN_DECL()
  65
  66 /* Set the value of the cell @a name in @a cfg with the provided value.*/
  67 XBT_ATTRIB_DEPRECATED_v325("Please use simgrid::config::set_value<int>") XBT_PUBLIC
  68     void xbt_cfg_set_int(const char* name, int val);
  69 XBT_ATTRIB_DEPRECATED_v325("Please use simgrid::config::set_value<double>") XBT_PUBLIC
  70     void xbt_cfg_set_double(const char* name, double val);
  71 XBT_ATTRIB_DEPRECATED_v325("Please use simgrid::config::set_value<bool>") XBT_PUBLIC
  72     void xbt_cfg_set_boolean(const char* name, const char* val);
  73 XBT_ATTRIB_DEPRECATED_v325("Please use simgrid::config::set_value<std::string>") XBT_PUBLIC
  74     void xbt_cfg_set_string(const char* name, const char* val);
  75
  76 /* @} */
  77
  78 /** @defgroup XBT_cfg_decl Configuration type declaration and memory management
  79  *  @ingroup XBT_config
  80  *
  81  *  @{
  82  */
  83
  84 /** @brief Callback types. They get the name of the modified entry, and the position of the changed value */
  85 typedef void (*xbt_cfg_cb_t)(const char* name);
  86
  87 /** @} */
  88
  89 /** @defgroup XBT_cfg_get Getting the stored values
  90  *  @ingroup XBT_config
  91  *
  92  * This is how to retrieve the values stored in the configuration set. This is only intended to configurable code,
  93  * naturally.
  94  *
  95  * Note that those function return a pointer to the values actually stored in the set. Do not modify them unless you
  96  * really know what you're doing. Likewise, do not free the strings after use, they are not copy of the data, but the
  97  * data themselves.
  98  *
  99  *  @{
 100  */
 101
 102 XBT_ATTRIB_DEPRECATED_v325("Please use simgrid::config::get_value<int>") XBT_PUBLIC
 103     int xbt_cfg_get_int(const char* name);
 104 XBT_ATTRIB_DEPRECATED_v325("Please use simgrid::config::get_value<double>") XBT_PUBLIC
 105     double xbt_cfg_get_double(const char* name);
 106 XBT_ATTRIB_DEPRECATED_v325("Please use simgrid::config::get_value<bool>") XBT_PUBLIC
 107     int xbt_cfg_get_boolean(const char* name);
 108
 109 /** @} */
 110
 111 SG_END_DECL()
 112 #endif /* XBT_CONFIG_H */