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