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"
8
9#define OPT_SHORT 1
10#define OPT_UNSET 2
11
12int optbug(const struct option *opt, const char *reason)
13{
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);
19 }
20 return error("BUG: switch '%c' %s", opt->short_name, reason);
21}
22
23static int get_arg(struct parse_opt_ctx_t *p, const struct option *opt,
24 int flags, const char **arg)
25{
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;
37}
38
39static void fix_filename(const char *prefix, const char **file)
40{
41 if (!file || !*file || !prefix || is_absolute_path(*file)
42 || !strcmp("-", *file))
43 return;
44 *file = prefix_filename(prefix, *file);
45}
46
47static int opt_command_mode_error(const struct option *opt,
48 const struct option *all_opts,
49 int flags)
50{
51 const struct option *that;
52 struct strbuf message = STRBUF_INIT;
53 struct strbuf that_name = STRBUF_INIT;
54
55 /*
56 * Find the other option that was used to set the variable
57 * already, and report that this is not compatible with it.
58 */
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;
65
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;
75 }
76 return opterror(opt, ": incompatible with something else", flags);
77}
78
79static int get_value(struct parse_opt_ctx_t *p,
80 const struct option *opt,
81 const struct option *all_opts,
82 int flags)
83{
84 const char *s, *arg;
85 const int unset = flags & OPT_UNSET;
86 int err;
87
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);
94
95 switch (opt->type) {
96 case OPTION_LOWLEVEL_CALLBACK:
97 return (*(parse_opt_ll_cb *)opt->callback)(p, opt, unset);
98
99 case OPTION_BIT:
100 if (unset)
101 *(int *)opt->value &= ~opt->defval;
102 else
103 *(int *)opt->value |= opt->defval;
104 return 0;
105
106 case OPTION_NEGBIT:
107 if (unset)
108 *(int *)opt->value |= opt->defval;
109 else
110 *(int *)opt->value &= ~opt->defval;
111 return 0;
112
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;
118
119 case OPTION_SET_INT:
120 *(int *)opt->value = unset ? 0 : opt->defval;
121 return 0;
122
123 case OPTION_CMDMODE:
124 /*
125 * Giving the same mode option twice, although is unnecessary,
126 * is not a grave error, so let it pass.
127 */
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;
132
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;
141
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);
150
151 if (!err)
152 fix_filename(p->prefix, (const char **)opt->value);
153 return err;
154
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;
165
166 case OPTION_INTEGER:
167 if (unset) {
168 *(int *)opt->value = 0;
169 return 0;
170 }
171 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
172 *(int *)opt->value = opt->defval;
173 return 0;
174 }
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;
181
182 case OPTION_MAGNITUDE:
183 if (unset) {
184 *(unsigned long *)opt->value = 0;
185 return 0;
186 }
187 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
188 *(unsigned long *)opt->value = opt->defval;
189 return 0;
190 }
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;
198
199 default:
200 die("should not happen, someone must be hit on the forehead");
201 }
202}
203
204static int parse_short_opt(struct parse_opt_ctx_t *p, const struct option *options)
205{
206 const struct option *all_opts = options;
207 const struct option *numopt = NULL;
208
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);
213 }
214
215 /*
216 * Handle the numerical option later, explicit one-digit
217 * options take precedence over it.
218 */
219 if (options->type == OPTION_NUMBER)
220 numopt = options;
221 }
222 if (numopt && isdigit(*p->opt)) {
223 size_t len = 1;
224 char *arg;
225 int rc;
226
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;
234 }
235 return -2;
236}
237
238static int parse_long_opt(struct parse_opt_ctx_t *p, const char *arg,
239 const struct option *options)
240{
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;
245
246 for (; options->type != OPTION_END; options++) {
247 const char *rest, *long_name = options->long_name;
248 int flags = 0, opt_flags = 0;
249
250 if (!long_name)
251 continue;
252
253again:
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;
265 }
266 if (!rest) {
267 /* abbreviated? */
268 if (!strncmp(long_name, arg, arg_end - arg)) {
269is_abbreviated:
270 if (abbrev_option) {
271 /*
272 * If this is abbreviated, it is
273 * ambiguous. So when there is no
274 * exact match later, we need to
275 * error out.
276 */
277 ambiguous_option = abbrev_option;
278 ambiguous_flags = abbrev_flags;
279 }
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;
285 }
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;
293 }
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;
300 }
301 continue;
302 }
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;
310 }
311 }
312 if (*rest) {
313 if (*rest != '=')
314 continue;
315 p->opt = rest + 1;
316 }
317 return get_value(p, options, all_opts, flags ^ opt_flags);
318 }
319
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;
329 }
330 if (abbrev_option)
331 return get_value(p, abbrev_option, all_opts, abbrev_flags);
332 return -2;
333}
334
335static int parse_nodash_opt(struct parse_opt_ctx_t *p, const char *arg,
336 const struct option *options)
337{
338 const struct option *all_opts = options;
339
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);
345 }
346 return -2;
347}
348
349static void check_typos(const char *arg, const struct option *options)
350{
351 if (strlen(arg) < 3)
352 return;
353
354 if (starts_with(arg, "no-")) {
355 error ("did you mean `--%s` (with two dashes ?)", arg);
356 exit(129);
357 }
358
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);
365 }
366 }
367}
368
369static void parse_options_check(const struct option *opts)
370{
371 int err = 0;
372 char short_opts[128];
373
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");
385 }
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) */
404 }
405 if (opts->argh &&
406 strcspn(opts->argh, " _") != strlen(opts->argh))
407 err |= optbug(opts, "multi-word argh should use dash to separate words");
408 }
409 if (err)
410 exit(128);
411}
412
413void 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)
416{
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);
428}
429
430static int usage_with_options_internal(struct parse_opt_ctx_t *,
431 const char * const *,
432 const struct option *, int, int);
433
434int parse_options_step(struct parse_opt_ctx_t *ctx,
435 const struct option *options,
436 const char * const usagestr[])
437{
438 int internal_help = !(ctx->flags & PARSE_OPT_NO_INTERNAL_HELP);
439
440 /* we must reset ->opt, unknown short option leave it dangling */
441 ctx->opt = NULL;
442
443 for (; ctx->argc; ctx->argc--, ctx->argv++) {
444 const char *arg = ctx->argv[0];
445
446 if (*arg != '-' || !arg[1]) {
447 if (parse_nodash_opt(ctx, arg, options) == 0)
448 continue;
449 if (ctx->flags & PARSE_OPT_STOP_AT_NON_OPTION)
450 return PARSE_OPT_NON_OPTION;
451 ctx->out[ctx->cpidx++] = ctx->argv[0];
452 continue;
453 }
454
455 /* lone -h asks for help */
456 if (internal_help && ctx->total == 1 && !strcmp(arg + 1, "h"))
457 goto show_usage;
458
459 if (arg[1] != '-') {
460 ctx->opt = arg + 1;
461 switch (parse_short_opt(ctx, options)) {
462 case -1:
463 return PARSE_OPT_ERROR;
464 case -2:
465 if (ctx->opt)
466 check_typos(arg + 1, options);
467 if (internal_help && *ctx->opt == 'h')
468 goto show_usage;
469 goto unknown;
470 }
471 if (ctx->opt)
472 check_typos(arg + 1, options);
473 while (ctx->opt) {
474 switch (parse_short_opt(ctx, options)) {
475 case -1:
476 return PARSE_OPT_ERROR;
477 case -2:
478 if (internal_help && *ctx->opt == 'h')
479 goto show_usage;
480
481 /* fake a short option thing to hide the fact that we may have
482 * started to parse aggregated stuff
483 *
484 * This is leaky, too bad.
485 */
486 ctx->argv[0] = xstrdup(ctx->opt - 1);
487 *(char *)ctx->argv[0] = '-';
488 goto unknown;
489 }
490 }
491 continue;
492 }
493
494 if (!arg[2]) { /* "--" */
495 if (!(ctx->flags & PARSE_OPT_KEEP_DASHDASH)) {
496 ctx->argc--;
497 ctx->argv++;
498 }
499 break;
500 }
501
502 if (internal_help && !strcmp(arg + 2, "help-all"))
503 return usage_with_options_internal(ctx, usagestr, options, 1, 0);
504 if (internal_help && !strcmp(arg + 2, "help"))
505 goto show_usage;
506 switch (parse_long_opt(ctx, arg + 2, options)) {
507 case -1:
508 return PARSE_OPT_ERROR;
509 case -2:
510 goto unknown;
511 case -3:
512 goto show_usage;
513 }
514 continue;
515unknown:
516 if (!(ctx->flags & PARSE_OPT_KEEP_UNKNOWN))
517 return PARSE_OPT_UNKNOWN;
518 ctx->out[ctx->cpidx++] = ctx->argv[0];
519 ctx->opt = NULL;
520 }
521 return PARSE_OPT_DONE;
522
523 show_usage:
524 return usage_with_options_internal(ctx, usagestr, options, 0, 0);
525}
526
527int parse_options_end(struct parse_opt_ctx_t *ctx)
528{
529 memmove(ctx->out + ctx->cpidx, ctx->argv, ctx->argc * sizeof(*ctx->out));
530 ctx->out[ctx->cpidx + ctx->argc] = NULL;
531 return ctx->cpidx + ctx->argc;
532}
533
534int parse_options(int argc, const char **argv, const char *prefix,
535 const struct option *options, const char * const usagestr[],
536 int flags)
537{
538 struct parse_opt_ctx_t ctx;
539
540 parse_options_start(&ctx, argc, argv, prefix, options, flags);
541 switch (parse_options_step(&ctx, options, usagestr)) {
542 case PARSE_OPT_HELP:
543 case PARSE_OPT_ERROR:
544 exit(129);
545 case PARSE_OPT_NON_OPTION:
546 case PARSE_OPT_DONE:
547 break;
548 default: /* PARSE_OPT_UNKNOWN */
549 if (ctx.argv[0][1] == '-') {
550 error("unknown option `%s'", ctx.argv[0] + 2);
551 } else if (isascii(*ctx.opt)) {
552 error("unknown switch `%c'", *ctx.opt);
553 } else {
554 error("unknown non-ascii option in string: `%s'",
555 ctx.argv[0]);
556 }
557 usage_with_options(usagestr, options);
558 }
559
560 precompose_argv(argc, argv);
561 return parse_options_end(&ctx);
562}
563
564static int usage_argh(const struct option *opts, FILE *outfile)
565{
566 const char *s;
567 int literal = (opts->flags & PARSE_OPT_LITERAL_ARGHELP) || !opts->argh;
568 if (opts->flags & PARSE_OPT_OPTARG)
569 if (opts->long_name)
570 s = literal ? "[=%s]" : "[=<%s>]";
571 else
572 s = literal ? "[%s]" : "[<%s>]";
573 else
574 s = literal ? " %s" : " <%s>";
575 return utf8_fprintf(outfile, s, opts->argh ? _(opts->argh) : _("..."));
576}
577
578#define USAGE_OPTS_WIDTH 24
579#define USAGE_GAP 2
580
581static int usage_with_options_internal(struct parse_opt_ctx_t *ctx,
582 const char * const *usagestr,
583 const struct option *opts, int full, int err)
584{
585 FILE *outfile = err ? stderr : stdout;
586 int need_newline;
587
588 if (!usagestr)
589 return PARSE_OPT_HELP;
590
591 if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
592 fprintf(outfile, "cat <<\\EOF\n");
593
594 fprintf_ln(outfile, _("usage: %s"), _(*usagestr++));
595 while (*usagestr && **usagestr)
596 /*
597 * TRANSLATORS: the colon here should align with the
598 * one in "usage: %s" translation.
599 */
600 fprintf_ln(outfile, _(" or: %s"), _(*usagestr++));
601 while (*usagestr) {
602 if (**usagestr)
603 fprintf_ln(outfile, _(" %s"), _(*usagestr));
604 else
605 fputc('\n', outfile);
606 usagestr++;
607 }
608
609 need_newline = 1;
610
611 for (; opts->type != OPTION_END; opts++) {
612 size_t pos;
613 int pad;
614
615 if (opts->type == OPTION_GROUP) {
616 fputc('\n', outfile);
617 need_newline = 0;
618 if (*opts->help)
619 fprintf(outfile, "%s\n", _(opts->help));
620 continue;
621 }
622 if (!full && (opts->flags & PARSE_OPT_HIDDEN))
623 continue;
624
625 if (need_newline) {
626 fputc('\n', outfile);
627 need_newline = 0;
628 }
629
630 pos = fprintf(outfile, " ");
631 if (opts->short_name) {
632 if (opts->flags & PARSE_OPT_NODASH)
633 pos += fprintf(outfile, "%c", opts->short_name);
634 else
635 pos += fprintf(outfile, "-%c", opts->short_name);
636 }
637 if (opts->long_name && opts->short_name)
638 pos += fprintf(outfile, ", ");
639 if (opts->long_name)
640 pos += fprintf(outfile, "--%s", opts->long_name);
641 if (opts->type == OPTION_NUMBER)
642 pos += utf8_fprintf(outfile, _("-NUM"));
643
644 if ((opts->flags & PARSE_OPT_LITERAL_ARGHELP) ||
645 !(opts->flags & PARSE_OPT_NOARG))
646 pos += usage_argh(opts, outfile);
647
648 if (pos <= USAGE_OPTS_WIDTH)
649 pad = USAGE_OPTS_WIDTH - pos;
650 else {
651 fputc('\n', outfile);
652 pad = USAGE_OPTS_WIDTH;
653 }
654 fprintf(outfile, "%*s%s\n", pad + USAGE_GAP, "", _(opts->help));
655 }
656 fputc('\n', outfile);
657
658 if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
659 fputs("EOF\n", outfile);
660
661 return PARSE_OPT_HELP;
662}
663
664void NORETURN usage_with_options(const char * const *usagestr,
665 const struct option *opts)
666{
667 usage_with_options_internal(NULL, usagestr, opts, 0, 1);
668 exit(129);
669}
670
671void NORETURN usage_msg_opt(const char *msg,
672 const char * const *usagestr,
673 const struct option *options)
674{
675 fprintf(stderr, "fatal: %s\n\n", msg);
676 usage_with_options(usagestr, options);
677}
678
679#undef opterror
680int opterror(const struct option *opt, const char *reason, int flags)
681{
682 if (flags & OPT_SHORT)
683 return error("switch `%c' %s", opt->short_name, reason);
684 if (flags & OPT_UNSET)
685 return error("option `no-%s' %s", opt->long_name, reason);
686 return error("option `%s' %s", opt->long_name, reason);
687}