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