include/conf.h

   1 /**
   2  *  \defgroup Config Configuration Interface
   3  *  Configuration Interface
   4  *  \{
   5  */
   6
   7 /** Config node type */
   8 typedef enum _snd_config_type {
   9         /** Integer number */
  10         SND_CONFIG_TYPE_INTEGER,
  11         /** Real number */
  12         SND_CONFIG_TYPE_REAL,
  13         /** Character string */
  14         SND_CONFIG_TYPE_STRING,
  15         /** Compound */
  16         SND_CONFIG_TYPE_COMPOUND,
  17 } snd_config_type_t;
  18
  19 /** Config node handle */
  20 typedef struct _snd_config snd_config_t;
  21 /** Config compound iterator */
  22 typedef struct _snd_config_iterator *snd_config_iterator_t;
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif
  27
  28 int snd_config_top(snd_config_t **config);
  29
  30 int snd_config_load(snd_config_t *config, snd_input_t *in);
  31 int snd_config_save(snd_config_t *config, snd_output_t *out);
  32
  33 int snd_config_search(snd_config_t *config, const char *key,
  34                       snd_config_t **result);
  35 int snd_config_searchv(snd_config_t *config,
  36                        snd_config_t **result, ...);
  37 int snd_config_search_alias(snd_config_t *config,
  38                             const char *base, const char *key,
  39                             snd_config_t **result);
  40
  41 int snd_config_expand(snd_config_t *config, const char *args,
  42                       void *private_data, snd_config_t **result);
  43
  44 int snd_config_add(snd_config_t *config, snd_config_t *leaf);
  45 int snd_config_delete(snd_config_t *config);
  46 int snd_config_copy(snd_config_t **dst, snd_config_t *src);
  47
  48 int snd_config_make(snd_config_t **config, const char *key,
  49                     snd_config_type_t type);
  50 int snd_config_make_integer(snd_config_t **config, const char *key);
  51 int snd_config_make_real(snd_config_t **config, const char *key);
  52 int snd_config_make_string(snd_config_t **config, const char *key);
  53 int snd_config_make_compound(snd_config_t **config, const char *key, int join);
  54
  55 int snd_config_set_id(snd_config_t *config, const char *id);
  56 int snd_config_set_integer(snd_config_t *config, long value);
  57 int snd_config_set_real(snd_config_t *config, double value);
  58 int snd_config_set_string(snd_config_t *config, const char *value);
  59 int snd_config_set_ascii(snd_config_t *config, const char *ascii);
  60 int snd_config_get_integer(snd_config_t *config, long *value);
  61 int snd_config_get_real(snd_config_t *config, double *value);
  62 int snd_config_get_string(snd_config_t *config, const char **value);
  63 int snd_config_get_ascii(snd_config_t *config, char **value);
  64
  65 snd_config_iterator_t snd_config_iterator_first(snd_config_t *node);
  66 snd_config_iterator_t snd_config_iterator_next(snd_config_iterator_t iterator);
  67 snd_config_iterator_t snd_config_iterator_end(snd_config_t *node);
  68 snd_config_t *snd_config_iterator_entry(snd_config_iterator_t iterator);
  69
  70 /** Helper for compound config node leaves traversal
  71  * \param pos Current node iterator
  72  * \param next Next node iterator
  73  * \param node Compound config node
  74  *
  75  * This macro is designed to permit the removal of current node.
  76  */
  77 #define snd_config_for_each(pos, next, node) \
  78         for (pos = snd_config_iterator_first(node), next = snd_config_iterator_next(pos); pos != snd_config_iterator_end(node); pos = next, next = snd_config_iterator_next(pos))
  79
  80 snd_config_type_t snd_config_get_type(snd_config_t *config);
  81 const char *snd_config_get_id(snd_config_t *config);
  82
  83 extern snd_config_t *snd_config;
  84 int snd_config_update(void);
  85
  86 /* Misc functions */
  87
  88 int snd_config_get_bool_ascii(const char *ascii);
  89 int snd_config_get_bool(snd_config_t *conf);
  90 int snd_config_get_ctl_iface_ascii(const char *ascii);
  91 int snd_config_get_ctl_iface(snd_config_t *conf);
  92
  93 typedef int (snd_config_string_replace_callback_t)(const char *what, char **dst, void *private_data);
  94
  95 int snd_config_string_replace(const char *src, char idchr,
  96                               snd_config_string_replace_callback_t *callback,
  97                               void *private_data,
  98                               char **dst);
  99 int snd_config_refer_load(snd_config_t *root,
 100                           snd_config_t *config,
 101                           char **name,
 102                           snd_config_t **dst_config,
 103                           int *dst_dynamic);
 104
 105 #ifdef __cplusplus
 106 }
 107 #endif
 108
 109 /** \} */
 110