Merge branch 'cb/do-not-use-test-cmp-with-a'
[git/git.git] / parse-options.c
CommitLineData
4a59fd13
PH
1#include "git-compat-util.h"
2#include "parse-options.h"
26141b5b 3#include "cache.h"
b2141fc1 4#include "config.h"
269defdf 5#include "commit.h"
73e9da01 6#include "color.h"
c0821965 7#include "utf8.h"
4a59fd13 8
b02e7d5d
JS
9static int disallow_abbreviated_options;
10
4a59fd13
PH
11#define OPT_SHORT 1
12#define OPT_UNSET 2
13
1f275b7c 14int optbug(const struct option *opt, const char *reason)
1e5ce570 15{
af465af8
JH
16 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);
1e5ce570 20 return error("BUG: option '%s' %s", opt->long_name, reason);
af465af8 21 }
1e5ce570
JN
22 return error("BUG: switch '%c' %s", opt->short_name, reason);
23}
24
f41179f1
NTND
25static enum parse_opt_result get_arg(struct parse_opt_ctx_t *p,
26 const struct option *opt,
27 int flags, const char **arg)
1cc6985c
PH
28{
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;
d5d745f9 34 } else if (p->argc > 1) {
1cc6985c
PH
35 p->argc--;
36 *arg = *++p->argv;
37 } else
9440b831 38 return error(_("%s requires a value"), optname(opt, flags));
1cc6985c
PH
39 return 0;
40}
41
df217ed6
SB
42static void fix_filename(const char *prefix, const char **file)
43{
44 if (!file || !*file || !prefix || is_absolute_path(*file)
45 || !strcmp("-", *file))
46 return;
e4da43b1 47 *file = prefix_filename(prefix, *file);
df217ed6
SB
48}
49
f41179f1
NTND
50static enum parse_opt_result opt_command_mode_error(
51 const struct option *opt,
52 const struct option *all_opts,
53 int flags)
11588263
JH
54{
55 const struct option *that;
11588263
JH
56 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 ||
64 that->type != OPTION_CMDMODE ||
65 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);
9440b831
NTND
73 error(_("%s is incompatible with %s"),
74 optname(opt, flags), that_name.buf);
11588263 75 strbuf_release(&that_name);
f41179f1 76 return PARSE_OPT_ERROR;
11588263 77 }
9440b831
NTND
78 return error(_("%s : incompatible with something else"),
79 optname(opt, flags));
11588263
JH
80}
81
f41179f1
NTND
82static 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)
4a59fd13 86{
ffe659f9 87 const char *s, *arg;
db7244bd 88 const int unset = flags & OPT_UNSET;
df217ed6 89 int err;
4a59fd13 90
db7244bd 91 if (unset && p->opt)
9440b831 92 return error(_("%s takes no value"), optname(opt, flags));
db7244bd 93 if (unset && (opt->flags & PARSE_OPT_NONEG))
9440b831 94 return error(_("%s isn't available"), optname(opt, flags));
c1f4ec9e 95 if (!(flags & OPT_SHORT) && p->opt && (opt->flags & PARSE_OPT_NOARG))
9440b831 96 return error(_("%s takes no value"), optname(opt, flags));
db7244bd 97
db7244bd 98 switch (opt->type) {
b0b3a8b6 99 case OPTION_LOWLEVEL_CALLBACK:
3ebbe289 100 return opt->ll_callback(p, opt, NULL, unset);
b0b3a8b6 101
db7244bd
PH
102 case OPTION_BIT:
103 if (unset)
104 *(int *)opt->value &= ~opt->defval;
4a59fd13 105 else
db7244bd
PH
106 *(int *)opt->value |= opt->defval;
107 return 0;
108
2f4b97f9
RS
109 case OPTION_NEGBIT:
110 if (unset)
111 *(int *)opt->value |= opt->defval;
112 else
113 *(int *)opt->value &= ~opt->defval;
114 return 0;
115
f62470c6
NTND
116 case OPTION_BITOP:
117 if (unset)
118 BUG("BITOP can't have unset form");
119 *(int *)opt->value &= ~opt->extra;
120 *(int *)opt->value |= opt->defval;
121 return 0;
122
b04ba2bb 123 case OPTION_COUNTUP:
e0070e8b
PB
124 if (*(int *)opt->value < 0)
125 *(int *)opt->value = 0;
db7244bd
PH
126 *(int *)opt->value = unset ? 0 : *(int *)opt->value + 1;
127 return 0;
128
129 case OPTION_SET_INT:
130 *(int *)opt->value = unset ? 0 : opt->defval;
131 return 0;
132
11588263
JH
133 case OPTION_CMDMODE:
134 /*
135 * Giving the same mode option twice, although is unnecessary,
136 * is not a grave error, so let it pass.
137 */
138 if (*(int *)opt->value && *(int *)opt->value != opt->defval)
139 return opt_command_mode_error(opt, all_opts, flags);
140 *(int *)opt->value = opt->defval;
141 return 0;
142
4a59fd13 143 case OPTION_STRING:
1cc6985c 144 if (unset)
db7244bd 145 *(const char **)opt->value = NULL;
1cc6985c 146 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
ffe659f9 147 *(const char **)opt->value = (const char *)opt->defval;
1cc6985c
PH
148 else
149 return get_arg(p, opt, flags, (const char **)opt->value);
4a59fd13
PH
150 return 0;
151
df217ed6
SB
152 case OPTION_FILENAME:
153 err = 0;
154 if (unset)
155 *(const char **)opt->value = NULL;
156 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
157 *(const char **)opt->value = (const char *)opt->defval;
158 else
159 err = get_arg(p, opt, flags, (const char **)opt->value);
160
161 if (!err)
162 fix_filename(p->prefix, (const char **)opt->value);
163 return err;
164
ffe659f9 165 case OPTION_CALLBACK:
3ebbe289
NTND
166 {
167 const char *p_arg = NULL;
168 int p_unset;
169
db7244bd 170 if (unset)
3ebbe289
NTND
171 p_unset = 1;
172 else if (opt->flags & PARSE_OPT_NOARG)
173 p_unset = 0;
174 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
175 p_unset = 0;
176 else if (get_arg(p, opt, flags, &arg))
1cc6985c 177 return -1;
3ebbe289
NTND
178 else {
179 p_unset = 0;
180 p_arg = arg;
181 }
182 if (opt->callback)
183 return (*opt->callback)(opt, p_arg, p_unset) ? (-1) : 0;
184 else
185 return (*opt->ll_callback)(p, opt, p_arg, p_unset);
186 }
4a59fd13 187 case OPTION_INTEGER:
db7244bd 188 if (unset) {
4a59fd13
PH
189 *(int *)opt->value = 0;
190 return 0;
191 }
c43a2483 192 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
ffe659f9
PH
193 *(int *)opt->value = opt->defval;
194 return 0;
195 }
1cc6985c
PH
196 if (get_arg(p, opt, flags, &arg))
197 return -1;
f7e68a08
NTND
198 if (!*arg)
199 return error(_("%s expects a numerical value"),
200 optname(opt, flags));
1cc6985c 201 *(int *)opt->value = strtol(arg, (char **)&s, 10);
4a59fd13 202 if (*s)
9440b831
NTND
203 return error(_("%s expects a numerical value"),
204 optname(opt, flags));
4a59fd13
PH
205 return 0;
206
2a514ed8
CB
207 case OPTION_MAGNITUDE:
208 if (unset) {
209 *(unsigned long *)opt->value = 0;
210 return 0;
211 }
212 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
213 *(unsigned long *)opt->value = opt->defval;
214 return 0;
215 }
216 if (get_arg(p, opt, flags, &arg))
217 return -1;
218 if (!git_parse_ulong(arg, opt->value))
9440b831
NTND
219 return error(_("%s expects a non-negative integer value"
220 " with an optional k/m/g suffix"),
221 optname(opt, flags));
2a514ed8
CB
222 return 0;
223
4a59fd13 224 default:
48a5499e 225 BUG("opt->type %d should not happen", opt->type);
4a59fd13
PH
226 }
227}
228
f41179f1
NTND
229static enum parse_opt_result parse_short_opt(struct parse_opt_ctx_t *p,
230 const struct option *options)
4a59fd13 231{
11588263 232 const struct option *all_opts = options;
e0319ff5
RS
233 const struct option *numopt = NULL;
234
4a59fd13
PH
235 for (; options->type != OPTION_END; options++) {
236 if (options->short_name == *p->opt) {
237 p->opt = p->opt[1] ? p->opt + 1 : NULL;
11588263 238 return get_value(p, options, all_opts, OPT_SHORT);
4a59fd13 239 }
e0319ff5
RS
240
241 /*
242 * Handle the numerical option later, explicit one-digit
243 * options take precedence over it.
244 */
245 if (options->type == OPTION_NUMBER)
246 numopt = options;
247 }
248 if (numopt && isdigit(*p->opt)) {
249 size_t len = 1;
250 char *arg;
251 int rc;
252
253 while (isdigit(p->opt[len]))
254 len++;
255 arg = xmemdupz(p->opt, len);
256 p->opt = p->opt[len] ? p->opt + len : NULL;
3ebbe289
NTND
257 if (numopt->callback)
258 rc = (*numopt->callback)(numopt, arg, 0) ? (-1) : 0;
259 else
260 rc = (*numopt->ll_callback)(p, numopt, arg, 0);
e0319ff5
RS
261 free(arg);
262 return rc;
4a59fd13 263 }
f41179f1 264 return PARSE_OPT_UNKNOWN;
4a59fd13
PH
265}
266
5c387428
NTND
267static int has_string(const char *it, const char **array)
268{
269 while (*array)
270 if (!strcmp(it, *(array++)))
271 return 1;
272 return 0;
273}
274
275static int is_alias(struct parse_opt_ctx_t *ctx,
276 const struct option *one_opt,
277 const struct option *another_opt)
278{
279 const char **group;
280
281 if (!ctx->alias_groups)
282 return 0;
283
284 if (!one_opt->long_name || !another_opt->long_name)
285 return 0;
286
287 for (group = ctx->alias_groups; *group; group += 3) {
288 /* it and other are from the same family? */
289 if (has_string(one_opt->long_name, group) &&
290 has_string(another_opt->long_name, group))
291 return 1;
292 }
293 return 0;
294}
295
f41179f1
NTND
296static enum parse_opt_result parse_long_opt(
297 struct parse_opt_ctx_t *p, const char *arg,
298 const struct option *options)
4a59fd13 299{
11588263 300 const struct option *all_opts = options;
2c5495f7 301 const char *arg_end = strchrnul(arg, '=');
243e0614
JS
302 const struct option *abbrev_option = NULL, *ambiguous_option = NULL;
303 int abbrev_flags = 0, ambiguous_flags = 0;
7f275b91 304
4a59fd13 305 for (; options->type != OPTION_END; options++) {
0f1930c5
RS
306 const char *rest, *long_name = options->long_name;
307 int flags = 0, opt_flags = 0;
4a59fd13 308
0f1930c5 309 if (!long_name)
4a59fd13
PH
310 continue;
311
0f1930c5 312again:
cf4fff57
JK
313 if (!skip_prefix(arg, long_name, &rest))
314 rest = NULL;
580d5bff
PH
315 if (options->type == OPTION_ARGUMENT) {
316 if (!rest)
317 continue;
318 if (*rest == '=')
9440b831
NTND
319 return error(_("%s takes no value"),
320 optname(options, flags));
580d5bff
PH
321 if (*rest)
322 continue;
1a85b49b
JS
323 if (options->value)
324 *(int *)options->value = options->defval;
580d5bff 325 p->out[p->cpidx++] = arg - 2;
f41179f1 326 return PARSE_OPT_DONE;
580d5bff 327 }
4a59fd13 328 if (!rest) {
7f275b91 329 /* abbreviated? */
baa4adc6
NTND
330 if (!(p->flags & PARSE_OPT_KEEP_UNKNOWN) &&
331 !strncmp(long_name, arg, arg_end - arg)) {
7f275b91 332is_abbreviated:
5c387428
NTND
333 if (abbrev_option &&
334 !is_alias(p, abbrev_option, options)) {
243e0614
JS
335 /*
336 * If this is abbreviated, it is
337 * ambiguous. So when there is no
338 * exact match later, we need to
339 * error out.
340 */
341 ambiguous_option = abbrev_option;
342 ambiguous_flags = abbrev_flags;
343 }
7f275b91
JS
344 if (!(flags & OPT_UNSET) && *arg_end)
345 p->opt = arg_end + 1;
346 abbrev_option = options;
0f1930c5 347 abbrev_flags = flags ^ opt_flags;
7f275b91
JS
348 continue;
349 }
6bbfd1fa
AS
350 /* negation allowed? */
351 if (options->flags & PARSE_OPT_NONEG)
352 continue;
7f275b91 353 /* negated and abbreviated very much? */
59556548 354 if (starts_with("no-", arg)) {
7f275b91
JS
355 flags |= OPT_UNSET;
356 goto is_abbreviated;
357 }
358 /* negated? */
59556548
CC
359 if (!starts_with(arg, "no-")) {
360 if (starts_with(long_name, "no-")) {
0f1930c5
RS
361 long_name += 3;
362 opt_flags |= OPT_UNSET;
363 goto again;
364 }
4a59fd13 365 continue;
0f1930c5 366 }
4a59fd13 367 flags |= OPT_UNSET;
cf4fff57
JK
368 if (!skip_prefix(arg + 3, long_name, &rest)) {
369 /* abbreviated and negated? */
370 if (starts_with(long_name, arg + 3))
371 goto is_abbreviated;
372 else
373 continue;
374 }
4a59fd13
PH
375 }
376 if (*rest) {
377 if (*rest != '=')
378 continue;
379 p->opt = rest + 1;
380 }
11588263 381 return get_value(p, options, all_opts, flags ^ opt_flags);
4a59fd13 382 }
243e0614 383
b02e7d5d
JS
384 if (disallow_abbreviated_options && (ambiguous_option || abbrev_option))
385 die("disallowed abbreviated or ambiguous option '%.*s'",
386 (int)(arg_end - arg), arg);
387
3bb0923f 388 if (ambiguous_option) {
89003426
NTND
389 error(_("ambiguous option: %s "
390 "(could be --%s%s or --%s%s)"),
243e0614
JS
391 arg,
392 (ambiguous_flags & OPT_UNSET) ? "no-" : "",
393 ambiguous_option->long_name,
394 (abbrev_flags & OPT_UNSET) ? "no-" : "",
395 abbrev_option->long_name);
f41179f1 396 return PARSE_OPT_HELP;
3bb0923f 397 }
7f275b91 398 if (abbrev_option)
11588263 399 return get_value(p, abbrev_option, all_opts, abbrev_flags);
f41179f1 400 return PARSE_OPT_UNKNOWN;
4a59fd13
PH
401}
402
51a9949e
RS
403static int parse_nodash_opt(struct parse_opt_ctx_t *p, const char *arg,
404 const struct option *options)
405{
11588263
JH
406 const struct option *all_opts = options;
407
51a9949e
RS
408 for (; options->type != OPTION_END; options++) {
409 if (!(options->flags & PARSE_OPT_NODASH))
410 continue;
51a9949e 411 if (options->short_name == arg[0] && arg[1] == '\0')
11588263 412 return get_value(p, options, all_opts, OPT_SHORT);
51a9949e
RS
413 }
414 return -2;
415}
416
1121a878 417static void check_typos(const char *arg, const struct option *options)
3a9f0f41
PH
418{
419 if (strlen(arg) < 3)
420 return;
421
59556548 422 if (starts_with(arg, "no-")) {
89003426 423 error(_("did you mean `--%s` (with two dashes ?)"), arg);
3a9f0f41
PH
424 exit(129);
425 }
426
427 for (; options->type != OPTION_END; options++) {
428 if (!options->long_name)
429 continue;
59556548 430 if (starts_with(options->long_name, arg)) {
89003426 431 error(_("did you mean `--%s` (with two dashes ?)"), arg);
3a9f0f41
PH
432 exit(129);
433 }
434 }
435}
436
cb9d398c
PH
437static void parse_options_check(const struct option *opts)
438{
439 int err = 0;
af465af8 440 char short_opts[128];
cb9d398c 441
af465af8 442 memset(short_opts, '\0', sizeof(short_opts));
cb9d398c
PH
443 for (; opts->type != OPTION_END; opts++) {
444 if ((opts->flags & PARSE_OPT_LASTARG_DEFAULT) &&
1e5ce570
JN
445 (opts->flags & PARSE_OPT_OPTARG))
446 err |= optbug(opts, "uses incompatible flags "
447 "LASTARG_DEFAULT and OPTARG");
af465af8
JH
448 if (opts->short_name) {
449 if (0x7F <= opts->short_name)
450 err |= optbug(opts, "invalid short name");
451 else if (short_opts[opts->short_name]++)
452 err |= optbug(opts, "short name already used");
453 }
a02dd4ff
JN
454 if (opts->flags & PARSE_OPT_NODASH &&
455 ((opts->flags & PARSE_OPT_OPTARG) ||
456 !(opts->flags & PARSE_OPT_NOARG) ||
457 !(opts->flags & PARSE_OPT_NONEG) ||
458 opts->long_name))
459 err |= optbug(opts, "uses feature "
460 "not supported for dashless options");
5c400ed2 461 switch (opts->type) {
b04ba2bb 462 case OPTION_COUNTUP:
5c400ed2
JN
463 case OPTION_BIT:
464 case OPTION_NEGBIT:
465 case OPTION_SET_INT:
5c400ed2
JN
466 case OPTION_NUMBER:
467 if ((opts->flags & PARSE_OPT_OPTARG) ||
468 !(opts->flags & PARSE_OPT_NOARG))
469 err |= optbug(opts, "should not accept an argument");
bf3ff338
NTND
470 break;
471 case OPTION_CALLBACK:
3ebbe289
NTND
472 if (!opts->callback && !opts->ll_callback)
473 BUG("OPTION_CALLBACK needs one callback");
474 if (opts->callback && opts->ll_callback)
475 BUG("OPTION_CALLBACK can't have two callbacks");
bf3ff338
NTND
476 break;
477 case OPTION_LOWLEVEL_CALLBACK:
478 if (!opts->ll_callback)
479 BUG("OPTION_LOWLEVEL_CALLBACK needs a callback");
480 if (opts->callback)
481 BUG("OPTION_LOWLEVEL_CALLBACK needs no high level callback");
482 break;
5c387428
NTND
483 case OPTION_ALIAS:
484 BUG("OPT_ALIAS() should not remain at this point. "
485 "Are you using parse_options_step() directly?\n"
486 "That case is not supported yet.");
5c400ed2
JN
487 default:
488 ; /* ok. (usually accepts an argument) */
489 }
b6c2a0d4
JH
490 if (opts->argh &&
491 strcspn(opts->argh, " _") != strlen(opts->argh))
492 err |= optbug(opts, "multi-word argh should use dash to separate words");
cb9d398c 493 }
cb9d398c 494 if (err)
1e5ce570 495 exit(128);
cb9d398c
PH
496}
497
5c387428
NTND
498static void parse_options_start_1(struct parse_opt_ctx_t *ctx,
499 int argc, const char **argv, const char *prefix,
500 const struct option *options, int flags)
7e7bbcb4 501{
202fbb33
NTND
502 ctx->argc = argc;
503 ctx->argv = argv;
504 if (!(flags & PARSE_OPT_ONE_SHOT)) {
505 ctx->argc--;
506 ctx->argv++;
507 }
508 ctx->total = ctx->argc;
509 ctx->out = argv;
37782920 510 ctx->prefix = prefix;
a32a4eaa 511 ctx->cpidx = ((flags & PARSE_OPT_KEEP_ARGV0) != 0);
7e7bbcb4 512 ctx->flags = flags;
0d260f9a 513 if ((flags & PARSE_OPT_KEEP_UNKNOWN) &&
202fbb33
NTND
514 (flags & PARSE_OPT_STOP_AT_NON_OPTION) &&
515 !(flags & PARSE_OPT_ONE_SHOT))
48a5499e 516 BUG("STOP_AT_NON_OPTION and KEEP_UNKNOWN don't go together");
202fbb33
NTND
517 if ((flags & PARSE_OPT_ONE_SHOT) &&
518 (flags & PARSE_OPT_KEEP_ARGV0))
519 BUG("Can't keep argv0 if you don't have it");
9ca1169f 520 parse_options_check(options);
7e7bbcb4
PH
521}
522
5c387428
NTND
523void parse_options_start(struct parse_opt_ctx_t *ctx,
524 int argc, const char **argv, const char *prefix,
525 const struct option *options, int flags)
526{
527 memset(ctx, 0, sizeof(*ctx));
528 parse_options_start_1(ctx, argc, argv, prefix, options, flags);
529}
530
b221b5ab
NTND
531static void show_negated_gitcomp(const struct option *opts, int nr_noopts)
532{
533 int printed_dashdash = 0;
534
535 for (; opts->type != OPTION_END; opts++) {
536 int has_unset_form = 0;
537 const char *name;
538
539 if (!opts->long_name)
540 continue;
541 if (opts->flags & (PARSE_OPT_HIDDEN | PARSE_OPT_NOCOMPLETE))
542 continue;
543 if (opts->flags & PARSE_OPT_NONEG)
544 continue;
545
546 switch (opts->type) {
547 case OPTION_STRING:
548 case OPTION_FILENAME:
549 case OPTION_INTEGER:
550 case OPTION_MAGNITUDE:
551 case OPTION_CALLBACK:
552 case OPTION_BIT:
553 case OPTION_NEGBIT:
554 case OPTION_COUNTUP:
555 case OPTION_SET_INT:
556 has_unset_form = 1;
557 break;
558 default:
559 break;
560 }
561 if (!has_unset_form)
562 continue;
563
564 if (skip_prefix(opts->long_name, "no-", &name)) {
565 if (nr_noopts < 0)
566 printf(" --%s", name);
567 } else if (nr_noopts >= 0) {
568 if (nr_noopts && !printed_dashdash) {
569 printf(" --");
570 printed_dashdash = 1;
571 }
572 printf(" --no-%s", opts->long_name);
573 nr_noopts++;
574 }
575 }
576}
577
5205749d 578static int show_gitcomp(const struct option *opts)
b9d7f4b4 579{
b221b5ab
NTND
580 const struct option *original_opts = opts;
581 int nr_noopts = 0;
582
b9d7f4b4
NTND
583 for (; opts->type != OPTION_END; opts++) {
584 const char *suffix = "";
585
586 if (!opts->long_name)
587 continue;
588 if (opts->flags & (PARSE_OPT_HIDDEN | PARSE_OPT_NOCOMPLETE))
589 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 }
ebc4a04e
NTND
610 if (opts->flags & PARSE_OPT_COMP_ARG)
611 suffix = "=";
b221b5ab
NTND
612 if (starts_with(opts->long_name, "no-"))
613 nr_noopts++;
b9d7f4b4
NTND
614 printf(" --%s%s", opts->long_name, suffix);
615 }
b221b5ab
NTND
616 show_negated_gitcomp(original_opts, -1);
617 show_negated_gitcomp(original_opts, nr_noopts);
b9d7f4b4 618 fputc('\n', stdout);
a92ec7ef 619 return PARSE_OPT_COMPLETE;
b9d7f4b4
NTND
620}
621
5c387428
NTND
622/*
623 * Scan and may produce a new option[] array, which should be used
624 * instead of the original 'options'.
625 *
626 * Right now this is only used to preprocess and substitue
627 * OPTION_ALIAS.
628 */
629static struct option *preprocess_options(struct parse_opt_ctx_t *ctx,
630 const struct option *options)
631{
632 struct option *newopt;
633 int i, nr, alias;
634 int nr_aliases = 0;
635
636 for (nr = 0; options[nr].type != OPTION_END; nr++) {
637 if (options[nr].type == OPTION_ALIAS)
638 nr_aliases++;
639 }
640
641 if (!nr_aliases)
642 return NULL;
643
644 ALLOC_ARRAY(newopt, nr + 1);
645 COPY_ARRAY(newopt, options, nr + 1);
646
647 /* each alias has two string pointers and NULL */
648 CALLOC_ARRAY(ctx->alias_groups, 3 * (nr_aliases + 1));
649
650 for (alias = 0, i = 0; i < nr; i++) {
651 int short_name;
652 const char *long_name;
653 const char *source;
654 int j;
655
656 if (newopt[i].type != OPTION_ALIAS)
657 continue;
658
659 short_name = newopt[i].short_name;
660 long_name = newopt[i].long_name;
661 source = newopt[i].value;
662
663 if (!long_name)
664 BUG("An alias must have long option name");
665
666 for (j = 0; j < nr; j++) {
667 const char *name = options[j].long_name;
668
669 if (!name || strcmp(name, source))
670 continue;
671
672 if (options[j].type == OPTION_ALIAS)
673 BUG("No please. Nested aliases are not supported.");
674
675 /*
676 * NEEDSWORK: this is a bit inconsistent because
677 * usage_with_options() on the original options[] will print
678 * help string as "alias of %s" but "git cmd -h" will
679 * print the original help string.
680 */
681 memcpy(newopt + i, options + j, sizeof(*newopt));
682 newopt[i].short_name = short_name;
683 newopt[i].long_name = long_name;
684 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
47e9cd28
TR
699static int usage_with_options_internal(struct parse_opt_ctx_t *,
700 const char * const *,
9c7304e3 701 const struct option *, int, int);
dd3bf0f4 702
ff43ec3e
PH
703int parse_options_step(struct parse_opt_ctx_t *ctx,
704 const struct option *options,
705 const char * const usagestr[])
4a59fd13 706{
b92891f9
RS
707 int internal_help = !(ctx->flags & PARSE_OPT_NO_INTERNAL_HELP);
708
26141b5b
PH
709 /* we must reset ->opt, unknown short option leave it dangling */
710 ctx->opt = NULL;
711
ff43ec3e
PH
712 for (; ctx->argc; ctx->argc--, ctx->argv++) {
713 const char *arg = ctx->argv[0];
4a59fd13 714
202fbb33
NTND
715 if (ctx->flags & PARSE_OPT_ONE_SHOT &&
716 ctx->argc != ctx->total)
717 break;
718
4a59fd13 719 if (*arg != '-' || !arg[1]) {
51a9949e
RS
720 if (parse_nodash_opt(ctx, arg, options) == 0)
721 continue;
ff43ec3e 722 if (ctx->flags & PARSE_OPT_STOP_AT_NON_OPTION)
979240fe 723 return PARSE_OPT_NON_OPTION;
ff43ec3e 724 ctx->out[ctx->cpidx++] = ctx->argv[0];
4a59fd13
PH
725 continue;
726 }
727
5ad0d3d5
RS
728 /* lone -h asks for help */
729 if (internal_help && ctx->total == 1 && !strcmp(arg + 1, "h"))
730 goto show_usage;
731
b9d7f4b4
NTND
732 /* lone --git-completion-helper is asked by git-completion.bash */
733 if (ctx->total == 1 && !strcmp(arg + 1, "-git-completion-helper"))
5205749d 734 return show_gitcomp(options);
b9d7f4b4 735
4a59fd13 736 if (arg[1] != '-') {
ff43ec3e 737 ctx->opt = arg + 1;
07fe54db 738 switch (parse_short_opt(ctx, options)) {
f41179f1 739 case PARSE_OPT_ERROR:
3bb0923f 740 return PARSE_OPT_ERROR;
f41179f1 741 case PARSE_OPT_UNKNOWN:
38916c5b
RS
742 if (ctx->opt)
743 check_typos(arg + 1, options);
5ad0d3d5
RS
744 if (internal_help && *ctx->opt == 'h')
745 goto show_usage;
b5ce3a54 746 goto unknown;
f41179f1
NTND
747 case PARSE_OPT_NON_OPTION:
748 case PARSE_OPT_HELP:
749 case PARSE_OPT_COMPLETE:
750 BUG("parse_short_opt() cannot return these");
751 case PARSE_OPT_DONE:
752 break;
07fe54db 753 }
ff43ec3e 754 if (ctx->opt)
3a9f0f41 755 check_typos(arg + 1, options);
ff43ec3e 756 while (ctx->opt) {
07fe54db 757 switch (parse_short_opt(ctx, options)) {
f41179f1 758 case PARSE_OPT_ERROR:
3bb0923f 759 return PARSE_OPT_ERROR;
f41179f1 760 case PARSE_OPT_UNKNOWN:
5ad0d3d5
RS
761 if (internal_help && *ctx->opt == 'h')
762 goto show_usage;
763
26141b5b
PH
764 /* fake a short option thing to hide the fact that we may have
765 * started to parse aggregated stuff
766 *
767 * This is leaky, too bad.
768 */
769 ctx->argv[0] = xstrdup(ctx->opt - 1);
770 *(char *)ctx->argv[0] = '-';
b5ce3a54 771 goto unknown;
f41179f1
NTND
772 case PARSE_OPT_NON_OPTION:
773 case PARSE_OPT_COMPLETE:
774 case PARSE_OPT_HELP:
775 BUG("parse_short_opt() cannot return these");
776 case PARSE_OPT_DONE:
777 break;
07fe54db 778 }
3a9f0f41 779 }
4a59fd13
PH
780 continue;
781 }
782
51b4594b
JK
783 if (!arg[2] /* "--" */ ||
784 !strcmp(arg + 2, "end-of-options")) {
ff43ec3e
PH
785 if (!(ctx->flags & PARSE_OPT_KEEP_DASHDASH)) {
786 ctx->argc--;
787 ctx->argv++;
4a59fd13
PH
788 }
789 break;
790 }
791
b92891f9 792 if (internal_help && !strcmp(arg + 2, "help-all"))
47e9cd28 793 return usage_with_options_internal(ctx, usagestr, options, 1, 0);
b92891f9 794 if (internal_help && !strcmp(arg + 2, "help"))
ac20ff6d 795 goto show_usage;
07fe54db 796 switch (parse_long_opt(ctx, arg + 2, options)) {
f41179f1 797 case PARSE_OPT_ERROR:
3bb0923f 798 return PARSE_OPT_ERROR;
f41179f1 799 case PARSE_OPT_UNKNOWN:
b5ce3a54 800 goto unknown;
f41179f1 801 case PARSE_OPT_HELP:
3bb0923f 802 goto show_usage;
f41179f1
NTND
803 case PARSE_OPT_NON_OPTION:
804 case PARSE_OPT_COMPLETE:
805 BUG("parse_long_opt() cannot return these");
806 case PARSE_OPT_DONE:
807 break;
07fe54db 808 }
b5ce3a54
RS
809 continue;
810unknown:
202fbb33
NTND
811 if (ctx->flags & PARSE_OPT_ONE_SHOT)
812 break;
b5ce3a54
RS
813 if (!(ctx->flags & PARSE_OPT_KEEP_UNKNOWN))
814 return PARSE_OPT_UNKNOWN;
815 ctx->out[ctx->cpidx++] = ctx->argv[0];
816 ctx->opt = NULL;
ff43ec3e
PH
817 }
818 return PARSE_OPT_DONE;
ac20ff6d 819
ac20ff6d 820 show_usage:
3bb0923f 821 return usage_with_options_internal(ctx, usagestr, options, 0, 0);
ff43ec3e
PH
822}
823
824int parse_options_end(struct parse_opt_ctx_t *ctx)
825{
202fbb33
NTND
826 if (ctx->flags & PARSE_OPT_ONE_SHOT)
827 return ctx->total - ctx->argc;
828
f919ffeb 829 MOVE_ARRAY(ctx->out + ctx->cpidx, ctx->argv, ctx->argc);
ff43ec3e
PH
830 ctx->out[ctx->cpidx + ctx->argc] = NULL;
831 return ctx->cpidx + ctx->argc;
832}
833
37782920
SB
834int parse_options(int argc, const char **argv, const char *prefix,
835 const struct option *options, const char * const usagestr[],
836 int flags)
ff43ec3e
PH
837{
838 struct parse_opt_ctx_t ctx;
5c387428 839 struct option *real_options;
ff43ec3e 840
b02e7d5d
JS
841 disallow_abbreviated_options =
842 git_env_bool("GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS", 0);
843
5c387428
NTND
844 memset(&ctx, 0, sizeof(ctx));
845 real_options = preprocess_options(&ctx, options);
846 if (real_options)
847 options = real_options;
848 parse_options_start_1(&ctx, argc, argv, prefix, options, flags);
ff43ec3e
PH
849 switch (parse_options_step(&ctx, options, usagestr)) {
850 case PARSE_OPT_HELP:
3bb0923f 851 case PARSE_OPT_ERROR:
ff43ec3e 852 exit(129);
a92ec7ef
NTND
853 case PARSE_OPT_COMPLETE:
854 exit(0);
979240fe 855 case PARSE_OPT_NON_OPTION:
ff43ec3e
PH
856 case PARSE_OPT_DONE:
857 break;
858 default: /* PARSE_OPT_UNKNOWN */
07fe54db 859 if (ctx.argv[0][1] == '-') {
89003426 860 error(_("unknown option `%s'"), ctx.argv[0] + 2);
b141a478 861 } else if (isascii(*ctx.opt)) {
89003426 862 error(_("unknown switch `%c'"), *ctx.opt);
b141a478 863 } else {
89003426 864 error(_("unknown non-ascii option in string: `%s'"),
b141a478 865 ctx.argv[0]);
07fe54db
PH
866 }
867 usage_with_options(usagestr, options);
4a59fd13
PH
868 }
869
76759c7d 870 precompose_argv(argc, argv);
5c387428
NTND
871 free(real_options);
872 free(ctx.alias_groups);
7e7bbcb4 873 return parse_options_end(&ctx);
4a59fd13 874}
d7a38c54 875
9c7304e3 876static int usage_argh(const struct option *opts, FILE *outfile)
29f25d49
SB
877{
878 const char *s;
5f0df44c
RS
879 int literal = (opts->flags & PARSE_OPT_LITERAL_ARGHELP) ||
880 !opts->argh || !!strpbrk(opts->argh, "()<>[]|");
29f25d49
SB
881 if (opts->flags & PARSE_OPT_OPTARG)
882 if (opts->long_name)
883 s = literal ? "[=%s]" : "[=<%s>]";
884 else
885 s = literal ? "[%s]" : "[<%s>]";
886 else
887 s = literal ? " %s" : " <%s>";
c0821965 888 return utf8_fprintf(outfile, s, opts->argh ? _(opts->argh) : _("..."));
29f25d49
SB
889}
890
d7a38c54
PH
891#define USAGE_OPTS_WIDTH 24
892#define USAGE_GAP 2
893
47e9cd28
TR
894static int usage_with_options_internal(struct parse_opt_ctx_t *ctx,
895 const char * const *usagestr,
896 const struct option *opts, int full, int err)
d7a38c54 897{
9c7304e3 898 FILE *outfile = err ? stderr : stdout;
a6304fa4 899 int need_newline;
9c7304e3 900
49b61802
RS
901 if (!usagestr)
902 return PARSE_OPT_HELP;
903
47e9cd28
TR
904 if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
905 fprintf(outfile, "cat <<\\EOF\n");
906
54e6dc7d 907 fprintf_ln(outfile, _("usage: %s"), _(*usagestr++));
f389c808 908 while (*usagestr && **usagestr)
66f5f6dc
ÆAB
909 /*
910 * TRANSLATORS: the colon here should align with the
911 * one in "usage: %s" translation.
912 */
54e6dc7d 913 fprintf_ln(outfile, _(" or: %s"), _(*usagestr++));
44d86e91 914 while (*usagestr) {
54e6dc7d
NTND
915 if (**usagestr)
916 fprintf_ln(outfile, _(" %s"), _(*usagestr));
917 else
1a9bf1e1 918 fputc('\n', outfile);
44d86e91
JK
919 usagestr++;
920 }
d7a38c54 921
a6304fa4 922 need_newline = 1;
d7a38c54
PH
923
924 for (; opts->type != OPTION_END; opts++) {
925 size_t pos;
926 int pad;
927
928 if (opts->type == OPTION_GROUP) {
9c7304e3 929 fputc('\n', outfile);
a6304fa4 930 need_newline = 0;
d7a38c54 931 if (*opts->help)
54e6dc7d 932 fprintf(outfile, "%s\n", _(opts->help));
d7a38c54
PH
933 continue;
934 }
dd3bf0f4
PH
935 if (!full && (opts->flags & PARSE_OPT_HIDDEN))
936 continue;
d7a38c54 937
a6304fa4
BC
938 if (need_newline) {
939 fputc('\n', outfile);
940 need_newline = 0;
941 }
942
9c7304e3 943 pos = fprintf(outfile, " ");
cbb08c2e 944 if (opts->short_name) {
51a9949e 945 if (opts->flags & PARSE_OPT_NODASH)
9c7304e3 946 pos += fprintf(outfile, "%c", opts->short_name);
51a9949e 947 else
9c7304e3 948 pos += fprintf(outfile, "-%c", opts->short_name);
51a9949e 949 }
d7a38c54 950 if (opts->long_name && opts->short_name)
9c7304e3 951 pos += fprintf(outfile, ", ");
d7a38c54 952 if (opts->long_name)
cbb08c2e 953 pos += fprintf(outfile, "--%s", opts->long_name);
e0319ff5 954 if (opts->type == OPTION_NUMBER)
c0821965 955 pos += utf8_fprintf(outfile, _("-NUM"));
d7a38c54 956
b57c68a6
JN
957 if ((opts->flags & PARSE_OPT_LITERAL_ARGHELP) ||
958 !(opts->flags & PARSE_OPT_NOARG))
9c7304e3 959 pos += usage_argh(opts, outfile);
d7a38c54 960
f389c808
AR
961 if (pos <= USAGE_OPTS_WIDTH)
962 pad = USAGE_OPTS_WIDTH - pos;
d7a38c54 963 else {
9c7304e3 964 fputc('\n', outfile);
d7a38c54
PH
965 pad = USAGE_OPTS_WIDTH;
966 }
5c387428
NTND
967 if (opts->type == OPTION_ALIAS) {
968 fprintf(outfile, "%*s", pad + USAGE_GAP, "");
969 fprintf_ln(outfile, _("alias of --%s"),
970 (const char *)opts->value);
971 continue;
972 }
54e6dc7d 973 fprintf(outfile, "%*s%s\n", pad + USAGE_GAP, "", _(opts->help));
d7a38c54 974 }
9c7304e3 975 fputc('\n', outfile);
f389c808 976
47e9cd28
TR
977 if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
978 fputs("EOF\n", outfile);
979
ee68b87a 980 return PARSE_OPT_HELP;
d7a38c54 981}
0ce865b1 982
c2e86add 983void NORETURN usage_with_options(const char * const *usagestr,
ff43ec3e 984 const struct option *opts)
dd3bf0f4 985{
47e9cd28 986 usage_with_options_internal(NULL, usagestr, opts, 0, 1);
ff43ec3e 987 exit(129);
dd3bf0f4
PH
988}
989
c2e86add 990void NORETURN usage_msg_opt(const char *msg,
451bb210
CC
991 const char * const *usagestr,
992 const struct option *options)
993{
87433261 994 fprintf(stderr, "fatal: %s\n\n", msg);
451bb210
CC
995 usage_with_options(usagestr, options);
996}
997
9440b831 998const char *optname(const struct option *opt, int flags)
a469a101 999{
9440b831
NTND
1000 static struct strbuf sb = STRBUF_INIT;
1001
1002 strbuf_reset(&sb);
a469a101 1003 if (flags & OPT_SHORT)
9440b831
NTND
1004 strbuf_addf(&sb, "switch `%c'", opt->short_name);
1005 else if (flags & OPT_UNSET)
1006 strbuf_addf(&sb, "option `no-%s'", opt->long_name);
1007 else
1008 strbuf_addf(&sb, "option `%s'", opt->long_name);
1009
1010 return sb.buf;
a469a101 1011}