blob: a4bd40bb6acf90fdafefa0983fb523dca4e8b11c [file] [log] [blame]
Pierre Habouzit4a59fd12007-10-15 01:35:37 +02001#ifndef PARSE_OPTIONS_H
2#define PARSE_OPTIONS_H
3
4enum parse_opt_type {
Pierre Habouzitdb7244b2007-11-07 11:20:27 +01005 /* special types */
Pierre Habouzit4a59fd12007-10-15 01:35:37 +02006 OPTION_END,
Pierre Habouzit580d5bf2008-03-02 11:35:56 +01007 OPTION_ARGUMENT,
Pierre Habouzitd7a38c52007-10-15 01:38:30 +02008 OPTION_GROUP,
René Scharfee0319ff2009-05-07 21:45:08 +02009 OPTION_NUMBER,
Nguyễn Thái Ngọc Duy5c387422019-04-29 17:05:25 +070010 OPTION_ALIAS,
Pierre Habouzitdb7244b2007-11-07 11:20:27 +010011 /* options with no arguments */
12 OPTION_BIT,
René Scharfe2f4b97f2009-05-07 21:44:17 +020013 OPTION_NEGBIT,
Nguyễn Thái Ngọc Duyf62470c2019-01-27 07:35:25 +070014 OPTION_BITOP,
Junio C Hamanob04ba2b2011-09-27 16:56:49 -070015 OPTION_COUNTUP,
Pierre Habouzitdb7244b2007-11-07 11:20:27 +010016 OPTION_SET_INT,
Junio C Hamano11588262013-07-30 12:06:01 -070017 OPTION_CMDMODE,
Pierre Habouzitdb7244b2007-11-07 11:20:27 +010018 /* options with arguments (usually) */
Pierre Habouzit4a59fd12007-10-15 01:35:37 +020019 OPTION_STRING,
20 OPTION_INTEGER,
Charles Bailey2a514ed2015-06-21 19:25:44 +010021 OPTION_MAGNITUDE,
Pierre Habouzitffe659f2007-10-15 01:45:45 +020022 OPTION_CALLBACK,
Jonathan Niederb0b3a8b2010-12-01 17:32:16 -060023 OPTION_LOWLEVEL_CALLBACK,
Stephen Boyddf217ed2009-05-23 11:53:13 -070024 OPTION_FILENAME
Pierre Habouzit4a59fd12007-10-15 01:35:37 +020025};
26
27enum parse_opt_flags {
28 PARSE_OPT_KEEP_DASHDASH = 1,
Johannes Schindelina0ec9d22008-02-29 01:45:09 +000029 PARSE_OPT_STOP_AT_NON_OPTION = 2,
Pierre Habouzita32a4ea2008-06-24 00:31:31 +020030 PARSE_OPT_KEEP_ARGV0 = 4,
René Scharfeb5ce3a52009-03-08 19:12:47 +010031 PARSE_OPT_KEEP_UNKNOWN = 8,
Nguyễn Thái Ngọc Duy202fbb32019-01-27 07:35:23 +070032 PARSE_OPT_NO_INTERNAL_HELP = 16,
33 PARSE_OPT_ONE_SHOT = 32
Pierre Habouzit4a59fd12007-10-15 01:35:37 +020034};
35
Pierre Habouzitffe659f2007-10-15 01:45:45 +020036enum parse_opt_option_flags {
37 PARSE_OPT_OPTARG = 1,
Pierre Habouzitf481e222007-10-16 00:32:38 +020038 PARSE_OPT_NOARG = 2,
Pierre Habouzitdb7244b2007-11-07 11:20:27 +010039 PARSE_OPT_NONEG = 4,
Pierre Habouzitdd3bf0f2007-11-19 10:21:44 +010040 PARSE_OPT_HIDDEN = 8,
Pierre Habouzit1cc69852008-07-08 12:34:08 +020041 PARSE_OPT_LASTARG_DEFAULT = 16,
René Scharfe51a99492009-05-07 21:45:42 +020042 PARSE_OPT_NODASH = 32,
Stephen Boyd29f25d42009-05-21 00:33:17 -070043 PARSE_OPT_LITERAL_ARGHELP = 64,
Nguyễn Thái Ngọc Duyb9d7f4b2018-02-09 18:01:40 +070044 PARSE_OPT_SHELL_EVAL = 256,
Nguyễn Thái Ngọc Duyebc4a042018-02-09 18:02:12 +070045 PARSE_OPT_NOCOMPLETE = 512,
46 PARSE_OPT_COMP_ARG = 1024
Pierre Habouzitffe659f2007-10-15 01:45:45 +020047};
48
49struct option;
50typedef int parse_opt_cb(const struct option *, const char *arg, int unset);
51
Jonathan Niederb0b3a8b2010-12-01 17:32:16 -060052struct parse_opt_ctx_t;
Nguyễn Thái Ngọc Duyf41179f2019-01-27 07:35:27 +070053typedef 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 +070054 const struct option *opt,
55 const char *arg, int unset);
Jonathan Niederb0b3a8b2010-12-01 17:32:16 -060056
Pierre Habouzit9b3beb52007-11-05 13:03:22 +010057/*
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
Nguyễn Thái Ngọc Duy54e6dc72012-05-06 21:23:51 +070073 * homogeneous across the repository. Should be wrapped by N_() for
74 * translation.
Pierre Habouzit9b3beb52007-11-05 13:03:22 +010075 *
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.
Nguyễn Thái Ngọc Duy54e6dc72012-05-06 21:23:51 +070080 * Should be wrapped by N_() for translation.
Pierre Habouzit9b3beb52007-11-05 13:03:22 +010081 *
82 * `flags`::
83 * mask of parse_opt_option_flags.
Mike Ralphson3ea3c212009-04-17 19:13:30 +010084 * PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs)
Jonathan Niederef45e4d2010-08-22 21:56:38 +053085 * PARSE_OPT_NOARG: says that this option does not take an argument
Pierre Habouzitdb7244b2007-11-07 11:20:27 +010086 * PARSE_OPT_NONEG: says that this option cannot be negated
René Scharfe51a99492009-05-07 21:45:42 +020087 * PARSE_OPT_HIDDEN: this option is skipped in the default usage, and
88 * shown only in the full usage.
Stephen Boyde169b972009-06-07 16:39:15 -070089 * 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.
René Scharfe51a99492009-05-07 21:45:42 +020094 * PARSE_OPT_NODASH: this option doesn't start with a dash.
Stephen Boyd29f25d42009-05-21 00:33:17 -070095 * 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.
Nguyễn Thái Ngọc Duyb9d7f4b2018-02-09 18:01:40 +070098 * PARSE_OPT_NOCOMPLETE: by default all visible options are completable
99 * by git-completion.bash. This option suppresses that.
Nguyễn Thái Ngọc Duyebc4a042018-02-09 18:02:12 +0700100 * 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.
Pierre Habouzit9b3beb52007-11-05 13:03:22 +0100103 *
104 * `callback`::
Nguyễn Thái Ngọc Duybf3ff332019-01-27 07:35:26 +0700105 * pointer to the callback to use for OPTION_CALLBACK
Pierre Habouzit9b3beb52007-11-05 13:03:22 +0100106 *
107 * `defval`::
108 * default value to fill (*->value) with for PARSE_OPT_OPTARG.
Ivan Ukhovd3c08112015-03-29 10:32:55 +0200109 * OPTION_{BIT,SET_INT} store the {mask,integer} to put in the value when met.
Pierre Habouzit9b3beb52007-11-05 13:03:22 +0100110 * CALLBACKS can use it like they want.
Nguyễn Thái Ngọc Duybf3ff332019-01-27 07:35:26 +0700111 *
112 * `ll_callback`::
113 * pointer to the callback to use for OPTION_LOWLEVEL_CALLBACK
114 *
Pierre Habouzit9b3beb52007-11-05 13:03:22 +0100115 */
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200116struct option {
117 enum parse_opt_type type;
118 int short_name;
119 const char *long_name;
120 void *value;
Pierre Habouzitd7a38c52007-10-15 01:38:30 +0200121 const char *argh;
122 const char *help;
Pierre Habouzitffe659f2007-10-15 01:45:45 +0200123
124 int flags;
125 parse_opt_cb *callback;
Pierre Habouzitffe659f2007-10-15 01:45:45 +0200126 intptr_t defval;
Nguyễn Thái Ngọc Duybf3ff332019-01-27 07:35:26 +0700127 parse_opt_ll_cb *ll_callback;
Nguyễn Thái Ngọc Duyf62470c2019-01-27 07:35:25 +0700128 intptr_t extra;
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200129};
130
Nguyễn Thái Ngọc Duy2de37342018-02-09 18:01:41 +0700131#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)
Nguyễn Thái Ngọc Duyd473e2e2019-01-27 07:35:33 +0700138#define OPT_CALLBACK_F(s, l, v, a, h, f, cb) \
139 { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), (cb) }
Nguyễn Thái Ngọc Duy31fba9d2019-03-24 15:20:05 +0700140#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 +0700141#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 +0700142
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200143#define OPT_END() { OPTION_END }
Johannes Schindelin1a85b492019-03-14 04:25:04 -0700144#define OPT_ARGUMENT(l, v, h) { OPTION_ARGUMENT, 0, (l), (v), NULL, \
145 (h), PARSE_OPT_NOARG, NULL, 1 }
Pierre Habouzitd7a38c52007-10-15 01:38:30 +0200146#define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
Nguyễn Thái Ngọc Duy2de37342018-02-09 18:01:41 +0700147#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 +0700148#define OPT_BITOP(s, l, v, h, set, clear) { OPTION_BITOP, (s), (l), (v), NULL, (h), \
149 PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, \
Nguyễn Thái Ngọc Duybf3ff332019-01-27 07:35:26 +0700150 (set), NULL, (clear) }
Stephen Boyd34aec9f2009-06-04 16:43:57 -0700151#define OPT_NEGBIT(s, l, v, h, b) { OPTION_NEGBIT, (s), (l), (v), NULL, \
152 (h), PARSE_OPT_NOARG, NULL, (b) }
Nguyễn Thái Ngọc Duy2de37342018-02-09 18:01:41 +0700153#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)
Stefan Beller4741edd2013-08-03 13:51:18 +0200156#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}
Stefan Beller14691e32015-07-29 13:18:37 -0700158#define OPT_CMDMODE(s, l, v, h, i) { OPTION_CMDMODE, (s), (l), (v), NULL, \
Junio C Hamano11588262013-07-30 12:06:01 -0700159 (h), PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, (i) }
Nguyễn Thái Ngọc Duy16ed6c92019-03-24 15:20:08 +0700160#define OPT_INTEGER(s, l, v, h) OPT_INTEGER_F(s, l, v, h, 0)
Charles Bailey2a514ed2015-06-21 19:25:44 +0100161#define OPT_MAGNITUDE(s, l, v, h) { OPTION_MAGNITUDE, (s), (l), (v), \
162 N_("n"), (h), PARSE_OPT_NONEG }
Nguyễn Thái Ngọc Duy31fba9d2019-03-24 15:20:05 +0700163#define OPT_STRING(s, l, v, a, h) OPT_STRING_F(s, l, v, a, h, 0)
Jeff Kingc8ba1632011-06-09 11:55:23 -0400164#define OPT_STRING_LIST(s, l, v, a, h) \
165 { OPTION_CALLBACK, (s), (l), (v), (a), \
166 (h), 0, &parse_opt_string_list }
Nguyễn Thái Ngọc Duyb475e442018-03-07 08:05:01 +0700167#define OPT_UYN(s, l, v, h) { OPTION_CALLBACK, (s), (l), (v), NULL, \
168 (h), PARSE_OPT_NOARG, &parse_opt_tertiary }
Junio C Hamano27ec3942013-04-25 11:13:49 -0700169#define OPT_EXPIRY_DATE(s, l, v, h) \
Junio C Hamanoe703d712014-03-23 15:58:12 -0700170 { OPTION_CALLBACK, (s), (l), (v), N_("expiry-date"),(h), 0, \
Junio C Hamano27ec3942013-04-25 11:13:49 -0700171 parse_opt_expiry_date_cb }
Nguyễn Thái Ngọc Duyd473e2e2019-01-27 07:35:33 +0700172#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 +0200173#define OPT_NUMBER_CALLBACK(v, h, f) \
174 { OPTION_NUMBER, 0, NULL, (v), NULL, (h), \
175 PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) }
Stephen Boyddf217ed2009-05-23 11:53:13 -0700176#define OPT_FILENAME(s, l, v, h) { OPTION_FILENAME, (s), (l), (v), \
Nguyễn Thái Ngọc Duy54e6dc72012-05-06 21:23:51 +0700177 N_("file"), (h) }
Mark Lodato73e9da02010-02-16 23:55:58 -0500178#define OPT_COLOR_FLAG(s, l, v, h) \
Nguyễn Thái Ngọc Duy54e6dc72012-05-06 21:23:51 +0700179 { OPTION_CALLBACK, (s), (l), (v), N_("when"), (h), PARSE_OPT_OPTARG, \
Mark Lodato73e9da02010-02-16 23:55:58 -0500180 parse_opt_color_flag_cb, (intptr_t)"always" }
181
René Scharfe6acec032011-09-28 19:44:30 +0200182#define OPT_NOOP_NOARG(s, l) \
183 { OPTION_CALLBACK, (s), (l), NULL, NULL, \
Nguyễn Thái Ngọc Duy54e6dc72012-05-06 21:23:51 +0700184 N_("no-op (backward compatibility)"), \
René Scharfe6acec032011-09-28 19:44:30 +0200185 PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, parse_opt_noop_cb }
186
Nguyễn Thái Ngọc Duy5c387422019-04-29 17:05:25 +0700187#define OPT_ALIAS(s, l, source_long_name) \
188 { OPTION_ALIAS, (s), (l), (source_long_name) }
189
Nguyễn Thái Ngọc Duy202fbb32019-01-27 07:35:23 +0700190/*
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 *
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200197 * Returns the number of arguments left in argv[].
Nguyễn Thái Ngọc Duy202fbb32019-01-27 07:35:23 +0700198 *
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.
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200202 */
Nguyễn Thái Ngọc Duy1987b0b2019-01-17 20:05:00 +0700203int parse_options(int argc, const char **argv, const char *prefix,
204 const struct option *options,
205 const char * const usagestr[], int flags);
Pierre Habouzitd7a38c52007-10-15 01:38:30 +0200206
Nguyễn Thái Ngọc Duy1987b0b2019-01-17 20:05:00 +0700207NORETURN void usage_with_options(const char * const *usagestr,
208 const struct option *options);
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200209
Nguyễn Thái Ngọc Duy1987b0b2019-01-17 20:05:00 +0700210NORETURN void usage_msg_opt(const char *msg,
211 const char * const *usagestr,
212 const struct option *options);
Christian Couder451bb212009-02-02 06:12:58 +0100213
Nguyễn Thái Ngọc Duy1987b0b2019-01-17 20:05:00 +0700214int optbug(const struct option *opt, const char *reason);
Nguyễn Thái Ngọc Duy9440b832018-11-10 06:16:11 +0100215const char *optname(const struct option *opt, int flags);
Jeff Kinga469a102012-12-15 12:42:10 -0500216
Jeff King517fe802018-11-05 01:45:42 -0500217/*
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
Brandon Richardsoncbdeab92019-03-07 11:44:09 -0400231/*
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
Mike Ralphson3ea3c212009-04-17 19:13:30 +0100242/*----- incremental advanced APIs -----*/
Pierre Habouzit7e7bbcb2008-06-23 21:59:37 +0200243
Nguyễn Thái Ngọc Duyf41179f2019-01-27 07:35:27 +0700244enum 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 */
Jonathan Nieder979240f2010-12-01 17:32:55 -0600249 PARSE_OPT_NON_OPTION,
Gary V. Vaughan4b055482010-05-14 09:31:35 +0000250 PARSE_OPT_UNKNOWN
Pierre Habouzitee68b872008-06-23 22:28:04 +0200251};
252
Pierre Habouzit26141b52008-06-23 22:55:11 +0200253/*
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 */
Pierre Habouzit7e7bbcb2008-06-23 21:59:37 +0200258struct parse_opt_ctx_t {
259 const char **argv;
260 const char **out;
René Scharfe5ad0d3d2015-11-17 11:25:38 +0100261 int argc, cpidx, total;
Pierre Habouzit7e7bbcb2008-06-23 21:59:37 +0200262 const char *opt;
263 int flags;
Stephen Boyd37782922009-05-23 11:53:12 -0700264 const char *prefix;
Nguyễn Thái Ngọc Duy5c387422019-04-29 17:05:25 +0700265 const char **alias_groups; /* must be in groups of 3 elements! */
266 struct option *updated_options;
Pierre Habouzit7e7bbcb2008-06-23 21:59:37 +0200267};
268
Nguyễn Thái Ngọc Duy1987b0b2019-01-17 20:05:00 +0700269void 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);
Pierre Habouzit7e7bbcb2008-06-23 21:59:37 +0200272
Nguyễn Thái Ngọc Duy1987b0b2019-01-17 20:05:00 +0700273int parse_options_step(struct parse_opt_ctx_t *ctx,
274 const struct option *options,
275 const char * const usagestr[]);
Pierre Habouzitff43ec32008-06-23 22:38:58 +0200276
Nguyễn Thái Ngọc Duy1987b0b2019-01-17 20:05:00 +0700277int parse_options_end(struct parse_opt_ctx_t *ctx);
Pierre Habouzit7e7bbcb2008-06-23 21:59:37 +0200278
Nguyễn Thái Ngọc Duy20871822019-03-29 17:39:04 +0700279struct option *parse_options_dup(const struct option *a);
Nguyễn Thái Ngọc Duy1987b0b2019-01-17 20:05:00 +0700280struct option *parse_options_concat(struct option *a, struct option *b);
Pierre Habouzit7e7bbcb2008-06-23 21:59:37 +0200281
Pierre Habouzit0ce865b2007-10-14 11:05:12 +0200282/*----- some often used options -----*/
Nguyễn Thái Ngọc Duy1987b0b2019-01-17 20:05:00 +0700283int parse_opt_abbrev_cb(const struct option *, const char *, int);
284int parse_opt_expiry_date_cb(const struct option *, const char *, int);
285int parse_opt_color_flag_cb(const struct option *, const char *, int);
286int parse_opt_verbosity_cb(const struct option *, const char *, int);
Phillip Wood33898532019-04-17 15:30:40 +0100287/* value is struct oid_array* */
Nguyễn Thái Ngọc Duy1987b0b2019-01-17 20:05:00 +0700288int parse_opt_object_name(const struct option *, const char *, int);
Phillip Wood33898532019-04-17 15:30:40 +0100289/* value is struct object_id* */
290int parse_opt_object_id(const struct option *, const char *, int);
Nguyễn Thái Ngọc Duy1987b0b2019-01-17 20:05:00 +0700291int parse_opt_commits(const struct option *, const char *, int);
Phillip Wood7d3488e2019-04-17 15:30:39 +0100292int parse_opt_commit(const struct option *, const char *, int);
Nguyễn Thái Ngọc Duy1987b0b2019-01-17 20:05:00 +0700293int parse_opt_tertiary(const struct option *, const char *, int);
294int parse_opt_string_list(const struct option *, const char *, int);
295int parse_opt_noop_cb(const struct option *, const char *, int);
Johannes Schindelin567fce12019-05-13 15:43:17 -0700296enum parse_opt_result parse_opt_unknown_cb(struct parse_opt_ctx_t *ctx,
297 const struct option *,
298 const char *, int);
Nguyễn Thái Ngọc Duy1987b0b2019-01-17 20:05:00 +0700299int parse_opt_passthru(const struct option *, const char *, int);
300int parse_opt_passthru_argv(const struct option *, const char *, int);
Pierre Habouzit0ce865b2007-10-14 11:05:12 +0200301
Nguyễn Thái Ngọc Duy212c0a62013-12-07 12:02:53 +0700302#define OPT__VERBOSE(var, h) OPT_COUNTUP('v', "verbose", (var), (h))
303#define OPT__QUIET(var, h) OPT_COUNTUP('q', "quiet", (var), (h))
Tuncer Ayaz7f87aff2008-11-15 01:14:24 +0100304#define OPT__VERBOSITY(var) \
Nguyễn Thái Ngọc Duy54e6dc72012-05-06 21:23:51 +0700305 { OPTION_CALLBACK, 'v', "verbose", (var), NULL, N_("be more verbose"), \
Tuncer Ayaz7f87aff2008-11-15 01:14:24 +0100306 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
Nguyễn Thái Ngọc Duy54e6dc72012-05-06 21:23:51 +0700307 { OPTION_CALLBACK, 'q', "quiet", (var), NULL, N_("be more quiet"), \
Tuncer Ayaz7f87aff2008-11-15 01:14:24 +0100308 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
Nguyễn Thái Ngọc Duy212c0a62013-12-07 12:02:53 +0700309#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 +0700310#define OPT__FORCE(var, h, f) OPT_COUNTUP_F('f', "force", (var), (h), (f))
Pierre Habouzit0ce865b2007-10-14 11:05:12 +0200311#define OPT__ABBREV(var) \
Nguyễn Thái Ngọc Duy54e6dc72012-05-06 21:23:51 +0700312 { OPTION_CALLBACK, 0, "abbrev", (var), N_("n"), \
313 N_("use <n> digits to display SHA-1s"), \
Pierre Habouzit0ce865b2007-10-14 11:05:12 +0200314 PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
Mark Lodato73e9da02010-02-16 23:55:58 -0500315#define OPT__COLOR(var, h) \
316 OPT_COLOR_FLAG(0, "color", (var), (h))
Nguyễn Thái Ngọc Duy7e29b822012-04-21 11:44:32 +0700317#define OPT_COLUMN(s, l, v, h) \
Nguyễn Thái Ngọc Duya054e042012-08-20 19:31:50 +0700318 { OPTION_CALLBACK, (s), (l), (v), N_("style"), (h), PARSE_OPT_OPTARG, parseopt_column_callback }
Paul Tan6b3ee182015-06-14 16:41:48 +0800319#define OPT_PASSTHRU(s, l, v, a, h, f) \
320 { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru }
Paul Tanffad85c2015-06-14 16:41:49 +0800321#define OPT_PASSTHRU_ARGV(s, l, v, a, h, f) \
322 { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru_argv }
Karthik Nayakf266c912015-07-07 21:36:15 +0530323#define _OPT_CONTAINS_OR_WITH(name, variable, help, flag) \
324 { OPTION_CALLBACK, 0, name, (variable), N_("commit"), (help), \
325 PARSE_OPT_LASTARG_DEFAULT | flag, \
326 parse_opt_commits, (intptr_t) "HEAD" \
327 }
Ævar Arnfjörð Bjarmasoneab98ee2017-03-24 18:40:53 +0000328#define OPT_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("contains", v, h, PARSE_OPT_NONEG)
Ævar Arnfjörð Bjarmasonac3f5a32017-03-24 18:40:57 +0000329#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 +0000330#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 +0000331#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 +0100332#define OPT_CLEANUP(v) OPT_STRING(0, "cleanup", v, N_("mode"), N_("how to strip spaces and #comments from message"))
Pierre Habouzit0ce865b2007-10-14 11:05:12 +0200333
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200334#endif