Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1#ifndef __SUBCMD_PARSE_OPTIONS_H
2#define __SUBCMD_PARSE_OPTIONS_H
3
4#include <stdbool.h>
5#include <stdint.h>
6
7#ifndef NORETURN
8#define NORETURN __attribute__((__noreturn__))
9#endif
10
11enum parse_opt_type {
12 /* special types */
13 OPTION_END,
14 OPTION_ARGUMENT,
15 OPTION_GROUP,
16 /* options with no arguments */
17 OPTION_BIT,
18 OPTION_BOOLEAN,
19 OPTION_INCR,
20 OPTION_SET_UINT,
21 OPTION_SET_PTR,
22 /* options with arguments (usually) */
23 OPTION_STRING,
24 OPTION_INTEGER,
25 OPTION_LONG,
26 OPTION_CALLBACK,
27 OPTION_U64,
28 OPTION_UINTEGER,
29};
30
31enum 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
39enum 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,
45 PARSE_OPT_DISABLED = 32,
46 PARSE_OPT_EXCLUSIVE = 64,
47 PARSE_OPT_NOEMPTY = 128,
48 PARSE_OPT_NOBUILD = 256,
49 PARSE_OPT_CANSKIP = 512,
50};
51
52struct option;
53typedef 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.
91 * OPTION_{BIT,SET_UINT,SET_PTR} store the {mask,integer,pointer} to put in
92 * the value when met.
93 * CALLBACKS can use it like they want.
94 *
95 * `set`::
96 * whether an option was set by the user
97 */
98struct 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;
105 const char *build_opt;
106
107 int flags;
108 parse_opt_cb *callback;
109 intptr_t defval;
110 bool *set;
111 void *data;
112};
113
114#define check_vtype(v, type) ( BUILD_BUG_ON_ZERO(!__builtin_types_compatible_p(typeof(v), type)) + v )
115
116#define OPT_END() { .type = OPTION_END }
117#define OPT_ARGUMENT(l, h) { .type = OPTION_ARGUMENT, .long_name = (l), .help = (h) }
118#define OPT_GROUP(h) { .type = OPTION_GROUP, .help = (h) }
119#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) }
120#define OPT_BOOLEAN(s, l, v, h) { .type = OPTION_BOOLEAN, .short_name = (s), .long_name = (l), .value = check_vtype(v, bool *), .help = (h) }
121#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) }
122#define OPT_BOOLEAN_SET(s, l, v, os, h) \
123 { .type = OPTION_BOOLEAN, .short_name = (s), .long_name = (l), \
124 .value = check_vtype(v, bool *), .help = (h), \
125 .set = check_vtype(os, bool *)}
126#define OPT_INCR(s, l, v, h) { .type = OPTION_INCR, .short_name = (s), .long_name = (l), .value = check_vtype(v, int *), .help = (h) }
127#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) }
128#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) }
129#define OPT_INTEGER(s, l, v, h) { .type = OPTION_INTEGER, .short_name = (s), .long_name = (l), .value = check_vtype(v, int *), .help = (h) }
130#define OPT_UINTEGER(s, l, v, h) { .type = OPTION_UINTEGER, .short_name = (s), .long_name = (l), .value = check_vtype(v, unsigned int *), .help = (h) }
131#define OPT_LONG(s, l, v, h) { .type = OPTION_LONG, .short_name = (s), .long_name = (l), .value = check_vtype(v, long *), .help = (h) }
132#define OPT_U64(s, l, v, h) { .type = OPTION_U64, .short_name = (s), .long_name = (l), .value = check_vtype(v, u64 *), .help = (h) }
133#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) }
134#define OPT_STRING_OPTARG(s, l, v, a, h, d) \
135 { .type = OPTION_STRING, .short_name = (s), .long_name = (l), \
136 .value = check_vtype(v, const char **), (a), .help = (h), \
137 .flags = PARSE_OPT_OPTARG, .defval = (intptr_t)(d) }
138#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}
139#define OPT_DATE(s, l, v, h) \
140 { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), .argh = "time", .help = (h), .callback = parse_opt_approxidate_cb }
141#define OPT_CALLBACK(s, l, v, a, h, f) \
142 { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), (a), .help = (h), .callback = (f) }
143#define OPT_CALLBACK_NOOPT(s, l, v, a, h, f) \
144 { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), (a), .help = (h), .callback = (f), .flags = PARSE_OPT_NOARG }
145#define OPT_CALLBACK_DEFAULT(s, l, v, a, h, f, d) \
146 { .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 }
147#define OPT_CALLBACK_DEFAULT_NOOPT(s, l, v, a, h, f, d) \
148 { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l),\
149 .value = (v), (a), .help = (h), .callback = (f), .defval = (intptr_t)d,\
150 .flags = PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NOARG}
151#define OPT_CALLBACK_OPTARG(s, l, v, d, a, h, f) \
152 { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), \
153 .value = (v), (a), .help = (h), .callback = (f), \
154 .flags = PARSE_OPT_OPTARG, .data = (d) }
155
156/* parse_options() will filter out the processed options and leave the
157 * non-option argments in argv[].
158 * Returns the number of arguments left in argv[].
159 *
160 * NOTE: parse_options() and parse_options_subcommand() may call exit() in the
161 * case of an error (or for 'special' options like --list-cmds or --list-opts).
162 */
163extern int parse_options(int argc, const char **argv,
164 const struct option *options,
165 const char * const usagestr[], int flags);
166
167extern int parse_options_subcommand(int argc, const char **argv,
168 const struct option *options,
169 const char *const subcommands[],
170 const char *usagestr[], int flags);
171
172extern NORETURN void usage_with_options(const char * const *usagestr,
173 const struct option *options);
174extern NORETURN __attribute__((format(printf,3,4)))
175void usage_with_options_msg(const char * const *usagestr,
176 const struct option *options,
177 const char *fmt, ...);
178
179/*----- incremantal advanced APIs -----*/
180
181enum {
182 PARSE_OPT_HELP = -1,
183 PARSE_OPT_DONE,
184 PARSE_OPT_LIST_OPTS,
185 PARSE_OPT_LIST_SUBCMDS,
186 PARSE_OPT_UNKNOWN,
187};
188
189/*
190 * It's okay for the caller to consume argv/argc in the usual way.
191 * Other fields of that structure are private to parse-options and should not
192 * be modified in any way.
193 */
194struct parse_opt_ctx_t {
195 const char **argv;
196 const char **out;
197 int argc, cpidx;
198 const char *opt;
199 const struct option *excl_opt;
200 int flags;
201};
202
203extern int parse_options_usage(const char * const *usagestr,
204 const struct option *opts,
205 const char *optstr,
206 bool short_opt);
207
208
209/*----- some often used options -----*/
210extern int parse_opt_abbrev_cb(const struct option *, const char *, int);
211extern int parse_opt_approxidate_cb(const struct option *, const char *, int);
212extern int parse_opt_verbosity_cb(const struct option *, const char *, int);
213
214#define OPT__VERBOSE(var) OPT_BOOLEAN('v', "verbose", (var), "be verbose")
215#define OPT__QUIET(var) OPT_BOOLEAN('q', "quiet", (var), "be quiet")
216#define OPT__VERBOSITY(var) \
217 { OPTION_CALLBACK, 'v', "verbose", (var), NULL, "be more verbose", \
218 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
219 { OPTION_CALLBACK, 'q', "quiet", (var), NULL, "be more quiet", \
220 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
221#define OPT__DRY_RUN(var) OPT_BOOLEAN('n', "dry-run", (var), "dry run")
222#define OPT__ABBREV(var) \
223 { OPTION_CALLBACK, 0, "abbrev", (var), "n", \
224 "use <n> digits to display SHA-1s", \
225 PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
226
227extern const char *parse_options_fix_filename(const char *prefix, const char *file);
228
229void set_option_flag(struct option *opts, int sopt, const char *lopt, int flag);
230void set_option_nobuild(struct option *opts, int shortopt, const char *longopt,
231 const char *build_opt, bool can_skip);
232
233#endif /* __SUBCMD_PARSE_OPTIONS_H */