1 #ifndef PARSE_OPTIONS_H
2 #define PARSE_OPTIONS_H
5 * Refer to Documentation/technical/api-parse-options.txt for the API doc.
15 /* options with no arguments */
21 /* options with arguments (usually) */
26 OPTION_LOWLEVEL_CALLBACK
,
30 enum parse_opt_flags
{
31 PARSE_OPT_KEEP_DASHDASH
= 1 << 0,
32 PARSE_OPT_STOP_AT_NON_OPTION
= 1 << 1,
33 PARSE_OPT_KEEP_ARGV0
= 1 << 2,
34 PARSE_OPT_KEEP_UNKNOWN_OPT
= 1 << 3,
35 PARSE_OPT_NO_INTERNAL_HELP
= 1 << 4,
36 PARSE_OPT_ONE_SHOT
= 1 << 5,
37 PARSE_OPT_SHELL_EVAL
= 1 << 6,
38 PARSE_OPT_SUBCOMMAND_OPTIONAL
= 1 << 7,
41 enum parse_opt_option_flags
{
42 PARSE_OPT_OPTARG
= 1 << 0,
43 PARSE_OPT_NOARG
= 1 << 1,
44 PARSE_OPT_NONEG
= 1 << 2,
45 PARSE_OPT_HIDDEN
= 1 << 3,
46 PARSE_OPT_LASTARG_DEFAULT
= 1 << 4,
47 PARSE_OPT_NODASH
= 1 << 5,
48 PARSE_OPT_LITERAL_ARGHELP
= 1 << 6,
49 PARSE_OPT_FROM_ALIAS
= 1 << 7,
50 PARSE_OPT_NOCOMPLETE
= 1 << 9,
51 PARSE_OPT_COMP_ARG
= 1 << 10,
52 PARSE_OPT_CMDMODE
= 1 << 11,
55 enum parse_opt_result
{
56 PARSE_OPT_COMPLETE
= -3,
58 PARSE_OPT_ERROR
= -1, /* must be the same as error() */
59 PARSE_OPT_DONE
= 0, /* fixed so that "return 0" works */
66 typedef int parse_opt_cb(const struct option
*, const char *arg
, int unset
);
68 struct parse_opt_ctx_t
;
69 typedef enum parse_opt_result
parse_opt_ll_cb(struct parse_opt_ctx_t
*ctx
,
70 const struct option
*opt
,
71 const char *arg
, int unset
);
73 typedef int parse_opt_subcommand_fn(int argc
, const char **argv
,
78 * holds the type of the option, you must have an OPTION_END last in your
82 * the character to use as a short option name, '\0' if none.
85 * the long option (without the leading dashes) or subcommand name,
89 * stores pointers to the values to be filled.
92 * token to explain the kind of argument this option wants. Does not
93 * begin in capital letter, and does not end with a full stop.
94 * Should be wrapped by N_() for translation.
95 * Is automatically enclosed in brackets when printed, unless it
96 * contains any of the following characters: ()<>[]|
97 * E.g. "name" is shown as "<name>" to indicate that a name value
98 * needs to be supplied, not the literal string "name", but
99 * "<start>,<end>" and "(this|that)" are printed verbatim.
102 * the short help associated to what the option does.
103 * Must never be NULL (except for OPTION_END and OPTION_SUBCOMMAND).
104 * OPTION_GROUP uses this pointer to store the group header.
105 * Should be wrapped by N_() for translation.
108 * mask of parse_opt_option_flags.
109 * PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs)
110 * PARSE_OPT_NOARG: says that this option does not take an argument
111 * PARSE_OPT_NONEG: says that this option cannot be negated
112 * PARSE_OPT_HIDDEN: this option is skipped in the default usage, and
113 * shown only in the full usage.
114 * PARSE_OPT_LASTARG_DEFAULT: says that this option will take the default
115 * value if no argument is given when the option
116 * is last on the command line. If the option is
117 * not last it will require an argument.
118 * Should not be used with PARSE_OPT_OPTARG.
119 * PARSE_OPT_NODASH: this option doesn't start with a dash; can only be a
120 * short option and can't accept arguments.
121 * PARSE_OPT_LITERAL_ARGHELP: says that argh shouldn't be enclosed in brackets
122 * (i.e. '<argh>') in the help message.
123 * Useful for options with multiple parameters.
124 * PARSE_OPT_NOCOMPLETE: by default all visible options are completable
125 * by git-completion.bash. This option suppresses that.
126 * PARSE_OPT_COMP_ARG: this option forces to git-completion.bash to
127 * complete an option as --name= not --name even if
128 * the option takes optional argument.
131 * pointer to the callback to use for OPTION_CALLBACK
134 * default value to fill (*->value) with for PARSE_OPT_OPTARG.
135 * OPTION_{BIT,SET_INT} store the {mask,integer} to put in the value when met.
136 * CALLBACKS can use it like they want.
139 * pointer to the callback to use for OPTION_LOWLEVEL_CALLBACK
142 * pointer to a function to use for OPTION_SUBCOMMAND.
143 * It will be put in value when the subcommand is given on the command line.
146 enum parse_opt_type type
;
148 const char *long_name
;
153 enum parse_opt_option_flags flags
;
154 parse_opt_cb
*callback
;
156 parse_opt_ll_cb
*ll_callback
;
158 parse_opt_subcommand_fn
*subcommand_fn
;
161 #define OPT_BIT_F(s, l, v, h, b, f) { \
162 .type = OPTION_BIT, \
167 .flags = PARSE_OPT_NOARG|(f), \
171 #define OPT_COUNTUP_F(s, l, v, h, f) { \
172 .type = OPTION_COUNTUP, \
177 .flags = PARSE_OPT_NOARG|(f), \
179 #define OPT_SET_INT_F(s, l, v, h, i, f) { \
180 .type = OPTION_SET_INT, \
185 .flags = PARSE_OPT_NOARG | (f), \
188 #define OPT_BOOL_F(s, l, v, h, f) OPT_SET_INT_F(s, l, v, h, 1, f)
189 #define OPT_CALLBACK_F(s, l, v, a, h, f, cb) { \
190 .type = OPTION_CALLBACK, \
199 #define OPT_STRING_F(s, l, v, a, h, f) { \
200 .type = OPTION_STRING, \
208 #define OPT_INTEGER_F(s, l, v, h, f) { \
209 .type = OPTION_INTEGER, \
218 #define OPT_END() { \
219 .type = OPTION_END, \
221 #define OPT_GROUP(h) { \
222 .type = OPTION_GROUP, \
225 #define OPT_BIT(s, l, v, h, b) OPT_BIT_F(s, l, v, h, b, 0)
226 #define OPT_BITOP(s, l, v, h, set, clear) { \
227 .type = OPTION_BITOP, \
232 .flags = PARSE_OPT_NOARG|PARSE_OPT_NONEG, \
236 #define OPT_NEGBIT(s, l, v, h, b) { \
237 .type = OPTION_NEGBIT, \
242 .flags = PARSE_OPT_NOARG, \
245 #define OPT_COUNTUP(s, l, v, h) OPT_COUNTUP_F(s, l, v, h, 0)
246 #define OPT_SET_INT(s, l, v, h, i) OPT_SET_INT_F(s, l, v, h, i, 0)
247 #define OPT_BOOL(s, l, v, h) OPT_BOOL_F(s, l, v, h, 0)
248 #define OPT_HIDDEN_BOOL(s, l, v, h) { \
249 .type = OPTION_SET_INT, \
254 .flags = PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, \
257 #define OPT_CMDMODE_F(s, l, v, h, i, f) { \
258 .type = OPTION_SET_INT, \
263 .flags = PARSE_OPT_CMDMODE|PARSE_OPT_NOARG|PARSE_OPT_NONEG | (f), \
266 #define OPT_CMDMODE(s, l, v, h, i) OPT_CMDMODE_F(s, l, v, h, i, 0)
268 #define OPT_INTEGER(s, l, v, h) OPT_INTEGER_F(s, l, v, h, 0)
269 #define OPT_MAGNITUDE(s, l, v, h) { \
270 .type = OPTION_MAGNITUDE, \
276 .flags = PARSE_OPT_NONEG, \
278 #define OPT_STRING(s, l, v, a, h) OPT_STRING_F(s, l, v, a, h, 0)
279 #define OPT_STRING_LIST(s, l, v, a, h) { \
280 .type = OPTION_CALLBACK, \
286 .callback = &parse_opt_string_list, \
288 #define OPT_STRVEC(s, l, v, a, h) { \
289 .type = OPTION_CALLBACK, \
295 .callback = &parse_opt_strvec, \
297 #define OPT_UYN(s, l, v, h) { \
298 .type = OPTION_CALLBACK, \
303 .flags = PARSE_OPT_NOARG, \
304 .callback = &parse_opt_tertiary, \
306 #define OPT_EXPIRY_DATE(s, l, v, h) { \
307 .type = OPTION_CALLBACK, \
311 .argh = N_("expiry-date"), \
313 .callback = parse_opt_expiry_date_cb, \
315 #define OPT_CALLBACK(s, l, v, a, h, cb) OPT_CALLBACK_F(s, l, v, a, h, 0, cb)
316 #define OPT_NUMBER_CALLBACK(v, h, cb) { \
317 .type = OPTION_NUMBER, \
320 .flags = PARSE_OPT_NOARG | PARSE_OPT_NONEG, \
323 #define OPT_FILENAME(s, l, v, h) { \
324 .type = OPTION_FILENAME, \
328 .argh = N_("file"), \
331 #define OPT_COLOR_FLAG(s, l, v, h) { \
332 .type = OPTION_CALLBACK, \
336 .argh = N_("when"), \
338 .flags = PARSE_OPT_OPTARG, \
339 .callback = parse_opt_color_flag_cb, \
340 .defval = (intptr_t)"always", \
343 #define OPT_NOOP_NOARG(s, l) { \
344 .type = OPTION_CALLBACK, \
347 .help = N_("no-op (backward compatibility)"), \
348 .flags = PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, \
349 .callback = parse_opt_noop_cb, \
352 #define OPT_ALIAS(s, l, source_long_name) { \
353 .type = OPTION_ALIAS, \
356 .value = (source_long_name), \
359 #define OPT_SUBCOMMAND_F(l, v, fn, f) { \
360 .type = OPTION_SUBCOMMAND, \
364 .subcommand_fn = (fn), \
366 #define OPT_SUBCOMMAND(l, v, fn) OPT_SUBCOMMAND_F((l), (v), (fn), 0)
369 * parse_options() will filter out the processed options and leave the
370 * non-option arguments in argv[]. argv0 is assumed program name and
373 * usagestr strings should be marked for translation with N_().
375 * Returns the number of arguments left in argv[].
377 * In one-shot mode, argv0 is not a program name, argv[] is left
378 * untouched and parse_options() returns the number of options
381 int parse_options(int argc
, const char **argv
, const char *prefix
,
382 const struct option
*options
,
383 const char * const usagestr
[],
384 enum parse_opt_flags flags
);
386 NORETURN
void usage_with_options(const char * const *usagestr
,
387 const struct option
*options
);
389 NORETURN
void usage_msg_opt(const char *msg
,
390 const char * const *usagestr
,
391 const struct option
*options
);
394 * usage_msg_optf() is like usage_msg_opt() except that the first
395 * argument is a format string, and optional format arguments follow
396 * after the 3rd option.
398 __attribute__((format (printf
,1,4)))
399 void NORETURN
usage_msg_optf(const char *fmt
,
400 const char * const *usagestr
,
401 const struct option
*options
, ...);
403 void die_for_incompatible_opt4(int opt1
, const char *opt1_name
,
404 int opt2
, const char *opt2_name
,
405 int opt3
, const char *opt3_name
,
406 int opt4
, const char *opt4_name
);
409 static inline void die_for_incompatible_opt3(int opt1
, const char *opt1_name
,
410 int opt2
, const char *opt2_name
,
411 int opt3
, const char *opt3_name
)
413 die_for_incompatible_opt4(opt1
, opt1_name
,
420 * Use these assertions for callbacks that expect to be called with NONEG and
421 * NOARG respectively, and do not otherwise handle the "unset" and "arg"
424 #define BUG_ON_OPT_NEG(unset) do { \
426 BUG("option callback does not expect negation"); \
428 #define BUG_ON_OPT_ARG(arg) do { \
430 BUG("option callback does not expect an argument"); \
434 * Similar to the assertions above, but checks that "arg" is always non-NULL.
435 * This assertion also implies BUG_ON_OPT_NEG(), letting you declare both
436 * assertions in a single line.
438 #define BUG_ON_OPT_NEG_NOARG(unset, arg) do { \
439 BUG_ON_OPT_NEG(unset); \
441 BUG("option callback expects an argument"); \
444 /*----- incremental advanced APIs -----*/
447 * It's okay for the caller to consume argv/argc in the usual way.
448 * Other fields of that structure are private to parse-options and should not
449 * be modified in any way.
451 struct parse_opt_ctx_t
{
454 int argc
, cpidx
, total
;
456 enum parse_opt_flags flags
;
457 unsigned has_subcommands
;
459 const char **alias_groups
; /* must be in groups of 3 elements! */
460 struct option
*updated_options
;
463 void parse_options_start(struct parse_opt_ctx_t
*ctx
,
464 int argc
, const char **argv
, const char *prefix
,
465 const struct option
*options
,
466 enum parse_opt_flags flags
);
468 enum parse_opt_result
parse_options_step(struct parse_opt_ctx_t
*ctx
,
469 const struct option
*options
,
470 const char * const usagestr
[]);
472 int parse_options_end(struct parse_opt_ctx_t
*ctx
);
474 struct option
*parse_options_dup(const struct option
*a
);
475 struct option
*parse_options_concat(const struct option
*a
, const struct option
*b
);
477 /*----- some often used options -----*/
478 int parse_opt_abbrev_cb(const struct option
*, const char *, int);
479 int parse_opt_expiry_date_cb(const struct option
*, const char *, int);
480 int parse_opt_color_flag_cb(const struct option
*, const char *, int);
481 int parse_opt_verbosity_cb(const struct option
*, const char *, int);
482 /* value is struct oid_array* */
483 int parse_opt_object_name(const struct option
*, const char *, int);
484 /* value is struct object_id* */
485 int parse_opt_object_id(const struct option
*, const char *, int);
486 int parse_opt_commits(const struct option
*, const char *, int);
487 int parse_opt_commit(const struct option
*, const char *, int);
488 int parse_opt_tertiary(const struct option
*, const char *, int);
489 int parse_opt_string_list(const struct option
*, const char *, int);
490 int parse_opt_strvec(const struct option
*, const char *, int);
491 int parse_opt_noop_cb(const struct option
*, const char *, int);
492 enum parse_opt_result
parse_opt_unknown_cb(struct parse_opt_ctx_t
*ctx
,
493 const struct option
*,
495 int parse_opt_passthru(const struct option
*, const char *, int);
496 int parse_opt_passthru_argv(const struct option
*, const char *, int);
497 /* value is enum branch_track* */
498 int parse_opt_tracking_mode(const struct option
*, const char *, int);
500 #define OPT__VERBOSE(var, h) OPT_COUNTUP('v', "verbose", (var), (h))
501 #define OPT__QUIET(var, h) OPT_COUNTUP('q', "quiet", (var), (h))
502 #define OPT__VERBOSITY(var) { \
503 .type = OPTION_CALLBACK, \
505 .long_name = "verbose", \
507 .help = N_("be more verbose"), \
508 .flags = PARSE_OPT_NOARG, \
509 .callback = &parse_opt_verbosity_cb, \
511 .type = OPTION_CALLBACK, \
513 .long_name = "quiet", \
515 .help = N_("be more quiet"), \
516 .flags = PARSE_OPT_NOARG, \
517 .callback = &parse_opt_verbosity_cb, \
519 #define OPT__DRY_RUN(var, h) OPT_BOOL('n', "dry-run", (var), (h))
520 #define OPT__FORCE(var, h, f) OPT_COUNTUP_F('f', "force", (var), (h), (f))
521 #define OPT__ABBREV(var) { \
522 .type = OPTION_CALLBACK, \
523 .long_name = "abbrev", \
526 .help = N_("use <n> digits to display object names"), \
527 .flags = PARSE_OPT_OPTARG, \
528 .callback = &parse_opt_abbrev_cb, \
530 #define OPT__SUPER_PREFIX(var) \
531 OPT_STRING_F(0, "super-prefix", (var), N_("prefix"), \
532 N_("prefixed path to initial superproject"), PARSE_OPT_HIDDEN)
534 #define OPT__COLOR(var, h) \
535 OPT_COLOR_FLAG(0, "color", (var), (h))
536 #define OPT_COLUMN(s, l, v, h) { \
537 .type = OPTION_CALLBACK, \
541 .argh = N_("style"), \
543 .flags = PARSE_OPT_OPTARG, \
544 .callback = parseopt_column_callback, \
546 #define OPT_PASSTHRU(s, l, v, a, h, f) { \
547 .type = OPTION_CALLBACK, \
554 .callback = parse_opt_passthru, \
556 #define OPT_PASSTHRU_ARGV(s, l, v, a, h, f) { \
557 .type = OPTION_CALLBACK, \
564 .callback = parse_opt_passthru_argv, \
566 #define _OPT_CONTAINS_OR_WITH(l, v, h, f) { \
567 .type = OPTION_CALLBACK, \
570 .argh = N_("commit"), \
572 .flags = PARSE_OPT_LASTARG_DEFAULT | (f), \
573 .callback = parse_opt_commits, \
574 .defval = (intptr_t) "HEAD", \
576 #define OPT_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("contains", v, h, PARSE_OPT_NONEG)
577 #define OPT_NO_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("no-contains", v, h, PARSE_OPT_NONEG)
578 #define OPT_WITH(v, h) _OPT_CONTAINS_OR_WITH("with", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
579 #define OPT_WITHOUT(v, h) _OPT_CONTAINS_OR_WITH("without", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
580 #define OPT_CLEANUP(v) OPT_STRING(0, "cleanup", v, N_("mode"), N_("how to strip spaces and #comments from message"))
581 #define OPT_PATHSPEC_FROM_FILE(v) OPT_FILENAME(0, "pathspec-from-file", v, N_("read pathspec from file"))
582 #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"))
583 #define OPT_AUTOSTASH(v) OPT_BOOL(0, "autostash", v, N_("automatically stash/stash pop before and after"))