Remove deprecated OPTION_BOOLEAN for parsing arguments
[git/git.git] / parse-options.h
1 #ifndef PARSE_OPTIONS_H
2 #define PARSE_OPTIONS_H
3
4 enum parse_opt_type {
5 /* special types */
6 OPTION_END,
7 OPTION_ARGUMENT,
8 OPTION_GROUP,
9 OPTION_NUMBER,
10 /* options with no arguments */
11 OPTION_BIT,
12 OPTION_NEGBIT,
13 OPTION_COUNTUP,
14 OPTION_SET_INT,
15 OPTION_SET_PTR,
16 OPTION_CMDMODE,
17 /* options with arguments (usually) */
18 OPTION_STRING,
19 OPTION_INTEGER,
20 OPTION_CALLBACK,
21 OPTION_LOWLEVEL_CALLBACK,
22 OPTION_FILENAME
23 };
24
25 enum parse_opt_flags {
26 PARSE_OPT_KEEP_DASHDASH = 1,
27 PARSE_OPT_STOP_AT_NON_OPTION = 2,
28 PARSE_OPT_KEEP_ARGV0 = 4,
29 PARSE_OPT_KEEP_UNKNOWN = 8,
30 PARSE_OPT_NO_INTERNAL_HELP = 16
31 };
32
33 enum parse_opt_option_flags {
34 PARSE_OPT_OPTARG = 1,
35 PARSE_OPT_NOARG = 2,
36 PARSE_OPT_NONEG = 4,
37 PARSE_OPT_HIDDEN = 8,
38 PARSE_OPT_LASTARG_DEFAULT = 16,
39 PARSE_OPT_NODASH = 32,
40 PARSE_OPT_LITERAL_ARGHELP = 64,
41 PARSE_OPT_SHELL_EVAL = 256
42 };
43
44 struct option;
45 typedef int parse_opt_cb(const struct option *, const char *arg, int unset);
46
47 struct parse_opt_ctx_t;
48 typedef int parse_opt_ll_cb(struct parse_opt_ctx_t *ctx,
49 const struct option *opt, int unset);
50
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
67 * homogeneous across the repository. Should be wrapped by N_() for
68 * translation.
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.
74 * Should be wrapped by N_() for translation.
75 *
76 * `flags`::
77 * mask of parse_opt_option_flags.
78 * PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs)
79 * PARSE_OPT_NOARG: says that this option does not take an argument
80 * PARSE_OPT_NONEG: says that this option cannot be negated
81 * PARSE_OPT_HIDDEN: this option is skipped in the default usage, and
82 * shown only in the full usage.
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.
88 * PARSE_OPT_NODASH: this option doesn't start with a dash.
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.
92 *
93 * `callback`::
94 * pointer to the callback to use for OPTION_CALLBACK or
95 * OPTION_LOWLEVEL_CALLBACK.
96 *
97 * `defval`::
98 * default value to fill (*->value) with for PARSE_OPT_OPTARG.
99 * OPTION_{BIT,SET_INT,SET_PTR} store the {mask,integer,pointer} to put in
100 * the value when met.
101 * CALLBACKS can use it like they want.
102 */
103 struct option {
104 enum parse_opt_type type;
105 int short_name;
106 const char *long_name;
107 void *value;
108 const char *argh;
109 const char *help;
110
111 int flags;
112 parse_opt_cb *callback;
113 intptr_t defval;
114 };
115
116 #define OPT_END() { OPTION_END }
117 #define OPT_ARGUMENT(l, h) { OPTION_ARGUMENT, 0, (l), NULL, NULL, \
118 (h), PARSE_OPT_NOARG}
119 #define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
120 #define OPT_BIT(s, l, v, h, b) { OPTION_BIT, (s), (l), (v), NULL, (h), \
121 PARSE_OPT_NOARG, NULL, (b) }
122 #define OPT_NEGBIT(s, l, v, h, b) { OPTION_NEGBIT, (s), (l), (v), NULL, \
123 (h), PARSE_OPT_NOARG, NULL, (b) }
124 #define OPT_COUNTUP(s, l, v, h) { OPTION_COUNTUP, (s), (l), (v), NULL, \
125 (h), PARSE_OPT_NOARG }
126 #define OPT_SET_INT(s, l, v, h, i) { OPTION_SET_INT, (s), (l), (v), NULL, \
127 (h), PARSE_OPT_NOARG, NULL, (i) }
128 #define OPT_BOOL(s, l, v, h) OPT_SET_INT(s, l, v, h, 1)
129 #define OPT_HIDDEN_BOOL(s, l, v, h) { OPTION_SET_INT, (s), (l), (v), NULL, \
130 (h), PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, 1}
131 #define OPT_SET_PTR(s, l, v, h, p) { OPTION_SET_PTR, (s), (l), (v), NULL, \
132 (h), PARSE_OPT_NOARG, NULL, (p) }
133 #define OPT_CMDMODE(s, l, v, h, i) { OPTION_CMDMODE, (s), (l), (v), NULL, \
134 (h), PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, (i) }
135 #define OPT_INTEGER(s, l, v, h) { OPTION_INTEGER, (s), (l), (v), N_("n"), (h) }
136 #define OPT_STRING(s, l, v, a, h) { OPTION_STRING, (s), (l), (v), (a), (h) }
137 #define OPT_STRING_LIST(s, l, v, a, h) \
138 { OPTION_CALLBACK, (s), (l), (v), (a), \
139 (h), 0, &parse_opt_string_list }
140 #define OPT_UYN(s, l, v, h) { OPTION_CALLBACK, (s), (l), (v), NULL, \
141 (h), PARSE_OPT_NOARG, &parse_opt_tertiary }
142 #define OPT_DATE(s, l, v, h) \
143 { OPTION_CALLBACK, (s), (l), (v), N_("time"),(h), 0, \
144 parse_opt_approxidate_cb }
145 #define OPT_EXPIRY_DATE(s, l, v, h) \
146 { OPTION_CALLBACK, (s), (l), (v), N_("expiry date"),(h), 0, \
147 parse_opt_expiry_date_cb }
148 #define OPT_CALLBACK(s, l, v, a, h, f) \
149 { OPTION_CALLBACK, (s), (l), (v), (a), (h), 0, (f) }
150 #define OPT_NUMBER_CALLBACK(v, h, f) \
151 { OPTION_NUMBER, 0, NULL, (v), NULL, (h), \
152 PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) }
153 #define OPT_FILENAME(s, l, v, h) { OPTION_FILENAME, (s), (l), (v), \
154 N_("file"), (h) }
155 #define OPT_COLOR_FLAG(s, l, v, h) \
156 { OPTION_CALLBACK, (s), (l), (v), N_("when"), (h), PARSE_OPT_OPTARG, \
157 parse_opt_color_flag_cb, (intptr_t)"always" }
158
159 #define OPT_NOOP_NOARG(s, l) \
160 { OPTION_CALLBACK, (s), (l), NULL, NULL, \
161 N_("no-op (backward compatibility)"), \
162 PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, parse_opt_noop_cb }
163
164 /* Deprecated synonym */
165 #define OPT_BOOLEAN OPT_COUNTUP
166
167 /* parse_options() will filter out the processed options and leave the
168 * non-option arguments in argv[]. usagestr strings should be marked
169 * for translation with N_().
170 * Returns the number of arguments left in argv[].
171 */
172 extern int parse_options(int argc, const char **argv, const char *prefix,
173 const struct option *options,
174 const char * const usagestr[], int flags);
175
176 extern NORETURN void usage_with_options(const char * const *usagestr,
177 const struct option *options);
178
179 extern NORETURN void usage_msg_opt(const char *msg,
180 const char * const *usagestr,
181 const struct option *options);
182
183 extern int optbug(const struct option *opt, const char *reason);
184 extern int opterror(const struct option *opt, const char *reason, int flags);
185 #if defined(__GNUC__) && ! defined(clang)
186 #define opterror(o,r,f) (opterror((o),(r),(f)), -1)
187 #endif
188
189 /*----- incremental advanced APIs -----*/
190
191 enum {
192 PARSE_OPT_HELP = -1,
193 PARSE_OPT_DONE,
194 PARSE_OPT_NON_OPTION,
195 PARSE_OPT_UNKNOWN
196 };
197
198 /*
199 * It's okay for the caller to consume argv/argc in the usual way.
200 * Other fields of that structure are private to parse-options and should not
201 * be modified in any way.
202 */
203 struct parse_opt_ctx_t {
204 const char **argv;
205 const char **out;
206 int argc, cpidx;
207 const char *opt;
208 int flags;
209 const char *prefix;
210 };
211
212 extern void parse_options_start(struct parse_opt_ctx_t *ctx,
213 int argc, const char **argv, const char *prefix,
214 const struct option *options, int flags);
215
216 extern int parse_options_step(struct parse_opt_ctx_t *ctx,
217 const struct option *options,
218 const char * const usagestr[]);
219
220 extern int parse_options_end(struct parse_opt_ctx_t *ctx);
221
222 extern int parse_options_concat(struct option *dst, size_t, struct option *src);
223
224 /*----- some often used options -----*/
225 extern int parse_opt_abbrev_cb(const struct option *, const char *, int);
226 extern int parse_opt_approxidate_cb(const struct option *, const char *, int);
227 extern int parse_opt_expiry_date_cb(const struct option *, const char *, int);
228 extern int parse_opt_color_flag_cb(const struct option *, const char *, int);
229 extern int parse_opt_verbosity_cb(const struct option *, const char *, int);
230 extern int parse_opt_with_commit(const struct option *, const char *, int);
231 extern int parse_opt_tertiary(const struct option *, const char *, int);
232 extern int parse_opt_string_list(const struct option *, const char *, int);
233 extern int parse_opt_noop_cb(const struct option *, const char *, int);
234
235 #define OPT__VERBOSE(var, h) OPT_BOOLEAN('v', "verbose", (var), (h))
236 #define OPT__QUIET(var, h) OPT_BOOLEAN('q', "quiet", (var), (h))
237 #define OPT__VERBOSITY(var) \
238 { OPTION_CALLBACK, 'v', "verbose", (var), NULL, N_("be more verbose"), \
239 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
240 { OPTION_CALLBACK, 'q', "quiet", (var), NULL, N_("be more quiet"), \
241 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
242 #define OPT__DRY_RUN(var, h) OPT_BOOLEAN('n', "dry-run", (var), (h))
243 #define OPT__FORCE(var, h) OPT_BOOLEAN('f', "force", (var), (h))
244 #define OPT__ABBREV(var) \
245 { OPTION_CALLBACK, 0, "abbrev", (var), N_("n"), \
246 N_("use <n> digits to display SHA-1s"), \
247 PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
248 #define OPT__COLOR(var, h) \
249 OPT_COLOR_FLAG(0, "color", (var), (h))
250 #define OPT_COLUMN(s, l, v, h) \
251 { OPTION_CALLBACK, (s), (l), (v), N_("style"), (h), PARSE_OPT_OPTARG, parseopt_column_callback }
252
253 #endif