parse-options.h 11 KB
Newer Older
1 2 3 4
#ifndef PARSE_OPTIONS_H
#define PARSE_OPTIONS_H

enum parse_opt_type {
5
	/* special types */
6
	OPTION_END,
7
	OPTION_ARGUMENT,
8
	OPTION_GROUP,
9
	OPTION_NUMBER,
10 11
	/* options with no arguments */
	OPTION_BIT,
René Scharfe's avatar
René Scharfe committed
12
	OPTION_NEGBIT,
13
	OPTION_COUNTUP,
14
	OPTION_SET_INT,
15
	OPTION_CMDMODE,
16
	/* options with arguments (usually) */
17 18
	OPTION_STRING,
	OPTION_INTEGER,
19
	OPTION_MAGNITUDE,
20
	OPTION_CALLBACK,
21
	OPTION_LOWLEVEL_CALLBACK,
22
	OPTION_FILENAME
23 24 25 26
};

enum parse_opt_flags {
	PARSE_OPT_KEEP_DASHDASH = 1,
27
	PARSE_OPT_STOP_AT_NON_OPTION = 2,
28
	PARSE_OPT_KEEP_ARGV0 = 4,
29
	PARSE_OPT_KEEP_UNKNOWN = 8,
30
	PARSE_OPT_NO_INTERNAL_HELP = 16
31 32
};

33 34
enum parse_opt_option_flags {
	PARSE_OPT_OPTARG  = 1,
35
	PARSE_OPT_NOARG   = 2,
36
	PARSE_OPT_NONEG   = 4,
37
	PARSE_OPT_HIDDEN  = 8,
38
	PARSE_OPT_LASTARG_DEFAULT = 16,
39
	PARSE_OPT_NODASH = 32,
40
	PARSE_OPT_LITERAL_ARGHELP = 64,
41
	PARSE_OPT_SHELL_EVAL = 256,
42 43
	PARSE_OPT_NOCOMPLETE = 512,
	PARSE_OPT_COMP_ARG = 1024
44 45 46 47 48
};

struct option;
typedef int parse_opt_cb(const struct option *, const char *arg, int unset);

49 50 51 52
struct parse_opt_ctx_t;
typedef int parse_opt_ll_cb(struct parse_opt_ctx_t *ctx,
				const struct option *opt, int unset);

53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
/*
 * `type`::
 *   holds the type of the option, you must have an OPTION_END last in your
 *   array.
 *
 * `short_name`::
 *   the character to use as a short option name, '\0' if none.
 *
 * `long_name`::
 *   the long option name, without the leading dashes, NULL if none.
 *
 * `value`::
 *   stores pointers to the values to be filled.
 *
 * `argh`::
 *   token to explain the kind of argument this option wants. Keep it
69 70
 *   homogeneous across the repository. Should be wrapped by N_() for
 *   translation.
71 72 73 74 75
 *
 * `help`::
 *   the short help associated to what the option does.
 *   Must never be NULL (except for OPTION_END).
 *   OPTION_GROUP uses this pointer to store the group header.
76
 *   Should be wrapped by N_() for translation.
77 78 79
 *
 * `flags`::
 *   mask of parse_opt_option_flags.
80
 *   PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs)
81
 *   PARSE_OPT_NOARG: says that this option does not take an argument
82
 *   PARSE_OPT_NONEG: says that this option cannot be negated
83 84
 *   PARSE_OPT_HIDDEN: this option is skipped in the default usage, and
 *                     shown only in the full usage.
85 86 87 88 89
 *   PARSE_OPT_LASTARG_DEFAULT: says that this option will take the default
 *				value if no argument is given when the option
 *				is last on the command line. If the option is
 *				not last it will require an argument.
 *				Should not be used with PARSE_OPT_OPTARG.
90
 *   PARSE_OPT_NODASH: this option doesn't start with a dash.
91 92 93
 *   PARSE_OPT_LITERAL_ARGHELP: says that argh shouldn't be enclosed in brackets
 *				(i.e. '<argh>') in the help message.
 *				Useful for options with multiple parameters.
94 95
 *   PARSE_OPT_NOCOMPLETE: by default all visible options are completable
 *			   by git-completion.bash. This option suppresses that.
96 97 98
 *   PARSE_OPT_COMP_ARG: this option forces to git-completion.bash to
 *			 complete an option as --name= not --name even if
 *			 the option takes optional argument.
99 100
 *
 * `callback`::
101 102
 *   pointer to the callback to use for OPTION_CALLBACK or
 *   OPTION_LOWLEVEL_CALLBACK.
103 104 105
 *
 * `defval`::
 *   default value to fill (*->value) with for PARSE_OPT_OPTARG.
106
 *   OPTION_{BIT,SET_INT} store the {mask,integer} to put in the value when met.
107 108
 *   CALLBACKS can use it like they want.
 */
109 110 111 112 113
struct option {
	enum parse_opt_type type;
	int short_name;
	const char *long_name;
	void *value;
114 115
	const char *argh;
	const char *help;
116 117 118 119

	int flags;
	parse_opt_cb *callback;
	intptr_t defval;
120 121
};

122 123 124 125 126 127 128 129
#define OPT_BIT_F(s, l, v, h, b, f) { OPTION_BIT, (s), (l), (v), NULL, (h), \
				      PARSE_OPT_NOARG|(f), NULL, (b) }
#define OPT_COUNTUP_F(s, l, v, h, f) { OPTION_COUNTUP, (s), (l), (v), NULL, \
				       (h), PARSE_OPT_NOARG|(f) }
#define OPT_SET_INT_F(s, l, v, h, i, f) { OPTION_SET_INT, (s), (l), (v), NULL, \
					  (h), PARSE_OPT_NOARG | (f), NULL, (i) }
#define OPT_BOOL_F(s, l, v, h, f)   OPT_SET_INT_F(s, l, v, h, 1, f)

130
#define OPT_END()                   { OPTION_END }
131 132
#define OPT_ARGUMENT(l, h)          { OPTION_ARGUMENT, 0, (l), NULL, NULL, \
				      (h), PARSE_OPT_NOARG}
133
#define OPT_GROUP(h)                { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
134
#define OPT_BIT(s, l, v, h, b)      OPT_BIT_F(s, l, v, h, b, 0)
135 136
#define OPT_NEGBIT(s, l, v, h, b)   { OPTION_NEGBIT, (s), (l), (v), NULL, \
				      (h), PARSE_OPT_NOARG, NULL, (b) }
137 138 139
#define OPT_COUNTUP(s, l, v, h)     OPT_COUNTUP_F(s, l, v, h, 0)
#define OPT_SET_INT(s, l, v, h, i)  OPT_SET_INT_F(s, l, v, h, i, 0)
#define OPT_BOOL(s, l, v, h)        OPT_BOOL_F(s, l, v, h, 0)
140 141
#define OPT_HIDDEN_BOOL(s, l, v, h) { OPTION_SET_INT, (s), (l), (v), NULL, \
				      (h), PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, 1}
142
#define OPT_CMDMODE(s, l, v, h, i)  { OPTION_CMDMODE, (s), (l), (v), NULL, \
143
				      (h), PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, (i) }
144
#define OPT_INTEGER(s, l, v, h)     { OPTION_INTEGER, (s), (l), (v), N_("n"), (h) }
145 146
#define OPT_MAGNITUDE(s, l, v, h)   { OPTION_MAGNITUDE, (s), (l), (v), \
				      N_("n"), (h), PARSE_OPT_NONEG }
147
#define OPT_STRING(s, l, v, a, h)   { OPTION_STRING,  (s), (l), (v), (a), (h) }
148 149 150
#define OPT_STRING_LIST(s, l, v, a, h) \
				    { OPTION_CALLBACK, (s), (l), (v), (a), \
				      (h), 0, &parse_opt_string_list }
151 152
#define OPT_UYN(s, l, v, h)         { OPTION_CALLBACK, (s), (l), (v), NULL, \
				      (h), PARSE_OPT_NOARG, &parse_opt_tertiary }
153
#define OPT_EXPIRY_DATE(s, l, v, h) \
154
	{ OPTION_CALLBACK, (s), (l), (v), N_("expiry-date"),(h), 0,	\
155
	  parse_opt_expiry_date_cb }
156 157
#define OPT_CALLBACK(s, l, v, a, h, f) \
	{ OPTION_CALLBACK, (s), (l), (v), (a), (h), 0, (f) }
158 159 160
#define OPT_NUMBER_CALLBACK(v, h, f) \
	{ OPTION_NUMBER, 0, NULL, (v), NULL, (h), \
	  PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) }
161
#define OPT_FILENAME(s, l, v, h)    { OPTION_FILENAME, (s), (l), (v), \
162
				       N_("file"), (h) }
163
#define OPT_COLOR_FLAG(s, l, v, h) \
164
	{ OPTION_CALLBACK, (s), (l), (v), N_("when"), (h), PARSE_OPT_OPTARG, \
165 166
		parse_opt_color_flag_cb, (intptr_t)"always" }

167 168
#define OPT_NOOP_NOARG(s, l) \
	{ OPTION_CALLBACK, (s), (l), NULL, NULL, \
169
	  N_("no-op (backward compatibility)"),		\
170 171
	  PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, parse_opt_noop_cb }

172
/* parse_options() will filter out the processed options and leave the
173 174
 * non-option arguments in argv[]. usagestr strings should be marked
 * for translation with N_().
175 176
 * Returns the number of arguments left in argv[].
 */
177
extern int parse_options(int argc, const char **argv, const char *prefix,
178
                         const struct option *options,
179 180 181 182
                         const char * const usagestr[], int flags);

extern NORETURN void usage_with_options(const char * const *usagestr,
                                        const struct option *options);
183

184 185 186 187
extern NORETURN void usage_msg_opt(const char *msg,
				   const char * const *usagestr,
				   const struct option *options);

188 189
extern int optbug(const struct option *opt, const char *reason);
extern int opterror(const struct option *opt, const char *reason, int flags);
190
#if defined(__GNUC__)
191
#define opterror(o,r,f) (opterror((o),(r),(f)), const_error())
192 193
#endif

194 195 196 197 198 199 200 201 202 203 204 205 206 207
/*
 * Use these assertions for callbacks that expect to be called with NONEG and
 * NOARG respectively, and do not otherwise handle the "unset" and "arg"
 * parameters.
 */
#define BUG_ON_OPT_NEG(unset) do { \
	if ((unset)) \
		BUG("option callback does not expect negation"); \
} while (0)
#define BUG_ON_OPT_ARG(arg) do { \
	if ((arg)) \
		BUG("option callback does not expect an argument"); \
} while (0)

208
/*----- incremental advanced APIs -----*/
209

210
enum {
211
	PARSE_OPT_COMPLETE = -2,
212 213
	PARSE_OPT_HELP = -1,
	PARSE_OPT_DONE,
214
	PARSE_OPT_NON_OPTION,
215
	PARSE_OPT_ERROR,
216
	PARSE_OPT_UNKNOWN
217 218
};

219 220 221 222 223
/*
 * It's okay for the caller to consume argv/argc in the usual way.
 * Other fields of that structure are private to parse-options and should not
 * be modified in any way.
 */
224 225 226
struct parse_opt_ctx_t {
	const char **argv;
	const char **out;
227
	int argc, cpidx, total;
228 229
	const char *opt;
	int flags;
230
	const char *prefix;
231 232 233
};

extern void parse_options_start(struct parse_opt_ctx_t *ctx,
234
				int argc, const char **argv, const char *prefix,
235
				const struct option *options, int flags);
236

237 238 239 240
extern int parse_options_step(struct parse_opt_ctx_t *ctx,
			      const struct option *options,
			      const char * const usagestr[]);

241 242
extern int parse_options_end(struct parse_opt_ctx_t *ctx);

243
extern struct option *parse_options_concat(struct option *a, struct option *b);
244

245 246
/*----- some often used options -----*/
extern int parse_opt_abbrev_cb(const struct option *, const char *, int);
247
extern int parse_opt_expiry_date_cb(const struct option *, const char *, int);
248
extern int parse_opt_color_flag_cb(const struct option *, const char *, int);
249
extern int parse_opt_verbosity_cb(const struct option *, const char *, int);
250
extern int parse_opt_object_name(const struct option *, const char *, int);
251
extern int parse_opt_commits(const struct option *, const char *, int);
252
extern int parse_opt_tertiary(const struct option *, const char *, int);
253
extern int parse_opt_string_list(const struct option *, const char *, int);
254
extern int parse_opt_noop_cb(const struct option *, const char *, int);
255
extern int parse_opt_unknown_cb(const struct option *, const char *, int);
256
extern int parse_opt_passthru(const struct option *, const char *, int);
257
extern int parse_opt_passthru_argv(const struct option *, const char *, int);
258

259 260
#define OPT__VERBOSE(var, h)  OPT_COUNTUP('v', "verbose", (var), (h))
#define OPT__QUIET(var, h)    OPT_COUNTUP('q', "quiet",   (var), (h))
261
#define OPT__VERBOSITY(var) \
262
	{ OPTION_CALLBACK, 'v', "verbose", (var), NULL, N_("be more verbose"), \
263
	  PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
264
	{ OPTION_CALLBACK, 'q', "quiet", (var), NULL, N_("be more quiet"), \
265
	  PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
266
#define OPT__DRY_RUN(var, h)  OPT_BOOL('n', "dry-run", (var), (h))
267
#define OPT__FORCE(var, h, f) OPT_COUNTUP_F('f', "force",   (var), (h), (f))
268
#define OPT__ABBREV(var)  \
269 270
	{ OPTION_CALLBACK, 0, "abbrev", (var), N_("n"),	\
	  N_("use <n> digits to display SHA-1s"),	\
271
	  PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
272 273
#define OPT__COLOR(var, h) \
	OPT_COLOR_FLAG(0, "color", (var), (h))
274
#define OPT_COLUMN(s, l, v, h) \
275
	{ OPTION_CALLBACK, (s), (l), (v), N_("style"), (h), PARSE_OPT_OPTARG, parseopt_column_callback }
276 277
#define OPT_PASSTHRU(s, l, v, a, h, f) \
	{ OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru }
278 279
#define OPT_PASSTHRU_ARGV(s, l, v, a, h, f) \
	{ OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru_argv }
280 281 282 283 284
#define _OPT_CONTAINS_OR_WITH(name, variable, help, flag) \
	{ OPTION_CALLBACK, 0, name, (variable), N_("commit"), (help), \
	  PARSE_OPT_LASTARG_DEFAULT | flag, \
	  parse_opt_commits, (intptr_t) "HEAD" \
	}
285
#define OPT_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("contains", v, h, PARSE_OPT_NONEG)
286
#define OPT_NO_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("no-contains", v, h, PARSE_OPT_NONEG)
287
#define OPT_WITH(v, h) _OPT_CONTAINS_OR_WITH("with", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
288
#define OPT_WITHOUT(v, h) _OPT_CONTAINS_OR_WITH("without", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
289

290
#endif