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