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