tag: use OPT_CMDMODE
[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,
11588263 16 OPTION_CMDMODE,
db7244bd 17 /* options with arguments (usually) */
4a59fd13
PH
18 OPTION_STRING,
19 OPTION_INTEGER,
ffe659f9 20 OPTION_CALLBACK,
b0b3a8b6 21 OPTION_LOWLEVEL_CALLBACK,
df217ed6 22 OPTION_FILENAME
4a59fd13
PH
23};
24
b04ba2bb
JH
25/* Deprecated synonym */
26#define OPTION_BOOLEAN OPTION_COUNTUP
27
4a59fd13
PH
28enum parse_opt_flags {
29 PARSE_OPT_KEEP_DASHDASH = 1,
a0ec9d25 30 PARSE_OPT_STOP_AT_NON_OPTION = 2,
a32a4eaa 31 PARSE_OPT_KEEP_ARGV0 = 4,
b5ce3a54 32 PARSE_OPT_KEEP_UNKNOWN = 8,
4b05548f 33 PARSE_OPT_NO_INTERNAL_HELP = 16
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,
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
54e6dc7d
NTND
70 * homogeneous across the repository. Should be wrapped by N_() for
71 * translation.
9b3beb58
PH
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.
54e6dc7d 77 * Should be wrapped by N_() for translation.
9b3beb58
PH
78 *
79 * `flags`::
80 * mask of parse_opt_option_flags.
3ea3c215 81 * PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs)
ef45e4da 82 * PARSE_OPT_NOARG: says that this option does not take an argument
db7244bd 83 * PARSE_OPT_NONEG: says that this option cannot be negated
51a9949e
RS
84 * PARSE_OPT_HIDDEN: this option is skipped in the default usage, and
85 * shown only in the full usage.
e169b974
SB
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.
51a9949e 91 * PARSE_OPT_NODASH: this option doesn't start with a dash.
29f25d49
SB
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.
9b3beb58
PH
95 *
96 * `callback`::
b0b3a8b6
JN
97 * pointer to the callback to use for OPTION_CALLBACK or
98 * OPTION_LOWLEVEL_CALLBACK.
9b3beb58
PH
99 *
100 * `defval`::
101 * default value to fill (*->value) with for PARSE_OPT_OPTARG.
db7244bd
PH
102 * OPTION_{BIT,SET_INT,SET_PTR} store the {mask,integer,pointer} to put in
103 * the value when met.
9b3beb58
PH
104 * CALLBACKS can use it like they want.
105 */
4a59fd13
PH
106struct option {
107 enum parse_opt_type type;
108 int short_name;
109 const char *long_name;
110 void *value;
d7a38c54
PH
111 const char *argh;
112 const char *help;
ffe659f9
PH
113
114 int flags;
115 parse_opt_cb *callback;
ffe659f9 116 intptr_t defval;
4a59fd13
PH
117};
118
119#define OPT_END() { OPTION_END }
34aec9f5
SB
120#define OPT_ARGUMENT(l, h) { OPTION_ARGUMENT, 0, (l), NULL, NULL, \
121 (h), PARSE_OPT_NOARG}
d7a38c54 122#define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
34aec9f5
SB
123#define OPT_BIT(s, l, v, h, b) { OPTION_BIT, (s), (l), (v), NULL, (h), \
124 PARSE_OPT_NOARG, NULL, (b) }
125#define OPT_NEGBIT(s, l, v, h, b) { OPTION_NEGBIT, (s), (l), (v), NULL, \
126 (h), PARSE_OPT_NOARG, NULL, (b) }
b04ba2bb 127#define OPT_COUNTUP(s, l, v, h) { OPTION_COUNTUP, (s), (l), (v), NULL, \
34aec9f5
SB
128 (h), PARSE_OPT_NOARG }
129#define OPT_SET_INT(s, l, v, h, i) { OPTION_SET_INT, (s), (l), (v), NULL, \
130 (h), PARSE_OPT_NOARG, NULL, (i) }
b04ba2bb 131#define OPT_BOOL(s, l, v, h) OPT_SET_INT(s, l, v, h, 1)
34aec9f5
SB
132#define OPT_SET_PTR(s, l, v, h, p) { OPTION_SET_PTR, (s), (l), (v), NULL, \
133 (h), PARSE_OPT_NOARG, NULL, (p) }
11588263
JH
134#define OPT_CMDMODE(s, l, v, h, i) { OPTION_CMDMODE, (s), (l), (v), NULL, \
135 (h), PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, (i) }
54e6dc7d 136#define OPT_INTEGER(s, l, v, h) { OPTION_INTEGER, (s), (l), (v), N_("n"), (h) }
d7a38c54 137#define OPT_STRING(s, l, v, a, h) { OPTION_STRING, (s), (l), (v), (a), (h) }
c8ba1639
JK
138#define OPT_STRING_LIST(s, l, v, a, h) \
139 { OPTION_CALLBACK, (s), (l), (v), (a), \
140 (h), 0, &parse_opt_string_list }
cb6020bb
JH
141#define OPT_UYN(s, l, v, h) { OPTION_CALLBACK, (s), (l), (v), NULL, \
142 (h), PARSE_OPT_NOARG, &parse_opt_tertiary }
1f4a711a 143#define OPT_DATE(s, l, v, h) \
54e6dc7d 144 { OPTION_CALLBACK, (s), (l), (v), N_("time"),(h), 0, \
1f4a711a 145 parse_opt_approxidate_cb }
27ec394a
JH
146#define OPT_EXPIRY_DATE(s, l, v, h) \
147 { OPTION_CALLBACK, (s), (l), (v), N_("expiry date"),(h), 0, \
148 parse_opt_expiry_date_cb }
ffe659f9
PH
149#define OPT_CALLBACK(s, l, v, a, h, f) \
150 { OPTION_CALLBACK, (s), (l), (v), (a), (h), 0, (f) }
e0319ff5
RS
151#define OPT_NUMBER_CALLBACK(v, h, f) \
152 { OPTION_NUMBER, 0, NULL, (v), NULL, (h), \
153 PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) }
df217ed6 154#define OPT_FILENAME(s, l, v, h) { OPTION_FILENAME, (s), (l), (v), \
54e6dc7d 155 N_("file"), (h) }
73e9da01 156#define OPT_COLOR_FLAG(s, l, v, h) \
54e6dc7d 157 { OPTION_CALLBACK, (s), (l), (v), N_("when"), (h), PARSE_OPT_OPTARG, \
73e9da01
ML
158 parse_opt_color_flag_cb, (intptr_t)"always" }
159
6acec038
RS
160#define OPT_NOOP_NOARG(s, l) \
161 { OPTION_CALLBACK, (s), (l), NULL, NULL, \
54e6dc7d 162 N_("no-op (backward compatibility)"), \
6acec038
RS
163 PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, parse_opt_noop_cb }
164
b04ba2bb
JH
165/* Deprecated synonym */
166#define OPT_BOOLEAN OPT_COUNTUP
4a59fd13
PH
167
168/* parse_options() will filter out the processed options and leave the
54e6dc7d
NTND
169 * non-option arguments in argv[]. usagestr strings should be marked
170 * for translation with N_().
4a59fd13
PH
171 * Returns the number of arguments left in argv[].
172 */
37782920 173extern int parse_options(int argc, const char **argv, const char *prefix,
4a59fd13 174 const struct option *options,
d7a38c54
PH
175 const char * const usagestr[], int flags);
176
177extern NORETURN void usage_with_options(const char * const *usagestr,
178 const struct option *options);
4a59fd13 179
451bb210
CC
180extern NORETURN void usage_msg_opt(const char *msg,
181 const char * const *usagestr,
182 const struct option *options);
183
1f275b7c
DI
184extern int optbug(const struct option *opt, const char *reason);
185extern int opterror(const struct option *opt, const char *reason, int flags);
5ded807f 186#if defined(__GNUC__) && ! defined(clang)
a469a101
JK
187#define opterror(o,r,f) (opterror((o),(r),(f)), -1)
188#endif
189
3ea3c215 190/*----- incremental advanced APIs -----*/
7e7bbcb4 191
ee68b87a
PH
192enum {
193 PARSE_OPT_HELP = -1,
194 PARSE_OPT_DONE,
979240fe 195 PARSE_OPT_NON_OPTION,
4b05548f 196 PARSE_OPT_UNKNOWN
ee68b87a
PH
197};
198
26141b5b
PH
199/*
200 * It's okay for the caller to consume argv/argc in the usual way.
201 * Other fields of that structure are private to parse-options and should not
202 * be modified in any way.
203 */
7e7bbcb4
PH
204struct parse_opt_ctx_t {
205 const char **argv;
206 const char **out;
207 int argc, cpidx;
208 const char *opt;
209 int flags;
37782920 210 const char *prefix;
7e7bbcb4
PH
211};
212
213extern void parse_options_start(struct parse_opt_ctx_t *ctx,
37782920 214 int argc, const char **argv, const char *prefix,
9ca1169f 215 const struct option *options, int flags);
7e7bbcb4 216
ff43ec3e
PH
217extern int parse_options_step(struct parse_opt_ctx_t *ctx,
218 const struct option *options,
219 const char * const usagestr[]);
220
7e7bbcb4
PH
221extern int parse_options_end(struct parse_opt_ctx_t *ctx);
222
8b74d75c 223extern int parse_options_concat(struct option *dst, size_t, struct option *src);
7e7bbcb4 224
0ce865b1
PH
225/*----- some often used options -----*/
226extern int parse_opt_abbrev_cb(const struct option *, const char *, int);
1f4a711a 227extern int parse_opt_approxidate_cb(const struct option *, const char *, int);
27ec394a 228extern int parse_opt_expiry_date_cb(const struct option *, const char *, int);
73e9da01 229extern int parse_opt_color_flag_cb(const struct option *, const char *, int);
7f87aff2 230extern int parse_opt_verbosity_cb(const struct option *, const char *, int);
269defdf 231extern int parse_opt_with_commit(const struct option *, const char *, int);
cb6020bb 232extern int parse_opt_tertiary(const struct option *, const char *, int);
c8ba1639 233extern int parse_opt_string_list(const struct option *, const char *, int);
6acec038 234extern int parse_opt_noop_cb(const struct option *, const char *, int);
0ce865b1 235
fd03881a 236#define OPT__VERBOSE(var, h) OPT_BOOLEAN('v', "verbose", (var), (h))
d52ee6e6 237#define OPT__QUIET(var, h) OPT_BOOLEAN('q', "quiet", (var), (h))
7f87aff2 238#define OPT__VERBOSITY(var) \
54e6dc7d 239 { OPTION_CALLBACK, 'v', "verbose", (var), NULL, N_("be more verbose"), \
7f87aff2 240 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
54e6dc7d 241 { OPTION_CALLBACK, 'q', "quiet", (var), NULL, N_("be more quiet"), \
7f87aff2 242 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
e21adb8c 243#define OPT__DRY_RUN(var, h) OPT_BOOLEAN('n', "dry-run", (var), (h))
76946b76 244#define OPT__FORCE(var, h) OPT_BOOLEAN('f', "force", (var), (h))
0ce865b1 245#define OPT__ABBREV(var) \
54e6dc7d
NTND
246 { OPTION_CALLBACK, 0, "abbrev", (var), N_("n"), \
247 N_("use <n> digits to display SHA-1s"), \
0ce865b1 248 PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
73e9da01
ML
249#define OPT__COLOR(var, h) \
250 OPT_COLOR_FLAG(0, "color", (var), (h))
7e29b825 251#define OPT_COLUMN(s, l, v, h) \
a054e049 252 { OPTION_CALLBACK, (s), (l), (v), N_("style"), (h), PARSE_OPT_OPTARG, parseopt_column_callback }
0ce865b1 253
4a59fd13 254#endif