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