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