The seventh batch
[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,
f62470c6 13 OPTION_BITOP,
b04ba2bb 14 OPTION_COUNTUP,
db7244bd 15 OPTION_SET_INT,
11588263 16 OPTION_CMDMODE,
db7244bd 17 /* options with arguments (usually) */
4a59fd13
PH
18 OPTION_STRING,
19 OPTION_INTEGER,
2a514ed8 20 OPTION_MAGNITUDE,
ffe659f9 21 OPTION_CALLBACK,
b0b3a8b6 22 OPTION_LOWLEVEL_CALLBACK,
df217ed6 23 OPTION_FILENAME
4a59fd13
PH
24};
25
26enum parse_opt_flags {
27 PARSE_OPT_KEEP_DASHDASH = 1,
a0ec9d25 28 PARSE_OPT_STOP_AT_NON_OPTION = 2,
a32a4eaa 29 PARSE_OPT_KEEP_ARGV0 = 4,
b5ce3a54 30 PARSE_OPT_KEEP_UNKNOWN = 8,
202fbb33
NTND
31 PARSE_OPT_NO_INTERNAL_HELP = 16,
32 PARSE_OPT_ONE_SHOT = 32
4a59fd13
PH
33};
34
ffe659f9
PH
35enum parse_opt_option_flags {
36 PARSE_OPT_OPTARG = 1,
f481e22a 37 PARSE_OPT_NOARG = 2,
db7244bd 38 PARSE_OPT_NONEG = 4,
dd3bf0f4 39 PARSE_OPT_HIDDEN = 8,
1cc6985c 40 PARSE_OPT_LASTARG_DEFAULT = 16,
51a9949e 41 PARSE_OPT_NODASH = 32,
29f25d49 42 PARSE_OPT_LITERAL_ARGHELP = 64,
b9d7f4b4 43 PARSE_OPT_SHELL_EVAL = 256,
ebc4a04e
NTND
44 PARSE_OPT_NOCOMPLETE = 512,
45 PARSE_OPT_COMP_ARG = 1024
ffe659f9
PH
46};
47
48struct option;
49typedef int parse_opt_cb(const struct option *, const char *arg, int unset);
50
b0b3a8b6 51struct parse_opt_ctx_t;
f41179f1 52typedef enum parse_opt_result parse_opt_ll_cb(struct parse_opt_ctx_t *ctx,
3ebbe289
NTND
53 const struct option *opt,
54 const char *arg, int unset);
b0b3a8b6 55
9b3beb58
PH
56/*
57 * `type`::
58 * holds the type of the option, you must have an OPTION_END last in your
59 * array.
60 *
61 * `short_name`::
62 * the character to use as a short option name, '\0' if none.
63 *
64 * `long_name`::
65 * the long option name, without the leading dashes, NULL if none.
66 *
67 * `value`::
68 * stores pointers to the values to be filled.
69 *
70 * `argh`::
71 * token to explain the kind of argument this option wants. Keep it
54e6dc7d
NTND
72 * homogeneous across the repository. Should be wrapped by N_() for
73 * translation.
9b3beb58
PH
74 *
75 * `help`::
76 * the short help associated to what the option does.
77 * Must never be NULL (except for OPTION_END).
78 * OPTION_GROUP uses this pointer to store the group header.
54e6dc7d 79 * Should be wrapped by N_() for translation.
9b3beb58
PH
80 *
81 * `flags`::
82 * mask of parse_opt_option_flags.
3ea3c215 83 * PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs)
ef45e4da 84 * PARSE_OPT_NOARG: says that this option does not take an argument
db7244bd 85 * PARSE_OPT_NONEG: says that this option cannot be negated
51a9949e
RS
86 * PARSE_OPT_HIDDEN: this option is skipped in the default usage, and
87 * shown only in the full usage.
e169b974
SB
88 * PARSE_OPT_LASTARG_DEFAULT: says that this option will take the default
89 * value if no argument is given when the option
90 * is last on the command line. If the option is
91 * not last it will require an argument.
92 * Should not be used with PARSE_OPT_OPTARG.
51a9949e 93 * PARSE_OPT_NODASH: this option doesn't start with a dash.
29f25d49
SB
94 * PARSE_OPT_LITERAL_ARGHELP: says that argh shouldn't be enclosed in brackets
95 * (i.e. '<argh>') in the help message.
96 * Useful for options with multiple parameters.
b9d7f4b4
NTND
97 * PARSE_OPT_NOCOMPLETE: by default all visible options are completable
98 * by git-completion.bash. This option suppresses that.
ebc4a04e
NTND
99 * PARSE_OPT_COMP_ARG: this option forces to git-completion.bash to
100 * complete an option as --name= not --name even if
101 * the option takes optional argument.
9b3beb58
PH
102 *
103 * `callback`::
bf3ff338 104 * pointer to the callback to use for OPTION_CALLBACK
9b3beb58
PH
105 *
106 * `defval`::
107 * default value to fill (*->value) with for PARSE_OPT_OPTARG.
d3c08114 108 * OPTION_{BIT,SET_INT} store the {mask,integer} to put in the value when met.
9b3beb58 109 * CALLBACKS can use it like they want.
bf3ff338
NTND
110 *
111 * `ll_callback`::
112 * pointer to the callback to use for OPTION_LOWLEVEL_CALLBACK
113 *
9b3beb58 114 */
4a59fd13
PH
115struct option {
116 enum parse_opt_type type;
117 int short_name;
118 const char *long_name;
119 void *value;
d7a38c54
PH
120 const char *argh;
121 const char *help;
ffe659f9
PH
122
123 int flags;
124 parse_opt_cb *callback;
ffe659f9 125 intptr_t defval;
bf3ff338 126 parse_opt_ll_cb *ll_callback;
f62470c6 127 intptr_t extra;
4a59fd13
PH
128};
129
2de37349
NTND
130#define OPT_BIT_F(s, l, v, h, b, f) { OPTION_BIT, (s), (l), (v), NULL, (h), \
131 PARSE_OPT_NOARG|(f), NULL, (b) }
132#define OPT_COUNTUP_F(s, l, v, h, f) { OPTION_COUNTUP, (s), (l), (v), NULL, \
133 (h), PARSE_OPT_NOARG|(f) }
134#define OPT_SET_INT_F(s, l, v, h, i, f) { OPTION_SET_INT, (s), (l), (v), NULL, \
135 (h), PARSE_OPT_NOARG | (f), NULL, (i) }
136#define OPT_BOOL_F(s, l, v, h, f) OPT_SET_INT_F(s, l, v, h, 1, f)
d473e2e0
NTND
137#define OPT_CALLBACK_F(s, l, v, a, h, f, cb) \
138 { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), (cb) }
31fba9d3 139#define OPT_STRING_F(s, l, v, a, h, f) { OPTION_STRING, (s), (l), (v), (a), (h), (f) }
16ed6c97 140#define OPT_INTEGER_F(s, l, v, h, f) { OPTION_INTEGER, (s), (l), (v), N_("n"), (h), (f) }
2de37349 141
4a59fd13 142#define OPT_END() { OPTION_END }
1a85b49b
JS
143#define OPT_ARGUMENT(l, v, h) { OPTION_ARGUMENT, 0, (l), (v), NULL, \
144 (h), PARSE_OPT_NOARG, NULL, 1 }
d7a38c54 145#define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
2de37349 146#define OPT_BIT(s, l, v, h, b) OPT_BIT_F(s, l, v, h, b, 0)
f62470c6
NTND
147#define OPT_BITOP(s, l, v, h, set, clear) { OPTION_BITOP, (s), (l), (v), NULL, (h), \
148 PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, \
bf3ff338 149 (set), NULL, (clear) }
34aec9f5
SB
150#define OPT_NEGBIT(s, l, v, h, b) { OPTION_NEGBIT, (s), (l), (v), NULL, \
151 (h), PARSE_OPT_NOARG, NULL, (b) }
2de37349
NTND
152#define OPT_COUNTUP(s, l, v, h) OPT_COUNTUP_F(s, l, v, h, 0)
153#define OPT_SET_INT(s, l, v, h, i) OPT_SET_INT_F(s, l, v, h, i, 0)
154#define OPT_BOOL(s, l, v, h) OPT_BOOL_F(s, l, v, h, 0)
4741edd5
SB
155#define OPT_HIDDEN_BOOL(s, l, v, h) { OPTION_SET_INT, (s), (l), (v), NULL, \
156 (h), PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, 1}
14691e38 157#define OPT_CMDMODE(s, l, v, h, i) { OPTION_CMDMODE, (s), (l), (v), NULL, \
11588263 158 (h), PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, (i) }
16ed6c97 159#define OPT_INTEGER(s, l, v, h) OPT_INTEGER_F(s, l, v, h, 0)
2a514ed8
CB
160#define OPT_MAGNITUDE(s, l, v, h) { OPTION_MAGNITUDE, (s), (l), (v), \
161 N_("n"), (h), PARSE_OPT_NONEG }
31fba9d3 162#define OPT_STRING(s, l, v, a, h) OPT_STRING_F(s, l, v, a, h, 0)
c8ba1639
JK
163#define OPT_STRING_LIST(s, l, v, a, h) \
164 { OPTION_CALLBACK, (s), (l), (v), (a), \
165 (h), 0, &parse_opt_string_list }
b475e442
NTND
166#define OPT_UYN(s, l, v, h) { OPTION_CALLBACK, (s), (l), (v), NULL, \
167 (h), PARSE_OPT_NOARG, &parse_opt_tertiary }
27ec394a 168#define OPT_EXPIRY_DATE(s, l, v, h) \
e703d711 169 { OPTION_CALLBACK, (s), (l), (v), N_("expiry-date"),(h), 0, \
27ec394a 170 parse_opt_expiry_date_cb }
d473e2e0 171#define OPT_CALLBACK(s, l, v, a, h, f) OPT_CALLBACK_F(s, l, v, a, h, 0, f)
e0319ff5
RS
172#define OPT_NUMBER_CALLBACK(v, h, f) \
173 { OPTION_NUMBER, 0, NULL, (v), NULL, (h), \
174 PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) }
df217ed6 175#define OPT_FILENAME(s, l, v, h) { OPTION_FILENAME, (s), (l), (v), \
54e6dc7d 176 N_("file"), (h) }
73e9da01 177#define OPT_COLOR_FLAG(s, l, v, h) \
54e6dc7d 178 { OPTION_CALLBACK, (s), (l), (v), N_("when"), (h), PARSE_OPT_OPTARG, \
73e9da01
ML
179 parse_opt_color_flag_cb, (intptr_t)"always" }
180
6acec038
RS
181#define OPT_NOOP_NOARG(s, l) \
182 { OPTION_CALLBACK, (s), (l), NULL, NULL, \
54e6dc7d 183 N_("no-op (backward compatibility)"), \
6acec038
RS
184 PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, parse_opt_noop_cb }
185
202fbb33
NTND
186/*
187 * parse_options() will filter out the processed options and leave the
188 * non-option arguments in argv[]. argv0 is assumed program name and
189 * skipped.
190 *
191 * usagestr strings should be marked for translation with N_().
192 *
4a59fd13 193 * Returns the number of arguments left in argv[].
202fbb33
NTND
194 *
195 * In one-shot mode, argv0 is not a program name, argv[] is left
196 * untouched and parse_options() returns the number of options
197 * processed.
4a59fd13 198 */
1987b0b2
NTND
199int parse_options(int argc, const char **argv, const char *prefix,
200 const struct option *options,
201 const char * const usagestr[], int flags);
d7a38c54 202
1987b0b2
NTND
203NORETURN void usage_with_options(const char * const *usagestr,
204 const struct option *options);
4a59fd13 205
1987b0b2
NTND
206NORETURN void usage_msg_opt(const char *msg,
207 const char * const *usagestr,
208 const struct option *options);
451bb210 209
1987b0b2 210int optbug(const struct option *opt, const char *reason);
9440b831 211const char *optname(const struct option *opt, int flags);
a469a101 212
517fe807
JK
213/*
214 * Use these assertions for callbacks that expect to be called with NONEG and
215 * NOARG respectively, and do not otherwise handle the "unset" and "arg"
216 * parameters.
217 */
218#define BUG_ON_OPT_NEG(unset) do { \
219 if ((unset)) \
220 BUG("option callback does not expect negation"); \
221} while (0)
222#define BUG_ON_OPT_ARG(arg) do { \
223 if ((arg)) \
224 BUG("option callback does not expect an argument"); \
225} while (0)
226
cbdeab98
BR
227/*
228 * Similar to the assertions above, but checks that "arg" is always non-NULL.
229 * This assertion also implies BUG_ON_OPT_NEG(), letting you declare both
230 * assertions in a single line.
231 */
232#define BUG_ON_OPT_NEG_NOARG(unset, arg) do { \
233 BUG_ON_OPT_NEG(unset); \
234 if(!(arg)) \
235 BUG("option callback expects an argument"); \
236} while(0)
237
3ea3c215 238/*----- incremental advanced APIs -----*/
7e7bbcb4 239
f41179f1
NTND
240enum parse_opt_result {
241 PARSE_OPT_COMPLETE = -3,
242 PARSE_OPT_HELP = -2,
243 PARSE_OPT_ERROR = -1, /* must be the same as error() */
244 PARSE_OPT_DONE = 0, /* fixed so that "return 0" works */
979240fe 245 PARSE_OPT_NON_OPTION,
4b05548f 246 PARSE_OPT_UNKNOWN
ee68b87a
PH
247};
248
26141b5b
PH
249/*
250 * It's okay for the caller to consume argv/argc in the usual way.
251 * Other fields of that structure are private to parse-options and should not
252 * be modified in any way.
253 */
7e7bbcb4
PH
254struct parse_opt_ctx_t {
255 const char **argv;
256 const char **out;
5ad0d3d5 257 int argc, cpidx, total;
7e7bbcb4
PH
258 const char *opt;
259 int flags;
37782920 260 const char *prefix;
7e7bbcb4
PH
261};
262
1987b0b2
NTND
263void parse_options_start(struct parse_opt_ctx_t *ctx,
264 int argc, const char **argv, const char *prefix,
265 const struct option *options, int flags);
7e7bbcb4 266
1987b0b2
NTND
267int parse_options_step(struct parse_opt_ctx_t *ctx,
268 const struct option *options,
269 const char * const usagestr[]);
ff43ec3e 270
1987b0b2 271int parse_options_end(struct parse_opt_ctx_t *ctx);
7e7bbcb4 272
1987b0b2 273struct option *parse_options_concat(struct option *a, struct option *b);
7e7bbcb4 274
0ce865b1 275/*----- some often used options -----*/
1987b0b2
NTND
276int parse_opt_abbrev_cb(const struct option *, const char *, int);
277int parse_opt_expiry_date_cb(const struct option *, const char *, int);
278int parse_opt_color_flag_cb(const struct option *, const char *, int);
279int parse_opt_verbosity_cb(const struct option *, const char *, int);
280int parse_opt_object_name(const struct option *, const char *, int);
281int parse_opt_commits(const struct option *, const char *, int);
282int parse_opt_tertiary(const struct option *, const char *, int);
283int parse_opt_string_list(const struct option *, const char *, int);
284int parse_opt_noop_cb(const struct option *, const char *, int);
3ebbe289 285int parse_opt_unknown_cb(struct parse_opt_ctx_t *ctx, const struct option *, const char *, int);
1987b0b2
NTND
286int parse_opt_passthru(const struct option *, const char *, int);
287int parse_opt_passthru_argv(const struct option *, const char *, int);
0ce865b1 288
212c0a6f
NTND
289#define OPT__VERBOSE(var, h) OPT_COUNTUP('v', "verbose", (var), (h))
290#define OPT__QUIET(var, h) OPT_COUNTUP('q', "quiet", (var), (h))
7f87aff2 291#define OPT__VERBOSITY(var) \
54e6dc7d 292 { OPTION_CALLBACK, 'v', "verbose", (var), NULL, N_("be more verbose"), \
7f87aff2 293 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
54e6dc7d 294 { OPTION_CALLBACK, 'q', "quiet", (var), NULL, N_("be more quiet"), \
7f87aff2 295 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
212c0a6f 296#define OPT__DRY_RUN(var, h) OPT_BOOL('n', "dry-run", (var), (h))
1224781d 297#define OPT__FORCE(var, h, f) OPT_COUNTUP_F('f', "force", (var), (h), (f))
0ce865b1 298#define OPT__ABBREV(var) \
54e6dc7d
NTND
299 { OPTION_CALLBACK, 0, "abbrev", (var), N_("n"), \
300 N_("use <n> digits to display SHA-1s"), \
0ce865b1 301 PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
73e9da01
ML
302#define OPT__COLOR(var, h) \
303 OPT_COLOR_FLAG(0, "color", (var), (h))
7e29b825 304#define OPT_COLUMN(s, l, v, h) \
a054e049 305 { OPTION_CALLBACK, (s), (l), (v), N_("style"), (h), PARSE_OPT_OPTARG, parseopt_column_callback }
6b3ee18d
PT
306#define OPT_PASSTHRU(s, l, v, a, h, f) \
307 { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru }
ffad85c5
PT
308#define OPT_PASSTHRU_ARGV(s, l, v, a, h, f) \
309 { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru_argv }
f266c916
KN
310#define _OPT_CONTAINS_OR_WITH(name, variable, help, flag) \
311 { OPTION_CALLBACK, 0, name, (variable), N_("commit"), (help), \
312 PARSE_OPT_LASTARG_DEFAULT | flag, \
313 parse_opt_commits, (intptr_t) "HEAD" \
314 }
eab98ee5 315#define OPT_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("contains", v, h, PARSE_OPT_NONEG)
ac3f5a34 316#define OPT_NO_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("no-contains", v, h, PARSE_OPT_NONEG)
eab98ee5 317#define OPT_WITH(v, h) _OPT_CONTAINS_OR_WITH("with", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
ac3f5a34 318#define OPT_WITHOUT(v, h) _OPT_CONTAINS_OR_WITH("without", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
0ce865b1 319
4a59fd13 320#endif