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