git.1: switch homepage for stats
[git.git] / parse-options.h
blob3189676695bc173cf6475445cfb6365d08a37906
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_CALLBACK,
20 OPTION_LOWLEVEL_CALLBACK,
21 OPTION_FILENAME
24 enum parse_opt_flags {
25 PARSE_OPT_KEEP_DASHDASH = 1,
26 PARSE_OPT_STOP_AT_NON_OPTION = 2,
27 PARSE_OPT_KEEP_ARGV0 = 4,
28 PARSE_OPT_KEEP_UNKNOWN = 8,
29 PARSE_OPT_NO_INTERNAL_HELP = 16
32 enum parse_opt_option_flags {
33 PARSE_OPT_OPTARG = 1,
34 PARSE_OPT_NOARG = 2,
35 PARSE_OPT_NONEG = 4,
36 PARSE_OPT_HIDDEN = 8,
37 PARSE_OPT_LASTARG_DEFAULT = 16,
38 PARSE_OPT_NODASH = 32,
39 PARSE_OPT_LITERAL_ARGHELP = 64,
40 PARSE_OPT_SHELL_EVAL = 256
43 struct option;
44 typedef int parse_opt_cb(const struct option *, const char *arg, int unset);
46 struct parse_opt_ctx_t;
47 typedef int parse_opt_ll_cb(struct parse_opt_ctx_t *ctx,
48 const struct option *opt, int unset);
51 * `type`::
52 * holds the type of the option, you must have an OPTION_END last in your
53 * array.
55 * `short_name`::
56 * the character to use as a short option name, '\0' if none.
58 * `long_name`::
59 * the long option name, without the leading dashes, NULL if none.
61 * `value`::
62 * stores pointers to the values to be filled.
64 * `argh`::
65 * token to explain the kind of argument this option wants. Keep it
66 * homogeneous across the repository. Should be wrapped by N_() for
67 * translation.
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 * Should be wrapped by N_() for translation.
75 * `flags`::
76 * mask of parse_opt_option_flags.
77 * PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs)
78 * PARSE_OPT_NOARG: says that this option does not take an argument
79 * PARSE_OPT_NONEG: says that this option cannot be negated
80 * PARSE_OPT_HIDDEN: this option is skipped in the default usage, and
81 * shown only in the full usage.
82 * PARSE_OPT_LASTARG_DEFAULT: says that this option will take the default
83 * value if no argument is given when the option
84 * is last on the command line. If the option is
85 * not last it will require an argument.
86 * Should not be used with PARSE_OPT_OPTARG.
87 * PARSE_OPT_NODASH: this option doesn't start with a dash.
88 * PARSE_OPT_LITERAL_ARGHELP: says that argh shouldn't be enclosed in brackets
89 * (i.e. '<argh>') in the help message.
90 * Useful for options with multiple parameters.
92 * `callback`::
93 * pointer to the callback to use for OPTION_CALLBACK or
94 * OPTION_LOWLEVEL_CALLBACK.
96 * `defval`::
97 * default value to fill (*->value) with for PARSE_OPT_OPTARG.
98 * OPTION_{BIT,SET_INT} store the {mask,integer,pointer} to put in
99 * the value when met.
100 * CALLBACKS can use it like they want.
102 struct option {
103 enum parse_opt_type type;
104 int short_name;
105 const char *long_name;
106 void *value;
107 const char *argh;
108 const char *help;
110 int flags;
111 parse_opt_cb *callback;
112 intptr_t defval;
115 #define OPT_END() { OPTION_END }
116 #define OPT_ARGUMENT(l, h) { OPTION_ARGUMENT, 0, (l), NULL, NULL, \
117 (h), PARSE_OPT_NOARG}
118 #define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
119 #define OPT_BIT(s, l, v, h, b) { OPTION_BIT, (s), (l), (v), NULL, (h), \
120 PARSE_OPT_NOARG, NULL, (b) }
121 #define OPT_NEGBIT(s, l, v, h, b) { OPTION_NEGBIT, (s), (l), (v), NULL, \
122 (h), PARSE_OPT_NOARG, NULL, (b) }
123 #define OPT_COUNTUP(s, l, v, h) { OPTION_COUNTUP, (s), (l), (v), NULL, \
124 (h), PARSE_OPT_NOARG }
125 #define OPT_SET_INT(s, l, v, h, i) { OPTION_SET_INT, (s), (l), (v), NULL, \
126 (h), PARSE_OPT_NOARG, NULL, (i) }
127 #define OPT_BOOL(s, l, v, h) OPT_SET_INT(s, l, v, h, 1)
128 #define OPT_HIDDEN_BOOL(s, l, v, h) { OPTION_SET_INT, (s), (l), (v), NULL, \
129 (h), PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, 1}
130 #define OPT_CMDMODE(s, l, v, h, i) { OPTION_CMDMODE, (s), (l), (v), NULL, \
131 (h), PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, (i) }
132 #define OPT_INTEGER(s, l, v, h) { OPTION_INTEGER, (s), (l), (v), N_("n"), (h) }
133 #define OPT_STRING(s, l, v, a, h) { OPTION_STRING, (s), (l), (v), (a), (h) }
134 #define OPT_STRING_LIST(s, l, v, a, h) \
135 { OPTION_CALLBACK, (s), (l), (v), (a), \
136 (h), 0, &parse_opt_string_list }
137 #define OPT_UYN(s, l, v, h) { OPTION_CALLBACK, (s), (l), (v), NULL, \
138 (h), PARSE_OPT_NOARG, &parse_opt_tertiary }
139 #define OPT_DATE(s, l, v, h) \
140 { OPTION_CALLBACK, (s), (l), (v), N_("time"),(h), 0, \
141 parse_opt_approxidate_cb }
142 #define OPT_EXPIRY_DATE(s, l, v, h) \
143 { OPTION_CALLBACK, (s), (l), (v), N_("expiry-date"),(h), 0, \
144 parse_opt_expiry_date_cb }
145 #define OPT_CALLBACK(s, l, v, a, h, f) \
146 { OPTION_CALLBACK, (s), (l), (v), (a), (h), 0, (f) }
147 #define OPT_NUMBER_CALLBACK(v, h, f) \
148 { OPTION_NUMBER, 0, NULL, (v), NULL, (h), \
149 PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) }
150 #define OPT_FILENAME(s, l, v, h) { OPTION_FILENAME, (s), (l), (v), \
151 N_("file"), (h) }
152 #define OPT_COLOR_FLAG(s, l, v, h) \
153 { OPTION_CALLBACK, (s), (l), (v), N_("when"), (h), PARSE_OPT_OPTARG, \
154 parse_opt_color_flag_cb, (intptr_t)"always" }
156 #define OPT_NOOP_NOARG(s, l) \
157 { OPTION_CALLBACK, (s), (l), NULL, NULL, \
158 N_("no-op (backward compatibility)"), \
159 PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, parse_opt_noop_cb }
161 /* parse_options() will filter out the processed options and leave the
162 * non-option arguments in argv[]. usagestr strings should be marked
163 * for translation with N_().
164 * Returns the number of arguments left in argv[].
166 extern int parse_options(int argc, const char **argv, const char *prefix,
167 const struct option *options,
168 const char * const usagestr[], int flags);
170 extern NORETURN void usage_with_options(const char * const *usagestr,
171 const struct option *options);
173 extern NORETURN void usage_msg_opt(const char *msg,
174 const char * const *usagestr,
175 const struct option *options);
177 extern int optbug(const struct option *opt, const char *reason);
178 extern int opterror(const struct option *opt, const char *reason, int flags);
179 #if defined(__GNUC__) && ! defined(__clang__)
180 #define opterror(o,r,f) (opterror((o),(r),(f)), -1)
181 #endif
183 /*----- incremental advanced APIs -----*/
185 enum {
186 PARSE_OPT_HELP = -1,
187 PARSE_OPT_DONE,
188 PARSE_OPT_NON_OPTION,
189 PARSE_OPT_UNKNOWN
193 * It's okay for the caller to consume argv/argc in the usual way.
194 * Other fields of that structure are private to parse-options and should not
195 * be modified in any way.
197 struct parse_opt_ctx_t {
198 const char **argv;
199 const char **out;
200 int argc, cpidx;
201 const char *opt;
202 int flags;
203 const char *prefix;
206 extern void parse_options_start(struct parse_opt_ctx_t *ctx,
207 int argc, const char **argv, const char *prefix,
208 const struct option *options, int flags);
210 extern int parse_options_step(struct parse_opt_ctx_t *ctx,
211 const struct option *options,
212 const char * const usagestr[]);
214 extern int parse_options_end(struct parse_opt_ctx_t *ctx);
216 extern int parse_options_concat(struct option *dst, size_t, struct option *src);
218 /*----- some often used options -----*/
219 extern int parse_opt_abbrev_cb(const struct option *, const char *, int);
220 extern int parse_opt_approxidate_cb(const struct option *, const char *, int);
221 extern int parse_opt_expiry_date_cb(const struct option *, const char *, int);
222 extern int parse_opt_color_flag_cb(const struct option *, const char *, int);
223 extern int parse_opt_verbosity_cb(const struct option *, const char *, int);
224 extern int parse_opt_with_commit(const struct option *, const char *, int);
225 extern int parse_opt_tertiary(const struct option *, const char *, int);
226 extern int parse_opt_string_list(const struct option *, const char *, int);
227 extern int parse_opt_noop_cb(const struct option *, const char *, int);
229 #define OPT__VERBOSE(var, h) OPT_COUNTUP('v', "verbose", (var), (h))
230 #define OPT__QUIET(var, h) OPT_COUNTUP('q', "quiet", (var), (h))
231 #define OPT__VERBOSITY(var) \
232 { OPTION_CALLBACK, 'v', "verbose", (var), NULL, N_("be more verbose"), \
233 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
234 { OPTION_CALLBACK, 'q', "quiet", (var), NULL, N_("be more quiet"), \
235 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
236 #define OPT__DRY_RUN(var, h) OPT_BOOL('n', "dry-run", (var), (h))
237 #define OPT__FORCE(var, h) OPT_COUNTUP('f', "force", (var), (h))
238 #define OPT__ABBREV(var) \
239 { OPTION_CALLBACK, 0, "abbrev", (var), N_("n"), \
240 N_("use <n> digits to display SHA-1s"), \
241 PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
242 #define OPT__COLOR(var, h) \
243 OPT_COLOR_FLAG(0, "color", (var), (h))
244 #define OPT_COLUMN(s, l, v, h) \
245 { OPTION_CALLBACK, (s), (l), (v), N_("style"), (h), PARSE_OPT_OPTARG, parseopt_column_callback }
247 #endif