Git 2.5
[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 14 OPTION_SET_INT,
11588263 15 OPTION_CMDMODE,
db7244bd 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
24enum parse_opt_flags {
25 PARSE_OPT_KEEP_DASHDASH = 1,
a0ec9d25 26 PARSE_OPT_STOP_AT_NON_OPTION = 2,
a32a4eaa 27 PARSE_OPT_KEEP_ARGV0 = 4,
b5ce3a54 28 PARSE_OPT_KEEP_UNKNOWN = 8,
4b05548f 29 PARSE_OPT_NO_INTERNAL_HELP = 16
4a59fd13
PH
30};
31
ffe659f9
PH
32enum parse_opt_option_flags {
33 PARSE_OPT_OPTARG = 1,
f481e22a 34 PARSE_OPT_NOARG = 2,
db7244bd 35 PARSE_OPT_NONEG = 4,
dd3bf0f4 36 PARSE_OPT_HIDDEN = 8,
1cc6985c 37 PARSE_OPT_LASTARG_DEFAULT = 16,
51a9949e 38 PARSE_OPT_NODASH = 32,
29f25d49 39 PARSE_OPT_LITERAL_ARGHELP = 64,
47e9cd28 40 PARSE_OPT_SHELL_EVAL = 256
ffe659f9
PH
41};
42
43struct option;
44typedef int parse_opt_cb(const struct option *, const char *arg, int unset);
45
b0b3a8b6
JN
46struct parse_opt_ctx_t;
47typedef int parse_opt_ll_cb(struct parse_opt_ctx_t *ctx,
48 const struct option *opt, int unset);
49
9b3beb58
PH
50/*
51 * `type`::
52 * holds the type of the option, you must have an OPTION_END last in your
53 * array.
54 *
55 * `short_name`::
56 * the character to use as a short option name, '\0' if none.
57 *
58 * `long_name`::
59 * the long option name, without the leading dashes, NULL if none.
60 *
61 * `value`::
62 * stores pointers to the values to be filled.
63 *
64 * `argh`::
65 * token to explain the kind of argument this option wants. Keep it
54e6dc7d
NTND
66 * homogeneous across the repository. Should be wrapped by N_() for
67 * translation.
9b3beb58
PH
68 *
69 * `help`::
70 * the short help associated to what the option does.
71 * Must never be NULL (except for OPTION_END).
72 * OPTION_GROUP uses this pointer to store the group header.
54e6dc7d 73 * Should be wrapped by N_() for translation.
9b3beb58
PH
74 *
75 * `flags`::
76 * mask of parse_opt_option_flags.
3ea3c215 77 * PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs)
ef45e4da 78 * PARSE_OPT_NOARG: says that this option does not take an argument
db7244bd 79 * PARSE_OPT_NONEG: says that this option cannot be negated
51a9949e
RS
80 * PARSE_OPT_HIDDEN: this option is skipped in the default usage, and
81 * shown only in the full usage.
e169b974
SB
82 * PARSE_OPT_LASTARG_DEFAULT: says that this option will take the default
83 * value if no argument is given when the option
84 * is last on the command line. If the option is
85 * not last it will require an argument.
86 * Should not be used with PARSE_OPT_OPTARG.
51a9949e 87 * PARSE_OPT_NODASH: this option doesn't start with a dash.
29f25d49
SB
88 * PARSE_OPT_LITERAL_ARGHELP: says that argh shouldn't be enclosed in brackets
89 * (i.e. '<argh>') in the help message.
90 * Useful for options with multiple parameters.
9b3beb58
PH
91 *
92 * `callback`::
b0b3a8b6
JN
93 * pointer to the callback to use for OPTION_CALLBACK or
94 * OPTION_LOWLEVEL_CALLBACK.
9b3beb58
PH
95 *
96 * `defval`::
97 * default value to fill (*->value) with for PARSE_OPT_OPTARG.
d3c08114 98 * OPTION_{BIT,SET_INT} store the {mask,integer} to put in the value when met.
9b3beb58
PH
99 * CALLBACKS can use it like they want.
100 */
4a59fd13
PH
101struct option {
102 enum parse_opt_type type;
103 int short_name;
104 const char *long_name;
105 void *value;
d7a38c54
PH
106 const char *argh;
107 const char *help;
ffe659f9
PH
108
109 int flags;
110 parse_opt_cb *callback;
ffe659f9 111 intptr_t defval;
4a59fd13
PH
112};
113
114#define OPT_END() { OPTION_END }
34aec9f5
SB
115#define OPT_ARGUMENT(l, h) { OPTION_ARGUMENT, 0, (l), NULL, NULL, \
116 (h), PARSE_OPT_NOARG}
d7a38c54 117#define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
34aec9f5
SB
118#define OPT_BIT(s, l, v, h, b) { OPTION_BIT, (s), (l), (v), NULL, (h), \
119 PARSE_OPT_NOARG, NULL, (b) }
120#define OPT_NEGBIT(s, l, v, h, b) { OPTION_NEGBIT, (s), (l), (v), NULL, \
121 (h), PARSE_OPT_NOARG, NULL, (b) }
b04ba2bb 122#define OPT_COUNTUP(s, l, v, h) { OPTION_COUNTUP, (s), (l), (v), NULL, \
34aec9f5
SB
123 (h), PARSE_OPT_NOARG }
124#define OPT_SET_INT(s, l, v, h, i) { OPTION_SET_INT, (s), (l), (v), NULL, \
125 (h), PARSE_OPT_NOARG, NULL, (i) }
b04ba2bb 126#define OPT_BOOL(s, l, v, h) OPT_SET_INT(s, l, v, h, 1)
4741edd5
SB
127#define OPT_HIDDEN_BOOL(s, l, v, h) { OPTION_SET_INT, (s), (l), (v), NULL, \
128 (h), PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, 1}
11588263
JH
129#define OPT_CMDMODE(s, l, v, h, i) { OPTION_CMDMODE, (s), (l), (v), NULL, \
130 (h), PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, (i) }
54e6dc7d 131#define OPT_INTEGER(s, l, v, h) { OPTION_INTEGER, (s), (l), (v), N_("n"), (h) }
d7a38c54 132#define OPT_STRING(s, l, v, a, h) { OPTION_STRING, (s), (l), (v), (a), (h) }
c8ba1639
JK
133#define OPT_STRING_LIST(s, l, v, a, h) \
134 { OPTION_CALLBACK, (s), (l), (v), (a), \
135 (h), 0, &parse_opt_string_list }
cb6020bb
JH
136#define OPT_UYN(s, l, v, h) { OPTION_CALLBACK, (s), (l), (v), NULL, \
137 (h), PARSE_OPT_NOARG, &parse_opt_tertiary }
1f4a711a 138#define OPT_DATE(s, l, v, h) \
54e6dc7d 139 { OPTION_CALLBACK, (s), (l), (v), N_("time"),(h), 0, \
1f4a711a 140 parse_opt_approxidate_cb }
27ec394a 141#define OPT_EXPIRY_DATE(s, l, v, h) \
e703d711 142 { OPTION_CALLBACK, (s), (l), (v), N_("expiry-date"),(h), 0, \
27ec394a 143 parse_opt_expiry_date_cb }
ffe659f9
PH
144#define OPT_CALLBACK(s, l, v, a, h, f) \
145 { OPTION_CALLBACK, (s), (l), (v), (a), (h), 0, (f) }
e0319ff5
RS
146#define OPT_NUMBER_CALLBACK(v, h, f) \
147 { OPTION_NUMBER, 0, NULL, (v), NULL, (h), \
148 PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) }
df217ed6 149#define OPT_FILENAME(s, l, v, h) { OPTION_FILENAME, (s), (l), (v), \
54e6dc7d 150 N_("file"), (h) }
73e9da01 151#define OPT_COLOR_FLAG(s, l, v, h) \
54e6dc7d 152 { OPTION_CALLBACK, (s), (l), (v), N_("when"), (h), PARSE_OPT_OPTARG, \
73e9da01
ML
153 parse_opt_color_flag_cb, (intptr_t)"always" }
154
6acec038
RS
155#define OPT_NOOP_NOARG(s, l) \
156 { OPTION_CALLBACK, (s), (l), NULL, NULL, \
54e6dc7d 157 N_("no-op (backward compatibility)"), \
6acec038
RS
158 PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, parse_opt_noop_cb }
159
4a59fd13 160/* parse_options() will filter out the processed options and leave the
54e6dc7d
NTND
161 * non-option arguments in argv[]. usagestr strings should be marked
162 * for translation with N_().
4a59fd13
PH
163 * Returns the number of arguments left in argv[].
164 */
37782920 165extern int parse_options(int argc, const char **argv, const char *prefix,
4a59fd13 166 const struct option *options,
d7a38c54
PH
167 const char * const usagestr[], int flags);
168
169extern NORETURN void usage_with_options(const char * const *usagestr,
170 const struct option *options);
4a59fd13 171
451bb210
CC
172extern NORETURN void usage_msg_opt(const char *msg,
173 const char * const *usagestr,
174 const struct option *options);
175
1f275b7c
DI
176extern int optbug(const struct option *opt, const char *reason);
177extern int opterror(const struct option *opt, const char *reason, int flags);
ff0a80af 178#if defined(__GNUC__)
87fe5df3 179#define opterror(o,r,f) (opterror((o),(r),(f)), const_error())
a469a101
JK
180#endif
181
3ea3c215 182/*----- incremental advanced APIs -----*/
7e7bbcb4 183
ee68b87a
PH
184enum {
185 PARSE_OPT_HELP = -1,
186 PARSE_OPT_DONE,
979240fe 187 PARSE_OPT_NON_OPTION,
4b05548f 188 PARSE_OPT_UNKNOWN
ee68b87a
PH
189};
190
26141b5b
PH
191/*
192 * It's okay for the caller to consume argv/argc in the usual way.
193 * Other fields of that structure are private to parse-options and should not
194 * be modified in any way.
195 */
7e7bbcb4
PH
196struct parse_opt_ctx_t {
197 const char **argv;
198 const char **out;
199 int argc, cpidx;
200 const char *opt;
201 int flags;
37782920 202 const char *prefix;
7e7bbcb4
PH
203};
204
205extern void parse_options_start(struct parse_opt_ctx_t *ctx,
37782920 206 int argc, const char **argv, const char *prefix,
9ca1169f 207 const struct option *options, int flags);
7e7bbcb4 208
ff43ec3e
PH
209extern int parse_options_step(struct parse_opt_ctx_t *ctx,
210 const struct option *options,
211 const char * const usagestr[]);
212
7e7bbcb4
PH
213extern int parse_options_end(struct parse_opt_ctx_t *ctx);
214
8b74d75c 215extern int parse_options_concat(struct option *dst, size_t, struct option *src);
7e7bbcb4 216
0ce865b1
PH
217/*----- some often used options -----*/
218extern int parse_opt_abbrev_cb(const struct option *, const char *, int);
1f4a711a 219extern int parse_opt_approxidate_cb(const struct option *, const char *, int);
27ec394a 220extern int parse_opt_expiry_date_cb(const struct option *, const char *, int);
73e9da01 221extern int parse_opt_color_flag_cb(const struct option *, const char *, int);
7f87aff2 222extern int parse_opt_verbosity_cb(const struct option *, const char *, int);
269defdf 223extern int parse_opt_with_commit(const struct option *, const char *, int);
cb6020bb 224extern int parse_opt_tertiary(const struct option *, const char *, int);
c8ba1639 225extern int parse_opt_string_list(const struct option *, const char *, int);
6acec038 226extern int parse_opt_noop_cb(const struct option *, const char *, int);
0ce865b1 227
212c0a6f
NTND
228#define OPT__VERBOSE(var, h) OPT_COUNTUP('v', "verbose", (var), (h))
229#define OPT__QUIET(var, h) OPT_COUNTUP('q', "quiet", (var), (h))
7f87aff2 230#define OPT__VERBOSITY(var) \
54e6dc7d 231 { OPTION_CALLBACK, 'v', "verbose", (var), NULL, N_("be more verbose"), \
7f87aff2 232 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
54e6dc7d 233 { OPTION_CALLBACK, 'q', "quiet", (var), NULL, N_("be more quiet"), \
7f87aff2 234 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
212c0a6f
NTND
235#define OPT__DRY_RUN(var, h) OPT_BOOL('n', "dry-run", (var), (h))
236#define OPT__FORCE(var, h) OPT_COUNTUP('f', "force", (var), (h))
0ce865b1 237#define OPT__ABBREV(var) \
54e6dc7d
NTND
238 { OPTION_CALLBACK, 0, "abbrev", (var), N_("n"), \
239 N_("use <n> digits to display SHA-1s"), \
0ce865b1 240 PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
73e9da01
ML
241#define OPT__COLOR(var, h) \
242 OPT_COLOR_FLAG(0, "color", (var), (h))
7e29b825 243#define OPT_COLUMN(s, l, v, h) \
a054e049 244 { OPTION_CALLBACK, (s), (l), (v), N_("style"), (h), PARSE_OPT_OPTARG, parseopt_column_callback }
0ce865b1 245
4a59fd13 246#endif