]> git.ipfire.org Git - thirdparty/git.git/blame - parse-options.h
Merge branch 'jc/maint-imap-config-parse' into maint
[thirdparty/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,
df217ed6 20 OPTION_FILENAME
4a59fd13
PH
21};
22
23enum parse_opt_flags {
24 PARSE_OPT_KEEP_DASHDASH = 1,
a0ec9d25 25 PARSE_OPT_STOP_AT_NON_OPTION = 2,
a32a4eaa 26 PARSE_OPT_KEEP_ARGV0 = 4,
b5ce3a54 27 PARSE_OPT_KEEP_UNKNOWN = 8,
b92891f9 28 PARSE_OPT_NO_INTERNAL_HELP = 16,
4a59fd13
PH
29};
30
ffe659f9
PH
31enum parse_opt_option_flags {
32 PARSE_OPT_OPTARG = 1,
f481e22a 33 PARSE_OPT_NOARG = 2,
db7244bd 34 PARSE_OPT_NONEG = 4,
dd3bf0f4 35 PARSE_OPT_HIDDEN = 8,
1cc6985c 36 PARSE_OPT_LASTARG_DEFAULT = 16,
51a9949e 37 PARSE_OPT_NODASH = 32,
29f25d49 38 PARSE_OPT_LITERAL_ARGHELP = 64,
86b5efb2 39 PARSE_OPT_NEGHELP = 128,
ffe659f9
PH
40};
41
42struct option;
43typedef int parse_opt_cb(const struct option *, const char *arg, int unset);
44
9b3beb58
PH
45/*
46 * `type`::
47 * holds the type of the option, you must have an OPTION_END last in your
48 * array.
49 *
50 * `short_name`::
51 * the character to use as a short option name, '\0' if none.
52 *
53 * `long_name`::
54 * the long option name, without the leading dashes, NULL if none.
55 *
56 * `value`::
57 * stores pointers to the values to be filled.
58 *
59 * `argh`::
60 * token to explain the kind of argument this option wants. Keep it
3ea3c215 61 * homogeneous across the repository.
9b3beb58
PH
62 *
63 * `help`::
64 * the short help associated to what the option does.
65 * Must never be NULL (except for OPTION_END).
66 * OPTION_GROUP uses this pointer to store the group header.
67 *
68 * `flags`::
69 * mask of parse_opt_option_flags.
3ea3c215 70 * PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs)
34aec9f5 71 * PARSE_OPT_NOARG: says that this option takes no argument
db7244bd 72 * PARSE_OPT_NONEG: says that this option cannot be negated
51a9949e
RS
73 * PARSE_OPT_HIDDEN: this option is skipped in the default usage, and
74 * shown only in the full usage.
e169b974
SB
75 * PARSE_OPT_LASTARG_DEFAULT: says that this option will take the default
76 * value if no argument is given when the option
77 * is last on the command line. If the option is
78 * not last it will require an argument.
79 * Should not be used with PARSE_OPT_OPTARG.
51a9949e 80 * PARSE_OPT_NODASH: this option doesn't start with a dash.
29f25d49
SB
81 * PARSE_OPT_LITERAL_ARGHELP: says that argh shouldn't be enclosed in brackets
82 * (i.e. '<argh>') in the help message.
83 * Useful for options with multiple parameters.
86b5efb2
JS
84 * PARSE_OPT_NEGHELP: says that the long option should always be shown with
85 * the --no prefix in the usage message. Sometimes
86 * useful for users of OPTION_NEGBIT.
9b3beb58
PH
87 *
88 * `callback`::
89 * pointer to the callback to use for OPTION_CALLBACK.
90 *
91 * `defval`::
92 * default value to fill (*->value) with for PARSE_OPT_OPTARG.
db7244bd
PH
93 * OPTION_{BIT,SET_INT,SET_PTR} store the {mask,integer,pointer} to put in
94 * the value when met.
9b3beb58
PH
95 * CALLBACKS can use it like they want.
96 */
4a59fd13
PH
97struct option {
98 enum parse_opt_type type;
99 int short_name;
100 const char *long_name;
101 void *value;
d7a38c54
PH
102 const char *argh;
103 const char *help;
ffe659f9
PH
104
105 int flags;
106 parse_opt_cb *callback;
ffe659f9 107 intptr_t defval;
4a59fd13
PH
108};
109
110#define OPT_END() { OPTION_END }
34aec9f5
SB
111#define OPT_ARGUMENT(l, h) { OPTION_ARGUMENT, 0, (l), NULL, NULL, \
112 (h), PARSE_OPT_NOARG}
d7a38c54 113#define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
34aec9f5
SB
114#define OPT_BIT(s, l, v, h, b) { OPTION_BIT, (s), (l), (v), NULL, (h), \
115 PARSE_OPT_NOARG, NULL, (b) }
116#define OPT_NEGBIT(s, l, v, h, b) { OPTION_NEGBIT, (s), (l), (v), NULL, \
117 (h), PARSE_OPT_NOARG, NULL, (b) }
118#define OPT_BOOLEAN(s, l, v, h) { OPTION_BOOLEAN, (s), (l), (v), NULL, \
119 (h), PARSE_OPT_NOARG }
120#define OPT_SET_INT(s, l, v, h, i) { OPTION_SET_INT, (s), (l), (v), NULL, \
121 (h), PARSE_OPT_NOARG, NULL, (i) }
122#define OPT_SET_PTR(s, l, v, h, p) { OPTION_SET_PTR, (s), (l), (v), NULL, \
123 (h), PARSE_OPT_NOARG, NULL, (p) }
e3a0ca87 124#define OPT_INTEGER(s, l, v, h) { OPTION_INTEGER, (s), (l), (v), "n", (h) }
d7a38c54 125#define OPT_STRING(s, l, v, a, h) { OPTION_STRING, (s), (l), (v), (a), (h) }
1f4a711a
MB
126#define OPT_DATE(s, l, v, h) \
127 { OPTION_CALLBACK, (s), (l), (v), "time",(h), 0, \
128 parse_opt_approxidate_cb }
ffe659f9
PH
129#define OPT_CALLBACK(s, l, v, a, h, f) \
130 { OPTION_CALLBACK, (s), (l), (v), (a), (h), 0, (f) }
e0319ff5
RS
131#define OPT_NUMBER_CALLBACK(v, h, f) \
132 { OPTION_NUMBER, 0, NULL, (v), NULL, (h), \
133 PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) }
df217ed6
SB
134#define OPT_FILENAME(s, l, v, h) { OPTION_FILENAME, (s), (l), (v), \
135 "FILE", (h) }
4a59fd13
PH
136
137/* parse_options() will filter out the processed options and leave the
3ea3c215 138 * non-option arguments in argv[].
4a59fd13
PH
139 * Returns the number of arguments left in argv[].
140 */
37782920 141extern int parse_options(int argc, const char **argv, const char *prefix,
4a59fd13 142 const struct option *options,
d7a38c54
PH
143 const char * const usagestr[], int flags);
144
145extern NORETURN void usage_with_options(const char * const *usagestr,
146 const struct option *options);
4a59fd13 147
451bb210
CC
148extern NORETURN void usage_msg_opt(const char *msg,
149 const char * const *usagestr,
150 const struct option *options);
151
3ea3c215 152/*----- incremental advanced APIs -----*/
7e7bbcb4 153
ee68b87a
PH
154enum {
155 PARSE_OPT_HELP = -1,
156 PARSE_OPT_DONE,
157 PARSE_OPT_UNKNOWN,
158};
159
26141b5b
PH
160/*
161 * It's okay for the caller to consume argv/argc in the usual way.
162 * Other fields of that structure are private to parse-options and should not
163 * be modified in any way.
164 */
7e7bbcb4
PH
165struct parse_opt_ctx_t {
166 const char **argv;
167 const char **out;
168 int argc, cpidx;
169 const char *opt;
170 int flags;
37782920 171 const char *prefix;
7e7bbcb4
PH
172};
173
ee68b87a
PH
174extern int parse_options_usage(const char * const *usagestr,
175 const struct option *opts);
176
7e7bbcb4 177extern void parse_options_start(struct parse_opt_ctx_t *ctx,
37782920
SB
178 int argc, const char **argv, const char *prefix,
179 int flags);
7e7bbcb4 180
ff43ec3e
PH
181extern int parse_options_step(struct parse_opt_ctx_t *ctx,
182 const struct option *options,
183 const char * const usagestr[]);
184
7e7bbcb4
PH
185extern int parse_options_end(struct parse_opt_ctx_t *ctx);
186
187
0ce865b1
PH
188/*----- some often used options -----*/
189extern int parse_opt_abbrev_cb(const struct option *, const char *, int);
1f4a711a 190extern int parse_opt_approxidate_cb(const struct option *, const char *, int);
7f87aff2 191extern int parse_opt_verbosity_cb(const struct option *, const char *, int);
269defdf 192extern int parse_opt_with_commit(const struct option *, const char *, int);
0ce865b1
PH
193
194#define OPT__VERBOSE(var) OPT_BOOLEAN('v', "verbose", (var), "be verbose")
195#define OPT__QUIET(var) OPT_BOOLEAN('q', "quiet", (var), "be quiet")
7f87aff2
TA
196#define OPT__VERBOSITY(var) \
197 { OPTION_CALLBACK, 'v', "verbose", (var), NULL, "be more verbose", \
198 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
199 { OPTION_CALLBACK, 'q', "quiet", (var), NULL, "be more quiet", \
200 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
0ce865b1
PH
201#define OPT__DRY_RUN(var) OPT_BOOLEAN('n', "dry-run", (var), "dry run")
202#define OPT__ABBREV(var) \
203 { OPTION_CALLBACK, 0, "abbrev", (var), "n", \
204 "use <n> digits to display SHA-1s", \
205 PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
206
4a59fd13 207#endif