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