OSDN Git Service

Documented input, output and conf
[android-x86/external-alsa-lib.git] / include / conf.h
1
2 /** Config node type */
3 typedef enum _snd_config_type {
4         /** Integer number */
5         SND_CONFIG_TYPE_INTEGER,
6         /** Real number */
7         SND_CONFIG_TYPE_REAL,
8         /** Character string */
9         SND_CONFIG_TYPE_STRING,
10         /** Compound */
11         SND_CONFIG_TYPE_COMPOUND,
12 } snd_config_type_t;
13
14 /** Config node handle */
15 typedef struct _snd_config snd_config_t;
16 /** Config compound iterator */
17 typedef struct _snd_config_iterator *snd_config_iterator_t;
18
19 #ifdef __cplusplus
20 extern "C" {
21 #endif
22
23 snd_config_type_t snd_config_get_type(snd_config_t *config);
24 const char *snd_config_get_id(snd_config_t *config);
25
26 int snd_config_top(snd_config_t **config);
27
28 int snd_config_load(snd_config_t *config, snd_input_t *in);
29 int snd_config_save(snd_config_t *config, snd_output_t *out);
30
31 int snd_config_search(snd_config_t *config, const char *key,
32                       snd_config_t **result);
33 int snd_config_searchv(snd_config_t *config, 
34                        snd_config_t **result, ...);
35 int snd_config_search_alias(snd_config_t *config,
36                             const char *base, const char *key,
37                             snd_config_t **result);
38
39 int snd_config_add(snd_config_t *config, snd_config_t *leaf);
40 int snd_config_delete(snd_config_t *config);
41
42 int snd_config_make(snd_config_t **config, const char *key,
43                     snd_config_type_t type);
44 int snd_config_make_integer(snd_config_t **config, const char *key);
45 int snd_config_make_real(snd_config_t **config, const char *key);
46 int snd_config_make_string(snd_config_t **config, const char *key);
47 int snd_config_make_compound(snd_config_t **config, const char *key, int join);
48
49 int snd_config_set_integer(snd_config_t *config, long value);
50 int snd_config_set_real(snd_config_t *config, double value);
51 int snd_config_set_string(snd_config_t *config, const char *value);
52 int snd_config_get_integer(snd_config_t *config, long *value);
53 int snd_config_get_real(snd_config_t *config, double *value);
54 int snd_config_get_string(snd_config_t *config, const char **value);
55
56 snd_config_iterator_t snd_config_iterator_first(snd_config_t *node);
57 snd_config_iterator_t snd_config_iterator_next(snd_config_iterator_t iterator);
58 snd_config_iterator_t snd_config_iterator_end(snd_config_t *node);
59 snd_config_t *snd_config_iterator_entry(snd_config_iterator_t iterator);
60
61 /** Helper for compound config node leaves traversal
62  * \param pos Current node iterator
63  * \param next Next node iterator
64  * \param node Compound config node
65  *
66  * This macro is designed to permit the removal of current node.
67  */
68 #define snd_config_for_each(pos, next, node) \
69         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))
70
71 snd_config_type_t snd_config_get_type(snd_config_t *config);
72 const char *snd_config_get_id(snd_config_t *config);
73
74 extern snd_config_t *snd_config;
75 int snd_config_update();
76
77 #ifdef __cplusplus
78 }
79 #endif
80