parseopt: make usage optional
[git] / parse-options.c
1 #include "git-compat-util.h"
2 #include "parse-options.h"
3 #include "cache.h"
4 #include "commit.h"
5
6 #define OPT_SHORT 1
7 #define OPT_UNSET 2
8
9 static 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
18 static 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;
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;
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         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;
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;
79                 return 0;
80
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;
89
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;
100
101         case OPTION_INTEGER:
102                 if (unset) {
103                         *(int *)opt->value = 0;
104                         return 0;
105                 }
106                 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
107                         *(int *)opt->value = opt->defval;
108                         return 0;
109                 }
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;
116
117         default:
118                 die("should not happen, someone must be hit on the forehead");
119         }
120 }
121
122 static int parse_short_opt(struct parse_opt_ctx_t *p, const struct option *options)
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         }
130         return -2;
131 }
132
133 static int parse_long_opt(struct parse_opt_ctx_t *p, const char *arg,
134                           const struct option *options)
135 {
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;
139
140         if (!arg_end)
141                 arg_end = arg + strlen(arg);
142
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);
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                 }
161                 if (!rest) {
162                         /* abbreviated? */
163                         if (!strncmp(options->long_name, arg, arg_end - arg)) {
164 is_abbreviated:
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                                 }
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? */
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;
196                 }
197                 if (*rest) {
198                         if (*rest != '=')
199                                 continue;
200                         p->opt = rest + 1;
201                 }
202                 return get_value(p, options, flags);
203         }
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);
213         if (abbrev_option)
214                 return get_value(p, abbrev_option, abbrev_flags);
215         return -2;
216 }
217
218 static void check_typos(const char *arg, const struct option *options)
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
238 void 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;
245         ctx->cpidx = ((flags & PARSE_OPT_KEEP_ARGV0) != 0);
246         ctx->flags = flags;
247 }
248
249 static int usage_with_options_internal(const char * const *,
250                                        const struct option *, int);
251
252 int parse_options_step(struct parse_opt_ctx_t *ctx,
253                        const struct option *options,
254                        const char * const usagestr[])
255 {
256         int internal_help = !(ctx->flags & PARSE_OPT_NO_INTERNAL_HELP);
257
258         /* we must reset ->opt, unknown short option leave it dangling */
259         ctx->opt = NULL;
260
261         for (; ctx->argc; ctx->argc--, ctx->argv++) {
262                 const char *arg = ctx->argv[0];
263
264                 if (*arg != '-' || !arg[1]) {
265                         if (ctx->flags & PARSE_OPT_STOP_AT_NON_OPTION)
266                                 break;
267                         ctx->out[ctx->cpidx++] = ctx->argv[0];
268                         continue;
269                 }
270
271                 if (arg[1] != '-') {
272                         ctx->opt = arg + 1;
273                         if (internal_help && *ctx->opt == 'h')
274                                 return parse_options_usage(usagestr, options);
275                         switch (parse_short_opt(ctx, options)) {
276                         case -1:
277                                 return parse_options_usage(usagestr, options);
278                         case -2:
279                                 goto unknown;
280                         }
281                         if (ctx->opt)
282                                 check_typos(arg + 1, options);
283                         while (ctx->opt) {
284                                 if (internal_help && *ctx->opt == 'h')
285                                         return parse_options_usage(usagestr, options);
286                                 switch (parse_short_opt(ctx, options)) {
287                                 case -1:
288                                         return parse_options_usage(usagestr, options);
289                                 case -2:
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] = '-';
297                                         goto unknown;
298                                 }
299                         }
300                         continue;
301                 }
302
303                 if (!arg[2]) { /* "--" */
304                         if (!(ctx->flags & PARSE_OPT_KEEP_DASHDASH)) {
305                                 ctx->argc--;
306                                 ctx->argv++;
307                         }
308                         break;
309                 }
310
311                 if (internal_help && !strcmp(arg + 2, "help-all"))
312                         return usage_with_options_internal(usagestr, options, 1);
313                 if (internal_help && !strcmp(arg + 2, "help"))
314                         return parse_options_usage(usagestr, options);
315                 switch (parse_long_opt(ctx, arg + 2, options)) {
316                 case -1:
317                         return parse_options_usage(usagestr, options);
318                 case -2:
319                         goto unknown;
320                 }
321                 continue;
322 unknown:
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;
327         }
328         return PARSE_OPT_DONE;
329 }
330
331 int 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
338 int 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 */
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);
356         }
357
358         return parse_options_end(&ctx);
359 }
360
361 #define USAGE_OPTS_WIDTH 24
362 #define USAGE_GAP         2
363
364 int usage_with_options_internal(const char * const *usagestr,
365                                 const struct option *opts, int full)
366 {
367         if (!usagestr)
368                 return PARSE_OPT_HELP;
369
370         fprintf(stderr, "usage: %s\n", *usagestr++);
371         while (*usagestr && **usagestr)
372                 fprintf(stderr, "   or: %s\n", *usagestr++);
373         while (*usagestr) {
374                 fprintf(stderr, "%s%s\n",
375                                 **usagestr ? "    " : "",
376                                 *usagestr);
377                 usagestr++;
378         }
379
380         if (opts->type != OPTION_GROUP)
381                 fputc('\n', stderr);
382
383         for (; opts->type != OPTION_END; opts++) {
384                 size_t pos;
385                 int pad;
386
387                 if (opts->type == OPTION_GROUP) {
388                         fputc('\n', stderr);
389                         if (*opts->help)
390                                 fprintf(stderr, "%s\n", opts->help);
391                         continue;
392                 }
393                 if (!full && (opts->flags & PARSE_OPT_HIDDEN))
394                         continue;
395
396                 pos = fprintf(stderr, "    ");
397                 if (opts->short_name)
398                         pos += fprintf(stderr, "-%c", opts->short_name);
399                 if (opts->long_name && opts->short_name)
400                         pos += fprintf(stderr, ", ");
401                 if (opts->long_name)
402                         pos += fprintf(stderr, "--%s", opts->long_name);
403
404                 switch (opts->type) {
405                 case OPTION_ARGUMENT:
406                         break;
407                 case OPTION_INTEGER:
408                         if (opts->flags & PARSE_OPT_OPTARG)
409                                 if (opts->long_name)
410                                         pos += fprintf(stderr, "[=<n>]");
411                                 else
412                                         pos += fprintf(stderr, "[<n>]");
413                         else
414                                 pos += fprintf(stderr, " <n>");
415                         break;
416                 case OPTION_CALLBACK:
417                         if (opts->flags & PARSE_OPT_NOARG)
418                                 break;
419                         /* FALLTHROUGH */
420                 case OPTION_STRING:
421                         if (opts->argh) {
422                                 if (opts->flags & PARSE_OPT_OPTARG)
423                                         if (opts->long_name)
424                                                 pos += fprintf(stderr, "[=<%s>]", opts->argh);
425                                         else
426                                                 pos += fprintf(stderr, "[<%s>]", opts->argh);
427                                 else
428                                         pos += fprintf(stderr, " <%s>", opts->argh);
429                         } else {
430                                 if (opts->flags & PARSE_OPT_OPTARG)
431                                         if (opts->long_name)
432                                                 pos += fprintf(stderr, "[=...]");
433                                         else
434                                                 pos += fprintf(stderr, "[...]");
435                                 else
436                                         pos += fprintf(stderr, " ...");
437                         }
438                         break;
439                 default: /* OPTION_{BIT,BOOLEAN,SET_INT,SET_PTR} */
440                         break;
441                 }
442
443                 if (pos <= USAGE_OPTS_WIDTH)
444                         pad = USAGE_OPTS_WIDTH - pos;
445                 else {
446                         fputc('\n', stderr);
447                         pad = USAGE_OPTS_WIDTH;
448                 }
449                 fprintf(stderr, "%*s%s\n", pad + USAGE_GAP, "", opts->help);
450         }
451         fputc('\n', stderr);
452
453         return PARSE_OPT_HELP;
454 }
455
456 void usage_with_options(const char * const *usagestr,
457                         const struct option *opts)
458 {
459         usage_with_options_internal(usagestr, opts, 0);
460         exit(129);
461 }
462
463 int parse_options_usage(const char * const *usagestr,
464                         const struct option *opts)
465 {
466         return usage_with_options_internal(usagestr, opts, 0);
467 }
468
469
470 /*----- some often used options -----*/
471 #include "cache.h"
472
473 int parse_opt_abbrev_cb(const struct option *opt, const char *arg, int unset)
474 {
475         int v;
476
477         if (!arg) {
478                 v = unset ? 0 : DEFAULT_ABBREV;
479         } else {
480                 v = strtol(arg, (char **)&arg, 10);
481                 if (*arg)
482                         return opterror(opt, "expects a numerical value", 0);
483                 if (v && v < MINIMUM_ABBREV)
484                         v = MINIMUM_ABBREV;
485                 else if (v > 40)
486                         v = 40;
487         }
488         *(int *)(opt->value) = v;
489         return 0;
490 }
491
492 int parse_opt_approxidate_cb(const struct option *opt, const char *arg,
493                              int unset)
494 {
495         *(unsigned long *)(opt->value) = approxidate(arg);
496         return 0;
497 }
498
499 int parse_opt_verbosity_cb(const struct option *opt, const char *arg,
500                            int unset)
501 {
502         int *target = opt->value;
503
504         if (unset)
505                 /* --no-quiet, --no-verbose */
506                 *target = 0;
507         else if (opt->short_name == 'v') {
508                 if (*target >= 0)
509                         (*target)++;
510                 else
511                         *target = 1;
512         } else {
513                 if (*target <= 0)
514                         (*target)--;
515                 else
516                         *target = -1;
517         }
518         return 0;
519 }
520
521 int parse_opt_with_commit(const struct option *opt, const char *arg, int unset)
522 {
523         unsigned char sha1[20];
524         struct commit *commit;
525
526         if (!arg)
527                 return -1;
528         if (get_sha1(arg, sha1))
529                 return error("malformed object name %s", arg);
530         commit = lookup_commit_reference(sha1);
531         if (!commit)
532                 return error("no such commit %s", arg);
533         commit_list_insert(commit, opt->value);
534         return 0;
535 }
536
537 /*
538  * This should really be OPTION_FILENAME type as a part of
539  * parse_options that take prefix to do this while parsing.
540  */
541 extern const char *parse_options_fix_filename(const char *prefix, const char *file)
542 {
543         if (!file || !prefix || is_absolute_path(file) || !strcmp("-", file))
544                 return file;
545         return prefix_filename(prefix, strlen(prefix), file);
546 }
547