parse-options.hon commit describe: fix accidental oid/hash type-punning (6d79e5e)
   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        OPTION_ALIAS,
  11        /* options with no arguments */
  12        OPTION_BIT,
  13        OPTION_NEGBIT,
  14        OPTION_BITOP,
  15        OPTION_COUNTUP,
  16        OPTION_SET_INT,
  17        OPTION_CMDMODE,
  18        /* options with arguments (usually) */
  19        OPTION_STRING,
  20        OPTION_INTEGER,
  21        OPTION_MAGNITUDE,
  22        OPTION_CALLBACK,
  23        OPTION_LOWLEVEL_CALLBACK,
  24        OPTION_FILENAME
  25};
  26
  27enum parse_opt_flags {
  28        PARSE_OPT_KEEP_DASHDASH = 1,
  29        PARSE_OPT_STOP_AT_NON_OPTION = 2,
  30        PARSE_OPT_KEEP_ARGV0 = 4,
  31        PARSE_OPT_KEEP_UNKNOWN = 8,
  32        PARSE_OPT_NO_INTERNAL_HELP = 16,
  33        PARSE_OPT_ONE_SHOT = 32
  34};
  35
  36enum parse_opt_option_flags {
  37        PARSE_OPT_OPTARG  = 1,
  38        PARSE_OPT_NOARG   = 2,
  39        PARSE_OPT_NONEG   = 4,
  40        PARSE_OPT_HIDDEN  = 8,
  41        PARSE_OPT_LASTARG_DEFAULT = 16,
  42        PARSE_OPT_NODASH = 32,
  43        PARSE_OPT_LITERAL_ARGHELP = 64,
  44        PARSE_OPT_SHELL_EVAL = 256,
  45        PARSE_OPT_NOCOMPLETE = 512,
  46        PARSE_OPT_COMP_ARG = 1024
  47};
  48
  49struct option;
  50typedef int parse_opt_cb(const struct option *, const char *arg, int unset);
  51
  52struct parse_opt_ctx_t;
  53typedef enum parse_opt_result parse_opt_ll_cb(struct parse_opt_ctx_t *ctx,
  54                                              const struct option *opt,
  55                                              const char *arg, int unset);
  56
  57/*
  58 * `type`::
  59 *   holds the type of the option, you must have an OPTION_END last in your
  60 *   array.
  61 *
  62 * `short_name`::
  63 *   the character to use as a short option name, '\0' if none.
  64 *
  65 * `long_name`::
  66 *   the long option name, without the leading dashes, NULL if none.
  67 *
  68 * `value`::
  69 *   stores pointers to the values to be filled.
  70 *
  71 * `argh`::
  72 *   token to explain the kind of argument this option wants. Keep it
  73 *   homogeneous across the repository. Should be wrapped by N_() for
  74 *   translation.
  75 *
  76 * `help`::
  77 *   the short help associated to what the option does.
  78 *   Must never be NULL (except for OPTION_END).
  79 *   OPTION_GROUP uses this pointer to store the group header.
  80 *   Should be wrapped by N_() for translation.
  81 *
  82 * `flags`::
  83 *   mask of parse_opt_option_flags.
  84 *   PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs)
  85 *   PARSE_OPT_NOARG: says that this option does not take an argument
  86 *   PARSE_OPT_NONEG: says that this option cannot be negated
  87 *   PARSE_OPT_HIDDEN: this option is skipped in the default usage, and
  88 *                     shown only in the full usage.
  89 *   PARSE_OPT_LASTARG_DEFAULT: says that this option will take the default
  90 *                              value if no argument is given when the option
  91 *                              is last on the command line. If the option is
  92 *                              not last it will require an argument.
  93 *                              Should not be used with PARSE_OPT_OPTARG.
  94 *   PARSE_OPT_NODASH: this option doesn't start with a dash.
  95 *   PARSE_OPT_LITERAL_ARGHELP: says that argh shouldn't be enclosed in brackets
  96 *                              (i.e. '<argh>') in the help message.
  97 *                              Useful for options with multiple parameters.
  98 *   PARSE_OPT_NOCOMPLETE: by default all visible options are completable
  99 *                         by git-completion.bash. This option suppresses that.
 100 *   PARSE_OPT_COMP_ARG: this option forces to git-completion.bash to
 101 *                       complete an option as --name= not --name even if
 102 *                       the option takes optional argument.
 103 *
 104 * `callback`::
 105 *   pointer to the callback to use for OPTION_CALLBACK
 106 *
 107 * `defval`::
 108 *   default value to fill (*->value) with for PARSE_OPT_OPTARG.
 109 *   OPTION_{BIT,SET_INT} store the {mask,integer} to put in the value when met.
 110 *   CALLBACKS can use it like they want.
 111 *
 112 * `ll_callback`::
 113 *   pointer to the callback to use for OPTION_LOWLEVEL_CALLBACK
 114 *
 115 */
 116struct option {
 117        enum parse_opt_type type;
 118        int short_name;
 119        const char *long_name;
 120        void *value;
 121        const char *argh;
 122        const char *help;
 123
 124        int flags;
 125        parse_opt_cb *callback;
 126        intptr_t defval;
 127        parse_opt_ll_cb *ll_callback;
 128        intptr_t extra;
 129};
 130
 131#define OPT_BIT_F(s, l, v, h, b, f) { OPTION_BIT, (s), (l), (v), NULL, (h), \
 132                                      PARSE_OPT_NOARG|(f), NULL, (b) }
 133#define OPT_COUNTUP_F(s, l, v, h, f) { OPTION_COUNTUP, (s), (l), (v), NULL, \
 134                                       (h), PARSE_OPT_NOARG|(f) }
 135#define OPT_SET_INT_F(s, l, v, h, i, f) { OPTION_SET_INT, (s), (l), (v), NULL, \
 136                                          (h), PARSE_OPT_NOARG | (f), NULL, (i) }
 137#define OPT_BOOL_F(s, l, v, h, f)   OPT_SET_INT_F(s, l, v, h, 1, f)
 138#define OPT_CALLBACK_F(s, l, v, a, h, f, cb)                    \
 139        { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), (cb) }
 140#define OPT_STRING_F(s, l, v, a, h, f)   { OPTION_STRING,  (s), (l), (v), (a), (h), (f) }
 141#define OPT_INTEGER_F(s, l, v, h, f)     { OPTION_INTEGER, (s), (l), (v), N_("n"), (h), (f) }
 142
 143#define OPT_END()                   { OPTION_END }
 144#define OPT_ARGUMENT(l, v, h)       { OPTION_ARGUMENT, 0, (l), (v), NULL, \
 145                                      (h), PARSE_OPT_NOARG, NULL, 1 }
 146#define OPT_GROUP(h)                { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
 147#define OPT_BIT(s, l, v, h, b)      OPT_BIT_F(s, l, v, h, b, 0)
 148#define OPT_BITOP(s, l, v, h, set, clear) { OPTION_BITOP, (s), (l), (v), NULL, (h), \
 149                                            PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, \
 150                                            (set), NULL, (clear) }
 151#define OPT_NEGBIT(s, l, v, h, b)   { OPTION_NEGBIT, (s), (l), (v), NULL, \
 152                                      (h), PARSE_OPT_NOARG, NULL, (b) }
 153#define OPT_COUNTUP(s, l, v, h)     OPT_COUNTUP_F(s, l, v, h, 0)
 154#define OPT_SET_INT(s, l, v, h, i)  OPT_SET_INT_F(s, l, v, h, i, 0)
 155#define OPT_BOOL(s, l, v, h)        OPT_BOOL_F(s, l, v, h, 0)
 156#define OPT_HIDDEN_BOOL(s, l, v, h) { OPTION_SET_INT, (s), (l), (v), NULL, \
 157                                      (h), PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, 1}
 158#define OPT_CMDMODE(s, l, v, h, i)  { OPTION_CMDMODE, (s), (l), (v), NULL, \
 159                                      (h), PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, (i) }
 160#define OPT_INTEGER(s, l, v, h)     OPT_INTEGER_F(s, l, v, h, 0)
 161#define OPT_MAGNITUDE(s, l, v, h)   { OPTION_MAGNITUDE, (s), (l), (v), \
 162                                      N_("n"), (h), PARSE_OPT_NONEG }
 163#define OPT_STRING(s, l, v, a, h)   OPT_STRING_F(s, l, v, a, h, 0)
 164#define OPT_STRING_LIST(s, l, v, a, h) \
 165                                    { OPTION_CALLBACK, (s), (l), (v), (a), \
 166                                      (h), 0, &parse_opt_string_list }
 167#define OPT_UYN(s, l, v, h)         { OPTION_CALLBACK, (s), (l), (v), NULL, \
 168                                      (h), PARSE_OPT_NOARG, &parse_opt_tertiary }
 169#define OPT_EXPIRY_DATE(s, l, v, h) \
 170        { OPTION_CALLBACK, (s), (l), (v), N_("expiry-date"),(h), 0,     \
 171          parse_opt_expiry_date_cb }
 172#define OPT_CALLBACK(s, l, v, a, h, f) OPT_CALLBACK_F(s, l, v, a, h, 0, f)
 173#define OPT_NUMBER_CALLBACK(v, h, f) \
 174        { OPTION_NUMBER, 0, NULL, (v), NULL, (h), \
 175          PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) }
 176#define OPT_FILENAME(s, l, v, h)    { OPTION_FILENAME, (s), (l), (v), \
 177                                       N_("file"), (h) }
 178#define OPT_COLOR_FLAG(s, l, v, h) \
 179        { OPTION_CALLBACK, (s), (l), (v), N_("when"), (h), PARSE_OPT_OPTARG, \
 180                parse_opt_color_flag_cb, (intptr_t)"always" }
 181
 182#define OPT_NOOP_NOARG(s, l) \
 183        { OPTION_CALLBACK, (s), (l), NULL, NULL, \
 184          N_("no-op (backward compatibility)"),         \
 185          PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, parse_opt_noop_cb }
 186
 187#define OPT_ALIAS(s, l, source_long_name) \
 188        { OPTION_ALIAS, (s), (l), (source_long_name) }
 189
 190/*
 191 * parse_options() will filter out the processed options and leave the
 192 * non-option arguments in argv[]. argv0 is assumed program name and
 193 * skipped.
 194 *
 195 * usagestr strings should be marked for translation with N_().
 196 *
 197 * Returns the number of arguments left in argv[].
 198 *
 199 * In one-shot mode, argv0 is not a program name, argv[] is left
 200 * untouched and parse_options() returns the number of options
 201 * processed.
 202 */
 203int parse_options(int argc, const char **argv, const char *prefix,
 204                  const struct option *options,
 205                  const char * const usagestr[], int flags);
 206
 207NORETURN void usage_with_options(const char * const *usagestr,
 208                                 const struct option *options);
 209
 210NORETURN void usage_msg_opt(const char *msg,
 211                            const char * const *usagestr,
 212                            const struct option *options);
 213
 214int optbug(const struct option *opt, const char *reason);
 215const char *optname(const struct option *opt, int flags);
 216
 217/*
 218 * Use these assertions for callbacks that expect to be called with NONEG and
 219 * NOARG respectively, and do not otherwise handle the "unset" and "arg"
 220 * parameters.
 221 */
 222#define BUG_ON_OPT_NEG(unset) do { \
 223        if ((unset)) \
 224                BUG("option callback does not expect negation"); \
 225} while (0)
 226#define BUG_ON_OPT_ARG(arg) do { \
 227        if ((arg)) \
 228                BUG("option callback does not expect an argument"); \
 229} while (0)
 230
 231/*
 232 * Similar to the assertions above, but checks that "arg" is always non-NULL.
 233 * This assertion also implies BUG_ON_OPT_NEG(), letting you declare both
 234 * assertions in a single line.
 235 */
 236#define BUG_ON_OPT_NEG_NOARG(unset, arg) do { \
 237        BUG_ON_OPT_NEG(unset); \
 238        if(!(arg)) \
 239                BUG("option callback expects an argument"); \
 240} while(0)
 241
 242/*----- incremental advanced APIs -----*/
 243
 244enum parse_opt_result {
 245        PARSE_OPT_COMPLETE = -3,
 246        PARSE_OPT_HELP = -2,
 247        PARSE_OPT_ERROR = -1,   /* must be the same as error() */
 248        PARSE_OPT_DONE = 0,     /* fixed so that "return 0" works */
 249        PARSE_OPT_NON_OPTION,
 250        PARSE_OPT_UNKNOWN
 251};
 252
 253/*
 254 * It's okay for the caller to consume argv/argc in the usual way.
 255 * Other fields of that structure are private to parse-options and should not
 256 * be modified in any way.
 257 */
 258struct parse_opt_ctx_t {
 259        const char **argv;
 260        const char **out;
 261        int argc, cpidx, total;
 262        const char *opt;
 263        int flags;
 264        const char *prefix;
 265        const char **alias_groups; /* must be in groups of 3 elements! */
 266        struct option *updated_options;
 267};
 268
 269void parse_options_start(struct parse_opt_ctx_t *ctx,
 270                         int argc, const char **argv, const char *prefix,
 271                         const struct option *options, int flags);
 272
 273int parse_options_step(struct parse_opt_ctx_t *ctx,
 274                       const struct option *options,
 275                       const char * const usagestr[]);
 276
 277int parse_options_end(struct parse_opt_ctx_t *ctx);
 278
 279struct option *parse_options_concat(struct option *a, struct option *b);
 280
 281/*----- some often used options -----*/
 282int parse_opt_abbrev_cb(const struct option *, const char *, int);
 283int parse_opt_expiry_date_cb(const struct option *, const char *, int);
 284int parse_opt_color_flag_cb(const struct option *, const char *, int);
 285int parse_opt_verbosity_cb(const struct option *, const char *, int);
 286/* value is struct oid_array* */
 287int parse_opt_object_name(const struct option *, const char *, int);
 288/* value is struct object_id* */
 289int parse_opt_object_id(const struct option *, const char *, int);
 290int parse_opt_commits(const struct option *, const char *, int);
 291int parse_opt_commit(const struct option *, const char *, int);
 292int parse_opt_tertiary(const struct option *, const char *, int);
 293int parse_opt_string_list(const struct option *, const char *, int);
 294int parse_opt_noop_cb(const struct option *, const char *, int);
 295enum parse_opt_result parse_opt_unknown_cb(struct parse_opt_ctx_t *ctx,
 296                                           const struct option *,
 297                                           const char *, int);
 298int parse_opt_passthru(const struct option *, const char *, int);
 299int parse_opt_passthru_argv(const struct option *, const char *, int);
 300
 301#define OPT__VERBOSE(var, h)  OPT_COUNTUP('v', "verbose", (var), (h))
 302#define OPT__QUIET(var, h)    OPT_COUNTUP('q', "quiet",   (var), (h))
 303#define OPT__VERBOSITY(var) \
 304        { OPTION_CALLBACK, 'v', "verbose", (var), NULL, N_("be more verbose"), \
 305          PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
 306        { OPTION_CALLBACK, 'q', "quiet", (var), NULL, N_("be more quiet"), \
 307          PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
 308#define OPT__DRY_RUN(var, h)  OPT_BOOL('n', "dry-run", (var), (h))
 309#define OPT__FORCE(var, h, f) OPT_COUNTUP_F('f', "force",   (var), (h), (f))
 310#define OPT__ABBREV(var)  \
 311        { OPTION_CALLBACK, 0, "abbrev", (var), N_("n"), \
 312          N_("use <n> digits to display SHA-1s"),       \
 313          PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
 314#define OPT__COLOR(var, h) \
 315        OPT_COLOR_FLAG(0, "color", (var), (h))
 316#define OPT_COLUMN(s, l, v, h) \
 317        { OPTION_CALLBACK, (s), (l), (v), N_("style"), (h), PARSE_OPT_OPTARG, parseopt_column_callback }
 318#define OPT_PASSTHRU(s, l, v, a, h, f) \
 319        { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru }
 320#define OPT_PASSTHRU_ARGV(s, l, v, a, h, f) \
 321        { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru_argv }
 322#define _OPT_CONTAINS_OR_WITH(name, variable, help, flag) \
 323        { OPTION_CALLBACK, 0, name, (variable), N_("commit"), (help), \
 324          PARSE_OPT_LASTARG_DEFAULT | flag, \
 325          parse_opt_commits, (intptr_t) "HEAD" \
 326        }
 327#define OPT_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("contains", v, h, PARSE_OPT_NONEG)
 328#define OPT_NO_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("no-contains", v, h, PARSE_OPT_NONEG)
 329#define OPT_WITH(v, h) _OPT_CONTAINS_OR_WITH("with", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
 330#define OPT_WITHOUT(v, h) _OPT_CONTAINS_OR_WITH("without", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
 331#define OPT_CLEANUP(v) OPT_STRING(0, "cleanup", v, N_("mode"), N_("how to strip spaces and #comments from message"))
 332
 333#endif