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