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