1 #include "git-compat-util.h"
2 #include "parse-options.h"
8 static inline const char *skip_prefix(const char *str, const char *prefix)
10 size_t len = strlen(prefix);
11 return strncmp(str, prefix, len) ? NULL : str + len;
14 static int opterror(const struct option *opt, const char *reason, int flags)
16 if (flags & OPT_SHORT)
17 return error("switch `%c' %s", opt->short_name, reason);
18 if (flags & OPT_UNSET)
19 return error("option `no-%s' %s", opt->long_name, reason);
20 return error("option `%s' %s", opt->long_name, reason);
23 static int get_arg(struct parse_opt_ctx_t *p, const struct option *opt,
24 int flags, const char **arg)
29 } else if (p->argc == 1 && (opt->flags & PARSE_OPT_LASTARG_DEFAULT)) {
30 *arg = (const char *)opt->defval;
35 return opterror(opt, "requires a value", flags);
39 static int get_value(struct parse_opt_ctx_t *p,
40 const struct option *opt, int flags)
43 const int unset = flags & OPT_UNSET;
46 return opterror(opt, "takes no value", flags);
47 if (unset && (opt->flags & PARSE_OPT_NONEG))
48 return opterror(opt, "isn't available", flags);
50 if (!(flags & OPT_SHORT) && p->opt) {
53 if (!(opt->flags & PARSE_OPT_NOARG))
60 return opterror(opt, "takes no value", flags);
69 *(int *)opt->value &= ~opt->defval;
71 *(int *)opt->value |= opt->defval;
75 *(int *)opt->value = unset ? 0 : *(int *)opt->value + 1;
79 *(int *)opt->value = unset ? 0 : opt->defval;
83 *(void **)opt->value = unset ? NULL : (void *)opt->defval;
88 *(const char **)opt->value = NULL;
89 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
90 *(const char **)opt->value = (const char *)opt->defval;
92 return get_arg(p, opt, flags, (const char **)opt->value);
97 return (*opt->callback)(opt, NULL, 1) ? (-1) : 0;
98 if (opt->flags & PARSE_OPT_NOARG)
99 return (*opt->callback)(opt, NULL, 0) ? (-1) : 0;
100 if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
101 return (*opt->callback)(opt, NULL, 0) ? (-1) : 0;
102 if (get_arg(p, opt, flags, &arg))
104 return (*opt->callback)(opt, arg, 0) ? (-1) : 0;
108 *(int *)opt->value = 0;
111 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
112 *(int *)opt->value = opt->defval;
115 if (get_arg(p, opt, flags, &arg))
117 *(int *)opt->value = strtol(arg, (char **)&s, 10);
119 return opterror(opt, "expects a numerical value", flags);
123 die("should not happen, someone must be hit on the forehead");
127 static int parse_short_opt(struct parse_opt_ctx_t *p, const struct option *options)
129 for (; options->type != OPTION_END; options++) {
130 if (options->short_name == *p->opt) {
131 p->opt = p->opt[1] ? p->opt + 1 : NULL;
132 return get_value(p, options, OPT_SHORT);
138 static int parse_long_opt(struct parse_opt_ctx_t *p, const char *arg,
139 const struct option *options)
141 const char *arg_end = strchr(arg, '=');
142 const struct option *abbrev_option = NULL, *ambiguous_option = NULL;
143 int abbrev_flags = 0, ambiguous_flags = 0;
146 arg_end = arg + strlen(arg);
148 for (; options->type != OPTION_END; options++) {
152 if (!options->long_name)
155 rest = skip_prefix(arg, options->long_name);
156 if (options->type == OPTION_ARGUMENT) {
160 return opterror(options, "takes no value", flags);
163 p->out[p->cpidx++] = arg - 2;
168 if (!strncmp(options->long_name, arg, arg_end - arg)) {
172 * If this is abbreviated, it is
173 * ambiguous. So when there is no
174 * exact match later, we need to
177 ambiguous_option = abbrev_option;
178 ambiguous_flags = abbrev_flags;
180 if (!(flags & OPT_UNSET) && *arg_end)
181 p->opt = arg_end + 1;
182 abbrev_option = options;
183 abbrev_flags = flags;
186 /* negated and abbreviated very much? */
187 if (!prefixcmp("no-", arg)) {
192 if (strncmp(arg, "no-", 3))
195 rest = skip_prefix(arg + 3, options->long_name);
196 /* abbreviated and negated? */
197 if (!rest && !prefixcmp(options->long_name, arg + 3))
207 return get_value(p, options, flags);
210 if (ambiguous_option)
211 return error("Ambiguous option: %s "
212 "(could be --%s%s or --%s%s)",
214 (ambiguous_flags & OPT_UNSET) ? "no-" : "",
215 ambiguous_option->long_name,
216 (abbrev_flags & OPT_UNSET) ? "no-" : "",
217 abbrev_option->long_name);
219 return get_value(p, abbrev_option, abbrev_flags);
223 void check_typos(const char *arg, const struct option *options)
228 if (!prefixcmp(arg, "no-")) {
229 error ("did you mean `--%s` (with two dashes ?)", arg);
233 for (; options->type != OPTION_END; options++) {
234 if (!options->long_name)
236 if (!prefixcmp(options->long_name, arg)) {
237 error ("did you mean `--%s` (with two dashes ?)", arg);
243 void parse_options_start(struct parse_opt_ctx_t *ctx,
244 int argc, const char **argv, int flags)
246 memset(ctx, 0, sizeof(*ctx));
247 ctx->argc = argc - 1;
248 ctx->argv = argv + 1;
250 ctx->cpidx = ((flags & PARSE_OPT_KEEP_ARGV0) != 0);
254 static int usage_with_options_internal(const char * const *,
255 const struct option *, int);
257 int parse_options_step(struct parse_opt_ctx_t *ctx,
258 const struct option *options,
259 const char * const usagestr[])
261 /* we must reset ->opt, unknown short option leave it dangling */
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)
270 ctx->out[ctx->cpidx++] = ctx->argv[0];
276 if (*ctx->opt == 'h')
277 return parse_options_usage(usagestr, options);
278 switch (parse_short_opt(ctx, options)) {
280 return parse_options_usage(usagestr, options);
282 return PARSE_OPT_UNKNOWN;
285 check_typos(arg + 1, options);
287 if (*ctx->opt == 'h')
288 return parse_options_usage(usagestr, options);
289 switch (parse_short_opt(ctx, options)) {
291 return parse_options_usage(usagestr, options);
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 return PARSE_OPT_UNKNOWN;
306 if (!arg[2]) { /* "--" */
307 if (!(ctx->flags & PARSE_OPT_KEEP_DASHDASH)) {
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)) {
320 return parse_options_usage(usagestr, options);
322 return PARSE_OPT_UNKNOWN;
325 return PARSE_OPT_DONE;
328 int parse_options_end(struct parse_opt_ctx_t *ctx)
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;
335 int parse_options(int argc, const char **argv, const struct option *options,
336 const char * const usagestr[], int flags)
338 struct parse_opt_ctx_t ctx;
340 parse_options_start(&ctx, argc, argv, flags);
341 switch (parse_options_step(&ctx, options, usagestr)) {
346 default: /* PARSE_OPT_UNKNOWN */
347 if (ctx.argv[0][1] == '-') {
348 error("unknown option `%s'", ctx.argv[0] + 2);
350 error("unknown switch `%c'", *ctx.opt);
352 usage_with_options(usagestr, options);
355 return parse_options_end(&ctx);
358 #define USAGE_OPTS_WIDTH 24
361 int usage_with_options_internal(const char * const *usagestr,
362 const struct option *opts, int full)
364 fprintf(stderr, "usage: %s\n", *usagestr++);
365 while (*usagestr && **usagestr)
366 fprintf(stderr, " or: %s\n", *usagestr++);
368 fprintf(stderr, "%s%s\n",
369 **usagestr ? " " : "",
374 if (opts->type != OPTION_GROUP)
377 for (; opts->type != OPTION_END; opts++) {
381 if (opts->type == OPTION_GROUP) {
384 fprintf(stderr, "%s\n", opts->help);
387 if (!full && (opts->flags & PARSE_OPT_HIDDEN))
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, ", ");
396 pos += fprintf(stderr, "--%s", opts->long_name);
398 switch (opts->type) {
399 case OPTION_ARGUMENT:
402 if (opts->flags & PARSE_OPT_OPTARG)
404 pos += fprintf(stderr, "[=<n>]");
406 pos += fprintf(stderr, "[<n>]");
408 pos += fprintf(stderr, " <n>");
410 case OPTION_CALLBACK:
411 if (opts->flags & PARSE_OPT_NOARG)
416 if (opts->flags & PARSE_OPT_OPTARG)
418 pos += fprintf(stderr, "[=<%s>]", opts->argh);
420 pos += fprintf(stderr, "[<%s>]", opts->argh);
422 pos += fprintf(stderr, " <%s>", opts->argh);
424 if (opts->flags & PARSE_OPT_OPTARG)
426 pos += fprintf(stderr, "[=...]");
428 pos += fprintf(stderr, "[...]");
430 pos += fprintf(stderr, " ...");
433 default: /* OPTION_{BIT,BOOLEAN,SET_INT,SET_PTR} */
437 if (pos <= USAGE_OPTS_WIDTH)
438 pad = USAGE_OPTS_WIDTH - pos;
441 pad = USAGE_OPTS_WIDTH;
443 fprintf(stderr, "%*s%s\n", pad + USAGE_GAP, "", opts->help);
447 return PARSE_OPT_HELP;
450 void usage_with_options(const char * const *usagestr,
451 const struct option *opts)
453 usage_with_options_internal(usagestr, opts, 0);
457 int parse_options_usage(const char * const *usagestr,
458 const struct option *opts)
460 return usage_with_options_internal(usagestr, opts, 0);
464 /*----- some often used options -----*/
467 int parse_opt_abbrev_cb(const struct option *opt, const char *arg, int unset)
472 v = unset ? 0 : DEFAULT_ABBREV;
474 v = strtol(arg, (char **)&arg, 10);
476 return opterror(opt, "expects a numerical value", 0);
477 if (v && v < MINIMUM_ABBREV)
482 *(int *)(opt->value) = v;
486 int parse_opt_approxidate_cb(const struct option *opt, const char *arg,
489 *(unsigned long *)(opt->value) = approxidate(arg);