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