]>
Commit | Line | Data |
---|---|---|
4a59fd13 PH |
1 | #ifndef PARSE_OPTIONS_H |
2 | #define PARSE_OPTIONS_H | |
3 | ||
f394e093 EN |
4 | #include "gettext.h" |
5 | ||
7db03054 HW |
6 | /** |
7 | * Refer to Documentation/technical/api-parse-options.txt for the API doc. | |
8 | */ | |
9 | ||
4a59fd13 | 10 | enum parse_opt_type { |
db7244bd | 11 | /* special types */ |
4a59fd13 | 12 | OPTION_END, |
d7a38c54 | 13 | OPTION_GROUP, |
e0319ff5 | 14 | OPTION_NUMBER, |
5c387428 | 15 | OPTION_ALIAS, |
fa83cc83 | 16 | OPTION_SUBCOMMAND, |
db7244bd PH |
17 | /* options with no arguments */ |
18 | OPTION_BIT, | |
2f4b97f9 | 19 | OPTION_NEGBIT, |
f62470c6 | 20 | OPTION_BITOP, |
b04ba2bb | 21 | OPTION_COUNTUP, |
db7244bd | 22 | OPTION_SET_INT, |
db7244bd | 23 | /* options with arguments (usually) */ |
4a59fd13 PH |
24 | OPTION_STRING, |
25 | OPTION_INTEGER, | |
2a514ed8 | 26 | OPTION_MAGNITUDE, |
ffe659f9 | 27 | OPTION_CALLBACK, |
b0b3a8b6 | 28 | OPTION_LOWLEVEL_CALLBACK, |
df217ed6 | 29 | OPTION_FILENAME |
4a59fd13 PH |
30 | }; |
31 | ||
32 | enum parse_opt_flags { | |
0171dbcb AH |
33 | PARSE_OPT_KEEP_DASHDASH = 1 << 0, |
34 | PARSE_OPT_STOP_AT_NON_OPTION = 1 << 1, | |
35 | PARSE_OPT_KEEP_ARGV0 = 1 << 2, | |
99d86d60 | 36 | PARSE_OPT_KEEP_UNKNOWN_OPT = 1 << 3, |
0171dbcb AH |
37 | PARSE_OPT_NO_INTERNAL_HELP = 1 << 4, |
38 | PARSE_OPT_ONE_SHOT = 1 << 5, | |
3b723f72 | 39 | PARSE_OPT_SHELL_EVAL = 1 << 6, |
fa83cc83 | 40 | PARSE_OPT_SUBCOMMAND_OPTIONAL = 1 << 7, |
4a59fd13 PH |
41 | }; |
42 | ||
ffe659f9 | 43 | enum parse_opt_option_flags { |
0171dbcb AH |
44 | PARSE_OPT_OPTARG = 1 << 0, |
45 | PARSE_OPT_NOARG = 1 << 1, | |
46 | PARSE_OPT_NONEG = 1 << 2, | |
47 | PARSE_OPT_HIDDEN = 1 << 3, | |
48 | PARSE_OPT_LASTARG_DEFAULT = 1 << 4, | |
49 | PARSE_OPT_NODASH = 1 << 5, | |
50 | PARSE_OPT_LITERAL_ARGHELP = 1 << 6, | |
64cc539f | 51 | PARSE_OPT_FROM_ALIAS = 1 << 7, |
0171dbcb AH |
52 | PARSE_OPT_NOCOMPLETE = 1 << 9, |
53 | PARSE_OPT_COMP_ARG = 1 << 10, | |
54 | PARSE_OPT_CMDMODE = 1 << 11, | |
ffe659f9 PH |
55 | }; |
56 | ||
19800bdc RS |
57 | enum parse_opt_result { |
58 | PARSE_OPT_COMPLETE = -3, | |
59 | PARSE_OPT_HELP = -2, | |
60 | PARSE_OPT_ERROR = -1, /* must be the same as error() */ | |
61 | PARSE_OPT_DONE = 0, /* fixed so that "return 0" works */ | |
62 | PARSE_OPT_NON_OPTION, | |
fa83cc83 | 63 | PARSE_OPT_SUBCOMMAND, |
19800bdc RS |
64 | PARSE_OPT_UNKNOWN |
65 | }; | |
66 | ||
ffe659f9 PH |
67 | struct option; |
68 | typedef int parse_opt_cb(const struct option *, const char *arg, int unset); | |
69 | ||
b0b3a8b6 | 70 | struct parse_opt_ctx_t; |
f41179f1 | 71 | typedef enum parse_opt_result parse_opt_ll_cb(struct parse_opt_ctx_t *ctx, |
3ebbe289 NTND |
72 | const struct option *opt, |
73 | const char *arg, int unset); | |
b0b3a8b6 | 74 | |
fa83cc83 SG |
75 | typedef int parse_opt_subcommand_fn(int argc, const char **argv, |
76 | const char *prefix); | |
77 | ||
9b3beb58 PH |
78 | /* |
79 | * `type`:: | |
80 | * holds the type of the option, you must have an OPTION_END last in your | |
81 | * array. | |
82 | * | |
83 | * `short_name`:: | |
84 | * the character to use as a short option name, '\0' if none. | |
85 | * | |
86 | * `long_name`:: | |
fa83cc83 SG |
87 | * the long option (without the leading dashes) or subcommand name, |
88 | * NULL if none. | |
9b3beb58 PH |
89 | * |
90 | * `value`:: | |
91 | * stores pointers to the values to be filled. | |
92 | * | |
93 | * `argh`:: | |
4ca7994b JH |
94 | * token to explain the kind of argument this option wants. Does not |
95 | * begin in capital letter, and does not end with a full stop. | |
96 | * Should be wrapped by N_() for translation. | |
518e15db RS |
97 | * Is automatically enclosed in brackets when printed, unless it |
98 | * contains any of the following characters: ()<>[]| | |
99 | * E.g. "name" is shown as "<name>" to indicate that a name value | |
100 | * needs to be supplied, not the literal string "name", but | |
101 | * "<start>,<end>" and "(this|that)" are printed verbatim. | |
9b3beb58 PH |
102 | * |
103 | * `help`:: | |
104 | * the short help associated to what the option does. | |
fa83cc83 | 105 | * Must never be NULL (except for OPTION_END and OPTION_SUBCOMMAND). |
9b3beb58 | 106 | * OPTION_GROUP uses this pointer to store the group header. |
54e6dc7d | 107 | * Should be wrapped by N_() for translation. |
9b3beb58 PH |
108 | * |
109 | * `flags`:: | |
110 | * mask of parse_opt_option_flags. | |
3ea3c215 | 111 | * PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs) |
ef45e4da | 112 | * PARSE_OPT_NOARG: says that this option does not take an argument |
db7244bd | 113 | * PARSE_OPT_NONEG: says that this option cannot be negated |
51a9949e RS |
114 | * PARSE_OPT_HIDDEN: this option is skipped in the default usage, and |
115 | * shown only in the full usage. | |
e169b974 SB |
116 | * PARSE_OPT_LASTARG_DEFAULT: says that this option will take the default |
117 | * value if no argument is given when the option | |
118 | * is last on the command line. If the option is | |
119 | * not last it will require an argument. | |
120 | * Should not be used with PARSE_OPT_OPTARG. | |
a9126b92 SG |
121 | * PARSE_OPT_NODASH: this option doesn't start with a dash; can only be a |
122 | * short option and can't accept arguments. | |
29f25d49 SB |
123 | * PARSE_OPT_LITERAL_ARGHELP: says that argh shouldn't be enclosed in brackets |
124 | * (i.e. '<argh>') in the help message. | |
125 | * Useful for options with multiple parameters. | |
b9d7f4b4 NTND |
126 | * PARSE_OPT_NOCOMPLETE: by default all visible options are completable |
127 | * by git-completion.bash. This option suppresses that. | |
ebc4a04e NTND |
128 | * PARSE_OPT_COMP_ARG: this option forces to git-completion.bash to |
129 | * complete an option as --name= not --name even if | |
130 | * the option takes optional argument. | |
9b3beb58 PH |
131 | * |
132 | * `callback`:: | |
bf3ff338 | 133 | * pointer to the callback to use for OPTION_CALLBACK |
9b3beb58 PH |
134 | * |
135 | * `defval`:: | |
136 | * default value to fill (*->value) with for PARSE_OPT_OPTARG. | |
d3c08114 | 137 | * OPTION_{BIT,SET_INT} store the {mask,integer} to put in the value when met. |
9b3beb58 | 138 | * CALLBACKS can use it like they want. |
bf3ff338 NTND |
139 | * |
140 | * `ll_callback`:: | |
141 | * pointer to the callback to use for OPTION_LOWLEVEL_CALLBACK | |
142 | * | |
fa83cc83 SG |
143 | * `subcommand_fn`:: |
144 | * pointer to a function to use for OPTION_SUBCOMMAND. | |
145 | * It will be put in value when the subcommand is given on the command line. | |
9b3beb58 | 146 | */ |
4a59fd13 PH |
147 | struct option { |
148 | enum parse_opt_type type; | |
149 | int short_name; | |
150 | const char *long_name; | |
151 | void *value; | |
d7a38c54 PH |
152 | const char *argh; |
153 | const char *help; | |
ffe659f9 | 154 | |
7bf7f0ba | 155 | enum parse_opt_option_flags flags; |
ffe659f9 | 156 | parse_opt_cb *callback; |
ffe659f9 | 157 | intptr_t defval; |
bf3ff338 | 158 | parse_opt_ll_cb *ll_callback; |
f62470c6 | 159 | intptr_t extra; |
fa83cc83 | 160 | parse_opt_subcommand_fn *subcommand_fn; |
4a59fd13 PH |
161 | }; |
162 | ||
353e6d45 SG |
163 | #define OPT_BIT_F(s, l, v, h, b, f) { \ |
164 | .type = OPTION_BIT, \ | |
165 | .short_name = (s), \ | |
166 | .long_name = (l), \ | |
167 | .value = (v), \ | |
168 | .help = (h), \ | |
169 | .flags = PARSE_OPT_NOARG|(f), \ | |
170 | .callback = NULL, \ | |
171 | .defval = (b), \ | |
172 | } | |
173 | #define OPT_COUNTUP_F(s, l, v, h, f) { \ | |
174 | .type = OPTION_COUNTUP, \ | |
175 | .short_name = (s), \ | |
176 | .long_name = (l), \ | |
177 | .value = (v), \ | |
178 | .help = (h), \ | |
179 | .flags = PARSE_OPT_NOARG|(f), \ | |
180 | } | |
181 | #define OPT_SET_INT_F(s, l, v, h, i, f) { \ | |
182 | .type = OPTION_SET_INT, \ | |
183 | .short_name = (s), \ | |
184 | .long_name = (l), \ | |
185 | .value = (v), \ | |
186 | .help = (h), \ | |
187 | .flags = PARSE_OPT_NOARG | (f), \ | |
188 | .defval = (i), \ | |
189 | } | |
2de37349 | 190 | #define OPT_BOOL_F(s, l, v, h, f) OPT_SET_INT_F(s, l, v, h, 1, f) |
353e6d45 SG |
191 | #define OPT_CALLBACK_F(s, l, v, a, h, f, cb) { \ |
192 | .type = OPTION_CALLBACK, \ | |
193 | .short_name = (s), \ | |
194 | .long_name = (l), \ | |
195 | .value = (v), \ | |
196 | .argh = (a), \ | |
197 | .help = (h), \ | |
198 | .flags = (f), \ | |
199 | .callback = (cb), \ | |
200 | } | |
201 | #define OPT_STRING_F(s, l, v, a, h, f) { \ | |
202 | .type = OPTION_STRING, \ | |
203 | .short_name = (s), \ | |
204 | .long_name = (l), \ | |
205 | .value = (v), \ | |
206 | .argh = (a), \ | |
207 | .help = (h), \ | |
208 | .flags = (f), \ | |
209 | } | |
210 | #define OPT_INTEGER_F(s, l, v, h, f) { \ | |
211 | .type = OPTION_INTEGER, \ | |
212 | .short_name = (s), \ | |
213 | .long_name = (l), \ | |
214 | .value = (v), \ | |
215 | .argh = N_("n"), \ | |
216 | .help = (h), \ | |
217 | .flags = (f), \ | |
218 | } | |
2de37349 | 219 | |
353e6d45 SG |
220 | #define OPT_END() { \ |
221 | .type = OPTION_END, \ | |
222 | } | |
223 | #define OPT_GROUP(h) { \ | |
224 | .type = OPTION_GROUP, \ | |
225 | .help = (h), \ | |
226 | } | |
2de37349 | 227 | #define OPT_BIT(s, l, v, h, b) OPT_BIT_F(s, l, v, h, b, 0) |
353e6d45 SG |
228 | #define OPT_BITOP(s, l, v, h, set, clear) { \ |
229 | .type = OPTION_BITOP, \ | |
230 | .short_name = (s), \ | |
231 | .long_name = (l), \ | |
232 | .value = (v), \ | |
233 | .help = (h), \ | |
234 | .flags = PARSE_OPT_NOARG|PARSE_OPT_NONEG, \ | |
235 | .defval = (set), \ | |
236 | .extra = (clear), \ | |
237 | } | |
238 | #define OPT_NEGBIT(s, l, v, h, b) { \ | |
239 | .type = OPTION_NEGBIT, \ | |
240 | .short_name = (s), \ | |
241 | .long_name = (l), \ | |
242 | .value = (v), \ | |
243 | .help = (h), \ | |
244 | .flags = PARSE_OPT_NOARG, \ | |
245 | .defval = (b), \ | |
246 | } | |
2de37349 NTND |
247 | #define OPT_COUNTUP(s, l, v, h) OPT_COUNTUP_F(s, l, v, h, 0) |
248 | #define OPT_SET_INT(s, l, v, h, i) OPT_SET_INT_F(s, l, v, h, i, 0) | |
249 | #define OPT_BOOL(s, l, v, h) OPT_BOOL_F(s, l, v, h, 0) | |
353e6d45 SG |
250 | #define OPT_HIDDEN_BOOL(s, l, v, h) { \ |
251 | .type = OPTION_SET_INT, \ | |
252 | .short_name = (s), \ | |
253 | .long_name = (l), \ | |
254 | .value = (v), \ | |
255 | .help = (h), \ | |
256 | .flags = PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, \ | |
257 | .defval = 1, \ | |
258 | } | |
259 | #define OPT_CMDMODE_F(s, l, v, h, i, f) { \ | |
260 | .type = OPTION_SET_INT, \ | |
261 | .short_name = (s), \ | |
262 | .long_name = (l), \ | |
263 | .value = (v), \ | |
264 | .help = (h), \ | |
265 | .flags = PARSE_OPT_CMDMODE|PARSE_OPT_NOARG|PARSE_OPT_NONEG | (f), \ | |
266 | .defval = (i), \ | |
267 | } | |
d35d03cf ÆAB |
268 | #define OPT_CMDMODE(s, l, v, h, i) OPT_CMDMODE_F(s, l, v, h, i, 0) |
269 | ||
16ed6c97 | 270 | #define OPT_INTEGER(s, l, v, h) OPT_INTEGER_F(s, l, v, h, 0) |
353e6d45 SG |
271 | #define OPT_MAGNITUDE(s, l, v, h) { \ |
272 | .type = OPTION_MAGNITUDE, \ | |
273 | .short_name = (s), \ | |
274 | .long_name = (l), \ | |
275 | .value = (v), \ | |
276 | .argh = N_("n"), \ | |
277 | .help = (h), \ | |
278 | .flags = PARSE_OPT_NONEG, \ | |
279 | } | |
31fba9d3 | 280 | #define OPT_STRING(s, l, v, a, h) OPT_STRING_F(s, l, v, a, h, 0) |
353e6d45 SG |
281 | #define OPT_STRING_LIST(s, l, v, a, h) { \ |
282 | .type = OPTION_CALLBACK, \ | |
283 | .short_name = (s), \ | |
284 | .long_name = (l), \ | |
285 | .value = (v), \ | |
286 | .argh = (a), \ | |
287 | .help = (h), \ | |
288 | .callback = &parse_opt_string_list, \ | |
289 | } | |
fb60b9f3 PW |
290 | #define OPT_STRVEC(s, l, v, a, h) { \ |
291 | .type = OPTION_CALLBACK, \ | |
292 | .short_name = (s), \ | |
293 | .long_name = (l), \ | |
294 | .value = (v), \ | |
295 | .argh = (a), \ | |
296 | .help = (h), \ | |
297 | .callback = &parse_opt_strvec, \ | |
298 | } | |
353e6d45 SG |
299 | #define OPT_UYN(s, l, v, h) { \ |
300 | .type = OPTION_CALLBACK, \ | |
301 | .short_name = (s), \ | |
302 | .long_name = (l), \ | |
303 | .value = (v), \ | |
304 | .help = (h), \ | |
305 | .flags = PARSE_OPT_NOARG, \ | |
306 | .callback = &parse_opt_tertiary, \ | |
307 | } | |
308 | #define OPT_EXPIRY_DATE(s, l, v, h) { \ | |
309 | .type = OPTION_CALLBACK, \ | |
310 | .short_name = (s), \ | |
311 | .long_name = (l), \ | |
312 | .value = (v), \ | |
313 | .argh = N_("expiry-date"), \ | |
314 | .help = (h), \ | |
315 | .callback = parse_opt_expiry_date_cb, \ | |
316 | } | |
ab0845b3 | 317 | #define OPT_CALLBACK(s, l, v, a, h, cb) OPT_CALLBACK_F(s, l, v, a, h, 0, cb) |
353e6d45 SG |
318 | #define OPT_NUMBER_CALLBACK(v, h, cb) { \ |
319 | .type = OPTION_NUMBER, \ | |
320 | .value = (v), \ | |
321 | .help = (h), \ | |
322 | .flags = PARSE_OPT_NOARG | PARSE_OPT_NONEG, \ | |
323 | .callback = (cb), \ | |
324 | } | |
325 | #define OPT_FILENAME(s, l, v, h) { \ | |
326 | .type = OPTION_FILENAME, \ | |
327 | .short_name = (s), \ | |
328 | .long_name = (l), \ | |
329 | .value = (v), \ | |
330 | .argh = N_("file"), \ | |
331 | .help = (h), \ | |
332 | } | |
333 | #define OPT_COLOR_FLAG(s, l, v, h) { \ | |
334 | .type = OPTION_CALLBACK, \ | |
335 | .short_name = (s), \ | |
336 | .long_name = (l), \ | |
337 | .value = (v), \ | |
338 | .argh = N_("when"), \ | |
339 | .help = (h), \ | |
340 | .flags = PARSE_OPT_OPTARG, \ | |
341 | .callback = parse_opt_color_flag_cb, \ | |
342 | .defval = (intptr_t)"always", \ | |
343 | } | |
344 | ||
345 | #define OPT_NOOP_NOARG(s, l) { \ | |
346 | .type = OPTION_CALLBACK, \ | |
347 | .short_name = (s), \ | |
348 | .long_name = (l), \ | |
349 | .help = N_("no-op (backward compatibility)"), \ | |
350 | .flags = PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, \ | |
351 | .callback = parse_opt_noop_cb, \ | |
352 | } | |
353 | ||
354 | #define OPT_ALIAS(s, l, source_long_name) { \ | |
355 | .type = OPTION_ALIAS, \ | |
356 | .short_name = (s), \ | |
357 | .long_name = (l), \ | |
358 | .value = (source_long_name), \ | |
359 | } | |
5c387428 | 360 | |
fa83cc83 SG |
361 | #define OPT_SUBCOMMAND_F(l, v, fn, f) { \ |
362 | .type = OPTION_SUBCOMMAND, \ | |
363 | .long_name = (l), \ | |
364 | .value = (v), \ | |
365 | .flags = (f), \ | |
353e6d45 SG |
366 | .subcommand_fn = (fn), \ |
367 | } | |
fa83cc83 SG |
368 | #define OPT_SUBCOMMAND(l, v, fn) OPT_SUBCOMMAND_F((l), (v), (fn), 0) |
369 | ||
202fbb33 NTND |
370 | /* |
371 | * parse_options() will filter out the processed options and leave the | |
372 | * non-option arguments in argv[]. argv0 is assumed program name and | |
373 | * skipped. | |
374 | * | |
375 | * usagestr strings should be marked for translation with N_(). | |
376 | * | |
4a59fd13 | 377 | * Returns the number of arguments left in argv[]. |
202fbb33 NTND |
378 | * |
379 | * In one-shot mode, argv0 is not a program name, argv[] is left | |
380 | * untouched and parse_options() returns the number of options | |
381 | * processed. | |
4a59fd13 | 382 | */ |
06a199f3 ÆAB |
383 | int parse_options(int argc, const char **argv, const char *prefix, |
384 | const struct option *options, | |
385 | const char * const usagestr[], | |
386 | enum parse_opt_flags flags); | |
d7a38c54 | 387 | |
1987b0b2 NTND |
388 | NORETURN void usage_with_options(const char * const *usagestr, |
389 | const struct option *options); | |
4a59fd13 | 390 | |
1987b0b2 NTND |
391 | NORETURN void usage_msg_opt(const char *msg, |
392 | const char * const *usagestr, | |
393 | const struct option *options); | |
451bb210 | 394 | |
fa476be8 ÆAB |
395 | /** |
396 | * usage_msg_optf() is like usage_msg_opt() except that the first | |
397 | * argument is a format string, and optional format arguments follow | |
398 | * after the 3rd option. | |
399 | */ | |
400 | __attribute__((format (printf,1,4))) | |
401 | void NORETURN usage_msg_optf(const char *fmt, | |
402 | const char * const *usagestr, | |
403 | const struct option *options, ...); | |
404 | ||
a699367b JNA |
405 | void die_for_incompatible_opt4(int opt1, const char *opt1_name, |
406 | int opt2, const char *opt2_name, | |
407 | int opt3, const char *opt3_name, | |
408 | int opt4, const char *opt4_name); | |
409 | ||
410 | ||
411 | static inline void die_for_incompatible_opt3(int opt1, const char *opt1_name, | |
412 | int opt2, const char *opt2_name, | |
413 | int opt3, const char *opt3_name) | |
414 | { | |
415 | die_for_incompatible_opt4(opt1, opt1_name, | |
416 | opt2, opt2_name, | |
417 | opt3, opt3_name, | |
418 | 0, ""); | |
419 | } | |
420 | ||
517fe807 JK |
421 | /* |
422 | * Use these assertions for callbacks that expect to be called with NONEG and | |
423 | * NOARG respectively, and do not otherwise handle the "unset" and "arg" | |
424 | * parameters. | |
425 | */ | |
426 | #define BUG_ON_OPT_NEG(unset) do { \ | |
427 | if ((unset)) \ | |
428 | BUG("option callback does not expect negation"); \ | |
429 | } while (0) | |
430 | #define BUG_ON_OPT_ARG(arg) do { \ | |
431 | if ((arg)) \ | |
432 | BUG("option callback does not expect an argument"); \ | |
433 | } while (0) | |
434 | ||
cbdeab98 BR |
435 | /* |
436 | * Similar to the assertions above, but checks that "arg" is always non-NULL. | |
437 | * This assertion also implies BUG_ON_OPT_NEG(), letting you declare both | |
438 | * assertions in a single line. | |
439 | */ | |
440 | #define BUG_ON_OPT_NEG_NOARG(unset, arg) do { \ | |
441 | BUG_ON_OPT_NEG(unset); \ | |
442 | if(!(arg)) \ | |
443 | BUG("option callback expects an argument"); \ | |
444 | } while(0) | |
445 | ||
3ea3c215 | 446 | /*----- incremental advanced APIs -----*/ |
7e7bbcb4 | 447 | |
0025dde7 RS |
448 | struct parse_opt_cmdmode_list; |
449 | ||
26141b5b PH |
450 | /* |
451 | * It's okay for the caller to consume argv/argc in the usual way. | |
452 | * Other fields of that structure are private to parse-options and should not | |
453 | * be modified in any way. | |
454 | */ | |
7e7bbcb4 PH |
455 | struct parse_opt_ctx_t { |
456 | const char **argv; | |
457 | const char **out; | |
5ad0d3d5 | 458 | int argc, cpidx, total; |
7e7bbcb4 | 459 | const char *opt; |
3f9ab7cc | 460 | enum parse_opt_flags flags; |
fa83cc83 | 461 | unsigned has_subcommands; |
37782920 | 462 | const char *prefix; |
5c387428 | 463 | const char **alias_groups; /* must be in groups of 3 elements! */ |
0025dde7 | 464 | struct parse_opt_cmdmode_list *cmdmode_list; |
7e7bbcb4 PH |
465 | }; |
466 | ||
1987b0b2 NTND |
467 | void parse_options_start(struct parse_opt_ctx_t *ctx, |
468 | int argc, const char **argv, const char *prefix, | |
3f9ab7cc ÆAB |
469 | const struct option *options, |
470 | enum parse_opt_flags flags); | |
7e7bbcb4 | 471 | |
352e7613 ÆAB |
472 | enum parse_opt_result parse_options_step(struct parse_opt_ctx_t *ctx, |
473 | const struct option *options, | |
474 | const char * const usagestr[]); | |
ff43ec3e | 475 | |
1987b0b2 | 476 | int parse_options_end(struct parse_opt_ctx_t *ctx); |
7e7bbcb4 | 477 | |
20871822 | 478 | struct option *parse_options_dup(const struct option *a); |
c8407857 | 479 | struct option *parse_options_concat(const struct option *a, const struct option *b); |
7e7bbcb4 | 480 | |
0ce865b1 | 481 | /*----- some often used options -----*/ |
1987b0b2 NTND |
482 | int parse_opt_abbrev_cb(const struct option *, const char *, int); |
483 | int parse_opt_expiry_date_cb(const struct option *, const char *, int); | |
484 | int parse_opt_color_flag_cb(const struct option *, const char *, int); | |
485 | int parse_opt_verbosity_cb(const struct option *, const char *, int); | |
33898531 | 486 | /* value is struct oid_array* */ |
1987b0b2 | 487 | int parse_opt_object_name(const struct option *, const char *, int); |
33898531 PW |
488 | /* value is struct object_id* */ |
489 | int parse_opt_object_id(const struct option *, const char *, int); | |
1987b0b2 | 490 | int parse_opt_commits(const struct option *, const char *, int); |
7d3488eb | 491 | int parse_opt_commit(const struct option *, const char *, int); |
1987b0b2 NTND |
492 | int parse_opt_tertiary(const struct option *, const char *, int); |
493 | int parse_opt_string_list(const struct option *, const char *, int); | |
fb60b9f3 | 494 | int parse_opt_strvec(const struct option *, const char *, int); |
1987b0b2 | 495 | int parse_opt_noop_cb(const struct option *, const char *, int); |
1987b0b2 NTND |
496 | int parse_opt_passthru(const struct option *, const char *, int); |
497 | int parse_opt_passthru_argv(const struct option *, const char *, int); | |
d3115660 JS |
498 | /* value is enum branch_track* */ |
499 | int parse_opt_tracking_mode(const struct option *, const char *, int); | |
0ce865b1 | 500 | |
212c0a6f NTND |
501 | #define OPT__VERBOSE(var, h) OPT_COUNTUP('v', "verbose", (var), (h)) |
502 | #define OPT__QUIET(var, h) OPT_COUNTUP('q', "quiet", (var), (h)) | |
353e6d45 SG |
503 | #define OPT__VERBOSITY(var) { \ |
504 | .type = OPTION_CALLBACK, \ | |
505 | .short_name = 'v', \ | |
506 | .long_name = "verbose", \ | |
507 | .value = (var), \ | |
508 | .help = N_("be more verbose"), \ | |
509 | .flags = PARSE_OPT_NOARG, \ | |
510 | .callback = &parse_opt_verbosity_cb, \ | |
511 | }, { \ | |
512 | .type = OPTION_CALLBACK, \ | |
513 | .short_name = 'q', \ | |
514 | .long_name = "quiet", \ | |
515 | .value = (var), \ | |
516 | .help = N_("be more quiet"), \ | |
517 | .flags = PARSE_OPT_NOARG, \ | |
518 | .callback = &parse_opt_verbosity_cb, \ | |
519 | } | |
212c0a6f | 520 | #define OPT__DRY_RUN(var, h) OPT_BOOL('n', "dry-run", (var), (h)) |
1224781d | 521 | #define OPT__FORCE(var, h, f) OPT_COUNTUP_F('f', "force", (var), (h), (f)) |
353e6d45 SG |
522 | #define OPT__ABBREV(var) { \ |
523 | .type = OPTION_CALLBACK, \ | |
524 | .long_name = "abbrev", \ | |
525 | .value = (var), \ | |
526 | .argh = N_("n"), \ | |
527 | .help = N_("use <n> digits to display object names"), \ | |
528 | .flags = PARSE_OPT_OPTARG, \ | |
529 | .callback = &parse_opt_abbrev_cb, \ | |
530 | } | |
bb61a962 ÆAB |
531 | #define OPT__SUPER_PREFIX(var) \ |
532 | OPT_STRING_F(0, "super-prefix", (var), N_("prefix"), \ | |
533 | N_("prefixed path to initial superproject"), PARSE_OPT_HIDDEN) | |
534 | ||
73e9da01 ML |
535 | #define OPT__COLOR(var, h) \ |
536 | OPT_COLOR_FLAG(0, "color", (var), (h)) | |
353e6d45 SG |
537 | #define OPT_COLUMN(s, l, v, h) { \ |
538 | .type = OPTION_CALLBACK, \ | |
539 | .short_name = (s), \ | |
540 | .long_name = (l), \ | |
541 | .value = (v), \ | |
542 | .argh = N_("style"), \ | |
543 | .help = (h), \ | |
544 | .flags = PARSE_OPT_OPTARG, \ | |
545 | .callback = parseopt_column_callback, \ | |
546 | } | |
547 | #define OPT_PASSTHRU(s, l, v, a, h, f) { \ | |
548 | .type = OPTION_CALLBACK, \ | |
549 | .short_name = (s), \ | |
550 | .long_name = (l), \ | |
551 | .value = (v), \ | |
552 | .argh = (a), \ | |
553 | .help = (h), \ | |
554 | .flags = (f), \ | |
555 | .callback = parse_opt_passthru, \ | |
556 | } | |
557 | #define OPT_PASSTHRU_ARGV(s, l, v, a, h, f) { \ | |
558 | .type = OPTION_CALLBACK, \ | |
559 | .short_name = (s), \ | |
560 | .long_name = (l), \ | |
561 | .value = (v), \ | |
562 | .argh = (a), \ | |
563 | .help = (h), \ | |
564 | .flags = (f), \ | |
565 | .callback = parse_opt_passthru_argv, \ | |
566 | } | |
567 | #define _OPT_CONTAINS_OR_WITH(l, v, h, f) { \ | |
568 | .type = OPTION_CALLBACK, \ | |
569 | .long_name = (l), \ | |
570 | .value = (v), \ | |
571 | .argh = N_("commit"), \ | |
572 | .help = (h), \ | |
573 | .flags = PARSE_OPT_LASTARG_DEFAULT | (f), \ | |
574 | .callback = parse_opt_commits, \ | |
575 | .defval = (intptr_t) "HEAD", \ | |
576 | } | |
eab98ee5 | 577 | #define OPT_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("contains", v, h, PARSE_OPT_NONEG) |
ac3f5a34 | 578 | #define OPT_NO_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("no-contains", v, h, PARSE_OPT_NONEG) |
eab98ee5 | 579 | #define OPT_WITH(v, h) _OPT_CONTAINS_OR_WITH("with", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG) |
ac3f5a34 | 580 | #define OPT_WITHOUT(v, h) _OPT_CONTAINS_OR_WITH("without", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG) |
ca04dc96 | 581 | #define OPT_CLEANUP(v) OPT_STRING(0, "cleanup", v, N_("mode"), N_("how to strip spaces and #comments from message")) |
add97702 AM |
582 | #define OPT_PATHSPEC_FROM_FILE(v) OPT_FILENAME(0, "pathspec-from-file", v, N_("read pathspec from file")) |
583 | #define OPT_PATHSPEC_FILE_NUL(v) OPT_BOOL(0, "pathspec-file-nul", v, N_("with --pathspec-from-file, pathspec elements are separated with NUL character")) | |
a03b5553 | 584 | #define OPT_AUTOSTASH(v) OPT_BOOL(0, "autostash", v, N_("automatically stash/stash pop before and after")) |
0ce865b1 | 585 | |
ae2c912c | 586 | #define OPT_IPVERSION(v) \ |
a2dad486 JH |
587 | OPT_SET_INT_F('4', "ipv4", (v), N_("use IPv4 addresses only"), \ |
588 | TRANSPORT_FAMILY_IPV4, PARSE_OPT_NONEG), \ | |
589 | OPT_SET_INT_F('6', "ipv6", (v), N_("use IPv6 addresses only"), \ | |
590 | TRANSPORT_FAMILY_IPV6, PARSE_OPT_NONEG) | |
ae2c912c | 591 | |
4a59fd13 | 592 | #endif |