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