1 #include "git-compat-util.h"
2 #include "parse-options.h"
9 static int disallow_abbreviated_options;
14 int optbug(const struct option *opt, const char *reason)
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);
22 return error("BUG: switch '%c' %s", opt->short_name, reason);
25 static enum parse_opt_result get_arg(struct parse_opt_ctx_t *p,
26 const struct option *opt,
27 int flags, const char **arg)
32 } else if (p->argc == 1 && (opt->flags & PARSE_OPT_LASTARG_DEFAULT)) {
33 *arg = (const char *)opt->defval;
34 } else if (p->argc > 1) {
38 return error(_("%s requires a value"), optname(opt, flags));
42 static void fix_filename(const char *prefix, const char **file)
44 if (!file || !*file || !prefix || is_absolute_path(*file)
45 || !strcmp("-", *file))
47 *file = prefix_filename(prefix, *file);
50 static enum parse_opt_result opt_command_mode_error(
51 const struct option *opt,
52 const struct option *all_opts,
55 const struct option *that;
56 struct strbuf that_name = STRBUF_INIT;
59 * Find the other option that was used to set the variable
60 * already, and report that this is not compatible with it.
62 for (that = all_opts; that->type != OPTION_END; that++) {
64 !(that->flags & PARSE_OPT_CMDMODE) ||
65 that->value != opt->value ||
66 that->defval != *(int *)opt->value)
70 strbuf_addf(&that_name, "--%s", that->long_name);
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;
78 return error(_("%s : incompatible with something else"),
82 static enum parse_opt_result get_value(struct parse_opt_ctx_t *p,
83 const struct option *opt,
84 const struct option *all_opts,
88 const int unset = flags & OPT_UNSET;
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));
99 * Giving the same mode option twice, although unnecessary,
100 * is not a grave error, so let it pass.
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);
107 case OPTION_LOWLEVEL_CALLBACK:
108 return opt->ll_callback(p, opt, NULL, unset);
112 *(int *)opt->value &= ~opt->defval;
114 *(int *)opt->value |= opt->defval;
119 *(int *)opt->value |= opt->defval;
121 *(int *)opt->value &= ~opt->defval;
126 BUG("BITOP can't have unset form");
127 *(int *)opt->value &= ~opt->extra;
128 *(int *)opt->value |= opt->defval;
132 if (*(int *)opt->value < 0)
133 *(int *)opt->value = 0;
134 *(int *)opt->value = unset ? 0 : *(int *)opt->value + 1;
138 *(int *)opt->value = unset ? 0 : opt->defval;
143 *(const char **)opt->value = NULL;
144 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
145 *(const char **)opt->value = (const char *)opt->defval;
147 return get_arg(p, opt, flags, (const char **)opt->value);
150 case OPTION_FILENAME:
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;
157 err = get_arg(p, opt, flags, (const char **)opt->value);
160 fix_filename(p->prefix, (const char **)opt->value);
163 case OPTION_CALLBACK:
165 const char *p_arg = NULL;
170 else if (opt->flags & PARSE_OPT_NOARG)
172 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
174 else if (get_arg(p, opt, flags, &arg))
181 return (*opt->callback)(opt, p_arg, p_unset) ? (-1) : 0;
183 return (*opt->ll_callback)(p, opt, p_arg, p_unset);
187 *(int *)opt->value = 0;
190 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
191 *(int *)opt->value = opt->defval;
194 if (get_arg(p, opt, flags, &arg))
197 return error(_("%s expects a numerical value"),
198 optname(opt, flags));
199 *(int *)opt->value = strtol(arg, (char **)&s, 10);
201 return error(_("%s expects a numerical value"),
202 optname(opt, flags));
205 case OPTION_MAGNITUDE:
207 *(unsigned long *)opt->value = 0;
210 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
211 *(unsigned long *)opt->value = opt->defval;
214 if (get_arg(p, opt, flags, &arg))
216 if (!git_parse_ulong(arg, opt->value))
217 return error(_("%s expects a non-negative integer value"
218 " with an optional k/m/g suffix"),
219 optname(opt, flags));
223 BUG("opt->type %d should not happen", opt->type);
227 static enum parse_opt_result parse_short_opt(struct parse_opt_ctx_t *p,
228 const struct option *options)
230 const struct option *all_opts = options;
231 const struct option *numopt = NULL;
233 for (; options->type != OPTION_END; options++) {
234 if (options->short_name == *p->opt) {
235 p->opt = p->opt[1] ? p->opt + 1 : NULL;
236 return get_value(p, options, all_opts, OPT_SHORT);
240 * Handle the numerical option later, explicit one-digit
241 * options take precedence over it.
243 if (options->type == OPTION_NUMBER)
246 if (numopt && isdigit(*p->opt)) {
251 while (isdigit(p->opt[len]))
253 arg = xmemdupz(p->opt, len);
254 p->opt = p->opt[len] ? p->opt + len : NULL;
255 if (numopt->callback)
256 rc = (*numopt->callback)(numopt, arg, 0) ? (-1) : 0;
258 rc = (*numopt->ll_callback)(p, numopt, arg, 0);
262 return PARSE_OPT_UNKNOWN;
265 static int has_string(const char *it, const char **array)
268 if (!strcmp(it, *(array++)))
273 static int is_alias(struct parse_opt_ctx_t *ctx,
274 const struct option *one_opt,
275 const struct option *another_opt)
279 if (!ctx->alias_groups)
282 if (!one_opt->long_name || !another_opt->long_name)
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))
294 static enum parse_opt_result parse_long_opt(
295 struct parse_opt_ctx_t *p, const char *arg,
296 const struct option *options)
298 const struct option *all_opts = options;
299 const char *arg_end = strchrnul(arg, '=');
300 const struct option *abbrev_option = NULL, *ambiguous_option = NULL;
301 int abbrev_flags = 0, ambiguous_flags = 0;
303 for (; options->type != OPTION_END; options++) {
304 const char *rest, *long_name = options->long_name;
305 int flags = 0, opt_flags = 0;
311 if (!skip_prefix(arg, long_name, &rest))
313 if (options->type == OPTION_ARGUMENT) {
317 return error(_("%s takes no value"),
318 optname(options, flags));
322 *(int *)options->value = options->defval;
323 p->out[p->cpidx++] = arg - 2;
324 return PARSE_OPT_DONE;
328 if (!(p->flags & PARSE_OPT_KEEP_UNKNOWN) &&
329 !strncmp(long_name, arg, arg_end - arg)) {
332 !is_alias(p, abbrev_option, options)) {
334 * If this is abbreviated, it is
335 * ambiguous. So when there is no
336 * exact match later, we need to
339 ambiguous_option = abbrev_option;
340 ambiguous_flags = abbrev_flags;
342 if (!(flags & OPT_UNSET) && *arg_end)
343 p->opt = arg_end + 1;
344 abbrev_option = options;
345 abbrev_flags = flags ^ opt_flags;
348 /* negation allowed? */
349 if (options->flags & PARSE_OPT_NONEG)
351 /* negated and abbreviated very much? */
352 if (starts_with("no-", arg)) {
357 if (!starts_with(arg, "no-")) {
358 if (skip_prefix(long_name, "no-", &long_name)) {
359 opt_flags |= OPT_UNSET;
365 if (!skip_prefix(arg + 3, long_name, &rest)) {
366 /* abbreviated and negated? */
367 if (starts_with(long_name, arg + 3))
378 return get_value(p, options, all_opts, flags ^ opt_flags);
381 if (disallow_abbreviated_options && (ambiguous_option || abbrev_option))
382 die("disallowed abbreviated or ambiguous option '%.*s'",
383 (int)(arg_end - arg), arg);
385 if (ambiguous_option) {
386 error(_("ambiguous option: %s "
387 "(could be --%s%s or --%s%s)"),
389 (ambiguous_flags & OPT_UNSET) ? "no-" : "",
390 ambiguous_option->long_name,
391 (abbrev_flags & OPT_UNSET) ? "no-" : "",
392 abbrev_option->long_name);
393 return PARSE_OPT_HELP;
396 return get_value(p, abbrev_option, all_opts, abbrev_flags);
397 return PARSE_OPT_UNKNOWN;
400 static int parse_nodash_opt(struct parse_opt_ctx_t *p, const char *arg,
401 const struct option *options)
403 const struct option *all_opts = options;
405 for (; options->type != OPTION_END; options++) {
406 if (!(options->flags & PARSE_OPT_NODASH))
408 if (options->short_name == arg[0] && arg[1] == '\0')
409 return get_value(p, options, all_opts, OPT_SHORT);
414 static void check_typos(const char *arg, const struct option *options)
419 if (starts_with(arg, "no-")) {
420 error(_("did you mean `--%s` (with two dashes)?"), arg);
424 for (; options->type != OPTION_END; options++) {
425 if (!options->long_name)
427 if (starts_with(options->long_name, arg)) {
428 error(_("did you mean `--%s` (with two dashes)?"), arg);
434 static void parse_options_check(const struct option *opts)
437 char short_opts[128];
439 memset(short_opts, '\0', sizeof(short_opts));
440 for (; opts->type != OPTION_END; opts++) {
441 if ((opts->flags & PARSE_OPT_LASTARG_DEFAULT) &&
442 (opts->flags & PARSE_OPT_OPTARG))
443 err |= optbug(opts, "uses incompatible flags "
444 "LASTARG_DEFAULT and OPTARG");
445 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");
451 if (opts->flags & PARSE_OPT_NODASH &&
452 ((opts->flags & PARSE_OPT_OPTARG) ||
453 !(opts->flags & PARSE_OPT_NOARG) ||
454 !(opts->flags & PARSE_OPT_NONEG) ||
456 err |= optbug(opts, "uses feature "
457 "not supported for dashless options");
458 switch (opts->type) {
464 if ((opts->flags & PARSE_OPT_OPTARG) ||
465 !(opts->flags & PARSE_OPT_NOARG))
466 err |= optbug(opts, "should not accept an argument");
468 case OPTION_CALLBACK:
469 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");
474 case OPTION_LOWLEVEL_CALLBACK:
475 if (!opts->ll_callback)
476 BUG("OPTION_LOWLEVEL_CALLBACK needs a callback");
478 BUG("OPTION_LOWLEVEL_CALLBACK needs no high level callback");
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.");
485 ; /* ok. (usually accepts an argument) */
488 strcspn(opts->argh, " _") != strlen(opts->argh))
489 err |= optbug(opts, "multi-word argh should use dash to separate words");
495 static 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)
501 if (!(flags & PARSE_OPT_ONE_SHOT)) {
505 ctx->total = ctx->argc;
507 ctx->prefix = prefix;
508 ctx->cpidx = ((flags & PARSE_OPT_KEEP_ARGV0) != 0);
510 if ((flags & PARSE_OPT_KEEP_UNKNOWN) &&
511 (flags & PARSE_OPT_STOP_AT_NON_OPTION) &&
512 !(flags & PARSE_OPT_ONE_SHOT))
513 BUG("STOP_AT_NON_OPTION and KEEP_UNKNOWN don't go together");
514 if ((flags & PARSE_OPT_ONE_SHOT) &&
515 (flags & PARSE_OPT_KEEP_ARGV0))
516 BUG("Can't keep argv0 if you don't have it");
517 parse_options_check(options);
520 void 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)
524 memset(ctx, 0, sizeof(*ctx));
525 parse_options_start_1(ctx, argc, argv, prefix, options, flags);
528 static void show_negated_gitcomp(const struct option *opts, int show_all,
531 int printed_dashdash = 0;
533 for (; opts->type != OPTION_END; opts++) {
534 int has_unset_form = 0;
537 if (!opts->long_name)
540 (opts->flags & (PARSE_OPT_HIDDEN | PARSE_OPT_NOCOMPLETE)))
542 if (opts->flags & PARSE_OPT_NONEG)
545 switch (opts->type) {
547 case OPTION_FILENAME:
549 case OPTION_MAGNITUDE:
550 case OPTION_CALLBACK:
563 if (skip_prefix(opts->long_name, "no-", &name)) {
565 printf(" --%s", name);
566 } else if (nr_noopts >= 0) {
567 if (nr_noopts && !printed_dashdash) {
569 printed_dashdash = 1;
571 printf(" --no-%s", opts->long_name);
577 static int show_gitcomp(const struct option *opts, int show_all)
579 const struct option *original_opts = opts;
582 for (; opts->type != OPTION_END; opts++) {
583 const char *suffix = "";
585 if (!opts->long_name)
588 (opts->flags & (PARSE_OPT_HIDDEN | PARSE_OPT_NOCOMPLETE)))
591 switch (opts->type) {
595 case OPTION_FILENAME:
597 case OPTION_MAGNITUDE:
598 case OPTION_CALLBACK:
599 if (opts->flags & PARSE_OPT_NOARG)
601 if (opts->flags & PARSE_OPT_OPTARG)
603 if (opts->flags & PARSE_OPT_LASTARG_DEFAULT)
610 if (opts->flags & PARSE_OPT_COMP_ARG)
612 if (starts_with(opts->long_name, "no-"))
614 printf(" --%s%s", opts->long_name, suffix);
616 show_negated_gitcomp(original_opts, show_all, -1);
617 show_negated_gitcomp(original_opts, show_all, nr_noopts);
619 return PARSE_OPT_COMPLETE;
623 * Scan and may produce a new option[] array, which should be used
624 * instead of the original 'options'.
626 * Right now this is only used to preprocess and substitute
629 static struct option *preprocess_options(struct parse_opt_ctx_t *ctx,
630 const struct option *options)
632 struct option *newopt;
636 for (nr = 0; options[nr].type != OPTION_END; nr++) {
637 if (options[nr].type == OPTION_ALIAS)
644 ALLOC_ARRAY(newopt, nr + 1);
645 COPY_ARRAY(newopt, options, nr + 1);
647 /* each alias has two string pointers and NULL */
648 CALLOC_ARRAY(ctx->alias_groups, 3 * (nr_aliases + 1));
650 for (alias = 0, i = 0; i < nr; i++) {
652 const char *long_name;
654 struct strbuf help = STRBUF_INIT;
657 if (newopt[i].type != OPTION_ALIAS)
660 short_name = newopt[i].short_name;
661 long_name = newopt[i].long_name;
662 source = newopt[i].value;
665 BUG("An alias must have long option name");
666 strbuf_addf(&help, _("alias of --%s"), source);
668 for (j = 0; j < nr; j++) {
669 const char *name = options[j].long_name;
671 if (!name || strcmp(name, source))
674 if (options[j].type == OPTION_ALIAS)
675 BUG("No please. Nested aliases are not supported.");
677 memcpy(newopt + i, options + j, sizeof(*newopt));
678 newopt[i].short_name = short_name;
679 newopt[i].long_name = long_name;
680 newopt[i].help = strbuf_detach(&help, NULL);
685 BUG("could not find source option '%s' of alias '%s'",
686 source, newopt[i].long_name);
687 ctx->alias_groups[alias * 3 + 0] = newopt[i].long_name;
688 ctx->alias_groups[alias * 3 + 1] = options[j].long_name;
689 ctx->alias_groups[alias * 3 + 2] = NULL;
696 static int usage_with_options_internal(struct parse_opt_ctx_t *,
697 const char * const *,
698 const struct option *, int, int);
700 int parse_options_step(struct parse_opt_ctx_t *ctx,
701 const struct option *options,
702 const char * const usagestr[])
704 int internal_help = !(ctx->flags & PARSE_OPT_NO_INTERNAL_HELP);
706 /* we must reset ->opt, unknown short option leave it dangling */
709 for (; ctx->argc; ctx->argc--, ctx->argv++) {
710 const char *arg = ctx->argv[0];
712 if (ctx->flags & PARSE_OPT_ONE_SHOT &&
713 ctx->argc != ctx->total)
716 if (*arg != '-' || !arg[1]) {
717 if (parse_nodash_opt(ctx, arg, options) == 0)
719 if (ctx->flags & PARSE_OPT_STOP_AT_NON_OPTION)
720 return PARSE_OPT_NON_OPTION;
721 ctx->out[ctx->cpidx++] = ctx->argv[0];
725 /* lone -h asks for help */
726 if (internal_help && ctx->total == 1 && !strcmp(arg + 1, "h"))
730 * lone --git-completion-helper and --git-completion-helper-all
731 * are asked by git-completion.bash
733 if (ctx->total == 1 && !strcmp(arg, "--git-completion-helper"))
734 return show_gitcomp(options, 0);
735 if (ctx->total == 1 && !strcmp(arg, "--git-completion-helper-all"))
736 return show_gitcomp(options, 1);
740 switch (parse_short_opt(ctx, options)) {
741 case PARSE_OPT_ERROR:
742 return PARSE_OPT_ERROR;
743 case PARSE_OPT_UNKNOWN:
745 check_typos(arg + 1, options);
746 if (internal_help && *ctx->opt == 'h')
749 case PARSE_OPT_NON_OPTION:
751 case PARSE_OPT_COMPLETE:
752 BUG("parse_short_opt() cannot return these");
757 check_typos(arg + 1, options);
759 switch (parse_short_opt(ctx, options)) {
760 case PARSE_OPT_ERROR:
761 return PARSE_OPT_ERROR;
762 case PARSE_OPT_UNKNOWN:
763 if (internal_help && *ctx->opt == 'h')
766 /* fake a short option thing to hide the fact that we may have
767 * started to parse aggregated stuff
769 * This is leaky, too bad.
771 ctx->argv[0] = xstrdup(ctx->opt - 1);
772 *(char *)ctx->argv[0] = '-';
774 case PARSE_OPT_NON_OPTION:
775 case PARSE_OPT_COMPLETE:
777 BUG("parse_short_opt() cannot return these");
785 if (!arg[2] /* "--" */ ||
786 !strcmp(arg + 2, "end-of-options")) {
787 if (!(ctx->flags & PARSE_OPT_KEEP_DASHDASH)) {
794 if (internal_help && !strcmp(arg + 2, "help-all"))
795 return usage_with_options_internal(ctx, usagestr, options, 1, 0);
796 if (internal_help && !strcmp(arg + 2, "help"))
798 switch (parse_long_opt(ctx, arg + 2, options)) {
799 case PARSE_OPT_ERROR:
800 return PARSE_OPT_ERROR;
801 case PARSE_OPT_UNKNOWN:
805 case PARSE_OPT_NON_OPTION:
806 case PARSE_OPT_COMPLETE:
807 BUG("parse_long_opt() cannot return these");
813 if (ctx->flags & PARSE_OPT_ONE_SHOT)
815 if (!(ctx->flags & PARSE_OPT_KEEP_UNKNOWN))
816 return PARSE_OPT_UNKNOWN;
817 ctx->out[ctx->cpidx++] = ctx->argv[0];
820 return PARSE_OPT_DONE;
823 return usage_with_options_internal(ctx, usagestr, options, 0, 0);
826 int parse_options_end(struct parse_opt_ctx_t *ctx)
828 if (ctx->flags & PARSE_OPT_ONE_SHOT)
829 return ctx->total - ctx->argc;
831 MOVE_ARRAY(ctx->out + ctx->cpidx, ctx->argv, ctx->argc);
832 ctx->out[ctx->cpidx + ctx->argc] = NULL;
833 return ctx->cpidx + ctx->argc;
836 int parse_options(int argc, const char **argv, const char *prefix,
837 const struct option *options, const char * const usagestr[],
840 struct parse_opt_ctx_t ctx;
841 struct option *real_options;
843 disallow_abbreviated_options =
844 git_env_bool("GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS", 0);
846 memset(&ctx, 0, sizeof(ctx));
847 real_options = preprocess_options(&ctx, options);
849 options = real_options;
850 parse_options_start_1(&ctx, argc, argv, prefix, options, flags);
851 switch (parse_options_step(&ctx, options, usagestr)) {
853 case PARSE_OPT_ERROR:
855 case PARSE_OPT_COMPLETE:
857 case PARSE_OPT_NON_OPTION:
860 default: /* PARSE_OPT_UNKNOWN */
861 if (ctx.argv[0][1] == '-') {
862 error(_("unknown option `%s'"), ctx.argv[0] + 2);
863 } else if (isascii(*ctx.opt)) {
864 error(_("unknown switch `%c'"), *ctx.opt);
866 error(_("unknown non-ascii option in string: `%s'"),
869 usage_with_options(usagestr, options);
872 precompose_argv_prefix(argc, argv, NULL);
874 free(ctx.alias_groups);
875 return parse_options_end(&ctx);
878 static int usage_argh(const struct option *opts, FILE *outfile)
881 int literal = (opts->flags & PARSE_OPT_LITERAL_ARGHELP) ||
882 !opts->argh || !!strpbrk(opts->argh, "()<>[]|");
883 if (opts->flags & PARSE_OPT_OPTARG)
885 s = literal ? "[=%s]" : "[=<%s>]";
887 s = literal ? "[%s]" : "[<%s>]";
889 s = literal ? " %s" : " <%s>";
890 return utf8_fprintf(outfile, s, opts->argh ? _(opts->argh) : _("..."));
893 #define USAGE_OPTS_WIDTH 24
896 static int usage_with_options_internal(struct parse_opt_ctx_t *ctx,
897 const char * const *usagestr,
898 const struct option *opts, int full, int err)
900 FILE *outfile = err ? stderr : stdout;
904 return PARSE_OPT_HELP;
906 if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
907 fprintf(outfile, "cat <<\\EOF\n");
909 fprintf_ln(outfile, _("usage: %s"), _(*usagestr++));
910 while (*usagestr && **usagestr)
912 * TRANSLATORS: the colon here should align with the
913 * one in "usage: %s" translation.
915 fprintf_ln(outfile, _(" or: %s"), _(*usagestr++));
918 fprintf_ln(outfile, _(" %s"), _(*usagestr));
920 fputc('\n', outfile);
926 for (; opts->type != OPTION_END; opts++) {
930 if (opts->type == OPTION_GROUP) {
931 fputc('\n', outfile);
934 fprintf(outfile, "%s\n", _(opts->help));
937 if (!full && (opts->flags & PARSE_OPT_HIDDEN))
941 fputc('\n', outfile);
945 pos = fprintf(outfile, " ");
946 if (opts->short_name) {
947 if (opts->flags & PARSE_OPT_NODASH)
948 pos += fprintf(outfile, "%c", opts->short_name);
950 pos += fprintf(outfile, "-%c", opts->short_name);
952 if (opts->long_name && opts->short_name)
953 pos += fprintf(outfile, ", ");
955 pos += fprintf(outfile, "--%s", opts->long_name);
956 if (opts->type == OPTION_NUMBER)
957 pos += utf8_fprintf(outfile, _("-NUM"));
959 if ((opts->flags & PARSE_OPT_LITERAL_ARGHELP) ||
960 !(opts->flags & PARSE_OPT_NOARG))
961 pos += usage_argh(opts, outfile);
963 if (pos <= USAGE_OPTS_WIDTH)
964 pad = USAGE_OPTS_WIDTH - pos;
966 fputc('\n', outfile);
967 pad = USAGE_OPTS_WIDTH;
969 if (opts->type == OPTION_ALIAS) {
970 fprintf(outfile, "%*s", pad + USAGE_GAP, "");
971 fprintf_ln(outfile, _("alias of --%s"),
972 (const char *)opts->value);
975 fprintf(outfile, "%*s%s\n", pad + USAGE_GAP, "", _(opts->help));
977 fputc('\n', outfile);
979 if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
980 fputs("EOF\n", outfile);
982 return PARSE_OPT_HELP;
985 void NORETURN usage_with_options(const char * const *usagestr,
986 const struct option *opts)
988 usage_with_options_internal(NULL, usagestr, opts, 0, 1);
992 void NORETURN usage_msg_opt(const char *msg,
993 const char * const *usagestr,
994 const struct option *options)
996 fprintf(stderr, "fatal: %s\n\n", msg);
997 usage_with_options(usagestr, options);
1000 const char *optname(const struct option *opt, int flags)
1002 static struct strbuf sb = STRBUF_INIT;
1005 if (flags & OPT_SHORT)
1006 strbuf_addf(&sb, "switch `%c'", opt->short_name);
1007 else if (flags & OPT_UNSET)
1008 strbuf_addf(&sb, "option `no-%s'", opt->long_name);
1010 strbuf_addf(&sb, "option `%s'", opt->long_name);