mailmap: resurrect lower-casing of email addresses
[git/spearce.git] / parse-options.c
blob4c5d09dd25aede8ea7e14886f5c17ed847a8f0d9
1 #include "git-compat-util.h"
2 #include "parse-options.h"
3 #include "cache.h"
4 #include "commit.h"
6 #define OPT_SHORT 1
7 #define OPT_UNSET 2
9 static int opterror(const struct option *opt, const char *reason, int flags)
11 if (flags & OPT_SHORT)
12 return error("switch `%c' %s", opt->short_name, reason);
13 if (flags & OPT_UNSET)
14 return error("option `no-%s' %s", opt->long_name, reason);
15 return error("option `%s' %s", opt->long_name, reason);
18 static int get_arg(struct parse_opt_ctx_t *p, const struct option *opt,
19 int flags, const char **arg)
21 if (p->opt) {
22 *arg = p->opt;
23 p->opt = NULL;
24 } else if (p->argc == 1 && (opt->flags & PARSE_OPT_LASTARG_DEFAULT)) {
25 *arg = (const char *)opt->defval;
26 } else if (p->argc > 1) {
27 p->argc--;
28 *arg = *++p->argv;
29 } else
30 return opterror(opt, "requires a value", flags);
31 return 0;
34 static int get_value(struct parse_opt_ctx_t *p,
35 const struct option *opt, int flags)
37 const char *s, *arg;
38 const int unset = flags & OPT_UNSET;
40 if (unset && p->opt)
41 return opterror(opt, "takes no value", flags);
42 if (unset && (opt->flags & PARSE_OPT_NONEG))
43 return opterror(opt, "isn't available", flags);
45 if (!(flags & OPT_SHORT) && p->opt) {
46 switch (opt->type) {
47 case OPTION_CALLBACK:
48 if (!(opt->flags & PARSE_OPT_NOARG))
49 break;
50 /* FALLTHROUGH */
51 case OPTION_BOOLEAN:
52 case OPTION_BIT:
53 case OPTION_SET_INT:
54 case OPTION_SET_PTR:
55 return opterror(opt, "takes no value", flags);
56 default:
57 break;
61 switch (opt->type) {
62 case OPTION_BIT:
63 if (unset)
64 *(int *)opt->value &= ~opt->defval;
65 else
66 *(int *)opt->value |= opt->defval;
67 return 0;
69 case OPTION_BOOLEAN:
70 *(int *)opt->value = unset ? 0 : *(int *)opt->value + 1;
71 return 0;
73 case OPTION_SET_INT:
74 *(int *)opt->value = unset ? 0 : opt->defval;
75 return 0;
77 case OPTION_SET_PTR:
78 *(void **)opt->value = unset ? NULL : (void *)opt->defval;
79 return 0;
81 case OPTION_STRING:
82 if (unset)
83 *(const char **)opt->value = NULL;
84 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
85 *(const char **)opt->value = (const char *)opt->defval;
86 else
87 return get_arg(p, opt, flags, (const char **)opt->value);
88 return 0;
90 case OPTION_CALLBACK:
91 if (unset)
92 return (*opt->callback)(opt, NULL, 1) ? (-1) : 0;
93 if (opt->flags & PARSE_OPT_NOARG)
94 return (*opt->callback)(opt, NULL, 0) ? (-1) : 0;
95 if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
96 return (*opt->callback)(opt, NULL, 0) ? (-1) : 0;
97 if (get_arg(p, opt, flags, &arg))
98 return -1;
99 return (*opt->callback)(opt, arg, 0) ? (-1) : 0;
101 case OPTION_INTEGER:
102 if (unset) {
103 *(int *)opt->value = 0;
104 return 0;
106 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
107 *(int *)opt->value = opt->defval;
108 return 0;
110 if (get_arg(p, opt, flags, &arg))
111 return -1;
112 *(int *)opt->value = strtol(arg, (char **)&s, 10);
113 if (*s)
114 return opterror(opt, "expects a numerical value", flags);
115 return 0;
117 default:
118 die("should not happen, someone must be hit on the forehead");
122 static int parse_short_opt(struct parse_opt_ctx_t *p, const struct option *options)
124 for (; options->type != OPTION_END; options++) {
125 if (options->short_name == *p->opt) {
126 p->opt = p->opt[1] ? p->opt + 1 : NULL;
127 return get_value(p, options, OPT_SHORT);
130 return -2;
133 static int parse_long_opt(struct parse_opt_ctx_t *p, const char *arg,
134 const struct option *options)
136 const char *arg_end = strchr(arg, '=');
137 const struct option *abbrev_option = NULL, *ambiguous_option = NULL;
138 int abbrev_flags = 0, ambiguous_flags = 0;
140 if (!arg_end)
141 arg_end = arg + strlen(arg);
143 for (; options->type != OPTION_END; options++) {
144 const char *rest;
145 int flags = 0;
147 if (!options->long_name)
148 continue;
150 rest = skip_prefix(arg, options->long_name);
151 if (options->type == OPTION_ARGUMENT) {
152 if (!rest)
153 continue;
154 if (*rest == '=')
155 return opterror(options, "takes no value", flags);
156 if (*rest)
157 continue;
158 p->out[p->cpidx++] = arg - 2;
159 return 0;
161 if (!rest) {
162 /* abbreviated? */
163 if (!strncmp(options->long_name, arg, arg_end - arg)) {
164 is_abbreviated:
165 if (abbrev_option) {
167 * If this is abbreviated, it is
168 * ambiguous. So when there is no
169 * exact match later, we need to
170 * error out.
172 ambiguous_option = abbrev_option;
173 ambiguous_flags = abbrev_flags;
175 if (!(flags & OPT_UNSET) && *arg_end)
176 p->opt = arg_end + 1;
177 abbrev_option = options;
178 abbrev_flags = flags;
179 continue;
181 /* negated and abbreviated very much? */
182 if (!prefixcmp("no-", arg)) {
183 flags |= OPT_UNSET;
184 goto is_abbreviated;
186 /* negated? */
187 if (strncmp(arg, "no-", 3))
188 continue;
189 flags |= OPT_UNSET;
190 rest = skip_prefix(arg + 3, options->long_name);
191 /* abbreviated and negated? */
192 if (!rest && !prefixcmp(options->long_name, arg + 3))
193 goto is_abbreviated;
194 if (!rest)
195 continue;
197 if (*rest) {
198 if (*rest != '=')
199 continue;
200 p->opt = rest + 1;
202 return get_value(p, options, flags);
205 if (ambiguous_option)
206 return error("Ambiguous option: %s "
207 "(could be --%s%s or --%s%s)",
208 arg,
209 (ambiguous_flags & OPT_UNSET) ? "no-" : "",
210 ambiguous_option->long_name,
211 (abbrev_flags & OPT_UNSET) ? "no-" : "",
212 abbrev_option->long_name);
213 if (abbrev_option)
214 return get_value(p, abbrev_option, abbrev_flags);
215 return -2;
218 static void check_typos(const char *arg, const struct option *options)
220 if (strlen(arg) < 3)
221 return;
223 if (!prefixcmp(arg, "no-")) {
224 error ("did you mean `--%s` (with two dashes ?)", arg);
225 exit(129);
228 for (; options->type != OPTION_END; options++) {
229 if (!options->long_name)
230 continue;
231 if (!prefixcmp(options->long_name, arg)) {
232 error ("did you mean `--%s` (with two dashes ?)", arg);
233 exit(129);
238 void parse_options_start(struct parse_opt_ctx_t *ctx,
239 int argc, const char **argv, int flags)
241 memset(ctx, 0, sizeof(*ctx));
242 ctx->argc = argc - 1;
243 ctx->argv = argv + 1;
244 ctx->out = argv;
245 ctx->cpidx = ((flags & PARSE_OPT_KEEP_ARGV0) != 0);
246 ctx->flags = flags;
249 static int usage_with_options_internal(const char * const *,
250 const struct option *, int);
252 int parse_options_step(struct parse_opt_ctx_t *ctx,
253 const struct option *options,
254 const char * const usagestr[])
256 /* we must reset ->opt, unknown short option leave it dangling */
257 ctx->opt = NULL;
259 for (; ctx->argc; ctx->argc--, ctx->argv++) {
260 const char *arg = ctx->argv[0];
262 if (*arg != '-' || !arg[1]) {
263 if (ctx->flags & PARSE_OPT_STOP_AT_NON_OPTION)
264 break;
265 ctx->out[ctx->cpidx++] = ctx->argv[0];
266 continue;
269 if (arg[1] != '-') {
270 ctx->opt = arg + 1;
271 if (*ctx->opt == 'h')
272 return parse_options_usage(usagestr, options);
273 switch (parse_short_opt(ctx, options)) {
274 case -1:
275 return parse_options_usage(usagestr, options);
276 case -2:
277 return PARSE_OPT_UNKNOWN;
279 if (ctx->opt)
280 check_typos(arg + 1, options);
281 while (ctx->opt) {
282 if (*ctx->opt == 'h')
283 return parse_options_usage(usagestr, options);
284 switch (parse_short_opt(ctx, options)) {
285 case -1:
286 return parse_options_usage(usagestr, options);
287 case -2:
288 /* fake a short option thing to hide the fact that we may have
289 * started to parse aggregated stuff
291 * This is leaky, too bad.
293 ctx->argv[0] = xstrdup(ctx->opt - 1);
294 *(char *)ctx->argv[0] = '-';
295 return PARSE_OPT_UNKNOWN;
298 continue;
301 if (!arg[2]) { /* "--" */
302 if (!(ctx->flags & PARSE_OPT_KEEP_DASHDASH)) {
303 ctx->argc--;
304 ctx->argv++;
306 break;
309 if (!strcmp(arg + 2, "help-all"))
310 return usage_with_options_internal(usagestr, options, 1);
311 if (!strcmp(arg + 2, "help"))
312 return parse_options_usage(usagestr, options);
313 switch (parse_long_opt(ctx, arg + 2, options)) {
314 case -1:
315 return parse_options_usage(usagestr, options);
316 case -2:
317 return PARSE_OPT_UNKNOWN;
320 return PARSE_OPT_DONE;
323 int parse_options_end(struct parse_opt_ctx_t *ctx)
325 memmove(ctx->out + ctx->cpidx, ctx->argv, ctx->argc * sizeof(*ctx->out));
326 ctx->out[ctx->cpidx + ctx->argc] = NULL;
327 return ctx->cpidx + ctx->argc;
330 int parse_options(int argc, const char **argv, const struct option *options,
331 const char * const usagestr[], int flags)
333 struct parse_opt_ctx_t ctx;
335 parse_options_start(&ctx, argc, argv, flags);
336 switch (parse_options_step(&ctx, options, usagestr)) {
337 case PARSE_OPT_HELP:
338 exit(129);
339 case PARSE_OPT_DONE:
340 break;
341 default: /* PARSE_OPT_UNKNOWN */
342 if (ctx.argv[0][1] == '-') {
343 error("unknown option `%s'", ctx.argv[0] + 2);
344 } else {
345 error("unknown switch `%c'", *ctx.opt);
347 usage_with_options(usagestr, options);
350 return parse_options_end(&ctx);
353 #define USAGE_OPTS_WIDTH 24
354 #define USAGE_GAP 2
356 int usage_with_options_internal(const char * const *usagestr,
357 const struct option *opts, int full)
359 fprintf(stderr, "usage: %s\n", *usagestr++);
360 while (*usagestr && **usagestr)
361 fprintf(stderr, " or: %s\n", *usagestr++);
362 while (*usagestr) {
363 fprintf(stderr, "%s%s\n",
364 **usagestr ? " " : "",
365 *usagestr);
366 usagestr++;
369 if (opts->type != OPTION_GROUP)
370 fputc('\n', stderr);
372 for (; opts->type != OPTION_END; opts++) {
373 size_t pos;
374 int pad;
376 if (opts->type == OPTION_GROUP) {
377 fputc('\n', stderr);
378 if (*opts->help)
379 fprintf(stderr, "%s\n", opts->help);
380 continue;
382 if (!full && (opts->flags & PARSE_OPT_HIDDEN))
383 continue;
385 pos = fprintf(stderr, " ");
386 if (opts->short_name)
387 pos += fprintf(stderr, "-%c", opts->short_name);
388 if (opts->long_name && opts->short_name)
389 pos += fprintf(stderr, ", ");
390 if (opts->long_name)
391 pos += fprintf(stderr, "--%s", opts->long_name);
393 switch (opts->type) {
394 case OPTION_ARGUMENT:
395 break;
396 case OPTION_INTEGER:
397 if (opts->flags & PARSE_OPT_OPTARG)
398 if (opts->long_name)
399 pos += fprintf(stderr, "[=<n>]");
400 else
401 pos += fprintf(stderr, "[<n>]");
402 else
403 pos += fprintf(stderr, " <n>");
404 break;
405 case OPTION_CALLBACK:
406 if (opts->flags & PARSE_OPT_NOARG)
407 break;
408 /* FALLTHROUGH */
409 case OPTION_STRING:
410 if (opts->argh) {
411 if (opts->flags & PARSE_OPT_OPTARG)
412 if (opts->long_name)
413 pos += fprintf(stderr, "[=<%s>]", opts->argh);
414 else
415 pos += fprintf(stderr, "[<%s>]", opts->argh);
416 else
417 pos += fprintf(stderr, " <%s>", opts->argh);
418 } else {
419 if (opts->flags & PARSE_OPT_OPTARG)
420 if (opts->long_name)
421 pos += fprintf(stderr, "[=...]");
422 else
423 pos += fprintf(stderr, "[...]");
424 else
425 pos += fprintf(stderr, " ...");
427 break;
428 default: /* OPTION_{BIT,BOOLEAN,SET_INT,SET_PTR} */
429 break;
432 if (pos <= USAGE_OPTS_WIDTH)
433 pad = USAGE_OPTS_WIDTH - pos;
434 else {
435 fputc('\n', stderr);
436 pad = USAGE_OPTS_WIDTH;
438 fprintf(stderr, "%*s%s\n", pad + USAGE_GAP, "", opts->help);
440 fputc('\n', stderr);
442 return PARSE_OPT_HELP;
445 void usage_with_options(const char * const *usagestr,
446 const struct option *opts)
448 usage_with_options_internal(usagestr, opts, 0);
449 exit(129);
452 int parse_options_usage(const char * const *usagestr,
453 const struct option *opts)
455 return usage_with_options_internal(usagestr, opts, 0);
459 /*----- some often used options -----*/
460 #include "cache.h"
462 int parse_opt_abbrev_cb(const struct option *opt, const char *arg, int unset)
464 int v;
466 if (!arg) {
467 v = unset ? 0 : DEFAULT_ABBREV;
468 } else {
469 v = strtol(arg, (char **)&arg, 10);
470 if (*arg)
471 return opterror(opt, "expects a numerical value", 0);
472 if (v && v < MINIMUM_ABBREV)
473 v = MINIMUM_ABBREV;
474 else if (v > 40)
475 v = 40;
477 *(int *)(opt->value) = v;
478 return 0;
481 int parse_opt_approxidate_cb(const struct option *opt, const char *arg,
482 int unset)
484 *(unsigned long *)(opt->value) = approxidate(arg);
485 return 0;
488 int parse_opt_verbosity_cb(const struct option *opt, const char *arg,
489 int unset)
491 int *target = opt->value;
493 if (unset)
494 /* --no-quiet, --no-verbose */
495 *target = 0;
496 else if (opt->short_name == 'v') {
497 if (*target >= 0)
498 (*target)++;
499 else
500 *target = 1;
501 } else {
502 if (*target <= 0)
503 (*target)--;
504 else
505 *target = -1;
507 return 0;
510 int parse_opt_with_commit(const struct option *opt, const char *arg, int unset)
512 unsigned char sha1[20];
513 struct commit *commit;
515 if (!arg)
516 return -1;
517 if (get_sha1(arg, sha1))
518 return error("malformed object name %s", arg);
519 commit = lookup_commit_reference(sha1);
520 if (!commit)
521 return error("no such commit %s", arg);
522 commit_list_insert(commit, opt->value);
523 return 0;
527 * This should really be OPTION_FILENAME type as a part of
528 * parse_options that take prefix to do this while parsing.
530 extern const char *parse_options_fix_filename(const char *prefix, const char *file)
532 if (!file || !prefix || is_absolute_path(file) || !strcmp("-", file))
533 return file;
534 return prefix_filename(prefix, strlen(prefix), file);