Andrew's git / gitweb.git / parse-options.h
?
parse-options.hon commit Documentation/git-config: use bulleted list for exit codes (94c5b0e)
   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_COUNTUP,
  14        OPTION_SET_INT,
  15        OPTION_CMDMODE,
  16        /* options with arguments (usually) */
  17        OPTION_STRING,
  18        OPTION_INTEGER,
  19        OPTION_MAGNITUDE,
  20        OPTION_CALLBACK,
  21        OPTION_LOWLEVEL_CALLBACK,
  22        OPTION_FILENAME
  23};
  24
  25enum parse_opt_flags {
  26        PARSE_OPT_KEEP_DASHDASH = 1,
  27        PARSE_OPT_STOP_AT_NON_OPTION = 2,
  28        PARSE_OPT_KEEP_ARGV0 = 4,
  29        PARSE_OPT_KEEP_UNKNOWN = 8,
  30        PARSE_OPT_NO_INTERNAL_HELP = 16
  31};
  32
  33enum parse_opt_option_flags {
  34        PARSE_OPT_OPTARG  = 1,
  35        PARSE_OPT_NOARG   = 2,
  36        PARSE_OPT_NONEG   = 4,
  37        PARSE_OPT_HIDDEN  = 8,
  38        PARSE_OPT_LASTARG_DEFAULT = 16,
  39        PARSE_OPT_NODASH = 32,
  40        PARSE_OPT_LITERAL_ARGHELP = 64,
  41        PARSE_OPT_SHELL_EVAL = 256
  42};
  43
  44struct option;
  45typedef int parse_opt_cb(const struct option *, const char *arg, int unset);
  46
  47struct parse_opt_ctx_t;
  48typedef int parse_opt_ll_cb(struct parse_opt_ctx_t *ctx,
  49                                const struct option *opt, int unset);
  50
  51/*
  52 * `type`::
  53 *   holds the type of the option, you must have an OPTION_END last in your
  54 *   array.
  55 *
  56 * `short_name`::
  57 *   the character to use as a short option name, '\0' if none.
  58 *
  59 * `long_name`::
  60 *   the long option name, without the leading dashes, NULL if none.
  61 *
  62 * `value`::
  63 *   stores pointers to the values to be filled.
  64 *
  65 * `argh`::
  66 *   token to explain the kind of argument this option wants. Keep it
  67 *   homogeneous across the repository. Should be wrapped by N_() for
  68 *   translation.
  69 *
  70 * `help`::
  71 *   the short help associated to what the option does.
  72 *   Must never be NULL (except for OPTION_END).
  73 *   OPTION_GROUP uses this pointer to store the group header.
  74 *   Should be wrapped by N_() for translation.
  75 *
  76 * `flags`::
  77 *   mask of parse_opt_option_flags.
  78 *   PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs)
  79 *   PARSE_OPT_NOARG: says that this option does not take an argument
  80 *   PARSE_OPT_NONEG: says that this option cannot be negated
  81 *   PARSE_OPT_HIDDEN: this option is skipped in the default usage, and
  82 *                     shown only in the full usage.
  83 *   PARSE_OPT_LASTARG_DEFAULT: says that this option will take the default
  84 *                              value if no argument is given when the option
  85 *                              is last on the command line. If the option is
  86 *                              not last it will require an argument.
  87 *                              Should not be used with PARSE_OPT_OPTARG.
  88 *   PARSE_OPT_NODASH: this option doesn't start with a dash.
  89 *   PARSE_OPT_LITERAL_ARGHELP: says that argh shouldn't be enclosed in brackets
  90 *                              (i.e. '<argh>') in the help message.
  91 *                              Useful for options with multiple parameters.
  92 *
  93 * `callback`::
  94 *   pointer to the callback to use for OPTION_CALLBACK or
  95 *   OPTION_LOWLEVEL_CALLBACK.
  96 *
  97 * `defval`::
  98 *   default value to fill (*->value) with for PARSE_OPT_OPTARG.
  99 *   OPTION_{BIT,SET_INT} store the {mask,integer} to put in the value when met.
 100 *   CALLBACKS can use it like they want.
 101 */
 102struct option {
 103        enum parse_opt_type type;
 104        int short_name;
 105        const char *long_name;
 106        void *value;
 107        const char *argh;
 108        const char *help;
 109
 110        int flags;
 111        parse_opt_cb *callback;
 112        intptr_t defval;
 113};
 114
 115#define OPT_END()                   { OPTION_END }
 116#define OPT_ARGUMENT(l, h)          { OPTION_ARGUMENT, 0, (l), NULL, NULL, \
 117                                      (h), PARSE_OPT_NOARG}
 118#define OPT_GROUP(h)                { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
 119#define OPT_BIT(s, l, v, h, b)      { OPTION_BIT, (s), (l), (v), NULL, (h), \
 120                                      PARSE_OPT_NOARG, NULL, (b) }
 121#define OPT_NEGBIT(s, l, v, h, b)   { OPTION_NEGBIT, (s), (l), (v), NULL, \
 122                                      (h), PARSE_OPT_NOARG, NULL, (b) }
 123#define OPT_COUNTUP(s, l, v, h)     { OPTION_COUNTUP, (s), (l), (v), NULL, \
 124                                      (h), PARSE_OPT_NOARG }
 125#define OPT_SET_INT(s, l, v, h, i)  { OPTION_SET_INT, (s), (l), (v), NULL, \
 126                                      (h), PARSE_OPT_NOARG, NULL, (i) }
 127#define OPT_BOOL(s, l, v, h)        OPT_SET_INT(s, l, v, h, 1)
 128#define OPT_HIDDEN_BOOL(s, l, v, h) { OPTION_SET_INT, (s), (l), (v), NULL, \
 129                                      (h), PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, 1}
 130#define OPT_CMDMODE(s, l, v, h, i)  { OPTION_CMDMODE, (s), (l), (v), NULL, \
 131                                      (h), PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, (i) }
 132#define OPT_INTEGER(s, l, v, h)     { OPTION_INTEGER, (s), (l), (v), N_("n"), (h) }
 133#define OPT_MAGNITUDE(s, l, v, h)   { OPTION_MAGNITUDE, (s), (l), (v), \
 134                                      N_("n"), (h), PARSE_OPT_NONEG }
 135#define OPT_STRING(s, l, v, a, h)   { OPTION_STRING,  (s), (l), (v), (a), (h) }
 136#define OPT_STRING_LIST(s, l, v, a, h) \
 137                                    { OPTION_CALLBACK, (s), (l), (v), (a), \
 138                                      (h), 0, &parse_opt_string_list }
 139#define OPT_UYN(s, l, v, h)         { OPTION_CALLBACK, (s), (l), (v), NULL, \
 140                                      (h), PARSE_OPT_NOARG, &parse_opt_tertiary }
 141#define OPT_DATE(s, l, v, h) \
 142        { OPTION_CALLBACK, (s), (l), (v), N_("time"),(h), 0,    \
 143          parse_opt_approxidate_cb }
 144#define OPT_EXPIRY_DATE(s, l, v, h) \
 145        { OPTION_CALLBACK, (s), (l), (v), N_("expiry-date"),(h), 0,     \
 146          parse_opt_expiry_date_cb }
 147#define OPT_CALLBACK(s, l, v, a, h, f) \
 148        { OPTION_CALLBACK, (s), (l), (v), (a), (h), 0, (f) }
 149#define OPT_NUMBER_CALLBACK(v, h, f) \
 150        { OPTION_NUMBER, 0, NULL, (v), NULL, (h), \
 151          PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) }
 152#define OPT_FILENAME(s, l, v, h)    { OPTION_FILENAME, (s), (l), (v), \
 153                                       N_("file"), (h) }
 154#define OPT_COLOR_FLAG(s, l, v, h) \
 155        { OPTION_CALLBACK, (s), (l), (v), N_("when"), (h), PARSE_OPT_OPTARG, \
 156                parse_opt_color_flag_cb, (intptr_t)"always" }
 157
 158#define OPT_NOOP_NOARG(s, l) \
 159        { OPTION_CALLBACK, (s), (l), NULL, NULL, \
 160          N_("no-op (backward compatibility)"),         \
 161          PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, parse_opt_noop_cb }
 162
 163/* parse_options() will filter out the processed options and leave the
 164 * non-option arguments in argv[]. usagestr strings should be marked
 165 * for translation with N_().
 166 * Returns the number of arguments left in argv[].
 167 */
 168extern int parse_options(int argc, const char **argv, const char *prefix,
 169                         const struct option *options,
 170                         const char * const usagestr[], int flags);
 171
 172extern NORETURN void usage_with_options(const char * const *usagestr,
 173                                        const struct option *options);
 174
 175extern NORETURN void usage_msg_opt(const char *msg,
 176                                   const char * const *usagestr,
 177                                   const struct option *options);
 178
 179extern int optbug(const struct option *opt, const char *reason);
 180extern int opterror(const struct option *opt, const char *reason, int flags);
 181#if defined(__GNUC__)
 182#define opterror(o,r,f) (opterror((o),(r),(f)), const_error())
 183#endif
 184
 185/*----- incremental advanced APIs -----*/
 186
 187enum {
 188        PARSE_OPT_HELP = -1,
 189        PARSE_OPT_DONE,
 190        PARSE_OPT_NON_OPTION,
 191        PARSE_OPT_UNKNOWN
 192};
 193
 194/*
 195 * It's okay for the caller to consume argv/argc in the usual way.
 196 * Other fields of that structure are private to parse-options and should not
 197 * be modified in any way.
 198 */
 199struct parse_opt_ctx_t {
 200        const char **argv;
 201        const char **out;
 202        int argc, cpidx, total;
 203        const char *opt;
 204        int flags;
 205        const char *prefix;
 206};
 207
 208extern void parse_options_start(struct parse_opt_ctx_t *ctx,
 209                                int argc, const char **argv, const char *prefix,
 210                                const struct option *options, int flags);
 211
 212extern int parse_options_step(struct parse_opt_ctx_t *ctx,
 213                              const struct option *options,
 214                              const char * const usagestr[]);
 215
 216extern int parse_options_end(struct parse_opt_ctx_t *ctx);
 217
 218extern int parse_options_concat(struct option *dst, size_t, struct option *src);
 219
 220/*----- some often used options -----*/
 221extern int parse_opt_abbrev_cb(const struct option *, const char *, int);
 222extern int parse_opt_approxidate_cb(const struct option *, const char *, int);
 223extern int parse_opt_expiry_date_cb(const struct option *, const char *, int);
 224extern int parse_opt_color_flag_cb(const struct option *, const char *, int);
 225extern int parse_opt_verbosity_cb(const struct option *, const char *, int);
 226extern int parse_opt_object_name(const struct option *, const char *, int);
 227extern int parse_opt_commits(const struct option *, const char *, int);
 228extern int parse_opt_tertiary(const struct option *, const char *, int);
 229extern int parse_opt_string_list(const struct option *, const char *, int);
 230extern int parse_opt_noop_cb(const struct option *, const char *, int);
 231extern int parse_opt_passthru(const struct option *, const char *, int);
 232extern int parse_opt_passthru_argv(const struct option *, const char *, int);
 233
 234#define OPT__VERBOSE(var, h)  OPT_COUNTUP('v', "verbose", (var), (h))
 235#define OPT__QUIET(var, h)    OPT_COUNTUP('q', "quiet",   (var), (h))
 236#define OPT__VERBOSITY(var) \
 237        { OPTION_CALLBACK, 'v', "verbose", (var), NULL, N_("be more verbose"), \
 238          PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
 239        { OPTION_CALLBACK, 'q', "quiet", (var), NULL, N_("be more quiet"), \
 240          PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
 241#define OPT__DRY_RUN(var, h)  OPT_BOOL('n', "dry-run", (var), (h))
 242#define OPT__FORCE(var, h)    OPT_COUNTUP('f', "force",   (var), (h))
 243#define OPT__ABBREV(var)  \
 244        { OPTION_CALLBACK, 0, "abbrev", (var), N_("n"), \
 245          N_("use <n> digits to display SHA-1s"),       \
 246          PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
 247#define OPT__COLOR(var, h) \
 248        OPT_COLOR_FLAG(0, "color", (var), (h))
 249#define OPT_COLUMN(s, l, v, h) \
 250        { OPTION_CALLBACK, (s), (l), (v), N_("style"), (h), PARSE_OPT_OPTARG, parseopt_column_callback }
 251#define OPT_PASSTHRU(s, l, v, a, h, f) \
 252        { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru }
 253#define OPT_PASSTHRU_ARGV(s, l, v, a, h, f) \
 254        { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru_argv }
 255#define _OPT_CONTAINS_OR_WITH(name, variable, help, flag) \
 256        { OPTION_CALLBACK, 0, name, (variable), N_("commit"), (help), \
 257          PARSE_OPT_LASTARG_DEFAULT | flag, \
 258          parse_opt_commits, (intptr_t) "HEAD" \
 259        }
 260#define OPT_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("contains", v, h, 0)
 261#define OPT_WITH(v, h) _OPT_CONTAINS_OR_WITH("with", v, h, PARSE_OPT_HIDDEN)
 262
 263#endif