blob: e22846d3b7be06fd2af2f81532633d6d773f0bab [file] [log] [blame]
Pierre Habouzit4a59fd12007-10-15 01:35:37 +02001#ifndef PARSE_OPTIONS_H
2#define PARSE_OPTIONS_H
3
Heba Waly7db03052019-11-17 21:04:54 +00004/**
5 * Refer to Documentation/technical/api-parse-options.txt for the API doc.
6 */
7
Pierre Habouzit4a59fd12007-10-15 01:35:37 +02008enum parse_opt_type {
Pierre Habouzitdb7244b2007-11-07 11:20:27 +01009 /* special types */
Pierre Habouzit4a59fd12007-10-15 01:35:37 +020010 OPTION_END,
Pierre Habouzitd7a38c52007-10-15 01:38:30 +020011 OPTION_GROUP,
René Scharfee0319ff2009-05-07 21:45:08 +020012 OPTION_NUMBER,
Nguyễn Thái Ngọc Duy5c387422019-04-29 17:05:25 +070013 OPTION_ALIAS,
Pierre Habouzitdb7244b2007-11-07 11:20:27 +010014 /* options with no arguments */
15 OPTION_BIT,
René Scharfe2f4b97f2009-05-07 21:44:17 +020016 OPTION_NEGBIT,
Nguyễn Thái Ngọc Duyf62470c2019-01-27 07:35:25 +070017 OPTION_BITOP,
Junio C Hamanob04ba2b2011-09-27 16:56:49 -070018 OPTION_COUNTUP,
Pierre Habouzitdb7244b2007-11-07 11:20:27 +010019 OPTION_SET_INT,
Pierre Habouzitdb7244b2007-11-07 11:20:27 +010020 /* options with arguments (usually) */
Pierre Habouzit4a59fd12007-10-15 01:35:37 +020021 OPTION_STRING,
22 OPTION_INTEGER,
Charles Bailey2a514ed2015-06-21 19:25:44 +010023 OPTION_MAGNITUDE,
Pierre Habouzitffe659f2007-10-15 01:45:45 +020024 OPTION_CALLBACK,
Jonathan Niederb0b3a8b2010-12-01 17:32:16 -060025 OPTION_LOWLEVEL_CALLBACK,
Stephen Boyddf217ed2009-05-23 11:53:13 -070026 OPTION_FILENAME
Pierre Habouzit4a59fd12007-10-15 01:35:37 +020027};
28
29enum parse_opt_flags {
Andrzej Hunt0171dbc2021-03-21 16:58:35 +000030 PARSE_OPT_KEEP_DASHDASH = 1 << 0,
31 PARSE_OPT_STOP_AT_NON_OPTION = 1 << 1,
32 PARSE_OPT_KEEP_ARGV0 = 1 << 2,
33 PARSE_OPT_KEEP_UNKNOWN = 1 << 3,
34 PARSE_OPT_NO_INTERNAL_HELP = 1 << 4,
35 PARSE_OPT_ONE_SHOT = 1 << 5,
Ævar Arnfjörð Bjarmason3b723f72021-09-28 15:14:22 +020036 PARSE_OPT_SHELL_EVAL = 1 << 6,
Pierre Habouzit4a59fd12007-10-15 01:35:37 +020037};
38
Pierre Habouzitffe659f2007-10-15 01:45:45 +020039enum parse_opt_option_flags {
Andrzej Hunt0171dbc2021-03-21 16:58:35 +000040 PARSE_OPT_OPTARG = 1 << 0,
41 PARSE_OPT_NOARG = 1 << 1,
42 PARSE_OPT_NONEG = 1 << 2,
43 PARSE_OPT_HIDDEN = 1 << 3,
44 PARSE_OPT_LASTARG_DEFAULT = 1 << 4,
45 PARSE_OPT_NODASH = 1 << 5,
46 PARSE_OPT_LITERAL_ARGHELP = 1 << 6,
Andrzej Hunt64cc5392021-03-21 16:58:36 +000047 PARSE_OPT_FROM_ALIAS = 1 << 7,
Andrzej Hunt0171dbc2021-03-21 16:58:35 +000048 PARSE_OPT_NOCOMPLETE = 1 << 9,
49 PARSE_OPT_COMP_ARG = 1 << 10,
50 PARSE_OPT_CMDMODE = 1 << 11,
Pierre Habouzitffe659f2007-10-15 01:45:45 +020051};
52
René Scharfe19800bd2019-08-20 20:49:07 +020053enum parse_opt_result {
54 PARSE_OPT_COMPLETE = -3,
55 PARSE_OPT_HELP = -2,
56 PARSE_OPT_ERROR = -1, /* must be the same as error() */
57 PARSE_OPT_DONE = 0, /* fixed so that "return 0" works */
58 PARSE_OPT_NON_OPTION,
59 PARSE_OPT_UNKNOWN
60};
61
Pierre Habouzitffe659f2007-10-15 01:45:45 +020062struct option;
63typedef int parse_opt_cb(const struct option *, const char *arg, int unset);
64
Jonathan Niederb0b3a8b2010-12-01 17:32:16 -060065struct parse_opt_ctx_t;
Nguyễn Thái Ngọc Duyf41179f2019-01-27 07:35:27 +070066typedef enum parse_opt_result parse_opt_ll_cb(struct parse_opt_ctx_t *ctx,
Nguyễn Thái Ngọc Duy3ebbe282019-01-27 07:35:28 +070067 const struct option *opt,
68 const char *arg, int unset);
Jonathan Niederb0b3a8b2010-12-01 17:32:16 -060069
Pierre Habouzit9b3beb52007-11-05 13:03:22 +010070/*
71 * `type`::
72 * holds the type of the option, you must have an OPTION_END last in your
73 * array.
74 *
75 * `short_name`::
76 * the character to use as a short option name, '\0' if none.
77 *
78 * `long_name`::
79 * the long option name, without the leading dashes, NULL if none.
80 *
81 * `value`::
82 * stores pointers to the values to be filled.
83 *
84 * `argh`::
Junio C Hamano4ca79942021-01-06 14:44:02 +000085 * token to explain the kind of argument this option wants. Does not
86 * begin in capital letter, and does not end with a full stop.
87 * Should be wrapped by N_() for translation.
Pierre Habouzit9b3beb52007-11-05 13:03:22 +010088 *
89 * `help`::
90 * the short help associated to what the option does.
91 * Must never be NULL (except for OPTION_END).
92 * OPTION_GROUP uses this pointer to store the group header.
Nguyễn Thái Ngọc Duy54e6dc72012-05-06 21:23:51 +070093 * Should be wrapped by N_() for translation.
Pierre Habouzit9b3beb52007-11-05 13:03:22 +010094 *
95 * `flags`::
96 * mask of parse_opt_option_flags.
Mike Ralphson3ea3c212009-04-17 19:13:30 +010097 * PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs)
Jonathan Niederef45e4d2010-08-22 21:56:38 +053098 * PARSE_OPT_NOARG: says that this option does not take an argument
Pierre Habouzitdb7244b2007-11-07 11:20:27 +010099 * PARSE_OPT_NONEG: says that this option cannot be negated
René Scharfe51a99492009-05-07 21:45:42 +0200100 * PARSE_OPT_HIDDEN: this option is skipped in the default usage, and
101 * shown only in the full usage.
Stephen Boyde169b972009-06-07 16:39:15 -0700102 * PARSE_OPT_LASTARG_DEFAULT: says that this option will take the default
103 * value if no argument is given when the option
104 * is last on the command line. If the option is
105 * not last it will require an argument.
106 * Should not be used with PARSE_OPT_OPTARG.
René Scharfe51a99492009-05-07 21:45:42 +0200107 * PARSE_OPT_NODASH: this option doesn't start with a dash.
Stephen Boyd29f25d42009-05-21 00:33:17 -0700108 * PARSE_OPT_LITERAL_ARGHELP: says that argh shouldn't be enclosed in brackets
109 * (i.e. '<argh>') in the help message.
110 * Useful for options with multiple parameters.
Nguyễn Thái Ngọc Duyb9d7f4b2018-02-09 18:01:40 +0700111 * PARSE_OPT_NOCOMPLETE: by default all visible options are completable
112 * by git-completion.bash. This option suppresses that.
Nguyễn Thái Ngọc Duyebc4a042018-02-09 18:02:12 +0700113 * PARSE_OPT_COMP_ARG: this option forces to git-completion.bash to
114 * complete an option as --name= not --name even if
115 * the option takes optional argument.
Pierre Habouzit9b3beb52007-11-05 13:03:22 +0100116 *
117 * `callback`::
Nguyễn Thái Ngọc Duybf3ff332019-01-27 07:35:26 +0700118 * pointer to the callback to use for OPTION_CALLBACK
Pierre Habouzit9b3beb52007-11-05 13:03:22 +0100119 *
120 * `defval`::
121 * default value to fill (*->value) with for PARSE_OPT_OPTARG.
Ivan Ukhovd3c08112015-03-29 10:32:55 +0200122 * OPTION_{BIT,SET_INT} store the {mask,integer} to put in the value when met.
Pierre Habouzit9b3beb52007-11-05 13:03:22 +0100123 * CALLBACKS can use it like they want.
Nguyễn Thái Ngọc Duybf3ff332019-01-27 07:35:26 +0700124 *
125 * `ll_callback`::
126 * pointer to the callback to use for OPTION_LOWLEVEL_CALLBACK
127 *
Pierre Habouzit9b3beb52007-11-05 13:03:22 +0100128 */
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200129struct option {
130 enum parse_opt_type type;
131 int short_name;
132 const char *long_name;
133 void *value;
Pierre Habouzitd7a38c52007-10-15 01:38:30 +0200134 const char *argh;
135 const char *help;
Pierre Habouzitffe659f2007-10-15 01:45:45 +0200136
Ævar Arnfjörð Bjarmason7bf7f0b2021-10-08 21:07:41 +0200137 enum parse_opt_option_flags flags;
Pierre Habouzitffe659f2007-10-15 01:45:45 +0200138 parse_opt_cb *callback;
Pierre Habouzitffe659f2007-10-15 01:45:45 +0200139 intptr_t defval;
Nguyễn Thái Ngọc Duybf3ff332019-01-27 07:35:26 +0700140 parse_opt_ll_cb *ll_callback;
Nguyễn Thái Ngọc Duyf62470c2019-01-27 07:35:25 +0700141 intptr_t extra;
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200142};
143
Nguyễn Thái Ngọc Duy2de37342018-02-09 18:01:41 +0700144#define OPT_BIT_F(s, l, v, h, b, f) { OPTION_BIT, (s), (l), (v), NULL, (h), \
145 PARSE_OPT_NOARG|(f), NULL, (b) }
146#define OPT_COUNTUP_F(s, l, v, h, f) { OPTION_COUNTUP, (s), (l), (v), NULL, \
147 (h), PARSE_OPT_NOARG|(f) }
148#define OPT_SET_INT_F(s, l, v, h, i, f) { OPTION_SET_INT, (s), (l), (v), NULL, \
149 (h), PARSE_OPT_NOARG | (f), NULL, (i) }
150#define OPT_BOOL_F(s, l, v, h, f) OPT_SET_INT_F(s, l, v, h, 1, f)
Nguyễn Thái Ngọc Duyd473e2e2019-01-27 07:35:33 +0700151#define OPT_CALLBACK_F(s, l, v, a, h, f, cb) \
152 { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), (cb) }
Nguyễn Thái Ngọc Duy31fba9d2019-03-24 15:20:05 +0700153#define OPT_STRING_F(s, l, v, a, h, f) { OPTION_STRING, (s), (l), (v), (a), (h), (f) }
Nguyễn Thái Ngọc Duy16ed6c92019-03-24 15:20:08 +0700154#define OPT_INTEGER_F(s, l, v, h, f) { OPTION_INTEGER, (s), (l), (v), N_("n"), (h), (f) }
Nguyễn Thái Ngọc Duy2de37342018-02-09 18:01:41 +0700155
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200156#define OPT_END() { OPTION_END }
Pierre Habouzitd7a38c52007-10-15 01:38:30 +0200157#define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
Nguyễn Thái Ngọc Duy2de37342018-02-09 18:01:41 +0700158#define OPT_BIT(s, l, v, h, b) OPT_BIT_F(s, l, v, h, b, 0)
Nguyễn Thái Ngọc Duyf62470c2019-01-27 07:35:25 +0700159#define OPT_BITOP(s, l, v, h, set, clear) { OPTION_BITOP, (s), (l), (v), NULL, (h), \
160 PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, \
Nguyễn Thái Ngọc Duybf3ff332019-01-27 07:35:26 +0700161 (set), NULL, (clear) }
Stephen Boyd34aec9f2009-06-04 16:43:57 -0700162#define OPT_NEGBIT(s, l, v, h, b) { OPTION_NEGBIT, (s), (l), (v), NULL, \
163 (h), PARSE_OPT_NOARG, NULL, (b) }
Nguyễn Thái Ngọc Duy2de37342018-02-09 18:01:41 +0700164#define OPT_COUNTUP(s, l, v, h) OPT_COUNTUP_F(s, l, v, h, 0)
165#define OPT_SET_INT(s, l, v, h, i) OPT_SET_INT_F(s, l, v, h, i, 0)
166#define OPT_BOOL(s, l, v, h) OPT_BOOL_F(s, l, v, h, 0)
Stefan Beller4741edd2013-08-03 13:51:18 +0200167#define OPT_HIDDEN_BOOL(s, l, v, h) { OPTION_SET_INT, (s), (l), (v), NULL, \
168 (h), PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, 1}
Ævar Arnfjörð Bjarmasond35d03c2021-09-22 00:40:36 +0200169#define OPT_CMDMODE_F(s, l, v, h, i, f) { OPTION_SET_INT, (s), (l), (v), NULL, \
170 (h), PARSE_OPT_CMDMODE|PARSE_OPT_NOARG|PARSE_OPT_NONEG | (f), NULL, (i) }
171#define OPT_CMDMODE(s, l, v, h, i) OPT_CMDMODE_F(s, l, v, h, i, 0)
172
Nguyễn Thái Ngọc Duy16ed6c92019-03-24 15:20:08 +0700173#define OPT_INTEGER(s, l, v, h) OPT_INTEGER_F(s, l, v, h, 0)
Charles Bailey2a514ed2015-06-21 19:25:44 +0100174#define OPT_MAGNITUDE(s, l, v, h) { OPTION_MAGNITUDE, (s), (l), (v), \
175 N_("n"), (h), PARSE_OPT_NONEG }
Nguyễn Thái Ngọc Duy31fba9d2019-03-24 15:20:05 +0700176#define OPT_STRING(s, l, v, a, h) OPT_STRING_F(s, l, v, a, h, 0)
Jeff Kingc8ba1632011-06-09 11:55:23 -0400177#define OPT_STRING_LIST(s, l, v, a, h) \
178 { OPTION_CALLBACK, (s), (l), (v), (a), \
179 (h), 0, &parse_opt_string_list }
Nguyễn Thái Ngọc Duyb475e442018-03-07 08:05:01 +0700180#define OPT_UYN(s, l, v, h) { OPTION_CALLBACK, (s), (l), (v), NULL, \
181 (h), PARSE_OPT_NOARG, &parse_opt_tertiary }
Junio C Hamano27ec3942013-04-25 11:13:49 -0700182#define OPT_EXPIRY_DATE(s, l, v, h) \
Junio C Hamanoe703d712014-03-23 15:58:12 -0700183 { OPTION_CALLBACK, (s), (l), (v), N_("expiry-date"),(h), 0, \
Junio C Hamano27ec3942013-04-25 11:13:49 -0700184 parse_opt_expiry_date_cb }
Nguyễn Thái Ngọc Duyd473e2e2019-01-27 07:35:33 +0700185#define OPT_CALLBACK(s, l, v, a, h, f) OPT_CALLBACK_F(s, l, v, a, h, 0, f)
René Scharfee0319ff2009-05-07 21:45:08 +0200186#define OPT_NUMBER_CALLBACK(v, h, f) \
187 { OPTION_NUMBER, 0, NULL, (v), NULL, (h), \
188 PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) }
Stephen Boyddf217ed2009-05-23 11:53:13 -0700189#define OPT_FILENAME(s, l, v, h) { OPTION_FILENAME, (s), (l), (v), \
Nguyễn Thái Ngọc Duy54e6dc72012-05-06 21:23:51 +0700190 N_("file"), (h) }
Mark Lodato73e9da02010-02-16 23:55:58 -0500191#define OPT_COLOR_FLAG(s, l, v, h) \
Nguyễn Thái Ngọc Duy54e6dc72012-05-06 21:23:51 +0700192 { OPTION_CALLBACK, (s), (l), (v), N_("when"), (h), PARSE_OPT_OPTARG, \
Mark Lodato73e9da02010-02-16 23:55:58 -0500193 parse_opt_color_flag_cb, (intptr_t)"always" }
194
René Scharfe6acec032011-09-28 19:44:30 +0200195#define OPT_NOOP_NOARG(s, l) \
196 { OPTION_CALLBACK, (s), (l), NULL, NULL, \
Nguyễn Thái Ngọc Duy54e6dc72012-05-06 21:23:51 +0700197 N_("no-op (backward compatibility)"), \
René Scharfe6acec032011-09-28 19:44:30 +0200198 PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, parse_opt_noop_cb }
199
Nguyễn Thái Ngọc Duy5c387422019-04-29 17:05:25 +0700200#define OPT_ALIAS(s, l, source_long_name) \
201 { OPTION_ALIAS, (s), (l), (source_long_name) }
202
Nguyễn Thái Ngọc Duy202fbb32019-01-27 07:35:23 +0700203/*
204 * parse_options() will filter out the processed options and leave the
205 * non-option arguments in argv[]. argv0 is assumed program name and
206 * skipped.
207 *
208 * usagestr strings should be marked for translation with N_().
209 *
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200210 * Returns the number of arguments left in argv[].
Nguyễn Thái Ngọc Duy202fbb32019-01-27 07:35:23 +0700211 *
212 * In one-shot mode, argv0 is not a program name, argv[] is left
213 * untouched and parse_options() returns the number of options
214 * processed.
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200215 */
Ævar Arnfjörð Bjarmason06a199f2021-11-09 12:04:43 +0100216int parse_options(int argc, const char **argv, const char *prefix,
217 const struct option *options,
218 const char * const usagestr[],
219 enum parse_opt_flags flags);
Pierre Habouzitd7a38c52007-10-15 01:38:30 +0200220
Nguyễn Thái Ngọc Duy1987b0b2019-01-17 20:05:00 +0700221NORETURN void usage_with_options(const char * const *usagestr,
222 const struct option *options);
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200223
Nguyễn Thái Ngọc Duy1987b0b2019-01-17 20:05:00 +0700224NORETURN void usage_msg_opt(const char *msg,
225 const char * const *usagestr,
226 const struct option *options);
Christian Couder451bb212009-02-02 06:12:58 +0100227
Jeff King517fe802018-11-05 01:45:42 -0500228/*
229 * Use these assertions for callbacks that expect to be called with NONEG and
230 * NOARG respectively, and do not otherwise handle the "unset" and "arg"
231 * parameters.
232 */
233#define BUG_ON_OPT_NEG(unset) do { \
234 if ((unset)) \
235 BUG("option callback does not expect negation"); \
236} while (0)
237#define BUG_ON_OPT_ARG(arg) do { \
238 if ((arg)) \
239 BUG("option callback does not expect an argument"); \
240} while (0)
241
Brandon Richardsoncbdeab92019-03-07 11:44:09 -0400242/*
243 * Similar to the assertions above, but checks that "arg" is always non-NULL.
244 * This assertion also implies BUG_ON_OPT_NEG(), letting you declare both
245 * assertions in a single line.
246 */
247#define BUG_ON_OPT_NEG_NOARG(unset, arg) do { \
248 BUG_ON_OPT_NEG(unset); \
249 if(!(arg)) \
250 BUG("option callback expects an argument"); \
251} while(0)
252
Mike Ralphson3ea3c212009-04-17 19:13:30 +0100253/*----- incremental advanced APIs -----*/
Pierre Habouzit7e7bbcb2008-06-23 21:59:37 +0200254
Pierre Habouzit26141b52008-06-23 22:55:11 +0200255/*
256 * It's okay for the caller to consume argv/argc in the usual way.
257 * Other fields of that structure are private to parse-options and should not
258 * be modified in any way.
259 */
Pierre Habouzit7e7bbcb2008-06-23 21:59:37 +0200260struct parse_opt_ctx_t {
261 const char **argv;
262 const char **out;
René Scharfe5ad0d3d2015-11-17 11:25:38 +0100263 int argc, cpidx, total;
Pierre Habouzit7e7bbcb2008-06-23 21:59:37 +0200264 const char *opt;
Ævar Arnfjörð Bjarmason3f9ab7c2021-10-08 21:07:38 +0200265 enum parse_opt_flags flags;
Stephen Boyd37782922009-05-23 11:53:12 -0700266 const char *prefix;
Nguyễn Thái Ngọc Duy5c387422019-04-29 17:05:25 +0700267 const char **alias_groups; /* must be in groups of 3 elements! */
268 struct option *updated_options;
Pierre Habouzit7e7bbcb2008-06-23 21:59:37 +0200269};
270
Nguyễn Thái Ngọc Duy1987b0b2019-01-17 20:05:00 +0700271void parse_options_start(struct parse_opt_ctx_t *ctx,
272 int argc, const char **argv, const char *prefix,
Ævar Arnfjörð Bjarmason3f9ab7c2021-10-08 21:07:38 +0200273 const struct option *options,
274 enum parse_opt_flags flags);
Pierre Habouzit7e7bbcb2008-06-23 21:59:37 +0200275
Ævar Arnfjörð Bjarmason352e7612021-10-08 21:07:39 +0200276enum parse_opt_result parse_options_step(struct parse_opt_ctx_t *ctx,
277 const struct option *options,
278 const char * const usagestr[]);
Pierre Habouzitff43ec32008-06-23 22:38:58 +0200279
Nguyễn Thái Ngọc Duy1987b0b2019-01-17 20:05:00 +0700280int parse_options_end(struct parse_opt_ctx_t *ctx);
Pierre Habouzit7e7bbcb2008-06-23 21:59:37 +0200281
Nguyễn Thái Ngọc Duy20871822019-03-29 17:39:04 +0700282struct option *parse_options_dup(const struct option *a);
René Scharfec8407852020-02-09 16:57:56 +0100283struct option *parse_options_concat(const struct option *a, const struct option *b);
Pierre Habouzit7e7bbcb2008-06-23 21:59:37 +0200284
Pierre Habouzit0ce865b2007-10-14 11:05:12 +0200285/*----- some often used options -----*/
Nguyễn Thái Ngọc Duy1987b0b2019-01-17 20:05:00 +0700286int parse_opt_abbrev_cb(const struct option *, const char *, int);
287int parse_opt_expiry_date_cb(const struct option *, const char *, int);
288int parse_opt_color_flag_cb(const struct option *, const char *, int);
289int parse_opt_verbosity_cb(const struct option *, const char *, int);
Phillip Wood33898532019-04-17 15:30:40 +0100290/* value is struct oid_array* */
Nguyễn Thái Ngọc Duy1987b0b2019-01-17 20:05:00 +0700291int parse_opt_object_name(const struct option *, const char *, int);
Phillip Wood33898532019-04-17 15:30:40 +0100292/* value is struct object_id* */
293int parse_opt_object_id(const struct option *, const char *, int);
Nguyễn Thái Ngọc Duy1987b0b2019-01-17 20:05:00 +0700294int parse_opt_commits(const struct option *, const char *, int);
Phillip Wood7d3488e2019-04-17 15:30:39 +0100295int parse_opt_commit(const struct option *, const char *, int);
Nguyễn Thái Ngọc Duy1987b0b2019-01-17 20:05:00 +0700296int parse_opt_tertiary(const struct option *, const char *, int);
297int parse_opt_string_list(const struct option *, const char *, int);
298int parse_opt_noop_cb(const struct option *, const char *, int);
Johannes Schindelin567fce12019-05-13 15:43:17 -0700299enum parse_opt_result parse_opt_unknown_cb(struct parse_opt_ctx_t *ctx,
300 const struct option *,
301 const char *, int);
Nguyễn Thái Ngọc Duy1987b0b2019-01-17 20:05:00 +0700302int parse_opt_passthru(const struct option *, const char *, int);
303int parse_opt_passthru_argv(const struct option *, const char *, int);
Josh Steadmond3115662021-12-20 19:30:23 -0800304/* value is enum branch_track* */
305int parse_opt_tracking_mode(const struct option *, const char *, int);
Pierre Habouzit0ce865b2007-10-14 11:05:12 +0200306
Nguyễn Thái Ngọc Duy212c0a62013-12-07 12:02:53 +0700307#define OPT__VERBOSE(var, h) OPT_COUNTUP('v', "verbose", (var), (h))
308#define OPT__QUIET(var, h) OPT_COUNTUP('q', "quiet", (var), (h))
Tuncer Ayaz7f87aff2008-11-15 01:14:24 +0100309#define OPT__VERBOSITY(var) \
Nguyễn Thái Ngọc Duy54e6dc72012-05-06 21:23:51 +0700310 { OPTION_CALLBACK, 'v', "verbose", (var), NULL, N_("be more verbose"), \
Tuncer Ayaz7f87aff2008-11-15 01:14:24 +0100311 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
Nguyễn Thái Ngọc Duy54e6dc72012-05-06 21:23:51 +0700312 { OPTION_CALLBACK, 'q', "quiet", (var), NULL, N_("be more quiet"), \
Tuncer Ayaz7f87aff2008-11-15 01:14:24 +0100313 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
Nguyễn Thái Ngọc Duy212c0a62013-12-07 12:02:53 +0700314#define OPT__DRY_RUN(var, h) OPT_BOOL('n', "dry-run", (var), (h))
Nguyễn Thái Ngọc Duy12247812018-02-09 18:01:42 +0700315#define OPT__FORCE(var, h, f) OPT_COUNTUP_F('f', "force", (var), (h), (f))
Pierre Habouzit0ce865b2007-10-14 11:05:12 +0200316#define OPT__ABBREV(var) \
Nguyễn Thái Ngọc Duy54e6dc72012-05-06 21:23:51 +0700317 { OPTION_CALLBACK, 0, "abbrev", (var), N_("n"), \
Junio C Hamano42790002020-08-13 18:07:12 -0700318 N_("use <n> digits to display object names"), \
Pierre Habouzit0ce865b2007-10-14 11:05:12 +0200319 PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
Mark Lodato73e9da02010-02-16 23:55:58 -0500320#define OPT__COLOR(var, h) \
321 OPT_COLOR_FLAG(0, "color", (var), (h))
Nguyễn Thái Ngọc Duy7e29b822012-04-21 11:44:32 +0700322#define OPT_COLUMN(s, l, v, h) \
Nguyễn Thái Ngọc Duya054e042012-08-20 19:31:50 +0700323 { OPTION_CALLBACK, (s), (l), (v), N_("style"), (h), PARSE_OPT_OPTARG, parseopt_column_callback }
Paul Tan6b3ee182015-06-14 16:41:48 +0800324#define OPT_PASSTHRU(s, l, v, a, h, f) \
325 { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru }
Paul Tanffad85c2015-06-14 16:41:49 +0800326#define OPT_PASSTHRU_ARGV(s, l, v, a, h, f) \
327 { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru_argv }
Karthik Nayakf266c912015-07-07 21:36:15 +0530328#define _OPT_CONTAINS_OR_WITH(name, variable, help, flag) \
329 { OPTION_CALLBACK, 0, name, (variable), N_("commit"), (help), \
330 PARSE_OPT_LASTARG_DEFAULT | flag, \
331 parse_opt_commits, (intptr_t) "HEAD" \
332 }
Ævar Arnfjörð Bjarmasoneab98ee2017-03-24 18:40:53 +0000333#define OPT_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("contains", v, h, PARSE_OPT_NONEG)
Ævar Arnfjörð Bjarmasonac3f5a32017-03-24 18:40:57 +0000334#define OPT_NO_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("no-contains", v, h, PARSE_OPT_NONEG)
Ævar Arnfjörð Bjarmasoneab98ee2017-03-24 18:40:53 +0000335#define OPT_WITH(v, h) _OPT_CONTAINS_OR_WITH("with", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
Ævar Arnfjörð Bjarmasonac3f5a32017-03-24 18:40:57 +0000336#define OPT_WITHOUT(v, h) _OPT_CONTAINS_OR_WITH("without", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
Denton Liuca04dc92019-04-17 11:23:26 +0100337#define OPT_CLEANUP(v) OPT_STRING(0, "cleanup", v, N_("mode"), N_("how to strip spaces and #comments from message"))
Alexandr Miloslavskiyadd97702019-11-06 15:51:13 +0000338#define OPT_PATHSPEC_FROM_FILE(v) OPT_FILENAME(0, "pathspec-from-file", v, N_("read pathspec from file"))
339#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"))
Denton Liua03b5552020-04-07 10:28:07 -0400340#define OPT_AUTOSTASH(v) OPT_BOOL(0, "autostash", v, N_("automatically stash/stash pop before and after"))
Pierre Habouzit0ce865b2007-10-14 11:05:12 +0200341
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200342#endif