archive.c: use OPT_BOOL()
[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,
db7244bd
PH
10 /* options with no arguments */
11 OPTION_BIT,
2f4b97f9 12 OPTION_NEGBIT,
b04ba2bb 13 OPTION_COUNTUP,
db7244bd
PH
14 OPTION_SET_INT,
15 OPTION_SET_PTR,
16 /* options with arguments (usually) */
4a59fd13
PH
17 OPTION_STRING,
18 OPTION_INTEGER,
ffe659f9 19 OPTION_CALLBACK,
b0b3a8b6 20 OPTION_LOWLEVEL_CALLBACK,
df217ed6 21 OPTION_FILENAME
4a59fd13
PH
22};
23
b04ba2bb
JH
24/* Deprecated synonym */
25#define OPTION_BOOLEAN OPTION_COUNTUP
26
4a59fd13
PH
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,
4b05548f 32 PARSE_OPT_NO_INTERNAL_HELP = 16
4a59fd13
PH
33};
34
ffe659f9
PH
35enum parse_opt_option_flags {
36 PARSE_OPT_OPTARG = 1,
f481e22a 37 PARSE_OPT_NOARG = 2,
db7244bd 38 PARSE_OPT_NONEG = 4,
dd3bf0f4 39 PARSE_OPT_HIDDEN = 8,
1cc6985c 40 PARSE_OPT_LASTARG_DEFAULT = 16,
51a9949e 41 PARSE_OPT_NODASH = 32,
29f25d49 42 PARSE_OPT_LITERAL_ARGHELP = 64,
86b5efb2 43 PARSE_OPT_NEGHELP = 128,
47e9cd28 44 PARSE_OPT_SHELL_EVAL = 256
ffe659f9
PH
45};
46
47struct option;
48typedef int parse_opt_cb(const struct option *, const char *arg, int unset);
49
b0b3a8b6
JN
50struct parse_opt_ctx_t;
51typedef int parse_opt_ll_cb(struct parse_opt_ctx_t *ctx,
52 const struct option *opt, int unset);
53
9b3beb58
PH
54/*
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
3ea3c215 70 * homogeneous across the repository.
9b3beb58
PH
71 *
72 * `help`::
73 * the short help associated to what the option does.
74 * Must never be NULL (except for OPTION_END).
75 * OPTION_GROUP uses this pointer to store the group header.
76 *
77 * `flags`::
78 * mask of parse_opt_option_flags.
3ea3c215 79 * PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs)
ef45e4da 80 * PARSE_OPT_NOARG: says that this option does not take an argument
db7244bd 81 * PARSE_OPT_NONEG: says that this option cannot be negated
51a9949e
RS
82 * PARSE_OPT_HIDDEN: this option is skipped in the default usage, and
83 * shown only in the full usage.
e169b974
SB
84 * PARSE_OPT_LASTARG_DEFAULT: says that this option will take the default
85 * value if no argument is given when the option
86 * is last on the command line. If the option is
87 * not last it will require an argument.
88 * Should not be used with PARSE_OPT_OPTARG.
51a9949e 89 * PARSE_OPT_NODASH: this option doesn't start with a dash.
29f25d49
SB
90 * PARSE_OPT_LITERAL_ARGHELP: says that argh shouldn't be enclosed in brackets
91 * (i.e. '<argh>') in the help message.
92 * Useful for options with multiple parameters.
86b5efb2
JS
93 * PARSE_OPT_NEGHELP: says that the long option should always be shown with
94 * the --no prefix in the usage message. Sometimes
95 * useful for users of OPTION_NEGBIT.
9b3beb58
PH
96 *
97 * `callback`::
b0b3a8b6
JN
98 * pointer to the callback to use for OPTION_CALLBACK or
99 * OPTION_LOWLEVEL_CALLBACK.
9b3beb58
PH
100 *
101 * `defval`::
102 * default value to fill (*->value) with for PARSE_OPT_OPTARG.
db7244bd
PH
103 * OPTION_{BIT,SET_INT,SET_PTR} store the {mask,integer,pointer} to put in
104 * the value when met.
9b3beb58
PH
105 * CALLBACKS can use it like they want.
106 */
4a59fd13
PH
107struct option {
108 enum parse_opt_type type;
109 int short_name;
110 const char *long_name;
111 void *value;
d7a38c54
PH
112 const char *argh;
113 const char *help;
ffe659f9
PH
114
115 int flags;
116 parse_opt_cb *callback;
ffe659f9 117 intptr_t defval;
4a59fd13
PH
118};
119
120#define OPT_END() { OPTION_END }
34aec9f5
SB
121#define OPT_ARGUMENT(l, h) { OPTION_ARGUMENT, 0, (l), NULL, NULL, \
122 (h), PARSE_OPT_NOARG}
d7a38c54 123#define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
34aec9f5
SB
124#define OPT_BIT(s, l, v, h, b) { OPTION_BIT, (s), (l), (v), NULL, (h), \
125 PARSE_OPT_NOARG, NULL, (b) }
126#define OPT_NEGBIT(s, l, v, h, b) { OPTION_NEGBIT, (s), (l), (v), NULL, \
127 (h), PARSE_OPT_NOARG, NULL, (b) }
b04ba2bb 128#define OPT_COUNTUP(s, l, v, h) { OPTION_COUNTUP, (s), (l), (v), NULL, \
34aec9f5
SB
129 (h), PARSE_OPT_NOARG }
130#define OPT_SET_INT(s, l, v, h, i) { OPTION_SET_INT, (s), (l), (v), NULL, \
131 (h), PARSE_OPT_NOARG, NULL, (i) }
b04ba2bb 132#define OPT_BOOL(s, l, v, h) OPT_SET_INT(s, l, v, h, 1)
34aec9f5
SB
133#define OPT_SET_PTR(s, l, v, h, p) { OPTION_SET_PTR, (s), (l), (v), NULL, \
134 (h), PARSE_OPT_NOARG, NULL, (p) }
e3a0ca87 135#define OPT_INTEGER(s, l, v, h) { OPTION_INTEGER, (s), (l), (v), "n", (h) }
d7a38c54 136#define OPT_STRING(s, l, v, a, h) { OPTION_STRING, (s), (l), (v), (a), (h) }
c8ba1639
JK
137#define OPT_STRING_LIST(s, l, v, a, h) \
138 { OPTION_CALLBACK, (s), (l), (v), (a), \
139 (h), 0, &parse_opt_string_list }
cb6020bb
JH
140#define OPT_UYN(s, l, v, h) { OPTION_CALLBACK, (s), (l), (v), NULL, \
141 (h), PARSE_OPT_NOARG, &parse_opt_tertiary }
1f4a711a
MB
142#define OPT_DATE(s, l, v, h) \
143 { OPTION_CALLBACK, (s), (l), (v), "time",(h), 0, \
144 parse_opt_approxidate_cb }
ffe659f9
PH
145#define OPT_CALLBACK(s, l, v, a, h, f) \
146 { OPTION_CALLBACK, (s), (l), (v), (a), (h), 0, (f) }
e0319ff5
RS
147#define OPT_NUMBER_CALLBACK(v, h, f) \
148 { OPTION_NUMBER, 0, NULL, (v), NULL, (h), \
149 PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) }
df217ed6 150#define OPT_FILENAME(s, l, v, h) { OPTION_FILENAME, (s), (l), (v), \
1d5006ab 151 "file", (h) }
73e9da01
ML
152#define OPT_COLOR_FLAG(s, l, v, h) \
153 { OPTION_CALLBACK, (s), (l), (v), "when", (h), PARSE_OPT_OPTARG, \
154 parse_opt_color_flag_cb, (intptr_t)"always" }
155
b04ba2bb
JH
156/* Deprecated synonym */
157#define OPT_BOOLEAN OPT_COUNTUP
4a59fd13
PH
158
159/* parse_options() will filter out the processed options and leave the
3ea3c215 160 * non-option arguments in argv[].
4a59fd13
PH
161 * Returns the number of arguments left in argv[].
162 */
37782920 163extern int parse_options(int argc, const char **argv, const char *prefix,
4a59fd13 164 const struct option *options,
d7a38c54
PH
165 const char * const usagestr[], int flags);
166
167extern NORETURN void usage_with_options(const char * const *usagestr,
168 const struct option *options);
4a59fd13 169
451bb210
CC
170extern NORETURN void usage_msg_opt(const char *msg,
171 const char * const *usagestr,
172 const struct option *options);
173
1f275b7c
DI
174extern int optbug(const struct option *opt, const char *reason);
175extern int opterror(const struct option *opt, const char *reason, int flags);
3ea3c215 176/*----- incremental advanced APIs -----*/
7e7bbcb4 177
ee68b87a
PH
178enum {
179 PARSE_OPT_HELP = -1,
180 PARSE_OPT_DONE,
979240fe 181 PARSE_OPT_NON_OPTION,
4b05548f 182 PARSE_OPT_UNKNOWN
ee68b87a
PH
183};
184
26141b5b
PH
185/*
186 * It's okay for the caller to consume argv/argc in the usual way.
187 * Other fields of that structure are private to parse-options and should not
188 * be modified in any way.
189 */
7e7bbcb4
PH
190struct parse_opt_ctx_t {
191 const char **argv;
192 const char **out;
193 int argc, cpidx;
194 const char *opt;
195 int flags;
37782920 196 const char *prefix;
7e7bbcb4
PH
197};
198
199extern void parse_options_start(struct parse_opt_ctx_t *ctx,
37782920 200 int argc, const char **argv, const char *prefix,
9ca1169f 201 const struct option *options, int flags);
7e7bbcb4 202
ff43ec3e
PH
203extern int parse_options_step(struct parse_opt_ctx_t *ctx,
204 const struct option *options,
205 const char * const usagestr[]);
206
7e7bbcb4
PH
207extern int parse_options_end(struct parse_opt_ctx_t *ctx);
208
8b74d75c 209extern int parse_options_concat(struct option *dst, size_t, struct option *src);
7e7bbcb4 210
0ce865b1
PH
211/*----- some often used options -----*/
212extern int parse_opt_abbrev_cb(const struct option *, const char *, int);
1f4a711a 213extern int parse_opt_approxidate_cb(const struct option *, const char *, int);
73e9da01 214extern int parse_opt_color_flag_cb(const struct option *, const char *, int);
7f87aff2 215extern int parse_opt_verbosity_cb(const struct option *, const char *, int);
269defdf 216extern int parse_opt_with_commit(const struct option *, const char *, int);
cb6020bb 217extern int parse_opt_tertiary(const struct option *, const char *, int);
c8ba1639 218extern int parse_opt_string_list(const struct option *, const char *, int);
0ce865b1 219
fd03881a 220#define OPT__VERBOSE(var, h) OPT_BOOLEAN('v', "verbose", (var), (h))
d52ee6e6 221#define OPT__QUIET(var, h) OPT_BOOLEAN('q', "quiet", (var), (h))
7f87aff2
TA
222#define OPT__VERBOSITY(var) \
223 { OPTION_CALLBACK, 'v', "verbose", (var), NULL, "be more verbose", \
224 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
225 { OPTION_CALLBACK, 'q', "quiet", (var), NULL, "be more quiet", \
226 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
e21adb8c 227#define OPT__DRY_RUN(var, h) OPT_BOOLEAN('n', "dry-run", (var), (h))
76946b76 228#define OPT__FORCE(var, h) OPT_BOOLEAN('f', "force", (var), (h))
0ce865b1
PH
229#define OPT__ABBREV(var) \
230 { OPTION_CALLBACK, 0, "abbrev", (var), "n", \
231 "use <n> digits to display SHA-1s", \
232 PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
73e9da01
ML
233#define OPT__COLOR(var, h) \
234 OPT_COLOR_FLAG(0, "color", (var), (h))
0ce865b1 235
4a59fd13 236#endif