Andrew's git - gitweb.git/blob

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