Merge branch 'jk/filter-branch-no-index'
[git/debian.git] / parse-options.c
blob3eceba4463b7e837cc12ee810811c8c5b8b253e7
1 #include "git-compat-util.h"
2 #include "parse-options.h"
3 #include "cache.h"
4 #include "commit.h"
5 #include "color.h"
6 #include "utf8.h"
8 static int parse_options_usage(struct parse_opt_ctx_t *ctx,
9 const char * const *usagestr,
10 const struct option *opts, int err);
12 #define OPT_SHORT 1
13 #define OPT_UNSET 2
15 int optbug(const struct option *opt, const char *reason)
17 if (opt->long_name) {
18 if (opt->short_name)
19 return error("BUG: switch '%c' (--%s) %s",
20 opt->short_name, opt->long_name, reason);
21 return error("BUG: option '%s' %s", opt->long_name, reason);
23 return error("BUG: switch '%c' %s", opt->short_name, reason);
26 static int get_arg(struct parse_opt_ctx_t *p, const struct option *opt,
27 int flags, const char **arg)
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 opterror(opt, "requires a value", flags);
39 return 0;
42 static void fix_filename(const char *prefix, const char **file)
44 if (!file || !*file || !prefix || is_absolute_path(*file)
45 || !strcmp("-", *file))
46 return;
47 *file = xstrdup(prefix_filename(prefix, strlen(prefix), *file));
50 static int opt_command_mode_error(const struct option *opt,
51 const struct option *all_opts,
52 int flags)
54 const struct option *that;
55 struct strbuf message = STRBUF_INIT;
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++) {
63 if (that == opt ||
64 that->type != OPTION_CMDMODE ||
65 that->value != opt->value ||
66 that->defval != *(int *)opt->value)
67 continue;
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 strbuf_addf(&message, ": incompatible with %s", that_name.buf);
74 strbuf_release(&that_name);
75 opterror(opt, message.buf, flags);
76 strbuf_release(&message);
77 return -1;
79 return opterror(opt, ": incompatible with something else", flags);
82 static int get_value(struct parse_opt_ctx_t *p,
83 const struct option *opt,
84 const struct option *all_opts,
85 int flags)
87 const char *s, *arg;
88 const int unset = flags & OPT_UNSET;
89 int err;
91 if (unset && p->opt)
92 return opterror(opt, "takes no value", flags);
93 if (unset && (opt->flags & PARSE_OPT_NONEG))
94 return opterror(opt, "isn't available", flags);
95 if (!(flags & OPT_SHORT) && p->opt && (opt->flags & PARSE_OPT_NOARG))
96 return opterror(opt, "takes no value", flags);
98 switch (opt->type) {
99 case OPTION_LOWLEVEL_CALLBACK:
100 return (*(parse_opt_ll_cb *)opt->callback)(p, opt, unset);
102 case OPTION_BIT:
103 if (unset)
104 *(int *)opt->value &= ~opt->defval;
105 else
106 *(int *)opt->value |= opt->defval;
107 return 0;
109 case OPTION_NEGBIT:
110 if (unset)
111 *(int *)opt->value |= opt->defval;
112 else
113 *(int *)opt->value &= ~opt->defval;
114 return 0;
116 case OPTION_COUNTUP:
117 *(int *)opt->value = unset ? 0 : *(int *)opt->value + 1;
118 return 0;
120 case OPTION_SET_INT:
121 *(int *)opt->value = unset ? 0 : opt->defval;
122 return 0;
124 case OPTION_CMDMODE:
126 * Giving the same mode option twice, although is unnecessary,
127 * is not a grave error, so let it pass.
129 if (*(int *)opt->value && *(int *)opt->value != opt->defval)
130 return opt_command_mode_error(opt, all_opts, flags);
131 *(int *)opt->value = opt->defval;
132 return 0;
134 case OPTION_STRING:
135 if (unset)
136 *(const char **)opt->value = NULL;
137 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
138 *(const char **)opt->value = (const char *)opt->defval;
139 else
140 return get_arg(p, opt, flags, (const char **)opt->value);
141 return 0;
143 case OPTION_FILENAME:
144 err = 0;
145 if (unset)
146 *(const char **)opt->value = NULL;
147 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
148 *(const char **)opt->value = (const char *)opt->defval;
149 else
150 err = get_arg(p, opt, flags, (const char **)opt->value);
152 if (!err)
153 fix_filename(p->prefix, (const char **)opt->value);
154 return err;
156 case OPTION_CALLBACK:
157 if (unset)
158 return (*opt->callback)(opt, NULL, 1) ? (-1) : 0;
159 if (opt->flags & PARSE_OPT_NOARG)
160 return (*opt->callback)(opt, NULL, 0) ? (-1) : 0;
161 if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
162 return (*opt->callback)(opt, NULL, 0) ? (-1) : 0;
163 if (get_arg(p, opt, flags, &arg))
164 return -1;
165 return (*opt->callback)(opt, arg, 0) ? (-1) : 0;
167 case OPTION_INTEGER:
168 if (unset) {
169 *(int *)opt->value = 0;
170 return 0;
172 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
173 *(int *)opt->value = opt->defval;
174 return 0;
176 if (get_arg(p, opt, flags, &arg))
177 return -1;
178 *(int *)opt->value = strtol(arg, (char **)&s, 10);
179 if (*s)
180 return opterror(opt, "expects a numerical value", flags);
181 return 0;
183 case OPTION_MAGNITUDE:
184 if (unset) {
185 *(unsigned long *)opt->value = 0;
186 return 0;
188 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
189 *(unsigned long *)opt->value = opt->defval;
190 return 0;
192 if (get_arg(p, opt, flags, &arg))
193 return -1;
194 if (!git_parse_ulong(arg, opt->value))
195 return opterror(opt,
196 "expects a non-negative integer value with an optional k/m/g suffix",
197 flags);
198 return 0;
200 default:
201 die("should not happen, someone must be hit on the forehead");
205 static int parse_short_opt(struct parse_opt_ctx_t *p, const struct option *options)
207 const struct option *all_opts = options;
208 const struct option *numopt = NULL;
210 for (; options->type != OPTION_END; options++) {
211 if (options->short_name == *p->opt) {
212 p->opt = p->opt[1] ? p->opt + 1 : NULL;
213 return get_value(p, options, all_opts, OPT_SHORT);
217 * Handle the numerical option later, explicit one-digit
218 * options take precedence over it.
220 if (options->type == OPTION_NUMBER)
221 numopt = options;
223 if (numopt && isdigit(*p->opt)) {
224 size_t len = 1;
225 char *arg;
226 int rc;
228 while (isdigit(p->opt[len]))
229 len++;
230 arg = xmemdupz(p->opt, len);
231 p->opt = p->opt[len] ? p->opt + len : NULL;
232 rc = (*numopt->callback)(numopt, arg, 0) ? (-1) : 0;
233 free(arg);
234 return rc;
236 return -2;
239 static int parse_long_opt(struct parse_opt_ctx_t *p, const char *arg,
240 const struct option *options)
242 const struct option *all_opts = options;
243 const char *arg_end = strchrnul(arg, '=');
244 const struct option *abbrev_option = NULL, *ambiguous_option = NULL;
245 int abbrev_flags = 0, ambiguous_flags = 0;
247 for (; options->type != OPTION_END; options++) {
248 const char *rest, *long_name = options->long_name;
249 int flags = 0, opt_flags = 0;
251 if (!long_name)
252 continue;
254 again:
255 if (!skip_prefix(arg, long_name, &rest))
256 rest = NULL;
257 if (options->type == OPTION_ARGUMENT) {
258 if (!rest)
259 continue;
260 if (*rest == '=')
261 return opterror(options, "takes no value", flags);
262 if (*rest)
263 continue;
264 p->out[p->cpidx++] = arg - 2;
265 return 0;
267 if (!rest) {
268 /* abbreviated? */
269 if (!strncmp(long_name, arg, arg_end - arg)) {
270 is_abbreviated:
271 if (abbrev_option) {
273 * If this is abbreviated, it is
274 * ambiguous. So when there is no
275 * exact match later, we need to
276 * error out.
278 ambiguous_option = abbrev_option;
279 ambiguous_flags = abbrev_flags;
281 if (!(flags & OPT_UNSET) && *arg_end)
282 p->opt = arg_end + 1;
283 abbrev_option = options;
284 abbrev_flags = flags ^ opt_flags;
285 continue;
287 /* negation allowed? */
288 if (options->flags & PARSE_OPT_NONEG)
289 continue;
290 /* negated and abbreviated very much? */
291 if (starts_with("no-", arg)) {
292 flags |= OPT_UNSET;
293 goto is_abbreviated;
295 /* negated? */
296 if (!starts_with(arg, "no-")) {
297 if (starts_with(long_name, "no-")) {
298 long_name += 3;
299 opt_flags |= OPT_UNSET;
300 goto again;
302 continue;
304 flags |= OPT_UNSET;
305 if (!skip_prefix(arg + 3, long_name, &rest)) {
306 /* abbreviated and negated? */
307 if (starts_with(long_name, arg + 3))
308 goto is_abbreviated;
309 else
310 continue;
313 if (*rest) {
314 if (*rest != '=')
315 continue;
316 p->opt = rest + 1;
318 return get_value(p, options, all_opts, flags ^ opt_flags);
321 if (ambiguous_option)
322 return error("Ambiguous option: %s "
323 "(could be --%s%s or --%s%s)",
324 arg,
325 (ambiguous_flags & OPT_UNSET) ? "no-" : "",
326 ambiguous_option->long_name,
327 (abbrev_flags & OPT_UNSET) ? "no-" : "",
328 abbrev_option->long_name);
329 if (abbrev_option)
330 return get_value(p, abbrev_option, all_opts, abbrev_flags);
331 return -2;
334 static int parse_nodash_opt(struct parse_opt_ctx_t *p, const char *arg,
335 const struct option *options)
337 const struct option *all_opts = options;
339 for (; options->type != OPTION_END; options++) {
340 if (!(options->flags & PARSE_OPT_NODASH))
341 continue;
342 if (options->short_name == arg[0] && arg[1] == '\0')
343 return get_value(p, options, all_opts, OPT_SHORT);
345 return -2;
348 static void check_typos(const char *arg, const struct option *options)
350 if (strlen(arg) < 3)
351 return;
353 if (starts_with(arg, "no-")) {
354 error ("did you mean `--%s` (with two dashes ?)", arg);
355 exit(129);
358 for (; options->type != OPTION_END; options++) {
359 if (!options->long_name)
360 continue;
361 if (starts_with(options->long_name, arg)) {
362 error ("did you mean `--%s` (with two dashes ?)", arg);
363 exit(129);
368 static void parse_options_check(const struct option *opts)
370 int err = 0;
371 char short_opts[128];
373 memset(short_opts, '\0', sizeof(short_opts));
374 for (; opts->type != OPTION_END; opts++) {
375 if ((opts->flags & PARSE_OPT_LASTARG_DEFAULT) &&
376 (opts->flags & PARSE_OPT_OPTARG))
377 err |= optbug(opts, "uses incompatible flags "
378 "LASTARG_DEFAULT and OPTARG");
379 if (opts->short_name) {
380 if (0x7F <= opts->short_name)
381 err |= optbug(opts, "invalid short name");
382 else if (short_opts[opts->short_name]++)
383 err |= optbug(opts, "short name already used");
385 if (opts->flags & PARSE_OPT_NODASH &&
386 ((opts->flags & PARSE_OPT_OPTARG) ||
387 !(opts->flags & PARSE_OPT_NOARG) ||
388 !(opts->flags & PARSE_OPT_NONEG) ||
389 opts->long_name))
390 err |= optbug(opts, "uses feature "
391 "not supported for dashless options");
392 switch (opts->type) {
393 case OPTION_COUNTUP:
394 case OPTION_BIT:
395 case OPTION_NEGBIT:
396 case OPTION_SET_INT:
397 case OPTION_NUMBER:
398 if ((opts->flags & PARSE_OPT_OPTARG) ||
399 !(opts->flags & PARSE_OPT_NOARG))
400 err |= optbug(opts, "should not accept an argument");
401 default:
402 ; /* ok. (usually accepts an argument) */
404 if (opts->argh &&
405 strcspn(opts->argh, " _") != strlen(opts->argh))
406 err |= optbug(opts, "multi-word argh should use dash to separate words");
408 if (err)
409 exit(128);
412 void parse_options_start(struct parse_opt_ctx_t *ctx,
413 int argc, const char **argv, const char *prefix,
414 const struct option *options, int flags)
416 memset(ctx, 0, sizeof(*ctx));
417 ctx->argc = argc - 1;
418 ctx->argv = argv + 1;
419 ctx->out = argv;
420 ctx->prefix = prefix;
421 ctx->cpidx = ((flags & PARSE_OPT_KEEP_ARGV0) != 0);
422 ctx->flags = flags;
423 if ((flags & PARSE_OPT_KEEP_UNKNOWN) &&
424 (flags & PARSE_OPT_STOP_AT_NON_OPTION))
425 die("STOP_AT_NON_OPTION and KEEP_UNKNOWN don't go together");
426 parse_options_check(options);
429 static int usage_with_options_internal(struct parse_opt_ctx_t *,
430 const char * const *,
431 const struct option *, int, int);
433 int parse_options_step(struct parse_opt_ctx_t *ctx,
434 const struct option *options,
435 const char * const usagestr[])
437 int internal_help = !(ctx->flags & PARSE_OPT_NO_INTERNAL_HELP);
439 /* we must reset ->opt, unknown short option leave it dangling */
440 ctx->opt = NULL;
442 for (; ctx->argc; ctx->argc--, ctx->argv++) {
443 const char *arg = ctx->argv[0];
445 if (*arg != '-' || !arg[1]) {
446 if (parse_nodash_opt(ctx, arg, options) == 0)
447 continue;
448 if (ctx->flags & PARSE_OPT_STOP_AT_NON_OPTION)
449 return PARSE_OPT_NON_OPTION;
450 ctx->out[ctx->cpidx++] = ctx->argv[0];
451 continue;
454 if (arg[1] != '-') {
455 ctx->opt = arg + 1;
456 if (internal_help && *ctx->opt == 'h')
457 return parse_options_usage(ctx, usagestr, options, 0);
458 switch (parse_short_opt(ctx, options)) {
459 case -1:
460 return parse_options_usage(ctx, usagestr, options, 1);
461 case -2:
462 if (ctx->opt)
463 check_typos(arg + 1, options);
464 goto unknown;
466 if (ctx->opt)
467 check_typos(arg + 1, options);
468 while (ctx->opt) {
469 if (internal_help && *ctx->opt == 'h')
470 return parse_options_usage(ctx, usagestr, options, 0);
471 switch (parse_short_opt(ctx, options)) {
472 case -1:
473 return parse_options_usage(ctx, usagestr, options, 1);
474 case -2:
475 /* fake a short option thing to hide the fact that we may have
476 * started to parse aggregated stuff
478 * This is leaky, too bad.
480 ctx->argv[0] = xstrdup(ctx->opt - 1);
481 *(char *)ctx->argv[0] = '-';
482 goto unknown;
485 continue;
488 if (!arg[2]) { /* "--" */
489 if (!(ctx->flags & PARSE_OPT_KEEP_DASHDASH)) {
490 ctx->argc--;
491 ctx->argv++;
493 break;
496 if (internal_help && !strcmp(arg + 2, "help-all"))
497 return usage_with_options_internal(ctx, usagestr, options, 1, 0);
498 if (internal_help && !strcmp(arg + 2, "help"))
499 return parse_options_usage(ctx, usagestr, options, 0);
500 switch (parse_long_opt(ctx, arg + 2, options)) {
501 case -1:
502 return parse_options_usage(ctx, usagestr, options, 1);
503 case -2:
504 goto unknown;
506 continue;
507 unknown:
508 if (!(ctx->flags & PARSE_OPT_KEEP_UNKNOWN))
509 return PARSE_OPT_UNKNOWN;
510 ctx->out[ctx->cpidx++] = ctx->argv[0];
511 ctx->opt = NULL;
513 return PARSE_OPT_DONE;
516 int parse_options_end(struct parse_opt_ctx_t *ctx)
518 memmove(ctx->out + ctx->cpidx, ctx->argv, ctx->argc * sizeof(*ctx->out));
519 ctx->out[ctx->cpidx + ctx->argc] = NULL;
520 return ctx->cpidx + ctx->argc;
523 int parse_options(int argc, const char **argv, const char *prefix,
524 const struct option *options, const char * const usagestr[],
525 int flags)
527 struct parse_opt_ctx_t ctx;
529 parse_options_start(&ctx, argc, argv, prefix, options, flags);
530 switch (parse_options_step(&ctx, options, usagestr)) {
531 case PARSE_OPT_HELP:
532 exit(129);
533 case PARSE_OPT_NON_OPTION:
534 case PARSE_OPT_DONE:
535 break;
536 default: /* PARSE_OPT_UNKNOWN */
537 if (ctx.argv[0][1] == '-') {
538 error("unknown option `%s'", ctx.argv[0] + 2);
539 } else if (isascii(*ctx.opt)) {
540 error("unknown switch `%c'", *ctx.opt);
541 } else {
542 error("unknown non-ascii option in string: `%s'",
543 ctx.argv[0]);
545 usage_with_options(usagestr, options);
548 precompose_argv(argc, argv);
549 return parse_options_end(&ctx);
552 static int usage_argh(const struct option *opts, FILE *outfile)
554 const char *s;
555 int literal = (opts->flags & PARSE_OPT_LITERAL_ARGHELP) || !opts->argh;
556 if (opts->flags & PARSE_OPT_OPTARG)
557 if (opts->long_name)
558 s = literal ? "[=%s]" : "[=<%s>]";
559 else
560 s = literal ? "[%s]" : "[<%s>]";
561 else
562 s = literal ? " %s" : " <%s>";
563 return utf8_fprintf(outfile, s, opts->argh ? _(opts->argh) : _("..."));
566 #define USAGE_OPTS_WIDTH 24
567 #define USAGE_GAP 2
569 static int usage_with_options_internal(struct parse_opt_ctx_t *ctx,
570 const char * const *usagestr,
571 const struct option *opts, int full, int err)
573 FILE *outfile = err ? stderr : stdout;
575 if (!usagestr)
576 return PARSE_OPT_HELP;
578 if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
579 fprintf(outfile, "cat <<\\EOF\n");
581 fprintf_ln(outfile, _("usage: %s"), _(*usagestr++));
582 while (*usagestr && **usagestr)
583 /* TRANSLATORS: the colon here should align with the
584 one in "usage: %s" translation */
585 fprintf_ln(outfile, _(" or: %s"), _(*usagestr++));
586 while (*usagestr) {
587 if (**usagestr)
588 fprintf_ln(outfile, _(" %s"), _(*usagestr));
589 else
590 putchar('\n');
591 usagestr++;
594 if (opts->type != OPTION_GROUP)
595 fputc('\n', outfile);
597 for (; opts->type != OPTION_END; opts++) {
598 size_t pos;
599 int pad;
601 if (opts->type == OPTION_GROUP) {
602 fputc('\n', outfile);
603 if (*opts->help)
604 fprintf(outfile, "%s\n", _(opts->help));
605 continue;
607 if (!full && (opts->flags & PARSE_OPT_HIDDEN))
608 continue;
610 pos = fprintf(outfile, " ");
611 if (opts->short_name) {
612 if (opts->flags & PARSE_OPT_NODASH)
613 pos += fprintf(outfile, "%c", opts->short_name);
614 else
615 pos += fprintf(outfile, "-%c", opts->short_name);
617 if (opts->long_name && opts->short_name)
618 pos += fprintf(outfile, ", ");
619 if (opts->long_name)
620 pos += fprintf(outfile, "--%s", opts->long_name);
621 if (opts->type == OPTION_NUMBER)
622 pos += utf8_fprintf(outfile, _("-NUM"));
624 if ((opts->flags & PARSE_OPT_LITERAL_ARGHELP) ||
625 !(opts->flags & PARSE_OPT_NOARG))
626 pos += usage_argh(opts, outfile);
628 if (pos <= USAGE_OPTS_WIDTH)
629 pad = USAGE_OPTS_WIDTH - pos;
630 else {
631 fputc('\n', outfile);
632 pad = USAGE_OPTS_WIDTH;
634 fprintf(outfile, "%*s%s\n", pad + USAGE_GAP, "", _(opts->help));
636 fputc('\n', outfile);
638 if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
639 fputs("EOF\n", outfile);
641 return PARSE_OPT_HELP;
644 void NORETURN usage_with_options(const char * const *usagestr,
645 const struct option *opts)
647 usage_with_options_internal(NULL, usagestr, opts, 0, 1);
648 exit(129);
651 void NORETURN usage_msg_opt(const char *msg,
652 const char * const *usagestr,
653 const struct option *options)
655 fprintf(stderr, "%s\n\n", msg);
656 usage_with_options(usagestr, options);
659 static int parse_options_usage(struct parse_opt_ctx_t *ctx,
660 const char * const *usagestr,
661 const struct option *opts, int err)
663 return usage_with_options_internal(ctx, usagestr, opts, 0, err);
666 #undef opterror
667 int opterror(const struct option *opt, const char *reason, int flags)
669 if (flags & OPT_SHORT)
670 return error("switch `%c' %s", opt->short_name, reason);
671 if (flags & OPT_UNSET)
672 return error("option `no-%s' %s", opt->long_name, reason);
673 return error("option `%s' %s", opt->long_name, reason);