1#ifndef PARSE_OPTIONS_H
2#define PARSE_OPTIONS_H
3enum parse_opt_type {
5 /* special types */
6 OPTION_END,
7 OPTION_ARGUMENT,
8 OPTION_GROUP,
9 OPTION_NUMBER,
10 /* options with no arguments */
11 OPTION_BIT,
12 OPTION_NEGBIT,
13 OPTION_BITOP,
14 OPTION_COUNTUP,
15 OPTION_SET_INT,
16 OPTION_CMDMODE,
17 /* options with arguments (usually) */
18 OPTION_STRING,
19 OPTION_INTEGER,
20 OPTION_MAGNITUDE,
21 OPTION_CALLBACK,
22 OPTION_LOWLEVEL_CALLBACK,
23 OPTION_FILENAME
24};
25enum parse_opt_flags {
27 PARSE_OPT_KEEP_DASHDASH = 1,
28 PARSE_OPT_STOP_AT_NON_OPTION = 2,
29 PARSE_OPT_KEEP_ARGV0 = 4,
30 PARSE_OPT_KEEP_UNKNOWN = 8,
31 PARSE_OPT_NO_INTERNAL_HELP = 16,
32 PARSE_OPT_ONE_SHOT = 32
33};
34enum parse_opt_option_flags {
36 PARSE_OPT_OPTARG = 1,
37 PARSE_OPT_NOARG = 2,
38 PARSE_OPT_NONEG = 4,
39 PARSE_OPT_HIDDEN = 8,
40 PARSE_OPT_LASTARG_DEFAULT = 16,
41 PARSE_OPT_NODASH = 32,
42 PARSE_OPT_LITERAL_ARGHELP = 64,
43 PARSE_OPT_SHELL_EVAL = 256,
44 PARSE_OPT_NOCOMPLETE = 512,
45 PARSE_OPT_COMP_ARG = 1024
46};
47struct option;
49typedef int parse_opt_cb(const struct option *, const char *arg, int unset);
50struct parse_opt_ctx_t;
52typedef int parse_opt_ll_cb(struct parse_opt_ctx_t *ctx,
53 const struct option *opt, int unset);
54/*
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 * homogeneous across the repository. Should be wrapped by N_() for
72 * translation.
73 *
74 * `help`::
75 * the short help associated to what the option does.
76 * Must never be NULL (except for OPTION_END).
77 * OPTION_GROUP uses this pointer to store the group header.
78 * Should be wrapped by N_() for translation.
79 *
80 * `flags`::
81 * mask of parse_opt_option_flags.
82 * PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs)
83 * PARSE_OPT_NOARG: says that this option does not take an argument
84 * PARSE_OPT_NONEG: says that this option cannot be negated
85 * PARSE_OPT_HIDDEN: this option is skipped in the default usage, and
86 * shown only in the full usage.
87 * PARSE_OPT_LASTARG_DEFAULT: says that this option will take the default
88 * value if no argument is given when the option
89 * is last on the command line. If the option is
90 * not last it will require an argument.
91 * Should not be used with PARSE_OPT_OPTARG.
92 * PARSE_OPT_NODASH: this option doesn't start with a dash.
93 * PARSE_OPT_LITERAL_ARGHELP: says that argh shouldn't be enclosed in brackets
94 * (i.e. '<argh>') in the help message.
95 * Useful for options with multiple parameters.
96 * PARSE_OPT_NOCOMPLETE: by default all visible options are completable
97 * by git-completion.bash. This option suppresses that.
98 * PARSE_OPT_COMP_ARG: this option forces to git-completion.bash to
99 * complete an option as --name= not --name even if
100 * the option takes optional argument.
101 *
102 * `callback`::
103 * pointer to the callback to use for OPTION_CALLBACK or
104 * OPTION_LOWLEVEL_CALLBACK.
105 *
106 * `defval`::
107 * default value to fill (*->value) with for PARSE_OPT_OPTARG.
108 * OPTION_{BIT,SET_INT} store the {mask,integer} to put in the value when met.
109 * CALLBACKS can use it like they want.
110 */
111struct option {
112 enum parse_opt_type type;
113 int short_name;
114 const char *long_name;
115 void *value;
116 const char *argh;
117 const char *help;
118 int flags;
120 parse_opt_cb *callback;
121 intptr_t defval;
122 intptr_t extra;
123};
124#define OPT_BIT_F(s, l, v, h, b, f) { OPTION_BIT, (s), (l), (v), NULL, (h), \
126 PARSE_OPT_NOARG|(f), NULL, (b) }
127#define OPT_COUNTUP_F(s, l, v, h, f) { OPTION_COUNTUP, (s), (l), (v), NULL, \
128 (h), PARSE_OPT_NOARG|(f) }
129#define OPT_SET_INT_F(s, l, v, h, i, f) { OPTION_SET_INT, (s), (l), (v), NULL, \
130 (h), PARSE_OPT_NOARG | (f), NULL, (i) }
131#define OPT_BOOL_F(s, l, v, h, f) OPT_SET_INT_F(s, l, v, h, 1, f)
132#define OPT_END() { OPTION_END }
134#define OPT_ARGUMENT(l, h) { OPTION_ARGUMENT, 0, (l), NULL, NULL, \
135 (h), PARSE_OPT_NOARG}
136#define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
137#define OPT_BIT(s, l, v, h, b) OPT_BIT_F(s, l, v, h, b, 0)
138#define OPT_BITOP(s, l, v, h, set, clear) { OPTION_BITOP, (s), (l), (v), NULL, (h), \
139 PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, \
140 (set), (clear) }
141#define OPT_NEGBIT(s, l, v, h, b) { OPTION_NEGBIT, (s), (l), (v), NULL, \
142 (h), PARSE_OPT_NOARG, NULL, (b) }
143#define OPT_COUNTUP(s, l, v, h) OPT_COUNTUP_F(s, l, v, h, 0)
144#define OPT_SET_INT(s, l, v, h, i) OPT_SET_INT_F(s, l, v, h, i, 0)
145#define OPT_BOOL(s, l, v, h) OPT_BOOL_F(s, l, v, h, 0)
146#define OPT_HIDDEN_BOOL(s, l, v, h) { OPTION_SET_INT, (s), (l), (v), NULL, \
147 (h), PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, 1}
148#define OPT_CMDMODE(s, l, v, h, i) { OPTION_CMDMODE, (s), (l), (v), NULL, \
149 (h), PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, (i) }
150#define OPT_INTEGER(s, l, v, h) { OPTION_INTEGER, (s), (l), (v), N_("n"), (h) }
151#define OPT_MAGNITUDE(s, l, v, h) { OPTION_MAGNITUDE, (s), (l), (v), \
152 N_("n"), (h), PARSE_OPT_NONEG }
153#define OPT_STRING(s, l, v, a, h) { OPTION_STRING, (s), (l), (v), (a), (h) }
154#define OPT_STRING_LIST(s, l, v, a, h) \
155 { OPTION_CALLBACK, (s), (l), (v), (a), \
156 (h), 0, &parse_opt_string_list }
157#define OPT_UYN(s, l, v, h) { OPTION_CALLBACK, (s), (l), (v), NULL, \
158 (h), PARSE_OPT_NOARG, &parse_opt_tertiary }
159#define OPT_EXPIRY_DATE(s, l, v, h) \
160 { OPTION_CALLBACK, (s), (l), (v), N_("expiry-date"),(h), 0, \
161 parse_opt_expiry_date_cb }
162#define OPT_CALLBACK(s, l, v, a, h, f) \
163 { OPTION_CALLBACK, (s), (l), (v), (a), (h), 0, (f) }
164#define OPT_NUMBER_CALLBACK(v, h, f) \
165 { OPTION_NUMBER, 0, NULL, (v), NULL, (h), \
166 PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) }
167#define OPT_FILENAME(s, l, v, h) { OPTION_FILENAME, (s), (l), (v), \
168 N_("file"), (h) }
169#define OPT_COLOR_FLAG(s, l, v, h) \
170 { OPTION_CALLBACK, (s), (l), (v), N_("when"), (h), PARSE_OPT_OPTARG, \
171 parse_opt_color_flag_cb, (intptr_t)"always" }
172#define OPT_NOOP_NOARG(s, l) \
174 { OPTION_CALLBACK, (s), (l), NULL, NULL, \
175 N_("no-op (backward compatibility)"), \
176 PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, parse_opt_noop_cb }
177/*
179 * parse_options() will filter out the processed options and leave the
180 * non-option arguments in argv[]. argv0 is assumed program name and
181 * skipped.
182 *
183 * usagestr strings should be marked for translation with N_().
184 *
185 * Returns the number of arguments left in argv[].
186 *
187 * In one-shot mode, argv0 is not a program name, argv[] is left
188 * untouched and parse_options() returns the number of options
189 * processed.
190 */
191int parse_options(int argc, const char **argv, const char *prefix,
192 const struct option *options,
193 const char * const usagestr[], int flags);
194NORETURN void usage_with_options(const char * const *usagestr,
196 const struct option *options);
197NORETURN void usage_msg_opt(const char *msg,
199 const char * const *usagestr,
200 const struct option *options);
201int optbug(const struct option *opt, const char *reason);
203const char *optname(const struct option *opt, int flags);
204/*
206 * Use these assertions for callbacks that expect to be called with NONEG and
207 * NOARG respectively, and do not otherwise handle the "unset" and "arg"
208 * parameters.
209 */
210#define BUG_ON_OPT_NEG(unset) do { \
211 if ((unset)) \
212 BUG("option callback does not expect negation"); \
213} while (0)
214#define BUG_ON_OPT_ARG(arg) do { \
215 if ((arg)) \
216 BUG("option callback does not expect an argument"); \
217} while (0)
218/*----- incremental advanced APIs -----*/
220enum {
222 PARSE_OPT_COMPLETE = -2,
223 PARSE_OPT_HELP = -1,
224 PARSE_OPT_DONE,
225 PARSE_OPT_NON_OPTION,
226 PARSE_OPT_ERROR,
227 PARSE_OPT_UNKNOWN
228};
229/*
231 * It's okay for the caller to consume argv/argc in the usual way.
232 * Other fields of that structure are private to parse-options and should not
233 * be modified in any way.
234 */
235struct parse_opt_ctx_t {
236 const char **argv;
237 const char **out;
238 int argc, cpidx, total;
239 const char *opt;
240 int flags;
241 const char *prefix;
242};
243void parse_options_start(struct parse_opt_ctx_t *ctx,
245 int argc, const char **argv, const char *prefix,
246 const struct option *options, int flags);
247int parse_options_step(struct parse_opt_ctx_t *ctx,
249 const struct option *options,
250 const char * const usagestr[]);
251int parse_options_end(struct parse_opt_ctx_t *ctx);
253struct option *parse_options_concat(struct option *a, struct option *b);
255/*----- some often used options -----*/
257int parse_opt_abbrev_cb(const struct option *, const char *, int);
258int parse_opt_expiry_date_cb(const struct option *, const char *, int);
259int parse_opt_color_flag_cb(const struct option *, const char *, int);
260int parse_opt_verbosity_cb(const struct option *, const char *, int);
261int parse_opt_object_name(const struct option *, const char *, int);
262int parse_opt_commits(const struct option *, const char *, int);
263int parse_opt_tertiary(const struct option *, const char *, int);
264int parse_opt_string_list(const struct option *, const char *, int);
265int parse_opt_noop_cb(const struct option *, const char *, int);
266int parse_opt_unknown_cb(const struct option *, const char *, int);
267int parse_opt_passthru(const struct option *, const char *, int);
268int parse_opt_passthru_argv(const struct option *, const char *, int);
269#define OPT__VERBOSE(var, h) OPT_COUNTUP('v', "verbose", (var), (h))
271#define OPT__QUIET(var, h) OPT_COUNTUP('q', "quiet", (var), (h))
272#define OPT__VERBOSITY(var) \
273 { OPTION_CALLBACK, 'v', "verbose", (var), NULL, N_("be more verbose"), \
274 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
275 { OPTION_CALLBACK, 'q', "quiet", (var), NULL, N_("be more quiet"), \
276 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
277#define OPT__DRY_RUN(var, h) OPT_BOOL('n', "dry-run", (var), (h))
278#define OPT__FORCE(var, h, f) OPT_COUNTUP_F('f', "force", (var), (h), (f))
279#define OPT__ABBREV(var) \
280 { OPTION_CALLBACK, 0, "abbrev", (var), N_("n"), \
281 N_("use <n> digits to display SHA-1s"), \
282 PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
283#define OPT__COLOR(var, h) \
284 OPT_COLOR_FLAG(0, "color", (var), (h))
285#define OPT_COLUMN(s, l, v, h) \
286 { OPTION_CALLBACK, (s), (l), (v), N_("style"), (h), PARSE_OPT_OPTARG, parseopt_column_callback }
287#define OPT_PASSTHRU(s, l, v, a, h, f) \
288 { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru }
289#define OPT_PASSTHRU_ARGV(s, l, v, a, h, f) \
290 { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru_argv }
291#define _OPT_CONTAINS_OR_WITH(name, variable, help, flag) \
292 { OPTION_CALLBACK, 0, name, (variable), N_("commit"), (help), \
293 PARSE_OPT_LASTARG_DEFAULT | flag, \
294 parse_opt_commits, (intptr_t) "HEAD" \
295 }
296#define OPT_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("contains", v, h, PARSE_OPT_NONEG)
297#define OPT_NO_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("no-contains", v, h, PARSE_OPT_NONEG)
298#define OPT_WITH(v, h) _OPT_CONTAINS_OR_WITH("with", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
299#define OPT_WITHOUT(v, h) _OPT_CONTAINS_OR_WITH("without", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
300#endif