blob: e6f56768ca5de8f644143ee462ac11dd959e5946 [file] [log] [blame]
Pierre Habouzit4a59fd12007-10-15 01:35:37 +02001#include "git-compat-util.h"
2#include "parse-options.h"
Pierre Habouzit26141b52008-06-23 22:55:11 +02003#include "cache.h"
Brandon Williamsb2141fc2017-06-14 11:07:36 -07004#include "config.h"
Jake Goulding269defd2009-01-26 09:13:23 -05005#include "commit.h"
Mark Lodato73e9da02010-02-16 23:55:58 -05006#include "color.h"
Jiang Xinc0821962013-02-09 14:31:09 +08007#include "utf8.h"
Pierre Habouzit4a59fd12007-10-15 01:35:37 +02008
Johannes Schindelinb02e7d52019-04-12 02:37:24 -07009static int disallow_abbreviated_options;
10
Pierre Habouzit4a59fd12007-10-15 01:35:37 +020011#define OPT_SHORT 1
12#define OPT_UNSET 2
13
Dmitry Ivankov1f275b72011-08-11 15:15:37 +060014int optbug(const struct option *opt, const char *reason)
Jonathan Nieder1e5ce572010-12-02 00:01:18 -060015{
Junio C Hamanoaf465af2014-09-03 12:42:37 -070016 if (opt->long_name) {
17 if (opt->short_name)
18 return error("BUG: switch '%c' (--%s) %s",
19 opt->short_name, opt->long_name, reason);
Jonathan Nieder1e5ce572010-12-02 00:01:18 -060020 return error("BUG: option '%s' %s", opt->long_name, reason);
Junio C Hamanoaf465af2014-09-03 12:42:37 -070021 }
Jonathan Nieder1e5ce572010-12-02 00:01:18 -060022 return error("BUG: switch '%c' %s", opt->short_name, reason);
23}
24
Nguyễn Thái Ngọc Duyf41179f2019-01-27 07:35:27 +070025static enum parse_opt_result get_arg(struct parse_opt_ctx_t *p,
26 const struct option *opt,
27 int flags, const char **arg)
Pierre Habouzit1cc69852008-07-08 12:34:08 +020028{
29 if (p->opt) {
30 *arg = p->opt;
31 p->opt = NULL;
32 } else if (p->argc == 1 && (opt->flags & PARSE_OPT_LASTARG_DEFAULT)) {
33 *arg = (const char *)opt->defval;
Olivier Marind5d745f2008-07-21 20:30:36 +020034 } else if (p->argc > 1) {
Pierre Habouzit1cc69852008-07-08 12:34:08 +020035 p->argc--;
36 *arg = *++p->argv;
37 } else
Nguyễn Thái Ngọc Duy9440b832018-11-10 06:16:11 +010038 return error(_("%s requires a value"), optname(opt, flags));
Pierre Habouzit1cc69852008-07-08 12:34:08 +020039 return 0;
40}
41
Stephen Boyddf217ed2009-05-23 11:53:13 -070042static void fix_filename(const char *prefix, const char **file)
43{
44 if (!file || !*file || !prefix || is_absolute_path(*file)
45 || !strcmp("-", *file))
46 return;
Jeff Kinge4da43b2017-03-20 21:28:49 -040047 *file = prefix_filename(prefix, *file);
Stephen Boyddf217ed2009-05-23 11:53:13 -070048}
49
Nguyễn Thái Ngọc Duyf41179f2019-01-27 07:35:27 +070050static enum parse_opt_result opt_command_mode_error(
51 const struct option *opt,
52 const struct option *all_opts,
53 int flags)
Junio C Hamano11588262013-07-30 12:06:01 -070054{
55 const struct option *that;
Junio C Hamano11588262013-07-30 12:06:01 -070056 struct strbuf that_name = STRBUF_INIT;
57
58 /*
59 * Find the other option that was used to set the variable
60 * already, and report that this is not compatible with it.
61 */
62 for (that = all_opts; that->type != OPTION_END; that++) {
63 if (that == opt ||
Paolo Bonzinibc8620b2020-02-20 15:15:16 +010064 !(that->flags & PARSE_OPT_CMDMODE) ||
Junio C Hamano11588262013-07-30 12:06:01 -070065 that->value != opt->value ||
66 that->defval != *(int *)opt->value)
67 continue;
68
69 if (that->long_name)
70 strbuf_addf(&that_name, "--%s", that->long_name);
71 else
72 strbuf_addf(&that_name, "-%c", that->short_name);
Nguyễn Thái Ngọc Duy9440b832018-11-10 06:16:11 +010073 error(_("%s is incompatible with %s"),
74 optname(opt, flags), that_name.buf);
Junio C Hamano11588262013-07-30 12:06:01 -070075 strbuf_release(&that_name);
Nguyễn Thái Ngọc Duyf41179f2019-01-27 07:35:27 +070076 return PARSE_OPT_ERROR;
Junio C Hamano11588262013-07-30 12:06:01 -070077 }
Nguyễn Thái Ngọc Duy9440b832018-11-10 06:16:11 +010078 return error(_("%s : incompatible with something else"),
79 optname(opt, flags));
Junio C Hamano11588262013-07-30 12:06:01 -070080}
81
Nguyễn Thái Ngọc Duyf41179f2019-01-27 07:35:27 +070082static enum parse_opt_result get_value(struct parse_opt_ctx_t *p,
83 const struct option *opt,
84 const struct option *all_opts,
85 int flags)
Pierre Habouzit4a59fd12007-10-15 01:35:37 +020086{
Pierre Habouzitffe659f2007-10-15 01:45:45 +020087 const char *s, *arg;
Pierre Habouzitdb7244b2007-11-07 11:20:27 +010088 const int unset = flags & OPT_UNSET;
Stephen Boyddf217ed2009-05-23 11:53:13 -070089 int err;
Pierre Habouzit4a59fd12007-10-15 01:35:37 +020090
Pierre Habouzitdb7244b2007-11-07 11:20:27 +010091 if (unset && p->opt)
Nguyễn Thái Ngọc Duy9440b832018-11-10 06:16:11 +010092 return error(_("%s takes no value"), optname(opt, flags));
Pierre Habouzitdb7244b2007-11-07 11:20:27 +010093 if (unset && (opt->flags & PARSE_OPT_NONEG))
Nguyễn Thái Ngọc Duy9440b832018-11-10 06:16:11 +010094 return error(_("%s isn't available"), optname(opt, flags));
Stephen Boydc1f4ec92010-12-01 17:30:40 -060095 if (!(flags & OPT_SHORT) && p->opt && (opt->flags & PARSE_OPT_NOARG))
Nguyễn Thái Ngọc Duy9440b832018-11-10 06:16:11 +010096 return error(_("%s takes no value"), optname(opt, flags));
Pierre Habouzitdb7244b2007-11-07 11:20:27 +010097
Paolo Bonzinibc8620b2020-02-20 15:15:16 +010098 /*
99 * Giving the same mode option twice, although unnecessary,
100 * is not a grave error, so let it pass.
101 */
102 if ((opt->flags & PARSE_OPT_CMDMODE) &&
103 *(int *)opt->value && *(int *)opt->value != opt->defval)
104 return opt_command_mode_error(opt, all_opts, flags);
105
Pierre Habouzitdb7244b2007-11-07 11:20:27 +0100106 switch (opt->type) {
Jonathan Niederb0b3a8b2010-12-01 17:32:16 -0600107 case OPTION_LOWLEVEL_CALLBACK:
Nguyễn Thái Ngọc Duy3ebbe282019-01-27 07:35:28 +0700108 return opt->ll_callback(p, opt, NULL, unset);
Jonathan Niederb0b3a8b2010-12-01 17:32:16 -0600109
Pierre Habouzitdb7244b2007-11-07 11:20:27 +0100110 case OPTION_BIT:
111 if (unset)
112 *(int *)opt->value &= ~opt->defval;
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200113 else
Pierre Habouzitdb7244b2007-11-07 11:20:27 +0100114 *(int *)opt->value |= opt->defval;
115 return 0;
116
René Scharfe2f4b97f2009-05-07 21:44:17 +0200117 case OPTION_NEGBIT:
118 if (unset)
119 *(int *)opt->value |= opt->defval;
120 else
121 *(int *)opt->value &= ~opt->defval;
122 return 0;
123
Nguyễn Thái Ngọc Duyf62470c2019-01-27 07:35:25 +0700124 case OPTION_BITOP:
125 if (unset)
126 BUG("BITOP can't have unset form");
127 *(int *)opt->value &= ~opt->extra;
128 *(int *)opt->value |= opt->defval;
129 return 0;
130
Junio C Hamanob04ba2b2011-09-27 16:56:49 -0700131 case OPTION_COUNTUP:
Pranit Bauvae0070e82016-05-05 15:20:00 +0530132 if (*(int *)opt->value < 0)
133 *(int *)opt->value = 0;
Pierre Habouzitdb7244b2007-11-07 11:20:27 +0100134 *(int *)opt->value = unset ? 0 : *(int *)opt->value + 1;
135 return 0;
136
137 case OPTION_SET_INT:
138 *(int *)opt->value = unset ? 0 : opt->defval;
139 return 0;
140
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200141 case OPTION_STRING:
Pierre Habouzit1cc69852008-07-08 12:34:08 +0200142 if (unset)
Pierre Habouzitdb7244b2007-11-07 11:20:27 +0100143 *(const char **)opt->value = NULL;
Pierre Habouzit1cc69852008-07-08 12:34:08 +0200144 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
Pierre Habouzitffe659f2007-10-15 01:45:45 +0200145 *(const char **)opt->value = (const char *)opt->defval;
Pierre Habouzit1cc69852008-07-08 12:34:08 +0200146 else
147 return get_arg(p, opt, flags, (const char **)opt->value);
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200148 return 0;
149
Stephen Boyddf217ed2009-05-23 11:53:13 -0700150 case OPTION_FILENAME:
151 err = 0;
152 if (unset)
153 *(const char **)opt->value = NULL;
154 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
155 *(const char **)opt->value = (const char *)opt->defval;
156 else
157 err = get_arg(p, opt, flags, (const char **)opt->value);
158
159 if (!err)
160 fix_filename(p->prefix, (const char **)opt->value);
161 return err;
162
Pierre Habouzitffe659f2007-10-15 01:45:45 +0200163 case OPTION_CALLBACK:
Nguyễn Thái Ngọc Duy3ebbe282019-01-27 07:35:28 +0700164 {
165 const char *p_arg = NULL;
166 int p_unset;
Pierre Habouzitffe659f2007-10-15 01:45:45 +0200167
Nguyễn Thái Ngọc Duy3ebbe282019-01-27 07:35:28 +0700168 if (unset)
169 p_unset = 1;
170 else if (opt->flags & PARSE_OPT_NOARG)
171 p_unset = 0;
172 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
173 p_unset = 0;
174 else if (get_arg(p, opt, flags, &arg))
175 return -1;
176 else {
177 p_unset = 0;
178 p_arg = arg;
179 }
180 if (opt->callback)
181 return (*opt->callback)(opt, p_arg, p_unset) ? (-1) : 0;
182 else
183 return (*opt->ll_callback)(p, opt, p_arg, p_unset);
184 }
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200185 case OPTION_INTEGER:
Pierre Habouzitdb7244b2007-11-07 11:20:27 +0100186 if (unset) {
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200187 *(int *)opt->value = 0;
188 return 0;
189 }
Pierre Habouzitc43a2482007-12-21 11:41:41 +0100190 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
Pierre Habouzitffe659f2007-10-15 01:45:45 +0200191 *(int *)opt->value = opt->defval;
192 return 0;
193 }
Pierre Habouzit1cc69852008-07-08 12:34:08 +0200194 if (get_arg(p, opt, flags, &arg))
195 return -1;
Nguyễn Thái Ngọc Duyf7e68a02019-05-29 16:11:16 +0700196 if (!*arg)
197 return error(_("%s expects a numerical value"),
198 optname(opt, flags));
Pierre Habouzit1cc69852008-07-08 12:34:08 +0200199 *(int *)opt->value = strtol(arg, (char **)&s, 10);
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200200 if (*s)
Nguyễn Thái Ngọc Duy9440b832018-11-10 06:16:11 +0100201 return error(_("%s expects a numerical value"),
202 optname(opt, flags));
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200203 return 0;
204
Charles Bailey2a514ed2015-06-21 19:25:44 +0100205 case OPTION_MAGNITUDE:
206 if (unset) {
207 *(unsigned long *)opt->value = 0;
208 return 0;
209 }
210 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
211 *(unsigned long *)opt->value = opt->defval;
212 return 0;
213 }
214 if (get_arg(p, opt, flags, &arg))
215 return -1;
216 if (!git_parse_ulong(arg, opt->value))
Nguyễn Thái Ngọc Duy9440b832018-11-10 06:16:11 +0100217 return error(_("%s expects a non-negative integer value"
218 " with an optional k/m/g suffix"),
219 optname(opt, flags));
Charles Bailey2a514ed2015-06-21 19:25:44 +0100220 return 0;
221
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200222 default:
Nguyễn Thái Ngọc Duy48a54992018-11-10 06:16:12 +0100223 BUG("opt->type %d should not happen", opt->type);
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200224 }
225}
226
Nguyễn Thái Ngọc Duyf41179f2019-01-27 07:35:27 +0700227static enum parse_opt_result parse_short_opt(struct parse_opt_ctx_t *p,
228 const struct option *options)
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200229{
Junio C Hamano11588262013-07-30 12:06:01 -0700230 const struct option *all_opts = options;
René Scharfee0319ff2009-05-07 21:45:08 +0200231 const struct option *numopt = NULL;
232
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200233 for (; options->type != OPTION_END; options++) {
234 if (options->short_name == *p->opt) {
235 p->opt = p->opt[1] ? p->opt + 1 : NULL;
Junio C Hamano11588262013-07-30 12:06:01 -0700236 return get_value(p, options, all_opts, OPT_SHORT);
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200237 }
René Scharfee0319ff2009-05-07 21:45:08 +0200238
239 /*
240 * Handle the numerical option later, explicit one-digit
241 * options take precedence over it.
242 */
243 if (options->type == OPTION_NUMBER)
244 numopt = options;
245 }
246 if (numopt && isdigit(*p->opt)) {
247 size_t len = 1;
248 char *arg;
249 int rc;
250
251 while (isdigit(p->opt[len]))
252 len++;
253 arg = xmemdupz(p->opt, len);
254 p->opt = p->opt[len] ? p->opt + len : NULL;
Nguyễn Thái Ngọc Duy3ebbe282019-01-27 07:35:28 +0700255 if (numopt->callback)
256 rc = (*numopt->callback)(numopt, arg, 0) ? (-1) : 0;
257 else
258 rc = (*numopt->ll_callback)(p, numopt, arg, 0);
René Scharfee0319ff2009-05-07 21:45:08 +0200259 free(arg);
260 return rc;
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200261 }
Nguyễn Thái Ngọc Duyf41179f2019-01-27 07:35:27 +0700262 return PARSE_OPT_UNKNOWN;
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200263}
264
Nguyễn Thái Ngọc Duy5c387422019-04-29 17:05:25 +0700265static int has_string(const char *it, const char **array)
266{
267 while (*array)
268 if (!strcmp(it, *(array++)))
269 return 1;
270 return 0;
271}
272
273static int is_alias(struct parse_opt_ctx_t *ctx,
274 const struct option *one_opt,
275 const struct option *another_opt)
276{
277 const char **group;
278
279 if (!ctx->alias_groups)
280 return 0;
281
282 if (!one_opt->long_name || !another_opt->long_name)
283 return 0;
284
285 for (group = ctx->alias_groups; *group; group += 3) {
286 /* it and other are from the same family? */
287 if (has_string(one_opt->long_name, group) &&
288 has_string(another_opt->long_name, group))
289 return 1;
290 }
291 return 0;
292}
293
Nguyễn Thái Ngọc Duyf41179f2019-01-27 07:35:27 +0700294static enum parse_opt_result parse_long_opt(
295 struct parse_opt_ctx_t *p, const char *arg,
296 const struct option *options)
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200297{
Junio C Hamano11588262013-07-30 12:06:01 -0700298 const struct option *all_opts = options;
Rohit Mani2c5495f2014-03-07 22:48:31 -0800299 const char *arg_end = strchrnul(arg, '=');
Johannes Schindelin243e0612007-11-05 13:15:21 +0000300 const struct option *abbrev_option = NULL, *ambiguous_option = NULL;
301 int abbrev_flags = 0, ambiguous_flags = 0;
Johannes Schindelin7f275b92007-10-14 17:54:06 +0100302
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200303 for (; options->type != OPTION_END; options++) {
René Scharfe0f1930c52012-02-25 20:14:54 +0100304 const char *rest, *long_name = options->long_name;
305 int flags = 0, opt_flags = 0;
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200306
René Scharfe0f1930c52012-02-25 20:14:54 +0100307 if (!long_name)
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200308 continue;
309
René Scharfe0f1930c52012-02-25 20:14:54 +0100310again:
Jeff Kingcf4fff52014-06-18 15:44:19 -0400311 if (!skip_prefix(arg, long_name, &rest))
312 rest = NULL;
Pierre Habouzit580d5bf2008-03-02 11:35:56 +0100313 if (options->type == OPTION_ARGUMENT) {
314 if (!rest)
315 continue;
316 if (*rest == '=')
Nguyễn Thái Ngọc Duy9440b832018-11-10 06:16:11 +0100317 return error(_("%s takes no value"),
318 optname(options, flags));
Pierre Habouzit580d5bf2008-03-02 11:35:56 +0100319 if (*rest)
320 continue;
Johannes Schindelin1a85b492019-03-14 04:25:04 -0700321 if (options->value)
322 *(int *)options->value = options->defval;
Pierre Habouzit580d5bf2008-03-02 11:35:56 +0100323 p->out[p->cpidx++] = arg - 2;
Nguyễn Thái Ngọc Duyf41179f2019-01-27 07:35:27 +0700324 return PARSE_OPT_DONE;
Pierre Habouzit580d5bf2008-03-02 11:35:56 +0100325 }
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200326 if (!rest) {
Johannes Schindelin7f275b92007-10-14 17:54:06 +0100327 /* abbreviated? */
Nguyễn Thái Ngọc Duybaa4adc2019-01-27 07:35:24 +0700328 if (!(p->flags & PARSE_OPT_KEEP_UNKNOWN) &&
329 !strncmp(long_name, arg, arg_end - arg)) {
Johannes Schindelin7f275b92007-10-14 17:54:06 +0100330is_abbreviated:
Nguyễn Thái Ngọc Duy5c387422019-04-29 17:05:25 +0700331 if (abbrev_option &&
332 !is_alias(p, abbrev_option, options)) {
Johannes Schindelin243e0612007-11-05 13:15:21 +0000333 /*
334 * If this is abbreviated, it is
335 * ambiguous. So when there is no
336 * exact match later, we need to
337 * error out.
338 */
339 ambiguous_option = abbrev_option;
340 ambiguous_flags = abbrev_flags;
341 }
Johannes Schindelin7f275b92007-10-14 17:54:06 +0100342 if (!(flags & OPT_UNSET) && *arg_end)
343 p->opt = arg_end + 1;
344 abbrev_option = options;
René Scharfe0f1930c52012-02-25 20:14:54 +0100345 abbrev_flags = flags ^ opt_flags;
Johannes Schindelin7f275b92007-10-14 17:54:06 +0100346 continue;
347 }
Andreas Schwab6bbfd1f2009-09-25 20:44:44 +0200348 /* negation allowed? */
349 if (options->flags & PARSE_OPT_NONEG)
350 continue;
Johannes Schindelin7f275b92007-10-14 17:54:06 +0100351 /* negated and abbreviated very much? */
Christian Couder59556542013-11-30 21:55:40 +0100352 if (starts_with("no-", arg)) {
Johannes Schindelin7f275b92007-10-14 17:54:06 +0100353 flags |= OPT_UNSET;
354 goto is_abbreviated;
355 }
356 /* negated? */
Christian Couder59556542013-11-30 21:55:40 +0100357 if (!starts_with(arg, "no-")) {
Junio C Hamano145136a2020-01-30 11:35:46 -0800358 if (skip_prefix(long_name, "no-", &long_name)) {
René Scharfe0f1930c52012-02-25 20:14:54 +0100359 opt_flags |= OPT_UNSET;
360 goto again;
361 }
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200362 continue;
René Scharfe0f1930c52012-02-25 20:14:54 +0100363 }
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200364 flags |= OPT_UNSET;
Jeff Kingcf4fff52014-06-18 15:44:19 -0400365 if (!skip_prefix(arg + 3, long_name, &rest)) {
366 /* abbreviated and negated? */
367 if (starts_with(long_name, arg + 3))
368 goto is_abbreviated;
369 else
370 continue;
371 }
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200372 }
373 if (*rest) {
374 if (*rest != '=')
375 continue;
376 p->opt = rest + 1;
377 }
Junio C Hamano11588262013-07-30 12:06:01 -0700378 return get_value(p, options, all_opts, flags ^ opt_flags);
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200379 }
Johannes Schindelin243e0612007-11-05 13:15:21 +0000380
Johannes Schindelinb02e7d52019-04-12 02:37:24 -0700381 if (disallow_abbreviated_options && (ambiguous_option || abbrev_option))
382 die("disallowed abbreviated or ambiguous option '%.*s'",
383 (int)(arg_end - arg), arg);
384
Paul-Sebastian Ungureanu3bb09232018-03-22 20:43:51 +0200385 if (ambiguous_option) {
Nguyễn Thái Ngọc Duy89003422018-11-10 06:16:13 +0100386 error(_("ambiguous option: %s "
387 "(could be --%s%s or --%s%s)"),
Johannes Schindelin243e0612007-11-05 13:15:21 +0000388 arg,
389 (ambiguous_flags & OPT_UNSET) ? "no-" : "",
390 ambiguous_option->long_name,
391 (abbrev_flags & OPT_UNSET) ? "no-" : "",
392 abbrev_option->long_name);
Nguyễn Thái Ngọc Duyf41179f2019-01-27 07:35:27 +0700393 return PARSE_OPT_HELP;
Paul-Sebastian Ungureanu3bb09232018-03-22 20:43:51 +0200394 }
Johannes Schindelin7f275b92007-10-14 17:54:06 +0100395 if (abbrev_option)
Junio C Hamano11588262013-07-30 12:06:01 -0700396 return get_value(p, abbrev_option, all_opts, abbrev_flags);
Nguyễn Thái Ngọc Duyf41179f2019-01-27 07:35:27 +0700397 return PARSE_OPT_UNKNOWN;
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200398}
399
René Scharfe51a99492009-05-07 21:45:42 +0200400static int parse_nodash_opt(struct parse_opt_ctx_t *p, const char *arg,
401 const struct option *options)
402{
Junio C Hamano11588262013-07-30 12:06:01 -0700403 const struct option *all_opts = options;
404
René Scharfe51a99492009-05-07 21:45:42 +0200405 for (; options->type != OPTION_END; options++) {
406 if (!(options->flags & PARSE_OPT_NODASH))
407 continue;
René Scharfe51a99492009-05-07 21:45:42 +0200408 if (options->short_name == arg[0] && arg[1] == '\0')
Junio C Hamano11588262013-07-30 12:06:01 -0700409 return get_value(p, options, all_opts, OPT_SHORT);
René Scharfe51a99492009-05-07 21:45:42 +0200410 }
411 return -2;
412}
413
Nanako Shiraishi1121a872008-07-16 19:42:18 +0900414static void check_typos(const char *arg, const struct option *options)
Pierre Habouzit3a9f0f42008-01-26 12:26:57 +0100415{
416 if (strlen(arg) < 3)
417 return;
418
Christian Couder59556542013-11-30 21:55:40 +0100419 if (starts_with(arg, "no-")) {
Jacques Bodin-Hullin395518c2020-02-05 13:07:23 +0000420 error(_("did you mean `--%s` (with two dashes)?"), arg);
Pierre Habouzit3a9f0f42008-01-26 12:26:57 +0100421 exit(129);
422 }
423
424 for (; options->type != OPTION_END; options++) {
425 if (!options->long_name)
426 continue;
Christian Couder59556542013-11-30 21:55:40 +0100427 if (starts_with(options->long_name, arg)) {
Jacques Bodin-Hullin395518c2020-02-05 13:07:23 +0000428 error(_("did you mean `--%s` (with two dashes)?"), arg);
Pierre Habouzit3a9f0f42008-01-26 12:26:57 +0100429 exit(129);
430 }
431 }
432}
433
Pierre Habouzitcb9d3982009-06-09 10:23:44 +0200434static void parse_options_check(const struct option *opts)
435{
436 int err = 0;
Junio C Hamanoaf465af2014-09-03 12:42:37 -0700437 char short_opts[128];
Pierre Habouzitcb9d3982009-06-09 10:23:44 +0200438
Junio C Hamanoaf465af2014-09-03 12:42:37 -0700439 memset(short_opts, '\0', sizeof(short_opts));
Pierre Habouzitcb9d3982009-06-09 10:23:44 +0200440 for (; opts->type != OPTION_END; opts++) {
441 if ((opts->flags & PARSE_OPT_LASTARG_DEFAULT) &&
Jonathan Nieder1e5ce572010-12-02 00:01:18 -0600442 (opts->flags & PARSE_OPT_OPTARG))
443 err |= optbug(opts, "uses incompatible flags "
444 "LASTARG_DEFAULT and OPTARG");
Junio C Hamanoaf465af2014-09-03 12:42:37 -0700445 if (opts->short_name) {
446 if (0x7F <= opts->short_name)
447 err |= optbug(opts, "invalid short name");
448 else if (short_opts[opts->short_name]++)
449 err |= optbug(opts, "short name already used");
450 }
Jonathan Niedera02dd4f2010-12-02 00:05:05 -0600451 if (opts->flags & PARSE_OPT_NODASH &&
452 ((opts->flags & PARSE_OPT_OPTARG) ||
453 !(opts->flags & PARSE_OPT_NOARG) ||
454 !(opts->flags & PARSE_OPT_NONEG) ||
455 opts->long_name))
456 err |= optbug(opts, "uses feature "
457 "not supported for dashless options");
Jonathan Nieder5c400ed2010-12-02 00:08:57 -0600458 switch (opts->type) {
Junio C Hamanob04ba2b2011-09-27 16:56:49 -0700459 case OPTION_COUNTUP:
Jonathan Nieder5c400ed2010-12-02 00:08:57 -0600460 case OPTION_BIT:
461 case OPTION_NEGBIT:
462 case OPTION_SET_INT:
Jonathan Nieder5c400ed2010-12-02 00:08:57 -0600463 case OPTION_NUMBER:
464 if ((opts->flags & PARSE_OPT_OPTARG) ||
465 !(opts->flags & PARSE_OPT_NOARG))
466 err |= optbug(opts, "should not accept an argument");
Nguyễn Thái Ngọc Duybf3ff332019-01-27 07:35:26 +0700467 break;
468 case OPTION_CALLBACK:
Nguyễn Thái Ngọc Duy3ebbe282019-01-27 07:35:28 +0700469 if (!opts->callback && !opts->ll_callback)
470 BUG("OPTION_CALLBACK needs one callback");
471 if (opts->callback && opts->ll_callback)
472 BUG("OPTION_CALLBACK can't have two callbacks");
Nguyễn Thái Ngọc Duybf3ff332019-01-27 07:35:26 +0700473 break;
474 case OPTION_LOWLEVEL_CALLBACK:
475 if (!opts->ll_callback)
476 BUG("OPTION_LOWLEVEL_CALLBACK needs a callback");
477 if (opts->callback)
478 BUG("OPTION_LOWLEVEL_CALLBACK needs no high level callback");
479 break;
Nguyễn Thái Ngọc Duy5c387422019-04-29 17:05:25 +0700480 case OPTION_ALIAS:
481 BUG("OPT_ALIAS() should not remain at this point. "
482 "Are you using parse_options_step() directly?\n"
483 "That case is not supported yet.");
Jonathan Nieder5c400ed2010-12-02 00:08:57 -0600484 default:
485 ; /* ok. (usually accepts an argument) */
486 }
Junio C Hamanob6c2a0d2014-03-23 16:04:36 -0700487 if (opts->argh &&
488 strcspn(opts->argh, " _") != strlen(opts->argh))
489 err |= optbug(opts, "multi-word argh should use dash to separate words");
Pierre Habouzitcb9d3982009-06-09 10:23:44 +0200490 }
Pierre Habouzitcb9d3982009-06-09 10:23:44 +0200491 if (err)
Jonathan Nieder1e5ce572010-12-02 00:01:18 -0600492 exit(128);
Pierre Habouzitcb9d3982009-06-09 10:23:44 +0200493}
494
Nguyễn Thái Ngọc Duy5c387422019-04-29 17:05:25 +0700495static void parse_options_start_1(struct parse_opt_ctx_t *ctx,
496 int argc, const char **argv, const char *prefix,
497 const struct option *options, int flags)
Pierre Habouzit7e7bbcb2008-06-23 21:59:37 +0200498{
Nguyễn Thái Ngọc Duy202fbb32019-01-27 07:35:23 +0700499 ctx->argc = argc;
500 ctx->argv = argv;
501 if (!(flags & PARSE_OPT_ONE_SHOT)) {
502 ctx->argc--;
503 ctx->argv++;
504 }
505 ctx->total = ctx->argc;
506 ctx->out = argv;
Stephen Boyd37782922009-05-23 11:53:12 -0700507 ctx->prefix = prefix;
Pierre Habouzita32a4ea2008-06-24 00:31:31 +0200508 ctx->cpidx = ((flags & PARSE_OPT_KEEP_ARGV0) != 0);
Pierre Habouzit7e7bbcb2008-06-23 21:59:37 +0200509 ctx->flags = flags;
René Scharfe0d260f92009-03-09 21:57:38 +0100510 if ((flags & PARSE_OPT_KEEP_UNKNOWN) &&
Nguyễn Thái Ngọc Duy202fbb32019-01-27 07:35:23 +0700511 (flags & PARSE_OPT_STOP_AT_NON_OPTION) &&
512 !(flags & PARSE_OPT_ONE_SHOT))
Nguyễn Thái Ngọc Duy48a54992018-11-10 06:16:12 +0100513 BUG("STOP_AT_NON_OPTION and KEEP_UNKNOWN don't go together");
Nguyễn Thái Ngọc Duy202fbb32019-01-27 07:35:23 +0700514 if ((flags & PARSE_OPT_ONE_SHOT) &&
515 (flags & PARSE_OPT_KEEP_ARGV0))
516 BUG("Can't keep argv0 if you don't have it");
Stephen Boyd9ca11692010-12-05 23:57:42 -0800517 parse_options_check(options);
Pierre Habouzit7e7bbcb2008-06-23 21:59:37 +0200518}
519
Nguyễn Thái Ngọc Duy5c387422019-04-29 17:05:25 +0700520void parse_options_start(struct parse_opt_ctx_t *ctx,
521 int argc, const char **argv, const char *prefix,
522 const struct option *options, int flags)
523{
524 memset(ctx, 0, sizeof(*ctx));
525 parse_options_start_1(ctx, argc, argv, prefix, options, flags);
526}
527
Ryan Zoellera0abe5e2020-08-19 23:06:08 +0000528static void show_negated_gitcomp(const struct option *opts, int show_all,
529 int nr_noopts)
Nguyễn Thái Ngọc Duyb221b5a2018-06-06 11:41:39 +0200530{
531 int printed_dashdash = 0;
532
533 for (; opts->type != OPTION_END; opts++) {
534 int has_unset_form = 0;
535 const char *name;
536
537 if (!opts->long_name)
538 continue;
Ryan Zoellera0abe5e2020-08-19 23:06:08 +0000539 if (!show_all &&
540 (opts->flags & (PARSE_OPT_HIDDEN | PARSE_OPT_NOCOMPLETE)))
Nguyễn Thái Ngọc Duyb221b5a2018-06-06 11:41:39 +0200541 continue;
542 if (opts->flags & PARSE_OPT_NONEG)
543 continue;
544
545 switch (opts->type) {
546 case OPTION_STRING:
547 case OPTION_FILENAME:
548 case OPTION_INTEGER:
549 case OPTION_MAGNITUDE:
550 case OPTION_CALLBACK:
551 case OPTION_BIT:
552 case OPTION_NEGBIT:
553 case OPTION_COUNTUP:
554 case OPTION_SET_INT:
555 has_unset_form = 1;
556 break;
557 default:
558 break;
559 }
560 if (!has_unset_form)
561 continue;
562
563 if (skip_prefix(opts->long_name, "no-", &name)) {
564 if (nr_noopts < 0)
565 printf(" --%s", name);
566 } else if (nr_noopts >= 0) {
567 if (nr_noopts && !printed_dashdash) {
568 printf(" --");
569 printed_dashdash = 1;
570 }
571 printf(" --no-%s", opts->long_name);
572 nr_noopts++;
573 }
574 }
575}
576
Ryan Zoellera0abe5e2020-08-19 23:06:08 +0000577static int show_gitcomp(const struct option *opts, int show_all)
Nguyễn Thái Ngọc Duyb9d7f4b2018-02-09 18:01:40 +0700578{
Nguyễn Thái Ngọc Duyb221b5a2018-06-06 11:41:39 +0200579 const struct option *original_opts = opts;
580 int nr_noopts = 0;
581
Nguyễn Thái Ngọc Duyb9d7f4b2018-02-09 18:01:40 +0700582 for (; opts->type != OPTION_END; opts++) {
583 const char *suffix = "";
584
585 if (!opts->long_name)
586 continue;
Ryan Zoellera0abe5e2020-08-19 23:06:08 +0000587 if (!show_all &&
588 (opts->flags & (PARSE_OPT_HIDDEN | PARSE_OPT_NOCOMPLETE)))
Nguyễn Thái Ngọc Duyb9d7f4b2018-02-09 18:01:40 +0700589 continue;
590
591 switch (opts->type) {
592 case OPTION_GROUP:
593 continue;
594 case OPTION_STRING:
595 case OPTION_FILENAME:
596 case OPTION_INTEGER:
597 case OPTION_MAGNITUDE:
598 case OPTION_CALLBACK:
599 if (opts->flags & PARSE_OPT_NOARG)
600 break;
601 if (opts->flags & PARSE_OPT_OPTARG)
602 break;
603 if (opts->flags & PARSE_OPT_LASTARG_DEFAULT)
604 break;
605 suffix = "=";
606 break;
607 default:
608 break;
609 }
Nguyễn Thái Ngọc Duyebc4a042018-02-09 18:02:12 +0700610 if (opts->flags & PARSE_OPT_COMP_ARG)
611 suffix = "=";
Nguyễn Thái Ngọc Duyb221b5a2018-06-06 11:41:39 +0200612 if (starts_with(opts->long_name, "no-"))
613 nr_noopts++;
Nguyễn Thái Ngọc Duyb9d7f4b2018-02-09 18:01:40 +0700614 printf(" --%s%s", opts->long_name, suffix);
615 }
Ryan Zoellera0abe5e2020-08-19 23:06:08 +0000616 show_negated_gitcomp(original_opts, show_all, -1);
617 show_negated_gitcomp(original_opts, show_all, nr_noopts);
Nguyễn Thái Ngọc Duyb9d7f4b2018-02-09 18:01:40 +0700618 fputc('\n', stdout);
Nguyễn Thái Ngọc Duya92ec7e2018-12-11 16:35:01 +0100619 return PARSE_OPT_COMPLETE;
Nguyễn Thái Ngọc Duyb9d7f4b2018-02-09 18:01:40 +0700620}
621
Nguyễn Thái Ngọc Duy5c387422019-04-29 17:05:25 +0700622/*
623 * Scan and may produce a new option[] array, which should be used
624 * instead of the original 'options'.
625 *
Elijah Newren15beaaa2019-11-05 17:07:23 +0000626 * Right now this is only used to preprocess and substitute
Nguyễn Thái Ngọc Duy5c387422019-04-29 17:05:25 +0700627 * OPTION_ALIAS.
Andrzej Hunt64cc5392021-03-21 16:58:36 +0000628 *
629 * The returned options should be freed using free_preprocessed_options.
Nguyễn Thái Ngọc Duy5c387422019-04-29 17:05:25 +0700630 */
631static struct option *preprocess_options(struct parse_opt_ctx_t *ctx,
632 const struct option *options)
633{
634 struct option *newopt;
635 int i, nr, alias;
636 int nr_aliases = 0;
637
638 for (nr = 0; options[nr].type != OPTION_END; nr++) {
639 if (options[nr].type == OPTION_ALIAS)
640 nr_aliases++;
641 }
642
643 if (!nr_aliases)
644 return NULL;
645
646 ALLOC_ARRAY(newopt, nr + 1);
647 COPY_ARRAY(newopt, options, nr + 1);
648
649 /* each alias has two string pointers and NULL */
650 CALLOC_ARRAY(ctx->alias_groups, 3 * (nr_aliases + 1));
651
652 for (alias = 0, i = 0; i < nr; i++) {
653 int short_name;
654 const char *long_name;
655 const char *source;
Junio C Hamano7c280582020-03-16 13:22:54 -0700656 struct strbuf help = STRBUF_INIT;
Nguyễn Thái Ngọc Duy5c387422019-04-29 17:05:25 +0700657 int j;
658
659 if (newopt[i].type != OPTION_ALIAS)
660 continue;
661
662 short_name = newopt[i].short_name;
663 long_name = newopt[i].long_name;
664 source = newopt[i].value;
665
666 if (!long_name)
667 BUG("An alias must have long option name");
Junio C Hamano7c280582020-03-16 13:22:54 -0700668 strbuf_addf(&help, _("alias of --%s"), source);
Nguyễn Thái Ngọc Duy5c387422019-04-29 17:05:25 +0700669
670 for (j = 0; j < nr; j++) {
671 const char *name = options[j].long_name;
672
673 if (!name || strcmp(name, source))
674 continue;
675
676 if (options[j].type == OPTION_ALIAS)
677 BUG("No please. Nested aliases are not supported.");
678
Nguyễn Thái Ngọc Duy5c387422019-04-29 17:05:25 +0700679 memcpy(newopt + i, options + j, sizeof(*newopt));
680 newopt[i].short_name = short_name;
681 newopt[i].long_name = long_name;
Junio C Hamano7c280582020-03-16 13:22:54 -0700682 newopt[i].help = strbuf_detach(&help, NULL);
Andrzej Hunt64cc5392021-03-21 16:58:36 +0000683 newopt[i].flags |= PARSE_OPT_FROM_ALIAS;
Nguyễn Thái Ngọc Duy5c387422019-04-29 17:05:25 +0700684 break;
685 }
686
687 if (j == nr)
688 BUG("could not find source option '%s' of alias '%s'",
689 source, newopt[i].long_name);
690 ctx->alias_groups[alias * 3 + 0] = newopt[i].long_name;
691 ctx->alias_groups[alias * 3 + 1] = options[j].long_name;
692 ctx->alias_groups[alias * 3 + 2] = NULL;
693 alias++;
694 }
695
696 return newopt;
697}
698
Andrzej Hunt64cc5392021-03-21 16:58:36 +0000699static void free_preprocessed_options(struct option *options)
700{
701 int i;
702
703 if (!options)
704 return;
705
706 for (i = 0; options[i].type != OPTION_END; i++) {
707 if (options[i].flags & PARSE_OPT_FROM_ALIAS)
708 free((void *)options[i].help);
709 }
710 free(options);
711}
712
Thomas Rast47e9cd22010-06-12 14:57:39 +0200713static int usage_with_options_internal(struct parse_opt_ctx_t *,
714 const char * const *,
Giuseppe Scrivano9c7304e2010-05-17 17:34:41 +0200715 const struct option *, int, int);
Pierre Habouzitff43ec32008-06-23 22:38:58 +0200716
717int parse_options_step(struct parse_opt_ctx_t *ctx,
718 const struct option *options,
719 const char * const usagestr[])
720{
René Scharfeb92891f2009-03-08 19:15:08 +0100721 int internal_help = !(ctx->flags & PARSE_OPT_NO_INTERNAL_HELP);
722
Pierre Habouzit26141b52008-06-23 22:55:11 +0200723 /* we must reset ->opt, unknown short option leave it dangling */
724 ctx->opt = NULL;
725
Pierre Habouzitff43ec32008-06-23 22:38:58 +0200726 for (; ctx->argc; ctx->argc--, ctx->argv++) {
727 const char *arg = ctx->argv[0];
728
Nguyễn Thái Ngọc Duy202fbb32019-01-27 07:35:23 +0700729 if (ctx->flags & PARSE_OPT_ONE_SHOT &&
730 ctx->argc != ctx->total)
731 break;
732
Pierre Habouzitff43ec32008-06-23 22:38:58 +0200733 if (*arg != '-' || !arg[1]) {
René Scharfe51a99492009-05-07 21:45:42 +0200734 if (parse_nodash_opt(ctx, arg, options) == 0)
735 continue;
Pierre Habouzitff43ec32008-06-23 22:38:58 +0200736 if (ctx->flags & PARSE_OPT_STOP_AT_NON_OPTION)
Jonathan Nieder979240f2010-12-01 17:32:55 -0600737 return PARSE_OPT_NON_OPTION;
Pierre Habouzitff43ec32008-06-23 22:38:58 +0200738 ctx->out[ctx->cpidx++] = ctx->argv[0];
739 continue;
740 }
741
René Scharfe5ad0d3d2015-11-17 11:25:38 +0100742 /* lone -h asks for help */
743 if (internal_help && ctx->total == 1 && !strcmp(arg + 1, "h"))
744 goto show_usage;
745
Ryan Zoellera0abe5e2020-08-19 23:06:08 +0000746 /*
747 * lone --git-completion-helper and --git-completion-helper-all
748 * are asked by git-completion.bash
749 */
750 if (ctx->total == 1 && !strcmp(arg, "--git-completion-helper"))
751 return show_gitcomp(options, 0);
752 if (ctx->total == 1 && !strcmp(arg, "--git-completion-helper-all"))
753 return show_gitcomp(options, 1);
Nguyễn Thái Ngọc Duyb9d7f4b2018-02-09 18:01:40 +0700754
Pierre Habouzitff43ec32008-06-23 22:38:58 +0200755 if (arg[1] != '-') {
756 ctx->opt = arg + 1;
Pierre Habouzit07fe54d2008-06-23 22:46:36 +0200757 switch (parse_short_opt(ctx, options)) {
Nguyễn Thái Ngọc Duyf41179f2019-01-27 07:35:27 +0700758 case PARSE_OPT_ERROR:
Paul-Sebastian Ungureanu3bb09232018-03-22 20:43:51 +0200759 return PARSE_OPT_ERROR;
Nguyễn Thái Ngọc Duyf41179f2019-01-27 07:35:27 +0700760 case PARSE_OPT_UNKNOWN:
René Scharfe38916c52012-03-03 12:00:29 +0100761 if (ctx->opt)
762 check_typos(arg + 1, options);
René Scharfe5ad0d3d2015-11-17 11:25:38 +0100763 if (internal_help && *ctx->opt == 'h')
764 goto show_usage;
René Scharfeb5ce3a52009-03-08 19:12:47 +0100765 goto unknown;
Nguyễn Thái Ngọc Duyf41179f2019-01-27 07:35:27 +0700766 case PARSE_OPT_NON_OPTION:
767 case PARSE_OPT_HELP:
768 case PARSE_OPT_COMPLETE:
769 BUG("parse_short_opt() cannot return these");
770 case PARSE_OPT_DONE:
771 break;
Pierre Habouzit07fe54d2008-06-23 22:46:36 +0200772 }
Pierre Habouzitff43ec32008-06-23 22:38:58 +0200773 if (ctx->opt)
774 check_typos(arg + 1, options);
775 while (ctx->opt) {
Pierre Habouzit07fe54d2008-06-23 22:46:36 +0200776 switch (parse_short_opt(ctx, options)) {
Nguyễn Thái Ngọc Duyf41179f2019-01-27 07:35:27 +0700777 case PARSE_OPT_ERROR:
Paul-Sebastian Ungureanu3bb09232018-03-22 20:43:51 +0200778 return PARSE_OPT_ERROR;
Nguyễn Thái Ngọc Duyf41179f2019-01-27 07:35:27 +0700779 case PARSE_OPT_UNKNOWN:
René Scharfe5ad0d3d2015-11-17 11:25:38 +0100780 if (internal_help && *ctx->opt == 'h')
781 goto show_usage;
782
Pierre Habouzit26141b52008-06-23 22:55:11 +0200783 /* fake a short option thing to hide the fact that we may have
784 * started to parse aggregated stuff
785 *
786 * This is leaky, too bad.
787 */
788 ctx->argv[0] = xstrdup(ctx->opt - 1);
789 *(char *)ctx->argv[0] = '-';
René Scharfeb5ce3a52009-03-08 19:12:47 +0100790 goto unknown;
Nguyễn Thái Ngọc Duyf41179f2019-01-27 07:35:27 +0700791 case PARSE_OPT_NON_OPTION:
792 case PARSE_OPT_COMPLETE:
793 case PARSE_OPT_HELP:
794 BUG("parse_short_opt() cannot return these");
795 case PARSE_OPT_DONE:
796 break;
Pierre Habouzit07fe54d2008-06-23 22:46:36 +0200797 }
Pierre Habouzitff43ec32008-06-23 22:38:58 +0200798 }
799 continue;
800 }
801
Jeff King51b45942019-08-06 10:40:16 -0400802 if (!arg[2] /* "--" */ ||
803 !strcmp(arg + 2, "end-of-options")) {
Pierre Habouzitff43ec32008-06-23 22:38:58 +0200804 if (!(ctx->flags & PARSE_OPT_KEEP_DASHDASH)) {
805 ctx->argc--;
806 ctx->argv++;
807 }
808 break;
809 }
810
René Scharfeb92891f2009-03-08 19:15:08 +0100811 if (internal_help && !strcmp(arg + 2, "help-all"))
Thomas Rast47e9cd22010-06-12 14:57:39 +0200812 return usage_with_options_internal(ctx, usagestr, options, 1, 0);
René Scharfeb92891f2009-03-08 19:15:08 +0100813 if (internal_help && !strcmp(arg + 2, "help"))
René Scharfeac20ff62015-11-17 11:25:14 +0100814 goto show_usage;
Pierre Habouzit07fe54d2008-06-23 22:46:36 +0200815 switch (parse_long_opt(ctx, arg + 2, options)) {
Nguyễn Thái Ngọc Duyf41179f2019-01-27 07:35:27 +0700816 case PARSE_OPT_ERROR:
Paul-Sebastian Ungureanu3bb09232018-03-22 20:43:51 +0200817 return PARSE_OPT_ERROR;
Nguyễn Thái Ngọc Duyf41179f2019-01-27 07:35:27 +0700818 case PARSE_OPT_UNKNOWN:
René Scharfeb5ce3a52009-03-08 19:12:47 +0100819 goto unknown;
Nguyễn Thái Ngọc Duyf41179f2019-01-27 07:35:27 +0700820 case PARSE_OPT_HELP:
Paul-Sebastian Ungureanu3bb09232018-03-22 20:43:51 +0200821 goto show_usage;
Nguyễn Thái Ngọc Duyf41179f2019-01-27 07:35:27 +0700822 case PARSE_OPT_NON_OPTION:
823 case PARSE_OPT_COMPLETE:
824 BUG("parse_long_opt() cannot return these");
825 case PARSE_OPT_DONE:
826 break;
Pierre Habouzit07fe54d2008-06-23 22:46:36 +0200827 }
René Scharfeb5ce3a52009-03-08 19:12:47 +0100828 continue;
829unknown:
Nguyễn Thái Ngọc Duy202fbb32019-01-27 07:35:23 +0700830 if (ctx->flags & PARSE_OPT_ONE_SHOT)
831 break;
René Scharfeb5ce3a52009-03-08 19:12:47 +0100832 if (!(ctx->flags & PARSE_OPT_KEEP_UNKNOWN))
833 return PARSE_OPT_UNKNOWN;
834 ctx->out[ctx->cpidx++] = ctx->argv[0];
835 ctx->opt = NULL;
Pierre Habouzitff43ec32008-06-23 22:38:58 +0200836 }
837 return PARSE_OPT_DONE;
René Scharfeac20ff62015-11-17 11:25:14 +0100838
René Scharfeac20ff62015-11-17 11:25:14 +0100839 show_usage:
Paul-Sebastian Ungureanu3bb09232018-03-22 20:43:51 +0200840 return usage_with_options_internal(ctx, usagestr, options, 0, 0);
Pierre Habouzitff43ec32008-06-23 22:38:58 +0200841}
842
Pierre Habouzit7e7bbcb2008-06-23 21:59:37 +0200843int parse_options_end(struct parse_opt_ctx_t *ctx)
844{
Nguyễn Thái Ngọc Duy202fbb32019-01-27 07:35:23 +0700845 if (ctx->flags & PARSE_OPT_ONE_SHOT)
846 return ctx->total - ctx->argc;
847
SZEDER Gáborf919ffe2018-01-22 18:50:09 +0100848 MOVE_ARRAY(ctx->out + ctx->cpidx, ctx->argv, ctx->argc);
Pierre Habouzit7e7bbcb2008-06-23 21:59:37 +0200849 ctx->out[ctx->cpidx + ctx->argc] = NULL;
850 return ctx->cpidx + ctx->argc;
851}
852
Stephen Boyd37782922009-05-23 11:53:12 -0700853int parse_options(int argc, const char **argv, const char *prefix,
854 const struct option *options, const char * const usagestr[],
855 int flags)
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200856{
Pierre Habouzit7e7bbcb2008-06-23 21:59:37 +0200857 struct parse_opt_ctx_t ctx;
Nguyễn Thái Ngọc Duy5c387422019-04-29 17:05:25 +0700858 struct option *real_options;
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200859
Johannes Schindelinb02e7d52019-04-12 02:37:24 -0700860 disallow_abbreviated_options =
861 git_env_bool("GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS", 0);
862
Nguyễn Thái Ngọc Duy5c387422019-04-29 17:05:25 +0700863 memset(&ctx, 0, sizeof(ctx));
864 real_options = preprocess_options(&ctx, options);
865 if (real_options)
866 options = real_options;
867 parse_options_start_1(&ctx, argc, argv, prefix, options, flags);
Pierre Habouzitff43ec32008-06-23 22:38:58 +0200868 switch (parse_options_step(&ctx, options, usagestr)) {
869 case PARSE_OPT_HELP:
Paul-Sebastian Ungureanu3bb09232018-03-22 20:43:51 +0200870 case PARSE_OPT_ERROR:
Pierre Habouzitff43ec32008-06-23 22:38:58 +0200871 exit(129);
Nguyễn Thái Ngọc Duya92ec7e2018-12-11 16:35:01 +0100872 case PARSE_OPT_COMPLETE:
873 exit(0);
Jonathan Nieder979240f2010-12-01 17:32:55 -0600874 case PARSE_OPT_NON_OPTION:
Pierre Habouzitff43ec32008-06-23 22:38:58 +0200875 case PARSE_OPT_DONE:
876 break;
877 default: /* PARSE_OPT_UNKNOWN */
Pierre Habouzit07fe54d2008-06-23 22:46:36 +0200878 if (ctx.argv[0][1] == '-') {
Nguyễn Thái Ngọc Duy89003422018-11-10 06:16:13 +0100879 error(_("unknown option `%s'"), ctx.argv[0] + 2);
Erik Faye-Lundb141a472013-02-12 00:13:48 +0100880 } else if (isascii(*ctx.opt)) {
Nguyễn Thái Ngọc Duy89003422018-11-10 06:16:13 +0100881 error(_("unknown switch `%c'"), *ctx.opt);
Erik Faye-Lundb141a472013-02-12 00:13:48 +0100882 } else {
Nguyễn Thái Ngọc Duy89003422018-11-10 06:16:13 +0100883 error(_("unknown non-ascii option in string: `%s'"),
Erik Faye-Lundb141a472013-02-12 00:13:48 +0100884 ctx.argv[0]);
Pierre Habouzit07fe54d2008-06-23 22:46:36 +0200885 }
886 usage_with_options(usagestr, options);
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200887 }
888
Torsten Bögershausen5c327502021-02-03 17:28:23 +0100889 precompose_argv_prefix(argc, argv, NULL);
Andrzej Hunt64cc5392021-03-21 16:58:36 +0000890 free_preprocessed_options(real_options);
Nguyễn Thái Ngọc Duy5c387422019-04-29 17:05:25 +0700891 free(ctx.alias_groups);
Pierre Habouzit7e7bbcb2008-06-23 21:59:37 +0200892 return parse_options_end(&ctx);
Pierre Habouzit4a59fd12007-10-15 01:35:37 +0200893}
Pierre Habouzitd7a38c52007-10-15 01:38:30 +0200894
Giuseppe Scrivano9c7304e2010-05-17 17:34:41 +0200895static int usage_argh(const struct option *opts, FILE *outfile)
Stephen Boyd29f25d42009-05-21 00:33:17 -0700896{
897 const char *s;
René Scharfe5f0df442018-08-02 21:18:14 +0200898 int literal = (opts->flags & PARSE_OPT_LITERAL_ARGHELP) ||
899 !opts->argh || !!strpbrk(opts->argh, "()<>[]|");
Stephen Boyd29f25d42009-05-21 00:33:17 -0700900 if (opts->flags & PARSE_OPT_OPTARG)
901 if (opts->long_name)
902 s = literal ? "[=%s]" : "[=<%s>]";
903 else
904 s = literal ? "[%s]" : "[<%s>]";
905 else
906 s = literal ? " %s" : " <%s>";
Jiang Xinc0821962013-02-09 14:31:09 +0800907 return utf8_fprintf(outfile, s, opts->argh ? _(opts->argh) : _("..."));
Stephen Boyd29f25d42009-05-21 00:33:17 -0700908}
909
Pierre Habouzitd7a38c52007-10-15 01:38:30 +0200910#define USAGE_OPTS_WIDTH 24
911#define USAGE_GAP 2
912
Thomas Rast47e9cd22010-06-12 14:57:39 +0200913static int usage_with_options_internal(struct parse_opt_ctx_t *ctx,
914 const char * const *usagestr,
915 const struct option *opts, int full, int err)
Pierre Habouzitd7a38c52007-10-15 01:38:30 +0200916{
Giuseppe Scrivano9c7304e2010-05-17 17:34:41 +0200917 FILE *outfile = err ? stderr : stdout;
Brandon Caseya6304fa2017-09-24 21:08:05 -0700918 int need_newline;
Giuseppe Scrivano9c7304e2010-05-17 17:34:41 +0200919
René Scharfe49b61802009-03-08 19:16:58 +0100920 if (!usagestr)
921 return PARSE_OPT_HELP;
922
Thomas Rast47e9cd22010-06-12 14:57:39 +0200923 if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
924 fprintf(outfile, "cat <<\\EOF\n");
925
Nguyễn Thái Ngọc Duy54e6dc72012-05-06 21:23:51 +0700926 fprintf_ln(outfile, _("usage: %s"), _(*usagestr++));
Alex Riesenf389c802007-10-14 00:10:51 +0200927 while (*usagestr && **usagestr)
Ævar Arnfjörð Bjarmason66f5f6d2017-05-11 21:20:12 +0000928 /*
929 * TRANSLATORS: the colon here should align with the
930 * one in "usage: %s" translation.
931 */
Nguyễn Thái Ngọc Duy54e6dc72012-05-06 21:23:51 +0700932 fprintf_ln(outfile, _(" or: %s"), _(*usagestr++));
Jeff King44d86e92008-06-14 03:27:21 -0400933 while (*usagestr) {
Nguyễn Thái Ngọc Duy54e6dc72012-05-06 21:23:51 +0700934 if (**usagestr)
935 fprintf_ln(outfile, _(" %s"), _(*usagestr));
936 else
Brandon Casey1a9bf1e2017-09-24 21:08:04 -0700937 fputc('\n', outfile);
Jeff King44d86e92008-06-14 03:27:21 -0400938 usagestr++;
939 }
Pierre Habouzitd7a38c52007-10-15 01:38:30 +0200940
Brandon Caseya6304fa2017-09-24 21:08:05 -0700941 need_newline = 1;
Pierre Habouzitd7a38c52007-10-15 01:38:30 +0200942
943 for (; opts->type != OPTION_END; opts++) {
944 size_t pos;
945 int pad;
946
947 if (opts->type == OPTION_GROUP) {
Giuseppe Scrivano9c7304e2010-05-17 17:34:41 +0200948 fputc('\n', outfile);
Brandon Caseya6304fa2017-09-24 21:08:05 -0700949 need_newline = 0;
Pierre Habouzitd7a38c52007-10-15 01:38:30 +0200950 if (*opts->help)
Nguyễn Thái Ngọc Duy54e6dc72012-05-06 21:23:51 +0700951 fprintf(outfile, "%s\n", _(opts->help));
Pierre Habouzitd7a38c52007-10-15 01:38:30 +0200952 continue;
953 }
Pierre Habouzitdd3bf0f2007-11-19 10:21:44 +0100954 if (!full && (opts->flags & PARSE_OPT_HIDDEN))
955 continue;
Pierre Habouzitd7a38c52007-10-15 01:38:30 +0200956
Brandon Caseya6304fa2017-09-24 21:08:05 -0700957 if (need_newline) {
958 fputc('\n', outfile);
959 need_newline = 0;
960 }
961
Giuseppe Scrivano9c7304e2010-05-17 17:34:41 +0200962 pos = fprintf(outfile, " ");
René Scharfecbb08c22012-02-28 20:06:09 +0100963 if (opts->short_name) {
René Scharfe51a99492009-05-07 21:45:42 +0200964 if (opts->flags & PARSE_OPT_NODASH)
Giuseppe Scrivano9c7304e2010-05-17 17:34:41 +0200965 pos += fprintf(outfile, "%c", opts->short_name);
René Scharfe51a99492009-05-07 21:45:42 +0200966 else
Giuseppe Scrivano9c7304e2010-05-17 17:34:41 +0200967 pos += fprintf(outfile, "-%c", opts->short_name);
René Scharfe51a99492009-05-07 21:45:42 +0200968 }
Pierre Habouzitd7a38c52007-10-15 01:38:30 +0200969 if (opts->long_name && opts->short_name)
Giuseppe Scrivano9c7304e2010-05-17 17:34:41 +0200970 pos += fprintf(outfile, ", ");
Pierre Habouzitd7a38c52007-10-15 01:38:30 +0200971 if (opts->long_name)
René Scharfecbb08c22012-02-28 20:06:09 +0100972 pos += fprintf(outfile, "--%s", opts->long_name);
René Scharfee0319ff2009-05-07 21:45:08 +0200973 if (opts->type == OPTION_NUMBER)
Jiang Xinc0821962013-02-09 14:31:09 +0800974 pos += utf8_fprintf(outfile, _("-NUM"));
Pierre Habouzitd7a38c52007-10-15 01:38:30 +0200975
Jonathan Niederb57c68a2010-12-01 17:31:36 -0600976 if ((opts->flags & PARSE_OPT_LITERAL_ARGHELP) ||
977 !(opts->flags & PARSE_OPT_NOARG))
Giuseppe Scrivano9c7304e2010-05-17 17:34:41 +0200978 pos += usage_argh(opts, outfile);
Pierre Habouzitd7a38c52007-10-15 01:38:30 +0200979
Alex Riesenf389c802007-10-14 00:10:51 +0200980 if (pos <= USAGE_OPTS_WIDTH)
981 pad = USAGE_OPTS_WIDTH - pos;
Pierre Habouzitd7a38c52007-10-15 01:38:30 +0200982 else {
Giuseppe Scrivano9c7304e2010-05-17 17:34:41 +0200983 fputc('\n', outfile);
Pierre Habouzitd7a38c52007-10-15 01:38:30 +0200984 pad = USAGE_OPTS_WIDTH;
985 }
Nguyễn Thái Ngọc Duy5c387422019-04-29 17:05:25 +0700986 if (opts->type == OPTION_ALIAS) {
987 fprintf(outfile, "%*s", pad + USAGE_GAP, "");
988 fprintf_ln(outfile, _("alias of --%s"),
989 (const char *)opts->value);
990 continue;
991 }
Nguyễn Thái Ngọc Duy54e6dc72012-05-06 21:23:51 +0700992 fprintf(outfile, "%*s%s\n", pad + USAGE_GAP, "", _(opts->help));
Pierre Habouzitd7a38c52007-10-15 01:38:30 +0200993 }
Giuseppe Scrivano9c7304e2010-05-17 17:34:41 +0200994 fputc('\n', outfile);
Alex Riesenf389c802007-10-14 00:10:51 +0200995
Thomas Rast47e9cd22010-06-12 14:57:39 +0200996 if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
997 fputs("EOF\n", outfile);
998
Pierre Habouzitee68b872008-06-23 22:28:04 +0200999 return PARSE_OPT_HELP;
Pierre Habouzitd7a38c52007-10-15 01:38:30 +02001000}
Pierre Habouzit0ce865b2007-10-14 11:05:12 +02001001
Stephen Boydc2e86ad2011-03-22 00:51:05 -07001002void NORETURN usage_with_options(const char * const *usagestr,
Pierre Habouzitff43ec32008-06-23 22:38:58 +02001003 const struct option *opts)
Pierre Habouzitdd3bf0f2007-11-19 10:21:44 +01001004{
Thomas Rast47e9cd22010-06-12 14:57:39 +02001005 usage_with_options_internal(NULL, usagestr, opts, 0, 1);
Pierre Habouzitff43ec32008-06-23 22:38:58 +02001006 exit(129);
Pierre Habouzitdd3bf0f2007-11-19 10:21:44 +01001007}
1008
Stephen Boydc2e86ad2011-03-22 00:51:05 -07001009void NORETURN usage_msg_opt(const char *msg,
Christian Couder451bb212009-02-02 06:12:58 +01001010 const char * const *usagestr,
1011 const struct option *options)
1012{
Jeff King87433262016-12-14 10:10:10 -05001013 fprintf(stderr, "fatal: %s\n\n", msg);
Christian Couder451bb212009-02-02 06:12:58 +01001014 usage_with_options(usagestr, options);
1015}
1016
Nguyễn Thái Ngọc Duy9440b832018-11-10 06:16:11 +01001017const char *optname(const struct option *opt, int flags)
Jeff Kinga469a102012-12-15 12:42:10 -05001018{
Nguyễn Thái Ngọc Duy9440b832018-11-10 06:16:11 +01001019 static struct strbuf sb = STRBUF_INIT;
1020
1021 strbuf_reset(&sb);
Jeff Kinga469a102012-12-15 12:42:10 -05001022 if (flags & OPT_SHORT)
Nguyễn Thái Ngọc Duy9440b832018-11-10 06:16:11 +01001023 strbuf_addf(&sb, "switch `%c'", opt->short_name);
1024 else if (flags & OPT_UNSET)
1025 strbuf_addf(&sb, "option `no-%s'", opt->long_name);
1026 else
1027 strbuf_addf(&sb, "option `%s'", opt->long_name);
1028
1029 return sb.buf;
Jeff Kinga469a102012-12-15 12:42:10 -05001030}