parse-options.h

   1 #ifndef PARSE_OPTIONS_H
   2 #define PARSE_OPTIONS_H
   3
   4 #include "gettext.h"
   5
   6 /**
   7  * Refer to Documentation/technical/api-parse-options.txt for the API doc.
   8  */
   9
  10 enum parse_opt_type {
  11         /* special types */
  12         OPTION_END,
  13         OPTION_GROUP,
  14         OPTION_NUMBER,
  15         OPTION_ALIAS,
  16         OPTION_SUBCOMMAND,
  17         /* options with no arguments */
  18         OPTION_BIT,
  19         OPTION_NEGBIT,
  20         OPTION_BITOP,
  21         OPTION_COUNTUP,
  22         OPTION_SET_INT,
  23         /* options with arguments (usually) */
  24         OPTION_STRING,
  25         OPTION_INTEGER,
  26         OPTION_MAGNITUDE,
  27         OPTION_CALLBACK,
  28         OPTION_LOWLEVEL_CALLBACK,
  29         OPTION_FILENAME
  30 };
  31
  32 enum parse_opt_flags {
  33         PARSE_OPT_KEEP_DASHDASH = 1 << 0,
  34         PARSE_OPT_STOP_AT_NON_OPTION = 1 << 1,
  35         PARSE_OPT_KEEP_ARGV0 = 1 << 2,
  36         PARSE_OPT_KEEP_UNKNOWN_OPT = 1 << 3,
  37         PARSE_OPT_NO_INTERNAL_HELP = 1 << 4,
  38         PARSE_OPT_ONE_SHOT = 1 << 5,
  39         PARSE_OPT_SHELL_EVAL = 1 << 6,
  40         PARSE_OPT_SUBCOMMAND_OPTIONAL = 1 << 7,
  41 };
  42
  43 enum parse_opt_option_flags {
  44         PARSE_OPT_OPTARG  = 1 << 0,
  45         PARSE_OPT_NOARG   = 1 << 1,
  46         PARSE_OPT_NONEG   = 1 << 2,
  47         PARSE_OPT_HIDDEN  = 1 << 3,
  48         PARSE_OPT_LASTARG_DEFAULT = 1 << 4,
  49         PARSE_OPT_NODASH = 1 << 5,
  50         PARSE_OPT_LITERAL_ARGHELP = 1 << 6,
  51         PARSE_OPT_FROM_ALIAS = 1 << 7,
  52         PARSE_OPT_NOCOMPLETE = 1 << 9,
  53         PARSE_OPT_COMP_ARG = 1 << 10,
  54         PARSE_OPT_CMDMODE = 1 << 11,
  55 };
  56
  57 enum parse_opt_result {
  58         PARSE_OPT_COMPLETE = -3,
  59         PARSE_OPT_HELP = -2,
  60         PARSE_OPT_ERROR = -1,   /* must be the same as error() */
  61         PARSE_OPT_DONE = 0,     /* fixed so that "return 0" works */
  62         PARSE_OPT_NON_OPTION,
  63         PARSE_OPT_SUBCOMMAND,
  64         PARSE_OPT_UNKNOWN
  65 };
  66
  67 struct option;
  68 typedef int parse_opt_cb(const struct option *, const char *arg, int unset);
  69
  70 struct parse_opt_ctx_t;
  71 typedef enum parse_opt_result parse_opt_ll_cb(struct parse_opt_ctx_t *ctx,
  72                                               const struct option *opt,
  73                                               const char *arg, int unset);
  74
  75 typedef int parse_opt_subcommand_fn(int argc, const char **argv,
  76                                     const char *prefix);
  77
  78 /*
  79  * `type`::
  80  *   holds the type of the option, you must have an OPTION_END last in your
  81  *   array.
  82  *
  83  * `short_name`::
  84  *   the character to use as a short option name, '\0' if none.
  85  *
  86  * `long_name`::
  87  *   the long option (without the leading dashes) or subcommand name,
  88  *   NULL if none.
  89  *
  90  * `value`::
  91  *   stores pointers to the values to be filled.
  92  *
  93  * `argh`::
  94  *   token to explain the kind of argument this option wants. Does not
  95  *   begin in capital letter, and does not end with a full stop.
  96  *   Should be wrapped by N_() for translation.
  97  *   Is automatically enclosed in brackets when printed, unless it
  98  *   contains any of the following characters: ()<>[]|
  99  *   E.g. "name" is shown as "<name>" to indicate that a name value
 100  *   needs to be supplied, not the literal string "name", but
 101  *   "<start>,<end>" and "(this|that)" are printed verbatim.
 102  *
 103  * `help`::
 104  *   the short help associated to what the option does.
 105  *   Must never be NULL (except for OPTION_END and OPTION_SUBCOMMAND).
 106  *   OPTION_GROUP uses this pointer to store the group header.
 107  *   Should be wrapped by N_() for translation.
 108  *
 109  * `flags`::
 110  *   mask of parse_opt_option_flags.
 111  *   PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs)
 112  *   PARSE_OPT_NOARG: says that this option does not take an argument
 113  *   PARSE_OPT_NONEG: says that this option cannot be negated
 114  *   PARSE_OPT_HIDDEN: this option is skipped in the default usage, and
 115  *                     shown only in the full usage.
 116  *   PARSE_OPT_LASTARG_DEFAULT: says that this option will take the default
 117  *                              value if no argument is given when the option
 118  *                              is last on the command line. If the option is
 119  *                              not last it will require an argument.
 120  *                              Should not be used with PARSE_OPT_OPTARG.
 121  *   PARSE_OPT_NODASH: this option doesn't start with a dash; can only be a
 122  *                     short option and can't accept arguments.
 123  *   PARSE_OPT_LITERAL_ARGHELP: says that argh shouldn't be enclosed in brackets
 124  *                              (i.e. '<argh>') in the help message.
 125  *                              Useful for options with multiple parameters.
 126  *   PARSE_OPT_NOCOMPLETE: by default all visible options are completable
 127  *                         by git-completion.bash. This option suppresses that.
 128  *   PARSE_OPT_COMP_ARG: this option forces to git-completion.bash to
 129  *                       complete an option as --name= not --name even if
 130  *                       the option takes optional argument.
 131  *
 132  * `callback`::
 133  *   pointer to the callback to use for OPTION_CALLBACK
 134  *
 135  * `defval`::
 136  *   default value to fill (*->value) with for PARSE_OPT_OPTARG.
 137  *   OPTION_{BIT,SET_INT} store the {mask,integer} to put in the value when met.
 138  *   CALLBACKS can use it like they want.
 139  *
 140  * `ll_callback`::
 141  *   pointer to the callback to use for OPTION_LOWLEVEL_CALLBACK
 142  *
 143  * `subcommand_fn`::
 144  *   pointer to a function to use for OPTION_SUBCOMMAND.
 145  *   It will be put in value when the subcommand is given on the command line.
 146  */
 147 struct option {
 148         enum parse_opt_type type;
 149         int short_name;
 150         const char *long_name;
 151         void *value;
 152         const char *argh;
 153         const char *help;
 154
 155         enum parse_opt_option_flags flags;
 156         parse_opt_cb *callback;
 157         intptr_t defval;
 158         parse_opt_ll_cb *ll_callback;
 159         intptr_t extra;
 160         parse_opt_subcommand_fn *subcommand_fn;
 161 };
 162
 163 #define OPT_BIT_F(s, l, v, h, b, f) { OPTION_BIT, (s), (l), (v), NULL, (h), \
 164                                       PARSE_OPT_NOARG|(f), NULL, (b) }
 165 #define OPT_COUNTUP_F(s, l, v, h, f) { OPTION_COUNTUP, (s), (l), (v), NULL, \
 166                                        (h), PARSE_OPT_NOARG|(f) }
 167 #define OPT_SET_INT_F(s, l, v, h, i, f) { OPTION_SET_INT, (s), (l), (v), NULL, \
 168                                           (h), PARSE_OPT_NOARG | (f), NULL, (i) }
 169 #define OPT_BOOL_F(s, l, v, h, f)   OPT_SET_INT_F(s, l, v, h, 1, f)
 170 #define OPT_CALLBACK_F(s, l, v, a, h, f, cb)                    \
 171         { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), (cb) }
 172 #define OPT_STRING_F(s, l, v, a, h, f)   { OPTION_STRING,  (s), (l), (v), (a), (h), (f) }
 173 #define OPT_INTEGER_F(s, l, v, h, f)     { OPTION_INTEGER, (s), (l), (v), N_("n"), (h), (f) }
 174
 175 #define OPT_END()                   { OPTION_END }
 176 #define OPT_GROUP(h)                { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
 177 #define OPT_BIT(s, l, v, h, b)      OPT_BIT_F(s, l, v, h, b, 0)
 178 #define OPT_BITOP(s, l, v, h, set, clear) { OPTION_BITOP, (s), (l), (v), NULL, (h), \
 179                                             PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, \
 180                                             (set), NULL, (clear) }
 181 #define OPT_NEGBIT(s, l, v, h, b)   { OPTION_NEGBIT, (s), (l), (v), NULL, \
 182                                       (h), PARSE_OPT_NOARG, NULL, (b) }
 183 #define OPT_COUNTUP(s, l, v, h)     OPT_COUNTUP_F(s, l, v, h, 0)
 184 #define OPT_SET_INT(s, l, v, h, i)  OPT_SET_INT_F(s, l, v, h, i, 0)
 185 #define OPT_BOOL(s, l, v, h)        OPT_BOOL_F(s, l, v, h, 0)
 186 #define OPT_HIDDEN_BOOL(s, l, v, h) { OPTION_SET_INT, (s), (l), (v), NULL, \
 187                                       (h), PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, 1}
 188 #define OPT_CMDMODE_F(s, l, v, h, i, f)  { OPTION_SET_INT, (s), (l), (v), NULL, \
 189                                       (h), PARSE_OPT_CMDMODE|PARSE_OPT_NOARG|PARSE_OPT_NONEG | (f), NULL, (i) }
 190 #define OPT_CMDMODE(s, l, v, h, i)  OPT_CMDMODE_F(s, l, v, h, i, 0)
 191
 192 #define OPT_INTEGER(s, l, v, h)     OPT_INTEGER_F(s, l, v, h, 0)
 193 #define OPT_MAGNITUDE(s, l, v, h)   { OPTION_MAGNITUDE, (s), (l), (v), \
 194                                       N_("n"), (h), PARSE_OPT_NONEG }
 195 #define OPT_STRING(s, l, v, a, h)   OPT_STRING_F(s, l, v, a, h, 0)
 196 #define OPT_STRING_LIST(s, l, v, a, h) \
 197                                     { OPTION_CALLBACK, (s), (l), (v), (a), \
 198                                       (h), 0, &parse_opt_string_list }
 199 #define OPT_UYN(s, l, v, h)         { OPTION_CALLBACK, (s), (l), (v), NULL, \
 200                                       (h), PARSE_OPT_NOARG, &parse_opt_tertiary }
 201 #define OPT_EXPIRY_DATE(s, l, v, h) \
 202         { OPTION_CALLBACK, (s), (l), (v), N_("expiry-date"),(h), 0,     \
 203           parse_opt_expiry_date_cb }
 204 #define OPT_CALLBACK(s, l, v, a, h, f) OPT_CALLBACK_F(s, l, v, a, h, 0, f)
 205 #define OPT_NUMBER_CALLBACK(v, h, f) \
 206         { OPTION_NUMBER, 0, NULL, (v), NULL, (h), \
 207           PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) }
 208 #define OPT_FILENAME(s, l, v, h)    { OPTION_FILENAME, (s), (l), (v), \
 209                                        N_("file"), (h) }
 210 #define OPT_COLOR_FLAG(s, l, v, h) \
 211         { OPTION_CALLBACK, (s), (l), (v), N_("when"), (h), PARSE_OPT_OPTARG, \
 212                 parse_opt_color_flag_cb, (intptr_t)"always" }
 213
 214 #define OPT_NOOP_NOARG(s, l) \
 215         { OPTION_CALLBACK, (s), (l), NULL, NULL, \
 216           N_("no-op (backward compatibility)"),         \
 217           PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, parse_opt_noop_cb }
 218
 219 #define OPT_ALIAS(s, l, source_long_name) \
 220         { OPTION_ALIAS, (s), (l), (source_long_name) }
 221
 222 #define OPT_SUBCOMMAND_F(l, v, fn, f) { \
 223         .type = OPTION_SUBCOMMAND, \
 224         .long_name = (l), \
 225         .value = (v), \
 226         .flags = (f), \
 227         .subcommand_fn = (fn) }
 228 #define OPT_SUBCOMMAND(l, v, fn)    OPT_SUBCOMMAND_F((l), (v), (fn), 0)
 229
 230 /*
 231  * parse_options() will filter out the processed options and leave the
 232  * non-option arguments in argv[]. argv0 is assumed program name and
 233  * skipped.
 234  *
 235  * usagestr strings should be marked for translation with N_().
 236  *
 237  * Returns the number of arguments left in argv[].
 238  *
 239  * In one-shot mode, argv0 is not a program name, argv[] is left
 240  * untouched and parse_options() returns the number of options
 241  * processed.
 242  */
 243 int parse_options(int argc, const char **argv, const char *prefix,
 244                   const struct option *options,
 245                   const char * const usagestr[],
 246                   enum parse_opt_flags flags);
 247
 248 NORETURN void usage_with_options(const char * const *usagestr,
 249                                  const struct option *options);
 250
 251 NORETURN void usage_msg_opt(const char *msg,
 252                             const char * const *usagestr,
 253                             const struct option *options);
 254
 255 /**
 256  * usage_msg_optf() is like usage_msg_opt() except that the first
 257  * argument is a format string, and optional format arguments follow
 258  * after the 3rd option.
 259  */
 260 __attribute__((format (printf,1,4)))
 261 void NORETURN usage_msg_optf(const char *fmt,
 262                              const char * const *usagestr,
 263                              const struct option *options, ...);
 264
 265 void die_for_incompatible_opt4(int opt1, const char *opt1_name,
 266                                int opt2, const char *opt2_name,
 267                                int opt3, const char *opt3_name,
 268                                int opt4, const char *opt4_name);
 269
 270
 271 static inline void die_for_incompatible_opt3(int opt1, const char *opt1_name,
 272                                              int opt2, const char *opt2_name,
 273                                              int opt3, const char *opt3_name)
 274 {
 275         die_for_incompatible_opt4(opt1, opt1_name,
 276                                   opt2, opt2_name,
 277                                   opt3, opt3_name,
 278                                   0, "");
 279 }
 280
 281 /*
 282  * Use these assertions for callbacks that expect to be called with NONEG and
 283  * NOARG respectively, and do not otherwise handle the "unset" and "arg"
 284  * parameters.
 285  */
 286 #define BUG_ON_OPT_NEG(unset) do { \
 287         if ((unset)) \
 288                 BUG("option callback does not expect negation"); \
 289 } while (0)
 290 #define BUG_ON_OPT_ARG(arg) do { \
 291         if ((arg)) \
 292                 BUG("option callback does not expect an argument"); \
 293 } while (0)
 294
 295 /*
 296  * Similar to the assertions above, but checks that "arg" is always non-NULL.
 297  * This assertion also implies BUG_ON_OPT_NEG(), letting you declare both
 298  * assertions in a single line.
 299  */
 300 #define BUG_ON_OPT_NEG_NOARG(unset, arg) do { \
 301         BUG_ON_OPT_NEG(unset); \
 302         if(!(arg)) \
 303                 BUG("option callback expects an argument"); \
 304 } while(0)
 305
 306 /*----- incremental advanced APIs -----*/
 307
 308 /*
 309  * It's okay for the caller to consume argv/argc in the usual way.
 310  * Other fields of that structure are private to parse-options and should not
 311  * be modified in any way.
 312  */
 313 struct parse_opt_ctx_t {
 314         const char **argv;
 315         const char **out;
 316         int argc, cpidx, total;
 317         const char *opt;
 318         enum parse_opt_flags flags;
 319         unsigned has_subcommands;
 320         const char *prefix;
 321         const char **alias_groups; /* must be in groups of 3 elements! */
 322         struct option *updated_options;
 323 };
 324
 325 void parse_options_start(struct parse_opt_ctx_t *ctx,
 326                          int argc, const char **argv, const char *prefix,
 327                          const struct option *options,
 328                          enum parse_opt_flags flags);
 329
 330 enum parse_opt_result parse_options_step(struct parse_opt_ctx_t *ctx,
 331                                          const struct option *options,
 332                                          const char * const usagestr[]);
 333
 334 int parse_options_end(struct parse_opt_ctx_t *ctx);
 335
 336 struct option *parse_options_dup(const struct option *a);
 337 struct option *parse_options_concat(const struct option *a, const struct option *b);
 338
 339 /*----- some often used options -----*/
 340 int parse_opt_abbrev_cb(const struct option *, const char *, int);
 341 int parse_opt_expiry_date_cb(const struct option *, const char *, int);
 342 int parse_opt_color_flag_cb(const struct option *, const char *, int);
 343 int parse_opt_verbosity_cb(const struct option *, const char *, int);
 344 /* value is struct oid_array* */
 345 int parse_opt_object_name(const struct option *, const char *, int);
 346 /* value is struct object_id* */
 347 int parse_opt_object_id(const struct option *, const char *, int);
 348 int parse_opt_commits(const struct option *, const char *, int);
 349 int parse_opt_commit(const struct option *, const char *, int);
 350 int parse_opt_tertiary(const struct option *, const char *, int);
 351 int parse_opt_string_list(const struct option *, const char *, int);
 352 int parse_opt_noop_cb(const struct option *, const char *, int);
 353 enum parse_opt_result parse_opt_unknown_cb(struct parse_opt_ctx_t *ctx,
 354                                            const struct option *,
 355                                            const char *, int);
 356 int parse_opt_passthru(const struct option *, const char *, int);
 357 int parse_opt_passthru_argv(const struct option *, const char *, int);
 358 /* value is enum branch_track* */
 359 int parse_opt_tracking_mode(const struct option *, const char *, int);
 360
 361 #define OPT__VERBOSE(var, h)  OPT_COUNTUP('v', "verbose", (var), (h))
 362 #define OPT__QUIET(var, h)    OPT_COUNTUP('q', "quiet",   (var), (h))
 363 #define OPT__VERBOSITY(var) \
 364         { OPTION_CALLBACK, 'v', "verbose", (var), NULL, N_("be more verbose"), \
 365           PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
 366         { OPTION_CALLBACK, 'q', "quiet", (var), NULL, N_("be more quiet"), \
 367           PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
 368 #define OPT__DRY_RUN(var, h)  OPT_BOOL('n', "dry-run", (var), (h))
 369 #define OPT__FORCE(var, h, f) OPT_COUNTUP_F('f', "force",   (var), (h), (f))
 370 #define OPT__ABBREV(var)  \
 371         { OPTION_CALLBACK, 0, "abbrev", (var), N_("n"), \
 372           N_("use <n> digits to display object names"), \
 373           PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
 374 #define OPT__SUPER_PREFIX(var) \
 375         OPT_STRING_F(0, "super-prefix", (var), N_("prefix"), \
 376                 N_("prefixed path to initial superproject"), PARSE_OPT_HIDDEN)
 377
 378 #define OPT__COLOR(var, h) \
 379         OPT_COLOR_FLAG(0, "color", (var), (h))
 380 #define OPT_COLUMN(s, l, v, h) \
 381         { OPTION_CALLBACK, (s), (l), (v), N_("style"), (h), PARSE_OPT_OPTARG, parseopt_column_callback }
 382 #define OPT_PASSTHRU(s, l, v, a, h, f) \
 383         { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru }
 384 #define OPT_PASSTHRU_ARGV(s, l, v, a, h, f) \
 385         { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru_argv }
 386 #define _OPT_CONTAINS_OR_WITH(name, variable, help, flag) \
 387         { OPTION_CALLBACK, 0, name, (variable), N_("commit"), (help), \
 388           PARSE_OPT_LASTARG_DEFAULT | flag, \
 389           parse_opt_commits, (intptr_t) "HEAD" \
 390         }
 391 #define OPT_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("contains", v, h, PARSE_OPT_NONEG)
 392 #define OPT_NO_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("no-contains", v, h, PARSE_OPT_NONEG)
 393 #define OPT_WITH(v, h) _OPT_CONTAINS_OR_WITH("with", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
 394 #define OPT_WITHOUT(v, h) _OPT_CONTAINS_OR_WITH("without", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
 395 #define OPT_CLEANUP(v) OPT_STRING(0, "cleanup", v, N_("mode"), N_("how to strip spaces and #comments from message"))
 396 #define OPT_PATHSPEC_FROM_FILE(v) OPT_FILENAME(0, "pathspec-from-file", v, N_("read pathspec from file"))
 397 #define OPT_PATHSPEC_FILE_NUL(v)  OPT_BOOL(0, "pathspec-file-nul", v, N_("with --pathspec-from-file, pathspec elements are separated with NUL character"))
 398 #define OPT_AUTOSTASH(v) OPT_BOOL(0, "autostash", v, N_("automatically stash/stash pop before and after"))
 399
 400 #endif