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