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