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         OPTION_NUMBER,
  10         /* options with no arguments */
  11         OPTION_BIT,
  12         OPTION_NEGBIT,
  13         OPTION_BOOLEAN, /* _INCR would have been a better name */
  14         OPTION_SET_INT,
  15         OPTION_SET_PTR,
  16         /* options with arguments (usually) */
  17         OPTION_STRING,
  18         OPTION_INTEGER,
  19         OPTION_CALLBACK,
  20 };
  21
  22 enum parse_opt_flags {
  23         PARSE_OPT_KEEP_DASHDASH = 1,
  24         PARSE_OPT_STOP_AT_NON_OPTION = 2,
  25         PARSE_OPT_KEEP_ARGV0 = 4,
  26         PARSE_OPT_KEEP_UNKNOWN = 8,
  27         PARSE_OPT_NO_INTERNAL_HELP = 16,
  28 };
  29
  30 enum parse_opt_option_flags {
  31         PARSE_OPT_OPTARG  = 1,
  32         PARSE_OPT_NOARG   = 2,
  33         PARSE_OPT_NONEG   = 4,
  34         PARSE_OPT_HIDDEN  = 8,
  35         PARSE_OPT_LASTARG_DEFAULT = 16,
  36         PARSE_OPT_NODASH = 32,
  37 };
  38
  39 struct option;
  40 typedef int parse_opt_cb(const struct option *, const char *arg, int unset);
  41
  42 /*
  43  * `type`::
  44  *   holds the type of the option, you must have an OPTION_END last in your
  45  *   array.
  46  *
  47  * `short_name`::
  48  *   the character to use as a short option name, '\0' if none.
  49  *
  50  * `long_name`::
  51  *   the long option name, without the leading dashes, NULL if none.
  52  *
  53  * `value`::
  54  *   stores pointers to the values to be filled.
  55  *
  56  * `argh`::
  57  *   token to explain the kind of argument this option wants. Keep it
  58  *   homogeneous across the repository.
  59  *
  60  * `help`::
  61  *   the short help associated to what the option does.
  62  *   Must never be NULL (except for OPTION_END).
  63  *   OPTION_GROUP uses this pointer to store the group header.
  64  *
  65  * `flags`::
  66  *   mask of parse_opt_option_flags.
  67  *   PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs)
  68  *   PARSE_OPT_NOARG: says that this option takes no argument, for CALLBACKs
  69  *   PARSE_OPT_NONEG: says that this option cannot be negated
  70  *   PARSE_OPT_HIDDEN: this option is skipped in the default usage, and
  71  *                     shown only in the full usage.
  72  *   PARSE_OPT_LASTARG_DEFAULT: if no argument is given, the default value
  73  *                              is used.
  74  *   PARSE_OPT_NODASH: this option doesn't start with a dash.
  75  *
  76  * `callback`::
  77  *   pointer to the callback to use for OPTION_CALLBACK.
  78  *
  79  * `defval`::
  80  *   default value to fill (*->value) with for PARSE_OPT_OPTARG.
  81  *   OPTION_{BIT,SET_INT,SET_PTR} store the {mask,integer,pointer} to put in
  82  *   the value when met.
  83  *   CALLBACKS can use it like they want.
  84  */
  85 struct option {
  86         enum parse_opt_type type;
  87         int short_name;
  88         const char *long_name;
  89         void *value;
  90         const char *argh;
  91         const char *help;
  92
  93         int flags;
  94         parse_opt_cb *callback;
  95         intptr_t defval;
  96 };
  97
  98 #define OPT_END()                   { OPTION_END }
  99 #define OPT_ARGUMENT(l, h)          { OPTION_ARGUMENT, 0, (l), NULL, NULL, (h) }
 100 #define OPT_GROUP(h)                { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
 101 #define OPT_BIT(s, l, v, h, b)      { OPTION_BIT, (s), (l), (v), NULL, (h), 0, NULL, (b) }
 102 #define OPT_NEGBIT(s, l, v, h, b)   { OPTION_NEGBIT, (s), (l), (v), NULL, (h), 0, NULL, (b) }
 103 #define OPT_BOOLEAN(s, l, v, h)     { OPTION_BOOLEAN, (s), (l), (v), NULL, (h) }
 104 #define OPT_SET_INT(s, l, v, h, i)  { OPTION_SET_INT, (s), (l), (v), NULL, (h), 0, NULL, (i) }
 105 #define OPT_SET_PTR(s, l, v, h, p)  { OPTION_SET_PTR, (s), (l), (v), NULL, (h), 0, NULL, (p) }
 106 #define OPT_INTEGER(s, l, v, h)     { OPTION_INTEGER, (s), (l), (v), NULL, (h) }
 107 #define OPT_STRING(s, l, v, a, h)   { OPTION_STRING,  (s), (l), (v), (a), (h) }
 108 #define OPT_DATE(s, l, v, h) \
 109         { OPTION_CALLBACK, (s), (l), (v), "time",(h), 0, \
 110           parse_opt_approxidate_cb }
 111 #define OPT_CALLBACK(s, l, v, a, h, f) \
 112         { OPTION_CALLBACK, (s), (l), (v), (a), (h), 0, (f) }
 113 #define OPT_NUMBER_CALLBACK(v, h, f) \
 114         { OPTION_NUMBER, 0, NULL, (v), NULL, (h), \
 115           PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) }
 116
 117 /* parse_options() will filter out the processed options and leave the
 118  * non-option arguments in argv[].
 119  * Returns the number of arguments left in argv[].
 120  */
 121 extern int parse_options(int argc, const char **argv,
 122                          const struct option *options,
 123                          const char * const usagestr[], int flags);
 124
 125 extern NORETURN void usage_with_options(const char * const *usagestr,
 126                                         const struct option *options);
 127
 128 /*----- incremental advanced APIs -----*/
 129
 130 enum {
 131         PARSE_OPT_HELP = -1,
 132         PARSE_OPT_DONE,
 133         PARSE_OPT_UNKNOWN,
 134 };
 135
 136 /*
 137  * It's okay for the caller to consume argv/argc in the usual way.
 138  * Other fields of that structure are private to parse-options and should not
 139  * be modified in any way.
 140  */
 141 struct parse_opt_ctx_t {
 142         const char **argv;
 143         const char **out;
 144         int argc, cpidx;
 145         const char *opt;
 146         int flags;
 147 };
 148
 149 extern int parse_options_usage(const char * const *usagestr,
 150                                const struct option *opts);
 151
 152 extern void parse_options_start(struct parse_opt_ctx_t *ctx,
 153                                 int argc, const char **argv, int flags);
 154
 155 extern int parse_options_step(struct parse_opt_ctx_t *ctx,
 156                               const struct option *options,
 157                               const char * const usagestr[]);
 158
 159 extern int parse_options_end(struct parse_opt_ctx_t *ctx);
 160
 161
 162 /*----- some often used options -----*/
 163 extern int parse_opt_abbrev_cb(const struct option *, const char *, int);
 164 extern int parse_opt_approxidate_cb(const struct option *, const char *, int);
 165 extern int parse_opt_verbosity_cb(const struct option *, const char *, int);
 166 extern int parse_opt_with_commit(const struct option *, const char *, int);
 167
 168 #define OPT__VERBOSE(var)  OPT_BOOLEAN('v', "verbose", (var), "be verbose")
 169 #define OPT__QUIET(var)    OPT_BOOLEAN('q', "quiet",   (var), "be quiet")
 170 #define OPT__VERBOSITY(var) \
 171         { OPTION_CALLBACK, 'v', "verbose", (var), NULL, "be more verbose", \
 172           PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
 173         { OPTION_CALLBACK, 'q', "quiet", (var), NULL, "be more quiet", \
 174           PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
 175 #define OPT__DRY_RUN(var)  OPT_BOOLEAN('n', "dry-run", (var), "dry run")
 176 #define OPT__ABBREV(var)  \
 177         { OPTION_CALLBACK, 0, "abbrev", (var), "n", \
 178           "use <n> digits to display SHA-1s", \
 179           PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
 180
 181 extern const char *parse_options_fix_filename(const char *prefix, const char *file);
 182
 183 #endif