b2ffcf5c4ff76fcf836c8fd3c62b2f7104aa37a7
[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 "asterisk/utils.h"
31 #include "asterisk/inline_api.h"
32
33 struct ast_config;
34
35 struct ast_category;
36
37 /*! Options for ast_config_load()
38  */
39 enum {
40         /*! Load the configuration, including comments */
41         CONFIG_FLAG_WITHCOMMENTS  = (1 << 0),
42         /*! On a reload, give us a -1 if the file hasn't changed. */
43         CONFIG_FLAG_FILEUNCHANGED = (1 << 1),
44         /*! Don't attempt to cache mtime on this config file. */
45         CONFIG_FLAG_NOCACHE       = (1 << 2),
46         /*! Don't attempt to load from realtime (typically called from a realtime driver dependency) */
47         CONFIG_FLAG_NOREALTIME    = (1 << 3),
48 };
49
50 #define CONFIG_STATUS_FILEMISSING       (void *)0
51 #define CONFIG_STATUS_FILEUNCHANGED     (void *)-1
52 #define CONFIG_STATUS_FILEINVALID       (void *)-2
53
54 /*!
55  * \brief Types used in ast_realtime_require_field
56  */
57 typedef enum {
58         RQ_INTEGER1,
59         RQ_UINTEGER1,
60         RQ_INTEGER2,
61         RQ_UINTEGER2,
62         RQ_INTEGER3,
63         RQ_UINTEGER3,
64         RQ_INTEGER4,
65         RQ_UINTEGER4,
66         RQ_INTEGER8,
67         RQ_UINTEGER8,
68         RQ_CHAR,
69         RQ_FLOAT,
70         RQ_DATE,
71         RQ_DATETIME,
72 } require_type;
73
74 /*! \brief Structure for variables, used for configurations and for channel variables */
75 struct ast_variable {
76         /*! Variable name.  Stored in stuff[] at struct end. */
77         const char *name;
78         /*! Variable value.  Stored in stuff[] at struct end. */
79         const char *value;
80
81         /*! Next node in the list. */
82         struct ast_variable *next;
83
84         /*! Filename where variable found.  Stored in stuff[] at struct end. */
85         const char *file;
86
87         int lineno;
88         int object;             /*!< 0 for variable, 1 for object */
89         int blanklines;         /*!< Number of blanklines following entry */
90         struct ast_comment *precomments;
91         struct ast_comment *sameline;
92         struct ast_comment *trailing; /*!< the last object in the list will get assigned any trailing comments when EOF is hit */
93         /*!
94          * \brief Contents of file, name, and value in that order stuffed here.
95          * \note File must be stuffed before name because of ast_include_rename().
96          */
97         char stuff[0];
98 };
99
100 typedef struct ast_config *config_load_func(const char *database, const char *table, const char *configfile, struct ast_config *config, struct ast_flags flags, const char *suggested_include_file, const char *who_asked);
101 typedef struct ast_variable *realtime_var_get(const char *database, const char *table, va_list ap);
102 typedef struct ast_config *realtime_multi_get(const char *database, const char *table, va_list ap);
103 typedef int realtime_update(const char *database, const char *table, const char *keyfield, const char *entity, va_list ap);
104 typedef int realtime_update2(const char *database, const char *table, va_list ap);
105 typedef int realtime_store(const char *database, const char *table, va_list ap);
106 typedef int realtime_destroy(const char *database, const char *table, const char *keyfield, const char *entity, va_list ap);
107
108 /*!
109  * \brief Function pointer called to ensure database schema is properly configured for realtime use
110  * \since 1.6.1
111  */
112 typedef int realtime_require(const char *database, const char *table, va_list ap);
113
114 /*!
115  * \brief Function pointer called to clear the database cache and free resources used for such
116  * \since 1.6.1
117  */
118 typedef int realtime_unload(const char *database, const char *table);
119
120 /*! \brief Configuration engine structure, used to define realtime drivers */
121 struct ast_config_engine {
122         char *name;
123         config_load_func *load_func;
124         realtime_var_get *realtime_func;
125         realtime_multi_get *realtime_multi_func;
126         realtime_update *update_func;
127         realtime_update2 *update2_func;
128         realtime_store *store_func;
129         realtime_destroy *destroy_func;
130         realtime_require *require_func;
131         realtime_unload *unload_func;
132         struct ast_config_engine *next;
133 };
134
135 /*!
136  * \brief Load a config file
137  *
138  * \param filename path of file to open.  If no preceding '/' character,
139  * path is considered relative to AST_CONFIG_DIR
140  * \param who_asked The module which is making this request.
141  * \param flags Optional flags:
142  * CONFIG_FLAG_WITHCOMMENTS - load the file with comments intact;
143  * CONFIG_FLAG_FILEUNCHANGED - check the file mtime and return CONFIG_STATUS_FILEUNCHANGED if the mtime is the same; or
144  * CONFIG_FLAG_NOCACHE - don't cache file mtime (main purpose of this option is to save memory on temporary files).
145  *
146  * \details
147  * Create a config structure from a given configuration file.
148  *
149  * \return an ast_config data structure on success
150  * \retval NULL on error
151  */
152 struct ast_config *ast_config_load2(const char *filename, const char *who_asked, struct ast_flags flags);
153
154 /*!
155  * \brief Load a config file
156  *
157  * \param filename path of file to open.  If no preceding '/' character,
158  * path is considered relative to AST_CONFIG_DIR
159  * \param flags Optional flags:
160  * CONFIG_FLAG_WITHCOMMENTS - load the file with comments intact;
161  * CONFIG_FLAG_FILEUNCHANGED - check the file mtime and return CONFIG_STATUS_FILEUNCHANGED if the mtime is the same; or
162  * CONFIG_FLAG_NOCACHE - don't cache file mtime (main purpose of this option is to save memory on temporary files).
163  *
164  * \details
165  * Create a config structure from a given configuration file.
166  *
167  * \return an ast_config data structure on success
168  * \retval NULL on error
169  */
170 #define ast_config_load(filename, flags)        ast_config_load2(filename, AST_MODULE, flags)
171
172 /*!
173  * \brief Destroys a config
174  *
175  * \param config pointer to config data structure
176  *
177  * \details
178  * Free memory associated with a given config
179  */
180 void ast_config_destroy(struct ast_config *config);
181
182 /*!
183  * \brief returns the root ast_variable of a config
184  *
185  * \param config pointer to an ast_config data structure
186  * \param cat name of the category for which you want the root
187  *
188  * \return the category specified
189  */
190 struct ast_variable *ast_category_root(struct ast_config *config, char *cat);
191
192 /*!
193  * \brief Goes through categories
194  *
195  * \param config Which config structure you wish to "browse"
196  * \param prev A pointer to a previous category.
197  *
198  * \details
199  * This function is kind of non-intuitive in it's use.
200  * To begin, one passes NULL as the second argument.
201  * It will return a pointer to the string of the first category in the file.
202  * From here on after, one must then pass the previous usage's return value
203  * as the second pointer, and it will return a pointer to the category name
204  * afterwards.
205  *
206  * \retval a category on success
207  * \retval NULL on failure/no-more-categories
208  */
209 char *ast_category_browse(struct ast_config *config, const char *prev);
210
211 /*!
212  * \brief Goes through variables
213  *
214  * \details
215  * Somewhat similar in intent as the ast_category_browse.
216  * List variables of config file category
217  *
218  * \retval ast_variable list on success
219  * \retval NULL on failure
220  */
221 struct ast_variable *ast_variable_browse(const struct ast_config *config, const char *category);
222
223 /*!
224  * \brief given a pointer to a category, return the root variable.
225  *
226  * \details
227  * This is equivalent to ast_variable_browse(), but more efficient if we
228  * already have the struct ast_category * (e.g. from ast_category_get())
229  */
230 struct ast_variable *ast_category_first(struct ast_category *cat);
231
232 /*!
233  * \brief Gets a variable
234  *
235  * \param config which (opened) config to use
236  * \param category category under which the variable lies
237  * \param variable which variable you wish to get the data for
238  *
239  * \details
240  * Goes through a given config file in the given category and searches for the given variable
241  *
242  * \retval The variable value on success
243  * \retval NULL if unable to find it.
244  */
245 const char *ast_variable_retrieve(const struct ast_config *config, const char *category, const char *variable);
246
247 /*!
248  * \brief Retrieve a category if it exists
249  *
250  * \param config which config to use
251  * \param category_name name of the category you're looking for
252  *
253  * \details
254  * This will search through the categories within a given config file for a match.
255  *
256  * \retval pointer to category if found
257  * \retval NULL if not.
258  */
259 struct ast_category *ast_category_get(const struct ast_config *config, const char *category_name);
260
261 /*!
262  * \brief Check for category duplicates
263  *
264  * \param config which config to use
265  * \param category_name name of the category you're looking for
266  *
267  * \details
268  * This will search through the categories within a given config file for a match.
269  *
270  * \return non-zero if found
271  */
272 int ast_category_exist(const struct ast_config *config, const char *category_name);
273
274 /*!
275  * \brief Retrieve realtime configuration
276  *
277  * \param family which family/config to lookup
278  *
279  * \details
280  * This will use builtin configuration backends to look up a particular
281  * entity in realtime and return a variable list of its parameters.
282  *
283  * \note
284  * Unlike the variables in ast_config, the resulting list of variables
285  * MUST be freed with ast_variables_destroy() as there is no container.
286  *
287  * \note
288  * The difference between these two calls is that ast_load_realtime excludes
289  * fields whose values are NULL, while ast_load_realtime_all loads all columns.
290  *
291  * \note
292  * You should use the constant SENTINEL to terminate arguments, in
293  * order to preserve cross-platform compatibility.
294  */
295 struct ast_variable *ast_load_realtime(const char *family, ...) attribute_sentinel;
296 struct ast_variable *ast_load_realtime_all(const char *family, ...) attribute_sentinel;
297
298 /*!
299  * \brief Release any resources cached for a realtime family
300  * \since 1.6.1
301  *
302  * \param family which family/config to destroy
303  *
304  * \details
305  * Various backends may cache attributes about a realtime data storage
306  * facility; on reload, a front end resource may request to purge that cache.
307  *
308  * \retval 0 If any cache was purged
309  * \retval -1 If no cache was found
310  */
311 int ast_unload_realtime(const char *family);
312
313 /*!
314  * \brief Inform realtime what fields that may be stored
315  * \since 1.6.1
316  *
317  * \param family which family/config is referenced
318  *
319  * \details
320  * This will inform builtin configuration backends that particular fields
321  * may be updated during the use of that configuration section.  This is
322  * mainly to be used during startup routines, to ensure that various fields
323  * exist in the backend.  The backends may take various actions, such as
324  * creating new fields in the data store or warning the administrator that
325  * new fields may need to be created, in order to ensure proper function.
326  *
327  * The arguments are specified in groups of 3:  column name, column type,
328  * and column size.  The column types are specified as integer constants,
329  * defined by the enum require_type.  Note that the size is specified as
330  * the number of equivalent character fields that a field may take up, even
331  * if a field is otherwise specified as an integer type.  This is due to
332  * the fact that some fields have historically been specified as character
333  * types, even if they contained integer values.
334  *
335  * A family should always specify its fields to the minimum necessary
336  * requirements to fulfill all possible values (within reason; for example,
337  * a timeout value may reasonably be specified as an INTEGER2, with size 5.
338  * Even though values above 32767 seconds are possible, they are unlikely
339  * to be useful, and we should not complain about that size).
340  *
341  * \retval 0 Required fields met specified standards
342  * \retval -1 One or more fields was missing or insufficient
343  *
344  * \note You should use the constant SENTINEL to terminate arguments, in
345  * order to preserve cross-platform compatibility.
346  */
347 int ast_realtime_require_field(const char *family, ...) attribute_sentinel;
348
349 /*!
350  * \brief Retrieve realtime configuration
351  *
352  * \param family which family/config to lookup
353  *
354  * \details
355  * This will use builtin configuration backends to look up a particular
356  * entity in realtime and return a variable list of its parameters. Unlike
357  * the ast_load_realtime, this function can return more than one entry and
358  * is thus stored inside a traditional ast_config structure rather than
359  * just returning a linked list of variables.
360  *
361  * \return An ast_config with one or more results
362  * \retval NULL Error or no results returned
363  *
364  * \note You should use the constant SENTINEL to terminate arguments, in
365  * order to preserve cross-platform compatibility.
366  */
367 struct ast_config *ast_load_realtime_multientry(const char *family, ...) attribute_sentinel;
368
369 /*!
370  * \brief Update realtime configuration
371  *
372  * \param family which family/config to be updated
373  * \param keyfield which field to use as the key
374  * \param lookup which value to look for in the key field to match the entry.
375  *
376  * \details
377  * This function is used to update a parameter in realtime configuration space.
378  *
379  * \return Number of rows affected, or -1 on error.
380  *
381  * \note You should use the constant SENTINEL to terminate arguments, in
382  * order to preserve cross-platform compatibility.
383  */
384 int ast_update_realtime(const char *family, const char *keyfield, const char *lookup, ...) attribute_sentinel;
385
386 /*!
387  * \brief Update realtime configuration
388  *
389  * \param family which family/config to be updated
390  *
391  * \details
392  * This function is used to update a parameter in realtime configuration space.
393  * It includes the ability to lookup a row based upon multiple key criteria.
394  * As a result, this function includes two sentinel values, one to terminate
395  * lookup values and the other to terminate the listing of fields to update.
396  *
397  * \return Number of rows affected, or -1 on error.
398  *
399  * \note You should use the constant SENTINEL to terminate arguments, in
400  * order to preserve cross-platform compatibility.
401  */
402 int ast_update2_realtime(const char *family, ...) attribute_sentinel;
403
404 /*!
405  * \brief Create realtime configuration
406  *
407  * \param family which family/config to be created
408  *
409  * \details
410  * This function is used to create a parameter in realtime configuration space.
411  *
412  * \return Number of rows affected, or -1 on error.
413  *
414  * \note
415  * On the MySQL engine only, for reasons of backwards compatibility, the return
416  * value is the insert ID.  This value is nonportable and may be changed in a
417  * future version to match the other engines.
418  *
419  * \note You should use the constant SENTINEL to terminate arguments, in
420  * order to preserve cross-platform compatibility.
421  */
422 int ast_store_realtime(const char *family, ...) attribute_sentinel;
423
424 /*!
425  * \brief Destroy realtime configuration
426  *
427  * \param family which family/config to be destroyed
428  * \param keyfield which field to use as the key
429  * \param lookup which value to look for in the key field to match the entry.
430  *
431  * \details
432  * This function is used to destroy an entry in realtime configuration space.
433  * Additional params are used as keys.
434  *
435  * \return Number of rows affected, or -1 on error.
436  *
437  * \note You should use the constant SENTINEL to terminate arguments, in
438  * order to preserve cross-platform compatibility.
439  */
440 int ast_destroy_realtime(const char *family, const char *keyfield, const char *lookup, ...) attribute_sentinel;
441
442 /*!
443  * \brief Check if realtime engine is configured for family
444  * \param family which family/config to be checked
445  * \return 1 if family is configured in realtime and engine exists
446  */
447 int ast_check_realtime(const char *family);
448
449 /*! \brief Check if there's any realtime engines loaded */
450 int ast_realtime_enabled(void);
451
452 /*!
453  * \brief Duplicate variable list
454  * \param var the linked list of variables to clone
455  * \return A duplicated list which you'll need to free with
456  * ast_variables_destroy or NULL when out of memory.
457  *
458  * \note Do not depend on this to copy more than just name, value and filename
459  * (the arguments to ast_variables_new).
460  */
461 struct ast_variable *ast_variables_dup(struct ast_variable *var);
462
463 /*!
464  * \brief Free variable list
465  * \param var the linked list of variables to free
466  *
467  * \details
468  * This function frees a list of variables.
469  */
470 void ast_variables_destroy(struct ast_variable *var);
471
472 /*!
473  * \brief Register config engine
474  * \retval 1 Always
475  */
476 int ast_config_engine_register(struct ast_config_engine *newconfig);
477
478 /*!
479  * \brief Deregister config engine
480  * \retval 0 Always
481  */
482 int ast_config_engine_deregister(struct ast_config_engine *del);
483
484 /*!
485  * \brief Exposed initialization method for core process
486  *
487  * \details
488  * This method is intended for use only with the core initialization and is
489  * not designed to be called from any user applications.
490  */
491 int register_config_cli(void);
492
493 /*!
494  * \brief Exposed re-initialization method for core process
495  *
496  * \details
497  * This method is intended for use only with the core re-initialization and is
498  * not designed to be called from any user applications.
499  */
500 int read_config_maps(void);
501
502 /*! \brief Create a new base configuration structure */
503 struct ast_config *ast_config_new(void);
504
505 /*!
506  * \brief Retrieve the current category name being built.
507  *
508  * \details
509  * API for backend configuration engines while building a configuration set.
510  */
511 struct ast_category *ast_config_get_current_category(const struct ast_config *cfg);
512
513 /*!
514  * \brief Set the category within the configuration as being current.
515  *
516  * \details
517  * API for backend configuration engines while building a configuration set.
518  */
519 void ast_config_set_current_category(struct ast_config *cfg, const struct ast_category *cat);
520
521 /*!
522  * \brief Retrieve a configuration variable within the configuration set.
523  *
524  * \details
525  * Retrieves the named variable \p var within category \p cat of configuration
526  * set \p cfg.  If not found, attempts to retrieve the named variable \p var
527  * from within category \em general.
528  *
529  * \return Value of \p var, or NULL if not found.
530  */
531 const char *ast_config_option(struct ast_config *cfg, const char *cat, const char *var);
532
533 /*! \brief Create a category structure */
534 struct ast_category *ast_category_new(const char *name, const char *in_file, int lineno);
535 void ast_category_append(struct ast_config *config, struct ast_category *cat);
536
537 /*!
538  * \brief Inserts new category
539  * 
540  * \param config which config to use
541  * \param cat newly created category to insert
542  * \param match which category to insert above
543  *
544  * \details
545  * This function is used to insert a new category above another category
546  * matching the match parameter.
547  */
548 void ast_category_insert(struct ast_config *config, struct ast_category *cat, const char *match);
549 int ast_category_delete(struct ast_config *cfg, const char *category);
550
551 /*!
552  * \brief Removes and destroys all variables within a category
553  * \retval 0 if the category was found and emptied
554  * \retval -1 if the category was not found
555  */
556 int ast_category_empty(struct ast_config *cfg, const char *category);
557 void ast_category_destroy(struct ast_category *cat);
558 struct ast_variable *ast_category_detach_variables(struct ast_category *cat);
559 void ast_category_rename(struct ast_category *cat, const char *name);
560
561 #ifdef MALLOC_DEBUG
562 struct ast_variable *_ast_variable_new(const char *name, const char *value, const char *filename, const char *file, const char *function, int lineno);
563 #define ast_variable_new(a, b, c) _ast_variable_new(a, b, c, __FILE__, __PRETTY_FUNCTION__, __LINE__)
564 #else
565 struct ast_variable *ast_variable_new(const char *name, const char *value, const char *filename);
566 #endif
567 struct ast_config_include *ast_include_new(struct ast_config *conf, const char *from_file, const char *included_file, int is_exec, const char *exec_file, int from_lineno, char *real_included_file_name, int real_included_file_name_size);
568 struct ast_config_include *ast_include_find(struct ast_config *conf, const char *included_file);
569 void ast_include_rename(struct ast_config *conf, const char *from_file, const char *to_file);
570 void ast_variable_append(struct ast_category *category, struct ast_variable *variable);
571 void ast_variable_insert(struct ast_category *category, struct ast_variable *variable, const char *line);
572 int ast_variable_delete(struct ast_category *category, const char *variable, const char *match, const char *line);
573
574 /*!
575  * \brief Update variable value within a config
576  *
577  * \param category Category element within the config
578  * \param variable Name of the variable to change
579  * \param value New value of the variable
580  * \param match If set, previous value of the variable (if NULL or zero-length, no matching will be done)
581  * \param object Boolean of whether to make the new variable an object
582  *
583  * \return 0 on success or -1 on failure.
584  */
585 int ast_variable_update(struct ast_category *category, const char *variable,
586                                                 const char *value, const char *match, unsigned int object);
587
588 int ast_config_text_file_save(const char *filename, const struct ast_config *cfg, const char *generator);
589 int config_text_file_save(const char *filename, const struct ast_config *cfg, const char *generator) __attribute__((deprecated));
590
591 struct ast_config *ast_config_internal_load(const char *configfile, struct ast_config *cfg, struct ast_flags flags, const char *suggested_incl_file, const char *who_asked);
592 /*!
593  * \brief
594  * Copies the contents of one ast_config into another
595  *
596  * \note
597  * This creates a config on the heap. The caller of this must
598  * be prepared to free the memory returned.
599  *
600  * \param orig the config to copy
601  * \return The new config on success, NULL on failure.
602  */
603 struct ast_config *ast_config_copy(const struct ast_config *orig);
604
605 /*!
606  * \brief
607  * Flags that affect the behaviour of config hooks.
608  */
609 enum config_hook_flags {
610         butt,
611 };
612
613 /*
614  * \brief Callback when configuration is updated
615  *
616  * \param cfg A copy of the configuration that is being changed.
617  *            This MUST be freed by the callback before returning.
618  */
619 typedef int (*config_hook_cb)(struct ast_config *cfg);
620
621 /*!
622  * \brief
623  * Register a config hook for a particular file and module
624  *
625  * \param name The name of the hook you are registering.
626  * \param filename The file whose config you wish to hook into.
627  * \param module The module that is reloading the config. This
628  *               can be useful if multiple modules may possibly
629  *               reload the same file, but you are only interested
630  *               when a specific module reloads the file
631  * \param flags Flags that affect the way hooks work.
632  * \param hook The callback to be called when config is loaded.
633  * return 0 Success
634  * return -1 Unsuccess, also known as UTTER AND COMPLETE FAILURE
635  */
636 int ast_config_hook_register(const char *name,
637                 const char *filename,
638                 const char *module,
639                 enum config_hook_flags flags,
640                 config_hook_cb hook);
641
642 /*!
643  * \brief
644  * Unregister a config hook
645  *
646  * \param name The name of the hook to unregister
647  */
648 void ast_config_hook_unregister(const char *name);
649
650 /*!
651  * \brief Support code to parse config file arguments
652  *
653  * \details
654  * The function ast_parse_arg() provides a generic interface to parse
655  * strings (e.g. numbers, network addresses and so on) in a flexible
656  * way, e.g. by doing proper error and bound checks, provide default
657  * values, and so on.
658  * The function (described later) takes a string as an argument,
659  * a set of flags to specify the result format and checks to perform,
660  * a pointer to the result, and optionally some additional arguments.
661  *
662  * \return It returns 0 on success, != 0 otherwise.
663  */
664 enum ast_parse_flags {
665         /* low 4 bits of flags are used for the operand type */
666         PARSE_TYPE      =       0x000f,
667         /* numeric types, with optional default value and bound checks.
668          * Additional arguments are passed by value.
669          */
670         PARSE_INT32     =       0x0001,
671         PARSE_UINT32    =       0x0002,
672         PARSE_DOUBLE    =       0x0003,
673 #if 0   /* not supported yet */
674         PARSE_INT16     =       0x0004,
675         PARSE_UINT16    =       0x0005,
676 #endif
677
678         /* Returns a struct ast_sockaddr, with optional default value
679          * (passed by reference) and port handling (accept, ignore,
680          * require, forbid). The format is 'ipaddress[:port]'. IPv6 address
681          * literals need square brackets around them if a port is specified.
682          */
683         PARSE_ADDR      =       0x000e,
684
685         /* Returns a struct sockaddr_in, with optional default value
686          * (passed by reference) and port handling (accept, ignore,
687          * require, forbid). The format is 'host.name[:port]'
688          */
689         PARSE_INADDR    =       0x000f,
690
691         /* Other data types can be added as needed */
692
693         /* If PARSE_DEFAULT is set, next argument is a default value
694          * which is returned in case of error. The argument is passed
695          * by value in case of numeric types, by reference in other cases.
696          */
697         PARSE_DEFAULT   =       0x0010, /* assign default on error */
698
699         /* Request a range check, applicable to numbers. Two additional
700          * arguments are passed by value, specifying the low-high end of
701          * the range (inclusive). An error is returned if the value
702          * is outside or inside the range, respectively.
703          */
704         PARSE_IN_RANGE =       0x0020, /* accept values inside a range */
705         PARSE_OUT_RANGE =      0x0040, /* accept values outside a range */
706         PARSE_RANGE_DEFAULTS = 0x0080, /* default to range min/max on range error */
707
708         /* Port handling, for ast_sockaddr. accept/ignore/require/forbid
709          * port number after the hostname or address.
710          */
711         PARSE_PORT_MASK =       0x0300, /* 0x000: accept port if present */
712         PARSE_PORT_IGNORE =     0x0100, /* 0x100: ignore port if present */
713         PARSE_PORT_REQUIRE =    0x0200, /* 0x200: require port number */
714         PARSE_PORT_FORBID =     0x0300, /* 0x100: forbid port number */
715 };
716
717 /*!
718  * \brief The argument parsing routine.
719  *
720  * \param arg the string to parse. It is not modified.
721  * \param flags combination of ast_parse_flags to specify the
722  * return type and additional checks.
723  * \param result pointer to the result. NULL is valid here, and can
724  * be used to perform only the validity checks.
725  * \param ... extra arguments are required according to flags.
726  *
727  * \retval 0 in case of success, != 0 otherwise.
728  * \retval result returns the parsed value in case of success,
729  * the default value in case of error, or it is left unchanged
730  * in case of error and no default specified. Note that in certain
731  * cases (e.g. sockaddr_in, with multi-field return values) some
732  * of the fields in result may be changed even if an error occurs.
733  *
734  * \details
735  * Examples of use:
736  *     ast_parse_arg("223", PARSE_INT32|PARSE_IN_RANGE, &a, -1000, 1000);
737  * returns 0, a = 223
738  *     ast_parse_arg("22345", PARSE_INT32|PARSE_IN_RANGE|PARSE_DEFAULT, &a, 9999, 10, 100);
739  * returns 1, a = 9999
740  *     ast_parse_arg("22345ssf", PARSE_UINT32|PARSE_IN_RANGE, &b, 10, 100);
741  * returns 1, b unchanged
742  *    ast_parse_arg("12", PARSE_UINT32|PARSE_IN_RANGE|PARSE_RANGE_DEFAULTS, &a, 1, 10);
743  * returns 1, a = 10
744  *    ast_parse_arg("www.foo.biz:44", PARSE_INADDR, &sa);
745  * returns 0, sa contains address and port
746  *    ast_parse_arg("www.foo.biz", PARSE_INADDR|PARSE_PORT_REQUIRE, &sa);
747  * returns 1 because port is missing, sa contains address
748  */
749 int ast_parse_arg(const char *arg, enum ast_parse_flags flags,
750         void *result, ...);
751
752 /*
753  * Parsing config file options in C is slightly annoying because we cannot use
754  * string in a switch() statement, yet we need a similar behaviour, with many
755  * branches and a break on a matching one.
756  * The following somehow simplifies the job: we create a block using
757  * the CV_START and CV_END macros, and then within the block we can run
758  * actions such as "if (condition) { body; break; }"
759  * Additional macros are present to run simple functions (e.g. ast_copy_string)
760  * or to pass arguments to ast_parse_arg()
761  *
762  * As an example:
763
764         CV_START(v->name, v->value);    // start the block
765         CV_STR("foo", x_foo);           // static string
766         CV_DSTR("bar", y_bar);          // malloc'ed string
767         CV_F("bar", ...);               // call a generic function
768         CV_END;                         // end the block
769  */
770
771 /*! \brief the macro to open a block for variable parsing */
772 #define CV_START(__in_var, __in_val)            \
773         do {                                    \
774                 const char *__var = __in_var;   \
775                 const char *__val = __in_val;
776
777 /*! \brief close a variable parsing block */
778 #define CV_END                  } while (0)
779
780 /*! \brief call a generic function if the name matches. */
781 #define CV_F(__pattern, __body) if (!strcasecmp((__var), __pattern)) { __body; break; }
782
783 /*!
784  * \brief helper macros to assign the value to a BOOL, UINT, static string and
785  * dynamic string
786  */
787 #define CV_BOOL(__x, __dst)     CV_F(__x, (__dst) = ast_true(__val) )
788 #define CV_UINT(__x, __dst)     CV_F(__x, (__dst) = strtoul(__val, NULL, 0) )
789 #define CV_STR(__x, __dst)      CV_F(__x, ast_copy_string(__dst, __val, sizeof(__dst)))
790 #define CV_DSTR(__x, __dst)     CV_F(__x, ast_free(__dst); __dst = ast_strdup(__val))
791 #define CV_STRFIELD(__x, __obj, __field) CV_F(__x, ast_string_field_set(__obj, __field, __val))
792
793 /*! \brief Check if require type is an integer type */
794 AST_INLINE_API(
795 int ast_rq_is_int(require_type type),
796 {
797         switch (type) {
798         case RQ_INTEGER1:
799         case RQ_UINTEGER1:
800         case RQ_INTEGER2:
801         case RQ_UINTEGER2:
802         case RQ_INTEGER3:
803         case RQ_UINTEGER3:
804         case RQ_INTEGER4:
805         case RQ_UINTEGER4:
806         case RQ_INTEGER8:
807         case RQ_UINTEGER8:
808                 return 1;
809         default:
810                 return 0;
811         }
812 }
813 )
814
815 /*!
816  * \brief Remove standard encoding from realtime values, which ensures
817  * that a semicolon embedded within a single value is not treated upon
818  * retrieval as multiple values.
819  * \param chunk Data to be decoded
820  * \return The decoded data, in the original buffer
821  * \since 1.8
822  * \warn This function modifies the original buffer
823  */
824 char *ast_realtime_decode_chunk(char *chunk);
825
826 /*!
827  * \brief Encodes a chunk of data for realtime
828  * \param dest Destination buffer
829  * \param maxlen Length passed through to ast_str_* functions
830  * \param chunk Source data to be encoded
831  * \return Buffer within dest
832  * \since 1.8
833  */
834 char *ast_realtime_encode_chunk(struct ast_str **dest, ssize_t maxlen, const char *chunk);
835
836 #if defined(__cplusplus) || defined(c_plusplus)
837 }
838 #endif
839
840 #endif /* _ASTERISK_CONFIG_H */