parse-options: introduce OPT_IPVERSION()
[alt-git.git] / parse-options.c
blobf8a155ee13b9599e2de3f973d9f9744c9c045893
1 #include "git-compat-util.h"
2 #include "parse-options.h"
3 #include "abspath.h"
4 #include "config.h"
5 #include "commit.h"
6 #include "color.h"
7 #include "gettext.h"
8 #include "strbuf.h"
9 #include "utf8.h"
11 static int disallow_abbreviated_options;
13 enum opt_parsed {
14 OPT_LONG = 0,
15 OPT_SHORT = 1<<0,
16 OPT_UNSET = 1<<1,
19 static void optbug(const struct option *opt, const char *reason)
21 if (opt->long_name && opt->short_name)
22 bug("switch '%c' (--%s) %s", opt->short_name,
23 opt->long_name, reason);
24 else if (opt->long_name)
25 bug("option '%s' %s", opt->long_name, reason);
26 else
27 bug("switch '%c' %s", opt->short_name, reason);
30 static const char *optname(const struct option *opt, enum opt_parsed flags)
32 static struct strbuf sb = STRBUF_INIT;
34 strbuf_reset(&sb);
35 if (flags & OPT_SHORT)
36 strbuf_addf(&sb, "switch `%c'", opt->short_name);
37 else if (flags & OPT_UNSET)
38 strbuf_addf(&sb, "option `no-%s'", opt->long_name);
39 else if (flags == OPT_LONG)
40 strbuf_addf(&sb, "option `%s'", opt->long_name);
41 else
42 BUG("optname() got unknown flags %d", flags);
44 return sb.buf;
47 static enum parse_opt_result get_arg(struct parse_opt_ctx_t *p,
48 const struct option *opt,
49 enum opt_parsed flags, const char **arg)
51 if (p->opt) {
52 *arg = p->opt;
53 p->opt = NULL;
54 } else if (p->argc == 1 && (opt->flags & PARSE_OPT_LASTARG_DEFAULT)) {
55 *arg = (const char *)opt->defval;
56 } else if (p->argc > 1) {
57 p->argc--;
58 *arg = *++p->argv;
59 } else
60 return error(_("%s requires a value"), optname(opt, flags));
61 return 0;
64 static void fix_filename(const char *prefix, char **file)
66 if (!file || !*file)
67 ; /* leave as NULL */
68 else
69 *file = prefix_filename_except_for_dash(prefix, *file);
72 static enum parse_opt_result opt_command_mode_error(
73 const struct option *opt,
74 const struct option *all_opts,
75 enum opt_parsed flags)
77 const struct option *that;
78 struct strbuf that_name = STRBUF_INIT;
81 * Find the other option that was used to set the variable
82 * already, and report that this is not compatible with it.
84 for (that = all_opts; that->type != OPTION_END; that++) {
85 if (that == opt ||
86 !(that->flags & PARSE_OPT_CMDMODE) ||
87 that->value != opt->value ||
88 that->defval != *(int *)opt->value)
89 continue;
91 if (that->long_name)
92 strbuf_addf(&that_name, "--%s", that->long_name);
93 else
94 strbuf_addf(&that_name, "-%c", that->short_name);
95 error(_("%s is incompatible with %s"),
96 optname(opt, flags), that_name.buf);
97 strbuf_release(&that_name);
98 return PARSE_OPT_ERROR;
100 return error(_("%s : incompatible with something else"),
101 optname(opt, flags));
104 static enum parse_opt_result get_value(struct parse_opt_ctx_t *p,
105 const struct option *opt,
106 const struct option *all_opts,
107 enum opt_parsed flags)
109 const char *s, *arg;
110 const int unset = flags & OPT_UNSET;
111 int err;
113 if (unset && p->opt)
114 return error(_("%s takes no value"), optname(opt, flags));
115 if (unset && (opt->flags & PARSE_OPT_NONEG))
116 return error(_("%s isn't available"), optname(opt, flags));
117 if (!(flags & OPT_SHORT) && p->opt && (opt->flags & PARSE_OPT_NOARG))
118 return error(_("%s takes no value"), optname(opt, flags));
121 * Giving the same mode option twice, although unnecessary,
122 * is not a grave error, so let it pass.
124 if ((opt->flags & PARSE_OPT_CMDMODE) &&
125 *(int *)opt->value && *(int *)opt->value != opt->defval)
126 return opt_command_mode_error(opt, all_opts, flags);
128 switch (opt->type) {
129 case OPTION_LOWLEVEL_CALLBACK:
130 return opt->ll_callback(p, opt, NULL, unset);
132 case OPTION_BIT:
133 if (unset)
134 *(int *)opt->value &= ~opt->defval;
135 else
136 *(int *)opt->value |= opt->defval;
137 return 0;
139 case OPTION_NEGBIT:
140 if (unset)
141 *(int *)opt->value |= opt->defval;
142 else
143 *(int *)opt->value &= ~opt->defval;
144 return 0;
146 case OPTION_BITOP:
147 if (unset)
148 BUG("BITOP can't have unset form");
149 *(int *)opt->value &= ~opt->extra;
150 *(int *)opt->value |= opt->defval;
151 return 0;
153 case OPTION_COUNTUP:
154 if (*(int *)opt->value < 0)
155 *(int *)opt->value = 0;
156 *(int *)opt->value = unset ? 0 : *(int *)opt->value + 1;
157 return 0;
159 case OPTION_SET_INT:
160 *(int *)opt->value = unset ? 0 : opt->defval;
161 return 0;
163 case OPTION_STRING:
164 if (unset)
165 *(const char **)opt->value = NULL;
166 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
167 *(const char **)opt->value = (const char *)opt->defval;
168 else
169 return get_arg(p, opt, flags, (const char **)opt->value);
170 return 0;
172 case OPTION_FILENAME:
173 err = 0;
174 if (unset)
175 *(const char **)opt->value = NULL;
176 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
177 *(const char **)opt->value = (const char *)opt->defval;
178 else
179 err = get_arg(p, opt, flags, (const char **)opt->value);
181 if (!err)
182 fix_filename(p->prefix, (char **)opt->value);
183 return err;
185 case OPTION_CALLBACK:
187 const char *p_arg = NULL;
188 int p_unset;
190 if (unset)
191 p_unset = 1;
192 else if (opt->flags & PARSE_OPT_NOARG)
193 p_unset = 0;
194 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
195 p_unset = 0;
196 else if (get_arg(p, opt, flags, &arg))
197 return -1;
198 else {
199 p_unset = 0;
200 p_arg = arg;
202 if (opt->callback)
203 return (*opt->callback)(opt, p_arg, p_unset) ? (-1) : 0;
204 else
205 return (*opt->ll_callback)(p, opt, p_arg, p_unset);
207 case OPTION_INTEGER:
208 if (unset) {
209 *(int *)opt->value = 0;
210 return 0;
212 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
213 *(int *)opt->value = opt->defval;
214 return 0;
216 if (get_arg(p, opt, flags, &arg))
217 return -1;
218 if (!*arg)
219 return error(_("%s expects a numerical value"),
220 optname(opt, flags));
221 *(int *)opt->value = strtol(arg, (char **)&s, 10);
222 if (*s)
223 return error(_("%s expects a numerical value"),
224 optname(opt, flags));
225 return 0;
227 case OPTION_MAGNITUDE:
228 if (unset) {
229 *(unsigned long *)opt->value = 0;
230 return 0;
232 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
233 *(unsigned long *)opt->value = opt->defval;
234 return 0;
236 if (get_arg(p, opt, flags, &arg))
237 return -1;
238 if (!git_parse_ulong(arg, opt->value))
239 return error(_("%s expects a non-negative integer value"
240 " with an optional k/m/g suffix"),
241 optname(opt, flags));
242 return 0;
244 default:
245 BUG("opt->type %d should not happen", opt->type);
249 static enum parse_opt_result parse_short_opt(struct parse_opt_ctx_t *p,
250 const struct option *options)
252 const struct option *all_opts = options;
253 const struct option *numopt = NULL;
255 for (; options->type != OPTION_END; options++) {
256 if (options->short_name == *p->opt) {
257 p->opt = p->opt[1] ? p->opt + 1 : NULL;
258 return get_value(p, options, all_opts, OPT_SHORT);
262 * Handle the numerical option later, explicit one-digit
263 * options take precedence over it.
265 if (options->type == OPTION_NUMBER)
266 numopt = options;
268 if (numopt && isdigit(*p->opt)) {
269 size_t len = 1;
270 char *arg;
271 int rc;
273 while (isdigit(p->opt[len]))
274 len++;
275 arg = xmemdupz(p->opt, len);
276 p->opt = p->opt[len] ? p->opt + len : NULL;
277 if (numopt->callback)
278 rc = (*numopt->callback)(numopt, arg, 0) ? (-1) : 0;
279 else
280 rc = (*numopt->ll_callback)(p, numopt, arg, 0);
281 free(arg);
282 return rc;
284 return PARSE_OPT_UNKNOWN;
287 static int has_string(const char *it, const char **array)
289 while (*array)
290 if (!strcmp(it, *(array++)))
291 return 1;
292 return 0;
295 static int is_alias(struct parse_opt_ctx_t *ctx,
296 const struct option *one_opt,
297 const struct option *another_opt)
299 const char **group;
301 if (!ctx->alias_groups)
302 return 0;
304 if (!one_opt->long_name || !another_opt->long_name)
305 return 0;
307 for (group = ctx->alias_groups; *group; group += 3) {
308 /* it and other are from the same family? */
309 if (has_string(one_opt->long_name, group) &&
310 has_string(another_opt->long_name, group))
311 return 1;
313 return 0;
316 static enum parse_opt_result parse_long_opt(
317 struct parse_opt_ctx_t *p, const char *arg,
318 const struct option *options)
320 const struct option *all_opts = options;
321 const char *arg_end = strchrnul(arg, '=');
322 const struct option *abbrev_option = NULL, *ambiguous_option = NULL;
323 enum opt_parsed abbrev_flags = OPT_LONG, ambiguous_flags = OPT_LONG;
325 for (; options->type != OPTION_END; options++) {
326 const char *rest, *long_name = options->long_name;
327 enum opt_parsed flags = OPT_LONG, opt_flags = OPT_LONG;
329 if (options->type == OPTION_SUBCOMMAND)
330 continue;
331 if (!long_name)
332 continue;
334 again:
335 if (!skip_prefix(arg, long_name, &rest))
336 rest = NULL;
337 if (!rest) {
338 /* abbreviated? */
339 if (!(p->flags & PARSE_OPT_KEEP_UNKNOWN_OPT) &&
340 !strncmp(long_name, arg, arg_end - arg)) {
341 is_abbreviated:
342 if (abbrev_option &&
343 !is_alias(p, abbrev_option, options)) {
345 * If this is abbreviated, it is
346 * ambiguous. So when there is no
347 * exact match later, we need to
348 * error out.
350 ambiguous_option = abbrev_option;
351 ambiguous_flags = abbrev_flags;
353 if (!(flags & OPT_UNSET) && *arg_end)
354 p->opt = arg_end + 1;
355 abbrev_option = options;
356 abbrev_flags = flags ^ opt_flags;
357 continue;
359 /* negation allowed? */
360 if (options->flags & PARSE_OPT_NONEG)
361 continue;
362 /* negated and abbreviated very much? */
363 if (starts_with("no-", arg)) {
364 flags |= OPT_UNSET;
365 goto is_abbreviated;
367 /* negated? */
368 if (!starts_with(arg, "no-")) {
369 if (skip_prefix(long_name, "no-", &long_name)) {
370 opt_flags |= OPT_UNSET;
371 goto again;
373 continue;
375 flags |= OPT_UNSET;
376 if (!skip_prefix(arg + 3, long_name, &rest)) {
377 /* abbreviated and negated? */
378 if (starts_with(long_name, arg + 3))
379 goto is_abbreviated;
380 else
381 continue;
384 if (*rest) {
385 if (*rest != '=')
386 continue;
387 p->opt = rest + 1;
389 return get_value(p, options, all_opts, flags ^ opt_flags);
392 if (disallow_abbreviated_options && (ambiguous_option || abbrev_option))
393 die("disallowed abbreviated or ambiguous option '%.*s'",
394 (int)(arg_end - arg), arg);
396 if (ambiguous_option) {
397 error(_("ambiguous option: %s "
398 "(could be --%s%s or --%s%s)"),
399 arg,
400 (ambiguous_flags & OPT_UNSET) ? "no-" : "",
401 ambiguous_option->long_name,
402 (abbrev_flags & OPT_UNSET) ? "no-" : "",
403 abbrev_option->long_name);
404 return PARSE_OPT_HELP;
406 if (abbrev_option)
407 return get_value(p, abbrev_option, all_opts, abbrev_flags);
408 return PARSE_OPT_UNKNOWN;
411 static enum parse_opt_result parse_nodash_opt(struct parse_opt_ctx_t *p,
412 const char *arg,
413 const struct option *options)
415 const struct option *all_opts = options;
417 for (; options->type != OPTION_END; options++) {
418 if (!(options->flags & PARSE_OPT_NODASH))
419 continue;
420 if (options->short_name == arg[0] && arg[1] == '\0')
421 return get_value(p, options, all_opts, OPT_SHORT);
423 return PARSE_OPT_ERROR;
426 static enum parse_opt_result parse_subcommand(const char *arg,
427 const struct option *options)
429 for (; options->type != OPTION_END; options++)
430 if (options->type == OPTION_SUBCOMMAND &&
431 !strcmp(options->long_name, arg)) {
432 *(parse_opt_subcommand_fn **)options->value = options->subcommand_fn;
433 return PARSE_OPT_SUBCOMMAND;
436 return PARSE_OPT_UNKNOWN;
439 static void check_typos(const char *arg, const struct option *options)
441 if (strlen(arg) < 3)
442 return;
444 if (starts_with(arg, "no-")) {
445 error(_("did you mean `--%s` (with two dashes)?"), arg);
446 exit(129);
449 for (; options->type != OPTION_END; options++) {
450 if (!options->long_name)
451 continue;
452 if (starts_with(options->long_name, arg)) {
453 error(_("did you mean `--%s` (with two dashes)?"), arg);
454 exit(129);
459 static void parse_options_check(const struct option *opts)
461 char short_opts[128];
462 void *subcommand_value = NULL;
464 memset(short_opts, '\0', sizeof(short_opts));
465 for (; opts->type != OPTION_END; opts++) {
466 if ((opts->flags & PARSE_OPT_LASTARG_DEFAULT) &&
467 (opts->flags & PARSE_OPT_OPTARG))
468 optbug(opts, "uses incompatible flags "
469 "LASTARG_DEFAULT and OPTARG");
470 if (opts->short_name) {
471 if (0x7F <= opts->short_name)
472 optbug(opts, "invalid short name");
473 else if (short_opts[opts->short_name]++)
474 optbug(opts, "short name already used");
476 if (opts->flags & PARSE_OPT_NODASH &&
477 ((opts->flags & PARSE_OPT_OPTARG) ||
478 !(opts->flags & PARSE_OPT_NOARG) ||
479 !(opts->flags & PARSE_OPT_NONEG) ||
480 opts->long_name))
481 optbug(opts, "uses feature "
482 "not supported for dashless options");
483 switch (opts->type) {
484 case OPTION_COUNTUP:
485 case OPTION_BIT:
486 case OPTION_NEGBIT:
487 case OPTION_SET_INT:
488 case OPTION_NUMBER:
489 if ((opts->flags & PARSE_OPT_OPTARG) ||
490 !(opts->flags & PARSE_OPT_NOARG))
491 optbug(opts, "should not accept an argument");
492 break;
493 case OPTION_CALLBACK:
494 if (!opts->callback && !opts->ll_callback)
495 optbug(opts, "OPTION_CALLBACK needs one callback");
496 else if (opts->callback && opts->ll_callback)
497 optbug(opts, "OPTION_CALLBACK can't have two callbacks");
498 break;
499 case OPTION_LOWLEVEL_CALLBACK:
500 if (!opts->ll_callback)
501 optbug(opts, "OPTION_LOWLEVEL_CALLBACK needs a callback");
502 if (opts->callback)
503 optbug(opts, "OPTION_LOWLEVEL_CALLBACK needs no high level callback");
504 break;
505 case OPTION_ALIAS:
506 optbug(opts, "OPT_ALIAS() should not remain at this point. "
507 "Are you using parse_options_step() directly?\n"
508 "That case is not supported yet.");
509 break;
510 case OPTION_SUBCOMMAND:
511 if (!opts->value || !opts->subcommand_fn)
512 optbug(opts, "OPTION_SUBCOMMAND needs a value and a subcommand function");
513 if (!subcommand_value)
514 subcommand_value = opts->value;
515 else if (subcommand_value != opts->value)
516 optbug(opts, "all OPTION_SUBCOMMANDs need the same value");
517 break;
518 default:
519 ; /* ok. (usually accepts an argument) */
521 if (opts->argh &&
522 strcspn(opts->argh, " _") != strlen(opts->argh))
523 optbug(opts, "multi-word argh should use dash to separate words");
525 BUG_if_bug("invalid 'struct option'");
528 static int has_subcommands(const struct option *options)
530 for (; options->type != OPTION_END; options++)
531 if (options->type == OPTION_SUBCOMMAND)
532 return 1;
533 return 0;
536 static void parse_options_start_1(struct parse_opt_ctx_t *ctx,
537 int argc, const char **argv, const char *prefix,
538 const struct option *options,
539 enum parse_opt_flags flags)
541 ctx->argc = argc;
542 ctx->argv = argv;
543 if (!(flags & PARSE_OPT_ONE_SHOT)) {
544 ctx->argc--;
545 ctx->argv++;
547 ctx->total = ctx->argc;
548 ctx->out = argv;
549 ctx->prefix = prefix;
550 ctx->cpidx = ((flags & PARSE_OPT_KEEP_ARGV0) != 0);
551 ctx->flags = flags;
552 ctx->has_subcommands = has_subcommands(options);
553 if (!ctx->has_subcommands && (flags & PARSE_OPT_SUBCOMMAND_OPTIONAL))
554 BUG("Using PARSE_OPT_SUBCOMMAND_OPTIONAL without subcommands");
555 if (ctx->has_subcommands) {
556 if (flags & PARSE_OPT_STOP_AT_NON_OPTION)
557 BUG("subcommands are incompatible with PARSE_OPT_STOP_AT_NON_OPTION");
558 if (!(flags & PARSE_OPT_SUBCOMMAND_OPTIONAL)) {
559 if (flags & PARSE_OPT_KEEP_UNKNOWN_OPT)
560 BUG("subcommands are incompatible with PARSE_OPT_KEEP_UNKNOWN_OPT unless in combination with PARSE_OPT_SUBCOMMAND_OPTIONAL");
561 if (flags & PARSE_OPT_KEEP_DASHDASH)
562 BUG("subcommands are incompatible with PARSE_OPT_KEEP_DASHDASH unless in combination with PARSE_OPT_SUBCOMMAND_OPTIONAL");
565 if ((flags & PARSE_OPT_KEEP_UNKNOWN_OPT) &&
566 (flags & PARSE_OPT_STOP_AT_NON_OPTION) &&
567 !(flags & PARSE_OPT_ONE_SHOT))
568 BUG("STOP_AT_NON_OPTION and KEEP_UNKNOWN don't go together");
569 if ((flags & PARSE_OPT_ONE_SHOT) &&
570 (flags & PARSE_OPT_KEEP_ARGV0))
571 BUG("Can't keep argv0 if you don't have it");
572 parse_options_check(options);
575 void parse_options_start(struct parse_opt_ctx_t *ctx,
576 int argc, const char **argv, const char *prefix,
577 const struct option *options,
578 enum parse_opt_flags flags)
580 memset(ctx, 0, sizeof(*ctx));
581 parse_options_start_1(ctx, argc, argv, prefix, options, flags);
584 static void show_negated_gitcomp(const struct option *opts, int show_all,
585 int nr_noopts)
587 int printed_dashdash = 0;
589 for (; opts->type != OPTION_END; opts++) {
590 int has_unset_form = 0;
591 const char *name;
593 if (!opts->long_name)
594 continue;
595 if (!show_all &&
596 (opts->flags & (PARSE_OPT_HIDDEN | PARSE_OPT_NOCOMPLETE)))
597 continue;
598 if (opts->flags & PARSE_OPT_NONEG)
599 continue;
601 switch (opts->type) {
602 case OPTION_STRING:
603 case OPTION_FILENAME:
604 case OPTION_INTEGER:
605 case OPTION_MAGNITUDE:
606 case OPTION_CALLBACK:
607 case OPTION_BIT:
608 case OPTION_NEGBIT:
609 case OPTION_COUNTUP:
610 case OPTION_SET_INT:
611 has_unset_form = 1;
612 break;
613 default:
614 break;
616 if (!has_unset_form)
617 continue;
619 if (skip_prefix(opts->long_name, "no-", &name)) {
620 if (nr_noopts < 0)
621 printf(" --%s", name);
622 } else if (nr_noopts >= 0) {
623 if (nr_noopts && !printed_dashdash) {
624 printf(" --");
625 printed_dashdash = 1;
627 printf(" --no-%s", opts->long_name);
628 nr_noopts++;
633 static int show_gitcomp(const struct option *opts, int show_all)
635 const struct option *original_opts = opts;
636 int nr_noopts = 0;
638 for (; opts->type != OPTION_END; opts++) {
639 const char *prefix = "--";
640 const char *suffix = "";
642 if (!opts->long_name)
643 continue;
644 if (!show_all &&
645 (opts->flags & (PARSE_OPT_HIDDEN | PARSE_OPT_NOCOMPLETE | PARSE_OPT_FROM_ALIAS)))
646 continue;
648 switch (opts->type) {
649 case OPTION_SUBCOMMAND:
650 prefix = "";
651 break;
652 case OPTION_GROUP:
653 continue;
654 case OPTION_STRING:
655 case OPTION_FILENAME:
656 case OPTION_INTEGER:
657 case OPTION_MAGNITUDE:
658 case OPTION_CALLBACK:
659 if (opts->flags & PARSE_OPT_NOARG)
660 break;
661 if (opts->flags & PARSE_OPT_OPTARG)
662 break;
663 if (opts->flags & PARSE_OPT_LASTARG_DEFAULT)
664 break;
665 suffix = "=";
666 break;
667 default:
668 break;
670 if (opts->flags & PARSE_OPT_COMP_ARG)
671 suffix = "=";
672 if (starts_with(opts->long_name, "no-"))
673 nr_noopts++;
674 printf("%s%s%s%s", opts == original_opts ? "" : " ",
675 prefix, opts->long_name, suffix);
677 show_negated_gitcomp(original_opts, show_all, -1);
678 show_negated_gitcomp(original_opts, show_all, nr_noopts);
679 fputc('\n', stdout);
680 return PARSE_OPT_COMPLETE;
684 * Scan and may produce a new option[] array, which should be used
685 * instead of the original 'options'.
687 * Right now this is only used to preprocess and substitute
688 * OPTION_ALIAS.
690 * The returned options should be freed using free_preprocessed_options.
692 static struct option *preprocess_options(struct parse_opt_ctx_t *ctx,
693 const struct option *options)
695 struct option *newopt;
696 int i, nr, alias;
697 int nr_aliases = 0;
699 for (nr = 0; options[nr].type != OPTION_END; nr++) {
700 if (options[nr].type == OPTION_ALIAS)
701 nr_aliases++;
704 if (!nr_aliases)
705 return NULL;
707 DUP_ARRAY(newopt, options, nr + 1);
709 /* each alias has two string pointers and NULL */
710 CALLOC_ARRAY(ctx->alias_groups, 3 * (nr_aliases + 1));
712 for (alias = 0, i = 0; i < nr; i++) {
713 int short_name;
714 const char *long_name;
715 const char *source;
716 struct strbuf help = STRBUF_INIT;
717 int j;
719 if (newopt[i].type != OPTION_ALIAS)
720 continue;
722 short_name = newopt[i].short_name;
723 long_name = newopt[i].long_name;
724 source = newopt[i].value;
726 if (!long_name)
727 BUG("An alias must have long option name");
728 strbuf_addf(&help, _("alias of --%s"), source);
730 for (j = 0; j < nr; j++) {
731 const char *name = options[j].long_name;
733 if (!name || strcmp(name, source))
734 continue;
736 if (options[j].type == OPTION_ALIAS)
737 BUG("No please. Nested aliases are not supported.");
739 memcpy(newopt + i, options + j, sizeof(*newopt));
740 newopt[i].short_name = short_name;
741 newopt[i].long_name = long_name;
742 newopt[i].help = strbuf_detach(&help, NULL);
743 newopt[i].flags |= PARSE_OPT_FROM_ALIAS;
744 break;
747 if (j == nr)
748 BUG("could not find source option '%s' of alias '%s'",
749 source, newopt[i].long_name);
750 ctx->alias_groups[alias * 3 + 0] = newopt[i].long_name;
751 ctx->alias_groups[alias * 3 + 1] = options[j].long_name;
752 ctx->alias_groups[alias * 3 + 2] = NULL;
753 alias++;
756 return newopt;
759 static void free_preprocessed_options(struct option *options)
761 int i;
763 if (!options)
764 return;
766 for (i = 0; options[i].type != OPTION_END; i++) {
767 if (options[i].flags & PARSE_OPT_FROM_ALIAS)
768 free((void *)options[i].help);
770 free(options);
773 static enum parse_opt_result usage_with_options_internal(struct parse_opt_ctx_t *,
774 const char * const *,
775 const struct option *,
776 int, int);
778 enum parse_opt_result parse_options_step(struct parse_opt_ctx_t *ctx,
779 const struct option *options,
780 const char * const usagestr[])
782 int internal_help = !(ctx->flags & PARSE_OPT_NO_INTERNAL_HELP);
784 /* we must reset ->opt, unknown short option leave it dangling */
785 ctx->opt = NULL;
787 for (; ctx->argc; ctx->argc--, ctx->argv++) {
788 const char *arg = ctx->argv[0];
790 if (ctx->flags & PARSE_OPT_ONE_SHOT &&
791 ctx->argc != ctx->total)
792 break;
794 if (*arg != '-' || !arg[1]) {
795 if (parse_nodash_opt(ctx, arg, options) == 0)
796 continue;
797 if (!ctx->has_subcommands) {
798 if (ctx->flags & PARSE_OPT_STOP_AT_NON_OPTION)
799 return PARSE_OPT_NON_OPTION;
800 ctx->out[ctx->cpidx++] = ctx->argv[0];
801 continue;
803 switch (parse_subcommand(arg, options)) {
804 case PARSE_OPT_SUBCOMMAND:
805 return PARSE_OPT_SUBCOMMAND;
806 case PARSE_OPT_UNKNOWN:
807 if (ctx->flags & PARSE_OPT_SUBCOMMAND_OPTIONAL)
809 * arg is neither a short or long
810 * option nor a subcommand. Since
811 * this command has a default
812 * operation mode, we have to treat
813 * this arg and all remaining args
814 * as args meant to that default
815 * operation mode.
816 * So we are done parsing.
818 return PARSE_OPT_DONE;
819 error(_("unknown subcommand: `%s'"), arg);
820 usage_with_options(usagestr, options);
821 case PARSE_OPT_COMPLETE:
822 case PARSE_OPT_HELP:
823 case PARSE_OPT_ERROR:
824 case PARSE_OPT_DONE:
825 case PARSE_OPT_NON_OPTION:
826 /* Impossible. */
827 BUG("parse_subcommand() cannot return these");
831 /* lone -h asks for help */
832 if (internal_help && ctx->total == 1 && !strcmp(arg + 1, "h"))
833 goto show_usage;
836 * lone --git-completion-helper and --git-completion-helper-all
837 * are asked by git-completion.bash
839 if (ctx->total == 1 && !strcmp(arg, "--git-completion-helper"))
840 return show_gitcomp(options, 0);
841 if (ctx->total == 1 && !strcmp(arg, "--git-completion-helper-all"))
842 return show_gitcomp(options, 1);
844 if (arg[1] != '-') {
845 ctx->opt = arg + 1;
846 switch (parse_short_opt(ctx, options)) {
847 case PARSE_OPT_ERROR:
848 return PARSE_OPT_ERROR;
849 case PARSE_OPT_UNKNOWN:
850 if (ctx->opt)
851 check_typos(arg + 1, options);
852 if (internal_help && *ctx->opt == 'h')
853 goto show_usage;
854 goto unknown;
855 case PARSE_OPT_NON_OPTION:
856 case PARSE_OPT_SUBCOMMAND:
857 case PARSE_OPT_HELP:
858 case PARSE_OPT_COMPLETE:
859 BUG("parse_short_opt() cannot return these");
860 case PARSE_OPT_DONE:
861 break;
863 if (ctx->opt)
864 check_typos(arg + 1, options);
865 while (ctx->opt) {
866 switch (parse_short_opt(ctx, options)) {
867 case PARSE_OPT_ERROR:
868 return PARSE_OPT_ERROR;
869 case PARSE_OPT_UNKNOWN:
870 if (internal_help && *ctx->opt == 'h')
871 goto show_usage;
873 /* fake a short option thing to hide the fact that we may have
874 * started to parse aggregated stuff
876 * This is leaky, too bad.
878 ctx->argv[0] = xstrdup(ctx->opt - 1);
879 *(char *)ctx->argv[0] = '-';
880 goto unknown;
881 case PARSE_OPT_NON_OPTION:
882 case PARSE_OPT_SUBCOMMAND:
883 case PARSE_OPT_COMPLETE:
884 case PARSE_OPT_HELP:
885 BUG("parse_short_opt() cannot return these");
886 case PARSE_OPT_DONE:
887 break;
890 continue;
893 if (!arg[2] /* "--" */ ||
894 !strcmp(arg + 2, "end-of-options")) {
895 if (!(ctx->flags & PARSE_OPT_KEEP_DASHDASH)) {
896 ctx->argc--;
897 ctx->argv++;
899 break;
902 if (internal_help && !strcmp(arg + 2, "help-all"))
903 return usage_with_options_internal(ctx, usagestr, options, 1, 0);
904 if (internal_help && !strcmp(arg + 2, "help"))
905 goto show_usage;
906 switch (parse_long_opt(ctx, arg + 2, options)) {
907 case PARSE_OPT_ERROR:
908 return PARSE_OPT_ERROR;
909 case PARSE_OPT_UNKNOWN:
910 goto unknown;
911 case PARSE_OPT_HELP:
912 goto show_usage;
913 case PARSE_OPT_NON_OPTION:
914 case PARSE_OPT_SUBCOMMAND:
915 case PARSE_OPT_COMPLETE:
916 BUG("parse_long_opt() cannot return these");
917 case PARSE_OPT_DONE:
918 break;
920 continue;
921 unknown:
922 if (ctx->flags & PARSE_OPT_ONE_SHOT)
923 break;
924 if (ctx->has_subcommands &&
925 (ctx->flags & PARSE_OPT_SUBCOMMAND_OPTIONAL) &&
926 (ctx->flags & PARSE_OPT_KEEP_UNKNOWN_OPT)) {
928 * Found an unknown option given to a command with
929 * subcommands that has a default operation mode:
930 * we treat this option and all remaining args as
931 * arguments meant to that default operation mode.
932 * So we are done parsing.
934 return PARSE_OPT_DONE;
936 if (!(ctx->flags & PARSE_OPT_KEEP_UNKNOWN_OPT))
937 return PARSE_OPT_UNKNOWN;
938 ctx->out[ctx->cpidx++] = ctx->argv[0];
939 ctx->opt = NULL;
941 return PARSE_OPT_DONE;
943 show_usage:
944 return usage_with_options_internal(ctx, usagestr, options, 0, 0);
947 int parse_options_end(struct parse_opt_ctx_t *ctx)
949 if (ctx->flags & PARSE_OPT_ONE_SHOT)
950 return ctx->total - ctx->argc;
952 MOVE_ARRAY(ctx->out + ctx->cpidx, ctx->argv, ctx->argc);
953 ctx->out[ctx->cpidx + ctx->argc] = NULL;
954 return ctx->cpidx + ctx->argc;
957 int parse_options(int argc, const char **argv,
958 const char *prefix,
959 const struct option *options,
960 const char * const usagestr[],
961 enum parse_opt_flags flags)
963 struct parse_opt_ctx_t ctx;
964 struct option *real_options;
966 disallow_abbreviated_options =
967 git_env_bool("GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS", 0);
969 memset(&ctx, 0, sizeof(ctx));
970 real_options = preprocess_options(&ctx, options);
971 if (real_options)
972 options = real_options;
973 parse_options_start_1(&ctx, argc, argv, prefix, options, flags);
974 switch (parse_options_step(&ctx, options, usagestr)) {
975 case PARSE_OPT_HELP:
976 case PARSE_OPT_ERROR:
977 exit(129);
978 case PARSE_OPT_COMPLETE:
979 exit(0);
980 case PARSE_OPT_NON_OPTION:
981 case PARSE_OPT_SUBCOMMAND:
982 break;
983 case PARSE_OPT_DONE:
984 if (ctx.has_subcommands &&
985 !(flags & PARSE_OPT_SUBCOMMAND_OPTIONAL)) {
986 error(_("need a subcommand"));
987 usage_with_options(usagestr, options);
989 break;
990 case PARSE_OPT_UNKNOWN:
991 if (ctx.argv[0][1] == '-') {
992 error(_("unknown option `%s'"), ctx.argv[0] + 2);
993 } else if (isascii(*ctx.opt)) {
994 error(_("unknown switch `%c'"), *ctx.opt);
995 } else {
996 error(_("unknown non-ascii option in string: `%s'"),
997 ctx.argv[0]);
999 usage_with_options(usagestr, options);
1002 precompose_argv_prefix(argc, argv, NULL);
1003 free_preprocessed_options(real_options);
1004 free(ctx.alias_groups);
1005 return parse_options_end(&ctx);
1008 static int usage_argh(const struct option *opts, FILE *outfile)
1010 const char *s;
1011 int literal = (opts->flags & PARSE_OPT_LITERAL_ARGHELP) ||
1012 !opts->argh || !!strpbrk(opts->argh, "()<>[]|");
1013 if (opts->flags & PARSE_OPT_OPTARG)
1014 if (opts->long_name)
1015 s = literal ? "[=%s]" : "[=<%s>]";
1016 else
1017 s = literal ? "[%s]" : "[<%s>]";
1018 else
1019 s = literal ? " %s" : " <%s>";
1020 return utf8_fprintf(outfile, s, opts->argh ? _(opts->argh) : _("..."));
1023 #define USAGE_OPTS_WIDTH 24
1024 #define USAGE_GAP 2
1026 static enum parse_opt_result usage_with_options_internal(struct parse_opt_ctx_t *ctx,
1027 const char * const *usagestr,
1028 const struct option *opts,
1029 int full, int err)
1031 FILE *outfile = err ? stderr : stdout;
1032 int need_newline;
1034 const char *usage_prefix = _("usage: %s");
1036 * The translation could be anything, but we can count on
1037 * msgfmt(1)'s --check option to have asserted that "%s" is in
1038 * the translation. So compute the length of the "usage: "
1039 * part. We are assuming that the translator wasn't overly
1040 * clever and used e.g. "%1$s" instead of "%s", there's only
1041 * one "%s" in "usage_prefix" above, so there's no reason to
1042 * do so even with a RTL language.
1044 size_t usage_len = strlen(usage_prefix) - strlen("%s");
1046 * TRANSLATORS: the colon here should align with the
1047 * one in "usage: %s" translation.
1049 const char *or_prefix = _(" or: %s");
1051 * TRANSLATORS: You should only need to translate this format
1052 * string if your language is a RTL language (e.g. Arabic,
1053 * Hebrew etc.), not if it's a LTR language (e.g. German,
1054 * Russian, Chinese etc.).
1056 * When a translated usage string has an embedded "\n" it's
1057 * because options have wrapped to the next line. The line
1058 * after the "\n" will then be padded to align with the
1059 * command name, such as N_("git cmd [opt]\n<8
1060 * spaces>[opt2]"), where the 8 spaces are the same length as
1061 * "git cmd ".
1063 * This format string prints out that already-translated
1064 * line. The "%*s" is whitespace padding to account for the
1065 * padding at the start of the line that we add in this
1066 * function. The "%s" is a line in the (hopefully already
1067 * translated) N_() usage string, which contained embedded
1068 * newlines before we split it up.
1070 const char *usage_continued = _("%*s%s");
1071 const char *prefix = usage_prefix;
1072 int saw_empty_line = 0;
1074 if (!usagestr)
1075 return PARSE_OPT_HELP;
1077 if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
1078 fprintf(outfile, "cat <<\\EOF\n");
1080 while (*usagestr) {
1081 const char *str = _(*usagestr++);
1082 struct string_list list = STRING_LIST_INIT_DUP;
1083 unsigned int j;
1085 if (!saw_empty_line && !*str)
1086 saw_empty_line = 1;
1088 string_list_split(&list, str, '\n', -1);
1089 for (j = 0; j < list.nr; j++) {
1090 const char *line = list.items[j].string;
1092 if (saw_empty_line && *line)
1093 fprintf_ln(outfile, _(" %s"), line);
1094 else if (saw_empty_line)
1095 fputc('\n', outfile);
1096 else if (!j)
1097 fprintf_ln(outfile, prefix, line);
1098 else
1099 fprintf_ln(outfile, usage_continued,
1100 (int)usage_len, "", line);
1102 string_list_clear(&list, 0);
1104 prefix = or_prefix;
1107 need_newline = 1;
1109 for (; opts->type != OPTION_END; opts++) {
1110 size_t pos;
1111 int pad;
1113 if (opts->type == OPTION_SUBCOMMAND)
1114 continue;
1115 if (opts->type == OPTION_GROUP) {
1116 fputc('\n', outfile);
1117 need_newline = 0;
1118 if (*opts->help)
1119 fprintf(outfile, "%s\n", _(opts->help));
1120 continue;
1122 if (!full && (opts->flags & PARSE_OPT_HIDDEN))
1123 continue;
1125 if (need_newline) {
1126 fputc('\n', outfile);
1127 need_newline = 0;
1130 pos = fprintf(outfile, " ");
1131 if (opts->short_name) {
1132 if (opts->flags & PARSE_OPT_NODASH)
1133 pos += fprintf(outfile, "%c", opts->short_name);
1134 else
1135 pos += fprintf(outfile, "-%c", opts->short_name);
1137 if (opts->long_name && opts->short_name)
1138 pos += fprintf(outfile, ", ");
1139 if (opts->long_name)
1140 pos += fprintf(outfile, "--%s", opts->long_name);
1141 if (opts->type == OPTION_NUMBER)
1142 pos += utf8_fprintf(outfile, _("-NUM"));
1144 if ((opts->flags & PARSE_OPT_LITERAL_ARGHELP) ||
1145 !(opts->flags & PARSE_OPT_NOARG))
1146 pos += usage_argh(opts, outfile);
1148 if (pos <= USAGE_OPTS_WIDTH)
1149 pad = USAGE_OPTS_WIDTH - pos;
1150 else {
1151 fputc('\n', outfile);
1152 pad = USAGE_OPTS_WIDTH;
1154 if (opts->type == OPTION_ALIAS) {
1155 fprintf(outfile, "%*s", pad + USAGE_GAP, "");
1156 fprintf_ln(outfile, _("alias of --%s"),
1157 (const char *)opts->value);
1158 continue;
1160 fprintf(outfile, "%*s%s\n", pad + USAGE_GAP, "", _(opts->help));
1162 fputc('\n', outfile);
1164 if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
1165 fputs("EOF\n", outfile);
1167 return PARSE_OPT_HELP;
1170 void NORETURN usage_with_options(const char * const *usagestr,
1171 const struct option *opts)
1173 usage_with_options_internal(NULL, usagestr, opts, 0, 1);
1174 exit(129);
1177 void NORETURN usage_msg_opt(const char *msg,
1178 const char * const *usagestr,
1179 const struct option *options)
1181 die_message("%s\n", msg); /* The extra \n is intentional */
1182 usage_with_options(usagestr, options);
1185 void NORETURN usage_msg_optf(const char * const fmt,
1186 const char * const *usagestr,
1187 const struct option *options, ...)
1189 struct strbuf msg = STRBUF_INIT;
1190 va_list ap;
1191 va_start(ap, options);
1192 strbuf_vaddf(&msg, fmt, ap);
1193 va_end(ap);
1195 usage_msg_opt(msg.buf, usagestr, options);
1198 void die_for_incompatible_opt4(int opt1, const char *opt1_name,
1199 int opt2, const char *opt2_name,
1200 int opt3, const char *opt3_name,
1201 int opt4, const char *opt4_name)
1203 int count = 0;
1204 const char *options[4];
1206 if (opt1)
1207 options[count++] = opt1_name;
1208 if (opt2)
1209 options[count++] = opt2_name;
1210 if (opt3)
1211 options[count++] = opt3_name;
1212 if (opt4)
1213 options[count++] = opt4_name;
1214 switch (count) {
1215 case 4:
1216 die(_("options '%s', '%s', '%s', and '%s' cannot be used together"),
1217 opt1_name, opt2_name, opt3_name, opt4_name);
1218 break;
1219 case 3:
1220 die(_("options '%s', '%s', and '%s' cannot be used together"),
1221 options[0], options[1], options[2]);
1222 break;
1223 case 2:
1224 die(_("options '%s' and '%s' cannot be used together"),
1225 options[0], options[1]);
1226 break;
1227 default:
1228 break;