Constify the result of a config retrieval function, to avoid mutilation (issue 7983).
[asterisk/asterisk.git] / include / asterisk / config.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  * \brief Configuration File Parser
21  */
22
23 #ifndef _ASTERISK_CONFIG_H
24 #define _ASTERISK_CONFIG_H
25
26 #if defined(__cplusplus) || defined(c_plusplus)
27 extern "C" {
28 #endif
29
30 #include <stdarg.h>
31
32 struct ast_config;
33
34 struct ast_category;
35
36 struct ast_variable {
37         char *name;
38         char *value;
39         int lineno;
40         int object;             /*!< 0 for variable, 1 for object */
41         int blanklines;         /*!< Number of blanklines following entry */
42         struct ast_comment *precomments;
43         struct ast_comment *sameline;
44         struct ast_variable *next;
45         char stuff[0];
46 };
47
48 typedef struct ast_config *config_load_func(const char *database, const char *table, const char *configfile, struct ast_config *config, int withcomments);
49 typedef struct ast_variable *realtime_var_get(const char *database, const char *table, va_list ap);
50 typedef struct ast_config *realtime_multi_get(const char *database, const char *table, va_list ap);
51 typedef int realtime_update(const char *database, const char *table, const char *keyfield, const char *entity, va_list ap);
52
53 struct ast_config_engine {
54         char *name;
55         config_load_func *load_func;
56         realtime_var_get *realtime_func;
57         realtime_multi_get *realtime_multi_func;
58         realtime_update *update_func;
59         struct ast_config_engine *next;
60 };
61
62 /*! \brief Load a config file 
63  * \param filename path of file to open.  If no preceding '/' character, path is considered relative to AST_CONFIG_DIR
64  * Create a config structure from a given configuration file.
65  *
66  * Returns NULL on error, or an ast_config data structure on success
67  */
68 struct ast_config *ast_config_load(const char *filename);
69 struct ast_config *ast_config_load_with_comments(const char *filename);
70
71 /*! \brief Destroys a config 
72  * \param config pointer to config data structure
73  * Free memory associated with a given config
74  *
75  */
76 void ast_config_destroy(struct ast_config *config);
77
78 /*! \brief Goes through categories 
79  * \param config Which config structure you wish to "browse"
80  * \param prev A pointer to a previous category.
81  * This funtion is kind of non-intuitive in it's use.  To begin, one passes NULL as the second arguement.  It will return a pointer to the string of the first category in the file.  From here on after, one must then pass the previous usage's return value as the second pointer, and it will return a pointer to the category name afterwards.
82  *
83  * Returns a category on success, or NULL on failure/no-more-categories
84  */
85 char *ast_category_browse(struct ast_config *config, const char *prev);
86
87 /*! \brief Goes through variables
88  * Somewhat similar in intent as the ast_category_browse.
89  * List variables of config file category
90  *
91  * Returns ast_variable list on success, or NULL on failure
92  */
93 struct ast_variable *ast_variable_browse(const struct ast_config *config, const char *category);
94
95 /*! \brief Gets a variable 
96  * \param config which (opened) config to use
97  * \param category category under which the variable lies
98  * \param variable which variable you wish to get the data for
99  * Goes through a given config file in the given category and searches for the given variable
100  *
101  * Returns the variable value on success, or NULL if unable to find it.
102  */
103 const char *ast_variable_retrieve(const struct ast_config *config, const char *category, const char *variable);
104
105 /*! \brief Retrieve a category if it exists
106  * \param config which config to use
107  * \param category_name name of the category you're looking for
108  * This will search through the categories within a given config file for a match.
109  *
110  * Returns pointer to category if found, NULL if not.
111  */
112 struct ast_category *ast_category_get(const struct ast_config *config, const char *category_name);
113
114 /*! \brief Check for category duplicates 
115  * \param config which config to use
116  * \param category_name name of the category you're looking for
117  * This will search through the categories within a given config file for a match.
118  *
119  * Return non-zero if found
120  */
121 int ast_category_exist(const struct ast_config *config, const char *category_name);
122
123 /*! \brief Retrieve realtime configuration 
124  * \param family which family/config to lookup
125  * This will use builtin configuration backends to look up a particular 
126  * entity in realtime and return a variable list of its parameters.  Note
127  * that unlike the variables in ast_config, the resulting list of variables
128  * MUST be freed with ast_variables_destroy() as there is no container.
129  */
130 struct ast_variable *ast_load_realtime(const char *family, ...);
131
132 /*! \brief Retrieve realtime configuration 
133  * \param family which family/config to lookup
134  * This will use builtin configuration backends to look up a particular 
135  * entity in realtime and return a variable list of its parameters. Unlike
136  * the ast_load_realtime, this function can return more than one entry and
137  * is thus stored inside a taditional ast_config structure rather than 
138  * just returning a linked list of variables.
139  */
140 struct ast_config *ast_load_realtime_multientry(const char *family, ...);
141
142 /*! \brief Update realtime configuration 
143  * \param family which family/config to be updated
144  * \param keyfield which field to use as the key
145  * \param lookup which value to look for in the key field to match the entry.
146  * This function is used to update a parameter in realtime configuration space.
147  *
148  */
149 int ast_update_realtime(const char *family, const char *keyfield, const char *lookup, ...);
150
151 /*! \brief Check if realtime engine is configured for family 
152  * returns 1 if family is configured in realtime and engine exists
153  * \param family which family/config to be checked
154 */
155 int ast_check_realtime(const char *family);
156
157 /*! \brief Free variable list 
158  * \param var the linked list of variables to free
159  * This function frees a list of variables.
160  */
161 void ast_variables_destroy(struct ast_variable *var);
162
163 /*! \brief Register config engine */
164 int ast_config_engine_register(struct ast_config_engine *newconfig);
165
166 /*! \brief Deegister config engine */
167 int ast_config_engine_deregister(struct ast_config_engine *del);
168
169 int register_config_cli(void);
170 int read_config_maps(void);
171
172 struct ast_config *ast_config_new(void);
173 struct ast_category *ast_config_get_current_category(const struct ast_config *cfg);
174 void ast_config_set_current_category(struct ast_config *cfg, const struct ast_category *cat);
175 const char *ast_config_option(struct ast_config *cfg, const char *cat, const char *var);
176
177 struct ast_category *ast_category_new(const char *name);
178 void ast_category_append(struct ast_config *config, struct ast_category *cat);
179 int ast_category_delete(struct ast_config *cfg, char *category);
180 void ast_category_destroy(struct ast_category *cat);
181 struct ast_variable *ast_category_detach_variables(struct ast_category *cat);
182 void ast_category_rename(struct ast_category *cat, const char *name);
183
184 struct ast_variable *ast_variable_new(const char *name, const char *value);
185 void ast_variable_append(struct ast_category *category, struct ast_variable *variable);
186 int ast_variable_delete(struct ast_category *category, char *variable, char *match);
187 int ast_variable_update(struct ast_category *category, char *variable, char *value, char *match);
188
189 int config_text_file_save(const char *filename, const struct ast_config *cfg, const char *generator);
190
191 struct ast_config *ast_config_internal_load(const char *configfile, struct ast_config *cfg, int withcomments);
192
193 #if defined(__cplusplus) || defined(c_plusplus)
194 }
195 #endif
196
197 #endif /* _ASTERISK_CONFIG_H */