1 #ifndef PARSE_OPTIONS_H
2 #define PARSE_OPTIONS_H
7 * Refer to Documentation/technical/api-parse-options.txt for the API doc.
17 /* options with no arguments */
23 /* options with arguments (usually) */
28 OPTION_LOWLEVEL_CALLBACK
,
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,
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,
57 enum parse_opt_result
{
58 PARSE_OPT_COMPLETE
= -3,
60 PARSE_OPT_ERROR
= -1, /* must be the same as error() */
61 PARSE_OPT_DONE
= 0, /* fixed so that "return 0" works */
68 typedef int parse_opt_cb(const struct option
*, const char *arg
, int unset
);
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
);
75 typedef int parse_opt_subcommand_fn(int argc
, const char **argv
,
80 * holds the type of the option, you must have an OPTION_END last in your
84 * the character to use as a short option name, '\0' if none.
87 * the long option (without the leading dashes) or subcommand name,
91 * stores pointers to the values to be filled.
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.
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.
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.
133 * pointer to the callback to use for OPTION_CALLBACK
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.
141 * pointer to the callback to use for OPTION_LOWLEVEL_CALLBACK
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.
148 enum parse_opt_type type
;
150 const char *long_name
;
155 enum parse_opt_option_flags flags
;
156 parse_opt_cb
*callback
;
158 parse_opt_ll_cb
*ll_callback
;
160 parse_opt_subcommand_fn
*subcommand_fn
;
163 #define OPT_BIT_F(s, l, v, h, b, f) { \
164 .type = OPTION_BIT, \
169 .flags = PARSE_OPT_NOARG|(f), \
173 #define OPT_COUNTUP_F(s, l, v, h, f) { \
174 .type = OPTION_COUNTUP, \
179 .flags = PARSE_OPT_NOARG|(f), \
181 #define OPT_SET_INT_F(s, l, v, h, i, f) { \
182 .type = OPTION_SET_INT, \
187 .flags = PARSE_OPT_NOARG | (f), \
190 #define OPT_BOOL_F(s, l, v, h, f) OPT_SET_INT_F(s, l, v, h, 1, f)
191 #define OPT_CALLBACK_F(s, l, v, a, h, f, cb) { \
192 .type = OPTION_CALLBACK, \
201 #define OPT_STRING_F(s, l, v, a, h, f) { \
202 .type = OPTION_STRING, \
210 #define OPT_INTEGER_F(s, l, v, h, f) { \
211 .type = OPTION_INTEGER, \
220 #define OPT_END() { \
221 .type = OPTION_END, \
223 #define OPT_GROUP(h) { \
224 .type = OPTION_GROUP, \
227 #define OPT_BIT(s, l, v, h, b) OPT_BIT_F(s, l, v, h, b, 0)
228 #define OPT_BITOP(s, l, v, h, set, clear) { \
229 .type = OPTION_BITOP, \
234 .flags = PARSE_OPT_NOARG|PARSE_OPT_NONEG, \
238 #define OPT_NEGBIT(s, l, v, h, b) { \
239 .type = OPTION_NEGBIT, \
244 .flags = PARSE_OPT_NOARG, \
247 #define OPT_COUNTUP(s, l, v, h) OPT_COUNTUP_F(s, l, v, h, 0)
248 #define OPT_SET_INT(s, l, v, h, i) OPT_SET_INT_F(s, l, v, h, i, 0)
249 #define OPT_BOOL(s, l, v, h) OPT_BOOL_F(s, l, v, h, 0)
250 #define OPT_HIDDEN_BOOL(s, l, v, h) { \
251 .type = OPTION_SET_INT, \
256 .flags = PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, \
259 #define OPT_CMDMODE_F(s, l, v, h, i, f) { \
260 .type = OPTION_SET_INT, \
265 .flags = PARSE_OPT_CMDMODE|PARSE_OPT_NOARG|PARSE_OPT_NONEG | (f), \
268 #define OPT_CMDMODE(s, l, v, h, i) OPT_CMDMODE_F(s, l, v, h, i, 0)
270 #define OPT_INTEGER(s, l, v, h) OPT_INTEGER_F(s, l, v, h, 0)
271 #define OPT_MAGNITUDE(s, l, v, h) { \
272 .type = OPTION_MAGNITUDE, \
278 .flags = PARSE_OPT_NONEG, \
280 #define OPT_STRING(s, l, v, a, h) OPT_STRING_F(s, l, v, a, h, 0)
281 #define OPT_STRING_LIST(s, l, v, a, h) { \
282 .type = OPTION_CALLBACK, \
288 .callback = &parse_opt_string_list, \
290 #define OPT_UYN(s, l, v, h) { \
291 .type = OPTION_CALLBACK, \
296 .flags = PARSE_OPT_NOARG, \
297 .callback = &parse_opt_tertiary, \
299 #define OPT_EXPIRY_DATE(s, l, v, h) { \
300 .type = OPTION_CALLBACK, \
304 .argh = N_("expiry-date"), \
306 .callback = parse_opt_expiry_date_cb, \
308 #define OPT_CALLBACK(s, l, v, a, h, cb) OPT_CALLBACK_F(s, l, v, a, h, 0, cb)
309 #define OPT_NUMBER_CALLBACK(v, h, cb) { \
310 .type = OPTION_NUMBER, \
313 .flags = PARSE_OPT_NOARG | PARSE_OPT_NONEG, \
316 #define OPT_FILENAME(s, l, v, h) { \
317 .type = OPTION_FILENAME, \
321 .argh = N_("file"), \
324 #define OPT_COLOR_FLAG(s, l, v, h) { \
325 .type = OPTION_CALLBACK, \
329 .argh = N_("when"), \
331 .flags = PARSE_OPT_OPTARG, \
332 .callback = parse_opt_color_flag_cb, \
333 .defval = (intptr_t)"always", \
336 #define OPT_NOOP_NOARG(s, l) { \
337 .type = OPTION_CALLBACK, \
340 .help = N_("no-op (backward compatibility)"), \
341 .flags = PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, \
342 .callback = parse_opt_noop_cb, \
345 #define OPT_ALIAS(s, l, source_long_name) { \
346 .type = OPTION_ALIAS, \
349 .value = (source_long_name), \
352 #define OPT_SUBCOMMAND_F(l, v, fn, f) { \
353 .type = OPTION_SUBCOMMAND, \
357 .subcommand_fn = (fn), \
359 #define OPT_SUBCOMMAND(l, v, fn) OPT_SUBCOMMAND_F((l), (v), (fn), 0)
362 * parse_options() will filter out the processed options and leave the
363 * non-option arguments in argv[]. argv0 is assumed program name and
366 * usagestr strings should be marked for translation with N_().
368 * Returns the number of arguments left in argv[].
370 * In one-shot mode, argv0 is not a program name, argv[] is left
371 * untouched and parse_options() returns the number of options
374 int parse_options(int argc
, const char **argv
, const char *prefix
,
375 const struct option
*options
,
376 const char * const usagestr
[],
377 enum parse_opt_flags flags
);
379 NORETURN
void usage_with_options(const char * const *usagestr
,
380 const struct option
*options
);
382 NORETURN
void usage_msg_opt(const char *msg
,
383 const char * const *usagestr
,
384 const struct option
*options
);
387 * usage_msg_optf() is like usage_msg_opt() except that the first
388 * argument is a format string, and optional format arguments follow
389 * after the 3rd option.
391 __attribute__((format (printf
,1,4)))
392 void NORETURN
usage_msg_optf(const char *fmt
,
393 const char * const *usagestr
,
394 const struct option
*options
, ...);
396 void die_for_incompatible_opt4(int opt1
, const char *opt1_name
,
397 int opt2
, const char *opt2_name
,
398 int opt3
, const char *opt3_name
,
399 int opt4
, const char *opt4_name
);
402 static inline void die_for_incompatible_opt3(int opt1
, const char *opt1_name
,
403 int opt2
, const char *opt2_name
,
404 int opt3
, const char *opt3_name
)
406 die_for_incompatible_opt4(opt1
, opt1_name
,
413 * Use these assertions for callbacks that expect to be called with NONEG and
414 * NOARG respectively, and do not otherwise handle the "unset" and "arg"
417 #define BUG_ON_OPT_NEG(unset) do { \
419 BUG("option callback does not expect negation"); \
421 #define BUG_ON_OPT_ARG(arg) do { \
423 BUG("option callback does not expect an argument"); \
427 * Similar to the assertions above, but checks that "arg" is always non-NULL.
428 * This assertion also implies BUG_ON_OPT_NEG(), letting you declare both
429 * assertions in a single line.
431 #define BUG_ON_OPT_NEG_NOARG(unset, arg) do { \
432 BUG_ON_OPT_NEG(unset); \
434 BUG("option callback expects an argument"); \
437 /*----- incremental advanced APIs -----*/
440 * It's okay for the caller to consume argv/argc in the usual way.
441 * Other fields of that structure are private to parse-options and should not
442 * be modified in any way.
444 struct parse_opt_ctx_t
{
447 int argc
, cpidx
, total
;
449 enum parse_opt_flags flags
;
450 unsigned has_subcommands
;
452 const char **alias_groups
; /* must be in groups of 3 elements! */
453 struct option
*updated_options
;
456 void parse_options_start(struct parse_opt_ctx_t
*ctx
,
457 int argc
, const char **argv
, const char *prefix
,
458 const struct option
*options
,
459 enum parse_opt_flags flags
);
461 enum parse_opt_result
parse_options_step(struct parse_opt_ctx_t
*ctx
,
462 const struct option
*options
,
463 const char * const usagestr
[]);
465 int parse_options_end(struct parse_opt_ctx_t
*ctx
);
467 struct option
*parse_options_dup(const struct option
*a
);
468 struct option
*parse_options_concat(const struct option
*a
, const struct option
*b
);
470 /*----- some often used options -----*/
471 int parse_opt_abbrev_cb(const struct option
*, const char *, int);
472 int parse_opt_expiry_date_cb(const struct option
*, const char *, int);
473 int parse_opt_color_flag_cb(const struct option
*, const char *, int);
474 int parse_opt_verbosity_cb(const struct option
*, const char *, int);
475 /* value is struct oid_array* */
476 int parse_opt_object_name(const struct option
*, const char *, int);
477 /* value is struct object_id* */
478 int parse_opt_object_id(const struct option
*, const char *, int);
479 int parse_opt_commits(const struct option
*, const char *, int);
480 int parse_opt_commit(const struct option
*, const char *, int);
481 int parse_opt_tertiary(const struct option
*, const char *, int);
482 int parse_opt_string_list(const struct option
*, const char *, int);
483 int parse_opt_noop_cb(const struct option
*, const char *, int);
484 int parse_opt_passthru(const struct option
*, const char *, int);
485 int parse_opt_passthru_argv(const struct option
*, const char *, int);
486 /* value is enum branch_track* */
487 int parse_opt_tracking_mode(const struct option
*, const char *, int);
489 #define OPT__VERBOSE(var, h) OPT_COUNTUP('v', "verbose", (var), (h))
490 #define OPT__QUIET(var, h) OPT_COUNTUP('q', "quiet", (var), (h))
491 #define OPT__VERBOSITY(var) { \
492 .type = OPTION_CALLBACK, \
494 .long_name = "verbose", \
496 .help = N_("be more verbose"), \
497 .flags = PARSE_OPT_NOARG, \
498 .callback = &parse_opt_verbosity_cb, \
500 .type = OPTION_CALLBACK, \
502 .long_name = "quiet", \
504 .help = N_("be more quiet"), \
505 .flags = PARSE_OPT_NOARG, \
506 .callback = &parse_opt_verbosity_cb, \
508 #define OPT__DRY_RUN(var, h) OPT_BOOL('n', "dry-run", (var), (h))
509 #define OPT__FORCE(var, h, f) OPT_COUNTUP_F('f', "force", (var), (h), (f))
510 #define OPT__ABBREV(var) { \
511 .type = OPTION_CALLBACK, \
512 .long_name = "abbrev", \
515 .help = N_("use <n> digits to display object names"), \
516 .flags = PARSE_OPT_OPTARG, \
517 .callback = &parse_opt_abbrev_cb, \
519 #define OPT__SUPER_PREFIX(var) \
520 OPT_STRING_F(0, "super-prefix", (var), N_("prefix"), \
521 N_("prefixed path to initial superproject"), PARSE_OPT_HIDDEN)
523 #define OPT__COLOR(var, h) \
524 OPT_COLOR_FLAG(0, "color", (var), (h))
525 #define OPT_COLUMN(s, l, v, h) { \
526 .type = OPTION_CALLBACK, \
530 .argh = N_("style"), \
532 .flags = PARSE_OPT_OPTARG, \
533 .callback = parseopt_column_callback, \
535 #define OPT_PASSTHRU(s, l, v, a, h, f) { \
536 .type = OPTION_CALLBACK, \
543 .callback = parse_opt_passthru, \
545 #define OPT_PASSTHRU_ARGV(s, l, v, a, h, f) { \
546 .type = OPTION_CALLBACK, \
553 .callback = parse_opt_passthru_argv, \
555 #define _OPT_CONTAINS_OR_WITH(l, v, h, f) { \
556 .type = OPTION_CALLBACK, \
559 .argh = N_("commit"), \
561 .flags = PARSE_OPT_LASTARG_DEFAULT | (f), \
562 .callback = parse_opt_commits, \
563 .defval = (intptr_t) "HEAD", \
565 #define OPT_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("contains", v, h, PARSE_OPT_NONEG)
566 #define OPT_NO_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("no-contains", v, h, PARSE_OPT_NONEG)
567 #define OPT_WITH(v, h) _OPT_CONTAINS_OR_WITH("with", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
568 #define OPT_WITHOUT(v, h) _OPT_CONTAINS_OR_WITH("without", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
569 #define OPT_CLEANUP(v) OPT_STRING(0, "cleanup", v, N_("mode"), N_("how to strip spaces and #comments from message"))
570 #define OPT_PATHSPEC_FROM_FILE(v) OPT_FILENAME(0, "pathspec-from-file", v, N_("read pathspec from file"))
571 #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"))
572 #define OPT_AUTOSTASH(v) OPT_BOOL(0, "autostash", v, N_("automatically stash/stash pop before and after"))