Merge commit 'git/master'
[git/git-bigfiles.git] / parse-options.c
blobcf71bcffd2e1e9aeacb44df488b0825f09d54255
1 #include "git-compat-util.h"
2 #include "parse-options.h"
3 #include "cache.h"
4 #include "commit.h"
6 #define OPT_SHORT 1
7 #define OPT_UNSET 2
9 static int opterror(const struct option *opt, const char *reason, int flags)
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);
18 static int get_arg(struct parse_opt_ctx_t *p, const struct option *opt,
19 int flags, const char **arg)
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;
34 static int get_value(struct parse_opt_ctx_t *p,
35 const struct option *opt, int flags)
37 const char *s, *arg;
38 const int unset = flags & OPT_UNSET;
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);
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;
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;
69 case OPTION_BOOLEAN:
70 *(int *)opt->value = unset ? 0 : *(int *)opt->value + 1;
71 return 0;
73 case OPTION_SET_INT:
74 *(int *)opt->value = unset ? 0 : opt->defval;
75 return 0;
77 case OPTION_SET_PTR:
78 *(void **)opt->value = unset ? NULL : (void *)opt->defval;
79 return 0;
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;
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;
101 case OPTION_INTEGER:
102 if (unset) {
103 *(int *)opt->value = 0;
104 return 0;
106 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
107 *(int *)opt->value = opt->defval;
108 return 0;
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;
117 default:
118 die("should not happen, someone must be hit on the forehead");
122 static int parse_short_opt(struct parse_opt_ctx_t *p, const struct option *options)
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);
130 return -2;
133 static int parse_long_opt(struct parse_opt_ctx_t *p, const char *arg,
134 const struct option *options)
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;
140 if (!arg_end)
141 arg_end = arg + strlen(arg);
143 for (; options->type != OPTION_END; options++) {
144 const char *rest;
145 int flags = 0;
147 if (!options->long_name)
148 continue;
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;
161 if (!rest) {
162 /* abbreviated? */
163 if (!strncmp(options->long_name, arg, arg_end - arg)) {
164 is_abbreviated:
165 if (abbrev_option) {
167 * If this is abbreviated, it is
168 * ambiguous. So when there is no
169 * exact match later, we need to
170 * error out.
172 ambiguous_option = abbrev_option;
173 ambiguous_flags = abbrev_flags;
175 if (!(flags & OPT_UNSET) && *arg_end)
176 p->opt = arg_end + 1;
177 abbrev_option = options;
178 abbrev_flags = flags;
179 continue;
181 /* negated and abbreviated very much? */
182 if (!prefixcmp("no-", arg)) {
183 flags |= OPT_UNSET;
184 goto is_abbreviated;
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;
197 if (*rest) {
198 if (*rest != '=')
199 continue;
200 p->opt = rest + 1;
202 return get_value(p, options, flags);
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;
218 static void check_typos(const char *arg, const struct option *options)
220 if (strlen(arg) < 3)
221 return;
223 if (!prefixcmp(arg, "no-")) {
224 error ("did you mean `--%s` (with two dashes ?)", arg);
225 exit(129);
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);
238 void parse_options_start(struct parse_opt_ctx_t *ctx,
239 int argc, const char **argv, int flags)
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 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");
252 static int usage_with_options_internal(const char * const *,
253 const struct option *, int);
255 int parse_options_step(struct parse_opt_ctx_t *ctx,
256 const struct option *options,
257 const char * const usagestr[])
259 int internal_help = !(ctx->flags & PARSE_OPT_NO_INTERNAL_HELP);
261 /* we must reset ->opt, unknown short option leave it dangling */
262 ctx->opt = NULL;
264 for (; ctx->argc; ctx->argc--, ctx->argv++) {
265 const char *arg = ctx->argv[0];
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;
274 if (arg[1] != '-') {
275 ctx->opt = arg + 1;
276 if (internal_help && *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 goto unknown;
284 if (ctx->opt)
285 check_typos(arg + 1, options);
286 while (ctx->opt) {
287 if (internal_help && *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
296 * This is leaky, too bad.
298 ctx->argv[0] = xstrdup(ctx->opt - 1);
299 *(char *)ctx->argv[0] = '-';
300 goto unknown;
303 continue;
306 if (!arg[2]) { /* "--" */
307 if (!(ctx->flags & PARSE_OPT_KEEP_DASHDASH)) {
308 ctx->argc--;
309 ctx->argv++;
311 break;
314 if (internal_help && !strcmp(arg + 2, "help-all"))
315 return usage_with_options_internal(usagestr, options, 1);
316 if (internal_help && !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 goto unknown;
324 continue;
325 unknown:
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;
331 return PARSE_OPT_DONE;
334 int parse_options_end(struct parse_opt_ctx_t *ctx)
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;
341 int parse_options(int argc, const char **argv, const struct option *options,
342 const char * const usagestr[], int flags)
344 struct parse_opt_ctx_t ctx;
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 */
353 if (ctx.argv[0][1] == '-') {
354 error("unknown option `%s'", ctx.argv[0] + 2);
355 } else {
356 error("unknown switch `%c'", *ctx.opt);
358 usage_with_options(usagestr, options);
361 return parse_options_end(&ctx);
364 #define USAGE_OPTS_WIDTH 24
365 #define USAGE_GAP 2
367 int usage_with_options_internal(const char * const *usagestr,
368 const struct option *opts, int full)
370 if (!usagestr)
371 return PARSE_OPT_HELP;
373 fprintf(stderr, "usage: %s\n", *usagestr++);
374 while (*usagestr && **usagestr)
375 fprintf(stderr, " or: %s\n", *usagestr++);
376 while (*usagestr) {
377 fprintf(stderr, "%s%s\n",
378 **usagestr ? " " : "",
379 *usagestr);
380 usagestr++;
383 if (opts->type != OPTION_GROUP)
384 fputc('\n', stderr);
386 for (; opts->type != OPTION_END; opts++) {
387 size_t pos;
388 int pad;
390 if (opts->type == OPTION_GROUP) {
391 fputc('\n', stderr);
392 if (*opts->help)
393 fprintf(stderr, "%s\n", opts->help);
394 continue;
396 if (!full && (opts->flags & PARSE_OPT_HIDDEN))
397 continue;
399 pos = fprintf(stderr, " ");
400 if (opts->short_name)
401 pos += fprintf(stderr, "-%c", opts->short_name);
402 if (opts->long_name && opts->short_name)
403 pos += fprintf(stderr, ", ");
404 if (opts->long_name)
405 pos += fprintf(stderr, "--%s", opts->long_name);
407 switch (opts->type) {
408 case OPTION_ARGUMENT:
409 break;
410 case OPTION_INTEGER:
411 if (opts->flags & PARSE_OPT_OPTARG)
412 if (opts->long_name)
413 pos += fprintf(stderr, "[=<n>]");
414 else
415 pos += fprintf(stderr, "[<n>]");
416 else
417 pos += fprintf(stderr, " <n>");
418 break;
419 case OPTION_CALLBACK:
420 if (opts->flags & PARSE_OPT_NOARG)
421 break;
422 /* FALLTHROUGH */
423 case OPTION_STRING:
424 if (opts->argh) {
425 if (opts->flags & PARSE_OPT_OPTARG)
426 if (opts->long_name)
427 pos += fprintf(stderr, "[=<%s>]", opts->argh);
428 else
429 pos += fprintf(stderr, "[<%s>]", opts->argh);
430 else
431 pos += fprintf(stderr, " <%s>", opts->argh);
432 } else {
433 if (opts->flags & PARSE_OPT_OPTARG)
434 if (opts->long_name)
435 pos += fprintf(stderr, "[=...]");
436 else
437 pos += fprintf(stderr, "[...]");
438 else
439 pos += fprintf(stderr, " ...");
441 break;
442 default: /* OPTION_{BIT,BOOLEAN,SET_INT,SET_PTR} */
443 break;
446 if (pos <= USAGE_OPTS_WIDTH)
447 pad = USAGE_OPTS_WIDTH - pos;
448 else {
449 fputc('\n', stderr);
450 pad = USAGE_OPTS_WIDTH;
452 fprintf(stderr, "%*s%s\n", pad + USAGE_GAP, "", opts->help);
454 fputc('\n', stderr);
456 return PARSE_OPT_HELP;
459 void usage_with_options(const char * const *usagestr,
460 const struct option *opts)
462 usage_with_options_internal(usagestr, opts, 0);
463 exit(129);
466 int parse_options_usage(const char * const *usagestr,
467 const struct option *opts)
469 return usage_with_options_internal(usagestr, opts, 0);
473 /*----- some often used options -----*/
474 #include "cache.h"
476 int parse_opt_abbrev_cb(const struct option *opt, const char *arg, int unset)
478 int v;
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;
491 *(int *)(opt->value) = v;
492 return 0;
495 int parse_opt_approxidate_cb(const struct option *opt, const char *arg,
496 int unset)
498 *(unsigned long *)(opt->value) = approxidate(arg);
499 return 0;
502 int parse_opt_verbosity_cb(const struct option *opt, const char *arg,
503 int unset)
505 int *target = opt->value;
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;
521 return 0;
524 int parse_opt_with_commit(const struct option *opt, const char *arg, int unset)
526 unsigned char sha1[20];
527 struct commit *commit;
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;
541 * This should really be OPTION_FILENAME type as a part of
542 * parse_options that take prefix to do this while parsing.
544 extern const char *parse_options_fix_filename(const char *prefix, const char *file)
546 if (!file || !prefix || is_absolute_path(file) || !strcmp("-", file))
547 return file;
548 return prefix_filename(prefix, strlen(prefix), file);