]>
Commit | Line | Data |
---|---|---|
4a59fd13 PH |
1 | #ifndef PARSE_OPTIONS_H |
2 | #define PARSE_OPTIONS_H | |
3 | ||
4 | enum 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 | ||
26 | enum 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 |
35 | enum 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 | ||
48 | struct option; | |
49 | typedef int parse_opt_cb(const struct option *, const char *arg, int unset); | |
50 | ||
b0b3a8b6 | 51 | struct parse_opt_ctx_t; |
f41179f1 | 52 | typedef 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 |
115 | struct 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) } | |
2de37349 | 139 | |
4a59fd13 | 140 | #define OPT_END() { OPTION_END } |
34aec9f5 SB |
141 | #define OPT_ARGUMENT(l, h) { OPTION_ARGUMENT, 0, (l), NULL, NULL, \ |
142 | (h), PARSE_OPT_NOARG} | |
d7a38c54 | 143 | #define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) } |
2de37349 | 144 | #define OPT_BIT(s, l, v, h, b) OPT_BIT_F(s, l, v, h, b, 0) |
f62470c6 NTND |
145 | #define OPT_BITOP(s, l, v, h, set, clear) { OPTION_BITOP, (s), (l), (v), NULL, (h), \ |
146 | PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, \ | |
bf3ff338 | 147 | (set), NULL, (clear) } |
34aec9f5 SB |
148 | #define OPT_NEGBIT(s, l, v, h, b) { OPTION_NEGBIT, (s), (l), (v), NULL, \ |
149 | (h), PARSE_OPT_NOARG, NULL, (b) } | |
2de37349 NTND |
150 | #define OPT_COUNTUP(s, l, v, h) OPT_COUNTUP_F(s, l, v, h, 0) |
151 | #define OPT_SET_INT(s, l, v, h, i) OPT_SET_INT_F(s, l, v, h, i, 0) | |
152 | #define OPT_BOOL(s, l, v, h) OPT_BOOL_F(s, l, v, h, 0) | |
4741edd5 SB |
153 | #define OPT_HIDDEN_BOOL(s, l, v, h) { OPTION_SET_INT, (s), (l), (v), NULL, \ |
154 | (h), PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, 1} | |
14691e38 | 155 | #define OPT_CMDMODE(s, l, v, h, i) { OPTION_CMDMODE, (s), (l), (v), NULL, \ |
11588263 | 156 | (h), PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, (i) } |
54e6dc7d | 157 | #define OPT_INTEGER(s, l, v, h) { OPTION_INTEGER, (s), (l), (v), N_("n"), (h) } |
2a514ed8 CB |
158 | #define OPT_MAGNITUDE(s, l, v, h) { OPTION_MAGNITUDE, (s), (l), (v), \ |
159 | N_("n"), (h), PARSE_OPT_NONEG } | |
d7a38c54 | 160 | #define OPT_STRING(s, l, v, a, h) { OPTION_STRING, (s), (l), (v), (a), (h) } |
c8ba1639 JK |
161 | #define OPT_STRING_LIST(s, l, v, a, h) \ |
162 | { OPTION_CALLBACK, (s), (l), (v), (a), \ | |
163 | (h), 0, &parse_opt_string_list } | |
b475e442 NTND |
164 | #define OPT_UYN(s, l, v, h) { OPTION_CALLBACK, (s), (l), (v), NULL, \ |
165 | (h), PARSE_OPT_NOARG, &parse_opt_tertiary } | |
27ec394a | 166 | #define OPT_EXPIRY_DATE(s, l, v, h) \ |
e703d711 | 167 | { OPTION_CALLBACK, (s), (l), (v), N_("expiry-date"),(h), 0, \ |
27ec394a | 168 | parse_opt_expiry_date_cb } |
d473e2e0 | 169 | #define OPT_CALLBACK(s, l, v, a, h, f) OPT_CALLBACK_F(s, l, v, a, h, 0, f) |
e0319ff5 RS |
170 | #define OPT_NUMBER_CALLBACK(v, h, f) \ |
171 | { OPTION_NUMBER, 0, NULL, (v), NULL, (h), \ | |
172 | PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) } | |
df217ed6 | 173 | #define OPT_FILENAME(s, l, v, h) { OPTION_FILENAME, (s), (l), (v), \ |
54e6dc7d | 174 | N_("file"), (h) } |
73e9da01 | 175 | #define OPT_COLOR_FLAG(s, l, v, h) \ |
54e6dc7d | 176 | { OPTION_CALLBACK, (s), (l), (v), N_("when"), (h), PARSE_OPT_OPTARG, \ |
73e9da01 ML |
177 | parse_opt_color_flag_cb, (intptr_t)"always" } |
178 | ||
6acec038 RS |
179 | #define OPT_NOOP_NOARG(s, l) \ |
180 | { OPTION_CALLBACK, (s), (l), NULL, NULL, \ | |
54e6dc7d | 181 | N_("no-op (backward compatibility)"), \ |
6acec038 RS |
182 | PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, parse_opt_noop_cb } |
183 | ||
202fbb33 NTND |
184 | /* |
185 | * parse_options() will filter out the processed options and leave the | |
186 | * non-option arguments in argv[]. argv0 is assumed program name and | |
187 | * skipped. | |
188 | * | |
189 | * usagestr strings should be marked for translation with N_(). | |
190 | * | |
4a59fd13 | 191 | * Returns the number of arguments left in argv[]. |
202fbb33 NTND |
192 | * |
193 | * In one-shot mode, argv0 is not a program name, argv[] is left | |
194 | * untouched and parse_options() returns the number of options | |
195 | * processed. | |
4a59fd13 | 196 | */ |
1987b0b2 NTND |
197 | int parse_options(int argc, const char **argv, const char *prefix, |
198 | const struct option *options, | |
199 | const char * const usagestr[], int flags); | |
d7a38c54 | 200 | |
1987b0b2 NTND |
201 | NORETURN void usage_with_options(const char * const *usagestr, |
202 | const struct option *options); | |
4a59fd13 | 203 | |
1987b0b2 NTND |
204 | NORETURN void usage_msg_opt(const char *msg, |
205 | const char * const *usagestr, | |
206 | const struct option *options); | |
451bb210 | 207 | |
1987b0b2 | 208 | int optbug(const struct option *opt, const char *reason); |
9440b831 | 209 | const char *optname(const struct option *opt, int flags); |
a469a101 | 210 | |
517fe807 JK |
211 | /* |
212 | * Use these assertions for callbacks that expect to be called with NONEG and | |
213 | * NOARG respectively, and do not otherwise handle the "unset" and "arg" | |
214 | * parameters. | |
215 | */ | |
216 | #define BUG_ON_OPT_NEG(unset) do { \ | |
217 | if ((unset)) \ | |
218 | BUG("option callback does not expect negation"); \ | |
219 | } while (0) | |
220 | #define BUG_ON_OPT_ARG(arg) do { \ | |
221 | if ((arg)) \ | |
222 | BUG("option callback does not expect an argument"); \ | |
223 | } while (0) | |
224 | ||
3ea3c215 | 225 | /*----- incremental advanced APIs -----*/ |
7e7bbcb4 | 226 | |
f41179f1 NTND |
227 | enum parse_opt_result { |
228 | PARSE_OPT_COMPLETE = -3, | |
229 | PARSE_OPT_HELP = -2, | |
230 | PARSE_OPT_ERROR = -1, /* must be the same as error() */ | |
231 | PARSE_OPT_DONE = 0, /* fixed so that "return 0" works */ | |
979240fe | 232 | PARSE_OPT_NON_OPTION, |
4b05548f | 233 | PARSE_OPT_UNKNOWN |
ee68b87a PH |
234 | }; |
235 | ||
26141b5b PH |
236 | /* |
237 | * It's okay for the caller to consume argv/argc in the usual way. | |
238 | * Other fields of that structure are private to parse-options and should not | |
239 | * be modified in any way. | |
240 | */ | |
7e7bbcb4 PH |
241 | struct parse_opt_ctx_t { |
242 | const char **argv; | |
243 | const char **out; | |
5ad0d3d5 | 244 | int argc, cpidx, total; |
7e7bbcb4 PH |
245 | const char *opt; |
246 | int flags; | |
37782920 | 247 | const char *prefix; |
7e7bbcb4 PH |
248 | }; |
249 | ||
1987b0b2 NTND |
250 | void parse_options_start(struct parse_opt_ctx_t *ctx, |
251 | int argc, const char **argv, const char *prefix, | |
252 | const struct option *options, int flags); | |
7e7bbcb4 | 253 | |
1987b0b2 NTND |
254 | int parse_options_step(struct parse_opt_ctx_t *ctx, |
255 | const struct option *options, | |
256 | const char * const usagestr[]); | |
ff43ec3e | 257 | |
1987b0b2 | 258 | int parse_options_end(struct parse_opt_ctx_t *ctx); |
7e7bbcb4 | 259 | |
1987b0b2 | 260 | struct option *parse_options_concat(struct option *a, struct option *b); |
7e7bbcb4 | 261 | |
0ce865b1 | 262 | /*----- some often used options -----*/ |
1987b0b2 NTND |
263 | int parse_opt_abbrev_cb(const struct option *, const char *, int); |
264 | int parse_opt_expiry_date_cb(const struct option *, const char *, int); | |
265 | int parse_opt_color_flag_cb(const struct option *, const char *, int); | |
266 | int parse_opt_verbosity_cb(const struct option *, const char *, int); | |
267 | int parse_opt_object_name(const struct option *, const char *, int); | |
268 | int parse_opt_commits(const struct option *, const char *, int); | |
7d3488eb | 269 | int parse_opt_commit(const struct option *, const char *, int); |
1987b0b2 NTND |
270 | int parse_opt_tertiary(const struct option *, const char *, int); |
271 | int parse_opt_string_list(const struct option *, const char *, int); | |
272 | int parse_opt_noop_cb(const struct option *, const char *, int); | |
3ebbe289 | 273 | int parse_opt_unknown_cb(struct parse_opt_ctx_t *ctx, const struct option *, const char *, int); |
1987b0b2 NTND |
274 | int parse_opt_passthru(const struct option *, const char *, int); |
275 | int parse_opt_passthru_argv(const struct option *, const char *, int); | |
0ce865b1 | 276 | |
212c0a6f NTND |
277 | #define OPT__VERBOSE(var, h) OPT_COUNTUP('v', "verbose", (var), (h)) |
278 | #define OPT__QUIET(var, h) OPT_COUNTUP('q', "quiet", (var), (h)) | |
7f87aff2 | 279 | #define OPT__VERBOSITY(var) \ |
54e6dc7d | 280 | { OPTION_CALLBACK, 'v', "verbose", (var), NULL, N_("be more verbose"), \ |
7f87aff2 | 281 | PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \ |
54e6dc7d | 282 | { OPTION_CALLBACK, 'q', "quiet", (var), NULL, N_("be more quiet"), \ |
7f87aff2 | 283 | PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 } |
212c0a6f | 284 | #define OPT__DRY_RUN(var, h) OPT_BOOL('n', "dry-run", (var), (h)) |
1224781d | 285 | #define OPT__FORCE(var, h, f) OPT_COUNTUP_F('f', "force", (var), (h), (f)) |
0ce865b1 | 286 | #define OPT__ABBREV(var) \ |
54e6dc7d NTND |
287 | { OPTION_CALLBACK, 0, "abbrev", (var), N_("n"), \ |
288 | N_("use <n> digits to display SHA-1s"), \ | |
0ce865b1 | 289 | PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 } |
73e9da01 ML |
290 | #define OPT__COLOR(var, h) \ |
291 | OPT_COLOR_FLAG(0, "color", (var), (h)) | |
7e29b825 | 292 | #define OPT_COLUMN(s, l, v, h) \ |
a054e049 | 293 | { OPTION_CALLBACK, (s), (l), (v), N_("style"), (h), PARSE_OPT_OPTARG, parseopt_column_callback } |
6b3ee18d PT |
294 | #define OPT_PASSTHRU(s, l, v, a, h, f) \ |
295 | { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru } | |
ffad85c5 PT |
296 | #define OPT_PASSTHRU_ARGV(s, l, v, a, h, f) \ |
297 | { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru_argv } | |
f266c916 KN |
298 | #define _OPT_CONTAINS_OR_WITH(name, variable, help, flag) \ |
299 | { OPTION_CALLBACK, 0, name, (variable), N_("commit"), (help), \ | |
300 | PARSE_OPT_LASTARG_DEFAULT | flag, \ | |
301 | parse_opt_commits, (intptr_t) "HEAD" \ | |
302 | } | |
eab98ee5 | 303 | #define OPT_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("contains", v, h, PARSE_OPT_NONEG) |
ac3f5a34 | 304 | #define OPT_NO_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("no-contains", v, h, PARSE_OPT_NONEG) |
eab98ee5 | 305 | #define OPT_WITH(v, h) _OPT_CONTAINS_OR_WITH("with", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG) |
ac3f5a34 | 306 | #define OPT_WITHOUT(v, h) _OPT_CONTAINS_OR_WITH("without", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG) |
0ce865b1 | 307 | |
4a59fd13 | 308 | #endif |