Merge branch 'ah/doc-submodule-ignore-submodules'
[git/git.git] / parse-options.h
CommitLineData
4a59fd13
PH
1#ifndef PARSE_OPTIONS_H
2#define PARSE_OPTIONS_H
3
4enum parse_opt_type {
db7244bd 5 /* special types */
4a59fd13 6 OPTION_END,
580d5bff 7 OPTION_ARGUMENT,
d7a38c54 8 OPTION_GROUP,
e0319ff5 9 OPTION_NUMBER,
5c387428 10 OPTION_ALIAS,
db7244bd
PH
11 /* options with no arguments */
12 OPTION_BIT,
2f4b97f9 13 OPTION_NEGBIT,
f62470c6 14 OPTION_BITOP,
b04ba2bb 15 OPTION_COUNTUP,
db7244bd 16 OPTION_SET_INT,
11588263 17 OPTION_CMDMODE,
db7244bd 18 /* options with arguments (usually) */
4a59fd13
PH
19 OPTION_STRING,
20 OPTION_INTEGER,
2a514ed8 21 OPTION_MAGNITUDE,
ffe659f9 22 OPTION_CALLBACK,
b0b3a8b6 23 OPTION_LOWLEVEL_CALLBACK,
df217ed6 24 OPTION_FILENAME
4a59fd13
PH
25};
26
27enum parse_opt_flags {
28 PARSE_OPT_KEEP_DASHDASH = 1,
a0ec9d25 29 PARSE_OPT_STOP_AT_NON_OPTION = 2,
a32a4eaa 30 PARSE_OPT_KEEP_ARGV0 = 4,
b5ce3a54 31 PARSE_OPT_KEEP_UNKNOWN = 8,
202fbb33
NTND
32 PARSE_OPT_NO_INTERNAL_HELP = 16,
33 PARSE_OPT_ONE_SHOT = 32
4a59fd13
PH
34};
35
ffe659f9
PH
36enum parse_opt_option_flags {
37 PARSE_OPT_OPTARG = 1,
f481e22a 38 PARSE_OPT_NOARG = 2,
db7244bd 39 PARSE_OPT_NONEG = 4,
dd3bf0f4 40 PARSE_OPT_HIDDEN = 8,
1cc6985c 41 PARSE_OPT_LASTARG_DEFAULT = 16,
51a9949e 42 PARSE_OPT_NODASH = 32,
29f25d49 43 PARSE_OPT_LITERAL_ARGHELP = 64,
b9d7f4b4 44 PARSE_OPT_SHELL_EVAL = 256,
ebc4a04e
NTND
45 PARSE_OPT_NOCOMPLETE = 512,
46 PARSE_OPT_COMP_ARG = 1024
ffe659f9
PH
47};
48
19800bdc
RS
49enum parse_opt_result {
50 PARSE_OPT_COMPLETE = -3,
51 PARSE_OPT_HELP = -2,
52 PARSE_OPT_ERROR = -1, /* must be the same as error() */
53 PARSE_OPT_DONE = 0, /* fixed so that "return 0" works */
54 PARSE_OPT_NON_OPTION,
55 PARSE_OPT_UNKNOWN
56};
57
ffe659f9
PH
58struct option;
59typedef int parse_opt_cb(const struct option *, const char *arg, int unset);
60
b0b3a8b6 61struct parse_opt_ctx_t;
f41179f1 62typedef enum parse_opt_result parse_opt_ll_cb(struct parse_opt_ctx_t *ctx,
3ebbe289
NTND
63 const struct option *opt,
64 const char *arg, int unset);
b0b3a8b6 65
9b3beb58
PH
66/*
67 * `type`::
68 * holds the type of the option, you must have an OPTION_END last in your
69 * array.
70 *
71 * `short_name`::
72 * the character to use as a short option name, '\0' if none.
73 *
74 * `long_name`::
75 * the long option name, without the leading dashes, NULL if none.
76 *
77 * `value`::
78 * stores pointers to the values to be filled.
79 *
80 * `argh`::
81 * token to explain the kind of argument this option wants. Keep it
54e6dc7d
NTND
82 * homogeneous across the repository. Should be wrapped by N_() for
83 * translation.
9b3beb58
PH
84 *
85 * `help`::
86 * the short help associated to what the option does.
87 * Must never be NULL (except for OPTION_END).
88 * OPTION_GROUP uses this pointer to store the group header.
54e6dc7d 89 * Should be wrapped by N_() for translation.
9b3beb58
PH
90 *
91 * `flags`::
92 * mask of parse_opt_option_flags.
3ea3c215 93 * PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs)
ef45e4da 94 * PARSE_OPT_NOARG: says that this option does not take an argument
db7244bd 95 * PARSE_OPT_NONEG: says that this option cannot be negated
51a9949e
RS
96 * PARSE_OPT_HIDDEN: this option is skipped in the default usage, and
97 * shown only in the full usage.
e169b974
SB
98 * PARSE_OPT_LASTARG_DEFAULT: says that this option will take the default
99 * value if no argument is given when the option
100 * is last on the command line. If the option is
101 * not last it will require an argument.
102 * Should not be used with PARSE_OPT_OPTARG.
51a9949e 103 * PARSE_OPT_NODASH: this option doesn't start with a dash.
29f25d49
SB
104 * PARSE_OPT_LITERAL_ARGHELP: says that argh shouldn't be enclosed in brackets
105 * (i.e. '<argh>') in the help message.
106 * Useful for options with multiple parameters.
b9d7f4b4
NTND
107 * PARSE_OPT_NOCOMPLETE: by default all visible options are completable
108 * by git-completion.bash. This option suppresses that.
ebc4a04e
NTND
109 * PARSE_OPT_COMP_ARG: this option forces to git-completion.bash to
110 * complete an option as --name= not --name even if
111 * the option takes optional argument.
9b3beb58
PH
112 *
113 * `callback`::
bf3ff338 114 * pointer to the callback to use for OPTION_CALLBACK
9b3beb58
PH
115 *
116 * `defval`::
117 * default value to fill (*->value) with for PARSE_OPT_OPTARG.
d3c08114 118 * OPTION_{BIT,SET_INT} store the {mask,integer} to put in the value when met.
9b3beb58 119 * CALLBACKS can use it like they want.
bf3ff338
NTND
120 *
121 * `ll_callback`::
122 * pointer to the callback to use for OPTION_LOWLEVEL_CALLBACK
123 *
9b3beb58 124 */
4a59fd13
PH
125struct option {
126 enum parse_opt_type type;
127 int short_name;
128 const char *long_name;
129 void *value;
d7a38c54
PH
130 const char *argh;
131 const char *help;
ffe659f9
PH
132
133 int flags;
134 parse_opt_cb *callback;
ffe659f9 135 intptr_t defval;
bf3ff338 136 parse_opt_ll_cb *ll_callback;
f62470c6 137 intptr_t extra;
4a59fd13
PH
138};
139
2de37349
NTND
140#define OPT_BIT_F(s, l, v, h, b, f) { OPTION_BIT, (s), (l), (v), NULL, (h), \
141 PARSE_OPT_NOARG|(f), NULL, (b) }
142#define OPT_COUNTUP_F(s, l, v, h, f) { OPTION_COUNTUP, (s), (l), (v), NULL, \
143 (h), PARSE_OPT_NOARG|(f) }
144#define OPT_SET_INT_F(s, l, v, h, i, f) { OPTION_SET_INT, (s), (l), (v), NULL, \
145 (h), PARSE_OPT_NOARG | (f), NULL, (i) }
146#define OPT_BOOL_F(s, l, v, h, f) OPT_SET_INT_F(s, l, v, h, 1, f)
d473e2e0
NTND
147#define OPT_CALLBACK_F(s, l, v, a, h, f, cb) \
148 { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), (cb) }
31fba9d3 149#define OPT_STRING_F(s, l, v, a, h, f) { OPTION_STRING, (s), (l), (v), (a), (h), (f) }
16ed6c97 150#define OPT_INTEGER_F(s, l, v, h, f) { OPTION_INTEGER, (s), (l), (v), N_("n"), (h), (f) }
2de37349 151
4a59fd13 152#define OPT_END() { OPTION_END }
1a85b49b
JS
153#define OPT_ARGUMENT(l, v, h) { OPTION_ARGUMENT, 0, (l), (v), NULL, \
154 (h), PARSE_OPT_NOARG, NULL, 1 }
d7a38c54 155#define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
2de37349 156#define OPT_BIT(s, l, v, h, b) OPT_BIT_F(s, l, v, h, b, 0)
f62470c6
NTND
157#define OPT_BITOP(s, l, v, h, set, clear) { OPTION_BITOP, (s), (l), (v), NULL, (h), \
158 PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, \
bf3ff338 159 (set), NULL, (clear) }
34aec9f5
SB
160#define OPT_NEGBIT(s, l, v, h, b) { OPTION_NEGBIT, (s), (l), (v), NULL, \
161 (h), PARSE_OPT_NOARG, NULL, (b) }
2de37349
NTND
162#define OPT_COUNTUP(s, l, v, h) OPT_COUNTUP_F(s, l, v, h, 0)
163#define OPT_SET_INT(s, l, v, h, i) OPT_SET_INT_F(s, l, v, h, i, 0)
164#define OPT_BOOL(s, l, v, h) OPT_BOOL_F(s, l, v, h, 0)
4741edd5
SB
165#define OPT_HIDDEN_BOOL(s, l, v, h) { OPTION_SET_INT, (s), (l), (v), NULL, \
166 (h), PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, 1}
14691e38 167#define OPT_CMDMODE(s, l, v, h, i) { OPTION_CMDMODE, (s), (l), (v), NULL, \
11588263 168 (h), PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, (i) }
16ed6c97 169#define OPT_INTEGER(s, l, v, h) OPT_INTEGER_F(s, l, v, h, 0)
2a514ed8
CB
170#define OPT_MAGNITUDE(s, l, v, h) { OPTION_MAGNITUDE, (s), (l), (v), \
171 N_("n"), (h), PARSE_OPT_NONEG }
31fba9d3 172#define OPT_STRING(s, l, v, a, h) OPT_STRING_F(s, l, v, a, h, 0)
c8ba1639
JK
173#define OPT_STRING_LIST(s, l, v, a, h) \
174 { OPTION_CALLBACK, (s), (l), (v), (a), \
175 (h), 0, &parse_opt_string_list }
b475e442
NTND
176#define OPT_UYN(s, l, v, h) { OPTION_CALLBACK, (s), (l), (v), NULL, \
177 (h), PARSE_OPT_NOARG, &parse_opt_tertiary }
27ec394a 178#define OPT_EXPIRY_DATE(s, l, v, h) \
e703d711 179 { OPTION_CALLBACK, (s), (l), (v), N_("expiry-date"),(h), 0, \
27ec394a 180 parse_opt_expiry_date_cb }
d473e2e0 181#define OPT_CALLBACK(s, l, v, a, h, f) OPT_CALLBACK_F(s, l, v, a, h, 0, f)
e0319ff5
RS
182#define OPT_NUMBER_CALLBACK(v, h, f) \
183 { OPTION_NUMBER, 0, NULL, (v), NULL, (h), \
184 PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) }
df217ed6 185#define OPT_FILENAME(s, l, v, h) { OPTION_FILENAME, (s), (l), (v), \
54e6dc7d 186 N_("file"), (h) }
73e9da01 187#define OPT_COLOR_FLAG(s, l, v, h) \
54e6dc7d 188 { OPTION_CALLBACK, (s), (l), (v), N_("when"), (h), PARSE_OPT_OPTARG, \
73e9da01
ML
189 parse_opt_color_flag_cb, (intptr_t)"always" }
190
6acec038
RS
191#define OPT_NOOP_NOARG(s, l) \
192 { OPTION_CALLBACK, (s), (l), NULL, NULL, \
54e6dc7d 193 N_("no-op (backward compatibility)"), \
6acec038
RS
194 PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, parse_opt_noop_cb }
195
5c387428
NTND
196#define OPT_ALIAS(s, l, source_long_name) \
197 { OPTION_ALIAS, (s), (l), (source_long_name) }
198
202fbb33
NTND
199/*
200 * parse_options() will filter out the processed options and leave the
201 * non-option arguments in argv[]. argv0 is assumed program name and
202 * skipped.
203 *
204 * usagestr strings should be marked for translation with N_().
205 *
4a59fd13 206 * Returns the number of arguments left in argv[].
202fbb33
NTND
207 *
208 * In one-shot mode, argv0 is not a program name, argv[] is left
209 * untouched and parse_options() returns the number of options
210 * processed.
4a59fd13 211 */
1987b0b2
NTND
212int parse_options(int argc, const char **argv, const char *prefix,
213 const struct option *options,
214 const char * const usagestr[], int flags);
d7a38c54 215
1987b0b2
NTND
216NORETURN void usage_with_options(const char * const *usagestr,
217 const struct option *options);
4a59fd13 218
1987b0b2
NTND
219NORETURN void usage_msg_opt(const char *msg,
220 const char * const *usagestr,
221 const struct option *options);
451bb210 222
1987b0b2 223int optbug(const struct option *opt, const char *reason);
9440b831 224const char *optname(const struct option *opt, int flags);
a469a101 225
517fe807
JK
226/*
227 * Use these assertions for callbacks that expect to be called with NONEG and
228 * NOARG respectively, and do not otherwise handle the "unset" and "arg"
229 * parameters.
230 */
231#define BUG_ON_OPT_NEG(unset) do { \
232 if ((unset)) \
233 BUG("option callback does not expect negation"); \
234} while (0)
235#define BUG_ON_OPT_ARG(arg) do { \
236 if ((arg)) \
237 BUG("option callback does not expect an argument"); \
238} while (0)
239
cbdeab98
BR
240/*
241 * Similar to the assertions above, but checks that "arg" is always non-NULL.
242 * This assertion also implies BUG_ON_OPT_NEG(), letting you declare both
243 * assertions in a single line.
244 */
245#define BUG_ON_OPT_NEG_NOARG(unset, arg) do { \
246 BUG_ON_OPT_NEG(unset); \
247 if(!(arg)) \
248 BUG("option callback expects an argument"); \
249} while(0)
250
3ea3c215 251/*----- incremental advanced APIs -----*/
7e7bbcb4 252
26141b5b
PH
253/*
254 * It's okay for the caller to consume argv/argc in the usual way.
255 * Other fields of that structure are private to parse-options and should not
256 * be modified in any way.
257 */
7e7bbcb4
PH
258struct parse_opt_ctx_t {
259 const char **argv;
260 const char **out;
5ad0d3d5 261 int argc, cpidx, total;
7e7bbcb4
PH
262 const char *opt;
263 int flags;
37782920 264 const char *prefix;
5c387428
NTND
265 const char **alias_groups; /* must be in groups of 3 elements! */
266 struct option *updated_options;
7e7bbcb4
PH
267};
268
1987b0b2
NTND
269void parse_options_start(struct parse_opt_ctx_t *ctx,
270 int argc, const char **argv, const char *prefix,
271 const struct option *options, int flags);
7e7bbcb4 272
1987b0b2
NTND
273int parse_options_step(struct parse_opt_ctx_t *ctx,
274 const struct option *options,
275 const char * const usagestr[]);
ff43ec3e 276
1987b0b2 277int parse_options_end(struct parse_opt_ctx_t *ctx);
7e7bbcb4 278
20871822 279struct option *parse_options_dup(const struct option *a);
1987b0b2 280struct option *parse_options_concat(struct option *a, struct option *b);
7e7bbcb4 281
0ce865b1 282/*----- some often used options -----*/
1987b0b2
NTND
283int parse_opt_abbrev_cb(const struct option *, const char *, int);
284int parse_opt_expiry_date_cb(const struct option *, const char *, int);
285int parse_opt_color_flag_cb(const struct option *, const char *, int);
286int parse_opt_verbosity_cb(const struct option *, const char *, int);
33898531 287/* value is struct oid_array* */
1987b0b2 288int parse_opt_object_name(const struct option *, const char *, int);
33898531
PW
289/* value is struct object_id* */
290int parse_opt_object_id(const struct option *, const char *, int);
1987b0b2 291int parse_opt_commits(const struct option *, const char *, int);
7d3488eb 292int parse_opt_commit(const struct option *, const char *, int);
1987b0b2
NTND
293int parse_opt_tertiary(const struct option *, const char *, int);
294int parse_opt_string_list(const struct option *, const char *, int);
295int parse_opt_noop_cb(const struct option *, const char *, int);
567fce1e
JS
296enum parse_opt_result parse_opt_unknown_cb(struct parse_opt_ctx_t *ctx,
297 const struct option *,
298 const char *, int);
1987b0b2
NTND
299int parse_opt_passthru(const struct option *, const char *, int);
300int parse_opt_passthru_argv(const struct option *, const char *, int);
0ce865b1 301
212c0a6f
NTND
302#define OPT__VERBOSE(var, h) OPT_COUNTUP('v', "verbose", (var), (h))
303#define OPT__QUIET(var, h) OPT_COUNTUP('q', "quiet", (var), (h))
7f87aff2 304#define OPT__VERBOSITY(var) \
54e6dc7d 305 { OPTION_CALLBACK, 'v', "verbose", (var), NULL, N_("be more verbose"), \
7f87aff2 306 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
54e6dc7d 307 { OPTION_CALLBACK, 'q', "quiet", (var), NULL, N_("be more quiet"), \
7f87aff2 308 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
212c0a6f 309#define OPT__DRY_RUN(var, h) OPT_BOOL('n', "dry-run", (var), (h))
1224781d 310#define OPT__FORCE(var, h, f) OPT_COUNTUP_F('f', "force", (var), (h), (f))
0ce865b1 311#define OPT__ABBREV(var) \
54e6dc7d
NTND
312 { OPTION_CALLBACK, 0, "abbrev", (var), N_("n"), \
313 N_("use <n> digits to display SHA-1s"), \
0ce865b1 314 PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
73e9da01
ML
315#define OPT__COLOR(var, h) \
316 OPT_COLOR_FLAG(0, "color", (var), (h))
7e29b825 317#define OPT_COLUMN(s, l, v, h) \
a054e049 318 { OPTION_CALLBACK, (s), (l), (v), N_("style"), (h), PARSE_OPT_OPTARG, parseopt_column_callback }
6b3ee18d
PT
319#define OPT_PASSTHRU(s, l, v, a, h, f) \
320 { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru }
ffad85c5
PT
321#define OPT_PASSTHRU_ARGV(s, l, v, a, h, f) \
322 { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru_argv }
f266c916
KN
323#define _OPT_CONTAINS_OR_WITH(name, variable, help, flag) \
324 { OPTION_CALLBACK, 0, name, (variable), N_("commit"), (help), \
325 PARSE_OPT_LASTARG_DEFAULT | flag, \
326 parse_opt_commits, (intptr_t) "HEAD" \
327 }
eab98ee5 328#define OPT_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("contains", v, h, PARSE_OPT_NONEG)
ac3f5a34 329#define OPT_NO_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("no-contains", v, h, PARSE_OPT_NONEG)
eab98ee5 330#define OPT_WITH(v, h) _OPT_CONTAINS_OR_WITH("with", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
ac3f5a34 331#define OPT_WITHOUT(v, h) _OPT_CONTAINS_OR_WITH("without", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
ca04dc96 332#define OPT_CLEANUP(v) OPT_STRING(0, "cleanup", v, N_("mode"), N_("how to strip spaces and #comments from message"))
0ce865b1 333
4a59fd13 334#endif