Revert "config.mak.uname: use clang for Mac OS X 10.6"
[git/git-svn.git] / parse-options.c
blob47a91920601d74842a0947ce1431c00b3d723972
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 #define OPT_SHORT 1
9 #define OPT_UNSET 2
11 int optbug(const struct option *opt, const char *reason)
13 if (opt->long_name) {
14 if (opt->short_name)
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)
25 if (p->opt) {
26 *arg = p->opt;
27 p->opt = NULL;
28 } else if (p->argc == 1 && (opt->flags & PARSE_OPT_LASTARG_DEFAULT)) {
29 *arg = (const char *)opt->defval;
30 } else if (p->argc > 1) {
31 p->argc--;
32 *arg = *++p->argv;
33 } else
34 return opterror(opt, "requires a value", flags);
35 return 0;
38 static void fix_filename(const char *prefix, const char **file)
40 if (!file || !*file || !prefix || is_absolute_path(*file)
41 || !strcmp("-", *file))
42 return;
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,
48 int flags)
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++) {
59 if (that == opt ||
60 that->type != OPTION_CMDMODE ||
61 that->value != opt->value ||
62 that->defval != *(int *)opt->value)
63 continue;
65 if (that->long_name)
66 strbuf_addf(&that_name, "--%s", that->long_name);
67 else
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);
73 return -1;
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,
81 int flags)
83 const char *s, *arg;
84 const int unset = flags & OPT_UNSET;
85 int err;
87 if (unset && p->opt)
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);
94 switch (opt->type) {
95 case OPTION_LOWLEVEL_CALLBACK:
96 return (*(parse_opt_ll_cb *)opt->callback)(p, opt, unset);
98 case OPTION_BIT:
99 if (unset)
100 *(int *)opt->value &= ~opt->defval;
101 else
102 *(int *)opt->value |= opt->defval;
103 return 0;
105 case OPTION_NEGBIT:
106 if (unset)
107 *(int *)opt->value |= opt->defval;
108 else
109 *(int *)opt->value &= ~opt->defval;
110 return 0;
112 case OPTION_COUNTUP:
113 *(int *)opt->value = unset ? 0 : *(int *)opt->value + 1;
114 return 0;
116 case OPTION_SET_INT:
117 *(int *)opt->value = unset ? 0 : opt->defval;
118 return 0;
120 case OPTION_CMDMODE:
122 * Giving the same mode option twice, although is unnecessary,
123 * is not a grave error, so let it pass.
125 if (*(int *)opt->value && *(int *)opt->value != opt->defval)
126 return opt_command_mode_error(opt, all_opts, flags);
127 *(int *)opt->value = opt->defval;
128 return 0;
130 case OPTION_STRING:
131 if (unset)
132 *(const char **)opt->value = NULL;
133 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
134 *(const char **)opt->value = (const char *)opt->defval;
135 else
136 return get_arg(p, opt, flags, (const char **)opt->value);
137 return 0;
139 case OPTION_FILENAME:
140 err = 0;
141 if (unset)
142 *(const char **)opt->value = NULL;
143 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
144 *(const char **)opt->value = (const char *)opt->defval;
145 else
146 err = get_arg(p, opt, flags, (const char **)opt->value);
148 if (!err)
149 fix_filename(p->prefix, (const char **)opt->value);
150 return err;
152 case OPTION_CALLBACK:
153 if (unset)
154 return (*opt->callback)(opt, NULL, 1) ? (-1) : 0;
155 if (opt->flags & PARSE_OPT_NOARG)
156 return (*opt->callback)(opt, NULL, 0) ? (-1) : 0;
157 if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
158 return (*opt->callback)(opt, NULL, 0) ? (-1) : 0;
159 if (get_arg(p, opt, flags, &arg))
160 return -1;
161 return (*opt->callback)(opt, arg, 0) ? (-1) : 0;
163 case OPTION_INTEGER:
164 if (unset) {
165 *(int *)opt->value = 0;
166 return 0;
168 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
169 *(int *)opt->value = opt->defval;
170 return 0;
172 if (get_arg(p, opt, flags, &arg))
173 return -1;
174 *(int *)opt->value = strtol(arg, (char **)&s, 10);
175 if (*s)
176 return opterror(opt, "expects a numerical value", flags);
177 return 0;
179 case OPTION_MAGNITUDE:
180 if (unset) {
181 *(unsigned long *)opt->value = 0;
182 return 0;
184 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
185 *(unsigned long *)opt->value = opt->defval;
186 return 0;
188 if (get_arg(p, opt, flags, &arg))
189 return -1;
190 if (!git_parse_ulong(arg, opt->value))
191 return opterror(opt,
192 "expects a non-negative integer value with an optional k/m/g suffix",
193 flags);
194 return 0;
196 default:
197 die("should not happen, someone must be hit on the forehead");
201 static int parse_short_opt(struct parse_opt_ctx_t *p, const struct option *options)
203 const struct option *all_opts = options;
204 const struct option *numopt = NULL;
206 for (; options->type != OPTION_END; options++) {
207 if (options->short_name == *p->opt) {
208 p->opt = p->opt[1] ? p->opt + 1 : NULL;
209 return get_value(p, options, all_opts, OPT_SHORT);
213 * Handle the numerical option later, explicit one-digit
214 * options take precedence over it.
216 if (options->type == OPTION_NUMBER)
217 numopt = options;
219 if (numopt && isdigit(*p->opt)) {
220 size_t len = 1;
221 char *arg;
222 int rc;
224 while (isdigit(p->opt[len]))
225 len++;
226 arg = xmemdupz(p->opt, len);
227 p->opt = p->opt[len] ? p->opt + len : NULL;
228 rc = (*numopt->callback)(numopt, arg, 0) ? (-1) : 0;
229 free(arg);
230 return rc;
232 return -2;
235 static int parse_long_opt(struct parse_opt_ctx_t *p, const char *arg,
236 const struct option *options)
238 const struct option *all_opts = options;
239 const char *arg_end = strchrnul(arg, '=');
240 const struct option *abbrev_option = NULL, *ambiguous_option = NULL;
241 int abbrev_flags = 0, ambiguous_flags = 0;
243 for (; options->type != OPTION_END; options++) {
244 const char *rest, *long_name = options->long_name;
245 int flags = 0, opt_flags = 0;
247 if (!long_name)
248 continue;
250 again:
251 if (!skip_prefix(arg, long_name, &rest))
252 rest = NULL;
253 if (options->type == OPTION_ARGUMENT) {
254 if (!rest)
255 continue;
256 if (*rest == '=')
257 return opterror(options, "takes no value", flags);
258 if (*rest)
259 continue;
260 p->out[p->cpidx++] = arg - 2;
261 return 0;
263 if (!rest) {
264 /* abbreviated? */
265 if (!strncmp(long_name, arg, arg_end - arg)) {
266 is_abbreviated:
267 if (abbrev_option) {
269 * If this is abbreviated, it is
270 * ambiguous. So when there is no
271 * exact match later, we need to
272 * error out.
274 ambiguous_option = abbrev_option;
275 ambiguous_flags = abbrev_flags;
277 if (!(flags & OPT_UNSET) && *arg_end)
278 p->opt = arg_end + 1;
279 abbrev_option = options;
280 abbrev_flags = flags ^ opt_flags;
281 continue;
283 /* negation allowed? */
284 if (options->flags & PARSE_OPT_NONEG)
285 continue;
286 /* negated and abbreviated very much? */
287 if (starts_with("no-", arg)) {
288 flags |= OPT_UNSET;
289 goto is_abbreviated;
291 /* negated? */
292 if (!starts_with(arg, "no-")) {
293 if (starts_with(long_name, "no-")) {
294 long_name += 3;
295 opt_flags |= OPT_UNSET;
296 goto again;
298 continue;
300 flags |= OPT_UNSET;
301 if (!skip_prefix(arg + 3, long_name, &rest)) {
302 /* abbreviated and negated? */
303 if (starts_with(long_name, arg + 3))
304 goto is_abbreviated;
305 else
306 continue;
309 if (*rest) {
310 if (*rest != '=')
311 continue;
312 p->opt = rest + 1;
314 return get_value(p, options, all_opts, flags ^ opt_flags);
317 if (ambiguous_option)
318 return error("Ambiguous option: %s "
319 "(could be --%s%s or --%s%s)",
320 arg,
321 (ambiguous_flags & OPT_UNSET) ? "no-" : "",
322 ambiguous_option->long_name,
323 (abbrev_flags & OPT_UNSET) ? "no-" : "",
324 abbrev_option->long_name);
325 if (abbrev_option)
326 return get_value(p, abbrev_option, all_opts, abbrev_flags);
327 return -2;
330 static int parse_nodash_opt(struct parse_opt_ctx_t *p, const char *arg,
331 const struct option *options)
333 const struct option *all_opts = options;
335 for (; options->type != OPTION_END; options++) {
336 if (!(options->flags & PARSE_OPT_NODASH))
337 continue;
338 if (options->short_name == arg[0] && arg[1] == '\0')
339 return get_value(p, options, all_opts, OPT_SHORT);
341 return -2;
344 static void check_typos(const char *arg, const struct option *options)
346 if (strlen(arg) < 3)
347 return;
349 if (starts_with(arg, "no-")) {
350 error ("did you mean `--%s` (with two dashes ?)", arg);
351 exit(129);
354 for (; options->type != OPTION_END; options++) {
355 if (!options->long_name)
356 continue;
357 if (starts_with(options->long_name, arg)) {
358 error ("did you mean `--%s` (with two dashes ?)", arg);
359 exit(129);
364 static void parse_options_check(const struct option *opts)
366 int err = 0;
367 char short_opts[128];
369 memset(short_opts, '\0', sizeof(short_opts));
370 for (; opts->type != OPTION_END; opts++) {
371 if ((opts->flags & PARSE_OPT_LASTARG_DEFAULT) &&
372 (opts->flags & PARSE_OPT_OPTARG))
373 err |= optbug(opts, "uses incompatible flags "
374 "LASTARG_DEFAULT and OPTARG");
375 if (opts->short_name) {
376 if (0x7F <= opts->short_name)
377 err |= optbug(opts, "invalid short name");
378 else if (short_opts[opts->short_name]++)
379 err |= optbug(opts, "short name already used");
381 if (opts->flags & PARSE_OPT_NODASH &&
382 ((opts->flags & PARSE_OPT_OPTARG) ||
383 !(opts->flags & PARSE_OPT_NOARG) ||
384 !(opts->flags & PARSE_OPT_NONEG) ||
385 opts->long_name))
386 err |= optbug(opts, "uses feature "
387 "not supported for dashless options");
388 switch (opts->type) {
389 case OPTION_COUNTUP:
390 case OPTION_BIT:
391 case OPTION_NEGBIT:
392 case OPTION_SET_INT:
393 case OPTION_NUMBER:
394 if ((opts->flags & PARSE_OPT_OPTARG) ||
395 !(opts->flags & PARSE_OPT_NOARG))
396 err |= optbug(opts, "should not accept an argument");
397 default:
398 ; /* ok. (usually accepts an argument) */
400 if (opts->argh &&
401 strcspn(opts->argh, " _") != strlen(opts->argh))
402 err |= optbug(opts, "multi-word argh should use dash to separate words");
404 if (err)
405 exit(128);
408 void parse_options_start(struct parse_opt_ctx_t *ctx,
409 int argc, const char **argv, const char *prefix,
410 const struct option *options, int flags)
412 memset(ctx, 0, sizeof(*ctx));
413 ctx->argc = ctx->total = argc - 1;
414 ctx->argv = argv + 1;
415 ctx->out = argv;
416 ctx->prefix = prefix;
417 ctx->cpidx = ((flags & PARSE_OPT_KEEP_ARGV0) != 0);
418 ctx->flags = flags;
419 if ((flags & PARSE_OPT_KEEP_UNKNOWN) &&
420 (flags & PARSE_OPT_STOP_AT_NON_OPTION))
421 die("STOP_AT_NON_OPTION and KEEP_UNKNOWN don't go together");
422 parse_options_check(options);
425 static int usage_with_options_internal(struct parse_opt_ctx_t *,
426 const char * const *,
427 const struct option *, int, int);
429 int parse_options_step(struct parse_opt_ctx_t *ctx,
430 const struct option *options,
431 const char * const usagestr[])
433 int internal_help = !(ctx->flags & PARSE_OPT_NO_INTERNAL_HELP);
434 int err = 0;
436 /* we must reset ->opt, unknown short option leave it dangling */
437 ctx->opt = NULL;
439 for (; ctx->argc; ctx->argc--, ctx->argv++) {
440 const char *arg = ctx->argv[0];
442 if (*arg != '-' || !arg[1]) {
443 if (parse_nodash_opt(ctx, arg, options) == 0)
444 continue;
445 if (ctx->flags & PARSE_OPT_STOP_AT_NON_OPTION)
446 return PARSE_OPT_NON_OPTION;
447 ctx->out[ctx->cpidx++] = ctx->argv[0];
448 continue;
451 /* lone -h asks for help */
452 if (internal_help && ctx->total == 1 && !strcmp(arg + 1, "h"))
453 goto show_usage;
455 if (arg[1] != '-') {
456 ctx->opt = arg + 1;
457 switch (parse_short_opt(ctx, options)) {
458 case -1:
459 goto show_usage_error;
460 case -2:
461 if (ctx->opt)
462 check_typos(arg + 1, options);
463 if (internal_help && *ctx->opt == 'h')
464 goto show_usage;
465 goto unknown;
467 if (ctx->opt)
468 check_typos(arg + 1, options);
469 while (ctx->opt) {
470 switch (parse_short_opt(ctx, options)) {
471 case -1:
472 goto show_usage_error;
473 case -2:
474 if (internal_help && *ctx->opt == 'h')
475 goto show_usage;
477 /* fake a short option thing to hide the fact that we may have
478 * started to parse aggregated stuff
480 * This is leaky, too bad.
482 ctx->argv[0] = xstrdup(ctx->opt - 1);
483 *(char *)ctx->argv[0] = '-';
484 goto unknown;
487 continue;
490 if (!arg[2]) { /* "--" */
491 if (!(ctx->flags & PARSE_OPT_KEEP_DASHDASH)) {
492 ctx->argc--;
493 ctx->argv++;
495 break;
498 if (internal_help && !strcmp(arg + 2, "help-all"))
499 return usage_with_options_internal(ctx, usagestr, options, 1, 0);
500 if (internal_help && !strcmp(arg + 2, "help"))
501 goto show_usage;
502 switch (parse_long_opt(ctx, arg + 2, options)) {
503 case -1:
504 goto show_usage_error;
505 case -2:
506 goto unknown;
508 continue;
509 unknown:
510 if (!(ctx->flags & PARSE_OPT_KEEP_UNKNOWN))
511 return PARSE_OPT_UNKNOWN;
512 ctx->out[ctx->cpidx++] = ctx->argv[0];
513 ctx->opt = NULL;
515 return PARSE_OPT_DONE;
517 show_usage_error:
518 err = 1;
519 show_usage:
520 return usage_with_options_internal(ctx, usagestr, options, 0, err);
523 int parse_options_end(struct parse_opt_ctx_t *ctx)
525 memmove(ctx->out + ctx->cpidx, ctx->argv, ctx->argc * sizeof(*ctx->out));
526 ctx->out[ctx->cpidx + ctx->argc] = NULL;
527 return ctx->cpidx + ctx->argc;
530 int parse_options(int argc, const char **argv, const char *prefix,
531 const struct option *options, const char * const usagestr[],
532 int flags)
534 struct parse_opt_ctx_t ctx;
536 parse_options_start(&ctx, argc, argv, prefix, options, flags);
537 switch (parse_options_step(&ctx, options, usagestr)) {
538 case PARSE_OPT_HELP:
539 exit(129);
540 case PARSE_OPT_NON_OPTION:
541 case PARSE_OPT_DONE:
542 break;
543 default: /* PARSE_OPT_UNKNOWN */
544 if (ctx.argv[0][1] == '-') {
545 error("unknown option `%s'", ctx.argv[0] + 2);
546 } else if (isascii(*ctx.opt)) {
547 error("unknown switch `%c'", *ctx.opt);
548 } else {
549 error("unknown non-ascii option in string: `%s'",
550 ctx.argv[0]);
552 usage_with_options(usagestr, options);
555 precompose_argv(argc, argv);
556 return parse_options_end(&ctx);
559 static int usage_argh(const struct option *opts, FILE *outfile)
561 const char *s;
562 int literal = (opts->flags & PARSE_OPT_LITERAL_ARGHELP) || !opts->argh;
563 if (opts->flags & PARSE_OPT_OPTARG)
564 if (opts->long_name)
565 s = literal ? "[=%s]" : "[=<%s>]";
566 else
567 s = literal ? "[%s]" : "[<%s>]";
568 else
569 s = literal ? " %s" : " <%s>";
570 return utf8_fprintf(outfile, s, opts->argh ? _(opts->argh) : _("..."));
573 #define USAGE_OPTS_WIDTH 24
574 #define USAGE_GAP 2
576 static int usage_with_options_internal(struct parse_opt_ctx_t *ctx,
577 const char * const *usagestr,
578 const struct option *opts, int full, int err)
580 FILE *outfile = err ? stderr : stdout;
582 if (!usagestr)
583 return PARSE_OPT_HELP;
585 if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
586 fprintf(outfile, "cat <<\\EOF\n");
588 fprintf_ln(outfile, _("usage: %s"), _(*usagestr++));
589 while (*usagestr && **usagestr)
590 /* TRANSLATORS: the colon here should align with the
591 one in "usage: %s" translation */
592 fprintf_ln(outfile, _(" or: %s"), _(*usagestr++));
593 while (*usagestr) {
594 if (**usagestr)
595 fprintf_ln(outfile, _(" %s"), _(*usagestr));
596 else
597 putchar('\n');
598 usagestr++;
601 if (opts->type != OPTION_GROUP)
602 fputc('\n', outfile);
604 for (; opts->type != OPTION_END; opts++) {
605 size_t pos;
606 int pad;
608 if (opts->type == OPTION_GROUP) {
609 fputc('\n', outfile);
610 if (*opts->help)
611 fprintf(outfile, "%s\n", _(opts->help));
612 continue;
614 if (!full && (opts->flags & PARSE_OPT_HIDDEN))
615 continue;
617 pos = fprintf(outfile, " ");
618 if (opts->short_name) {
619 if (opts->flags & PARSE_OPT_NODASH)
620 pos += fprintf(outfile, "%c", opts->short_name);
621 else
622 pos += fprintf(outfile, "-%c", opts->short_name);
624 if (opts->long_name && opts->short_name)
625 pos += fprintf(outfile, ", ");
626 if (opts->long_name)
627 pos += fprintf(outfile, "--%s", opts->long_name);
628 if (opts->type == OPTION_NUMBER)
629 pos += utf8_fprintf(outfile, _("-NUM"));
631 if ((opts->flags & PARSE_OPT_LITERAL_ARGHELP) ||
632 !(opts->flags & PARSE_OPT_NOARG))
633 pos += usage_argh(opts, outfile);
635 if (pos <= USAGE_OPTS_WIDTH)
636 pad = USAGE_OPTS_WIDTH - pos;
637 else {
638 fputc('\n', outfile);
639 pad = USAGE_OPTS_WIDTH;
641 fprintf(outfile, "%*s%s\n", pad + USAGE_GAP, "", _(opts->help));
643 fputc('\n', outfile);
645 if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
646 fputs("EOF\n", outfile);
648 return PARSE_OPT_HELP;
651 void NORETURN usage_with_options(const char * const *usagestr,
652 const struct option *opts)
654 usage_with_options_internal(NULL, usagestr, opts, 0, 1);
655 exit(129);
658 void NORETURN usage_msg_opt(const char *msg,
659 const char * const *usagestr,
660 const struct option *options)
662 fprintf(stderr, "%s\n\n", msg);
663 usage_with_options(usagestr, options);
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);