]> git.ipfire.org Git - thirdparty/git.git/blob - parse-options.c
parse-options: Don't call parse_options_check() so much
[thirdparty/git.git] / parse-options.c
1 #include "git-compat-util.h"
2 #include "parse-options.h"
3 #include "cache.h"
4 #include "commit.h"
5 #include "color.h"
6
7 static int parse_options_usage(struct parse_opt_ctx_t *ctx,
8 const char * const *usagestr,
9 const struct option *opts, int err);
10
11 #define OPT_SHORT 1
12 #define OPT_UNSET 2
13
14 static int opterror(const struct option *opt, const char *reason, int flags)
15 {
16 if (flags & OPT_SHORT)
17 return error("switch `%c' %s", opt->short_name, reason);
18 if (flags & OPT_UNSET)
19 return error("option `no-%s' %s", opt->long_name, reason);
20 return error("option `%s' %s", opt->long_name, reason);
21 }
22
23 static 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
39 static 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 = xstrdup(prefix_filename(prefix, strlen(prefix), *file));
45 }
46
47 static int get_value(struct parse_opt_ctx_t *p,
48 const struct option *opt, int flags)
49 {
50 const char *s, *arg;
51 const int unset = flags & OPT_UNSET;
52 int err;
53
54 if (unset && p->opt)
55 return opterror(opt, "takes no value", flags);
56 if (unset && (opt->flags & PARSE_OPT_NONEG))
57 return opterror(opt, "isn't available", flags);
58
59 if (!(flags & OPT_SHORT) && p->opt) {
60 switch (opt->type) {
61 case OPTION_CALLBACK:
62 if (!(opt->flags & PARSE_OPT_NOARG))
63 break;
64 /* FALLTHROUGH */
65 case OPTION_BOOLEAN:
66 case OPTION_BIT:
67 case OPTION_NEGBIT:
68 case OPTION_SET_INT:
69 case OPTION_SET_PTR:
70 return opterror(opt, "takes no value", flags);
71 default:
72 break;
73 }
74 }
75
76 switch (opt->type) {
77 case OPTION_BIT:
78 if (unset)
79 *(int *)opt->value &= ~opt->defval;
80 else
81 *(int *)opt->value |= opt->defval;
82 return 0;
83
84 case OPTION_NEGBIT:
85 if (unset)
86 *(int *)opt->value |= opt->defval;
87 else
88 *(int *)opt->value &= ~opt->defval;
89 return 0;
90
91 case OPTION_BOOLEAN:
92 *(int *)opt->value = unset ? 0 : *(int *)opt->value + 1;
93 return 0;
94
95 case OPTION_SET_INT:
96 *(int *)opt->value = unset ? 0 : opt->defval;
97 return 0;
98
99 case OPTION_SET_PTR:
100 *(void **)opt->value = unset ? NULL : (void *)opt->defval;
101 return 0;
102
103 case OPTION_STRING:
104 if (unset)
105 *(const char **)opt->value = NULL;
106 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
107 *(const char **)opt->value = (const char *)opt->defval;
108 else
109 return get_arg(p, opt, flags, (const char **)opt->value);
110 return 0;
111
112 case OPTION_FILENAME:
113 err = 0;
114 if (unset)
115 *(const char **)opt->value = NULL;
116 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
117 *(const char **)opt->value = (const char *)opt->defval;
118 else
119 err = get_arg(p, opt, flags, (const char **)opt->value);
120
121 if (!err)
122 fix_filename(p->prefix, (const char **)opt->value);
123 return err;
124
125 case OPTION_CALLBACK:
126 if (unset)
127 return (*opt->callback)(opt, NULL, 1) ? (-1) : 0;
128 if (opt->flags & PARSE_OPT_NOARG)
129 return (*opt->callback)(opt, NULL, 0) ? (-1) : 0;
130 if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
131 return (*opt->callback)(opt, NULL, 0) ? (-1) : 0;
132 if (get_arg(p, opt, flags, &arg))
133 return -1;
134 return (*opt->callback)(opt, arg, 0) ? (-1) : 0;
135
136 case OPTION_INTEGER:
137 if (unset) {
138 *(int *)opt->value = 0;
139 return 0;
140 }
141 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
142 *(int *)opt->value = opt->defval;
143 return 0;
144 }
145 if (get_arg(p, opt, flags, &arg))
146 return -1;
147 *(int *)opt->value = strtol(arg, (char **)&s, 10);
148 if (*s)
149 return opterror(opt, "expects a numerical value", flags);
150 return 0;
151
152 default:
153 die("should not happen, someone must be hit on the forehead");
154 }
155 }
156
157 static int parse_short_opt(struct parse_opt_ctx_t *p, const struct option *options)
158 {
159 const struct option *numopt = NULL;
160
161 for (; options->type != OPTION_END; options++) {
162 if (options->short_name == *p->opt) {
163 p->opt = p->opt[1] ? p->opt + 1 : NULL;
164 return get_value(p, options, OPT_SHORT);
165 }
166
167 /*
168 * Handle the numerical option later, explicit one-digit
169 * options take precedence over it.
170 */
171 if (options->type == OPTION_NUMBER)
172 numopt = options;
173 }
174 if (numopt && isdigit(*p->opt)) {
175 size_t len = 1;
176 char *arg;
177 int rc;
178
179 while (isdigit(p->opt[len]))
180 len++;
181 arg = xmemdupz(p->opt, len);
182 p->opt = p->opt[len] ? p->opt + len : NULL;
183 rc = (*numopt->callback)(numopt, arg, 0) ? (-1) : 0;
184 free(arg);
185 return rc;
186 }
187 return -2;
188 }
189
190 static int parse_long_opt(struct parse_opt_ctx_t *p, const char *arg,
191 const struct option *options)
192 {
193 const char *arg_end = strchr(arg, '=');
194 const struct option *abbrev_option = NULL, *ambiguous_option = NULL;
195 int abbrev_flags = 0, ambiguous_flags = 0;
196
197 if (!arg_end)
198 arg_end = arg + strlen(arg);
199
200 for (; options->type != OPTION_END; options++) {
201 const char *rest;
202 int flags = 0;
203
204 if (!options->long_name)
205 continue;
206
207 rest = skip_prefix(arg, options->long_name);
208 if (options->type == OPTION_ARGUMENT) {
209 if (!rest)
210 continue;
211 if (*rest == '=')
212 return opterror(options, "takes no value", flags);
213 if (*rest)
214 continue;
215 p->out[p->cpidx++] = arg - 2;
216 return 0;
217 }
218 if (!rest) {
219 /* abbreviated? */
220 if (!strncmp(options->long_name, arg, arg_end - arg)) {
221 is_abbreviated:
222 if (abbrev_option) {
223 /*
224 * If this is abbreviated, it is
225 * ambiguous. So when there is no
226 * exact match later, we need to
227 * error out.
228 */
229 ambiguous_option = abbrev_option;
230 ambiguous_flags = abbrev_flags;
231 }
232 if (!(flags & OPT_UNSET) && *arg_end)
233 p->opt = arg_end + 1;
234 abbrev_option = options;
235 abbrev_flags = flags;
236 continue;
237 }
238 /* negation allowed? */
239 if (options->flags & PARSE_OPT_NONEG)
240 continue;
241 /* negated and abbreviated very much? */
242 if (!prefixcmp("no-", arg)) {
243 flags |= OPT_UNSET;
244 goto is_abbreviated;
245 }
246 /* negated? */
247 if (strncmp(arg, "no-", 3))
248 continue;
249 flags |= OPT_UNSET;
250 rest = skip_prefix(arg + 3, options->long_name);
251 /* abbreviated and negated? */
252 if (!rest && !prefixcmp(options->long_name, arg + 3))
253 goto is_abbreviated;
254 if (!rest)
255 continue;
256 }
257 if (*rest) {
258 if (*rest != '=')
259 continue;
260 p->opt = rest + 1;
261 }
262 return get_value(p, options, flags);
263 }
264
265 if (ambiguous_option)
266 return error("Ambiguous option: %s "
267 "(could be --%s%s or --%s%s)",
268 arg,
269 (ambiguous_flags & OPT_UNSET) ? "no-" : "",
270 ambiguous_option->long_name,
271 (abbrev_flags & OPT_UNSET) ? "no-" : "",
272 abbrev_option->long_name);
273 if (abbrev_option)
274 return get_value(p, abbrev_option, abbrev_flags);
275 return -2;
276 }
277
278 static int parse_nodash_opt(struct parse_opt_ctx_t *p, const char *arg,
279 const struct option *options)
280 {
281 for (; options->type != OPTION_END; options++) {
282 if (!(options->flags & PARSE_OPT_NODASH))
283 continue;
284 if ((options->flags & PARSE_OPT_OPTARG) ||
285 !(options->flags & PARSE_OPT_NOARG))
286 die("BUG: dashless options don't support arguments");
287 if (!(options->flags & PARSE_OPT_NONEG))
288 die("BUG: dashless options don't support negation");
289 if (options->long_name)
290 die("BUG: dashless options can't be long");
291 if (options->short_name == arg[0] && arg[1] == '\0')
292 return get_value(p, options, OPT_SHORT);
293 }
294 return -2;
295 }
296
297 static void check_typos(const char *arg, const struct option *options)
298 {
299 if (strlen(arg) < 3)
300 return;
301
302 if (!prefixcmp(arg, "no-")) {
303 error ("did you mean `--%s` (with two dashes ?)", arg);
304 exit(129);
305 }
306
307 for (; options->type != OPTION_END; options++) {
308 if (!options->long_name)
309 continue;
310 if (!prefixcmp(options->long_name, arg)) {
311 error ("did you mean `--%s` (with two dashes ?)", arg);
312 exit(129);
313 }
314 }
315 }
316
317 static void parse_options_check(const struct option *opts)
318 {
319 int err = 0;
320
321 for (; opts->type != OPTION_END; opts++) {
322 if ((opts->flags & PARSE_OPT_LASTARG_DEFAULT) &&
323 (opts->flags & PARSE_OPT_OPTARG)) {
324 if (opts->long_name) {
325 error("`--%s` uses incompatible flags "
326 "LASTARG_DEFAULT and OPTARG", opts->long_name);
327 } else {
328 error("`-%c` uses incompatible flags "
329 "LASTARG_DEFAULT and OPTARG", opts->short_name);
330 }
331 err |= 1;
332 }
333 }
334
335 if (err)
336 exit(129);
337 }
338
339 void parse_options_start(struct parse_opt_ctx_t *ctx,
340 int argc, const char **argv, const char *prefix,
341 const struct option *options, int flags)
342 {
343 memset(ctx, 0, sizeof(*ctx));
344 ctx->argc = argc - 1;
345 ctx->argv = argv + 1;
346 ctx->out = argv;
347 ctx->prefix = prefix;
348 ctx->cpidx = ((flags & PARSE_OPT_KEEP_ARGV0) != 0);
349 ctx->flags = flags;
350 if ((flags & PARSE_OPT_KEEP_UNKNOWN) &&
351 (flags & PARSE_OPT_STOP_AT_NON_OPTION))
352 die("STOP_AT_NON_OPTION and KEEP_UNKNOWN don't go together");
353 parse_options_check(options);
354 }
355
356 static int usage_with_options_internal(struct parse_opt_ctx_t *,
357 const char * const *,
358 const struct option *, int, int);
359
360 int parse_options_step(struct parse_opt_ctx_t *ctx,
361 const struct option *options,
362 const char * const usagestr[])
363 {
364 int internal_help = !(ctx->flags & PARSE_OPT_NO_INTERNAL_HELP);
365
366 /* we must reset ->opt, unknown short option leave it dangling */
367 ctx->opt = NULL;
368
369 for (; ctx->argc; ctx->argc--, ctx->argv++) {
370 const char *arg = ctx->argv[0];
371
372 if (*arg != '-' || !arg[1]) {
373 if (parse_nodash_opt(ctx, arg, options) == 0)
374 continue;
375 if (ctx->flags & PARSE_OPT_STOP_AT_NON_OPTION)
376 break;
377 ctx->out[ctx->cpidx++] = ctx->argv[0];
378 continue;
379 }
380
381 if (arg[1] != '-') {
382 ctx->opt = arg + 1;
383 if (internal_help && *ctx->opt == 'h')
384 return parse_options_usage(ctx, usagestr, options, 0);
385 switch (parse_short_opt(ctx, options)) {
386 case -1:
387 return parse_options_usage(ctx, usagestr, options, 1);
388 case -2:
389 goto unknown;
390 }
391 if (ctx->opt)
392 check_typos(arg + 1, options);
393 while (ctx->opt) {
394 if (internal_help && *ctx->opt == 'h')
395 return parse_options_usage(ctx, usagestr, options, 0);
396 switch (parse_short_opt(ctx, options)) {
397 case -1:
398 return parse_options_usage(ctx, usagestr, options, 1);
399 case -2:
400 /* fake a short option thing to hide the fact that we may have
401 * started to parse aggregated stuff
402 *
403 * This is leaky, too bad.
404 */
405 ctx->argv[0] = xstrdup(ctx->opt - 1);
406 *(char *)ctx->argv[0] = '-';
407 goto unknown;
408 }
409 }
410 continue;
411 }
412
413 if (!arg[2]) { /* "--" */
414 if (!(ctx->flags & PARSE_OPT_KEEP_DASHDASH)) {
415 ctx->argc--;
416 ctx->argv++;
417 }
418 break;
419 }
420
421 if (internal_help && !strcmp(arg + 2, "help-all"))
422 return usage_with_options_internal(ctx, usagestr, options, 1, 0);
423 if (internal_help && !strcmp(arg + 2, "help"))
424 return parse_options_usage(ctx, usagestr, options, 0);
425 switch (parse_long_opt(ctx, arg + 2, options)) {
426 case -1:
427 return parse_options_usage(ctx, usagestr, options, 1);
428 case -2:
429 goto unknown;
430 }
431 continue;
432 unknown:
433 if (!(ctx->flags & PARSE_OPT_KEEP_UNKNOWN))
434 return PARSE_OPT_UNKNOWN;
435 ctx->out[ctx->cpidx++] = ctx->argv[0];
436 ctx->opt = NULL;
437 }
438 return PARSE_OPT_DONE;
439 }
440
441 int parse_options_end(struct parse_opt_ctx_t *ctx)
442 {
443 memmove(ctx->out + ctx->cpidx, ctx->argv, ctx->argc * sizeof(*ctx->out));
444 ctx->out[ctx->cpidx + ctx->argc] = NULL;
445 return ctx->cpidx + ctx->argc;
446 }
447
448 int parse_options(int argc, const char **argv, const char *prefix,
449 const struct option *options, const char * const usagestr[],
450 int flags)
451 {
452 struct parse_opt_ctx_t ctx;
453
454 parse_options_start(&ctx, argc, argv, prefix, options, flags);
455 switch (parse_options_step(&ctx, options, usagestr)) {
456 case PARSE_OPT_HELP:
457 exit(129);
458 case PARSE_OPT_DONE:
459 break;
460 default: /* PARSE_OPT_UNKNOWN */
461 if (ctx.argv[0][1] == '-') {
462 error("unknown option `%s'", ctx.argv[0] + 2);
463 } else {
464 error("unknown switch `%c'", *ctx.opt);
465 }
466 usage_with_options(usagestr, options);
467 }
468
469 return parse_options_end(&ctx);
470 }
471
472 static int usage_argh(const struct option *opts, FILE *outfile)
473 {
474 const char *s;
475 int literal = (opts->flags & PARSE_OPT_LITERAL_ARGHELP) || !opts->argh;
476 if (opts->flags & PARSE_OPT_OPTARG)
477 if (opts->long_name)
478 s = literal ? "[=%s]" : "[=<%s>]";
479 else
480 s = literal ? "[%s]" : "[<%s>]";
481 else
482 s = literal ? " %s" : " <%s>";
483 return fprintf(outfile, s, opts->argh ? opts->argh : "...");
484 }
485
486 #define USAGE_OPTS_WIDTH 24
487 #define USAGE_GAP 2
488
489 static int usage_with_options_internal(struct parse_opt_ctx_t *ctx,
490 const char * const *usagestr,
491 const struct option *opts, int full, int err)
492 {
493 FILE *outfile = err ? stderr : stdout;
494
495 if (!usagestr)
496 return PARSE_OPT_HELP;
497
498 if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
499 fprintf(outfile, "cat <<\\EOF\n");
500
501 fprintf(outfile, "usage: %s\n", *usagestr++);
502 while (*usagestr && **usagestr)
503 fprintf(outfile, " or: %s\n", *usagestr++);
504 while (*usagestr) {
505 fprintf(outfile, "%s%s\n",
506 **usagestr ? " " : "",
507 *usagestr);
508 usagestr++;
509 }
510
511 if (opts->type != OPTION_GROUP)
512 fputc('\n', outfile);
513
514 for (; opts->type != OPTION_END; opts++) {
515 size_t pos;
516 int pad;
517
518 if (opts->type == OPTION_GROUP) {
519 fputc('\n', outfile);
520 if (*opts->help)
521 fprintf(outfile, "%s\n", opts->help);
522 continue;
523 }
524 if (!full && (opts->flags & PARSE_OPT_HIDDEN))
525 continue;
526
527 pos = fprintf(outfile, " ");
528 if (opts->short_name && !(opts->flags & PARSE_OPT_NEGHELP)) {
529 if (opts->flags & PARSE_OPT_NODASH)
530 pos += fprintf(outfile, "%c", opts->short_name);
531 else
532 pos += fprintf(outfile, "-%c", opts->short_name);
533 }
534 if (opts->long_name && opts->short_name)
535 pos += fprintf(outfile, ", ");
536 if (opts->long_name)
537 pos += fprintf(outfile, "--%s%s",
538 (opts->flags & PARSE_OPT_NEGHELP) ? "no-" : "",
539 opts->long_name);
540 if (opts->type == OPTION_NUMBER)
541 pos += fprintf(outfile, "-NUM");
542
543 if (!(opts->flags & PARSE_OPT_NOARG))
544 pos += usage_argh(opts, outfile);
545
546 if (pos <= USAGE_OPTS_WIDTH)
547 pad = USAGE_OPTS_WIDTH - pos;
548 else {
549 fputc('\n', outfile);
550 pad = USAGE_OPTS_WIDTH;
551 }
552 fprintf(outfile, "%*s%s\n", pad + USAGE_GAP, "", opts->help);
553 }
554 fputc('\n', outfile);
555
556 if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
557 fputs("EOF\n", outfile);
558
559 return PARSE_OPT_HELP;
560 }
561
562 void usage_with_options(const char * const *usagestr,
563 const struct option *opts)
564 {
565 usage_with_options_internal(NULL, usagestr, opts, 0, 1);
566 exit(129);
567 }
568
569 void usage_msg_opt(const char *msg,
570 const char * const *usagestr,
571 const struct option *options)
572 {
573 fprintf(stderr, "%s\n\n", msg);
574 usage_with_options(usagestr, options);
575 }
576
577 static int parse_options_usage(struct parse_opt_ctx_t *ctx,
578 const char * const *usagestr,
579 const struct option *opts, int err)
580 {
581 return usage_with_options_internal(ctx, usagestr, opts, 0, err);
582 }
583
584
585 /*----- some often used options -----*/
586 #include "cache.h"
587
588 int parse_opt_abbrev_cb(const struct option *opt, const char *arg, int unset)
589 {
590 int v;
591
592 if (!arg) {
593 v = unset ? 0 : DEFAULT_ABBREV;
594 } else {
595 v = strtol(arg, (char **)&arg, 10);
596 if (*arg)
597 return opterror(opt, "expects a numerical value", 0);
598 if (v && v < MINIMUM_ABBREV)
599 v = MINIMUM_ABBREV;
600 else if (v > 40)
601 v = 40;
602 }
603 *(int *)(opt->value) = v;
604 return 0;
605 }
606
607 int parse_opt_approxidate_cb(const struct option *opt, const char *arg,
608 int unset)
609 {
610 *(unsigned long *)(opt->value) = approxidate(arg);
611 return 0;
612 }
613
614 int parse_opt_color_flag_cb(const struct option *opt, const char *arg,
615 int unset)
616 {
617 int value;
618
619 if (!arg)
620 arg = unset ? "never" : (const char *)opt->defval;
621 value = git_config_colorbool(NULL, arg, -1);
622 if (value < 0)
623 return opterror(opt,
624 "expects \"always\", \"auto\", or \"never\"", 0);
625 *(int *)opt->value = value;
626 return 0;
627 }
628
629 int parse_opt_verbosity_cb(const struct option *opt, const char *arg,
630 int unset)
631 {
632 int *target = opt->value;
633
634 if (unset)
635 /* --no-quiet, --no-verbose */
636 *target = 0;
637 else if (opt->short_name == 'v') {
638 if (*target >= 0)
639 (*target)++;
640 else
641 *target = 1;
642 } else {
643 if (*target <= 0)
644 (*target)--;
645 else
646 *target = -1;
647 }
648 return 0;
649 }
650
651 int parse_opt_with_commit(const struct option *opt, const char *arg, int unset)
652 {
653 unsigned char sha1[20];
654 struct commit *commit;
655
656 if (!arg)
657 return -1;
658 if (get_sha1(arg, sha1))
659 return error("malformed object name %s", arg);
660 commit = lookup_commit_reference(sha1);
661 if (!commit)
662 return error("no such commit %s", arg);
663 commit_list_insert(commit, opt->value);
664 return 0;
665 }
666
667 int parse_opt_tertiary(const struct option *opt, const char *arg, int unset)
668 {
669 int *target = opt->value;
670 *target = unset ? 2 : 1;
671 return 0;
672 }
673
674 int parse_options_concat(struct option *dst, size_t dst_size, struct option *src)
675 {
676 int i, j;
677
678 for (i = 0; i < dst_size; i++)
679 if (dst[i].type == OPTION_END)
680 break;
681 for (j = 0; i < dst_size; i++, j++) {
682 dst[i] = src[j];
683 if (src[j].type == OPTION_END)
684 return 0;
685 }
686 return -1;
687 }