rebase --root: fix amending root commit messages
[git.git] / parse-options.c
blob0f7059a8ab32a624775026d7dc2289245c87c192
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"
9 #define OPT_SHORT 1
10 #define OPT_UNSET 2
12 int optbug(const struct option *opt, const char *reason)
14 if (opt->long_name) {
15 if (opt->short_name)
16 return error("BUG: switch '%c' (--%s) %s",
17 opt->short_name, opt->long_name, reason);
18 return error("BUG: option '%s' %s", opt->long_name, reason);
20 return error("BUG: switch '%c' %s", opt->short_name, reason);
23 static int get_arg(struct parse_opt_ctx_t *p, const struct option *opt,
24 int flags, const char **arg)
26 if (p->opt) {
27 *arg = p->opt;
28 p->opt = NULL;
29 } else if (p->argc == 1 && (opt->flags & PARSE_OPT_LASTARG_DEFAULT)) {
30 *arg = (const char *)opt->defval;
31 } else if (p->argc > 1) {
32 p->argc--;
33 *arg = *++p->argv;
34 } else
35 return opterror(opt, "requires a value", flags);
36 return 0;
39 static void fix_filename(const char *prefix, const char **file)
41 if (!file || !*file || !prefix || is_absolute_path(*file)
42 || !strcmp("-", *file))
43 return;
44 *file = prefix_filename(prefix, *file);
47 static int opt_command_mode_error(const struct option *opt,
48 const struct option *all_opts,
49 int flags)
51 const struct option *that;
52 struct strbuf message = STRBUF_INIT;
53 struct strbuf that_name = STRBUF_INIT;
56 * Find the other option that was used to set the variable
57 * already, and report that this is not compatible with it.
59 for (that = all_opts; that->type != OPTION_END; that++) {
60 if (that == opt ||
61 that->type != OPTION_CMDMODE ||
62 that->value != opt->value ||
63 that->defval != *(int *)opt->value)
64 continue;
66 if (that->long_name)
67 strbuf_addf(&that_name, "--%s", that->long_name);
68 else
69 strbuf_addf(&that_name, "-%c", that->short_name);
70 strbuf_addf(&message, ": incompatible with %s", that_name.buf);
71 strbuf_release(&that_name);
72 opterror(opt, message.buf, flags);
73 strbuf_release(&message);
74 return -1;
76 return opterror(opt, ": incompatible with something else", flags);
79 static int get_value(struct parse_opt_ctx_t *p,
80 const struct option *opt,
81 const struct option *all_opts,
82 int flags)
84 const char *s, *arg;
85 const int unset = flags & OPT_UNSET;
86 int err;
88 if (unset && p->opt)
89 return opterror(opt, "takes no value", flags);
90 if (unset && (opt->flags & PARSE_OPT_NONEG))
91 return opterror(opt, "isn't available", flags);
92 if (!(flags & OPT_SHORT) && p->opt && (opt->flags & PARSE_OPT_NOARG))
93 return opterror(opt, "takes no value", flags);
95 switch (opt->type) {
96 case OPTION_LOWLEVEL_CALLBACK:
97 return (*(parse_opt_ll_cb *)opt->callback)(p, opt, unset);
99 case OPTION_BIT:
100 if (unset)
101 *(int *)opt->value &= ~opt->defval;
102 else
103 *(int *)opt->value |= opt->defval;
104 return 0;
106 case OPTION_NEGBIT:
107 if (unset)
108 *(int *)opt->value |= opt->defval;
109 else
110 *(int *)opt->value &= ~opt->defval;
111 return 0;
113 case OPTION_COUNTUP:
114 if (*(int *)opt->value < 0)
115 *(int *)opt->value = 0;
116 *(int *)opt->value = unset ? 0 : *(int *)opt->value + 1;
117 return 0;
119 case OPTION_SET_INT:
120 *(int *)opt->value = unset ? 0 : opt->defval;
121 return 0;
123 case OPTION_CMDMODE:
125 * Giving the same mode option twice, although is unnecessary,
126 * is not a grave error, so let it pass.
128 if (*(int *)opt->value && *(int *)opt->value != opt->defval)
129 return opt_command_mode_error(opt, all_opts, flags);
130 *(int *)opt->value = opt->defval;
131 return 0;
133 case OPTION_STRING:
134 if (unset)
135 *(const char **)opt->value = NULL;
136 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
137 *(const char **)opt->value = (const char *)opt->defval;
138 else
139 return get_arg(p, opt, flags, (const char **)opt->value);
140 return 0;
142 case OPTION_FILENAME:
143 err = 0;
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 err = get_arg(p, opt, flags, (const char **)opt->value);
151 if (!err)
152 fix_filename(p->prefix, (const char **)opt->value);
153 return err;
155 case OPTION_CALLBACK:
156 if (unset)
157 return (*opt->callback)(opt, NULL, 1) ? (-1) : 0;
158 if (opt->flags & PARSE_OPT_NOARG)
159 return (*opt->callback)(opt, NULL, 0) ? (-1) : 0;
160 if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
161 return (*opt->callback)(opt, NULL, 0) ? (-1) : 0;
162 if (get_arg(p, opt, flags, &arg))
163 return -1;
164 return (*opt->callback)(opt, arg, 0) ? (-1) : 0;
166 case OPTION_INTEGER:
167 if (unset) {
168 *(int *)opt->value = 0;
169 return 0;
171 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
172 *(int *)opt->value = opt->defval;
173 return 0;
175 if (get_arg(p, opt, flags, &arg))
176 return -1;
177 *(int *)opt->value = strtol(arg, (char **)&s, 10);
178 if (*s)
179 return opterror(opt, "expects a numerical value", flags);
180 return 0;
182 case OPTION_MAGNITUDE:
183 if (unset) {
184 *(unsigned long *)opt->value = 0;
185 return 0;
187 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
188 *(unsigned long *)opt->value = opt->defval;
189 return 0;
191 if (get_arg(p, opt, flags, &arg))
192 return -1;
193 if (!git_parse_ulong(arg, opt->value))
194 return opterror(opt,
195 "expects a non-negative integer value with an optional k/m/g suffix",
196 flags);
197 return 0;
199 default:
200 die("should not happen, someone must be hit on the forehead");
204 static int parse_short_opt(struct parse_opt_ctx_t *p, const struct option *options)
206 const struct option *all_opts = options;
207 const struct option *numopt = NULL;
209 for (; options->type != OPTION_END; options++) {
210 if (options->short_name == *p->opt) {
211 p->opt = p->opt[1] ? p->opt + 1 : NULL;
212 return get_value(p, options, all_opts, OPT_SHORT);
216 * Handle the numerical option later, explicit one-digit
217 * options take precedence over it.
219 if (options->type == OPTION_NUMBER)
220 numopt = options;
222 if (numopt && isdigit(*p->opt)) {
223 size_t len = 1;
224 char *arg;
225 int rc;
227 while (isdigit(p->opt[len]))
228 len++;
229 arg = xmemdupz(p->opt, len);
230 p->opt = p->opt[len] ? p->opt + len : NULL;
231 rc = (*numopt->callback)(numopt, arg, 0) ? (-1) : 0;
232 free(arg);
233 return rc;
235 return -2;
238 static int parse_long_opt(struct parse_opt_ctx_t *p, const char *arg,
239 const struct option *options)
241 const struct option *all_opts = options;
242 const char *arg_end = strchrnul(arg, '=');
243 const struct option *abbrev_option = NULL, *ambiguous_option = NULL;
244 int abbrev_flags = 0, ambiguous_flags = 0;
246 for (; options->type != OPTION_END; options++) {
247 const char *rest, *long_name = options->long_name;
248 int flags = 0, opt_flags = 0;
250 if (!long_name)
251 continue;
253 again:
254 if (!skip_prefix(arg, long_name, &rest))
255 rest = NULL;
256 if (options->type == OPTION_ARGUMENT) {
257 if (!rest)
258 continue;
259 if (*rest == '=')
260 return opterror(options, "takes no value", flags);
261 if (*rest)
262 continue;
263 p->out[p->cpidx++] = arg - 2;
264 return 0;
266 if (!rest) {
267 /* abbreviated? */
268 if (!strncmp(long_name, arg, arg_end - arg)) {
269 is_abbreviated:
270 if (abbrev_option) {
272 * If this is abbreviated, it is
273 * ambiguous. So when there is no
274 * exact match later, we need to
275 * error out.
277 ambiguous_option = abbrev_option;
278 ambiguous_flags = abbrev_flags;
280 if (!(flags & OPT_UNSET) && *arg_end)
281 p->opt = arg_end + 1;
282 abbrev_option = options;
283 abbrev_flags = flags ^ opt_flags;
284 continue;
286 /* negation allowed? */
287 if (options->flags & PARSE_OPT_NONEG)
288 continue;
289 /* negated and abbreviated very much? */
290 if (starts_with("no-", arg)) {
291 flags |= OPT_UNSET;
292 goto is_abbreviated;
294 /* negated? */
295 if (!starts_with(arg, "no-")) {
296 if (starts_with(long_name, "no-")) {
297 long_name += 3;
298 opt_flags |= OPT_UNSET;
299 goto again;
301 continue;
303 flags |= OPT_UNSET;
304 if (!skip_prefix(arg + 3, long_name, &rest)) {
305 /* abbreviated and negated? */
306 if (starts_with(long_name, arg + 3))
307 goto is_abbreviated;
308 else
309 continue;
312 if (*rest) {
313 if (*rest != '=')
314 continue;
315 p->opt = rest + 1;
317 return get_value(p, options, all_opts, flags ^ opt_flags);
320 if (ambiguous_option) {
321 error("Ambiguous option: %s "
322 "(could be --%s%s or --%s%s)",
323 arg,
324 (ambiguous_flags & OPT_UNSET) ? "no-" : "",
325 ambiguous_option->long_name,
326 (abbrev_flags & OPT_UNSET) ? "no-" : "",
327 abbrev_option->long_name);
328 return -3;
330 if (abbrev_option)
331 return get_value(p, abbrev_option, all_opts, abbrev_flags);
332 return -2;
335 static int parse_nodash_opt(struct parse_opt_ctx_t *p, const char *arg,
336 const struct option *options)
338 const struct option *all_opts = options;
340 for (; options->type != OPTION_END; options++) {
341 if (!(options->flags & PARSE_OPT_NODASH))
342 continue;
343 if (options->short_name == arg[0] && arg[1] == '\0')
344 return get_value(p, options, all_opts, OPT_SHORT);
346 return -2;
349 static void check_typos(const char *arg, const struct option *options)
351 if (strlen(arg) < 3)
352 return;
354 if (starts_with(arg, "no-")) {
355 error ("did you mean `--%s` (with two dashes ?)", arg);
356 exit(129);
359 for (; options->type != OPTION_END; options++) {
360 if (!options->long_name)
361 continue;
362 if (starts_with(options->long_name, arg)) {
363 error ("did you mean `--%s` (with two dashes ?)", arg);
364 exit(129);
369 static void parse_options_check(const struct option *opts)
371 int err = 0;
372 char short_opts[128];
374 memset(short_opts, '\0', sizeof(short_opts));
375 for (; opts->type != OPTION_END; opts++) {
376 if ((opts->flags & PARSE_OPT_LASTARG_DEFAULT) &&
377 (opts->flags & PARSE_OPT_OPTARG))
378 err |= optbug(opts, "uses incompatible flags "
379 "LASTARG_DEFAULT and OPTARG");
380 if (opts->short_name) {
381 if (0x7F <= opts->short_name)
382 err |= optbug(opts, "invalid short name");
383 else if (short_opts[opts->short_name]++)
384 err |= optbug(opts, "short name already used");
386 if (opts->flags & PARSE_OPT_NODASH &&
387 ((opts->flags & PARSE_OPT_OPTARG) ||
388 !(opts->flags & PARSE_OPT_NOARG) ||
389 !(opts->flags & PARSE_OPT_NONEG) ||
390 opts->long_name))
391 err |= optbug(opts, "uses feature "
392 "not supported for dashless options");
393 switch (opts->type) {
394 case OPTION_COUNTUP:
395 case OPTION_BIT:
396 case OPTION_NEGBIT:
397 case OPTION_SET_INT:
398 case OPTION_NUMBER:
399 if ((opts->flags & PARSE_OPT_OPTARG) ||
400 !(opts->flags & PARSE_OPT_NOARG))
401 err |= optbug(opts, "should not accept an argument");
402 default:
403 ; /* ok. (usually accepts an argument) */
405 if (opts->argh &&
406 strcspn(opts->argh, " _") != strlen(opts->argh))
407 err |= optbug(opts, "multi-word argh should use dash to separate words");
409 if (err)
410 exit(128);
413 void parse_options_start(struct parse_opt_ctx_t *ctx,
414 int argc, const char **argv, const char *prefix,
415 const struct option *options, int flags)
417 memset(ctx, 0, sizeof(*ctx));
418 ctx->argc = ctx->total = argc - 1;
419 ctx->argv = argv + 1;
420 ctx->out = argv;
421 ctx->prefix = prefix;
422 ctx->cpidx = ((flags & PARSE_OPT_KEEP_ARGV0) != 0);
423 ctx->flags = flags;
424 if ((flags & PARSE_OPT_KEEP_UNKNOWN) &&
425 (flags & PARSE_OPT_STOP_AT_NON_OPTION))
426 die("STOP_AT_NON_OPTION and KEEP_UNKNOWN don't go together");
427 parse_options_check(options);
431 * TODO: we are not completing the --no-XXX form yet because there are
432 * many options that do not suppress it properly.
434 static int show_gitcomp(struct parse_opt_ctx_t *ctx,
435 const struct option *opts)
437 for (; opts->type != OPTION_END; opts++) {
438 const char *suffix = "";
440 if (!opts->long_name)
441 continue;
442 if (opts->flags & (PARSE_OPT_HIDDEN | PARSE_OPT_NOCOMPLETE))
443 continue;
445 switch (opts->type) {
446 case OPTION_GROUP:
447 continue;
448 case OPTION_STRING:
449 case OPTION_FILENAME:
450 case OPTION_INTEGER:
451 case OPTION_MAGNITUDE:
452 case OPTION_CALLBACK:
453 if (opts->flags & PARSE_OPT_NOARG)
454 break;
455 if (opts->flags & PARSE_OPT_OPTARG)
456 break;
457 if (opts->flags & PARSE_OPT_LASTARG_DEFAULT)
458 break;
459 suffix = "=";
460 break;
461 default:
462 break;
464 if (opts->flags & PARSE_OPT_COMP_ARG)
465 suffix = "=";
466 printf(" --%s%s", opts->long_name, suffix);
468 fputc('\n', stdout);
469 exit(0);
472 static int usage_with_options_internal(struct parse_opt_ctx_t *,
473 const char * const *,
474 const struct option *, int, int);
476 int parse_options_step(struct parse_opt_ctx_t *ctx,
477 const struct option *options,
478 const char * const usagestr[])
480 int internal_help = !(ctx->flags & PARSE_OPT_NO_INTERNAL_HELP);
482 /* we must reset ->opt, unknown short option leave it dangling */
483 ctx->opt = NULL;
485 for (; ctx->argc; ctx->argc--, ctx->argv++) {
486 const char *arg = ctx->argv[0];
488 if (*arg != '-' || !arg[1]) {
489 if (parse_nodash_opt(ctx, arg, options) == 0)
490 continue;
491 if (ctx->flags & PARSE_OPT_STOP_AT_NON_OPTION)
492 return PARSE_OPT_NON_OPTION;
493 ctx->out[ctx->cpidx++] = ctx->argv[0];
494 continue;
497 /* lone -h asks for help */
498 if (internal_help && ctx->total == 1 && !strcmp(arg + 1, "h"))
499 goto show_usage;
501 /* lone --git-completion-helper is asked by git-completion.bash */
502 if (ctx->total == 1 && !strcmp(arg + 1, "-git-completion-helper"))
503 return show_gitcomp(ctx, options);
505 if (arg[1] != '-') {
506 ctx->opt = arg + 1;
507 switch (parse_short_opt(ctx, options)) {
508 case -1:
509 return PARSE_OPT_ERROR;
510 case -2:
511 if (ctx->opt)
512 check_typos(arg + 1, options);
513 if (internal_help && *ctx->opt == 'h')
514 goto show_usage;
515 goto unknown;
517 if (ctx->opt)
518 check_typos(arg + 1, options);
519 while (ctx->opt) {
520 switch (parse_short_opt(ctx, options)) {
521 case -1:
522 return PARSE_OPT_ERROR;
523 case -2:
524 if (internal_help && *ctx->opt == 'h')
525 goto show_usage;
527 /* fake a short option thing to hide the fact that we may have
528 * started to parse aggregated stuff
530 * This is leaky, too bad.
532 ctx->argv[0] = xstrdup(ctx->opt - 1);
533 *(char *)ctx->argv[0] = '-';
534 goto unknown;
537 continue;
540 if (!arg[2]) { /* "--" */
541 if (!(ctx->flags & PARSE_OPT_KEEP_DASHDASH)) {
542 ctx->argc--;
543 ctx->argv++;
545 break;
548 if (internal_help && !strcmp(arg + 2, "help-all"))
549 return usage_with_options_internal(ctx, usagestr, options, 1, 0);
550 if (internal_help && !strcmp(arg + 2, "help"))
551 goto show_usage;
552 switch (parse_long_opt(ctx, arg + 2, options)) {
553 case -1:
554 return PARSE_OPT_ERROR;
555 case -2:
556 goto unknown;
557 case -3:
558 goto show_usage;
560 continue;
561 unknown:
562 if (!(ctx->flags & PARSE_OPT_KEEP_UNKNOWN))
563 return PARSE_OPT_UNKNOWN;
564 ctx->out[ctx->cpidx++] = ctx->argv[0];
565 ctx->opt = NULL;
567 return PARSE_OPT_DONE;
569 show_usage:
570 return usage_with_options_internal(ctx, usagestr, options, 0, 0);
573 int parse_options_end(struct parse_opt_ctx_t *ctx)
575 MOVE_ARRAY(ctx->out + ctx->cpidx, ctx->argv, ctx->argc);
576 ctx->out[ctx->cpidx + ctx->argc] = NULL;
577 return ctx->cpidx + ctx->argc;
580 int parse_options(int argc, const char **argv, const char *prefix,
581 const struct option *options, const char * const usagestr[],
582 int flags)
584 struct parse_opt_ctx_t ctx;
586 parse_options_start(&ctx, argc, argv, prefix, options, flags);
587 switch (parse_options_step(&ctx, options, usagestr)) {
588 case PARSE_OPT_HELP:
589 case PARSE_OPT_ERROR:
590 exit(129);
591 case PARSE_OPT_NON_OPTION:
592 case PARSE_OPT_DONE:
593 break;
594 default: /* PARSE_OPT_UNKNOWN */
595 if (ctx.argv[0][1] == '-') {
596 error("unknown option `%s'", ctx.argv[0] + 2);
597 } else if (isascii(*ctx.opt)) {
598 error("unknown switch `%c'", *ctx.opt);
599 } else {
600 error("unknown non-ascii option in string: `%s'",
601 ctx.argv[0]);
603 usage_with_options(usagestr, options);
606 precompose_argv(argc, argv);
607 return parse_options_end(&ctx);
610 static int usage_argh(const struct option *opts, FILE *outfile)
612 const char *s;
613 int literal = (opts->flags & PARSE_OPT_LITERAL_ARGHELP) || !opts->argh;
614 if (opts->flags & PARSE_OPT_OPTARG)
615 if (opts->long_name)
616 s = literal ? "[=%s]" : "[=<%s>]";
617 else
618 s = literal ? "[%s]" : "[<%s>]";
619 else
620 s = literal ? " %s" : " <%s>";
621 return utf8_fprintf(outfile, s, opts->argh ? _(opts->argh) : _("..."));
624 #define USAGE_OPTS_WIDTH 24
625 #define USAGE_GAP 2
627 static int usage_with_options_internal(struct parse_opt_ctx_t *ctx,
628 const char * const *usagestr,
629 const struct option *opts, int full, int err)
631 FILE *outfile = err ? stderr : stdout;
632 int need_newline;
634 if (!usagestr)
635 return PARSE_OPT_HELP;
637 if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
638 fprintf(outfile, "cat <<\\EOF\n");
640 fprintf_ln(outfile, _("usage: %s"), _(*usagestr++));
641 while (*usagestr && **usagestr)
643 * TRANSLATORS: the colon here should align with the
644 * one in "usage: %s" translation.
646 fprintf_ln(outfile, _(" or: %s"), _(*usagestr++));
647 while (*usagestr) {
648 if (**usagestr)
649 fprintf_ln(outfile, _(" %s"), _(*usagestr));
650 else
651 fputc('\n', outfile);
652 usagestr++;
655 need_newline = 1;
657 for (; opts->type != OPTION_END; opts++) {
658 size_t pos;
659 int pad;
661 if (opts->type == OPTION_GROUP) {
662 fputc('\n', outfile);
663 need_newline = 0;
664 if (*opts->help)
665 fprintf(outfile, "%s\n", _(opts->help));
666 continue;
668 if (!full && (opts->flags & PARSE_OPT_HIDDEN))
669 continue;
671 if (need_newline) {
672 fputc('\n', outfile);
673 need_newline = 0;
676 pos = fprintf(outfile, " ");
677 if (opts->short_name) {
678 if (opts->flags & PARSE_OPT_NODASH)
679 pos += fprintf(outfile, "%c", opts->short_name);
680 else
681 pos += fprintf(outfile, "-%c", opts->short_name);
683 if (opts->long_name && opts->short_name)
684 pos += fprintf(outfile, ", ");
685 if (opts->long_name)
686 pos += fprintf(outfile, "--%s", opts->long_name);
687 if (opts->type == OPTION_NUMBER)
688 pos += utf8_fprintf(outfile, _("-NUM"));
690 if ((opts->flags & PARSE_OPT_LITERAL_ARGHELP) ||
691 !(opts->flags & PARSE_OPT_NOARG))
692 pos += usage_argh(opts, outfile);
694 if (pos <= USAGE_OPTS_WIDTH)
695 pad = USAGE_OPTS_WIDTH - pos;
696 else {
697 fputc('\n', outfile);
698 pad = USAGE_OPTS_WIDTH;
700 fprintf(outfile, "%*s%s\n", pad + USAGE_GAP, "", _(opts->help));
702 fputc('\n', outfile);
704 if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
705 fputs("EOF\n", outfile);
707 return PARSE_OPT_HELP;
710 void NORETURN usage_with_options(const char * const *usagestr,
711 const struct option *opts)
713 usage_with_options_internal(NULL, usagestr, opts, 0, 1);
714 exit(129);
717 void NORETURN usage_msg_opt(const char *msg,
718 const char * const *usagestr,
719 const struct option *options)
721 fprintf(stderr, "fatal: %s\n\n", msg);
722 usage_with_options(usagestr, options);
725 #undef opterror
726 int opterror(const struct option *opt, const char *reason, int flags)
728 if (flags & OPT_SHORT)
729 return error("switch `%c' %s", opt->short_name, reason);
730 if (flags & OPT_UNSET)
731 return error("option `no-%s' %s", opt->long_name, reason);
732 return error("option `%s' %s", opt->long_name, reason);