parse-options: support --git-completion-helper
[git/git.git] / parse-options.h
CommitLineData
4a59fd13
PH
1#ifndef PARSE_OPTIONS_H
2#define PARSE_OPTIONS_H
3
4enum parse_opt_type {
db7244bd 5 /* special types */
4a59fd13 6 OPTION_END,
580d5bff 7 OPTION_ARGUMENT,
d7a38c54 8 OPTION_GROUP,
e0319ff5 9 OPTION_NUMBER,
db7244bd
PH
10 /* options with no arguments */
11 OPTION_BIT,
2f4b97f9 12 OPTION_NEGBIT,
b04ba2bb 13 OPTION_COUNTUP,
db7244bd 14 OPTION_SET_INT,
11588263 15 OPTION_CMDMODE,
db7244bd 16 /* options with arguments (usually) */
4a59fd13
PH
17 OPTION_STRING,
18 OPTION_INTEGER,
2a514ed8 19 OPTION_MAGNITUDE,
ffe659f9 20 OPTION_CALLBACK,
b0b3a8b6 21 OPTION_LOWLEVEL_CALLBACK,
df217ed6 22 OPTION_FILENAME
4a59fd13
PH
23};
24
25enum parse_opt_flags {
26 PARSE_OPT_KEEP_DASHDASH = 1,
a0ec9d25 27 PARSE_OPT_STOP_AT_NON_OPTION = 2,
a32a4eaa 28 PARSE_OPT_KEEP_ARGV0 = 4,
b5ce3a54 29 PARSE_OPT_KEEP_UNKNOWN = 8,
4b05548f 30 PARSE_OPT_NO_INTERNAL_HELP = 16
4a59fd13
PH
31};
32
ffe659f9
PH
33enum parse_opt_option_flags {
34 PARSE_OPT_OPTARG = 1,
f481e22a 35 PARSE_OPT_NOARG = 2,
db7244bd 36 PARSE_OPT_NONEG = 4,
dd3bf0f4 37 PARSE_OPT_HIDDEN = 8,
1cc6985c 38 PARSE_OPT_LASTARG_DEFAULT = 16,
51a9949e 39 PARSE_OPT_NODASH = 32,
29f25d49 40 PARSE_OPT_LITERAL_ARGHELP = 64,
b9d7f4b4
NTND
41 PARSE_OPT_SHELL_EVAL = 256,
42 PARSE_OPT_NOCOMPLETE = 512
ffe659f9
PH
43};
44
45struct option;
46typedef int parse_opt_cb(const struct option *, const char *arg, int unset);
47
b0b3a8b6
JN
48struct parse_opt_ctx_t;
49typedef int parse_opt_ll_cb(struct parse_opt_ctx_t *ctx,
50 const struct option *opt, int unset);
51
9b3beb58
PH
52/*
53 * `type`::
54 * holds the type of the option, you must have an OPTION_END last in your
55 * array.
56 *
57 * `short_name`::
58 * the character to use as a short option name, '\0' if none.
59 *
60 * `long_name`::
61 * the long option name, without the leading dashes, NULL if none.
62 *
63 * `value`::
64 * stores pointers to the values to be filled.
65 *
66 * `argh`::
67 * token to explain the kind of argument this option wants. Keep it
54e6dc7d
NTND
68 * homogeneous across the repository. Should be wrapped by N_() for
69 * translation.
9b3beb58
PH
70 *
71 * `help`::
72 * the short help associated to what the option does.
73 * Must never be NULL (except for OPTION_END).
74 * OPTION_GROUP uses this pointer to store the group header.
54e6dc7d 75 * Should be wrapped by N_() for translation.
9b3beb58
PH
76 *
77 * `flags`::
78 * mask of parse_opt_option_flags.
3ea3c215 79 * PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs)
ef45e4da 80 * PARSE_OPT_NOARG: says that this option does not take an argument
db7244bd 81 * PARSE_OPT_NONEG: says that this option cannot be negated
51a9949e
RS
82 * PARSE_OPT_HIDDEN: this option is skipped in the default usage, and
83 * shown only in the full usage.
e169b974
SB
84 * PARSE_OPT_LASTARG_DEFAULT: says that this option will take the default
85 * value if no argument is given when the option
86 * is last on the command line. If the option is
87 * not last it will require an argument.
88 * Should not be used with PARSE_OPT_OPTARG.
51a9949e 89 * PARSE_OPT_NODASH: this option doesn't start with a dash.
29f25d49
SB
90 * PARSE_OPT_LITERAL_ARGHELP: says that argh shouldn't be enclosed in brackets
91 * (i.e. '<argh>') in the help message.
92 * Useful for options with multiple parameters.
b9d7f4b4
NTND
93 * PARSE_OPT_NOCOMPLETE: by default all visible options are completable
94 * by git-completion.bash. This option suppresses that.
9b3beb58
PH
95 *
96 * `callback`::
b0b3a8b6
JN
97 * pointer to the callback to use for OPTION_CALLBACK or
98 * OPTION_LOWLEVEL_CALLBACK.
9b3beb58
PH
99 *
100 * `defval`::
101 * default value to fill (*->value) with for PARSE_OPT_OPTARG.
d3c08114 102 * OPTION_{BIT,SET_INT} store the {mask,integer} to put in the value when met.
9b3beb58
PH
103 * CALLBACKS can use it like they want.
104 */
4a59fd13
PH
105struct option {
106 enum parse_opt_type type;
107 int short_name;
108 const char *long_name;
109 void *value;
d7a38c54
PH
110 const char *argh;
111 const char *help;
ffe659f9
PH
112
113 int flags;
114 parse_opt_cb *callback;
ffe659f9 115 intptr_t defval;
4a59fd13
PH
116};
117
118#define OPT_END() { OPTION_END }
34aec9f5
SB
119#define OPT_ARGUMENT(l, h) { OPTION_ARGUMENT, 0, (l), NULL, NULL, \
120 (h), PARSE_OPT_NOARG}
d7a38c54 121#define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
34aec9f5
SB
122#define OPT_BIT(s, l, v, h, b) { OPTION_BIT, (s), (l), (v), NULL, (h), \
123 PARSE_OPT_NOARG, NULL, (b) }
124#define OPT_NEGBIT(s, l, v, h, b) { OPTION_NEGBIT, (s), (l), (v), NULL, \
125 (h), PARSE_OPT_NOARG, NULL, (b) }
b04ba2bb 126#define OPT_COUNTUP(s, l, v, h) { OPTION_COUNTUP, (s), (l), (v), NULL, \
34aec9f5
SB
127 (h), PARSE_OPT_NOARG }
128#define OPT_SET_INT(s, l, v, h, i) { OPTION_SET_INT, (s), (l), (v), NULL, \
129 (h), PARSE_OPT_NOARG, NULL, (i) }
b04ba2bb 130#define OPT_BOOL(s, l, v, h) OPT_SET_INT(s, l, v, h, 1)
4741edd5
SB
131#define OPT_HIDDEN_BOOL(s, l, v, h) { OPTION_SET_INT, (s), (l), (v), NULL, \
132 (h), PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, 1}
14691e38 133#define OPT_CMDMODE(s, l, v, h, i) { OPTION_CMDMODE, (s), (l), (v), NULL, \
11588263 134 (h), PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, (i) }
54e6dc7d 135#define OPT_INTEGER(s, l, v, h) { OPTION_INTEGER, (s), (l), (v), N_("n"), (h) }
2a514ed8
CB
136#define OPT_MAGNITUDE(s, l, v, h) { OPTION_MAGNITUDE, (s), (l), (v), \
137 N_("n"), (h), PARSE_OPT_NONEG }
d7a38c54 138#define OPT_STRING(s, l, v, a, h) { OPTION_STRING, (s), (l), (v), (a), (h) }
c8ba1639
JK
139#define OPT_STRING_LIST(s, l, v, a, h) \
140 { OPTION_CALLBACK, (s), (l), (v), (a), \
141 (h), 0, &parse_opt_string_list }
cb6020bb
JH
142#define OPT_UYN(s, l, v, h) { OPTION_CALLBACK, (s), (l), (v), NULL, \
143 (h), PARSE_OPT_NOARG, &parse_opt_tertiary }
1f4a711a 144#define OPT_DATE(s, l, v, h) \
54e6dc7d 145 { OPTION_CALLBACK, (s), (l), (v), N_("time"),(h), 0, \
1f4a711a 146 parse_opt_approxidate_cb }
27ec394a 147#define OPT_EXPIRY_DATE(s, l, v, h) \
e703d711 148 { OPTION_CALLBACK, (s), (l), (v), N_("expiry-date"),(h), 0, \
27ec394a 149 parse_opt_expiry_date_cb }
ffe659f9
PH
150#define OPT_CALLBACK(s, l, v, a, h, f) \
151 { OPTION_CALLBACK, (s), (l), (v), (a), (h), 0, (f) }
e0319ff5
RS
152#define OPT_NUMBER_CALLBACK(v, h, f) \
153 { OPTION_NUMBER, 0, NULL, (v), NULL, (h), \
154 PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) }
df217ed6 155#define OPT_FILENAME(s, l, v, h) { OPTION_FILENAME, (s), (l), (v), \
54e6dc7d 156 N_("file"), (h) }
73e9da01 157#define OPT_COLOR_FLAG(s, l, v, h) \
54e6dc7d 158 { OPTION_CALLBACK, (s), (l), (v), N_("when"), (h), PARSE_OPT_OPTARG, \
73e9da01
ML
159 parse_opt_color_flag_cb, (intptr_t)"always" }
160
6acec038
RS
161#define OPT_NOOP_NOARG(s, l) \
162 { OPTION_CALLBACK, (s), (l), NULL, NULL, \
54e6dc7d 163 N_("no-op (backward compatibility)"), \
6acec038
RS
164 PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, parse_opt_noop_cb }
165
4a59fd13 166/* parse_options() will filter out the processed options and leave the
54e6dc7d
NTND
167 * non-option arguments in argv[]. usagestr strings should be marked
168 * for translation with N_().
4a59fd13
PH
169 * Returns the number of arguments left in argv[].
170 */
37782920 171extern int parse_options(int argc, const char **argv, const char *prefix,
4a59fd13 172 const struct option *options,
d7a38c54
PH
173 const char * const usagestr[], int flags);
174
175extern NORETURN void usage_with_options(const char * const *usagestr,
176 const struct option *options);
4a59fd13 177
451bb210
CC
178extern NORETURN void usage_msg_opt(const char *msg,
179 const char * const *usagestr,
180 const struct option *options);
181
1f275b7c
DI
182extern int optbug(const struct option *opt, const char *reason);
183extern int opterror(const struct option *opt, const char *reason, int flags);
ff0a80af 184#if defined(__GNUC__)
87fe5df3 185#define opterror(o,r,f) (opterror((o),(r),(f)), const_error())
a469a101
JK
186#endif
187
3ea3c215 188/*----- incremental advanced APIs -----*/
7e7bbcb4 189
ee68b87a
PH
190enum {
191 PARSE_OPT_HELP = -1,
192 PARSE_OPT_DONE,
979240fe 193 PARSE_OPT_NON_OPTION,
4b05548f 194 PARSE_OPT_UNKNOWN
ee68b87a
PH
195};
196
26141b5b
PH
197/*
198 * It's okay for the caller to consume argv/argc in the usual way.
199 * Other fields of that structure are private to parse-options and should not
200 * be modified in any way.
201 */
7e7bbcb4
PH
202struct parse_opt_ctx_t {
203 const char **argv;
204 const char **out;
5ad0d3d5 205 int argc, cpidx, total;
7e7bbcb4
PH
206 const char *opt;
207 int flags;
37782920 208 const char *prefix;
7e7bbcb4
PH
209};
210
211extern void parse_options_start(struct parse_opt_ctx_t *ctx,
37782920 212 int argc, const char **argv, const char *prefix,
9ca1169f 213 const struct option *options, int flags);
7e7bbcb4 214
ff43ec3e
PH
215extern int parse_options_step(struct parse_opt_ctx_t *ctx,
216 const struct option *options,
217 const char * const usagestr[]);
218
7e7bbcb4
PH
219extern int parse_options_end(struct parse_opt_ctx_t *ctx);
220
023ff39b 221extern struct option *parse_options_concat(struct option *a, struct option *b);
7e7bbcb4 222
0ce865b1
PH
223/*----- some often used options -----*/
224extern int parse_opt_abbrev_cb(const struct option *, const char *, int);
1f4a711a 225extern int parse_opt_approxidate_cb(const struct option *, const char *, int);
27ec394a 226extern int parse_opt_expiry_date_cb(const struct option *, const char *, int);
73e9da01 227extern int parse_opt_color_flag_cb(const struct option *, const char *, int);
7f87aff2 228extern int parse_opt_verbosity_cb(const struct option *, const char *, int);
b2172fdf 229extern int parse_opt_object_name(const struct option *, const char *, int);
9d306b5a 230extern int parse_opt_commits(const struct option *, const char *, int);
cb6020bb 231extern int parse_opt_tertiary(const struct option *, const char *, int);
c8ba1639 232extern int parse_opt_string_list(const struct option *, const char *, int);
6acec038 233extern int parse_opt_noop_cb(const struct option *, const char *, int);
ce564eb1 234extern int parse_opt_unknown_cb(const struct option *, const char *, int);
6b3ee18d 235extern int parse_opt_passthru(const struct option *, const char *, int);
ffad85c5 236extern int parse_opt_passthru_argv(const struct option *, const char *, int);
0ce865b1 237
212c0a6f
NTND
238#define OPT__VERBOSE(var, h) OPT_COUNTUP('v', "verbose", (var), (h))
239#define OPT__QUIET(var, h) OPT_COUNTUP('q', "quiet", (var), (h))
7f87aff2 240#define OPT__VERBOSITY(var) \
54e6dc7d 241 { OPTION_CALLBACK, 'v', "verbose", (var), NULL, N_("be more verbose"), \
7f87aff2 242 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
54e6dc7d 243 { OPTION_CALLBACK, 'q', "quiet", (var), NULL, N_("be more quiet"), \
7f87aff2 244 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
212c0a6f
NTND
245#define OPT__DRY_RUN(var, h) OPT_BOOL('n', "dry-run", (var), (h))
246#define OPT__FORCE(var, h) OPT_COUNTUP('f', "force", (var), (h))
0ce865b1 247#define OPT__ABBREV(var) \
54e6dc7d
NTND
248 { OPTION_CALLBACK, 0, "abbrev", (var), N_("n"), \
249 N_("use <n> digits to display SHA-1s"), \
0ce865b1 250 PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
73e9da01
ML
251#define OPT__COLOR(var, h) \
252 OPT_COLOR_FLAG(0, "color", (var), (h))
7e29b825 253#define OPT_COLUMN(s, l, v, h) \
a054e049 254 { OPTION_CALLBACK, (s), (l), (v), N_("style"), (h), PARSE_OPT_OPTARG, parseopt_column_callback }
6b3ee18d
PT
255#define OPT_PASSTHRU(s, l, v, a, h, f) \
256 { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru }
ffad85c5
PT
257#define OPT_PASSTHRU_ARGV(s, l, v, a, h, f) \
258 { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru_argv }
f266c916
KN
259#define _OPT_CONTAINS_OR_WITH(name, variable, help, flag) \
260 { OPTION_CALLBACK, 0, name, (variable), N_("commit"), (help), \
261 PARSE_OPT_LASTARG_DEFAULT | flag, \
262 parse_opt_commits, (intptr_t) "HEAD" \
263 }
eab98ee5 264#define OPT_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("contains", v, h, PARSE_OPT_NONEG)
ac3f5a34 265#define OPT_NO_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("no-contains", v, h, PARSE_OPT_NONEG)
eab98ee5 266#define OPT_WITH(v, h) _OPT_CONTAINS_OR_WITH("with", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
ac3f5a34 267#define OPT_WITHOUT(v, h) _OPT_CONTAINS_OR_WITH("without", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
0ce865b1 268
4a59fd13 269#endif