parse-options.h

   1 #ifndef PARSE_OPTIONS_H
   2 #define PARSE_OPTIONS_H
   3
   4 enum parse_opt_type {
   5         /* special types */
   6         OPTION_END,
   7         OPTION_ARGUMENT,
   8         OPTION_GROUP,
   9         /* options with no arguments */
  10         OPTION_BIT,
  11         OPTION_BOOLEAN, /* _INCR would have been a better name */
  12         OPTION_SET_INT,
  13         OPTION_SET_PTR,
  14         /* options with arguments (usually) */
  15         OPTION_STRING,
  16         OPTION_INTEGER,
  17         OPTION_CALLBACK,
  18 };
  19
  20 enum parse_opt_flags {
  21         PARSE_OPT_KEEP_DASHDASH = 1,
  22 };
  23
  24 enum parse_opt_option_flags {
  25         PARSE_OPT_OPTARG  = 1,
  26         PARSE_OPT_NOARG   = 2,
  27         PARSE_OPT_NONEG   = 4,
  28         PARSE_OPT_HIDDEN  = 8,
  29 };
  30
  31 struct option;
  32 typedef int parse_opt_cb(const struct option *, const char *arg, int unset);
  33
  34 /*
  35  * `type`::
  36  *   holds the type of the option, you must have an OPTION_END last in your
  37  *   array.
  38  *
  39  * `short_name`::
  40  *   the character to use as a short option name, '\0' if none.
  41  *
  42  * `long_name`::
  43  *   the long option name, without the leading dashes, NULL if none.
  44  *
  45  * `value`::
  46  *   stores pointers to the values to be filled.
  47  *
  48  * `argh`::
  49  *   token to explain the kind of argument this option wants. Keep it
  50  *   homogenous across the repository.
  51  *
  52  * `help`::
  53  *   the short help associated to what the option does.
  54  *   Must never be NULL (except for OPTION_END).
  55  *   OPTION_GROUP uses this pointer to store the group header.
  56  *
  57  * `flags`::
  58  *   mask of parse_opt_option_flags.
  59  *   PARSE_OPT_OPTARG: says that the argument is optionnal (not for BOOLEANs)
  60  *   PARSE_OPT_NOARG: says that this option takes no argument, for CALLBACKs
  61  *   PARSE_OPT_NONEG: says that this option cannot be negated
  62  *   PARSE_OPT_HIDDEN this option is skipped in the default usage, showed in
  63  *                    the long one.
  64  *
  65  * `callback`::
  66  *   pointer to the callback to use for OPTION_CALLBACK.
  67  *
  68  * `defval`::
  69  *   default value to fill (*->value) with for PARSE_OPT_OPTARG.
  70  *   OPTION_{BIT,SET_INT,SET_PTR} store the {mask,integer,pointer} to put in
  71  *   the value when met.
  72  *   CALLBACKS can use it like they want.
  73  */
  74 struct option {
  75         enum parse_opt_type type;
  76         int short_name;
  77         const char *long_name;
  78         void *value;
  79         const char *argh;
  80         const char *help;
  81
  82         int flags;
  83         parse_opt_cb *callback;
  84         intptr_t defval;
  85 };
  86
  87 #define OPT_END()                   { OPTION_END }
  88 #define OPT_ARGUMENT(l, h)          { OPTION_ARGUMENT, 0, (l), NULL, NULL, (h) }
  89 #define OPT_GROUP(h)                { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
  90 #define OPT_BIT(s, l, v, h, b)      { OPTION_BIT, (s), (l), (v), NULL, (h), 0, NULL, (b) }
  91 #define OPT_BOOLEAN(s, l, v, h)     { OPTION_BOOLEAN, (s), (l), (v), NULL, (h) }
  92 #define OPT_SET_INT(s, l, v, h, i)  { OPTION_SET_INT, (s), (l), (v), NULL, (h), 0, NULL, (i) }
  93 #define OPT_SET_PTR(s, l, v, h, p)  { OPTION_SET_PTR, (s), (l), (v), NULL, (h), 0, NULL, (p) }
  94 #define OPT_INTEGER(s, l, v, h)     { OPTION_INTEGER, (s), (l), (v), NULL, (h) }
  95 #define OPT_STRING(s, l, v, a, h)   { OPTION_STRING,  (s), (l), (v), (a), (h) }
  96 #define OPT_CALLBACK(s, l, v, a, h, f) \
  97         { OPTION_CALLBACK, (s), (l), (v), (a), (h), 0, (f) }
  98
  99 /* parse_options() will filter out the processed options and leave the
 100  * non-option argments in argv[].
 101  * Returns the number of arguments left in argv[].
 102  */
 103 extern int parse_options(int argc, const char **argv,
 104                          const struct option *options,
 105                          const char * const usagestr[], int flags);
 106
 107 extern NORETURN void usage_with_options(const char * const *usagestr,
 108                                         const struct option *options);
 109
 110 /*----- some often used options -----*/
 111 extern int parse_opt_abbrev_cb(const struct option *, const char *, int);
 112
 113 #define OPT__VERBOSE(var)  OPT_BOOLEAN('v', "verbose", (var), "be verbose")
 114 #define OPT__QUIET(var)    OPT_BOOLEAN('q', "quiet",   (var), "be quiet")
 115 #define OPT__DRY_RUN(var)  OPT_BOOLEAN('n', "dry-run", (var), "dry run")
 116 #define OPT__ABBREV(var)  \
 117         { OPTION_CALLBACK, 0, "abbrev", (var), "n", \
 118           "use <n> digits to display SHA-1s", \
 119           PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
 120
 121 #endif