1 #include "git-compat-util.h"
2 #include "parse-options.h"
12 int optbug(const struct option
*opt
, const char *reason
)
16 return error("BUG: switch '%c' (--%s) %s",
17 opt
->short_name
, opt
->long_name
, reason
);
18 return error("BUG: option '%s' %s", opt
->long_name
, reason
);
20 return error("BUG: switch '%c' %s", opt
->short_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
;
31 } else if (p
->argc
> 1) {
35 return opterror(opt
, "requires a value", flags
);
39 static void fix_filename(const char *prefix
, const char **file
)
41 if (!file
|| !*file
|| !prefix
|| is_absolute_path(*file
)
42 || !strcmp("-", *file
))
44 *file
= prefix_filename(prefix
, *file
);
47 static int opt_command_mode_error(const struct option
*opt
,
48 const struct option
*all_opts
,
51 const struct option
*that
;
52 struct strbuf message
= STRBUF_INIT
;
53 struct strbuf that_name
= STRBUF_INIT
;
56 * Find the other option that was used to set the variable
57 * already, and report that this is not compatible with it.
59 for (that
= all_opts
; that
->type
!= OPTION_END
; that
++) {
61 that
->type
!= OPTION_CMDMODE
||
62 that
->value
!= opt
->value
||
63 that
->defval
!= *(int *)opt
->value
)
67 strbuf_addf(&that_name
, "--%s", that
->long_name
);
69 strbuf_addf(&that_name
, "-%c", that
->short_name
);
70 strbuf_addf(&message
, ": incompatible with %s", that_name
.buf
);
71 strbuf_release(&that_name
);
72 opterror(opt
, message
.buf
, flags
);
73 strbuf_release(&message
);
76 return opterror(opt
, ": incompatible with something else", flags
);
79 static int get_value(struct parse_opt_ctx_t
*p
,
80 const struct option
*opt
,
81 const struct option
*all_opts
,
85 const int unset
= flags
& OPT_UNSET
;
89 return opterror(opt
, "takes no value", flags
);
90 if (unset
&& (opt
->flags
& PARSE_OPT_NONEG
))
91 return opterror(opt
, "isn't available", flags
);
92 if (!(flags
& OPT_SHORT
) && p
->opt
&& (opt
->flags
& PARSE_OPT_NOARG
))
93 return opterror(opt
, "takes no value", flags
);
96 case OPTION_LOWLEVEL_CALLBACK
:
97 return (*(parse_opt_ll_cb
*)opt
->callback
)(p
, opt
, unset
);
101 *(int *)opt
->value
&= ~opt
->defval
;
103 *(int *)opt
->value
|= opt
->defval
;
108 *(int *)opt
->value
|= opt
->defval
;
110 *(int *)opt
->value
&= ~opt
->defval
;
114 if (*(int *)opt
->value
< 0)
115 *(int *)opt
->value
= 0;
116 *(int *)opt
->value
= unset
? 0 : *(int *)opt
->value
+ 1;
120 *(int *)opt
->value
= unset
? 0 : opt
->defval
;
125 * Giving the same mode option twice, although is unnecessary,
126 * is not a grave error, so let it pass.
128 if (*(int *)opt
->value
&& *(int *)opt
->value
!= opt
->defval
)
129 return opt_command_mode_error(opt
, all_opts
, flags
);
130 *(int *)opt
->value
= opt
->defval
;
135 *(const char **)opt
->value
= NULL
;
136 else if (opt
->flags
& PARSE_OPT_OPTARG
&& !p
->opt
)
137 *(const char **)opt
->value
= (const char *)opt
->defval
;
139 return get_arg(p
, opt
, flags
, (const char **)opt
->value
);
142 case OPTION_FILENAME
:
145 *(const char **)opt
->value
= NULL
;
146 else if (opt
->flags
& PARSE_OPT_OPTARG
&& !p
->opt
)
147 *(const char **)opt
->value
= (const char *)opt
->defval
;
149 err
= get_arg(p
, opt
, flags
, (const char **)opt
->value
);
152 fix_filename(p
->prefix
, (const char **)opt
->value
);
155 case OPTION_CALLBACK
:
157 return (*opt
->callback
)(opt
, NULL
, 1) ? (-1) : 0;
158 if (opt
->flags
& PARSE_OPT_NOARG
)
159 return (*opt
->callback
)(opt
, NULL
, 0) ? (-1) : 0;
160 if (opt
->flags
& PARSE_OPT_OPTARG
&& !p
->opt
)
161 return (*opt
->callback
)(opt
, NULL
, 0) ? (-1) : 0;
162 if (get_arg(p
, opt
, flags
, &arg
))
164 return (*opt
->callback
)(opt
, arg
, 0) ? (-1) : 0;
168 *(int *)opt
->value
= 0;
171 if (opt
->flags
& PARSE_OPT_OPTARG
&& !p
->opt
) {
172 *(int *)opt
->value
= opt
->defval
;
175 if (get_arg(p
, opt
, flags
, &arg
))
177 *(int *)opt
->value
= strtol(arg
, (char **)&s
, 10);
179 return opterror(opt
, "expects a numerical value", flags
);
182 case OPTION_MAGNITUDE
:
184 *(unsigned long *)opt
->value
= 0;
187 if (opt
->flags
& PARSE_OPT_OPTARG
&& !p
->opt
) {
188 *(unsigned long *)opt
->value
= opt
->defval
;
191 if (get_arg(p
, opt
, flags
, &arg
))
193 if (!git_parse_ulong(arg
, opt
->value
))
195 "expects a non-negative integer value with an optional k/m/g suffix",
200 die("should not happen, someone must be hit on the forehead");
204 static int parse_short_opt(struct parse_opt_ctx_t
*p
, const struct option
*options
)
206 const struct option
*all_opts
= options
;
207 const struct option
*numopt
= NULL
;
209 for (; options
->type
!= OPTION_END
; options
++) {
210 if (options
->short_name
== *p
->opt
) {
211 p
->opt
= p
->opt
[1] ? p
->opt
+ 1 : NULL
;
212 return get_value(p
, options
, all_opts
, OPT_SHORT
);
216 * Handle the numerical option later, explicit one-digit
217 * options take precedence over it.
219 if (options
->type
== OPTION_NUMBER
)
222 if (numopt
&& isdigit(*p
->opt
)) {
227 while (isdigit(p
->opt
[len
]))
229 arg
= xmemdupz(p
->opt
, len
);
230 p
->opt
= p
->opt
[len
] ? p
->opt
+ len
: NULL
;
231 rc
= (*numopt
->callback
)(numopt
, arg
, 0) ? (-1) : 0;
238 static int parse_long_opt(struct parse_opt_ctx_t
*p
, const char *arg
,
239 const struct option
*options
)
241 const struct option
*all_opts
= options
;
242 const char *arg_end
= strchrnul(arg
, '=');
243 const struct option
*abbrev_option
= NULL
, *ambiguous_option
= NULL
;
244 int abbrev_flags
= 0, ambiguous_flags
= 0;
246 for (; options
->type
!= OPTION_END
; options
++) {
247 const char *rest
, *long_name
= options
->long_name
;
248 int flags
= 0, opt_flags
= 0;
254 if (!skip_prefix(arg
, long_name
, &rest
))
256 if (options
->type
== OPTION_ARGUMENT
) {
260 return opterror(options
, "takes no value", flags
);
263 p
->out
[p
->cpidx
++] = arg
- 2;
268 if (!strncmp(long_name
, arg
, arg_end
- arg
)) {
272 * If this is abbreviated, it is
273 * ambiguous. So when there is no
274 * exact match later, we need to
277 ambiguous_option
= abbrev_option
;
278 ambiguous_flags
= abbrev_flags
;
280 if (!(flags
& OPT_UNSET
) && *arg_end
)
281 p
->opt
= arg_end
+ 1;
282 abbrev_option
= options
;
283 abbrev_flags
= flags
^ opt_flags
;
286 /* negation allowed? */
287 if (options
->flags
& PARSE_OPT_NONEG
)
289 /* negated and abbreviated very much? */
290 if (starts_with("no-", arg
)) {
295 if (!starts_with(arg
, "no-")) {
296 if (starts_with(long_name
, "no-")) {
298 opt_flags
|= OPT_UNSET
;
304 if (!skip_prefix(arg
+ 3, long_name
, &rest
)) {
305 /* abbreviated and negated? */
306 if (starts_with(long_name
, arg
+ 3))
317 return get_value(p
, options
, all_opts
, flags
^ opt_flags
);
320 if (ambiguous_option
)
321 return error("Ambiguous option: %s "
322 "(could be --%s%s or --%s%s)",
324 (ambiguous_flags
& OPT_UNSET
) ? "no-" : "",
325 ambiguous_option
->long_name
,
326 (abbrev_flags
& OPT_UNSET
) ? "no-" : "",
327 abbrev_option
->long_name
);
329 return get_value(p
, abbrev_option
, all_opts
, abbrev_flags
);
333 static int parse_nodash_opt(struct parse_opt_ctx_t
*p
, const char *arg
,
334 const struct option
*options
)
336 const struct option
*all_opts
= options
;
338 for (; options
->type
!= OPTION_END
; options
++) {
339 if (!(options
->flags
& PARSE_OPT_NODASH
))
341 if (options
->short_name
== arg
[0] && arg
[1] == '\0')
342 return get_value(p
, options
, all_opts
, OPT_SHORT
);
347 static void check_typos(const char *arg
, const struct option
*options
)
352 if (starts_with(arg
, "no-")) {
353 error ("did you mean `--%s` (with two dashes ?)", arg
);
357 for (; options
->type
!= OPTION_END
; options
++) {
358 if (!options
->long_name
)
360 if (starts_with(options
->long_name
, arg
)) {
361 error ("did you mean `--%s` (with two dashes ?)", arg
);
367 static void parse_options_check(const struct option
*opts
)
370 char short_opts
[128];
372 memset(short_opts
, '\0', sizeof(short_opts
));
373 for (; opts
->type
!= OPTION_END
; opts
++) {
374 if ((opts
->flags
& PARSE_OPT_LASTARG_DEFAULT
) &&
375 (opts
->flags
& PARSE_OPT_OPTARG
))
376 err
|= optbug(opts
, "uses incompatible flags "
377 "LASTARG_DEFAULT and OPTARG");
378 if (opts
->short_name
) {
379 if (0x7F <= opts
->short_name
)
380 err
|= optbug(opts
, "invalid short name");
381 else if (short_opts
[opts
->short_name
]++)
382 err
|= optbug(opts
, "short name already used");
384 if (opts
->flags
& PARSE_OPT_NODASH
&&
385 ((opts
->flags
& PARSE_OPT_OPTARG
) ||
386 !(opts
->flags
& PARSE_OPT_NOARG
) ||
387 !(opts
->flags
& PARSE_OPT_NONEG
) ||
389 err
|= optbug(opts
, "uses feature "
390 "not supported for dashless options");
391 switch (opts
->type
) {
397 if ((opts
->flags
& PARSE_OPT_OPTARG
) ||
398 !(opts
->flags
& PARSE_OPT_NOARG
))
399 err
|= optbug(opts
, "should not accept an argument");
401 ; /* ok. (usually accepts an argument) */
404 strcspn(opts
->argh
, " _") != strlen(opts
->argh
))
405 err
|= optbug(opts
, "multi-word argh should use dash to separate words");
411 void parse_options_start(struct parse_opt_ctx_t
*ctx
,
412 int argc
, const char **argv
, const char *prefix
,
413 const struct option
*options
, int flags
)
415 memset(ctx
, 0, sizeof(*ctx
));
416 ctx
->argc
= ctx
->total
= argc
- 1;
417 ctx
->argv
= argv
+ 1;
419 ctx
->prefix
= prefix
;
420 ctx
->cpidx
= ((flags
& PARSE_OPT_KEEP_ARGV0
) != 0);
422 if ((flags
& PARSE_OPT_KEEP_UNKNOWN
) &&
423 (flags
& PARSE_OPT_STOP_AT_NON_OPTION
))
424 die("STOP_AT_NON_OPTION and KEEP_UNKNOWN don't go together");
425 parse_options_check(options
);
429 * TODO: we are not completing the --no-XXX form yet because there are
430 * many options that do not suppress it properly.
432 static int show_gitcomp(struct parse_opt_ctx_t
*ctx
,
433 const struct option
*opts
)
435 for (; opts
->type
!= OPTION_END
; opts
++) {
436 const char *suffix
= "";
438 if (!opts
->long_name
)
440 if (opts
->flags
& (PARSE_OPT_HIDDEN
| PARSE_OPT_NOCOMPLETE
))
443 switch (opts
->type
) {
447 case OPTION_FILENAME
:
449 case OPTION_MAGNITUDE
:
450 case OPTION_CALLBACK
:
451 if (opts
->flags
& PARSE_OPT_NOARG
)
453 if (opts
->flags
& PARSE_OPT_OPTARG
)
455 if (opts
->flags
& PARSE_OPT_LASTARG_DEFAULT
)
462 if (opts
->flags
& PARSE_OPT_COMP_ARG
)
464 printf(" --%s%s", opts
->long_name
, suffix
);
470 static int usage_with_options_internal(struct parse_opt_ctx_t
*,
471 const char * const *,
472 const struct option
*, int, int);
474 int parse_options_step(struct parse_opt_ctx_t
*ctx
,
475 const struct option
*options
,
476 const char * const usagestr
[])
478 int internal_help
= !(ctx
->flags
& PARSE_OPT_NO_INTERNAL_HELP
);
481 /* we must reset ->opt, unknown short option leave it dangling */
484 for (; ctx
->argc
; ctx
->argc
--, ctx
->argv
++) {
485 const char *arg
= ctx
->argv
[0];
487 if (*arg
!= '-' || !arg
[1]) {
488 if (parse_nodash_opt(ctx
, arg
, options
) == 0)
490 if (ctx
->flags
& PARSE_OPT_STOP_AT_NON_OPTION
)
491 return PARSE_OPT_NON_OPTION
;
492 ctx
->out
[ctx
->cpidx
++] = ctx
->argv
[0];
496 /* lone -h asks for help */
497 if (internal_help
&& ctx
->total
== 1 && !strcmp(arg
+ 1, "h"))
500 /* lone --git-completion-helper is asked by git-completion.bash */
501 if (ctx
->total
== 1 && !strcmp(arg
+ 1, "-git-completion-helper"))
502 return show_gitcomp(ctx
, options
);
506 switch (parse_short_opt(ctx
, options
)) {
508 goto show_usage_error
;
511 check_typos(arg
+ 1, options
);
512 if (internal_help
&& *ctx
->opt
== 'h')
517 check_typos(arg
+ 1, options
);
519 switch (parse_short_opt(ctx
, options
)) {
521 goto show_usage_error
;
523 if (internal_help
&& *ctx
->opt
== 'h')
526 /* fake a short option thing to hide the fact that we may have
527 * started to parse aggregated stuff
529 * This is leaky, too bad.
531 ctx
->argv
[0] = xstrdup(ctx
->opt
- 1);
532 *(char *)ctx
->argv
[0] = '-';
539 if (!arg
[2]) { /* "--" */
540 if (!(ctx
->flags
& PARSE_OPT_KEEP_DASHDASH
)) {
547 if (internal_help
&& !strcmp(arg
+ 2, "help-all"))
548 return usage_with_options_internal(ctx
, usagestr
, options
, 1, 0);
549 if (internal_help
&& !strcmp(arg
+ 2, "help"))
551 switch (parse_long_opt(ctx
, arg
+ 2, options
)) {
553 goto show_usage_error
;
559 if (!(ctx
->flags
& PARSE_OPT_KEEP_UNKNOWN
))
560 return PARSE_OPT_UNKNOWN
;
561 ctx
->out
[ctx
->cpidx
++] = ctx
->argv
[0];
564 return PARSE_OPT_DONE
;
569 return usage_with_options_internal(ctx
, usagestr
, options
, 0, err
);
572 int parse_options_end(struct parse_opt_ctx_t
*ctx
)
574 MOVE_ARRAY(ctx
->out
+ ctx
->cpidx
, ctx
->argv
, ctx
->argc
);
575 ctx
->out
[ctx
->cpidx
+ ctx
->argc
] = NULL
;
576 return ctx
->cpidx
+ ctx
->argc
;
579 int parse_options(int argc
, const char **argv
, const char *prefix
,
580 const struct option
*options
, const char * const usagestr
[],
583 struct parse_opt_ctx_t ctx
;
585 parse_options_start(&ctx
, argc
, argv
, prefix
, options
, flags
);
586 switch (parse_options_step(&ctx
, options
, usagestr
)) {
589 case PARSE_OPT_NON_OPTION
:
592 default: /* PARSE_OPT_UNKNOWN */
593 if (ctx
.argv
[0][1] == '-') {
594 error("unknown option `%s'", ctx
.argv
[0] + 2);
595 } else if (isascii(*ctx
.opt
)) {
596 error("unknown switch `%c'", *ctx
.opt
);
598 error("unknown non-ascii option in string: `%s'",
601 usage_with_options(usagestr
, options
);
604 precompose_argv(argc
, argv
);
605 return parse_options_end(&ctx
);
608 static int usage_argh(const struct option
*opts
, FILE *outfile
)
611 int literal
= (opts
->flags
& PARSE_OPT_LITERAL_ARGHELP
) || !opts
->argh
;
612 if (opts
->flags
& PARSE_OPT_OPTARG
)
614 s
= literal
? "[=%s]" : "[=<%s>]";
616 s
= literal
? "[%s]" : "[<%s>]";
618 s
= literal
? " %s" : " <%s>";
619 return utf8_fprintf(outfile
, s
, opts
->argh
? _(opts
->argh
) : _("..."));
622 #define USAGE_OPTS_WIDTH 24
625 static int usage_with_options_internal(struct parse_opt_ctx_t
*ctx
,
626 const char * const *usagestr
,
627 const struct option
*opts
, int full
, int err
)
629 FILE *outfile
= err
? stderr
: stdout
;
633 return PARSE_OPT_HELP
;
635 if (!err
&& ctx
&& ctx
->flags
& PARSE_OPT_SHELL_EVAL
)
636 fprintf(outfile
, "cat <<\\EOF\n");
638 fprintf_ln(outfile
, _("usage: %s"), _(*usagestr
++));
639 while (*usagestr
&& **usagestr
)
641 * TRANSLATORS: the colon here should align with the
642 * one in "usage: %s" translation.
644 fprintf_ln(outfile
, _(" or: %s"), _(*usagestr
++));
647 fprintf_ln(outfile
, _(" %s"), _(*usagestr
));
649 fputc('\n', outfile
);
655 for (; opts
->type
!= OPTION_END
; opts
++) {
659 if (opts
->type
== OPTION_GROUP
) {
660 fputc('\n', outfile
);
663 fprintf(outfile
, "%s\n", _(opts
->help
));
666 if (!full
&& (opts
->flags
& PARSE_OPT_HIDDEN
))
670 fputc('\n', outfile
);
674 pos
= fprintf(outfile
, " ");
675 if (opts
->short_name
) {
676 if (opts
->flags
& PARSE_OPT_NODASH
)
677 pos
+= fprintf(outfile
, "%c", opts
->short_name
);
679 pos
+= fprintf(outfile
, "-%c", opts
->short_name
);
681 if (opts
->long_name
&& opts
->short_name
)
682 pos
+= fprintf(outfile
, ", ");
684 pos
+= fprintf(outfile
, "--%s", opts
->long_name
);
685 if (opts
->type
== OPTION_NUMBER
)
686 pos
+= utf8_fprintf(outfile
, _("-NUM"));
688 if ((opts
->flags
& PARSE_OPT_LITERAL_ARGHELP
) ||
689 !(opts
->flags
& PARSE_OPT_NOARG
))
690 pos
+= usage_argh(opts
, outfile
);
692 if (pos
<= USAGE_OPTS_WIDTH
)
693 pad
= USAGE_OPTS_WIDTH
- pos
;
695 fputc('\n', outfile
);
696 pad
= USAGE_OPTS_WIDTH
;
698 fprintf(outfile
, "%*s%s\n", pad
+ USAGE_GAP
, "", _(opts
->help
));
700 fputc('\n', outfile
);
702 if (!err
&& ctx
&& ctx
->flags
& PARSE_OPT_SHELL_EVAL
)
703 fputs("EOF\n", outfile
);
705 return PARSE_OPT_HELP
;
708 void NORETURN
usage_with_options(const char * const *usagestr
,
709 const struct option
*opts
)
711 usage_with_options_internal(NULL
, usagestr
, opts
, 0, 1);
715 void NORETURN
usage_msg_opt(const char *msg
,
716 const char * const *usagestr
,
717 const struct option
*options
)
719 fprintf(stderr
, "fatal: %s\n\n", msg
);
720 usage_with_options(usagestr
, options
);
724 int opterror(const struct option
*opt
, const char *reason
, int flags
)
726 if (flags
& OPT_SHORT
)
727 return error("switch `%c' %s", opt
->short_name
, reason
);
728 if (flags
& OPT_UNSET
)
729 return error("option `no-%s' %s", opt
->long_name
, reason
);
730 return error("option `%s' %s", opt
->long_name
, reason
);