1 #include "git-compat-util.h"
2 #include "parse-options.h"
11 int optbug(const struct option *opt, const char *reason)
15 return error("BUG: switch '%c' (--%s) %s",
16 opt->short_name, opt->long_name, reason);
17 return error("BUG: option '%s' %s", opt->long_name, reason);
19 return error("BUG: switch '%c' %s", opt->short_name, reason);
22 static int get_arg(struct parse_opt_ctx_t *p, const struct option *opt,
23 int flags, const char **arg)
28 } else if (p->argc == 1 && (opt->flags & PARSE_OPT_LASTARG_DEFAULT)) {
29 *arg = (const char *)opt->defval;
30 } else if (p->argc > 1) {
34 return opterror(opt, "requires a value", flags);
38 static void fix_filename(const char *prefix, const char **file)
40 if (!file || !*file || !prefix || is_absolute_path(*file)
41 || !strcmp("-", *file))
43 *file = xstrdup(prefix_filename(prefix, strlen(prefix), *file));
46 static int opt_command_mode_error(const struct option *opt,
47 const struct option *all_opts,
50 const struct option *that;
51 struct strbuf message = STRBUF_INIT;
52 struct strbuf that_name = STRBUF_INIT;
55 * Find the other option that was used to set the variable
56 * already, and report that this is not compatible with it.
58 for (that = all_opts; that->type != OPTION_END; that++) {
60 that->type != OPTION_CMDMODE ||
61 that->value != opt->value ||
62 that->defval != *(int *)opt->value)
66 strbuf_addf(&that_name, "--%s", that->long_name);
68 strbuf_addf(&that_name, "-%c", that->short_name);
69 strbuf_addf(&message, ": incompatible with %s", that_name.buf);
70 strbuf_release(&that_name);
71 opterror(opt, message.buf, flags);
72 strbuf_release(&message);
75 return opterror(opt, ": incompatible with something else", flags);
78 static int get_value(struct parse_opt_ctx_t *p,
79 const struct option *opt,
80 const struct option *all_opts,
84 const int unset = flags & OPT_UNSET;
88 return opterror(opt, "takes no value", flags);
89 if (unset && (opt->flags & PARSE_OPT_NONEG))
90 return opterror(opt, "isn't available", flags);
91 if (!(flags & OPT_SHORT) && p->opt && (opt->flags & PARSE_OPT_NOARG))
92 return opterror(opt, "takes no value", flags);
95 case OPTION_LOWLEVEL_CALLBACK:
96 return (*(parse_opt_ll_cb *)opt->callback)(p, opt, unset);
100 *(int *)opt->value &= ~opt->defval;
102 *(int *)opt->value |= opt->defval;
107 *(int *)opt->value |= opt->defval;
109 *(int *)opt->value &= ~opt->defval;
113 if (*(int *)opt->value < 0)
114 *(int *)opt->value = 0;
115 *(int *)opt->value = unset ? 0 : *(int *)opt->value + 1;
119 *(int *)opt->value = unset ? 0 : opt->defval;
124 * Giving the same mode option twice, although is unnecessary,
125 * is not a grave error, so let it pass.
127 if (*(int *)opt->value && *(int *)opt->value != opt->defval)
128 return opt_command_mode_error(opt, all_opts, flags);
129 *(int *)opt->value = opt->defval;
134 *(const char **)opt->value = NULL;
135 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
136 *(const char **)opt->value = (const char *)opt->defval;
138 return get_arg(p, opt, flags, (const char **)opt->value);
141 case OPTION_FILENAME:
144 *(const char **)opt->value = NULL;
145 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
146 *(const char **)opt->value = (const char *)opt->defval;
148 err = get_arg(p, opt, flags, (const char **)opt->value);
151 fix_filename(p->prefix, (const char **)opt->value);
154 case OPTION_CALLBACK:
156 return (*opt->callback)(opt, NULL, 1) ? (-1) : 0;
157 if (opt->flags & PARSE_OPT_NOARG)
158 return (*opt->callback)(opt, NULL, 0) ? (-1) : 0;
159 if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
160 return (*opt->callback)(opt, NULL, 0) ? (-1) : 0;
161 if (get_arg(p, opt, flags, &arg))
163 return (*opt->callback)(opt, arg, 0) ? (-1) : 0;
167 *(int *)opt->value = 0;
170 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
171 *(int *)opt->value = opt->defval;
174 if (get_arg(p, opt, flags, &arg))
176 *(int *)opt->value = strtol(arg, (char **)&s, 10);
178 return opterror(opt, "expects a numerical value", flags);
181 case OPTION_MAGNITUDE:
183 *(unsigned long *)opt->value = 0;
186 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
187 *(unsigned long *)opt->value = opt->defval;
190 if (get_arg(p, opt, flags, &arg))
192 if (!git_parse_ulong(arg, opt->value))
194 "expects a non-negative integer value with an optional k/m/g suffix",
199 die("should not happen, someone must be hit on the forehead");
203 static int parse_short_opt(struct parse_opt_ctx_t *p, const struct option *options)
205 const struct option *all_opts = options;
206 const struct option *numopt = NULL;
208 for (; options->type != OPTION_END; options++) {
209 if (options->short_name == *p->opt) {
210 p->opt = p->opt[1] ? p->opt + 1 : NULL;
211 return get_value(p, options, all_opts, OPT_SHORT);
215 * Handle the numerical option later, explicit one-digit
216 * options take precedence over it.
218 if (options->type == OPTION_NUMBER)
221 if (numopt && isdigit(*p->opt)) {
226 while (isdigit(p->opt[len]))
228 arg = xmemdupz(p->opt, len);
229 p->opt = p->opt[len] ? p->opt + len : NULL;
230 rc = (*numopt->callback)(numopt, arg, 0) ? (-1) : 0;
237 static int parse_long_opt(struct parse_opt_ctx_t *p, const char *arg,
238 const struct option *options)
240 const struct option *all_opts = options;
241 const char *arg_end = strchrnul(arg, '=');
242 const struct option *abbrev_option = NULL, *ambiguous_option = NULL;
243 int abbrev_flags = 0, ambiguous_flags = 0;
245 for (; options->type != OPTION_END; options++) {
246 const char *rest, *long_name = options->long_name;
247 int flags = 0, opt_flags = 0;
253 if (!skip_prefix(arg, long_name, &rest))
255 if (options->type == OPTION_ARGUMENT) {
259 return opterror(options, "takes no value", flags);
262 p->out[p->cpidx++] = arg - 2;
267 if (!strncmp(long_name, arg, arg_end - arg)) {
271 * If this is abbreviated, it is
272 * ambiguous. So when there is no
273 * exact match later, we need to
276 ambiguous_option = abbrev_option;
277 ambiguous_flags = abbrev_flags;
279 if (!(flags & OPT_UNSET) && *arg_end)
280 p->opt = arg_end + 1;
281 abbrev_option = options;
282 abbrev_flags = flags ^ opt_flags;
285 /* negation allowed? */
286 if (options->flags & PARSE_OPT_NONEG)
288 /* negated and abbreviated very much? */
289 if (starts_with("no-", arg)) {
294 if (!starts_with(arg, "no-")) {
295 if (starts_with(long_name, "no-")) {
297 opt_flags |= OPT_UNSET;
303 if (!skip_prefix(arg + 3, long_name, &rest)) {
304 /* abbreviated and negated? */
305 if (starts_with(long_name, arg + 3))
316 return get_value(p, options, all_opts, flags ^ opt_flags);
319 if (ambiguous_option)
320 return error("Ambiguous option: %s "
321 "(could be --%s%s or --%s%s)",
323 (ambiguous_flags & OPT_UNSET) ? "no-" : "",
324 ambiguous_option->long_name,
325 (abbrev_flags & OPT_UNSET) ? "no-" : "",
326 abbrev_option->long_name);
328 return get_value(p, abbrev_option, all_opts, abbrev_flags);
332 static int parse_nodash_opt(struct parse_opt_ctx_t *p, const char *arg,
333 const struct option *options)
335 const struct option *all_opts = options;
337 for (; options->type != OPTION_END; options++) {
338 if (!(options->flags & PARSE_OPT_NODASH))
340 if (options->short_name == arg[0] && arg[1] == '\0')
341 return get_value(p, options, all_opts, OPT_SHORT);
346 static void check_typos(const char *arg, const struct option *options)
351 if (starts_with(arg, "no-")) {
352 error ("did you mean `--%s` (with two dashes ?)", arg);
356 for (; options->type != OPTION_END; options++) {
357 if (!options->long_name)
359 if (starts_with(options->long_name, arg)) {
360 error ("did you mean `--%s` (with two dashes ?)", arg);
366 static void parse_options_check(const struct option *opts)
369 char short_opts[128];
371 memset(short_opts, '\0', sizeof(short_opts));
372 for (; opts->type != OPTION_END; opts++) {
373 if ((opts->flags & PARSE_OPT_LASTARG_DEFAULT) &&
374 (opts->flags & PARSE_OPT_OPTARG))
375 err |= optbug(opts, "uses incompatible flags "
376 "LASTARG_DEFAULT and OPTARG");
377 if (opts->short_name) {
378 if (0x7F <= opts->short_name)
379 err |= optbug(opts, "invalid short name");
380 else if (short_opts[opts->short_name]++)
381 err |= optbug(opts, "short name already used");
383 if (opts->flags & PARSE_OPT_NODASH &&
384 ((opts->flags & PARSE_OPT_OPTARG) ||
385 !(opts->flags & PARSE_OPT_NOARG) ||
386 !(opts->flags & PARSE_OPT_NONEG) ||
388 err |= optbug(opts, "uses feature "
389 "not supported for dashless options");
390 switch (opts->type) {
396 if ((opts->flags & PARSE_OPT_OPTARG) ||
397 !(opts->flags & PARSE_OPT_NOARG))
398 err |= optbug(opts, "should not accept an argument");
400 ; /* ok. (usually accepts an argument) */
403 strcspn(opts->argh, " _") != strlen(opts->argh))
404 err |= optbug(opts, "multi-word argh should use dash to separate words");
410 void parse_options_start(struct parse_opt_ctx_t *ctx,
411 int argc, const char **argv, const char *prefix,
412 const struct option *options, int flags)
414 memset(ctx, 0, sizeof(*ctx));
415 ctx->argc = ctx->total = argc - 1;
416 ctx->argv = argv + 1;
418 ctx->prefix = prefix;
419 ctx->cpidx = ((flags & PARSE_OPT_KEEP_ARGV0) != 0);
421 if ((flags & PARSE_OPT_KEEP_UNKNOWN) &&
422 (flags & PARSE_OPT_STOP_AT_NON_OPTION))
423 die("STOP_AT_NON_OPTION and KEEP_UNKNOWN don't go together");
424 parse_options_check(options);
427 static int usage_with_options_internal(struct parse_opt_ctx_t *,
428 const char * const *,
429 const struct option *, int, int);
431 int parse_options_step(struct parse_opt_ctx_t *ctx,
432 const struct option *options,
433 const char * const usagestr[])
435 int internal_help = !(ctx->flags & PARSE_OPT_NO_INTERNAL_HELP);
438 /* we must reset ->opt, unknown short option leave it dangling */
441 for (; ctx->argc; ctx->argc--, ctx->argv++) {
442 const char *arg = ctx->argv[0];
444 if (*arg != '-' || !arg[1]) {
445 if (parse_nodash_opt(ctx, arg, options) == 0)
447 if (ctx->flags & PARSE_OPT_STOP_AT_NON_OPTION)
448 return PARSE_OPT_NON_OPTION;
449 ctx->out[ctx->cpidx++] = ctx->argv[0];
453 /* lone -h asks for help */
454 if (internal_help && ctx->total == 1 && !strcmp(arg + 1, "h"))
459 switch (parse_short_opt(ctx, options)) {
461 goto show_usage_error;
464 check_typos(arg + 1, options);
465 if (internal_help && *ctx->opt == 'h')
470 check_typos(arg + 1, options);
472 switch (parse_short_opt(ctx, options)) {
474 goto show_usage_error;
476 if (internal_help && *ctx->opt == 'h')
479 /* fake a short option thing to hide the fact that we may have
480 * started to parse aggregated stuff
482 * This is leaky, too bad.
484 ctx->argv[0] = xstrdup(ctx->opt - 1);
485 *(char *)ctx->argv[0] = '-';
492 if (!arg[2]) { /* "--" */
493 if (!(ctx->flags & PARSE_OPT_KEEP_DASHDASH)) {
500 if (internal_help && !strcmp(arg + 2, "help-all"))
501 return usage_with_options_internal(ctx, usagestr, options, 1, 0);
502 if (internal_help && !strcmp(arg + 2, "help"))
504 switch (parse_long_opt(ctx, arg + 2, options)) {
506 goto show_usage_error;
512 if (!(ctx->flags & PARSE_OPT_KEEP_UNKNOWN))
513 return PARSE_OPT_UNKNOWN;
514 ctx->out[ctx->cpidx++] = ctx->argv[0];
517 return PARSE_OPT_DONE;
522 return usage_with_options_internal(ctx, usagestr, options, 0, err);
525 int parse_options_end(struct parse_opt_ctx_t *ctx)
527 memmove(ctx->out + ctx->cpidx, ctx->argv, ctx->argc * sizeof(*ctx->out));
528 ctx->out[ctx->cpidx + ctx->argc] = NULL;
529 return ctx->cpidx + ctx->argc;
532 int parse_options(int argc, const char **argv, const char *prefix,
533 const struct option *options, const char * const usagestr[],
536 struct parse_opt_ctx_t ctx;
538 parse_options_start(&ctx, argc, argv, prefix, options, flags);
539 switch (parse_options_step(&ctx, options, usagestr)) {
542 case PARSE_OPT_NON_OPTION:
545 default: /* PARSE_OPT_UNKNOWN */
546 if (ctx.argv[0][1] == '-') {
547 error("unknown option `%s'", ctx.argv[0] + 2);
548 } else if (isascii(*ctx.opt)) {
549 error("unknown switch `%c'", *ctx.opt);
551 error("unknown non-ascii option in string: `%s'",
554 usage_with_options(usagestr, options);
557 precompose_argv(argc, argv);
558 return parse_options_end(&ctx);
561 static int usage_argh(const struct option *opts, FILE *outfile)
564 int literal = (opts->flags & PARSE_OPT_LITERAL_ARGHELP) || !opts->argh;
565 if (opts->flags & PARSE_OPT_OPTARG)
567 s = literal ? "[=%s]" : "[=<%s>]";
569 s = literal ? "[%s]" : "[<%s>]";
571 s = literal ? " %s" : " <%s>";
572 return utf8_fprintf(outfile, s, opts->argh ? _(opts->argh) : _("..."));
575 #define USAGE_OPTS_WIDTH 24
578 static int usage_with_options_internal(struct parse_opt_ctx_t *ctx,
579 const char * const *usagestr,
580 const struct option *opts, int full, int err)
582 FILE *outfile = err ? stderr : stdout;
585 return PARSE_OPT_HELP;
587 if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
588 fprintf(outfile, "cat <<\\EOF\n");
590 fprintf_ln(outfile, _("usage: %s"), _(*usagestr++));
591 while (*usagestr && **usagestr)
592 /* TRANSLATORS: the colon here should align with the
593 one in "usage: %s" translation */
594 fprintf_ln(outfile, _(" or: %s"), _(*usagestr++));
597 fprintf_ln(outfile, _(" %s"), _(*usagestr));
603 if (opts->type != OPTION_GROUP)
604 fputc('\n', outfile);
606 for (; opts->type != OPTION_END; opts++) {
610 if (opts->type == OPTION_GROUP) {
611 fputc('\n', outfile);
613 fprintf(outfile, "%s\n", _(opts->help));
616 if (!full && (opts->flags & PARSE_OPT_HIDDEN))
619 pos = fprintf(outfile, " ");
620 if (opts->short_name) {
621 if (opts->flags & PARSE_OPT_NODASH)
622 pos += fprintf(outfile, "%c", opts->short_name);
624 pos += fprintf(outfile, "-%c", opts->short_name);
626 if (opts->long_name && opts->short_name)
627 pos += fprintf(outfile, ", ");
629 pos += fprintf(outfile, "--%s", opts->long_name);
630 if (opts->type == OPTION_NUMBER)
631 pos += utf8_fprintf(outfile, _("-NUM"));
633 if ((opts->flags & PARSE_OPT_LITERAL_ARGHELP) ||
634 !(opts->flags & PARSE_OPT_NOARG))
635 pos += usage_argh(opts, outfile);
637 if (pos <= USAGE_OPTS_WIDTH)
638 pad = USAGE_OPTS_WIDTH - pos;
640 fputc('\n', outfile);
641 pad = USAGE_OPTS_WIDTH;
643 fprintf(outfile, "%*s%s\n", pad + USAGE_GAP, "", _(opts->help));
645 fputc('\n', outfile);
647 if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
648 fputs("EOF\n", outfile);
650 return PARSE_OPT_HELP;
653 void NORETURN usage_with_options(const char * const *usagestr,
654 const struct option *opts)
656 usage_with_options_internal(NULL, usagestr, opts, 0, 1);
660 void NORETURN usage_msg_opt(const char *msg,
661 const char * const *usagestr,
662 const struct option *options)
664 fprintf(stderr, "fatal: %s\n\n", msg);
665 usage_with_options(usagestr, options);
669 int opterror(const struct option *opt, const char *reason, int flags)
671 if (flags & OPT_SHORT)
672 return error("switch `%c' %s", opt->short_name, reason);
673 if (flags & OPT_UNSET)
674 return error("option `no-%s' %s", opt->long_name, reason);
675 return error("option `%s' %s", opt->long_name, reason);