]> mj.ucw.cz Git - libucw.git/blob - ucw/opt.h
Merge branch 'master' into dev-sizet
[libucw.git] / ucw / opt.h
1 /*
2  *      UCW Library -- Parsing of command line options
3  *
4  *      (c) 2013 Jan Moskyto Matejka <mq@ucw.cz>
5  *      (c) 2014 Martin Mares <mj@ucw.cz>
6  *      (c) 2014 Pavel Charvat <pchar@ucw.cz>
7  *
8  *      This software may be freely distributed and used according to the terms
9  *      of the GNU Lesser General Public License.
10  */
11
12 #ifndef _UCW_OPT_H
13 #define _UCW_OPT_H
14
15 #include <ucw/lib.h>
16 #include <ucw/conf.h>
17
18 #include <stdlib.h>
19 #include <stdio.h>
20
21 #ifdef CONFIG_UCW_CLEAN_ABI
22 #define cf_def_file ucw_cf_def_file
23 #define cf_env_file ucw_cf_env_file
24 #define opt_conf_hook_internal ucw_opt_conf_hook_internal
25 #define opt_failure ucw_opt_failure
26 #define opt_handle_config ucw_opt_handle_config
27 #define opt_handle_dumpconfig ucw_opt_handle_dumpconfig
28 #define opt_handle_help ucw_opt_handle_help
29 #define opt_handle_set ucw_opt_handle_set
30 #define opt_help ucw_opt_help
31 #define opt_parse ucw_opt_parse
32 #endif
33
34 #define OPT_EXIT_BAD_ARGS 2
35
36 /***
37  * [[classes]]
38  * Option classes
39  * --------------
40  *
41  * Each option belongs to one of the following classes, which define
42  * the overall behavior of the option. In most cases, the classes
43  * are set automatically by <<macros,declaration macros>>.
44  *
45  * - `OPT_CL_END`: this is not a real option class, but a signal
46  *   that the list of options ends.
47  * - `OPT_CL_BOOL`: a boolean option. If specified without an argument,
48  *   it sets the corresponding variable to 1 (true). So does an argument of
49  *   `1`, `y`, `yes`, or `true`. Conversely, an argument of `0`, `n`, `no`,
50  *   or `false` sets the variable to 0 (false) and the same happens if
51  *   the option is given as `--no-`'option' with no argument.
52  * - `OPT_CL_STATIC`: options of this class just take a value and store
53  *   it in the variable.
54  * - `OPT_CL_MULTIPLE`: collect values from all occurrences of this
55  *   option in a growing array (see `gary.h`).
56  * - `OPT_CL_SWITCH`: a multiple-choice switch, which sets the variable
57  *   to a fixed value provided in option definition.
58  * - `OPT_CL_INC`: increments the variable (or decrements, if the
59  *   `OPT_NEGATIVE` flag is set).
60  * - `OPT_CL_CALL`: instead of setting a variable, call a function
61  *   and pass the value of the option to it.
62  * - `OPT_CL_SECTION`: not a real option, but an instruction to insert
63  *   contents of another list of options.
64  * - `OPT_CL_HELP`: no option, just print a help text.
65  * - `OPT_CL_HOOK`: no option, but a definition of a <<hooks,hook>>.
66  ***/
67
68 enum opt_class {
69   OPT_CL_END,
70   OPT_CL_BOOL,
71   OPT_CL_STATIC,
72   OPT_CL_MULTIPLE,
73   OPT_CL_SWITCH,
74   OPT_CL_INC,
75   OPT_CL_CALL,
76   OPT_CL_SECTION,
77   OPT_CL_HELP,
78   OPT_CL_HOOK,
79 };
80
81 /***
82  * [[opt_item]]
83  * Option definitions
84  * ------------------
85  *
86  * The list of options is represented by `struct opt_section`, which points to
87  * a sequence of `struct opt_item`s.
88  *
89  * These structures are seldom used directly -- instead, they are produced
90  * by <<macros,declaration macros>>.
91  ***/
92
93 /** A section of option list. **/
94 struct opt_section {
95   struct opt_item * opt;
96 };
97
98 /** A definition of a single option item. **/
99 struct opt_item {
100   const char * name;                    // long name (NULL if none)
101   int letter;                           // short name (0 if none)
102   void * ptr;                           // variable to store the value to
103   const char * help;                    // description in --help (NULL to omit the option from the help)
104   union opt_union {
105     struct opt_section * section;       // subsection for OPT_CL_SECTION
106     int value;                          // value for OPT_CL_SWITCH
107     void (* call)(struct opt_item * opt, const char * value, void * data);              // function to call for OPT_CL_CALL
108     void (* hook)(struct opt_item * opt, uint event, const char * value, void * data);  // function to call for OPT_CL_HOOK
109     struct cf_user_type * utype;        // specification of the user-defined type for CT_USER
110   } u;
111   u16 flags;                            // as defined below (for hooks, event mask is stored instead)
112   byte cls;                             // enum opt_class
113   byte type;                            // enum cf_type
114 };
115
116 /***
117  * [[flags]]
118  * Option flags
119  * ------------
120  *
121  * Each option can specify a combination of the following flags.
122  ***/
123
124 #define OPT_REQUIRED        0x1         /** The option must be always present. **/
125 #define OPT_REQUIRED_VALUE  0x2         /** The option must have a value. **/
126 #define OPT_NO_VALUE        0x4         /** The option must have no value. **/
127 #define OPT_MAYBE_VALUE     0x8         /** The option may have a value. **/
128 #define OPT_NEGATIVE        0x10        /** Reversing the effect of OPT_INC or saving @false into OPT_BOOL. **/
129 #define OPT_LAST_ARG        0x40        /** Stop processing arguments after this line. **/
130 #define OPT_SINGLE          0x100       /** The option must appear at most once. **/
131 #define OPT_MULTIPLE        0x200       /** The option may appear multiple times; will save all the values into a simple list. **/
132 #define OPT_SEEN_AS_LONG    0x400       // Used internally to signal that we currently process the long form of the option
133 #define OPT_BEFORE_CONFIG   0x800       /** The option may appear before a config file is loaded. **/
134 #define OPT_INTERNAL        0x4000      // Used internally to ask for passing of struct opt_context to OPT_CALL
135
136 /**
137  * If none of these flags are specified, a default is chosen automatically
138  * according to option class:
139  *
140  * - `OPT_MAYBE_VALUE` for `OPT_CL_STATIC`
141  * - `OPT_REQUIRED_VALUE` for `OPT_CL_MULTIPLE`
142  * - `OPT_NO_VALUE` for `OPT_CL_BOOL`, `OPT_CL_SWITCH` and `OPT_CL_INC`
143  * - An error is reported in all other cases.
144  **/
145 #define OPT_VALUE_FLAGS     (OPT_REQUIRED_VALUE | OPT_NO_VALUE | OPT_MAYBE_VALUE)
146
147 /***
148  * [[macros]]
149  * Macros for declaration of options
150  * ---------------------------------
151  *
152  * In most cases, option definitions are built using these macros.
153  ***/
154
155 /** Used inside `struct opt_section` to start a list of items. **/
156 #define OPT_ITEMS       .opt = ( struct opt_item[] )
157
158 /** No option, just a piece of help text. **/
159 #define OPT_HELP(line) { .help = line, .cls = OPT_CL_HELP }
160
161 /** Standard `--help` option. **/
162 #define OPT_HELP_OPTION OPT_CALL(0, "help", opt_handle_help, NULL, OPT_BEFORE_CONFIG | OPT_INTERNAL | OPT_NO_VALUE, "\tShow this help")
163
164 /** Boolean option. @target should be a variable of type `int`. **/
165 #define OPT_BOOL(shortopt, longopt, target, fl, desc) { .letter = shortopt, .name = longopt, .ptr = CHECK_PTR_TYPE(&target, int *), .help = desc, .flags = fl, .cls = OPT_CL_BOOL, .type = CT_INT }
166
167 /** String option. @target should be a variable of type `char *`. **/
168 #define OPT_STRING(shortopt, longopt, target, fl, desc) { .letter = shortopt, .name = longopt, .ptr = CHECK_PTR_TYPE(&target, char **), .help = desc, .flags = fl, .cls = OPT_CL_STATIC, .type = CT_STRING }
169
170 /** Ordinary integer option. @target should be a variable of type `int`. **/
171 #define OPT_INT(shortopt, longopt, target, fl, desc) { .letter = shortopt, .name = longopt, .ptr = CHECK_PTR_TYPE(&target, int *), .help = desc, .flags = fl, .cls = OPT_CL_STATIC, .type = CT_INT }
172
173 /** Unsigned integer option. @target should be a variable of type `uint`. **/
174 #define OPT_UINT(shortopt, longopt, target, fl, desc) { .letter = shortopt, .name = longopt, .ptr = CHECK_PTR_TYPE(&target, uint *), .help = desc, .flags = fl, .cls = OPT_CL_STATIC, .type = CT_INT }
175
176 /** 64-bit integer option. @target should be a variable of type `u64`. **/
177 #define OPT_U64(shortopt, longopt, target, fl, desc) { .letter = shortopt, .name = longopt, .ptr = CHECK_PTR_TYPE(&target, u64 *), .help = desc, .flags = fl, .cls = OPT_CL_STATIC, .type = CT_U64 }
178
179 /** Floating-point option. @target should be a variable of type `double`. **/
180 #define OPT_DOUBLE(shortopt, longopt, target, fl, desc) { .letter = shortopt, .name = longopt, .ptr = CHECK_PTR_TYPE(&target, double *), .help = desc, .flags = fl, .cls = OPT_CL_STATIC, .type = CT_DOUBLE }
181
182 /** IP address option, currently IPv4 only. @target should be a variable of type `u32`. **/
183 #define OPT_IP(shortopt, longopt, target, fl, desc) { .letter = shortopt, .name = longopt, .ptr = CHECK_PTR_TYPE(&target, u32 *), .help = desc, .flags = fl, .cls = OPT_CL_STATIC, .type = CT_IP }
184
185 /** Multi-valued string option. @target should be a growing array of `char *`s. **/
186 #define OPT_STRING_MULTIPLE(shortopt, longopt, target, fl, desc) { .letter = shortopt, .name = longopt, .ptr = CHECK_PTR_TYPE(&target, char ***), .help = desc, .flags = fl, .cls = OPT_CL_MULTIPLE, .type = CT_STRING }
187
188 /** Multi-valued integer option. @target should be a growing array of `int`s. **/
189 #define OPT_INT_MULTIPLE(shortopt, longopt, target, fl, desc) { .letter = shortopt, .name = longopt, .ptr = CHECK_PTR_TYPE(&target, int **), .help = desc, .flags = fl, .cls = OPT_CL_MULTIPLE, .type = CT_INT }
190
191 /** Multi-valued unsigned integer option. @target should be a growing array of `uint`s. **/
192 #define OPT_UINT_MULTIPLE(shortopt, longopt, target, fl, desc) { .letter = shortopt, .name = longopt, .ptr = CHECK_PTR_TYPE(&target, uint **), .help = desc, .flags = fl, .cls = OPT_CL_MULTIPLE, .type = CT_INT }
193
194 /** Multi-valued 64-bit integer option. @target should be a growing array of `u64`s. **/
195 #define OPT_U64_MULTIPLE(shortopt, longopt, target, fl, desc) { .letter = shortopt, .name = longopt, .ptr = CHECK_PTR_TYPE(&target, u64 **), .help = desc, .flags = fl, .cls = OPT_CL_MULTIPLE, .type = CT_U64 }
196
197 /** Multi-valued floating-point option. @target should be a growing array of `double`s. **/
198 #define OPT_DOUBLE_MULTIPLE(shortopt, longopt, target, fl, desc) { .letter = shortopt, .name = longopt, .ptr = CHECK_PTR_TYPE(&target, double **), .help = desc, .flags = fl, .cls = OPT_CL_MULTIPLE, .type = CT_DOUBLE }
199
200 /** Multi-valued IPv4 address option. @target should be a growing array of `u32`s. **/
201 #define OPT_IP_MULTIPLE(shortopt, longopt, target, fl, desc) { .letter = shortopt, .name = longopt, .ptr = CHECK_PTR_TYPE(&target, u32 **), .help = desc, .flags = fl, .cls = OPT_CL_MULTIPLE, .type = CT_IP }
202
203 /** Switch option. @target should be a variable of type `int` and it will be set to the value @val. **/
204 #define OPT_SWITCH(shortopt, longopt, target, val, fl, desc) { .letter = shortopt, .name = longopt, .ptr = CHECK_PTR_TYPE(&target, int *), .help = desc, .flags = fl, .cls = OPT_CL_SWITCH, .type = CT_LOOKUP, .u.value = val }
205
206 /** Incrementing option. @target should be a variable of type `int`. **/
207 #define OPT_INC(shortopt, longopt, target, fl, desc) { .letter = shortopt, .name = longopt, .ptr = CHECK_PTR_TYPE(&target, int *), .flags = fl, .help = desc, .cls = OPT_CL_INC, .type = CT_INT }
208
209 /* FIXME: Backwards compatibility only, should not be used anymore. */
210 #define OPT_UNS OPT_UINT
211 #define OPT_UNS_MULTIPLE OPT_UINT_MULTIPLE
212
213
214 /**
215  * When this option appears, call the function @fn with parameters @item, @value, @data,
216  * where @item points to the <<struct_opt_item,`struct opt_item`>> of this option,
217  * @value contains the current argument of the option (NULL if there is none),
218  * and @data is specified here.
219  **/
220 #define OPT_CALL(shortopt, longopt, fn, data, fl, desc) { .letter = shortopt, .name = longopt, .ptr = data, .help = desc, .u.call = fn, .flags = fl, .cls = OPT_CL_CALL, .type = CT_USER }
221
222 /**
223  * An option with user-defined syntax. @ttype is a <<conf:struct_cf_user_type,`cf_user_type`>>
224  * describing the syntax, @target is a variable of the corresponding type. If the @OPT_REQUIRED_VALUE
225  * flag is not set, the parser must be able to parse a NULL value.
226  **/
227 #define OPT_USER(shortopt, longopt, target, ttype, fl, desc) { .letter = shortopt, .name = longopt, .ptr = &target, .u.utype = &ttype, .flags = fl, .help = desc, .cls = OPT_CL_STATIC, .type = CT_USER }
228
229 /** Multi-valued option of user-defined type. @target should be a growing array of the right kind of items. **/
230 #define OPT_USER_MULTIPLE(shortopt, longopt, target, ttype, fl, desc) { .letter = shortopt, .name = longopt, .ptr = &target, .u.utype = &ttype, .flags = fl, .help = desc, .cls = OPT_CL_MULTIPLE, .type = CT_USER }
231
232 /** A sub-section. **/
233 #define OPT_SECTION(sec) { .cls = OPT_CL_SECTION, .u.section = &sec }
234
235 /** Declares a <<hooks,hook>> to call upon any event from the specified set. **/
236 #define OPT_HOOK(fn, data, events) { .cls = OPT_CL_HOOK, .u.hook = fn, .flags = events, .ptr = data }
237
238 /** A terminator signalling the end of the option list. **/
239 #define OPT_END { .cls = OPT_CL_END }
240
241 /***
242  * [[positional]]
243  * Positional arguments
244  * --------------------
245  *
246  * In addition to short and long options, the parser can also process 'positional
247  * arguments', which don't start with a dash and whose meaning depends solely on
248  * their position.
249  *
250  * Positional arguments are declared as options with short name `OPT_POSITIONAL(n)`
251  * (where `n` is the position of the argument, starting with 1) and long name
252  * NULL. To accept an arbitrary number of positional arguments, use
253  * `OPT_POSITIONAL_TAIL` instead, which matches all arguments, for which no
254  * `OPT_POSITIONAL` is defined. (In the latter case, you probably want to define
255  * the argument as `OPT_MULTIPLE` or `OPT_CALL`, so that the values do not
256  * overwrite each other.)
257  *
258  * Options and positional arguments can be mixed arbitrarily. When a `--` appears
259  * as an argument, it is understood as a signal that all other arguments are
260  * positional.
261  *
262  * `OPT_REQUIRED` can be used with positional arguments, but all required arguments
263  * must come before the non-required ones. When `OPT_POSITIONAL_TAIL` is declared
264  * required, it means that it must match at least once.
265  *
266  * Ordering of positional arguments within the list of options need not match
267  * their positions. Holes in position numbering are inadvisable.
268  ***/
269
270 #define OPT_POSITIONAL(n)   (OPT_POSITIONAL_TAIL+(n))
271 #define OPT_POSITIONAL_TAIL 128
272
273 /***
274  * [[func]]
275  * Functions
276  * ---------
277  ***/
278
279 /**
280  * Parse all arguments, given in a NULL-terminated array of strings.
281  *
282  * Typically, this is called from `main(argc, argv)` as `opt_parse(options, argv+1)`,
283  * skipping the 0th argument, which contains program name.
284  *
285  * Returns the number of arguments used (which need not be all of them
286  * if `OPT_LAST_ARG` was encountered).
287  *
288  * The argument array is left untouched.
289  * However, option values are not necessarily copied, the variables
290  * set by the parser may point to the argument array.
291  **/
292 int opt_parse(const struct opt_section * options, char ** argv);
293
294 /**
295  * Report parsing failure, suggest `--help`, and abort the program with
296  * exit code 2.
297  **/
298 void opt_failure(const char * mesg, ...) FORMAT_CHECK(printf,1,2) NONRET;
299
300 void opt_help(const struct opt_section * sec);
301 void opt_handle_help(struct opt_item * opt, const char * value, void * data);
302
303 /***
304  * [[conf]]
305  * Cooperating with config file parser
306  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
307  *
308  * Parsing of command-line options and configuration files are usually
309  * intertwined in a somewhat tricky way. We want to provide command-line
310  * options that control the name of the configuration file, or possibly to
311  * override configuration settings from the command line. On the other hand,
312  * regular command-line options can refer to values loaded from the
313  * program's configuration.
314  *
315  * To achieve this goal, the option parser is able to cooperate with the
316  * config file parser. This is enabled by listing the `OPT_CONF_OPTIONS`
317  * macro in the list of command-line options.
318  *
319  * The following options are defined for you:
320  *
321  * - `-C` (`--config`) to load a specific configuration file. This option
322  *   suppresses loading of the default configuration, but it can be given
323  *   multiple times to merge settings from several files.
324  *
325  * - `-S` (`--set`) to include a part of configuration inline. For example,
326  *   you can use `-Ssection.item=value` to change a single configuration item.
327  *
328  * - `--dumpconfig` to dump the configuration to standard output and exit.
329  *   (This is available only if the program is compiled with `CONFIG_UCW_DEBUG`.)
330  *
331  * The default configuration file (as specified by <<var_cf_def_file,`cf_def_file`>>) is loaded
332  * as soon as the first option different from `-C` is encountered, unless
333  * a different file has been already loaded. For this reason, `-C` must be
334  * the very first argument given to the program.
335  *
336  * This interface supersedes <<conf:getopt_h,`cf_getopt()`>>.
337  ***/
338
339 #ifdef CONFIG_UCW_DEBUG
340 #define OPT_CONF_OPTIONS    OPT_CONF_CONFIG, OPT_CONF_SET, OPT_CONF_DUMPCONFIG, OPT_CONF_HOOK
341 #else
342 #define OPT_CONF_OPTIONS    OPT_CONF_CONFIG, OPT_CONF_SET, OPT_CONF_HOOK
343 #endif
344
345 #define OPT_CONF_CONFIG     OPT_CALL('C', "config", opt_handle_config, NULL, OPT_BEFORE_CONFIG | OPT_INTERNAL | OPT_REQUIRED_VALUE, "<file>\tOverride the default configuration file")
346 #define OPT_CONF_SET        OPT_CALL('S', "set", opt_handle_set, NULL, OPT_BEFORE_CONFIG | OPT_INTERNAL | OPT_REQUIRED_VALUE, "<item>\tManual setting of a configuration item")
347 #define OPT_CONF_DUMPCONFIG OPT_CALL(0, "dumpconfig", opt_handle_dumpconfig, NULL, OPT_INTERNAL | OPT_NO_VALUE, "\tDump program configuration")
348 #define OPT_CONF_HOOK       OPT_HOOK(opt_conf_hook_internal, NULL, OPT_HOOK_BEFORE_VALUE | OPT_HOOK_FINAL | OPT_HOOK_INTERNAL)
349
350 void opt_handle_config(struct opt_item * opt, const char * value, void * data);
351 void opt_handle_set(struct opt_item * opt, const char * value, void * data);
352 void opt_handle_dumpconfig(struct opt_item * opt, const char * value, void * data);
353 void opt_conf_hook_internal(struct opt_item * opt, uint event, const char * value, void * data);
354
355 // XXX: This is duplicated with <ucw/getopt.h>, but that one will hopefully go away one day.
356 /**
357  * The name of the default configuration file (NULL if configuration has been
358  * already loaded). It is initialized to `CONFIG_UCW_DEFAULT_CONFIG`, but you
359  * usually want to replace it by your own config file.
360  */
361 extern char *cf_def_file;
362 /**
363  * Name of environment variable that can override what configuration is loaded.
364  * Defaults to the value of the `CONFIG_UCW_ENV_VAR_CONFIG` compile-time option.
365  **/
366 extern char *cf_env_file;
367
368 /***
369  * [[hooks]]
370  * Hooks
371  * -----
372  *
373  * You can supply hook functions, which will be called by the parser upon various
374  * events. Hooks are declared as option items of class `OPT_CL_HOOK`, whose @flags
375  * field specifies a mask of events the hook wants to receive.
376  *
377  * Please note that the hook interface is not considered stable yet,
378  * so it might change in future versions of libucw.
379  *
380  * The following events are defined:
381  ***/
382
383 #define OPT_HOOK_BEFORE_ARG     0x1     /** Call before option parsing **/
384 #define OPT_HOOK_BEFORE_VALUE   0x2     /** Call before value parsing **/
385 #define OPT_HOOK_AFTER_VALUE    0x4     /** Call after value parsing **/
386 #define OPT_HOOK_FINAL          0x8     /** Call just before @opt_parse() returns **/
387 #define OPT_HOOK_INTERNAL       0x4000  // Used internally to ask for passing of struct opt_context
388
389 #endif