]>
Commit | Line | Data |
---|---|---|
4a59fd13 PH |
1 | #ifndef PARSE_OPTIONS_H |
2 | #define PARSE_OPTIONS_H | |
3 | ||
4 | enum 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, |
b04ba2bb | 13 | OPTION_COUNTUP, |
db7244bd PH |
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, |
b0b3a8b6 | 20 | OPTION_LOWLEVEL_CALLBACK, |
df217ed6 | 21 | OPTION_FILENAME |
4a59fd13 PH |
22 | }; |
23 | ||
b04ba2bb JH |
24 | /* Deprecated synonym */ |
25 | #define OPTION_BOOLEAN OPTION_COUNTUP | |
26 | ||
4a59fd13 PH |
27 | enum parse_opt_flags { |
28 | PARSE_OPT_KEEP_DASHDASH = 1, | |
a0ec9d25 | 29 | PARSE_OPT_STOP_AT_NON_OPTION = 2, |
a32a4eaa | 30 | PARSE_OPT_KEEP_ARGV0 = 4, |
b5ce3a54 | 31 | PARSE_OPT_KEEP_UNKNOWN = 8, |
4b05548f | 32 | PARSE_OPT_NO_INTERNAL_HELP = 16 |
4a59fd13 PH |
33 | }; |
34 | ||
ffe659f9 PH |
35 | enum parse_opt_option_flags { |
36 | PARSE_OPT_OPTARG = 1, | |
f481e22a | 37 | PARSE_OPT_NOARG = 2, |
db7244bd | 38 | PARSE_OPT_NONEG = 4, |
dd3bf0f4 | 39 | PARSE_OPT_HIDDEN = 8, |
1cc6985c | 40 | PARSE_OPT_LASTARG_DEFAULT = 16, |
51a9949e | 41 | PARSE_OPT_NODASH = 32, |
29f25d49 | 42 | PARSE_OPT_LITERAL_ARGHELP = 64, |
47e9cd28 | 43 | PARSE_OPT_SHELL_EVAL = 256 |
ffe659f9 PH |
44 | }; |
45 | ||
46 | struct option; | |
47 | typedef int parse_opt_cb(const struct option *, const char *arg, int unset); | |
48 | ||
b0b3a8b6 JN |
49 | struct parse_opt_ctx_t; |
50 | typedef int parse_opt_ll_cb(struct parse_opt_ctx_t *ctx, | |
51 | const struct option *opt, int unset); | |
52 | ||
9b3beb58 PH |
53 | /* |
54 | * `type`:: | |
55 | * holds the type of the option, you must have an OPTION_END last in your | |
56 | * array. | |
57 | * | |
58 | * `short_name`:: | |
59 | * the character to use as a short option name, '\0' if none. | |
60 | * | |
61 | * `long_name`:: | |
62 | * the long option name, without the leading dashes, NULL if none. | |
63 | * | |
64 | * `value`:: | |
65 | * stores pointers to the values to be filled. | |
66 | * | |
67 | * `argh`:: | |
68 | * token to explain the kind of argument this option wants. Keep it | |
54e6dc7d NTND |
69 | * homogeneous across the repository. Should be wrapped by N_() for |
70 | * translation. | |
9b3beb58 PH |
71 | * |
72 | * `help`:: | |
73 | * the short help associated to what the option does. | |
74 | * Must never be NULL (except for OPTION_END). | |
75 | * OPTION_GROUP uses this pointer to store the group header. | |
54e6dc7d | 76 | * Should be wrapped by N_() for translation. |
9b3beb58 PH |
77 | * |
78 | * `flags`:: | |
79 | * mask of parse_opt_option_flags. | |
3ea3c215 | 80 | * PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs) |
ef45e4da | 81 | * PARSE_OPT_NOARG: says that this option does not take an argument |
db7244bd | 82 | * PARSE_OPT_NONEG: says that this option cannot be negated |
51a9949e RS |
83 | * PARSE_OPT_HIDDEN: this option is skipped in the default usage, and |
84 | * shown only in the full usage. | |
e169b974 SB |
85 | * PARSE_OPT_LASTARG_DEFAULT: says that this option will take the default |
86 | * value if no argument is given when the option | |
87 | * is last on the command line. If the option is | |
88 | * not last it will require an argument. | |
89 | * Should not be used with PARSE_OPT_OPTARG. | |
51a9949e | 90 | * PARSE_OPT_NODASH: this option doesn't start with a dash. |
29f25d49 SB |
91 | * PARSE_OPT_LITERAL_ARGHELP: says that argh shouldn't be enclosed in brackets |
92 | * (i.e. '<argh>') in the help message. | |
93 | * Useful for options with multiple parameters. | |
9b3beb58 PH |
94 | * |
95 | * `callback`:: | |
b0b3a8b6 JN |
96 | * pointer to the callback to use for OPTION_CALLBACK or |
97 | * OPTION_LOWLEVEL_CALLBACK. | |
9b3beb58 PH |
98 | * |
99 | * `defval`:: | |
100 | * default value to fill (*->value) with for PARSE_OPT_OPTARG. | |
db7244bd PH |
101 | * OPTION_{BIT,SET_INT,SET_PTR} store the {mask,integer,pointer} to put in |
102 | * the value when met. | |
9b3beb58 PH |
103 | * CALLBACKS can use it like they want. |
104 | */ | |
4a59fd13 PH |
105 | struct option { |
106 | enum parse_opt_type type; | |
107 | int short_name; | |
108 | const char *long_name; | |
109 | void *value; | |
d7a38c54 PH |
110 | const char *argh; |
111 | const char *help; | |
ffe659f9 PH |
112 | |
113 | int flags; | |
114 | parse_opt_cb *callback; | |
ffe659f9 | 115 | intptr_t defval; |
4a59fd13 PH |
116 | }; |
117 | ||
118 | #define OPT_END() { OPTION_END } | |
34aec9f5 SB |
119 | #define OPT_ARGUMENT(l, h) { OPTION_ARGUMENT, 0, (l), NULL, NULL, \ |
120 | (h), PARSE_OPT_NOARG} | |
d7a38c54 | 121 | #define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) } |
34aec9f5 SB |
122 | #define OPT_BIT(s, l, v, h, b) { OPTION_BIT, (s), (l), (v), NULL, (h), \ |
123 | PARSE_OPT_NOARG, NULL, (b) } | |
124 | #define OPT_NEGBIT(s, l, v, h, b) { OPTION_NEGBIT, (s), (l), (v), NULL, \ | |
125 | (h), PARSE_OPT_NOARG, NULL, (b) } | |
b04ba2bb | 126 | #define OPT_COUNTUP(s, l, v, h) { OPTION_COUNTUP, (s), (l), (v), NULL, \ |
34aec9f5 SB |
127 | (h), PARSE_OPT_NOARG } |
128 | #define OPT_SET_INT(s, l, v, h, i) { OPTION_SET_INT, (s), (l), (v), NULL, \ | |
129 | (h), PARSE_OPT_NOARG, NULL, (i) } | |
b04ba2bb | 130 | #define OPT_BOOL(s, l, v, h) OPT_SET_INT(s, l, v, h, 1) |
34aec9f5 SB |
131 | #define OPT_SET_PTR(s, l, v, h, p) { OPTION_SET_PTR, (s), (l), (v), NULL, \ |
132 | (h), PARSE_OPT_NOARG, NULL, (p) } | |
54e6dc7d | 133 | #define OPT_INTEGER(s, l, v, h) { OPTION_INTEGER, (s), (l), (v), N_("n"), (h) } |
d7a38c54 | 134 | #define OPT_STRING(s, l, v, a, h) { OPTION_STRING, (s), (l), (v), (a), (h) } |
c8ba1639 JK |
135 | #define OPT_STRING_LIST(s, l, v, a, h) \ |
136 | { OPTION_CALLBACK, (s), (l), (v), (a), \ | |
137 | (h), 0, &parse_opt_string_list } | |
cb6020bb JH |
138 | #define OPT_UYN(s, l, v, h) { OPTION_CALLBACK, (s), (l), (v), NULL, \ |
139 | (h), PARSE_OPT_NOARG, &parse_opt_tertiary } | |
1f4a711a | 140 | #define OPT_DATE(s, l, v, h) \ |
54e6dc7d | 141 | { OPTION_CALLBACK, (s), (l), (v), N_("time"),(h), 0, \ |
1f4a711a | 142 | parse_opt_approxidate_cb } |
ffe659f9 PH |
143 | #define OPT_CALLBACK(s, l, v, a, h, f) \ |
144 | { OPTION_CALLBACK, (s), (l), (v), (a), (h), 0, (f) } | |
e0319ff5 RS |
145 | #define OPT_NUMBER_CALLBACK(v, h, f) \ |
146 | { OPTION_NUMBER, 0, NULL, (v), NULL, (h), \ | |
147 | PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) } | |
df217ed6 | 148 | #define OPT_FILENAME(s, l, v, h) { OPTION_FILENAME, (s), (l), (v), \ |
54e6dc7d | 149 | N_("file"), (h) } |
73e9da01 | 150 | #define OPT_COLOR_FLAG(s, l, v, h) \ |
54e6dc7d | 151 | { OPTION_CALLBACK, (s), (l), (v), N_("when"), (h), PARSE_OPT_OPTARG, \ |
73e9da01 ML |
152 | parse_opt_color_flag_cb, (intptr_t)"always" } |
153 | ||
6acec038 RS |
154 | #define OPT_NOOP_NOARG(s, l) \ |
155 | { OPTION_CALLBACK, (s), (l), NULL, NULL, \ | |
54e6dc7d | 156 | N_("no-op (backward compatibility)"), \ |
6acec038 RS |
157 | PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, parse_opt_noop_cb } |
158 | ||
b04ba2bb JH |
159 | /* Deprecated synonym */ |
160 | #define OPT_BOOLEAN OPT_COUNTUP | |
4a59fd13 PH |
161 | |
162 | /* parse_options() will filter out the processed options and leave the | |
54e6dc7d NTND |
163 | * non-option arguments in argv[]. usagestr strings should be marked |
164 | * for translation with N_(). | |
4a59fd13 PH |
165 | * Returns the number of arguments left in argv[]. |
166 | */ | |
37782920 | 167 | extern int parse_options(int argc, const char **argv, const char *prefix, |
4a59fd13 | 168 | const struct option *options, |
d7a38c54 PH |
169 | const char * const usagestr[], int flags); |
170 | ||
171 | extern NORETURN void usage_with_options(const char * const *usagestr, | |
172 | const struct option *options); | |
4a59fd13 | 173 | |
451bb210 CC |
174 | extern NORETURN void usage_msg_opt(const char *msg, |
175 | const char * const *usagestr, | |
176 | const struct option *options); | |
177 | ||
1f275b7c DI |
178 | extern int optbug(const struct option *opt, const char *reason); |
179 | extern int opterror(const struct option *opt, const char *reason, int flags); | |
3ea3c215 | 180 | /*----- incremental advanced APIs -----*/ |
7e7bbcb4 | 181 | |
ee68b87a PH |
182 | enum { |
183 | PARSE_OPT_HELP = -1, | |
184 | PARSE_OPT_DONE, | |
979240fe | 185 | PARSE_OPT_NON_OPTION, |
4b05548f | 186 | PARSE_OPT_UNKNOWN |
ee68b87a PH |
187 | }; |
188 | ||
26141b5b PH |
189 | /* |
190 | * It's okay for the caller to consume argv/argc in the usual way. | |
191 | * Other fields of that structure are private to parse-options and should not | |
192 | * be modified in any way. | |
193 | */ | |
7e7bbcb4 PH |
194 | struct parse_opt_ctx_t { |
195 | const char **argv; | |
196 | const char **out; | |
197 | int argc, cpidx; | |
198 | const char *opt; | |
199 | int flags; | |
37782920 | 200 | const char *prefix; |
7e7bbcb4 PH |
201 | }; |
202 | ||
203 | extern void parse_options_start(struct parse_opt_ctx_t *ctx, | |
37782920 | 204 | int argc, const char **argv, const char *prefix, |
9ca1169f | 205 | const struct option *options, int flags); |
7e7bbcb4 | 206 | |
ff43ec3e PH |
207 | extern int parse_options_step(struct parse_opt_ctx_t *ctx, |
208 | const struct option *options, | |
209 | const char * const usagestr[]); | |
210 | ||
7e7bbcb4 PH |
211 | extern int parse_options_end(struct parse_opt_ctx_t *ctx); |
212 | ||
8b74d75c | 213 | extern int parse_options_concat(struct option *dst, size_t, struct option *src); |
7e7bbcb4 | 214 | |
0ce865b1 PH |
215 | /*----- some often used options -----*/ |
216 | extern int parse_opt_abbrev_cb(const struct option *, const char *, int); | |
1f4a711a | 217 | extern int parse_opt_approxidate_cb(const struct option *, const char *, int); |
73e9da01 | 218 | extern int parse_opt_color_flag_cb(const struct option *, const char *, int); |
7f87aff2 | 219 | extern int parse_opt_verbosity_cb(const struct option *, const char *, int); |
269defdf | 220 | extern int parse_opt_with_commit(const struct option *, const char *, int); |
cb6020bb | 221 | extern int parse_opt_tertiary(const struct option *, const char *, int); |
c8ba1639 | 222 | extern int parse_opt_string_list(const struct option *, const char *, int); |
6acec038 | 223 | extern int parse_opt_noop_cb(const struct option *, const char *, int); |
0ce865b1 | 224 | |
fd03881a | 225 | #define OPT__VERBOSE(var, h) OPT_BOOLEAN('v', "verbose", (var), (h)) |
d52ee6e6 | 226 | #define OPT__QUIET(var, h) OPT_BOOLEAN('q', "quiet", (var), (h)) |
7f87aff2 | 227 | #define OPT__VERBOSITY(var) \ |
54e6dc7d | 228 | { OPTION_CALLBACK, 'v', "verbose", (var), NULL, N_("be more verbose"), \ |
7f87aff2 | 229 | PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \ |
54e6dc7d | 230 | { OPTION_CALLBACK, 'q', "quiet", (var), NULL, N_("be more quiet"), \ |
7f87aff2 | 231 | PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 } |
e21adb8c | 232 | #define OPT__DRY_RUN(var, h) OPT_BOOLEAN('n', "dry-run", (var), (h)) |
76946b76 | 233 | #define OPT__FORCE(var, h) OPT_BOOLEAN('f', "force", (var), (h)) |
0ce865b1 | 234 | #define OPT__ABBREV(var) \ |
54e6dc7d NTND |
235 | { OPTION_CALLBACK, 0, "abbrev", (var), N_("n"), \ |
236 | N_("use <n> digits to display SHA-1s"), \ | |
0ce865b1 | 237 | PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 } |
73e9da01 ML |
238 | #define OPT__COLOR(var, h) \ |
239 | OPT_COLOR_FLAG(0, "color", (var), (h)) | |
7e29b825 | 240 | #define OPT_COLUMN(s, l, v, h) \ |
a054e049 | 241 | { OPTION_CALLBACK, (s), (l), (v), N_("style"), (h), PARSE_OPT_OPTARG, parseopt_column_callback } |
0ce865b1 | 242 | |
4a59fd13 | 243 | #endif |