Merge branch 'esr/maint-doc-fast-import'
[git.git] / parse-options.h
blob71a39c60d942601a1cf30e218df56777742d5580
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_SET_PTR,
16 /* options with arguments (usually) */
17 OPTION_STRING,
18 OPTION_INTEGER,
19 OPTION_CALLBACK,
20 OPTION_LOWLEVEL_CALLBACK,
21 OPTION_FILENAME
24 /* Deprecated synonym */
25 #define OPTION_BOOLEAN OPTION_COUNTUP
27 enum parse_opt_flags {
28 PARSE_OPT_KEEP_DASHDASH = 1,
29 PARSE_OPT_STOP_AT_NON_OPTION = 2,
30 PARSE_OPT_KEEP_ARGV0 = 4,
31 PARSE_OPT_KEEP_UNKNOWN = 8,
32 PARSE_OPT_NO_INTERNAL_HELP = 16
35 enum parse_opt_option_flags {
36 PARSE_OPT_OPTARG = 1,
37 PARSE_OPT_NOARG = 2,
38 PARSE_OPT_NONEG = 4,
39 PARSE_OPT_HIDDEN = 8,
40 PARSE_OPT_LASTARG_DEFAULT = 16,
41 PARSE_OPT_NODASH = 32,
42 PARSE_OPT_LITERAL_ARGHELP = 64,
43 PARSE_OPT_SHELL_EVAL = 256
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.
95 * `callback`::
96 * pointer to the callback to use for OPTION_CALLBACK or
97 * OPTION_LOWLEVEL_CALLBACK.
99 * `defval`::
100 * default value to fill (*->value) with for PARSE_OPT_OPTARG.
101 * OPTION_{BIT,SET_INT,SET_PTR} store the {mask,integer,pointer} to put in
102 * the value when met.
103 * CALLBACKS can use it like they want.
105 struct option {
106 enum parse_opt_type type;
107 int short_name;
108 const char *long_name;
109 void *value;
110 const char *argh;
111 const char *help;
113 int flags;
114 parse_opt_cb *callback;
115 intptr_t defval;
118 #define OPT_END() { OPTION_END }
119 #define OPT_ARGUMENT(l, h) { OPTION_ARGUMENT, 0, (l), NULL, NULL, \
120 (h), PARSE_OPT_NOARG}
121 #define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
122 #define OPT_BIT(s, l, v, h, b) { OPTION_BIT, (s), (l), (v), NULL, (h), \
123 PARSE_OPT_NOARG, NULL, (b) }
124 #define OPT_NEGBIT(s, l, v, h, b) { OPTION_NEGBIT, (s), (l), (v), NULL, \
125 (h), PARSE_OPT_NOARG, NULL, (b) }
126 #define OPT_COUNTUP(s, l, v, h) { OPTION_COUNTUP, (s), (l), (v), NULL, \
127 (h), PARSE_OPT_NOARG }
128 #define OPT_SET_INT(s, l, v, h, i) { OPTION_SET_INT, (s), (l), (v), NULL, \
129 (h), PARSE_OPT_NOARG, NULL, (i) }
130 #define OPT_BOOL(s, l, v, h) OPT_SET_INT(s, l, v, h, 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_INTEGER(s, l, v, h) { OPTION_INTEGER, (s), (l), (v), N_("n"), (h) }
134 #define OPT_STRING(s, l, v, a, h) { OPTION_STRING, (s), (l), (v), (a), (h) }
135 #define OPT_STRING_LIST(s, l, v, a, h) \
136 { OPTION_CALLBACK, (s), (l), (v), (a), \
137 (h), 0, &parse_opt_string_list }
138 #define OPT_UYN(s, l, v, h) { OPTION_CALLBACK, (s), (l), (v), NULL, \
139 (h), PARSE_OPT_NOARG, &parse_opt_tertiary }
140 #define OPT_DATE(s, l, v, h) \
141 { OPTION_CALLBACK, (s), (l), (v), N_("time"),(h), 0, \
142 parse_opt_approxidate_cb }
143 #define OPT_CALLBACK(s, l, v, a, h, f) \
144 { OPTION_CALLBACK, (s), (l), (v), (a), (h), 0, (f) }
145 #define OPT_NUMBER_CALLBACK(v, h, f) \
146 { OPTION_NUMBER, 0, NULL, (v), NULL, (h), \
147 PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) }
148 #define OPT_FILENAME(s, l, v, h) { OPTION_FILENAME, (s), (l), (v), \
149 N_("file"), (h) }
150 #define OPT_COLOR_FLAG(s, l, v, h) \
151 { OPTION_CALLBACK, (s), (l), (v), N_("when"), (h), PARSE_OPT_OPTARG, \
152 parse_opt_color_flag_cb, (intptr_t)"always" }
154 #define OPT_NOOP_NOARG(s, l) \
155 { OPTION_CALLBACK, (s), (l), NULL, NULL, \
156 N_("no-op (backward compatibility)"), \
157 PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, parse_opt_noop_cb }
159 /* Deprecated synonym */
160 #define OPT_BOOLEAN OPT_COUNTUP
162 /* parse_options() will filter out the processed options and leave the
163 * non-option arguments in argv[]. usagestr strings should be marked
164 * for translation with N_().
165 * Returns the number of arguments left in argv[].
167 extern int parse_options(int argc, const char **argv, const char *prefix,
168 const struct option *options,
169 const char * const usagestr[], int flags);
171 extern NORETURN void usage_with_options(const char * const *usagestr,
172 const struct option *options);
174 extern NORETURN void usage_msg_opt(const char *msg,
175 const char * const *usagestr,
176 const struct option *options);
178 extern int optbug(const struct option *opt, const char *reason);
179 extern int opterror(const struct option *opt, const char *reason, int flags);
180 /*----- incremental advanced APIs -----*/
182 enum {
183 PARSE_OPT_HELP = -1,
184 PARSE_OPT_DONE,
185 PARSE_OPT_NON_OPTION,
186 PARSE_OPT_UNKNOWN
190 * It's okay for the caller to consume argv/argc in the usual way.
191 * Other fields of that structure are private to parse-options and should not
192 * be modified in any way.
194 struct parse_opt_ctx_t {
195 const char **argv;
196 const char **out;
197 int argc, cpidx;
198 const char *opt;
199 int flags;
200 const char *prefix;
203 extern void parse_options_start(struct parse_opt_ctx_t *ctx,
204 int argc, const char **argv, const char *prefix,
205 const struct option *options, int flags);
207 extern int parse_options_step(struct parse_opt_ctx_t *ctx,
208 const struct option *options,
209 const char * const usagestr[]);
211 extern int parse_options_end(struct parse_opt_ctx_t *ctx);
213 extern int parse_options_concat(struct option *dst, size_t, struct option *src);
215 /*----- some often used options -----*/
216 extern int parse_opt_abbrev_cb(const struct option *, const char *, int);
217 extern int parse_opt_approxidate_cb(const struct option *, const char *, int);
218 extern int parse_opt_color_flag_cb(const struct option *, const char *, int);
219 extern int parse_opt_verbosity_cb(const struct option *, const char *, int);
220 extern int parse_opt_with_commit(const struct option *, const char *, int);
221 extern int parse_opt_tertiary(const struct option *, const char *, int);
222 extern int parse_opt_string_list(const struct option *, const char *, int);
223 extern int parse_opt_noop_cb(const struct option *, const char *, int);
225 #define OPT__VERBOSE(var, h) OPT_BOOLEAN('v', "verbose", (var), (h))
226 #define OPT__QUIET(var, h) OPT_BOOLEAN('q', "quiet", (var), (h))
227 #define OPT__VERBOSITY(var) \
228 { OPTION_CALLBACK, 'v', "verbose", (var), NULL, N_("be more verbose"), \
229 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
230 { OPTION_CALLBACK, 'q', "quiet", (var), NULL, N_("be more quiet"), \
231 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
232 #define OPT__DRY_RUN(var, h) OPT_BOOLEAN('n', "dry-run", (var), (h))
233 #define OPT__FORCE(var, h) OPT_BOOLEAN('f', "force", (var), (h))
234 #define OPT__ABBREV(var) \
235 { OPTION_CALLBACK, 0, "abbrev", (var), N_("n"), \
236 N_("use <n> digits to display SHA-1s"), \
237 PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
238 #define OPT__COLOR(var, h) \
239 OPT_COLOR_FLAG(0, "color", (var), (h))
240 #define OPT_COLUMN(s, l, v, h) \
241 { OPTION_CALLBACK, (s), (l), (v), N_("style"), (h), PARSE_OPT_OPTARG, parseopt_column_callback }
243 #endif