parseopt: add PARSE_OPT_NO_INTERNAL_HELP
[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
PH
246 ctx->flags = flags;
247}
248
ee68b87a 249static int usage_with_options_internal(const char * const *,
ff43ec3e 250 const struct option *, int);
dd3bf0f4 251
ff43ec3e
PH
252int parse_options_step(struct parse_opt_ctx_t *ctx,
253 const struct option *options,
254 const char * const usagestr[])
4a59fd13 255{
b92891f9
RS
256 int internal_help = !(ctx->flags & PARSE_OPT_NO_INTERNAL_HELP);
257
26141b5b
PH
258 /* we must reset ->opt, unknown short option leave it dangling */
259 ctx->opt = NULL;
260
ff43ec3e
PH
261 for (; ctx->argc; ctx->argc--, ctx->argv++) {
262 const char *arg = ctx->argv[0];
4a59fd13
PH
263
264 if (*arg != '-' || !arg[1]) {
ff43ec3e 265 if (ctx->flags & PARSE_OPT_STOP_AT_NON_OPTION)
a0ec9d25 266 break;
ff43ec3e 267 ctx->out[ctx->cpidx++] = ctx->argv[0];
4a59fd13
PH
268 continue;
269 }
270
271 if (arg[1] != '-') {
ff43ec3e 272 ctx->opt = arg + 1;
b92891f9 273 if (internal_help && *ctx->opt == 'h')
ff43ec3e 274 return parse_options_usage(usagestr, options);
07fe54db
PH
275 switch (parse_short_opt(ctx, options)) {
276 case -1:
277 return parse_options_usage(usagestr, options);
278 case -2:
b5ce3a54 279 goto unknown;
07fe54db 280 }
ff43ec3e 281 if (ctx->opt)
3a9f0f41 282 check_typos(arg + 1, options);
ff43ec3e 283 while (ctx->opt) {
b92891f9 284 if (internal_help && *ctx->opt == 'h')
ff43ec3e 285 return parse_options_usage(usagestr, options);
07fe54db
PH
286 switch (parse_short_opt(ctx, options)) {
287 case -1:
288 return parse_options_usage(usagestr, options);
289 case -2:
26141b5b
PH
290 /* fake a short option thing to hide the fact that we may have
291 * started to parse aggregated stuff
292 *
293 * This is leaky, too bad.
294 */
295 ctx->argv[0] = xstrdup(ctx->opt - 1);
296 *(char *)ctx->argv[0] = '-';
b5ce3a54 297 goto unknown;
07fe54db 298 }
3a9f0f41 299 }
4a59fd13
PH
300 continue;
301 }
302
303 if (!arg[2]) { /* "--" */
ff43ec3e
PH
304 if (!(ctx->flags & PARSE_OPT_KEEP_DASHDASH)) {
305 ctx->argc--;
306 ctx->argv++;
4a59fd13
PH
307 }
308 break;
309 }
310
b92891f9 311 if (internal_help && !strcmp(arg + 2, "help-all"))
ff43ec3e 312 return usage_with_options_internal(usagestr, options, 1);
b92891f9 313 if (internal_help && !strcmp(arg + 2, "help"))
ff43ec3e 314 return parse_options_usage(usagestr, options);
07fe54db
PH
315 switch (parse_long_opt(ctx, arg + 2, options)) {
316 case -1:
317 return parse_options_usage(usagestr, options);
318 case -2:
b5ce3a54 319 goto unknown;
07fe54db 320 }
b5ce3a54
RS
321 continue;
322unknown:
323 if (!(ctx->flags & PARSE_OPT_KEEP_UNKNOWN))
324 return PARSE_OPT_UNKNOWN;
325 ctx->out[ctx->cpidx++] = ctx->argv[0];
326 ctx->opt = NULL;
ff43ec3e
PH
327 }
328 return PARSE_OPT_DONE;
329}
330
331int parse_options_end(struct parse_opt_ctx_t *ctx)
332{
333 memmove(ctx->out + ctx->cpidx, ctx->argv, ctx->argc * sizeof(*ctx->out));
334 ctx->out[ctx->cpidx + ctx->argc] = NULL;
335 return ctx->cpidx + ctx->argc;
336}
337
338int parse_options(int argc, const char **argv, const struct option *options,
339 const char * const usagestr[], int flags)
340{
341 struct parse_opt_ctx_t ctx;
342
343 parse_options_start(&ctx, argc, argv, flags);
344 switch (parse_options_step(&ctx, options, usagestr)) {
345 case PARSE_OPT_HELP:
346 exit(129);
347 case PARSE_OPT_DONE:
348 break;
349 default: /* PARSE_OPT_UNKNOWN */
07fe54db
PH
350 if (ctx.argv[0][1] == '-') {
351 error("unknown option `%s'", ctx.argv[0] + 2);
352 } else {
353 error("unknown switch `%c'", *ctx.opt);
354 }
355 usage_with_options(usagestr, options);
4a59fd13
PH
356 }
357
7e7bbcb4 358 return parse_options_end(&ctx);
4a59fd13 359}
d7a38c54
PH
360
361#define USAGE_OPTS_WIDTH 24
362#define USAGE_GAP 2
363
ee68b87a 364int usage_with_options_internal(const char * const *usagestr,
ff43ec3e 365 const struct option *opts, int full)
d7a38c54 366{
f389c808
AR
367 fprintf(stderr, "usage: %s\n", *usagestr++);
368 while (*usagestr && **usagestr)
369 fprintf(stderr, " or: %s\n", *usagestr++);
44d86e91
JK
370 while (*usagestr) {
371 fprintf(stderr, "%s%s\n",
372 **usagestr ? " " : "",
373 *usagestr);
374 usagestr++;
375 }
d7a38c54
PH
376
377 if (opts->type != OPTION_GROUP)
f389c808 378 fputc('\n', stderr);
d7a38c54
PH
379
380 for (; opts->type != OPTION_END; opts++) {
381 size_t pos;
382 int pad;
383
384 if (opts->type == OPTION_GROUP) {
f389c808 385 fputc('\n', stderr);
d7a38c54 386 if (*opts->help)
f389c808 387 fprintf(stderr, "%s\n", opts->help);
d7a38c54
PH
388 continue;
389 }
dd3bf0f4
PH
390 if (!full && (opts->flags & PARSE_OPT_HIDDEN))
391 continue;
d7a38c54 392
f389c808 393 pos = fprintf(stderr, " ");
d7a38c54 394 if (opts->short_name)
f389c808 395 pos += fprintf(stderr, "-%c", opts->short_name);
d7a38c54 396 if (opts->long_name && opts->short_name)
f389c808 397 pos += fprintf(stderr, ", ");
d7a38c54 398 if (opts->long_name)
f389c808 399 pos += fprintf(stderr, "--%s", opts->long_name);
d7a38c54
PH
400
401 switch (opts->type) {
580d5bff
PH
402 case OPTION_ARGUMENT:
403 break;
d7a38c54 404 case OPTION_INTEGER:
ffe659f9 405 if (opts->flags & PARSE_OPT_OPTARG)
6422f633
MB
406 if (opts->long_name)
407 pos += fprintf(stderr, "[=<n>]");
408 else
409 pos += fprintf(stderr, "[<n>]");
ffe659f9
PH
410 else
411 pos += fprintf(stderr, " <n>");
d7a38c54 412 break;
ffe659f9 413 case OPTION_CALLBACK:
f481e22a
PH
414 if (opts->flags & PARSE_OPT_NOARG)
415 break;
416 /* FALLTHROUGH */
417 case OPTION_STRING:
ffe659f9
PH
418 if (opts->argh) {
419 if (opts->flags & PARSE_OPT_OPTARG)
6422f633
MB
420 if (opts->long_name)
421 pos += fprintf(stderr, "[=<%s>]", opts->argh);
422 else
423 pos += fprintf(stderr, "[<%s>]", opts->argh);
ffe659f9
PH
424 else
425 pos += fprintf(stderr, " <%s>", opts->argh);
426 } else {
427 if (opts->flags & PARSE_OPT_OPTARG)
6422f633
MB
428 if (opts->long_name)
429 pos += fprintf(stderr, "[=...]");
430 else
431 pos += fprintf(stderr, "[...]");
ffe659f9
PH
432 else
433 pos += fprintf(stderr, " ...");
434 }
d7a38c54 435 break;
db7244bd 436 default: /* OPTION_{BIT,BOOLEAN,SET_INT,SET_PTR} */
d7a38c54
PH
437 break;
438 }
439
f389c808
AR
440 if (pos <= USAGE_OPTS_WIDTH)
441 pad = USAGE_OPTS_WIDTH - pos;
d7a38c54 442 else {
f389c808 443 fputc('\n', stderr);
d7a38c54
PH
444 pad = USAGE_OPTS_WIDTH;
445 }
f389c808 446 fprintf(stderr, "%*s%s\n", pad + USAGE_GAP, "", opts->help);
d7a38c54 447 }
f389c808
AR
448 fputc('\n', stderr);
449
ee68b87a 450 return PARSE_OPT_HELP;
d7a38c54 451}
0ce865b1 452
dd3bf0f4 453void usage_with_options(const char * const *usagestr,
ff43ec3e 454 const struct option *opts)
dd3bf0f4 455{
ff43ec3e
PH
456 usage_with_options_internal(usagestr, opts, 0);
457 exit(129);
dd3bf0f4
PH
458}
459
ee68b87a
PH
460int parse_options_usage(const char * const *usagestr,
461 const struct option *opts)
462{
ff43ec3e 463 return usage_with_options_internal(usagestr, opts, 0);
ee68b87a
PH
464}
465
466
0ce865b1
PH
467/*----- some often used options -----*/
468#include "cache.h"
db7244bd 469
0ce865b1
PH
470int parse_opt_abbrev_cb(const struct option *opt, const char *arg, int unset)
471{
472 int v;
473
474 if (!arg) {
475 v = unset ? 0 : DEFAULT_ABBREV;
476 } else {
477 v = strtol(arg, (char **)&arg, 10);
478 if (*arg)
479 return opterror(opt, "expects a numerical value", 0);
480 if (v && v < MINIMUM_ABBREV)
481 v = MINIMUM_ABBREV;
482 else if (v > 40)
483 v = 40;
484 }
485 *(int *)(opt->value) = v;
486 return 0;
487}
1f4a711a
MB
488
489int parse_opt_approxidate_cb(const struct option *opt, const char *arg,
490 int unset)
491{
492 *(unsigned long *)(opt->value) = approxidate(arg);
493 return 0;
494}
dbd0f5c7 495
7f87aff2
TA
496int parse_opt_verbosity_cb(const struct option *opt, const char *arg,
497 int unset)
498{
499 int *target = opt->value;
500
501 if (unset)
502 /* --no-quiet, --no-verbose */
503 *target = 0;
504 else if (opt->short_name == 'v') {
505 if (*target >= 0)
506 (*target)++;
507 else
508 *target = 1;
509 } else {
510 if (*target <= 0)
511 (*target)--;
512 else
513 *target = -1;
514 }
515 return 0;
516}
517
269defdf
JG
518int parse_opt_with_commit(const struct option *opt, const char *arg, int unset)
519{
520 unsigned char sha1[20];
521 struct commit *commit;
522
523 if (!arg)
524 return -1;
525 if (get_sha1(arg, sha1))
526 return error("malformed object name %s", arg);
527 commit = lookup_commit_reference(sha1);
528 if (!commit)
529 return error("no such commit %s", arg);
530 commit_list_insert(commit, opt->value);
531 return 0;
532}
533
dbd0f5c7
JH
534/*
535 * This should really be OPTION_FILENAME type as a part of
536 * parse_options that take prefix to do this while parsing.
537 */
538extern const char *parse_options_fix_filename(const char *prefix, const char *file)
539{
540 if (!file || !prefix || is_absolute_path(file) || !strcmp("-", file))
541 return file;
542 return prefix_filename(prefix, strlen(prefix), file);
543}
544