Return NULL when no results returned for realtime_multientry
[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 Free variable list
454  * \param var the linked list of variables to free
455  *
456  * \details
457  * This function frees a list of variables.
458  */
459 void ast_variables_destroy(struct ast_variable *var);
460
461 /*!
462  * \brief Register config engine
463  * \retval 1 Always
464  */
465 int ast_config_engine_register(struct ast_config_engine *newconfig);
466
467 /*!
468  * \brief Deregister config engine
469  * \retval 0 Always
470  */
471 int ast_config_engine_deregister(struct ast_config_engine *del);
472
473 /*!
474  * \brief Exposed initialization method for core process
475  *
476  * \details
477  * This method is intended for use only with the core initialization and is
478  * not designed to be called from any user applications.
479  */
480 int register_config_cli(void);
481
482 /*!
483  * \brief Exposed re-initialization method for core process
484  *
485  * \details
486  * This method is intended for use only with the core re-initialization and is
487  * not designed to be called from any user applications.
488  */
489 int read_config_maps(void);
490
491 /*! \brief Create a new base configuration structure */
492 struct ast_config *ast_config_new(void);
493
494 /*!
495  * \brief Retrieve the current category name being built.
496  *
497  * \details
498  * API for backend configuration engines while building a configuration set.
499  */
500 struct ast_category *ast_config_get_current_category(const struct ast_config *cfg);
501
502 /*!
503  * \brief Set the category within the configuration as being current.
504  *
505  * \details
506  * API for backend configuration engines while building a configuration set.
507  */
508 void ast_config_set_current_category(struct ast_config *cfg, const struct ast_category *cat);
509
510 /*!
511  * \brief Retrieve a configuration variable within the configuration set.
512  *
513  * \details
514  * Retrieves the named variable \p var within category \p cat of configuration
515  * set \p cfg.  If not found, attempts to retrieve the named variable \p var
516  * from within category \em general.
517  *
518  * \return Value of \p var, or NULL if not found.
519  */
520 const char *ast_config_option(struct ast_config *cfg, const char *cat, const char *var);
521
522 /*! \brief Create a category structure */
523 struct ast_category *ast_category_new(const char *name, const char *in_file, int lineno);
524 void ast_category_append(struct ast_config *config, struct ast_category *cat);
525
526 /*!
527  * \brief Inserts new category
528  * 
529  * \param config which config to use
530  * \param cat newly created category to insert
531  * \param match which category to insert above
532  *
533  * \details
534  * This function is used to insert a new category above another category
535  * matching the match parameter.
536  */
537 void ast_category_insert(struct ast_config *config, struct ast_category *cat, const char *match);
538 int ast_category_delete(struct ast_config *cfg, const char *category);
539
540 /*!
541  * \brief Removes and destroys all variables within a category
542  * \retval 0 if the category was found and emptied
543  * \retval -1 if the category was not found
544  */
545 int ast_category_empty(struct ast_config *cfg, const char *category);
546 void ast_category_destroy(struct ast_category *cat);
547 struct ast_variable *ast_category_detach_variables(struct ast_category *cat);
548 void ast_category_rename(struct ast_category *cat, const char *name);
549
550 #ifdef MALLOC_DEBUG
551 struct ast_variable *_ast_variable_new(const char *name, const char *value, const char *filename, const char *file, const char *function, int lineno);
552 #define ast_variable_new(a, b, c) _ast_variable_new(a, b, c, __FILE__, __PRETTY_FUNCTION__, __LINE__)
553 #else
554 struct ast_variable *ast_variable_new(const char *name, const char *value, const char *filename);
555 #endif
556 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);
557 struct ast_config_include *ast_include_find(struct ast_config *conf, const char *included_file);
558 void ast_include_rename(struct ast_config *conf, const char *from_file, const char *to_file);
559 void ast_variable_append(struct ast_category *category, struct ast_variable *variable);
560 void ast_variable_insert(struct ast_category *category, struct ast_variable *variable, const char *line);
561 int ast_variable_delete(struct ast_category *category, const char *variable, const char *match, const char *line);
562
563 /*!
564  * \brief Update variable value within a config
565  *
566  * \param category Category element within the config
567  * \param variable Name of the variable to change
568  * \param value New value of the variable
569  * \param match If set, previous value of the variable (if NULL or zero-length, no matching will be done)
570  * \param object Boolean of whether to make the new variable an object
571  *
572  * \return 0 on success or -1 on failure.
573  */
574 int ast_variable_update(struct ast_category *category, const char *variable,
575                                                 const char *value, const char *match, unsigned int object);
576
577 int ast_config_text_file_save(const char *filename, const struct ast_config *cfg, const char *generator);
578 int config_text_file_save(const char *filename, const struct ast_config *cfg, const char *generator) __attribute__((deprecated));
579
580 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);
581
582 /*!
583  * \brief Support code to parse config file arguments
584  *
585  * \details
586  * The function ast_parse_arg() provides a generic interface to parse
587  * strings (e.g. numbers, network addresses and so on) in a flexible
588  * way, e.g. by doing proper error and bound checks, provide default
589  * values, and so on.
590  * The function (described later) takes a string as an argument,
591  * a set of flags to specify the result format and checks to perform,
592  * a pointer to the result, and optionally some additional arguments.
593  *
594  * \return It returns 0 on success, != 0 otherwise.
595  */
596 enum ast_parse_flags {
597         /* low 4 bits of flags are used for the operand type */
598         PARSE_TYPE      =       0x000f,
599         /* numeric types, with optional default value and bound checks.
600          * Additional arguments are passed by value.
601          */
602         PARSE_INT32     =       0x0001,
603         PARSE_UINT32    =       0x0002,
604         PARSE_DOUBLE    =       0x0003,
605 #if 0   /* not supported yet */
606         PARSE_INT16     =       0x0004,
607         PARSE_UINT16    =       0x0005,
608 #endif
609
610         /* Returns a struct ast_sockaddr, with optional default value
611          * (passed by reference) and port handling (accept, ignore,
612          * require, forbid). The format is 'ipaddress[:port]'. IPv6 address
613          * literals need square brackets around them if a port is specified.
614          */
615         PARSE_ADDR      =       0x000e,
616
617         /* Returns a struct sockaddr_in, with optional default value
618          * (passed by reference) and port handling (accept, ignore,
619          * require, forbid). The format is 'host.name[:port]'
620          */
621         PARSE_INADDR    =       0x000f,
622
623         /* Other data types can be added as needed */
624
625         /* If PARSE_DEFAULT is set, next argument is a default value
626          * which is returned in case of error. The argument is passed
627          * by value in case of numeric types, by reference in other cases.
628          */
629         PARSE_DEFAULT   =       0x0010, /* assign default on error */
630
631         /* Request a range check, applicable to numbers. Two additional
632          * arguments are passed by value, specifying the low-high end of
633          * the range (inclusive). An error is returned if the value
634          * is outside or inside the range, respectively.
635          */
636         PARSE_IN_RANGE =        0x0020, /* accept values inside a range */
637         PARSE_OUT_RANGE =       0x0040, /* accept values outside a range */
638
639         /* Port handling, for ast_sockaddr. accept/ignore/require/forbid
640          * port number after the hostname or address.
641          */
642         PARSE_PORT_MASK =       0x0300, /* 0x000: accept port if present */
643         PARSE_PORT_IGNORE =     0x0100, /* 0x100: ignore port if present */
644         PARSE_PORT_REQUIRE =    0x0200, /* 0x200: require port number */
645         PARSE_PORT_FORBID =     0x0300, /* 0x100: forbid port number */
646 };
647
648 /*!
649  * \brief The argument parsing routine.
650  *
651  * \param arg the string to parse. It is not modified.
652  * \param flags combination of ast_parse_flags to specify the
653  *      return type and additional checks.
654  * \param result pointer to the result. NULL is valid here, and can
655  *      be used to perform only the validity checks.
656  * \param ... extra arguments are required according to flags.
657  *
658  * \retval 0 in case of success, != 0 otherwise.
659  * \retval result returns the parsed value in case of success,
660  *      the default value in case of error, or it is left unchanged
661  *      in case of error and no default specified. Note that in certain
662  *      cases (e.g. sockaddr_in, with multi-field return values) some
663  *      of the fields in result may be changed even if an error occurs.
664  *
665  * \details
666  * Examples of use:
667  *      ast_parse_arg("223", PARSE_INT32|PARSE_IN_RANGE,
668  *              &a, -1000, 1000);
669  *              returns 0, a = 223
670  *      ast_parse_arg("22345", PARSE_INT32|PARSE_IN_RANGE|PARSE_DEFAULT,
671  *              &a, 9999, 10, 100);
672  *              returns 1, a = 9999
673  *      ast_parse_arg("22345ssf", PARSE_UINT32|PARSE_IN_RANGE, &b, 10, 100);
674  *              returns 1, b unchanged
675  *      ast_parse_arg("www.foo.biz:44", PARSE_INADDR, &sa);
676  *              returns 0, sa contains address and port
677  *      ast_parse_arg("www.foo.biz", PARSE_INADDR|PARSE_PORT_REQUIRE, &sa);
678  *              returns 1 because port is missing, sa contains address
679  */
680 int ast_parse_arg(const char *arg, enum ast_parse_flags flags,
681         void *result, ...);
682
683 /*
684  * Parsing config file options in C is slightly annoying because we cannot use
685  * string in a switch() statement, yet we need a similar behaviour, with many
686  * branches and a break on a matching one.
687  * The following somehow simplifies the job: we create a block using
688  * the  CV_START and CV_END macros, and then within the block we can run
689  * actions such as "if (condition) { body; break; }"
690  * Additional macros are present to run simple functions (e.g. ast_copy_string)
691  * or to pass arguments to ast_parse_arg()
692  *
693  * As an example:
694
695         CV_START(v->name, v->value);    // start the block
696         CV_STR("foo", x_foo);           // static string
697         CV_DSTR("bar", y_bar);          // malloc'ed string
698         CV_F("bar", ...);               // call a generic function
699         CV_END;                         // end the block
700  */
701
702 /*! \brief the macro to open a block for variable parsing */
703 #define CV_START(__in_var, __in_val)            \
704         do {                                    \
705                 const char *__var = __in_var;   \
706                 const char *__val = __in_val;
707
708 /*! \brief close a variable parsing block */
709 #define CV_END                  } while (0)
710
711 /*! \brief call a generic function if the name matches. */
712 #define CV_F(__pattern, __body) if (!strcasecmp((__var), __pattern)) { __body; break; }
713
714 /*!
715  * \brief helper macros to assign the value to a BOOL, UINT, static string and
716  * dynamic string
717  */
718 #define CV_BOOL(__x, __dst)     CV_F(__x, (__dst) = ast_true(__val) )
719 #define CV_UINT(__x, __dst)     CV_F(__x, (__dst) = strtoul(__val, NULL, 0) )
720 #define CV_STR(__x, __dst)      CV_F(__x, ast_copy_string(__dst, __val, sizeof(__dst)))
721 #define CV_DSTR(__x, __dst)     CV_F(__x, ast_free(__dst); __dst = ast_strdup(__val))
722 #define CV_STRFIELD(__x, __obj, __field) CV_F(__x, ast_string_field_set(__obj, __field, __val))
723
724 /*! \brief Check if require type is an integer type */
725 AST_INLINE_API(
726 int ast_rq_is_int(require_type type),
727 {
728         switch (type) {
729         case RQ_INTEGER1:
730         case RQ_UINTEGER1:
731         case RQ_INTEGER2:
732         case RQ_UINTEGER2:
733         case RQ_INTEGER3:
734         case RQ_UINTEGER3:
735         case RQ_INTEGER4:
736         case RQ_UINTEGER4:
737         case RQ_INTEGER8:
738         case RQ_UINTEGER8:
739                 return 1;
740         default:
741                 return 0;
742         }
743 }
744 )
745
746 /*!
747  * \brief Remove standard encoding from realtime values, which ensures
748  * that a semicolon embedded within a single value is not treated upon
749  * retrieval as multiple values.
750  * \param chunk Data to be decoded
751  * \return The decoded data, in the original buffer
752  * \since 1.8
753  * \warn This function modifies the original buffer
754  */
755 char *ast_realtime_decode_chunk(char *chunk);
756
757 /*!
758  * \brief Encodes a chunk of data for realtime
759  * \param dest Destination buffer
760  * \param maxlen Length passed through to ast_str_* functions
761  * \param chunk Source data to be encoded
762  * \return Buffer within dest
763  * \since 1.8
764  */
765 char *ast_realtime_encode_chunk(struct ast_str **dest, ssize_t maxlen, const char *chunk);
766
767 #if defined(__cplusplus) || defined(c_plusplus)
768 }
769 #endif
770
771 #endif /* _ASTERISK_CONFIG_H */