rebase --root: fix amending root commit messages
[git.git] / parse-options.h
blobdd14911a297a5b10705ecb31243c55a7dc2f193c
1 #ifndef PARSE_OPTIONS_H
2 #define PARSE_OPTIONS_H
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_CMDMODE,
16 /* options with arguments (usually) */
17 OPTION_STRING,
18 OPTION_INTEGER,
19 OPTION_MAGNITUDE,
20 OPTION_CALLBACK,
21 OPTION_LOWLEVEL_CALLBACK,
22 OPTION_FILENAME
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
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 PARSE_OPT_NOCOMPLETE = 512,
43 PARSE_OPT_COMP_ARG = 1024
46 struct option;
47 typedef int parse_opt_cb(const struct option *, const char *arg, int unset);
49 struct parse_opt_ctx_t;
50 typedef int parse_opt_ll_cb(struct parse_opt_ctx_t *ctx,
51 const struct option *opt, int unset);
54 * `type`::
55 * holds the type of the option, you must have an OPTION_END last in your
56 * array.
58 * `short_name`::
59 * the character to use as a short option name, '\0' if none.
61 * `long_name`::
62 * the long option name, without the leading dashes, NULL if none.
64 * `value`::
65 * stores pointers to the values to be filled.
67 * `argh`::
68 * token to explain the kind of argument this option wants. Keep it
69 * homogeneous across the repository. Should be wrapped by N_() for
70 * translation.
72 * `help`::
73 * the short help associated to what the option does.
74 * Must never be NULL (except for OPTION_END).
75 * OPTION_GROUP uses this pointer to store the group header.
76 * Should be wrapped by N_() for translation.
78 * `flags`::
79 * mask of parse_opt_option_flags.
80 * PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs)
81 * PARSE_OPT_NOARG: says that this option does not take an argument
82 * PARSE_OPT_NONEG: says that this option cannot be negated
83 * PARSE_OPT_HIDDEN: this option is skipped in the default usage, and
84 * shown only in the full usage.
85 * PARSE_OPT_LASTARG_DEFAULT: says that this option will take the default
86 * value if no argument is given when the option
87 * is last on the command line. If the option is
88 * not last it will require an argument.
89 * Should not be used with PARSE_OPT_OPTARG.
90 * PARSE_OPT_NODASH: this option doesn't start with a dash.
91 * PARSE_OPT_LITERAL_ARGHELP: says that argh shouldn't be enclosed in brackets
92 * (i.e. '<argh>') in the help message.
93 * Useful for options with multiple parameters.
94 * PARSE_OPT_NOCOMPLETE: by default all visible options are completable
95 * by git-completion.bash. This option suppresses that.
96 * PARSE_OPT_COMP_ARG: this option forces to git-completion.bash to
97 * complete an option as --name= not --name even if
98 * the option takes optional argument.
100 * `callback`::
101 * pointer to the callback to use for OPTION_CALLBACK or
102 * OPTION_LOWLEVEL_CALLBACK.
104 * `defval`::
105 * default value to fill (*->value) with for PARSE_OPT_OPTARG.
106 * OPTION_{BIT,SET_INT} store the {mask,integer} to put in the value when met.
107 * CALLBACKS can use it like they want.
109 struct option {
110 enum parse_opt_type type;
111 int short_name;
112 const char *long_name;
113 void *value;
114 const char *argh;
115 const char *help;
117 int flags;
118 parse_opt_cb *callback;
119 intptr_t defval;
122 #define OPT_BIT_F(s, l, v, h, b, f) { OPTION_BIT, (s), (l), (v), NULL, (h), \
123 PARSE_OPT_NOARG|(f), NULL, (b) }
124 #define OPT_COUNTUP_F(s, l, v, h, f) { OPTION_COUNTUP, (s), (l), (v), NULL, \
125 (h), PARSE_OPT_NOARG|(f) }
126 #define OPT_SET_INT_F(s, l, v, h, i, f) { OPTION_SET_INT, (s), (l), (v), NULL, \
127 (h), PARSE_OPT_NOARG | (f), NULL, (i) }
128 #define OPT_BOOL_F(s, l, v, h, f) OPT_SET_INT_F(s, l, v, h, 1, f)
130 #define OPT_END() { OPTION_END }
131 #define OPT_ARGUMENT(l, h) { OPTION_ARGUMENT, 0, (l), NULL, NULL, \
132 (h), PARSE_OPT_NOARG}
133 #define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
134 #define OPT_BIT(s, l, v, h, b) OPT_BIT_F(s, l, v, h, b, 0)
135 #define OPT_NEGBIT(s, l, v, h, b) { OPTION_NEGBIT, (s), (l), (v), NULL, \
136 (h), PARSE_OPT_NOARG, NULL, (b) }
137 #define OPT_COUNTUP(s, l, v, h) OPT_COUNTUP_F(s, l, v, h, 0)
138 #define OPT_SET_INT(s, l, v, h, i) OPT_SET_INT_F(s, l, v, h, i, 0)
139 #define OPT_BOOL(s, l, v, h) OPT_BOOL_F(s, l, v, h, 0)
140 #define OPT_HIDDEN_BOOL(s, l, v, h) { OPTION_SET_INT, (s), (l), (v), NULL, \
141 (h), PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, 1}
142 #define OPT_CMDMODE(s, l, v, h, i) { OPTION_CMDMODE, (s), (l), (v), NULL, \
143 (h), PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, (i) }
144 #define OPT_INTEGER(s, l, v, h) { OPTION_INTEGER, (s), (l), (v), N_("n"), (h) }
145 #define OPT_MAGNITUDE(s, l, v, h) { OPTION_MAGNITUDE, (s), (l), (v), \
146 N_("n"), (h), PARSE_OPT_NONEG }
147 #define OPT_STRING(s, l, v, a, h) { OPTION_STRING, (s), (l), (v), (a), (h) }
148 #define OPT_STRING_LIST(s, l, v, a, h) \
149 { OPTION_CALLBACK, (s), (l), (v), (a), \
150 (h), 0, &parse_opt_string_list }
151 #define OPT_UYN(s, l, v, h) { OPTION_CALLBACK, (s), (l), (v), NULL, \
152 (h), PARSE_OPT_NOARG, &parse_opt_tertiary }
153 #define OPT_DATE(s, l, v, h) \
154 { OPTION_CALLBACK, (s), (l), (v), N_("time"),(h), 0, \
155 parse_opt_approxidate_cb }
156 #define OPT_EXPIRY_DATE(s, l, v, h) \
157 { OPTION_CALLBACK, (s), (l), (v), N_("expiry-date"),(h), 0, \
158 parse_opt_expiry_date_cb }
159 #define OPT_CALLBACK(s, l, v, a, h, f) \
160 { OPTION_CALLBACK, (s), (l), (v), (a), (h), 0, (f) }
161 #define OPT_NUMBER_CALLBACK(v, h, f) \
162 { OPTION_NUMBER, 0, NULL, (v), NULL, (h), \
163 PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) }
164 #define OPT_FILENAME(s, l, v, h) { OPTION_FILENAME, (s), (l), (v), \
165 N_("file"), (h) }
166 #define OPT_COLOR_FLAG(s, l, v, h) \
167 { OPTION_CALLBACK, (s), (l), (v), N_("when"), (h), PARSE_OPT_OPTARG, \
168 parse_opt_color_flag_cb, (intptr_t)"always" }
170 #define OPT_NOOP_NOARG(s, l) \
171 { OPTION_CALLBACK, (s), (l), NULL, NULL, \
172 N_("no-op (backward compatibility)"), \
173 PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, parse_opt_noop_cb }
175 /* parse_options() will filter out the processed options and leave the
176 * non-option arguments in argv[]. usagestr strings should be marked
177 * for translation with N_().
178 * Returns the number of arguments left in argv[].
180 extern int parse_options(int argc, const char **argv, const char *prefix,
181 const struct option *options,
182 const char * const usagestr[], int flags);
184 extern NORETURN void usage_with_options(const char * const *usagestr,
185 const struct option *options);
187 extern NORETURN void usage_msg_opt(const char *msg,
188 const char * const *usagestr,
189 const struct option *options);
191 extern int optbug(const struct option *opt, const char *reason);
192 extern int opterror(const struct option *opt, const char *reason, int flags);
193 #if defined(__GNUC__)
194 #define opterror(o,r,f) (opterror((o),(r),(f)), const_error())
195 #endif
197 /*----- incremental advanced APIs -----*/
199 enum {
200 PARSE_OPT_HELP = -1,
201 PARSE_OPT_DONE,
202 PARSE_OPT_NON_OPTION,
203 PARSE_OPT_ERROR,
204 PARSE_OPT_UNKNOWN
208 * It's okay for the caller to consume argv/argc in the usual way.
209 * Other fields of that structure are private to parse-options and should not
210 * be modified in any way.
212 struct parse_opt_ctx_t {
213 const char **argv;
214 const char **out;
215 int argc, cpidx, total;
216 const char *opt;
217 int flags;
218 const char *prefix;
221 extern void parse_options_start(struct parse_opt_ctx_t *ctx,
222 int argc, const char **argv, const char *prefix,
223 const struct option *options, int flags);
225 extern int parse_options_step(struct parse_opt_ctx_t *ctx,
226 const struct option *options,
227 const char * const usagestr[]);
229 extern int parse_options_end(struct parse_opt_ctx_t *ctx);
231 extern struct option *parse_options_concat(struct option *a, struct option *b);
233 /*----- some often used options -----*/
234 extern int parse_opt_abbrev_cb(const struct option *, const char *, int);
235 extern int parse_opt_approxidate_cb(const struct option *, const char *, int);
236 extern int parse_opt_expiry_date_cb(const struct option *, const char *, int);
237 extern int parse_opt_color_flag_cb(const struct option *, const char *, int);
238 extern int parse_opt_verbosity_cb(const struct option *, const char *, int);
239 extern int parse_opt_object_name(const struct option *, const char *, int);
240 extern int parse_opt_commits(const struct option *, const char *, int);
241 extern int parse_opt_tertiary(const struct option *, const char *, int);
242 extern int parse_opt_string_list(const struct option *, const char *, int);
243 extern int parse_opt_noop_cb(const struct option *, const char *, int);
244 extern int parse_opt_unknown_cb(const struct option *, const char *, int);
245 extern int parse_opt_passthru(const struct option *, const char *, int);
246 extern int parse_opt_passthru_argv(const struct option *, const char *, int);
248 #define OPT__VERBOSE(var, h) OPT_COUNTUP('v', "verbose", (var), (h))
249 #define OPT__QUIET(var, h) OPT_COUNTUP('q', "quiet", (var), (h))
250 #define OPT__VERBOSITY(var) \
251 { OPTION_CALLBACK, 'v', "verbose", (var), NULL, N_("be more verbose"), \
252 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
253 { OPTION_CALLBACK, 'q', "quiet", (var), NULL, N_("be more quiet"), \
254 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
255 #define OPT__DRY_RUN(var, h) OPT_BOOL('n', "dry-run", (var), (h))
256 #define OPT__FORCE(var, h, f) OPT_COUNTUP_F('f', "force", (var), (h), (f))
257 #define OPT__ABBREV(var) \
258 { OPTION_CALLBACK, 0, "abbrev", (var), N_("n"), \
259 N_("use <n> digits to display SHA-1s"), \
260 PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
261 #define OPT__COLOR(var, h) \
262 OPT_COLOR_FLAG(0, "color", (var), (h))
263 #define OPT_COLUMN(s, l, v, h) \
264 { OPTION_CALLBACK, (s), (l), (v), N_("style"), (h), PARSE_OPT_OPTARG, parseopt_column_callback }
265 #define OPT_PASSTHRU(s, l, v, a, h, f) \
266 { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru }
267 #define OPT_PASSTHRU_ARGV(s, l, v, a, h, f) \
268 { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru_argv }
269 #define _OPT_CONTAINS_OR_WITH(name, variable, help, flag) \
270 { OPTION_CALLBACK, 0, name, (variable), N_("commit"), (help), \
271 PARSE_OPT_LASTARG_DEFAULT | flag, \
272 parse_opt_commits, (intptr_t) "HEAD" \
274 #define OPT_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("contains", v, h, PARSE_OPT_NONEG)
275 #define OPT_NO_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("no-contains", v, h, PARSE_OPT_NONEG)
276 #define OPT_WITH(v, h) _OPT_CONTAINS_OR_WITH("with", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
277 #define OPT_WITHOUT(v, h) _OPT_CONTAINS_OR_WITH("without", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
279 #endif