am: Use cat instead of echo to avoid DOS line-endings (fixes t4150)
[git/dscho.git] / parse-options.h
blobda999f8995ee79865bd4c2f72a1e009502a69926
1 #ifndef PARSE_OPTIONS_H
2 #define PARSE_OPTIONS_H
4 enum parse_opt_type {
5 /* special types */
6 OPTION_END,
7 OPTION_ARGUMENT,
8 OPTION_GROUP,
9 OPTION_NUMBER,
10 /* options with no arguments */
11 OPTION_BIT,
12 OPTION_NEGBIT,
13 OPTION_COUNTUP,
14 OPTION_SET_INT,
15 OPTION_SET_PTR,
16 /* options with arguments (usually) */
17 OPTION_STRING,
18 OPTION_INTEGER,
19 OPTION_CALLBACK,
20 OPTION_LOWLEVEL_CALLBACK,
21 OPTION_FILENAME
24 /* Deprecated synonym */
25 #define OPTION_BOOLEAN OPTION_COUNTUP
27 enum parse_opt_flags {
28 PARSE_OPT_KEEP_DASHDASH = 1,
29 PARSE_OPT_STOP_AT_NON_OPTION = 2,
30 PARSE_OPT_KEEP_ARGV0 = 4,
31 PARSE_OPT_KEEP_UNKNOWN = 8,
32 PARSE_OPT_NO_INTERNAL_HELP = 16
35 enum parse_opt_option_flags {
36 PARSE_OPT_OPTARG = 1,
37 PARSE_OPT_NOARG = 2,
38 PARSE_OPT_NONEG = 4,
39 PARSE_OPT_HIDDEN = 8,
40 PARSE_OPT_LASTARG_DEFAULT = 16,
41 PARSE_OPT_NODASH = 32,
42 PARSE_OPT_LITERAL_ARGHELP = 64,
43 PARSE_OPT_SHELL_EVAL = 256
46 struct option;
47 typedef int parse_opt_cb(const struct option *, const char *arg, int unset);
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);
54 * `type`::
55 * holds the type of the option, you must have an OPTION_END last in your
56 * array.
58 * `short_name`::
59 * the character to use as a short option name, '\0' if none.
61 * `long_name`::
62 * the long option name, without the leading dashes, NULL if none.
64 * `value`::
65 * stores pointers to the values to be filled.
67 * `argh`::
68 * token to explain the kind of argument this option wants. Keep it
69 * homogeneous across the repository.
71 * `help`::
72 * the short help associated to what the option does.
73 * Must never be NULL (except for OPTION_END).
74 * OPTION_GROUP uses this pointer to store the group header.
76 * `flags`::
77 * mask of parse_opt_option_flags.
78 * PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs)
79 * PARSE_OPT_NOARG: says that this option does not take an argument
80 * PARSE_OPT_NONEG: says that this option cannot be negated
81 * PARSE_OPT_HIDDEN: this option is skipped in the default usage, and
82 * shown only in the full usage.
83 * PARSE_OPT_LASTARG_DEFAULT: says that this option will take the default
84 * value if no argument is given when the option
85 * is last on the command line. If the option is
86 * not last it will require an argument.
87 * Should not be used with PARSE_OPT_OPTARG.
88 * PARSE_OPT_NODASH: this option doesn't start with a dash.
89 * PARSE_OPT_LITERAL_ARGHELP: says that argh shouldn't be enclosed in brackets
90 * (i.e. '<argh>') in the help message.
91 * Useful for options with multiple parameters.
93 * `callback`::
94 * pointer to the callback to use for OPTION_CALLBACK or
95 * OPTION_LOWLEVEL_CALLBACK.
97 * `defval`::
98 * default value to fill (*->value) with for PARSE_OPT_OPTARG.
99 * OPTION_{BIT,SET_INT,SET_PTR} store the {mask,integer,pointer} to put in
100 * the value when met.
101 * CALLBACKS can use it like they want.
103 struct option {
104 enum parse_opt_type type;
105 int short_name;
106 const char *long_name;
107 void *value;
108 const char *argh;
109 const char *help;
111 int flags;
112 parse_opt_cb *callback;
113 intptr_t defval;
116 #define OPT_END() { OPTION_END }
117 #define OPT_ARGUMENT(l, h) { OPTION_ARGUMENT, 0, (l), NULL, NULL, \
118 (h), PARSE_OPT_NOARG}
119 #define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
120 #define OPT_BIT(s, l, v, h, b) { OPTION_BIT, (s), (l), (v), NULL, (h), \
121 PARSE_OPT_NOARG, NULL, (b) }
122 #define OPT_NEGBIT(s, l, v, h, b) { OPTION_NEGBIT, (s), (l), (v), NULL, \
123 (h), PARSE_OPT_NOARG, NULL, (b) }
124 #define OPT_COUNTUP(s, l, v, h) { OPTION_COUNTUP, (s), (l), (v), NULL, \
125 (h), PARSE_OPT_NOARG }
126 #define OPT_SET_INT(s, l, v, h, i) { OPTION_SET_INT, (s), (l), (v), NULL, \
127 (h), PARSE_OPT_NOARG, NULL, (i) }
128 #define OPT_BOOL(s, l, v, h) OPT_SET_INT(s, l, v, h, 1)
129 #define OPT_SET_PTR(s, l, v, h, p) { OPTION_SET_PTR, (s), (l), (v), NULL, \
130 (h), PARSE_OPT_NOARG, NULL, (p) }
131 #define OPT_INTEGER(s, l, v, h) { OPTION_INTEGER, (s), (l), (v), "n", (h) }
132 #define OPT_STRING(s, l, v, a, h) { OPTION_STRING, (s), (l), (v), (a), (h) }
133 #define OPT_STRING_LIST(s, l, v, a, h) \
134 { OPTION_CALLBACK, (s), (l), (v), (a), \
135 (h), 0, &parse_opt_string_list }
136 #define OPT_UYN(s, l, v, h) { OPTION_CALLBACK, (s), (l), (v), NULL, \
137 (h), PARSE_OPT_NOARG, &parse_opt_tertiary }
138 #define OPT_DATE(s, l, v, h) \
139 { OPTION_CALLBACK, (s), (l), (v), "time",(h), 0, \
140 parse_opt_approxidate_cb }
141 #define OPT_CALLBACK(s, l, v, a, h, f) \
142 { OPTION_CALLBACK, (s), (l), (v), (a), (h), 0, (f) }
143 #define OPT_NUMBER_CALLBACK(v, h, f) \
144 { OPTION_NUMBER, 0, NULL, (v), NULL, (h), \
145 PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) }
146 #define OPT_FILENAME(s, l, v, h) { OPTION_FILENAME, (s), (l), (v), \
147 "file", (h) }
148 #define OPT_COLOR_FLAG(s, l, v, h) \
149 { OPTION_CALLBACK, (s), (l), (v), "when", (h), PARSE_OPT_OPTARG, \
150 parse_opt_color_flag_cb, (intptr_t)"always" }
152 #define OPT_NOOP_NOARG(s, l) \
153 { OPTION_CALLBACK, (s), (l), NULL, NULL, \
154 "no-op (backward compatibility)", \
155 PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, parse_opt_noop_cb }
157 /* Deprecated synonym */
158 #define OPT_BOOLEAN OPT_COUNTUP
160 /* parse_options() will filter out the processed options and leave the
161 * non-option arguments in argv[].
162 * Returns the number of arguments left in argv[].
164 extern int parse_options(int argc, const char **argv, const char *prefix,
165 const struct option *options,
166 const char * const usagestr[], int flags);
168 extern NORETURN void usage_with_options(const char * const *usagestr,
169 const struct option *options);
171 extern NORETURN void usage_msg_opt(const char *msg,
172 const char * const *usagestr,
173 const struct option *options);
175 extern int optbug(const struct option *opt, const char *reason);
176 extern int opterror(const struct option *opt, const char *reason, int flags);
177 /*----- incremental advanced APIs -----*/
179 enum {
180 PARSE_OPT_HELP = -1,
181 PARSE_OPT_DONE,
182 PARSE_OPT_NON_OPTION,
183 PARSE_OPT_UNKNOWN
187 * It's okay for the caller to consume argv/argc in the usual way.
188 * Other fields of that structure are private to parse-options and should not
189 * be modified in any way.
191 struct parse_opt_ctx_t {
192 const char **argv;
193 const char **out;
194 int argc, cpidx;
195 const char *opt;
196 int flags;
197 const char *prefix;
200 extern void parse_options_start(struct parse_opt_ctx_t *ctx,
201 int argc, const char **argv, const char *prefix,
202 const struct option *options, int flags);
204 extern int parse_options_step(struct parse_opt_ctx_t *ctx,
205 const struct option *options,
206 const char * const usagestr[]);
208 extern int parse_options_end(struct parse_opt_ctx_t *ctx);
210 extern int parse_options_concat(struct option *dst, size_t, struct option *src);
212 /*----- some often used options -----*/
213 extern int parse_opt_abbrev_cb(const struct option *, const char *, int);
214 extern int parse_opt_approxidate_cb(const struct option *, const char *, int);
215 extern int parse_opt_color_flag_cb(const struct option *, const char *, int);
216 extern int parse_opt_verbosity_cb(const struct option *, const char *, int);
217 extern int parse_opt_with_commit(const struct option *, const char *, int);
218 extern int parse_opt_tertiary(const struct option *, const char *, int);
219 extern int parse_opt_string_list(const struct option *, const char *, int);
220 extern int parse_opt_noop_cb(const struct option *, const char *, int);
222 #define OPT__VERBOSE(var, h) OPT_BOOLEAN('v', "verbose", (var), (h))
223 #define OPT__QUIET(var, h) OPT_BOOLEAN('q', "quiet", (var), (h))
224 #define OPT__VERBOSITY(var) \
225 { OPTION_CALLBACK, 'v', "verbose", (var), NULL, "be more verbose", \
226 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
227 { OPTION_CALLBACK, 'q', "quiet", (var), NULL, "be more quiet", \
228 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
229 #define OPT__DRY_RUN(var, h) OPT_BOOLEAN('n', "dry-run", (var), (h))
230 #define OPT__FORCE(var, h) OPT_BOOLEAN('f', "force", (var), (h))
231 #define OPT__ABBREV(var) \
232 { OPTION_CALLBACK, 0, "abbrev", (var), "n", \
233 "use <n> digits to display SHA-1s", \
234 PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
235 #define OPT__COLOR(var, h) \
236 OPT_COLOR_FLAG(0, "color", (var), (h))
237 #define OPT_COLUMN(s, l, v, h) \
238 { OPTION_CALLBACK, (s), (l), (v), "style", (h), PARSE_OPT_OPTARG, parseopt_column_callback }
240 #endif