Start 1.6.4 development
[git/git.git] / parse-options.c
CommitLineData
4a59fd13
PH
1#include "git-compat-util.h"
2#include "parse-options.h"
26141b5b 3#include "cache.h"
269defdf 4#include "commit.h"
4a59fd13
PH
5
6#define OPT_SHORT 1
7#define OPT_UNSET 2
8
4a59fd13
PH
9static int opterror(const struct option *opt, const char *reason, int flags)
10{
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);
16}
17
1cc6985c
PH
18static int get_arg(struct parse_opt_ctx_t *p, const struct option *opt,
19 int flags, const char **arg)
20{
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;
d5d745f9 26 } else if (p->argc > 1) {
1cc6985c
PH
27 p->argc--;
28 *arg = *++p->argv;
29 } else
30 return opterror(opt, "requires a value", flags);
31 return 0;
32}
33
7e7bbcb4 34static int get_value(struct parse_opt_ctx_t *p,
1cc6985c 35 const struct option *opt, int flags)
4a59fd13 36{
ffe659f9 37 const char *s, *arg;
db7244bd 38 const int unset = flags & OPT_UNSET;
4a59fd13 39
db7244bd 40 if (unset && p->opt)
4a59fd13 41 return opterror(opt, "takes no value", flags);
db7244bd
PH
42 if (unset && (opt->flags & PARSE_OPT_NONEG))
43 return opterror(opt, "isn't available", flags);
4a59fd13 44
db7244bd
PH
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:
4a59fd13 55 return opterror(opt, "takes no value", flags);
db7244bd
PH
56 default:
57 break;
58 }
59 }
60
db7244bd
PH
61 switch (opt->type) {
62 case OPTION_BIT:
63 if (unset)
64 *(int *)opt->value &= ~opt->defval;
4a59fd13 65 else
db7244bd
PH
66 *(int *)opt->value |= opt->defval;
67 return 0;
68
69 case OPTION_BOOLEAN:
70 *(int *)opt->value = unset ? 0 : *(int *)opt->value + 1;
71 return 0;
72
73 case OPTION_SET_INT:
74 *(int *)opt->value = unset ? 0 : opt->defval;
75 return 0;
76
77 case OPTION_SET_PTR:
78 *(void **)opt->value = unset ? NULL : (void *)opt->defval;
4a59fd13
PH
79 return 0;
80
81 case OPTION_STRING:
1cc6985c 82 if (unset)
db7244bd 83 *(const char **)opt->value = NULL;
1cc6985c 84 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
ffe659f9 85 *(const char **)opt->value = (const char *)opt->defval;
1cc6985c
PH
86 else
87 return get_arg(p, opt, flags, (const char **)opt->value);
4a59fd13
PH
88 return 0;
89
ffe659f9 90 case OPTION_CALLBACK:
db7244bd 91 if (unset)
07fe54db 92 return (*opt->callback)(opt, NULL, 1) ? (-1) : 0;
db7244bd 93 if (opt->flags & PARSE_OPT_NOARG)
07fe54db 94 return (*opt->callback)(opt, NULL, 0) ? (-1) : 0;
c43a2483 95 if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
07fe54db 96 return (*opt->callback)(opt, NULL, 0) ? (-1) : 0;
1cc6985c
PH
97 if (get_arg(p, opt, flags, &arg))
98 return -1;
99 return (*opt->callback)(opt, arg, 0) ? (-1) : 0;
ffe659f9 100
4a59fd13 101 case OPTION_INTEGER:
db7244bd 102 if (unset) {
4a59fd13
PH
103 *(int *)opt->value = 0;
104 return 0;
105 }
c43a2483 106 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
ffe659f9
PH
107 *(int *)opt->value = opt->defval;
108 return 0;
109 }
1cc6985c
PH
110 if (get_arg(p, opt, flags, &arg))
111 return -1;
112 *(int *)opt->value = strtol(arg, (char **)&s, 10);
4a59fd13
PH
113 if (*s)
114 return opterror(opt, "expects a numerical value", flags);
115 return 0;
116
117 default:
118 die("should not happen, someone must be hit on the forehead");
119 }
120}
121
7e7bbcb4 122static int parse_short_opt(struct parse_opt_ctx_t *p, const struct option *options)
4a59fd13
PH
123{
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);
128 }
129 }
07fe54db 130 return -2;
4a59fd13
PH
131}
132
7e7bbcb4 133static int parse_long_opt(struct parse_opt_ctx_t *p, const char *arg,
4a59fd13
PH
134 const struct option *options)
135{
7f275b91 136 const char *arg_end = strchr(arg, '=');
243e0614
JS
137 const struct option *abbrev_option = NULL, *ambiguous_option = NULL;
138 int abbrev_flags = 0, ambiguous_flags = 0;
7f275b91
JS
139
140 if (!arg_end)
141 arg_end = arg + strlen(arg);
142
4a59fd13
PH
143 for (; options->type != OPTION_END; options++) {
144 const char *rest;
145 int flags = 0;
146
147 if (!options->long_name)
148 continue;
149
150 rest = skip_prefix(arg, options->long_name);
580d5bff
PH
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;
160 }
4a59fd13 161 if (!rest) {
7f275b91
JS
162 /* abbreviated? */
163 if (!strncmp(options->long_name, arg, arg_end - arg)) {
164is_abbreviated:
243e0614
JS
165 if (abbrev_option) {
166 /*
167 * If this is abbreviated, it is
168 * ambiguous. So when there is no
169 * exact match later, we need to
170 * error out.
171 */
172 ambiguous_option = abbrev_option;
173 ambiguous_flags = abbrev_flags;
174 }
7f275b91
JS
175 if (!(flags & OPT_UNSET) && *arg_end)
176 p->opt = arg_end + 1;
177 abbrev_option = options;
178 abbrev_flags = flags;
179 continue;
180 }
181 /* negated and abbreviated very much? */
182 if (!prefixcmp("no-", arg)) {
183 flags |= OPT_UNSET;
184 goto is_abbreviated;
185 }
186 /* negated? */
4a59fd13
PH
187 if (strncmp(arg, "no-", 3))
188 continue;
189 flags |= OPT_UNSET;
190 rest = skip_prefix(arg + 3, options->long_name);
7f275b91
JS
191 /* abbreviated and negated? */
192 if (!rest && !prefixcmp(options->long_name, arg + 3))
193 goto is_abbreviated;
4a59fd13
PH
194 if (!rest)
195 continue;
196 }
197 if (*rest) {
198 if (*rest != '=')
199 continue;
200 p->opt = rest + 1;
201 }
202 return get_value(p, options, flags);
203 }
243e0614
JS
204
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);
7f275b91
JS
213 if (abbrev_option)
214 return get_value(p, abbrev_option, abbrev_flags);
07fe54db 215 return -2;
4a59fd13
PH
216}
217
1121a878 218static void check_typos(const char *arg, const struct option *options)
3a9f0f41
PH
219{
220 if (strlen(arg) < 3)
221 return;
222
223 if (!prefixcmp(arg, "no-")) {
224 error ("did you mean `--%s` (with two dashes ?)", arg);
225 exit(129);
226 }
227
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);
234 }
235 }
236}
237
7e7bbcb4
PH
238void parse_options_start(struct parse_opt_ctx_t *ctx,
239 int argc, const char **argv, int flags)
240{
241 memset(ctx, 0, sizeof(*ctx));
242 ctx->argc = argc - 1;
243 ctx->argv = argv + 1;
244 ctx->out = argv;
a32a4eaa 245 ctx->cpidx = ((flags & PARSE_OPT_KEEP_ARGV0) != 0);
7e7bbcb4 246 ctx->flags = flags;
0d260f9a
RS
247 if ((flags & PARSE_OPT_KEEP_UNKNOWN) &&
248 (flags & PARSE_OPT_STOP_AT_NON_OPTION))
249 die("STOP_AT_NON_OPTION and KEEP_UNKNOWN don't go together");
7e7bbcb4
PH
250}
251
ee68b87a 252static int usage_with_options_internal(const char * const *,
ff43ec3e 253 const struct option *, int);
dd3bf0f4 254
ff43ec3e
PH
255int parse_options_step(struct parse_opt_ctx_t *ctx,
256 const struct option *options,
257 const char * const usagestr[])
4a59fd13 258{
b92891f9
RS
259 int internal_help = !(ctx->flags & PARSE_OPT_NO_INTERNAL_HELP);
260
26141b5b
PH
261 /* we must reset ->opt, unknown short option leave it dangling */
262 ctx->opt = NULL;
263
ff43ec3e
PH
264 for (; ctx->argc; ctx->argc--, ctx->argv++) {
265 const char *arg = ctx->argv[0];
4a59fd13
PH
266
267 if (*arg != '-' || !arg[1]) {
ff43ec3e 268 if (ctx->flags & PARSE_OPT_STOP_AT_NON_OPTION)
a0ec9d25 269 break;
ff43ec3e 270 ctx->out[ctx->cpidx++] = ctx->argv[0];
4a59fd13
PH
271 continue;
272 }
273
274 if (arg[1] != '-') {
ff43ec3e 275 ctx->opt = arg + 1;
b92891f9 276 if (internal_help && *ctx->opt == 'h')
ff43ec3e 277 return parse_options_usage(usagestr, options);
07fe54db
PH
278 switch (parse_short_opt(ctx, options)) {
279 case -1:
280 return parse_options_usage(usagestr, options);
281 case -2:
b5ce3a54 282 goto unknown;
07fe54db 283 }
ff43ec3e 284 if (ctx->opt)
3a9f0f41 285 check_typos(arg + 1, options);
ff43ec3e 286 while (ctx->opt) {
b92891f9 287 if (internal_help && *ctx->opt == 'h')
ff43ec3e 288 return parse_options_usage(usagestr, options);
07fe54db
PH
289 switch (parse_short_opt(ctx, options)) {
290 case -1:
291 return parse_options_usage(usagestr, options);
292 case -2:
26141b5b
PH
293 /* fake a short option thing to hide the fact that we may have
294 * started to parse aggregated stuff
295 *
296 * This is leaky, too bad.
297 */
298 ctx->argv[0] = xstrdup(ctx->opt - 1);
299 *(char *)ctx->argv[0] = '-';
b5ce3a54 300 goto unknown;
07fe54db 301 }
3a9f0f41 302 }
4a59fd13
PH
303 continue;
304 }
305
306 if (!arg[2]) { /* "--" */
ff43ec3e
PH
307 if (!(ctx->flags & PARSE_OPT_KEEP_DASHDASH)) {
308 ctx->argc--;
309 ctx->argv++;
4a59fd13
PH
310 }
311 break;
312 }
313
b92891f9 314 if (internal_help && !strcmp(arg + 2, "help-all"))
ff43ec3e 315 return usage_with_options_internal(usagestr, options, 1);
b92891f9 316 if (internal_help && !strcmp(arg + 2, "help"))
ff43ec3e 317 return parse_options_usage(usagestr, options);
07fe54db
PH
318 switch (parse_long_opt(ctx, arg + 2, options)) {
319 case -1:
320 return parse_options_usage(usagestr, options);
321 case -2:
b5ce3a54 322 goto unknown;
07fe54db 323 }
b5ce3a54
RS
324 continue;
325unknown:
326 if (!(ctx->flags & PARSE_OPT_KEEP_UNKNOWN))
327 return PARSE_OPT_UNKNOWN;
328 ctx->out[ctx->cpidx++] = ctx->argv[0];
329 ctx->opt = NULL;
ff43ec3e
PH
330 }
331 return PARSE_OPT_DONE;
332}
333
334int parse_options_end(struct parse_opt_ctx_t *ctx)
335{
336 memmove(ctx->out + ctx->cpidx, ctx->argv, ctx->argc * sizeof(*ctx->out));
337 ctx->out[ctx->cpidx + ctx->argc] = NULL;
338 return ctx->cpidx + ctx->argc;
339}
340
341int parse_options(int argc, const char **argv, const struct option *options,
342 const char * const usagestr[], int flags)
343{
344 struct parse_opt_ctx_t ctx;
345
346 parse_options_start(&ctx, argc, argv, flags);
347 switch (parse_options_step(&ctx, options, usagestr)) {
348 case PARSE_OPT_HELP:
349 exit(129);
350 case PARSE_OPT_DONE:
351 break;
352 default: /* PARSE_OPT_UNKNOWN */
07fe54db
PH
353 if (ctx.argv[0][1] == '-') {
354 error("unknown option `%s'", ctx.argv[0] + 2);
355 } else {
356 error("unknown switch `%c'", *ctx.opt);
357 }
358 usage_with_options(usagestr, options);
4a59fd13
PH
359 }
360
7e7bbcb4 361 return parse_options_end(&ctx);
4a59fd13 362}
d7a38c54
PH
363
364#define USAGE_OPTS_WIDTH 24
365#define USAGE_GAP 2
366
ee68b87a 367int usage_with_options_internal(const char * const *usagestr,
ff43ec3e 368 const struct option *opts, int full)
d7a38c54 369{
49b61802
RS
370 if (!usagestr)
371 return PARSE_OPT_HELP;
372
f389c808
AR
373 fprintf(stderr, "usage: %s\n", *usagestr++);
374 while (*usagestr && **usagestr)
375 fprintf(stderr, " or: %s\n", *usagestr++);
44d86e91
JK
376 while (*usagestr) {
377 fprintf(stderr, "%s%s\n",
378 **usagestr ? " " : "",
379 *usagestr);
380 usagestr++;
381 }
d7a38c54
PH
382
383 if (opts->type != OPTION_GROUP)
f389c808 384 fputc('\n', stderr);
d7a38c54
PH
385
386 for (; opts->type != OPTION_END; opts++) {
387 size_t pos;
388 int pad;
389
390 if (opts->type == OPTION_GROUP) {
f389c808 391 fputc('\n', stderr);
d7a38c54 392 if (*opts->help)
f389c808 393 fprintf(stderr, "%s\n", opts->help);
d7a38c54
PH
394 continue;
395 }
dd3bf0f4
PH
396 if (!full && (opts->flags & PARSE_OPT_HIDDEN))
397 continue;
d7a38c54 398
f389c808 399 pos = fprintf(stderr, " ");
d7a38c54 400 if (opts->short_name)
f389c808 401 pos += fprintf(stderr, "-%c", opts->short_name);
d7a38c54 402 if (opts->long_name && opts->short_name)
f389c808 403 pos += fprintf(stderr, ", ");
d7a38c54 404 if (opts->long_name)
f389c808 405 pos += fprintf(stderr, "--%s", opts->long_name);
d7a38c54
PH
406
407 switch (opts->type) {
580d5bff
PH
408 case OPTION_ARGUMENT:
409 break;
d7a38c54 410 case OPTION_INTEGER:
ffe659f9 411 if (opts->flags & PARSE_OPT_OPTARG)
6422f633
MB
412 if (opts->long_name)
413 pos += fprintf(stderr, "[=<n>]");
414 else
415 pos += fprintf(stderr, "[<n>]");
ffe659f9
PH
416 else
417 pos += fprintf(stderr, " <n>");
d7a38c54 418 break;
ffe659f9 419 case OPTION_CALLBACK:
f481e22a
PH
420 if (opts->flags & PARSE_OPT_NOARG)
421 break;
422 /* FALLTHROUGH */
423 case OPTION_STRING:
ffe659f9
PH
424 if (opts->argh) {
425 if (opts->flags & PARSE_OPT_OPTARG)
6422f633
MB
426 if (opts->long_name)
427 pos += fprintf(stderr, "[=<%s>]", opts->argh);
428 else
429 pos += fprintf(stderr, "[<%s>]", opts->argh);
ffe659f9
PH
430 else
431 pos += fprintf(stderr, " <%s>", opts->argh);
432 } else {
433 if (opts->flags & PARSE_OPT_OPTARG)
6422f633
MB
434 if (opts->long_name)
435 pos += fprintf(stderr, "[=...]");
436 else
437 pos += fprintf(stderr, "[...]");
ffe659f9
PH
438 else
439 pos += fprintf(stderr, " ...");
440 }
d7a38c54 441 break;
db7244bd 442 default: /* OPTION_{BIT,BOOLEAN,SET_INT,SET_PTR} */
d7a38c54
PH
443 break;
444 }
445
f389c808
AR
446 if (pos <= USAGE_OPTS_WIDTH)
447 pad = USAGE_OPTS_WIDTH - pos;
d7a38c54 448 else {
f389c808 449 fputc('\n', stderr);
d7a38c54
PH
450 pad = USAGE_OPTS_WIDTH;
451 }
f389c808 452 fprintf(stderr, "%*s%s\n", pad + USAGE_GAP, "", opts->help);
d7a38c54 453 }
f389c808
AR
454 fputc('\n', stderr);
455
ee68b87a 456 return PARSE_OPT_HELP;
d7a38c54 457}
0ce865b1 458
dd3bf0f4 459void usage_with_options(const char * const *usagestr,
ff43ec3e 460 const struct option *opts)
dd3bf0f4 461{
ff43ec3e
PH
462 usage_with_options_internal(usagestr, opts, 0);
463 exit(129);
dd3bf0f4
PH
464}
465
ee68b87a
PH
466int parse_options_usage(const char * const *usagestr,
467 const struct option *opts)
468{
ff43ec3e 469 return usage_with_options_internal(usagestr, opts, 0);
ee68b87a
PH
470}
471
472
0ce865b1
PH
473/*----- some often used options -----*/
474#include "cache.h"
db7244bd 475
0ce865b1
PH
476int parse_opt_abbrev_cb(const struct option *opt, const char *arg, int unset)
477{
478 int v;
479
480 if (!arg) {
481 v = unset ? 0 : DEFAULT_ABBREV;
482 } else {
483 v = strtol(arg, (char **)&arg, 10);
484 if (*arg)
485 return opterror(opt, "expects a numerical value", 0);
486 if (v && v < MINIMUM_ABBREV)
487 v = MINIMUM_ABBREV;
488 else if (v > 40)
489 v = 40;
490 }
491 *(int *)(opt->value) = v;
492 return 0;
493}
1f4a711a
MB
494
495int parse_opt_approxidate_cb(const struct option *opt, const char *arg,
496 int unset)
497{
498 *(unsigned long *)(opt->value) = approxidate(arg);
499 return 0;
500}
dbd0f5c7 501
7f87aff2
TA
502int parse_opt_verbosity_cb(const struct option *opt, const char *arg,
503 int unset)
504{
505 int *target = opt->value;
506
507 if (unset)
508 /* --no-quiet, --no-verbose */
509 *target = 0;
510 else if (opt->short_name == 'v') {
511 if (*target >= 0)
512 (*target)++;
513 else
514 *target = 1;
515 } else {
516 if (*target <= 0)
517 (*target)--;
518 else
519 *target = -1;
520 }
521 return 0;
522}
523
269defdf
JG
524int parse_opt_with_commit(const struct option *opt, const char *arg, int unset)
525{
526 unsigned char sha1[20];
527 struct commit *commit;
528
529 if (!arg)
530 return -1;
531 if (get_sha1(arg, sha1))
532 return error("malformed object name %s", arg);
533 commit = lookup_commit_reference(sha1);
534 if (!commit)
535 return error("no such commit %s", arg);
536 commit_list_insert(commit, opt->value);
537 return 0;
538}
539
dbd0f5c7
JH
540/*
541 * This should really be OPTION_FILENAME type as a part of
542 * parse_options that take prefix to do this while parsing.
543 */
544extern const char *parse_options_fix_filename(const char *prefix, const char *file)
545{
546 if (!file || !prefix || is_absolute_path(file) || !strcmp("-", file))
547 return file;
548 return prefix_filename(prefix, strlen(prefix), file);
549}
550