1 #ifndef __SUBCMD_PARSE_OPTIONS_H
2 #define __SUBCMD_PARSE_OPTIONS_H
8 #define NORETURN __attribute__((__noreturn__))
16 /* options with no arguments */
22 /* options with arguments (usually) */
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,
39 enum parse_opt_option_flags {
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,
53 typedef int parse_opt_cb(const struct option *, const char *arg, int unset);
57 * holds the type of the option, you must have an OPTION_END last in your
61 * the character to use as a short option name, '\0' if none.
64 * the long option name, without the leading dashes, NULL if none.
67 * stores pointers to the values to be filled.
70 * token to explain the kind of argument this option wants. Keep it
71 * homogenous across the repository.
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.
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
87 * pointer to the callback to use for OPTION_CALLBACK.
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
93 * CALLBACKS can use it like they want.
96 * whether an option was set by the user
99 enum parse_opt_type type;
101 const char *long_name;
105 const char *build_opt;
108 parse_opt_cb *callback;
114 #define check_vtype(v, type) ( BUILD_BUG_ON_ZERO(!__builtin_types_compatible_p(typeof(v), type)) + v )
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) }
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[].
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).
163 extern int parse_options(int argc, const char **argv,
164 const struct option *options,
165 const char * const usagestr[], int flags);
167 extern 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);
172 extern NORETURN void usage_with_options(const char * const *usagestr,
173 const struct option *options);
174 extern NORETURN __attribute__((format(printf,3,4)))
175 void usage_with_options_msg(const char * const *usagestr,
176 const struct option *options,
177 const char *fmt, ...);
179 /*----- incremantal advanced APIs -----*/
185 PARSE_OPT_LIST_SUBCMDS,
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.
194 struct parse_opt_ctx_t {
199 const struct option *excl_opt;
203 extern int parse_options_usage(const char * const *usagestr,
204 const struct option *opts,
209 /*----- some often used options -----*/
210 extern int parse_opt_abbrev_cb(const struct option *, const char *, int);
211 extern int parse_opt_approxidate_cb(const struct option *, const char *, int);
212 extern int parse_opt_verbosity_cb(const struct option *, const char *, int);
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 }
227 extern const char *parse_options_fix_filename(const char *prefix, const char *file);
229 void set_option_flag(struct option *opts, int sopt, const char *lopt, int flag);
230 void set_option_nobuild(struct option *opts, int shortopt, const char *longopt,
231 const char *build_opt, bool can_skip);
233 #endif /* __SUBCMD_PARSE_OPTIONS_H */