parse-opt: fake short strings for callers to believe in.
[git/git.git] / parse-options.c
1 #include "git-compat-util.h"
2 #include "parse-options.h"
3 #include "cache.h"
4
5 #define OPT_SHORT 1
6 #define OPT_UNSET 2
7
8 static inline const char *get_arg(struct parse_opt_ctx_t *p)
9 {
10 if (p->opt) {
11 const char *res = p->opt;
12 p->opt = NULL;
13 return res;
14 }
15 p->argc--;
16 return *++p->argv;
17 }
18
19 static inline const char *skip_prefix(const char *str, const char *prefix)
20 {
21 size_t len = strlen(prefix);
22 return strncmp(str, prefix, len) ? NULL : str + len;
23 }
24
25 static int opterror(const struct option *opt, const char *reason, int flags)
26 {
27 if (flags & OPT_SHORT)
28 return error("switch `%c' %s", opt->short_name, reason);
29 if (flags & OPT_UNSET)
30 return error("option `no-%s' %s", opt->long_name, reason);
31 return error("option `%s' %s", opt->long_name, reason);
32 }
33
34 static int get_value(struct parse_opt_ctx_t *p,
35 const struct option *opt, int flags)
36 {
37 const char *s, *arg;
38 const int unset = flags & OPT_UNSET;
39
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);
44
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;
58 }
59 }
60
61 arg = p->opt ? p->opt : (p->argc > 1 ? p->argv[1] : NULL);
62 switch (opt->type) {
63 case OPTION_BIT:
64 if (unset)
65 *(int *)opt->value &= ~opt->defval;
66 else
67 *(int *)opt->value |= opt->defval;
68 return 0;
69
70 case OPTION_BOOLEAN:
71 *(int *)opt->value = unset ? 0 : *(int *)opt->value + 1;
72 return 0;
73
74 case OPTION_SET_INT:
75 *(int *)opt->value = unset ? 0 : opt->defval;
76 return 0;
77
78 case OPTION_SET_PTR:
79 *(void **)opt->value = unset ? NULL : (void *)opt->defval;
80 return 0;
81
82 case OPTION_STRING:
83 if (unset) {
84 *(const char **)opt->value = NULL;
85 return 0;
86 }
87 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
88 *(const char **)opt->value = (const char *)opt->defval;
89 return 0;
90 }
91 if (!arg)
92 return opterror(opt, "requires a value", flags);
93 *(const char **)opt->value = get_arg(p);
94 return 0;
95
96 case OPTION_CALLBACK:
97 if (unset)
98 return (*opt->callback)(opt, NULL, 1) ? (-1) : 0;
99 if (opt->flags & PARSE_OPT_NOARG)
100 return (*opt->callback)(opt, NULL, 0) ? (-1) : 0;
101 if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
102 return (*opt->callback)(opt, NULL, 0) ? (-1) : 0;
103 if (!arg)
104 return opterror(opt, "requires a value", flags);
105 return (*opt->callback)(opt, get_arg(p), 0) ? (-1) : 0;
106
107 case OPTION_INTEGER:
108 if (unset) {
109 *(int *)opt->value = 0;
110 return 0;
111 }
112 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
113 *(int *)opt->value = opt->defval;
114 return 0;
115 }
116 if (!arg)
117 return opterror(opt, "requires a value", flags);
118 *(int *)opt->value = strtol(get_arg(p), (char **)&s, 10);
119 if (*s)
120 return opterror(opt, "expects a numerical value", flags);
121 return 0;
122
123 default:
124 die("should not happen, someone must be hit on the forehead");
125 }
126 }
127
128 static int parse_short_opt(struct parse_opt_ctx_t *p, const struct option *options)
129 {
130 for (; options->type != OPTION_END; options++) {
131 if (options->short_name == *p->opt) {
132 p->opt = p->opt[1] ? p->opt + 1 : NULL;
133 return get_value(p, options, OPT_SHORT);
134 }
135 }
136 return -2;
137 }
138
139 static int parse_long_opt(struct parse_opt_ctx_t *p, const char *arg,
140 const struct option *options)
141 {
142 const char *arg_end = strchr(arg, '=');
143 const struct option *abbrev_option = NULL, *ambiguous_option = NULL;
144 int abbrev_flags = 0, ambiguous_flags = 0;
145
146 if (!arg_end)
147 arg_end = arg + strlen(arg);
148
149 for (; options->type != OPTION_END; options++) {
150 const char *rest;
151 int flags = 0;
152
153 if (!options->long_name)
154 continue;
155
156 rest = skip_prefix(arg, options->long_name);
157 if (options->type == OPTION_ARGUMENT) {
158 if (!rest)
159 continue;
160 if (*rest == '=')
161 return opterror(options, "takes no value", flags);
162 if (*rest)
163 continue;
164 p->out[p->cpidx++] = arg - 2;
165 return 0;
166 }
167 if (!rest) {
168 /* abbreviated? */
169 if (!strncmp(options->long_name, arg, arg_end - arg)) {
170 is_abbreviated:
171 if (abbrev_option) {
172 /*
173 * If this is abbreviated, it is
174 * ambiguous. So when there is no
175 * exact match later, we need to
176 * error out.
177 */
178 ambiguous_option = abbrev_option;
179 ambiguous_flags = abbrev_flags;
180 }
181 if (!(flags & OPT_UNSET) && *arg_end)
182 p->opt = arg_end + 1;
183 abbrev_option = options;
184 abbrev_flags = flags;
185 continue;
186 }
187 /* negated and abbreviated very much? */
188 if (!prefixcmp("no-", arg)) {
189 flags |= OPT_UNSET;
190 goto is_abbreviated;
191 }
192 /* negated? */
193 if (strncmp(arg, "no-", 3))
194 continue;
195 flags |= OPT_UNSET;
196 rest = skip_prefix(arg + 3, options->long_name);
197 /* abbreviated and negated? */
198 if (!rest && !prefixcmp(options->long_name, arg + 3))
199 goto is_abbreviated;
200 if (!rest)
201 continue;
202 }
203 if (*rest) {
204 if (*rest != '=')
205 continue;
206 p->opt = rest + 1;
207 }
208 return get_value(p, options, flags);
209 }
210
211 if (ambiguous_option)
212 return error("Ambiguous option: %s "
213 "(could be --%s%s or --%s%s)",
214 arg,
215 (ambiguous_flags & OPT_UNSET) ? "no-" : "",
216 ambiguous_option->long_name,
217 (abbrev_flags & OPT_UNSET) ? "no-" : "",
218 abbrev_option->long_name);
219 if (abbrev_option)
220 return get_value(p, abbrev_option, abbrev_flags);
221 return -2;
222 }
223
224 void check_typos(const char *arg, const struct option *options)
225 {
226 if (strlen(arg) < 3)
227 return;
228
229 if (!prefixcmp(arg, "no-")) {
230 error ("did you mean `--%s` (with two dashes ?)", arg);
231 exit(129);
232 }
233
234 for (; options->type != OPTION_END; options++) {
235 if (!options->long_name)
236 continue;
237 if (!prefixcmp(options->long_name, arg)) {
238 error ("did you mean `--%s` (with two dashes ?)", arg);
239 exit(129);
240 }
241 }
242 }
243
244 void parse_options_start(struct parse_opt_ctx_t *ctx,
245 int argc, const char **argv, int flags)
246 {
247 memset(ctx, 0, sizeof(*ctx));
248 ctx->argc = argc - 1;
249 ctx->argv = argv + 1;
250 ctx->out = argv;
251 ctx->flags = flags;
252 }
253
254 static int usage_with_options_internal(const char * const *,
255 const struct option *, int);
256
257 int parse_options_step(struct parse_opt_ctx_t *ctx,
258 const struct option *options,
259 const char * const usagestr[])
260 {
261 /* we must reset ->opt, unknown short option leave it dangling */
262 ctx->opt = NULL;
263
264 for (; ctx->argc; ctx->argc--, ctx->argv++) {
265 const char *arg = ctx->argv[0];
266
267 if (*arg != '-' || !arg[1]) {
268 if (ctx->flags & PARSE_OPT_STOP_AT_NON_OPTION)
269 break;
270 ctx->out[ctx->cpidx++] = ctx->argv[0];
271 continue;
272 }
273
274 if (arg[1] != '-') {
275 ctx->opt = arg + 1;
276 if (*ctx->opt == 'h')
277 return parse_options_usage(usagestr, options);
278 switch (parse_short_opt(ctx, options)) {
279 case -1:
280 return parse_options_usage(usagestr, options);
281 case -2:
282 return PARSE_OPT_UNKNOWN;
283 }
284 if (ctx->opt)
285 check_typos(arg + 1, options);
286 while (ctx->opt) {
287 if (*ctx->opt == 'h')
288 return parse_options_usage(usagestr, options);
289 switch (parse_short_opt(ctx, options)) {
290 case -1:
291 return parse_options_usage(usagestr, options);
292 case -2:
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] = '-';
300 return PARSE_OPT_UNKNOWN;
301 }
302 }
303 continue;
304 }
305
306 if (!arg[2]) { /* "--" */
307 if (!(ctx->flags & PARSE_OPT_KEEP_DASHDASH)) {
308 ctx->argc--;
309 ctx->argv++;
310 }
311 break;
312 }
313
314 if (!strcmp(arg + 2, "help-all"))
315 return usage_with_options_internal(usagestr, options, 1);
316 if (!strcmp(arg + 2, "help"))
317 return parse_options_usage(usagestr, options);
318 switch (parse_long_opt(ctx, arg + 2, options)) {
319 case -1:
320 return parse_options_usage(usagestr, options);
321 case -2:
322 return PARSE_OPT_UNKNOWN;
323 }
324 }
325 return PARSE_OPT_DONE;
326 }
327
328 int parse_options_end(struct parse_opt_ctx_t *ctx)
329 {
330 memmove(ctx->out + ctx->cpidx, ctx->argv, ctx->argc * sizeof(*ctx->out));
331 ctx->out[ctx->cpidx + ctx->argc] = NULL;
332 return ctx->cpidx + ctx->argc;
333 }
334
335 int parse_options(int argc, const char **argv, const struct option *options,
336 const char * const usagestr[], int flags)
337 {
338 struct parse_opt_ctx_t ctx;
339
340 parse_options_start(&ctx, argc, argv, flags);
341 switch (parse_options_step(&ctx, options, usagestr)) {
342 case PARSE_OPT_HELP:
343 exit(129);
344 case PARSE_OPT_DONE:
345 break;
346 default: /* PARSE_OPT_UNKNOWN */
347 if (ctx.argv[0][1] == '-') {
348 error("unknown option `%s'", ctx.argv[0] + 2);
349 } else {
350 error("unknown switch `%c'", *ctx.opt);
351 }
352 usage_with_options(usagestr, options);
353 }
354
355 return parse_options_end(&ctx);
356 }
357
358 #define USAGE_OPTS_WIDTH 24
359 #define USAGE_GAP 2
360
361 int usage_with_options_internal(const char * const *usagestr,
362 const struct option *opts, int full)
363 {
364 fprintf(stderr, "usage: %s\n", *usagestr++);
365 while (*usagestr && **usagestr)
366 fprintf(stderr, " or: %s\n", *usagestr++);
367 while (*usagestr) {
368 fprintf(stderr, "%s%s\n",
369 **usagestr ? " " : "",
370 *usagestr);
371 usagestr++;
372 }
373
374 if (opts->type != OPTION_GROUP)
375 fputc('\n', stderr);
376
377 for (; opts->type != OPTION_END; opts++) {
378 size_t pos;
379 int pad;
380
381 if (opts->type == OPTION_GROUP) {
382 fputc('\n', stderr);
383 if (*opts->help)
384 fprintf(stderr, "%s\n", opts->help);
385 continue;
386 }
387 if (!full && (opts->flags & PARSE_OPT_HIDDEN))
388 continue;
389
390 pos = fprintf(stderr, " ");
391 if (opts->short_name)
392 pos += fprintf(stderr, "-%c", opts->short_name);
393 if (opts->long_name && opts->short_name)
394 pos += fprintf(stderr, ", ");
395 if (opts->long_name)
396 pos += fprintf(stderr, "--%s", opts->long_name);
397
398 switch (opts->type) {
399 case OPTION_ARGUMENT:
400 break;
401 case OPTION_INTEGER:
402 if (opts->flags & PARSE_OPT_OPTARG)
403 if (opts->long_name)
404 pos += fprintf(stderr, "[=<n>]");
405 else
406 pos += fprintf(stderr, "[<n>]");
407 else
408 pos += fprintf(stderr, " <n>");
409 break;
410 case OPTION_CALLBACK:
411 if (opts->flags & PARSE_OPT_NOARG)
412 break;
413 /* FALLTHROUGH */
414 case OPTION_STRING:
415 if (opts->argh) {
416 if (opts->flags & PARSE_OPT_OPTARG)
417 if (opts->long_name)
418 pos += fprintf(stderr, "[=<%s>]", opts->argh);
419 else
420 pos += fprintf(stderr, "[<%s>]", opts->argh);
421 else
422 pos += fprintf(stderr, " <%s>", opts->argh);
423 } else {
424 if (opts->flags & PARSE_OPT_OPTARG)
425 if (opts->long_name)
426 pos += fprintf(stderr, "[=...]");
427 else
428 pos += fprintf(stderr, "[...]");
429 else
430 pos += fprintf(stderr, " ...");
431 }
432 break;
433 default: /* OPTION_{BIT,BOOLEAN,SET_INT,SET_PTR} */
434 break;
435 }
436
437 if (pos <= USAGE_OPTS_WIDTH)
438 pad = USAGE_OPTS_WIDTH - pos;
439 else {
440 fputc('\n', stderr);
441 pad = USAGE_OPTS_WIDTH;
442 }
443 fprintf(stderr, "%*s%s\n", pad + USAGE_GAP, "", opts->help);
444 }
445 fputc('\n', stderr);
446
447 return PARSE_OPT_HELP;
448 }
449
450 void usage_with_options(const char * const *usagestr,
451 const struct option *opts)
452 {
453 usage_with_options_internal(usagestr, opts, 0);
454 exit(129);
455 }
456
457 int parse_options_usage(const char * const *usagestr,
458 const struct option *opts)
459 {
460 return usage_with_options_internal(usagestr, opts, 0);
461 }
462
463
464 /*----- some often used options -----*/
465 #include "cache.h"
466
467 int parse_opt_abbrev_cb(const struct option *opt, const char *arg, int unset)
468 {
469 int v;
470
471 if (!arg) {
472 v = unset ? 0 : DEFAULT_ABBREV;
473 } else {
474 v = strtol(arg, (char **)&arg, 10);
475 if (*arg)
476 return opterror(opt, "expects a numerical value", 0);
477 if (v && v < MINIMUM_ABBREV)
478 v = MINIMUM_ABBREV;
479 else if (v > 40)
480 v = 40;
481 }
482 *(int *)(opt->value) = v;
483 return 0;
484 }
485
486 int parse_opt_approxidate_cb(const struct option *opt, const char *arg,
487 int unset)
488 {
489 *(unsigned long *)(opt->value) = approxidate(arg);
490 return 0;
491 }