8947521d3f3efef5c1eeb39e3488c38cefbe4d81
[asterisk/asterisk.git] / include / asterisk / config_options.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2012, 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 option-handling
21  * \author Terry Wilson <twilson@digium.com>
22  */
23
24 #ifndef _ASTERISK_CONFIG_OPTIONS_H
25 #define _ASTERISK_CONFIG_OPTIONS_H
26
27 #if defined(__cplusplus) || defined(c_plusplus)
28 extern "C" {
29 #endif
30
31 #include <regex.h>
32
33 #include "asterisk/config.h"
34 #include "asterisk/astobj2.h"
35
36 struct aco_option;
37 struct aco_info_internal;
38 struct aco_type_internal;
39
40 enum aco_type_t {
41         ACO_GLOBAL,
42         ACO_ITEM,
43 };
44
45 /*! \brief Whether a category regex is a blackist or a whitelist */
46 enum aco_category_op {
47         ACO_BLACKLIST = 0,
48         ACO_WHITELIST,
49 };
50
51 /*! \brief What kind of matching should be done on an option name */
52 enum aco_matchtype {
53         ACO_EXACT = 1,
54         ACO_REGEX,
55 };
56
57 /*! Callback functions for option parsing via aco_process_config() */
58
59 /*! \brief Allocate a configurable ao2 object
60  * \param category The config category the object is being generated for
61  * \retval NULL error
62  * \retval non-NULL a new configurable ao2 object
63  */
64 typedef void *(*aco_type_item_alloc)(const char *category);
65
66 /*! \brief Find a item given a category and container of items
67  * \param container The container to search for the item
68  * \param category The category associated with the item
69  * \retval non-NULL item from the container
70  * \retval NULL item does not exist in container
71  */
72 typedef void *(*aco_type_item_find)(struct ao2_container *newcontainer, const char *category);
73
74 /*! \brief Callback function that is called after a config object is initialized with defaults
75  *
76  * \note This callback is called during config processing after a new config is allocated and
77  * and defaults applied but before values from the config are read. This callback could be used
78  * to merge in settings inherited from the global settings if necessary, despite that being a
79  * bad thing to do!
80  *
81  * \param newitem The newly allocated config object with defaults populated
82  * \retval 0 succes, continue processing
83  * \retval non-zero failure, stop processing
84  */
85 typedef int (*aco_type_item_pre_process)(void *newitem);
86
87 /*! \brief Callback function that is called after config processing, but before linking
88  *
89  * \note This callback is called after config processing, but before linking the object
90  * in the config container. This callback can be used to verify that all settings make
91  * sense together, that required options have been set, etc.
92  *
93  * \param newitem The newly configured object
94  * \retval 0 success, continue processing
95  * \retval non-zero failure, stop processing
96  */
97 typedef int (*aco_type_prelink)(void *newitem);
98
99 /*! \brief A function for determining whether the value for the matchfield in an aco_type is sufficient for a match
100  * \param text The value of the option
101  * \retval -1 The value is sufficient for a match
102  * \retval 0 The value is not sufficient for a match
103  */
104 typedef int (*aco_matchvalue_func)(const char *text);
105
106 /*! \struct aco_type
107  * \brief Type information about a category-level configurable object
108  */
109 struct aco_type {
110         /* common stuff */
111         enum aco_type_t type;   /*!< Whether this is a global or item type */
112         const char *name;       /*!< The name of this type (must match XML documentation) */
113         const char *category;   /*!< A regular expression for matching categories to be allowed or denied */
114         const char *matchfield; /*!< An option name to match for this type (i.e. a 'type'-like column) */
115         const char *matchvalue; /*!< The value of the option to require for matching (i.e. 'peer' for type= in sip.conf) */
116         aco_matchvalue_func matchfunc;       /*!< A function for determing whether the option value matches (i.e. hassip= requires ast_true()) */
117         enum aco_category_op category_match; /*!< Whether the following category regex is a whitelist or blacklist */
118         size_t item_offset;                  /*!< The offset in the config snapshot for the global config or item config container */
119         unsigned int hidden;  /*!< Type is for internal purposes only and it and all options should not be visible to users */
120
121         /* non-global callbacks */
122         aco_type_item_alloc item_alloc;         /*!< An allocation function for item associated with this type */
123         aco_type_item_find item_find;           /*!< A callback function to find an existing item in a particular container */
124         aco_type_item_pre_process item_pre_process; /*!< An optional callback function that is called after defaults are applied, but before config processing */
125         aco_type_prelink item_prelink;          /*!< An optional callback function that is called after config processing, but before applying changes */
126         struct aco_type_internal *internal;
127 };
128
129 /*! \brief A callback function to run just prior to applying config changes
130  * \retval 0 Success
131  * \retval non-zero Failure. Changes not applied
132  */
133 typedef int (*aco_pre_apply_config)(void);
134
135 /*! \brief A callback function called only if config changes have been applied
136  *
137  * \note If a config file has not been edited prior to performing a reload, this
138  * callback will not be called.
139  */
140 typedef void (*aco_post_apply_config)(void);
141
142 /*! \brief A callback function for allocating an object to hold all config objects
143  * \retval NULL error
144  * \retval non-NULL a config object container
145  */
146 typedef void *(*aco_snapshot_alloc)(void);
147
148 /*! \brief The representation of a single configuration file to be processed */
149 struct aco_file {
150         const char *filename;       /*!< The filename to be processed */
151         const char *alias;          /*!< An alias filename to be tried if 'filename' cannot be found */
152         const char **preload;       /*!< A null-terminated ordered array of categories to be loaded first */
153         const char *skip_category;  /*!< A regular expression of categories to skip in the file. Use when a file is processed by multiple modules */
154         struct aco_type *types[];   /*!< The list of types for this config. Required. Use a sentinel! */
155 };
156
157 struct aco_info {
158         const char *module; /*!< The name of the module whose config is being processed */
159         aco_pre_apply_config pre_apply_config; /*!< A callback called after processing, but before changes are applied */
160         aco_post_apply_config post_apply_config;/*!< A callback called after changes are applied */
161         aco_snapshot_alloc snapshot_alloc;     /*!< Allocate an object to hold all global configs and item containers */
162         struct ao2_global_obj *global_obj;     /*!< The global object array that holds the user-defined config object */
163         struct aco_info_internal *internal;
164         struct aco_file *files[];    /*!< An array of aco_files to process */
165 };
166
167 /*! \brief A helper macro to ensure that aco_info types always have a sentinel */
168 #define ACO_TYPES(...) { __VA_ARGS__, NULL, }
169 #define ACO_FILES(...) { __VA_ARGS__, NULL, }
170
171 /*! \brief Get pending config changes
172  * \note This will most likely be called from the pre_apply_config callback function
173  * \param info An initialized aco_info
174  * \retval NULL error
175  * \retval non-NULL A pointer to the user-defined config object with un-applied changes
176  */
177 void *aco_pending_config(struct aco_info *info);
178
179 /*! \def CONFIG_INFO_STANDARD
180  * \brief Declare an aco_info struct with default module and preload values
181  * \param name The name of the struct
182  * \param arr The global object array for holding the user-defined config object
183  * \param alloc The allocater for the user-defined config object
184  *
185  * Example:
186  * \code
187  * static AO2_GLOBAL_OBJ_STATIC(globals, 1);
188  * CONFIG_INFO_STANDARD(cfg_info, globals, skel_config_alloc,
189  *     .pre_apply_config = skel_pre_apply_config,
190  *     .files = { &app_skel_conf, NULL },
191  * );
192  * ...
193  * if (aco_info_init(&cfg_info)) {
194  *     return AST_MODULE_LOAD_DECLINE;
195  * }
196  * ...
197  * aco_info_destroy(&cfg_info);
198  * \endcode
199  */
200 #define CONFIG_INFO_STANDARD(name, arr, alloc, ...) \
201 static struct aco_info name = { \
202         .module = AST_MODULE, \
203         .global_obj = &arr, \
204         .snapshot_alloc = alloc, \
205         __VA_ARGS__ \
206 };
207
208 #define CONFIG_INFO_CORE(mod, name, arr, alloc, ...) \
209 static struct aco_info name = { \
210         .module = mod, \
211         .global_obj = &arr, \
212         .snapshot_alloc = alloc, \
213         __VA_ARGS__ \
214 };
215
216 /*! \brief Initialize an aco_info structure
217  * \note aco_info_destroy must be called if this succeeds
218  * \param info The address of an aco_info struct to initialize
219  * \retval 0 Success
220  * \retval non-zero Failure
221  */
222 int aco_info_init(struct aco_info *info);
223
224 /*! \brief Destroy an initialized aco_info struct
225  * \param info The address of the aco_info struct to destroy
226  */
227 void aco_info_destroy(struct aco_info *info);
228
229 /*! \brief The option types
230  *
231  * \note aco_option_register takes an option type which is used
232  * to look up the handler for that type. Each non-custom type requires
233  * field names for specific types in the struct being configured. Each
234  * option below is commented with the field types, additional arguments
235  * and example usage with aco_option_register
236  */
237 enum aco_option_type {
238         /*! \brief Type for default option handler for ACLs
239          * \note aco_option_register flags:
240          *   non-zero : "permit"
241          *   0        : "deny"
242          * aco_option_register varargs:
243          *   FLDSET macro with the field of type struct ast_ha *.
244          *
245          * Example:
246          * {code}
247          * struct test_item {
248          *     struct ast_ha *ha;
249          * };
250          * aco_option_register(&cfg_info, "permit", ACO_EXACT, my_types, NULL, OPT_ACL_T, 1, FLDSET(struct test_item, ha));
251          * aco_option_register(&cfg_info, "deny", ACO_EXACT, my_types, NULL, OPT_ACL_T, 0, FLDSET(struct test_item, ha));
252          * {code}
253          */
254         OPT_ACL_T,
255
256         /*! \brief Type for default option handler for bools (ast_true/ast_false)
257          * \note aco_option_register flags:
258          *   non-zero : process via ast_true
259          *   0        : process via ast_false
260          * aco_option_register varargs:
261          *   FLDSET macro with the field of type int. It is important to note that the field
262          *   cannot be a bitfield. If bitfields are required, they must be set via a custom handler.
263          *
264          * Example:
265          * {code}
266          * struct test_item {
267          *     int enabled;
268          * };
269          * aco_option_register(&cfg_info, "enabled", ACO_EXACT, my_types, "no", OPT_BOOL_T, 1, FLDSET(struct test_item, enabled));
270          * {endcode}
271          */
272         OPT_BOOL_T,
273
274         /*! \brief Type for default option handler for bools (ast_true/ast_false) that are stored in a flag
275          * \note aco_option_register flags:
276          *   non-zero : process via ast_true
277          *   0        : process via ast_false
278          * aco_option_register varargs:
279          *   FLDSET macro with the field of type of unsigned int.
280          *   The flag to set
281          *
282          * Example:
283          * {code}
284          * #define MY_TYPE_ISQUIET    1 << 4
285          * struct test_item {
286          *     unsigned int flags;
287          * };
288          * aco_option_register(&cfg_info, "quiet", ACO_EXACT, my_types, "no", OPT_BOOLFLAG_T, 1, FLDSET(struct test_item, flags), MY_TYPE_ISQUIET);
289          * {endcode}
290          */
291         OPT_BOOLFLAG_T,
292
293         /*! \brief Type for default option handler for character array strings
294          * \note aco_option_register flags:
295          *   non-zero : String cannot be empty.
296          *   0        : String can be empty.
297          * \note aco_option_register varargs:
298          *   CHARFLDSET macro with a field of type char[]
299          *
300          * Example:
301          * {code}
302          * struct test_item {
303          *     char description[128];
304          * };
305          * aco_option_register(&cfg_info, "description", ACO_EXACT, my_types, "none", OPT_CHAR_ARRAY_T, 0, CHARFLDSET(struct test_item, description));
306          * {endcode}
307          */
308         OPT_CHAR_ARRAY_T,
309
310         /*! \brief Type for default option handler for codec preferences/capabilities
311          * \note aco_option_register flags:
312          *   non-zero : This is an "allow" style option
313          *   0        : This is a "disallow" style option
314          * aco_option_register varargs:
315          *   FLDSET macro with fields representing a struct ast_codec_pref and a struct ast_format_cap *
316          *
317          * Example:
318          * {code}
319          * struct test_item {
320          *     struct ast_codec_pref pref;
321          *     struct ast_format cap *cap;
322          * };
323          * aco_option_register(&cfg_info, "allow", ACO_EXACT, my_types, "ulaw,alaw", OPT_CODEC_T, 1, FLDSET(struct test_item, pref, cap));
324          * aco_option_register(&cfg_info, "disallow", ACO_EXACT, my_types, "all", OPT_CODEC_T, 0, FLDSET(struct test_item, pref, cap));
325          * {endcode}
326          */
327         OPT_CODEC_T,
328
329         /*! \brief Type for a custom (user-defined) option handler */
330         OPT_CUSTOM_T,
331
332         /*! \brief Type for default option handler for doubles
333          *
334          * \note aco_option_register flags:
335          *   See flags available for use with the PARSE_DOUBLE type for the ast_parse_arg function
336          * aco_option_register varargs:
337          *   FLDSET macro with the field of type double
338          *
339          * Example:
340          * struct test_item {
341          *     double dub;
342          * };
343          * {code}
344          * aco_option_register(&cfg_info, "doubleopt", ACO_EXACT, my_types, "3", OPT_DOUBLE_T, 0, FLDSET(struct test_item, dub));
345          * {endcode}
346          */
347         OPT_DOUBLE_T,
348
349         /*! \brief Type for default option handler for signed integers
350          *
351          * \note aco_option_register flags:
352          *   See flags available for use with the PARSE_INT32 type for the ast_parse_arg function
353          * aco_option_register varargs:
354          *   FLDSET macro with the field of type int32_t
355          *   The remaining varargs for should be arguments compatible with the varargs for the
356          *   ast_parse_arg function with the PARSE_INT32 type and the flags passed in the
357          *   aco_option_register flags parameter.
358          *
359          * \note In most situations, it is preferable to not pass the PARSE_DEFAULT flag. If a config
360          * contains an invalid value, it is better to let the config loading fail with warnings so that
361          * the problem is fixed by the administrator.
362          *
363          * Example:
364          * struct test_item {
365          *     int32_t intopt;
366          * };
367          * {code}
368          * aco_option_register(&cfg_info, "intopt", ACO_EXACT, my_types, "3", OPT_INT_T, PARSE_IN_RANGE, FLDSET(struct test_item, intopt), -10, 10);
369          * {endcode}
370          */
371         OPT_INT_T,
372
373         /*! \brief Type for a default handler that should do nothing
374          *
375          * \note This might be useful for a "type" field that is valid, but doesn't
376          * actually need to do anything
377          */
378         OPT_NOOP_T,
379
380         /*! \brief Type for default handler for ast_sockaddrs
381          *
382          * \note aco_option_register flags:
383          *   See flags available for use with the PARSE_ADDR type for the ast_parse_arg function
384          * aco_option_register varargs:
385          *   FLDSET macro with the field being of type struct ast_sockaddr.
386          *
387          * Example:
388          * {code}
389          * struct test_item {
390          *     struct ast_sockaddr addr;
391          * };
392          * aco_option_register(&cfg_info, "sockaddropt", ACO_EXACT, my_types, "0.0.0.0:1234", OPT_SOCKADDR_T, 0, FLDSET(struct test_item, addr));
393          * {endcode}
394          */
395         OPT_SOCKADDR_T,
396
397         /*! \brief Type for default option handler for stringfields
398          * \note aco_option_register flags:
399          *   non-zero : String cannot be empty.
400          *   0        : String can be empty.
401          * aco_option_register varargs:
402          *   STRFLDSET macro with the field being the field created by AST_STRING_FIELD
403          *
404          * Example:
405          * {code}
406          * struct test_item {
407          *     AST_DECLARE_STRING_FIELDS(
408          *         AST_STRING_FIELD(thing);
409          *     );
410          * };
411          * aco_option_register(&cfg_info, "thing", ACO_EXACT, my_types, NULL, OPT_STRINGFIELD_T, 0, STRFLDSET(struct test_item, thing));
412          * {endcode}
413          */
414         OPT_STRINGFIELD_T,
415
416         /*! \brief Type for default option handler for unsigned integers
417          *
418          * \note aco_option_register flags:
419          *   See flags available for use with the PARSE_UINT32 type for the ast_parse_arg function
420          * aco_option_register varargs:
421          *   FLDSET macro with the field of type uint32_t
422          *   The remaining varargs for should be arguments compatible with the varargs for the
423          *   ast_parse_arg function with the PARSE_UINT32 type and the flags passed in the
424          *   aco_option_register flags parameter.
425          *
426          * \note In most situations, it is preferable to not pass the PARSE_DEFAULT flag. If a config
427          * contains an invalid value, it is better to let the config loading fail with warnings so that
428          * the problem is fixed by the administrator.
429          *
430          * Example:
431          * struct test_item {
432          *     int32_t intopt;
433          * };
434          * {code}
435          * aco_option_register(&cfg_info, "uintopt", ACO_EXACT, my_types, "3", OPT_UINT_T, PARSE_IN_RANGE, FLDSET(struct test_item, uintopt), 1, 10);
436          * {endcode}
437          */
438         OPT_UINT_T,
439 };
440
441 /*! \brief A callback function for handling a particular option
442  * \param opt The option being configured
443  * \param var The config variable to use to configure \a obj
444  * \param obj The object to be configured
445  *
446  * \retval 0 Parsing and recording the config value succeeded
447  * \retval non-zero Failure. Parsing should stop and no reload applied
448  */
449 typedef int (*aco_option_handler)(const struct aco_option *opt, struct ast_variable *var, void *obj);
450
451 /*! \brief Allocate a container to hold config options */
452 struct ao2_container *aco_option_container_alloc(void);
453
454 /*! \brief Return values for the aco_process functions
455  */
456 enum aco_process_status {
457         ACO_PROCESS_OK,        /*!< \brief The config was processed and applied */
458         ACO_PROCESS_UNCHANGED, /*!< \brief The config had not been edited and no changes applied */
459         ACO_PROCESS_ERROR,     /*!< \brief Their was an error and no changes were applied */
460 };
461
462 /*! \brief Process a config info via the options registered with an aco_info
463  *
464  * \param info The config_options_info to be used for handling the config
465  * \param reload Non-zero if this is for a reload.
466  *
467  * \retval ACO_PROCESS_OK Success
468  * \retval ACO_PROCESS_ERROR Failure
469  * \retval ACO_PROCESS_UNCHANGED No change due to unedited config file
470  */
471 enum aco_process_status aco_process_config(struct aco_info *info, int reload);
472
473 /*! \brief Process config info from an ast_config via options registered with an aco_info
474  *
475  * \param info The aco_info to be used for handling the config
476  * \param file The file attached to aco_info that the config represents
477  * \param cfg A pointer to a loaded ast_config to parse
478  *
479  * \retval ACO_PROCESS_OK Success
480  * \retval ACO_PROCESS_ERROR Failure
481  */
482 enum aco_process_status aco_process_ast_config(struct aco_info *info, struct aco_file *file, struct ast_config *cfg);
483
484 /*! \brief Parse a single ast_variable and apply it to an object
485  * \note This function can be used to build up an object by repeatedly passing in
486  * the config variable name and values that would be found in a config file. This can
487  * be useful if the object is to be populated by a dialplan function, for example.
488  *
489  * \param type The aco_type associated with the object
490  * \param cat The category to use
491  * \param var A variable to apply to the object
492  * \param obj A pointer to the object to be configured
493  *
494  * \retval 0 Success
495  * \retval -1 Failure
496  */
497 int aco_process_var(struct aco_type *type, const char *cat, struct ast_variable *var, void *obj);
498
499 /*! \brief Parse each option defined in a config category
500  * \param type The aco_type with the options for parsing
501  * \param cfg The ast_config being parsed
502  * \param cat The config category being parsed
503  * \param obj The user-defined config object that will store the parsed config items
504  *
505  * \retval 0 Success
506  * \retval -1 Failure
507  */
508 int aco_process_category_options(struct aco_type *type, struct ast_config *cfg, const char *cat, void *obj);
509
510 /*! \brief Set all default options of \a obj
511  * \param type The aco_type with the options
512  * \param category The configuration category from which \a obj is being configured
513  * \param obj The object being configured
514  *
515  * \retval 0 Success
516  * \retval -1 Failure
517  */
518 int aco_set_defaults(struct aco_type *type, const char *category, void *obj);
519
520 /*! \brief register a config option
521  *
522  * \note this should probably only be called by one of the aco_option_register* macros
523  *
524  * \param info The aco_info holding this module's config information
525  * \param name The name of the option
526  * \param match_type
527  * \param types An array of valid option types for matching categories to the correct struct type
528  * \param default_val The default value of the option in the same format as defined in a config file
529  * \param type The option type (only for default handlers)
530  * \param handler The handler function for the option (only for non-default types)
531  * \param flags a type specific flags, stored in the option and available to the handler
532  * \param no_doc if non-zero, this option should not have documentation
533  * \param argc The number for variadic arguments
534  * \param ... field offsets to store for default handlers
535  *
536  * \retval 0 success
537  * \retval -1 failure
538  */
539 int __aco_option_register(struct aco_info *info, const char *name, enum aco_matchtype match_type, struct aco_type **types,
540         const char *default_val, enum aco_option_type type, aco_option_handler handler, unsigned int flags, unsigned int no_doc, size_t argc, ...);
541
542 /*! \brief Register a config option
543  * \param info A pointer to the aco_info struct
544  * \param name The name of the option
545  * \param matchtype
546  * \param types An array of valid option types for matching categories to the correct struct type
547  * \param default_val The default value of the option in the same format as defined in a config file
548  * \param opt_type The option type for default option type handling
549  * \param flags a type specific flags, stored in the option and available to the handler
550  * \param ...
551  *
552  * \retval 0 Success
553  * \retval -1 Failure
554  */
555 #define aco_option_register(info, name, matchtype, types, default_val, opt_type, flags, ...) \
556         __aco_option_register(info, name, matchtype, types, default_val, opt_type, NULL, flags, 0, VA_NARGS(__VA_ARGS__), __VA_ARGS__);
557
558 /*! \brief Register a config option
559  * \param info A pointer to the aco_info struct
560  * \param name The name of the option
561  * \param matchtype
562  * \param types An array of valid option types for matching categories to the correct struct type
563  * \param default_val The default value of the option in the same format as defined in a config file
564  * \param handler The handler callback for the option
565  * \param flags \a type specific flags, stored in the option and available to the handler
566  *
567  * \retval 0 Success
568  * \retval -1 Failure
569  */
570 #define aco_option_register_custom(info, name, matchtype, types, default_val, handler, flags) \
571         __aco_option_register(info, name, matchtype, types, default_val, OPT_CUSTOM_T, handler, flags, 0, 0);
572
573 /*! \brief Register a config option with no expected documentation
574  * \param info A pointer to the aco_info struct
575  * \param name The name of the option
576  * \param matchtype
577  * \param types An array of valid option types for matching categories to the correct struct type
578  * \param default_val The default value of the option in the same format as defined in a config file
579  * \param handler The handler callback for the option
580  * \param flags \a type specific flags, stored in the option and available to the handler
581  *
582  * \note This is used primarily with custom options that only have internal purposes
583  * and that should be ignored by the user.
584  *
585  * \retval 0 Success
586  * \retval -1 Failure
587  */
588 #define aco_option_register_custom_nodoc(info, name, matchtype, types, default_val, handler, flags) \
589         __aco_option_register(info, name, matchtype, types, default_val, OPT_CUSTOM_T, handler, flags, 1, 0);
590
591 /*! \brief Register a deprecated (and aliased) config option
592  * \param info A pointer to the aco_info struct
593  * \param name The name of the deprecated option
594  * \param types An array of valid option types for matching categories to the correct struct type
595  * \param aliased_to The name of the option that this deprecated option matches to
596  *
597  * \retval 0 Success
598  * \retval -1 Failure
599  */
600 int aco_option_register_deprecated(struct aco_info *info, const char *name, struct aco_type **types, const char *aliased_to);
601
602 /*!
603  * \brief Read the flags of a config option - useful when using a custom callback for a config option
604  * \since 12
605  *
606  * \param option Pointer to the aco_option struct
607  *
608  * \retval value of the flags on the config option
609  */
610 unsigned int aco_option_get_flags(const struct aco_option *option);
611
612 /*! \note  Everything below this point is to handle converting varargs
613  * containing field names, to varargs containing a count of args, followed
614  * by the offset of each of the field names in the struct type that is
615  * passed in. It is currently limited to 8 arguments, but 8 variadic
616  * arguments, like 640K, should be good enough for anyone. If not, it is
617  * easy to add more.
618  *
619  */
620
621 /*!
622  * \brief Map \a func(\a func_arg, field) across all fields including \a x
623  * \param func The function (almost certainly offsetof) to map across the fields
624  * \param func_arg The first argument (almost certainly a type (e.g. "struct mystruct")
625  * \param x The first field
626  * \param ... varargs The rest of the fields
627  *
628  * Example usage:
629  * \code
630  * struct foo {
631  *     int a;
632  *     char *b;
633  *     foo *c;
634  * };
635  * ARGMAP(offsetof, struct foo, a, c)
636  * \endcode
637  *
638  * produces the string:
639  *
640  * \code
641  * 2, offsetof(struct foo, a), offsetof(struct foo, b)
642  * \endcode
643  * which can be passed as the varargs to some other function
644  *
645  * The macro isn't limited to offsetof, but that is the only purpose for
646  * which it has been tested.
647  *
648  * As an example of how the processing works:
649  * \verbatim
650  * ARGMAP(offsetof, struct foo, a, b, c) ->
651  * ARGMAP_(3, offsetof, struct foo, a, b, c) ->
652  * ARGMAP_3(offsetof, struct foo, 3, a, b, c) ->
653  * ARGMAP_2(offsetof, struct foo, ARGIFY(3, offsetof(struct foo, a)), b, c) ->
654  * ARGMAP_1(offsetof, struct foo, ARGIFY(3, offsetof(struct foo, a), offsetof(struct foo, b)), c) ->
655  * ARGIFY(3, offsetof(struct foo, a), offsetof(struct foo, b), offsetof(struct foo, c)) ->
656  * 3, offsetof(struct foo, a), offsetof(struct foo, b), offsetof(struct foo, c)
657  * \endverbatim
658  *
659  */
660 #define ARGMAP(func, func_arg, x, ...) ARGMAP_(VA_NARGS(x, ##__VA_ARGS__), func, func_arg, x, __VA_ARGS__)
661
662 /*! \note This is sneaky. On the very first argument, we set "in" to N, the number of arguments, so
663  * that the accumulation both works properly for the first argument (since "in" can't be empty) and
664  * we get the number of arguments in our varargs as a bonus
665  */
666 #define ARGMAP_(N, func, func_arg, x, ...) PASTE(ARGMAP_, N)(func, func_arg, N, x, __VA_ARGS__)
667
668 /*! \def PASTE(arg1, arg2)
669  * \brief Paste two arguments together, even if they are macros themselves
670  * \note Uses two levels to handle the case where arg1 and arg2 are macros themselves
671  */
672 #define PASTE(arg1, arg2)  PASTE1(arg1, arg2)
673 #define PASTE1(arg1, arg2) arg1##arg2
674
675 /*! \brief Take a comma-separated list and allow it to be passed as a single argument to another macro */
676 #define ARGIFY(...) __VA_ARGS__
677
678 /*! \brief The individual field handlers for ARGMAP
679  * \param func The function (most likely offsetof)
680  * \param func_arg The first argument to func (most likely a type e.g. "struct my_struct")
681  * \param in The accumulated function-mapped field names so far
682  * \param x The next field name
683  * \param ... varargs The rest of the field names
684  */
685 #define ARGMAP_1(func, func_arg, in, x, ...) ARGIFY(in, func(func_arg, x))
686 #define ARGMAP_2(func, func_arg, in, x, ...)\
687         ARGMAP_1(func, func_arg, ARGIFY(in, func(func_arg, x)), __VA_ARGS__)
688 #define ARGMAP_3(func, func_arg, in, x, ...)\
689         ARGMAP_2(func, func_arg, ARGIFY(in, func(func_arg, x)), __VA_ARGS__)
690 #define ARGMAP_4(func, func_arg, in, x, ...)\
691         ARGMAP_3(func, func_arg, ARGIFY(in, func(func_arg, x)), __VA_ARGS__)
692 #define ARGMAP_5(func, func_arg, in, x, ...)\
693         ARGMAP_4(func, func_arg, ARGIFY(in, func(func_arg, x)), __VA_ARGS__)
694 #define ARGMAP_6(func, func_arg, in, x, ...)\
695         ARGMAP_5(func, func_arg, ARGIFY(in, func(func_arg, x)), __VA_ARGS__)
696 #define ARGMAP_7(func, func_arg, in, x, ...)\
697         ARGMAP_6(func, func_arg, ARGIFY(in, func(func_arg, x)), __VA_ARGS__)
698 #define ARGMAP_8(func, func_arg, in, x, ...)\
699         ARGMAP_7(func, func_arg, ARGIFY(in, func(func_arg, x)), __VA_ARGS__)
700
701 /*! \def VA_NARGS(...)
702  * \brief Results in the number of arguments passed to it
703  * \note Currently only up to 8, but expanding is easy. This macro basically counts
704  * commas + 1. To visualize:
705  * \verbatim
706  * VA_NARGS(one, two, three) ->                    v
707  * VA_NARGS1(one, two, three,  8,  7,  6,  5,  4,  3,  2,  1,  0) ->
708  * VA_NARGS1( _1,  _2,    _3, _4, _5, _6, _7, _8,  N, ...       ) N -> 3
709  * 
710  * Note that VA_NARGS *does not* work when there are no arguments passed. Pasting an empty
711  * __VA_ARGS__ with a comma like ", ##__VA_ARGS__" will delete the leading comma, but it
712  * does not work when __VA_ARGS__ is the first argument. Instead, 1 is returned instead of 0:
713  * 
714  * VA_NARGS() ->                              v
715  * VA_NARGS1(  ,  8,  7,  6,  5,  4,  3,  2,  1,  0) ->
716  * VA_NARGS1(_1, _2, _3, _4, _5, _6, _7, _8,  N) -> 1
717  * \endverbatim
718  */
719 #define VA_NARGS(...) VA_NARGS1(__VA_ARGS__, 8, 7, 6, 5, 4, 3, 2, 1, 0)
720 #define VA_NARGS1(_1, _2, _3, _4, _5, _6, _7, _8, N, ...) N
721
722 /*! \def FLDSET(type, ...)
723  * \brief Convert a struct and list of fields to an argument list of field offsets
724  * \param type The type with the fields (e.g. "struct my_struct")
725  * \param ... varags The fields in the struct whose offsets are needed as arguments
726  *
727  * For example:
728  * \code
729  * struct foo {int a, char b[128], char *c};
730  * FLDSET(struct foo, a, c)
731  * \endcode
732  *
733  * produces
734  * \code
735  * offsetof(struct foo, a), offsetof(struct foo, c)
736  * \endcode
737  */
738 #define FLDSET(type, ...) FLDSET1(type, ##__VA_ARGS__)
739 #define FLDSET1(type, ...) POPPED(ARGMAP(offsetof, type, ##__VA_ARGS__))
740
741 /*! \def STRFLDSET(type, ...)
742  * \brief Convert a struct and a list of stringfield fields to an argument list of field offsets
743  * \note Stringfields require the passing of the field manager pool, and field manager to the
744  * default stringfield option handler, so registering options that point to stringfields requires
745  * this macro to be called instead of the FLDSET macro.
746  * \param type The type with the fields (e.g. "struct my_struct")
747  * \param ... varargs The fields in the struct whose offsets are needed as arguments
748  */
749 #define STRFLDSET(type, ...) FLDSET(type, __VA_ARGS__, __field_mgr_pool, __field_mgr)
750
751 /*! \def CHARFLDSET(type, field)
752  * \brief A helper macro to pass the appropriate arguments to aco_option_register for OPT_CHAR_ARRAY_T
753  * \note This will pass the offset of the field and its length as arguments
754  * \param type The type with the char array field (e.g. "struct my_struct")
755  * \param field The name of char array field
756  */
757 #define CHARFLDSET(type, field) ARGIFY(offsetof(type, field), sizeof(((type *)0)->field))
758
759 /*! \def POPPED(...)
760  * \brief A list of arguments without the first argument
761  * \note Used internally to remove the leading "number of arguments" argument from ARGMAP for
762  * FLDSET. This is because a call to FLDSET may be followed by additional arguments in
763  * aco_register_option, so the true number of arguments will possibly be different than what
764  * ARGMAP returns.
765  * \param ... varags A list of arguments
766  * \verbatim
767  * POPPED(a, b, c) -> b, c
768  * \endverbatim
769  */
770 #define POPPED(...) POPPED1(__VA_ARGS__)
771 #define POPPED1(x, ...) __VA_ARGS__
772
773 #if defined(__cplusplus) || defined(c_plusplus)
774 }
775 #endif
776
777 #endif /* _ASTERISK_CONFIG_OPTIONS_H */