1#include "git-compat-util.h"
2#include "parse-options.h"
3#include "cache.h"
4#include "config.h"
5#include "commit.h"
6#include "color.h"
7#include "utf8.h"
8
9static int disallow_abbreviated_options;
10
11#define OPT_SHORT 1
12#define OPT_UNSET 2
13
14int optbug(const struct option *opt, const char *reason)
15{
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);
20 return error("BUG: option '%s' %s", opt->long_name, reason);
21 }
22 return error("BUG: switch '%c' %s", opt->short_name, reason);
23}
24
25static enum parse_opt_result get_arg(struct parse_opt_ctx_t *p,
26 const struct option *opt,
27 int flags, const char **arg)
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;
34 } else if (p->argc > 1) {
35 p->argc--;
36 *arg = *++p->argv;
37 } else
38 return error(_("%s requires a value"), optname(opt, flags));
39 return 0;
40}
41
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;
47 *file = prefix_filename(prefix, *file);
48}
49
50static enum parse_opt_result opt_command_mode_error(
51 const struct option *opt,
52 const struct option *all_opts,
53 int flags)
54{
55 const struct option *that;
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);
73 error(_("%s is incompatible with %s"),
74 optname(opt, flags), that_name.buf);
75 strbuf_release(&that_name);
76 return PARSE_OPT_ERROR;
77 }
78 return error(_("%s : incompatible with something else"),
79 optname(opt, flags));
80}
81
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)
86{
87 const char *s, *arg;
88 const int unset = flags & OPT_UNSET;
89 int err;
90
91 if (unset && p->opt)
92 return error(_("%s takes no value"), optname(opt, flags));
93 if (unset && (opt->flags & PARSE_OPT_NONEG))
94 return error(_("%s isn't available"), optname(opt, flags));
95 if (!(flags & OPT_SHORT) && p->opt && (opt->flags & PARSE_OPT_NOARG))
96 return error(_("%s takes no value"), optname(opt, flags));
97
98 switch (opt->type) {
99 case OPTION_LOWLEVEL_CALLBACK:
100 return opt->ll_callback(p, opt, NULL, unset);
101
102 case OPTION_BIT:
103 if (unset)
104 *(int *)opt->value &= ~opt->defval;
105 else
106 *(int *)opt->value |= opt->defval;
107 return 0;
108
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
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
123 case OPTION_COUNTUP:
124 if (*(int *)opt->value < 0)
125 *(int *)opt->value = 0;
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
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
143 case OPTION_STRING:
144 if (unset)
145 *(const char **)opt->value = NULL;
146 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
147 *(const char **)opt->value = (const char *)opt->defval;
148 else
149 return get_arg(p, opt, flags, (const char **)opt->value);
150 return 0;
151
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
165 case OPTION_CALLBACK:
166 {
167 const char *p_arg = NULL;
168 int p_unset;
169
170 if (unset)
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))
177 return -1;
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 }
187 case OPTION_INTEGER:
188 if (unset) {
189 *(int *)opt->value = 0;
190 return 0;
191 }
192 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
193 *(int *)opt->value = opt->defval;
194 return 0;
195 }
196 if (get_arg(p, opt, flags, &arg))
197 return -1;
198 *(int *)opt->value = strtol(arg, (char **)&s, 10);
199 if (*s)
200 return error(_("%s expects a numerical value"),
201 optname(opt, flags));
202 return 0;
203
204 case OPTION_MAGNITUDE:
205 if (unset) {
206 *(unsigned long *)opt->value = 0;
207 return 0;
208 }
209 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
210 *(unsigned long *)opt->value = opt->defval;
211 return 0;
212 }
213 if (get_arg(p, opt, flags, &arg))
214 return -1;
215 if (!git_parse_ulong(arg, opt->value))
216 return error(_("%s expects a non-negative integer value"
217 " with an optional k/m/g suffix"),
218 optname(opt, flags));
219 return 0;
220
221 default:
222 BUG("opt->type %d should not happen", opt->type);
223 }
224}
225
226static enum parse_opt_result parse_short_opt(struct parse_opt_ctx_t *p,
227 const struct option *options)
228{
229 const struct option *all_opts = options;
230 const struct option *numopt = NULL;
231
232 for (; options->type != OPTION_END; options++) {
233 if (options->short_name == *p->opt) {
234 p->opt = p->opt[1] ? p->opt + 1 : NULL;
235 return get_value(p, options, all_opts, OPT_SHORT);
236 }
237
238 /*
239 * Handle the numerical option later, explicit one-digit
240 * options take precedence over it.
241 */
242 if (options->type == OPTION_NUMBER)
243 numopt = options;
244 }
245 if (numopt && isdigit(*p->opt)) {
246 size_t len = 1;
247 char *arg;
248 int rc;
249
250 while (isdigit(p->opt[len]))
251 len++;
252 arg = xmemdupz(p->opt, len);
253 p->opt = p->opt[len] ? p->opt + len : NULL;
254 if (numopt->callback)
255 rc = (*numopt->callback)(numopt, arg, 0) ? (-1) : 0;
256 else
257 rc = (*numopt->ll_callback)(p, numopt, arg, 0);
258 free(arg);
259 return rc;
260 }
261 return PARSE_OPT_UNKNOWN;
262}
263
264static enum parse_opt_result parse_long_opt(
265 struct parse_opt_ctx_t *p, const char *arg,
266 const struct option *options)
267{
268 const struct option *all_opts = options;
269 const char *arg_end = strchrnul(arg, '=');
270 const struct option *abbrev_option = NULL, *ambiguous_option = NULL;
271 int abbrev_flags = 0, ambiguous_flags = 0;
272
273 for (; options->type != OPTION_END; options++) {
274 const char *rest, *long_name = options->long_name;
275 int flags = 0, opt_flags = 0;
276
277 if (!long_name)
278 continue;
279
280again:
281 if (!skip_prefix(arg, long_name, &rest))
282 rest = NULL;
283 if (options->type == OPTION_ARGUMENT) {
284 if (!rest)
285 continue;
286 if (*rest == '=')
287 return error(_("%s takes no value"),
288 optname(options, flags));
289 if (*rest)
290 continue;
291 p->out[p->cpidx++] = arg - 2;
292 return PARSE_OPT_DONE;
293 }
294 if (!rest) {
295 /* abbreviated? */
296 if (!(p->flags & PARSE_OPT_KEEP_UNKNOWN) &&
297 !strncmp(long_name, arg, arg_end - arg)) {
298is_abbreviated:
299 if (abbrev_option) {
300 /*
301 * If this is abbreviated, it is
302 * ambiguous. So when there is no
303 * exact match later, we need to
304 * error out.
305 */
306 ambiguous_option = abbrev_option;
307 ambiguous_flags = abbrev_flags;
308 }
309 if (!(flags & OPT_UNSET) && *arg_end)
310 p->opt = arg_end + 1;
311 abbrev_option = options;
312 abbrev_flags = flags ^ opt_flags;
313 continue;
314 }
315 /* negation allowed? */
316 if (options->flags & PARSE_OPT_NONEG)
317 continue;
318 /* negated and abbreviated very much? */
319 if (starts_with("no-", arg)) {
320 flags |= OPT_UNSET;
321 goto is_abbreviated;
322 }
323 /* negated? */
324 if (!starts_with(arg, "no-")) {
325 if (starts_with(long_name, "no-")) {
326 long_name += 3;
327 opt_flags |= OPT_UNSET;
328 goto again;
329 }
330 continue;
331 }
332 flags |= OPT_UNSET;
333 if (!skip_prefix(arg + 3, long_name, &rest)) {
334 /* abbreviated and negated? */
335 if (starts_with(long_name, arg + 3))
336 goto is_abbreviated;
337 else
338 continue;
339 }
340 }
341 if (*rest) {
342 if (*rest != '=')
343 continue;
344 p->opt = rest + 1;
345 }
346 return get_value(p, options, all_opts, flags ^ opt_flags);
347 }
348
349 if (disallow_abbreviated_options && (ambiguous_option || abbrev_option))
350 die("disallowed abbreviated or ambiguous option '%.*s'",
351 (int)(arg_end - arg), arg);
352
353 if (ambiguous_option) {
354 error(_("ambiguous option: %s "
355 "(could be --%s%s or --%s%s)"),
356 arg,
357 (ambiguous_flags & OPT_UNSET) ? "no-" : "",
358 ambiguous_option->long_name,
359 (abbrev_flags & OPT_UNSET) ? "no-" : "",
360 abbrev_option->long_name);
361 return PARSE_OPT_HELP;
362 }
363 if (abbrev_option)
364 return get_value(p, abbrev_option, all_opts, abbrev_flags);
365 return PARSE_OPT_UNKNOWN;
366}
367
368static int parse_nodash_opt(struct parse_opt_ctx_t *p, const char *arg,
369 const struct option *options)
370{
371 const struct option *all_opts = options;
372
373 for (; options->type != OPTION_END; options++) {
374 if (!(options->flags & PARSE_OPT_NODASH))
375 continue;
376 if (options->short_name == arg[0] && arg[1] == '\0')
377 return get_value(p, options, all_opts, OPT_SHORT);
378 }
379 return -2;
380}
381
382static void check_typos(const char *arg, const struct option *options)
383{
384 if (strlen(arg) < 3)
385 return;
386
387 if (starts_with(arg, "no-")) {
388 error(_("did you mean `--%s` (with two dashes ?)"), arg);
389 exit(129);
390 }
391
392 for (; options->type != OPTION_END; options++) {
393 if (!options->long_name)
394 continue;
395 if (starts_with(options->long_name, arg)) {
396 error(_("did you mean `--%s` (with two dashes ?)"), arg);
397 exit(129);
398 }
399 }
400}
401
402static void parse_options_check(const struct option *opts)
403{
404 int err = 0;
405 char short_opts[128];
406
407 memset(short_opts, '\0', sizeof(short_opts));
408 for (; opts->type != OPTION_END; opts++) {
409 if ((opts->flags & PARSE_OPT_LASTARG_DEFAULT) &&
410 (opts->flags & PARSE_OPT_OPTARG))
411 err |= optbug(opts, "uses incompatible flags "
412 "LASTARG_DEFAULT and OPTARG");
413 if (opts->short_name) {
414 if (0x7F <= opts->short_name)
415 err |= optbug(opts, "invalid short name");
416 else if (short_opts[opts->short_name]++)
417 err |= optbug(opts, "short name already used");
418 }
419 if (opts->flags & PARSE_OPT_NODASH &&
420 ((opts->flags & PARSE_OPT_OPTARG) ||
421 !(opts->flags & PARSE_OPT_NOARG) ||
422 !(opts->flags & PARSE_OPT_NONEG) ||
423 opts->long_name))
424 err |= optbug(opts, "uses feature "
425 "not supported for dashless options");
426 switch (opts->type) {
427 case OPTION_COUNTUP:
428 case OPTION_BIT:
429 case OPTION_NEGBIT:
430 case OPTION_SET_INT:
431 case OPTION_NUMBER:
432 if ((opts->flags & PARSE_OPT_OPTARG) ||
433 !(opts->flags & PARSE_OPT_NOARG))
434 err |= optbug(opts, "should not accept an argument");
435 break;
436 case OPTION_CALLBACK:
437 if (!opts->callback && !opts->ll_callback)
438 BUG("OPTION_CALLBACK needs one callback");
439 if (opts->callback && opts->ll_callback)
440 BUG("OPTION_CALLBACK can't have two callbacks");
441 break;
442 case OPTION_LOWLEVEL_CALLBACK:
443 if (!opts->ll_callback)
444 BUG("OPTION_LOWLEVEL_CALLBACK needs a callback");
445 if (opts->callback)
446 BUG("OPTION_LOWLEVEL_CALLBACK needs no high level callback");
447 break;
448 default:
449 ; /* ok. (usually accepts an argument) */
450 }
451 if (opts->argh &&
452 strcspn(opts->argh, " _") != strlen(opts->argh))
453 err |= optbug(opts, "multi-word argh should use dash to separate words");
454 }
455 if (err)
456 exit(128);
457}
458
459void parse_options_start(struct parse_opt_ctx_t *ctx,
460 int argc, const char **argv, const char *prefix,
461 const struct option *options, int flags)
462{
463 memset(ctx, 0, sizeof(*ctx));
464 ctx->argc = argc;
465 ctx->argv = argv;
466 if (!(flags & PARSE_OPT_ONE_SHOT)) {
467 ctx->argc--;
468 ctx->argv++;
469 }
470 ctx->total = ctx->argc;
471 ctx->out = argv;
472 ctx->prefix = prefix;
473 ctx->cpidx = ((flags & PARSE_OPT_KEEP_ARGV0) != 0);
474 ctx->flags = flags;
475 if ((flags & PARSE_OPT_KEEP_UNKNOWN) &&
476 (flags & PARSE_OPT_STOP_AT_NON_OPTION) &&
477 !(flags & PARSE_OPT_ONE_SHOT))
478 BUG("STOP_AT_NON_OPTION and KEEP_UNKNOWN don't go together");
479 if ((flags & PARSE_OPT_ONE_SHOT) &&
480 (flags & PARSE_OPT_KEEP_ARGV0))
481 BUG("Can't keep argv0 if you don't have it");
482 parse_options_check(options);
483}
484
485static void show_negated_gitcomp(const struct option *opts, int nr_noopts)
486{
487 int printed_dashdash = 0;
488
489 for (; opts->type != OPTION_END; opts++) {
490 int has_unset_form = 0;
491 const char *name;
492
493 if (!opts->long_name)
494 continue;
495 if (opts->flags & (PARSE_OPT_HIDDEN | PARSE_OPT_NOCOMPLETE))
496 continue;
497 if (opts->flags & PARSE_OPT_NONEG)
498 continue;
499
500 switch (opts->type) {
501 case OPTION_STRING:
502 case OPTION_FILENAME:
503 case OPTION_INTEGER:
504 case OPTION_MAGNITUDE:
505 case OPTION_CALLBACK:
506 case OPTION_BIT:
507 case OPTION_NEGBIT:
508 case OPTION_COUNTUP:
509 case OPTION_SET_INT:
510 has_unset_form = 1;
511 break;
512 default:
513 break;
514 }
515 if (!has_unset_form)
516 continue;
517
518 if (skip_prefix(opts->long_name, "no-", &name)) {
519 if (nr_noopts < 0)
520 printf(" --%s", name);
521 } else if (nr_noopts >= 0) {
522 if (nr_noopts && !printed_dashdash) {
523 printf(" --");
524 printed_dashdash = 1;
525 }
526 printf(" --no-%s", opts->long_name);
527 nr_noopts++;
528 }
529 }
530}
531
532static int show_gitcomp(struct parse_opt_ctx_t *ctx,
533 const struct option *opts)
534{
535 const struct option *original_opts = opts;
536 int nr_noopts = 0;
537
538 for (; opts->type != OPTION_END; opts++) {
539 const char *suffix = "";
540
541 if (!opts->long_name)
542 continue;
543 if (opts->flags & (PARSE_OPT_HIDDEN | PARSE_OPT_NOCOMPLETE))
544 continue;
545
546 switch (opts->type) {
547 case OPTION_GROUP:
548 continue;
549 case OPTION_STRING:
550 case OPTION_FILENAME:
551 case OPTION_INTEGER:
552 case OPTION_MAGNITUDE:
553 case OPTION_CALLBACK:
554 if (opts->flags & PARSE_OPT_NOARG)
555 break;
556 if (opts->flags & PARSE_OPT_OPTARG)
557 break;
558 if (opts->flags & PARSE_OPT_LASTARG_DEFAULT)
559 break;
560 suffix = "=";
561 break;
562 default:
563 break;
564 }
565 if (opts->flags & PARSE_OPT_COMP_ARG)
566 suffix = "=";
567 if (starts_with(opts->long_name, "no-"))
568 nr_noopts++;
569 printf(" --%s%s", opts->long_name, suffix);
570 }
571 show_negated_gitcomp(original_opts, -1);
572 show_negated_gitcomp(original_opts, nr_noopts);
573 fputc('\n', stdout);
574 return PARSE_OPT_COMPLETE;
575}
576
577static int usage_with_options_internal(struct parse_opt_ctx_t *,
578 const char * const *,
579 const struct option *, int, int);
580
581int parse_options_step(struct parse_opt_ctx_t *ctx,
582 const struct option *options,
583 const char * const usagestr[])
584{
585 int internal_help = !(ctx->flags & PARSE_OPT_NO_INTERNAL_HELP);
586
587 /* we must reset ->opt, unknown short option leave it dangling */
588 ctx->opt = NULL;
589
590 for (; ctx->argc; ctx->argc--, ctx->argv++) {
591 const char *arg = ctx->argv[0];
592
593 if (ctx->flags & PARSE_OPT_ONE_SHOT &&
594 ctx->argc != ctx->total)
595 break;
596
597 if (*arg != '-' || !arg[1]) {
598 if (parse_nodash_opt(ctx, arg, options) == 0)
599 continue;
600 if (ctx->flags & PARSE_OPT_STOP_AT_NON_OPTION)
601 return PARSE_OPT_NON_OPTION;
602 ctx->out[ctx->cpidx++] = ctx->argv[0];
603 continue;
604 }
605
606 /* lone -h asks for help */
607 if (internal_help && ctx->total == 1 && !strcmp(arg + 1, "h"))
608 goto show_usage;
609
610 /* lone --git-completion-helper is asked by git-completion.bash */
611 if (ctx->total == 1 && !strcmp(arg + 1, "-git-completion-helper"))
612 return show_gitcomp(ctx, options);
613
614 if (arg[1] != '-') {
615 ctx->opt = arg + 1;
616 switch (parse_short_opt(ctx, options)) {
617 case PARSE_OPT_ERROR:
618 return PARSE_OPT_ERROR;
619 case PARSE_OPT_UNKNOWN:
620 if (ctx->opt)
621 check_typos(arg + 1, options);
622 if (internal_help && *ctx->opt == 'h')
623 goto show_usage;
624 goto unknown;
625 case PARSE_OPT_NON_OPTION:
626 case PARSE_OPT_HELP:
627 case PARSE_OPT_COMPLETE:
628 BUG("parse_short_opt() cannot return these");
629 case PARSE_OPT_DONE:
630 break;
631 }
632 if (ctx->opt)
633 check_typos(arg + 1, options);
634 while (ctx->opt) {
635 switch (parse_short_opt(ctx, options)) {
636 case PARSE_OPT_ERROR:
637 return PARSE_OPT_ERROR;
638 case PARSE_OPT_UNKNOWN:
639 if (internal_help && *ctx->opt == 'h')
640 goto show_usage;
641
642 /* fake a short option thing to hide the fact that we may have
643 * started to parse aggregated stuff
644 *
645 * This is leaky, too bad.
646 */
647 ctx->argv[0] = xstrdup(ctx->opt - 1);
648 *(char *)ctx->argv[0] = '-';
649 goto unknown;
650 case PARSE_OPT_NON_OPTION:
651 case PARSE_OPT_COMPLETE:
652 case PARSE_OPT_HELP:
653 BUG("parse_short_opt() cannot return these");
654 case PARSE_OPT_DONE:
655 break;
656 }
657 }
658 continue;
659 }
660
661 if (!arg[2]) { /* "--" */
662 if (!(ctx->flags & PARSE_OPT_KEEP_DASHDASH)) {
663 ctx->argc--;
664 ctx->argv++;
665 }
666 break;
667 }
668
669 if (internal_help && !strcmp(arg + 2, "help-all"))
670 return usage_with_options_internal(ctx, usagestr, options, 1, 0);
671 if (internal_help && !strcmp(arg + 2, "help"))
672 goto show_usage;
673 switch (parse_long_opt(ctx, arg + 2, options)) {
674 case PARSE_OPT_ERROR:
675 return PARSE_OPT_ERROR;
676 case PARSE_OPT_UNKNOWN:
677 goto unknown;
678 case PARSE_OPT_HELP:
679 goto show_usage;
680 case PARSE_OPT_NON_OPTION:
681 case PARSE_OPT_COMPLETE:
682 BUG("parse_long_opt() cannot return these");
683 case PARSE_OPT_DONE:
684 break;
685 }
686 continue;
687unknown:
688 if (ctx->flags & PARSE_OPT_ONE_SHOT)
689 break;
690 if (!(ctx->flags & PARSE_OPT_KEEP_UNKNOWN))
691 return PARSE_OPT_UNKNOWN;
692 ctx->out[ctx->cpidx++] = ctx->argv[0];
693 ctx->opt = NULL;
694 }
695 return PARSE_OPT_DONE;
696
697 show_usage:
698 return usage_with_options_internal(ctx, usagestr, options, 0, 0);
699}
700
701int parse_options_end(struct parse_opt_ctx_t *ctx)
702{
703 if (ctx->flags & PARSE_OPT_ONE_SHOT)
704 return ctx->total - ctx->argc;
705
706 MOVE_ARRAY(ctx->out + ctx->cpidx, ctx->argv, ctx->argc);
707 ctx->out[ctx->cpidx + ctx->argc] = NULL;
708 return ctx->cpidx + ctx->argc;
709}
710
711int parse_options(int argc, const char **argv, const char *prefix,
712 const struct option *options, const char * const usagestr[],
713 int flags)
714{
715 struct parse_opt_ctx_t ctx;
716
717 disallow_abbreviated_options =
718 git_env_bool("GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS", 0);
719
720 parse_options_start(&ctx, argc, argv, prefix, options, flags);
721 switch (parse_options_step(&ctx, options, usagestr)) {
722 case PARSE_OPT_HELP:
723 case PARSE_OPT_ERROR:
724 exit(129);
725 case PARSE_OPT_COMPLETE:
726 exit(0);
727 case PARSE_OPT_NON_OPTION:
728 case PARSE_OPT_DONE:
729 break;
730 default: /* PARSE_OPT_UNKNOWN */
731 if (ctx.argv[0][1] == '-') {
732 error(_("unknown option `%s'"), ctx.argv[0] + 2);
733 } else if (isascii(*ctx.opt)) {
734 error(_("unknown switch `%c'"), *ctx.opt);
735 } else {
736 error(_("unknown non-ascii option in string: `%s'"),
737 ctx.argv[0]);
738 }
739 usage_with_options(usagestr, options);
740 }
741
742 precompose_argv(argc, argv);
743 return parse_options_end(&ctx);
744}
745
746static int usage_argh(const struct option *opts, FILE *outfile)
747{
748 const char *s;
749 int literal = (opts->flags & PARSE_OPT_LITERAL_ARGHELP) ||
750 !opts->argh || !!strpbrk(opts->argh, "()<>[]|");
751 if (opts->flags & PARSE_OPT_OPTARG)
752 if (opts->long_name)
753 s = literal ? "[=%s]" : "[=<%s>]";
754 else
755 s = literal ? "[%s]" : "[<%s>]";
756 else
757 s = literal ? " %s" : " <%s>";
758 return utf8_fprintf(outfile, s, opts->argh ? _(opts->argh) : _("..."));
759}
760
761#define USAGE_OPTS_WIDTH 24
762#define USAGE_GAP 2
763
764static int usage_with_options_internal(struct parse_opt_ctx_t *ctx,
765 const char * const *usagestr,
766 const struct option *opts, int full, int err)
767{
768 FILE *outfile = err ? stderr : stdout;
769 int need_newline;
770
771 if (!usagestr)
772 return PARSE_OPT_HELP;
773
774 if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
775 fprintf(outfile, "cat <<\\EOF\n");
776
777 fprintf_ln(outfile, _("usage: %s"), _(*usagestr++));
778 while (*usagestr && **usagestr)
779 /*
780 * TRANSLATORS: the colon here should align with the
781 * one in "usage: %s" translation.
782 */
783 fprintf_ln(outfile, _(" or: %s"), _(*usagestr++));
784 while (*usagestr) {
785 if (**usagestr)
786 fprintf_ln(outfile, _(" %s"), _(*usagestr));
787 else
788 fputc('\n', outfile);
789 usagestr++;
790 }
791
792 need_newline = 1;
793
794 for (; opts->type != OPTION_END; opts++) {
795 size_t pos;
796 int pad;
797
798 if (opts->type == OPTION_GROUP) {
799 fputc('\n', outfile);
800 need_newline = 0;
801 if (*opts->help)
802 fprintf(outfile, "%s\n", _(opts->help));
803 continue;
804 }
805 if (!full && (opts->flags & PARSE_OPT_HIDDEN))
806 continue;
807
808 if (need_newline) {
809 fputc('\n', outfile);
810 need_newline = 0;
811 }
812
813 pos = fprintf(outfile, " ");
814 if (opts->short_name) {
815 if (opts->flags & PARSE_OPT_NODASH)
816 pos += fprintf(outfile, "%c", opts->short_name);
817 else
818 pos += fprintf(outfile, "-%c", opts->short_name);
819 }
820 if (opts->long_name && opts->short_name)
821 pos += fprintf(outfile, ", ");
822 if (opts->long_name)
823 pos += fprintf(outfile, "--%s", opts->long_name);
824 if (opts->type == OPTION_NUMBER)
825 pos += utf8_fprintf(outfile, _("-NUM"));
826
827 if ((opts->flags & PARSE_OPT_LITERAL_ARGHELP) ||
828 !(opts->flags & PARSE_OPT_NOARG))
829 pos += usage_argh(opts, outfile);
830
831 if (pos <= USAGE_OPTS_WIDTH)
832 pad = USAGE_OPTS_WIDTH - pos;
833 else {
834 fputc('\n', outfile);
835 pad = USAGE_OPTS_WIDTH;
836 }
837 fprintf(outfile, "%*s%s\n", pad + USAGE_GAP, "", _(opts->help));
838 }
839 fputc('\n', outfile);
840
841 if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
842 fputs("EOF\n", outfile);
843
844 return PARSE_OPT_HELP;
845}
846
847void NORETURN usage_with_options(const char * const *usagestr,
848 const struct option *opts)
849{
850 usage_with_options_internal(NULL, usagestr, opts, 0, 1);
851 exit(129);
852}
853
854void NORETURN usage_msg_opt(const char *msg,
855 const char * const *usagestr,
856 const struct option *options)
857{
858 fprintf(stderr, "fatal: %s\n\n", msg);
859 usage_with_options(usagestr, options);
860}
861
862const char *optname(const struct option *opt, int flags)
863{
864 static struct strbuf sb = STRBUF_INIT;
865
866 strbuf_reset(&sb);
867 if (flags & OPT_SHORT)
868 strbuf_addf(&sb, "switch `%c'", opt->short_name);
869 else if (flags & OPT_UNSET)
870 strbuf_addf(&sb, "option `no-%s'", opt->long_name);
871 else
872 strbuf_addf(&sb, "option `%s'", opt->long_name);
873
874 return sb.buf;
875}