]>
Commit | Line | Data |
---|---|---|
1843b4e0 JP |
1 | #ifndef __SUBCMD_PARSE_OPTIONS_H |
2 | #define __SUBCMD_PARSE_OPTIONS_H | |
07800601 | 3 | |
8035458f | 4 | #include <stdbool.h> |
2f4ce5ec | 5 | #include <stdint.h> |
1967936d | 6 | |
24b1e5d7 JP |
7 | #ifndef NORETURN |
8 | #define NORETURN __attribute__((__noreturn__)) | |
9 | #endif | |
10 | ||
07800601 IM |
11 | enum parse_opt_type { |
12 | /* special types */ | |
13 | OPTION_END, | |
14 | OPTION_ARGUMENT, | |
15 | OPTION_GROUP, | |
16 | /* options with no arguments */ | |
17 | OPTION_BIT, | |
c0555642 IM |
18 | OPTION_BOOLEAN, |
19 | OPTION_INCR, | |
edb7c60e | 20 | OPTION_SET_UINT, |
07800601 IM |
21 | OPTION_SET_PTR, |
22 | /* options with arguments (usually) */ | |
23 | OPTION_STRING, | |
24 | OPTION_INTEGER, | |
e61078a0 | 25 | OPTION_LONG, |
07800601 | 26 | OPTION_CALLBACK, |
6ba85cea | 27 | OPTION_U64, |
c100edbe | 28 | OPTION_UINTEGER, |
07800601 IM |
29 | }; |
30 | ||
31 | enum parse_opt_flags { | |
32 | PARSE_OPT_KEEP_DASHDASH = 1, | |
33 | PARSE_OPT_STOP_AT_NON_OPTION = 2, | |
34 | PARSE_OPT_KEEP_ARGV0 = 4, | |
35 | PARSE_OPT_KEEP_UNKNOWN = 8, | |
36 | PARSE_OPT_NO_INTERNAL_HELP = 16, | |
37 | }; | |
38 | ||
39 | enum parse_opt_option_flags { | |
40 | PARSE_OPT_OPTARG = 1, | |
41 | PARSE_OPT_NOARG = 2, | |
42 | PARSE_OPT_NONEG = 4, | |
43 | PARSE_OPT_HIDDEN = 8, | |
44 | PARSE_OPT_LASTARG_DEFAULT = 16, | |
d152d1be | 45 | PARSE_OPT_DISABLED = 32, |
42bd71d0 | 46 | PARSE_OPT_EXCLUSIVE = 64, |
0c8c2077 | 47 | PARSE_OPT_NOEMPTY = 128, |
48e1cab1 WN |
48 | PARSE_OPT_NOBUILD = 256, |
49 | PARSE_OPT_CANSKIP = 512, | |
07800601 IM |
50 | }; |
51 | ||
52 | struct option; | |
53 | typedef int parse_opt_cb(const struct option *, const char *arg, int unset); | |
54 | ||
55 | /* | |
56 | * `type`:: | |
57 | * holds the type of the option, you must have an OPTION_END last in your | |
58 | * array. | |
59 | * | |
60 | * `short_name`:: | |
61 | * the character to use as a short option name, '\0' if none. | |
62 | * | |
63 | * `long_name`:: | |
64 | * the long option name, without the leading dashes, NULL if none. | |
65 | * | |
66 | * `value`:: | |
67 | * stores pointers to the values to be filled. | |
68 | * | |
69 | * `argh`:: | |
70 | * token to explain the kind of argument this option wants. Keep it | |
71 | * homogenous across the repository. | |
72 | * | |
73 | * `help`:: | |
74 | * the short help associated to what the option does. | |
75 | * Must never be NULL (except for OPTION_END). | |
76 | * OPTION_GROUP uses this pointer to store the group header. | |
77 | * | |
78 | * `flags`:: | |
79 | * mask of parse_opt_option_flags. | |
80 | * PARSE_OPT_OPTARG: says that the argument is optionnal (not for BOOLEANs) | |
81 | * PARSE_OPT_NOARG: says that this option takes no argument, for CALLBACKs | |
82 | * PARSE_OPT_NONEG: says that this option cannot be negated | |
83 | * PARSE_OPT_HIDDEN this option is skipped in the default usage, showed in | |
84 | * the long one. | |
85 | * | |
86 | * `callback`:: | |
87 | * pointer to the callback to use for OPTION_CALLBACK. | |
88 | * | |
89 | * `defval`:: | |
90 | * default value to fill (*->value) with for PARSE_OPT_OPTARG. | |
edb7c60e | 91 | * OPTION_{BIT,SET_UINT,SET_PTR} store the {mask,integer,pointer} to put in |
07800601 IM |
92 | * the value when met. |
93 | * CALLBACKS can use it like they want. | |
167faf32 AH |
94 | * |
95 | * `set`:: | |
96 | * whether an option was set by the user | |
07800601 IM |
97 | */ |
98 | struct option { | |
99 | enum parse_opt_type type; | |
100 | int short_name; | |
101 | const char *long_name; | |
102 | void *value; | |
103 | const char *argh; | |
104 | const char *help; | |
48e1cab1 | 105 | const char *build_opt; |
07800601 IM |
106 | |
107 | int flags; | |
108 | parse_opt_cb *callback; | |
109 | intptr_t defval; | |
167faf32 | 110 | bool *set; |
ea8e08a1 | 111 | void *data; |
369a2478 | 112 | const struct option *parent; |
07800601 IM |
113 | }; |
114 | ||
1967936d ACM |
115 | #define check_vtype(v, type) ( BUILD_BUG_ON_ZERO(!__builtin_types_compatible_p(typeof(v), type)) + v ) |
116 | ||
f37a291c | 117 | #define OPT_END() { .type = OPTION_END } |
369a2478 | 118 | #define OPT_PARENT(p) { .type = OPTION_END, .parent = (p) } |
f37a291c IM |
119 | #define OPT_ARGUMENT(l, h) { .type = OPTION_ARGUMENT, .long_name = (l), .help = (h) } |
120 | #define OPT_GROUP(h) { .type = OPTION_GROUP, .help = (h) } | |
edb7c60e | 121 | #define OPT_BIT(s, l, v, h, b) { .type = OPTION_BIT, .short_name = (s), .long_name = (l), .value = check_vtype(v, int *), .help = (h), .defval = (b) } |
8035458f | 122 | #define OPT_BOOLEAN(s, l, v, h) { .type = OPTION_BOOLEAN, .short_name = (s), .long_name = (l), .value = check_vtype(v, bool *), .help = (h) } |
b272a59d | 123 | #define OPT_BOOLEAN_FLAG(s, l, v, h, f) { .type = OPTION_BOOLEAN, .short_name = (s), .long_name = (l), .value = check_vtype(v, bool *), .help = (h), .flags = (f) } |
167faf32 AH |
124 | #define OPT_BOOLEAN_SET(s, l, v, os, h) \ |
125 | { .type = OPTION_BOOLEAN, .short_name = (s), .long_name = (l), \ | |
126 | .value = check_vtype(v, bool *), .help = (h), \ | |
127 | .set = check_vtype(os, bool *)} | |
edb7c60e ACM |
128 | #define OPT_INCR(s, l, v, h) { .type = OPTION_INCR, .short_name = (s), .long_name = (l), .value = check_vtype(v, int *), .help = (h) } |
129 | #define OPT_SET_UINT(s, l, v, h, i) { .type = OPTION_SET_UINT, .short_name = (s), .long_name = (l), .value = check_vtype(v, unsigned int *), .help = (h), .defval = (i) } | |
f37a291c | 130 | #define OPT_SET_PTR(s, l, v, h, p) { .type = OPTION_SET_PTR, .short_name = (s), .long_name = (l), .value = (v), .help = (h), .defval = (p) } |
1967936d ACM |
131 | #define OPT_INTEGER(s, l, v, h) { .type = OPTION_INTEGER, .short_name = (s), .long_name = (l), .value = check_vtype(v, int *), .help = (h) } |
132 | #define OPT_UINTEGER(s, l, v, h) { .type = OPTION_UINTEGER, .short_name = (s), .long_name = (l), .value = check_vtype(v, unsigned int *), .help = (h) } | |
edb7c60e ACM |
133 | #define OPT_LONG(s, l, v, h) { .type = OPTION_LONG, .short_name = (s), .long_name = (l), .value = check_vtype(v, long *), .help = (h) } |
134 | #define OPT_U64(s, l, v, h) { .type = OPTION_U64, .short_name = (s), .long_name = (l), .value = check_vtype(v, u64 *), .help = (h) } | |
135 | #define OPT_STRING(s, l, v, a, h) { .type = OPTION_STRING, .short_name = (s), .long_name = (l), .value = check_vtype(v, const char **), (a), .help = (h) } | |
2dd6d8a1 AH |
136 | #define OPT_STRING_OPTARG(s, l, v, a, h, d) \ |
137 | { .type = OPTION_STRING, .short_name = (s), .long_name = (l), \ | |
138 | .value = check_vtype(v, const char **), (a), .help = (h), \ | |
139 | .flags = PARSE_OPT_OPTARG, .defval = (intptr_t)(d) } | |
0c8c2077 | 140 | #define OPT_STRING_NOEMPTY(s, l, v, a, h) { .type = OPTION_STRING, .short_name = (s), .long_name = (l), .value = check_vtype(v, const char **), (a), .help = (h), .flags = PARSE_OPT_NOEMPTY} |
07800601 | 141 | #define OPT_DATE(s, l, v, h) \ |
f37a291c | 142 | { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), .argh = "time", .help = (h), .callback = parse_opt_approxidate_cb } |
07800601 | 143 | #define OPT_CALLBACK(s, l, v, a, h, f) \ |
f37a291c | 144 | { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), (a), .help = (h), .callback = (f) } |
a79d7db9 AV |
145 | #define OPT_CALLBACK_NOOPT(s, l, v, a, h, f) \ |
146 | { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), (a), .help = (h), .callback = (f), .flags = PARSE_OPT_NOARG } | |
5a4b1817 FW |
147 | #define OPT_CALLBACK_DEFAULT(s, l, v, a, h, f, d) \ |
148 | { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), (a), .help = (h), .callback = (f), .defval = (intptr_t)d, .flags = PARSE_OPT_LASTARG_DEFAULT } | |
e4e18d56 AN |
149 | #define OPT_CALLBACK_DEFAULT_NOOPT(s, l, v, a, h, f, d) \ |
150 | { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l),\ | |
151 | .value = (v), (a), .help = (h), .callback = (f), .defval = (intptr_t)d,\ | |
152 | .flags = PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NOARG} | |
ea8e08a1 AH |
153 | #define OPT_CALLBACK_OPTARG(s, l, v, d, a, h, f) \ |
154 | { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), \ | |
155 | .value = (v), (a), .help = (h), .callback = (f), \ | |
156 | .flags = PARSE_OPT_OPTARG, .data = (d) } | |
07800601 IM |
157 | |
158 | /* parse_options() will filter out the processed options and leave the | |
159 | * non-option argments in argv[]. | |
160 | * Returns the number of arguments left in argv[]. | |
24a88bdd JP |
161 | * |
162 | * NOTE: parse_options() and parse_options_subcommand() may call exit() in the | |
163 | * case of an error (or for 'special' options like --list-cmds or --list-opts). | |
07800601 IM |
164 | */ |
165 | extern int parse_options(int argc, const char **argv, | |
166 | const struct option *options, | |
167 | const char * const usagestr[], int flags); | |
168 | ||
09a71b97 RR |
169 | extern int parse_options_subcommand(int argc, const char **argv, |
170 | const struct option *options, | |
171 | const char *const subcommands[], | |
172 | const char *usagestr[], int flags); | |
173 | ||
07800601 IM |
174 | extern NORETURN void usage_with_options(const char * const *usagestr, |
175 | const struct option *options); | |
c7118369 NK |
176 | extern NORETURN __attribute__((format(printf,3,4))) |
177 | void usage_with_options_msg(const char * const *usagestr, | |
178 | const struct option *options, | |
179 | const char *fmt, ...); | |
07800601 IM |
180 | |
181 | /*----- incremantal advanced APIs -----*/ | |
182 | ||
183 | enum { | |
184 | PARSE_OPT_HELP = -1, | |
185 | PARSE_OPT_DONE, | |
09a71b97 RR |
186 | PARSE_OPT_LIST_OPTS, |
187 | PARSE_OPT_LIST_SUBCMDS, | |
07800601 IM |
188 | PARSE_OPT_UNKNOWN, |
189 | }; | |
190 | ||
191 | /* | |
192 | * It's okay for the caller to consume argv/argc in the usual way. | |
193 | * Other fields of that structure are private to parse-options and should not | |
194 | * be modified in any way. | |
195 | */ | |
196 | struct parse_opt_ctx_t { | |
197 | const char **argv; | |
198 | const char **out; | |
199 | int argc, cpidx; | |
200 | const char *opt; | |
42bd71d0 | 201 | const struct option *excl_opt; |
07800601 IM |
202 | int flags; |
203 | }; | |
204 | ||
205 | extern int parse_options_usage(const char * const *usagestr, | |
ac697625 NK |
206 | const struct option *opts, |
207 | const char *optstr, | |
208 | bool short_opt); | |
07800601 | 209 | |
07800601 IM |
210 | |
211 | /*----- some often used options -----*/ | |
212 | extern int parse_opt_abbrev_cb(const struct option *, const char *, int); | |
213 | extern int parse_opt_approxidate_cb(const struct option *, const char *, int); | |
214 | extern int parse_opt_verbosity_cb(const struct option *, const char *, int); | |
215 | ||
216 | #define OPT__VERBOSE(var) OPT_BOOLEAN('v', "verbose", (var), "be verbose") | |
217 | #define OPT__QUIET(var) OPT_BOOLEAN('q', "quiet", (var), "be quiet") | |
218 | #define OPT__VERBOSITY(var) \ | |
219 | { OPTION_CALLBACK, 'v', "verbose", (var), NULL, "be more verbose", \ | |
220 | PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \ | |
221 | { OPTION_CALLBACK, 'q', "quiet", (var), NULL, "be more quiet", \ | |
222 | PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 } | |
223 | #define OPT__DRY_RUN(var) OPT_BOOLEAN('n', "dry-run", (var), "dry run") | |
224 | #define OPT__ABBREV(var) \ | |
225 | { OPTION_CALLBACK, 0, "abbrev", (var), "n", \ | |
226 | "use <n> digits to display SHA-1s", \ | |
227 | PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 } | |
228 | ||
229 | extern const char *parse_options_fix_filename(const char *prefix, const char *file); | |
230 | ||
d152d1be | 231 | void set_option_flag(struct option *opts, int sopt, const char *lopt, int flag); |
48e1cab1 WN |
232 | void set_option_nobuild(struct option *opts, int shortopt, const char *longopt, |
233 | const char *build_opt, bool can_skip); | |
1843b4e0 JP |
234 | |
235 | #endif /* __SUBCMD_PARSE_OPTIONS_H */ |