[thirdparty/git.git] / parse-options.h

#ifndef PARSE_OPTIONS_H
#define PARSE_OPTIONS_H

enum parse_opt_type {
	/* special types */
	OPTION_END,
	OPTION_ARGUMENT,
	OPTION_GROUP,
	OPTION_NUMBER,
	/* options with no arguments */
	OPTION_BIT,
	OPTION_NEGBIT,
	OPTION_COUNTUP,
	OPTION_SET_INT,
	OPTION_CMDMODE,
	/* options with arguments (usually) */
	OPTION_STRING,
	OPTION_INTEGER,
	OPTION_MAGNITUDE,
	OPTION_CALLBACK,
	OPTION_LOWLEVEL_CALLBACK,
	OPTION_FILENAME
};

enum parse_opt_flags {
	PARSE_OPT_KEEP_DASHDASH = 1,
	PARSE_OPT_STOP_AT_NON_OPTION = 2,
	PARSE_OPT_KEEP_ARGV0 = 4,
	PARSE_OPT_KEEP_UNKNOWN = 8,
	PARSE_OPT_NO_INTERNAL_HELP = 16
};

enum parse_opt_option_flags {
	PARSE_OPT_OPTARG  = 1,
	PARSE_OPT_NOARG   = 2,
	PARSE_OPT_NONEG   = 4,
	PARSE_OPT_HIDDEN  = 8,
	PARSE_OPT_LASTARG_DEFAULT = 16,
	PARSE_OPT_NODASH = 32,
	PARSE_OPT_LITERAL_ARGHELP = 64,
	PARSE_OPT_SHELL_EVAL = 256,
	PARSE_OPT_NOCOMPLETE = 512,
	PARSE_OPT_COMP_ARG = 1024
};

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

struct parse_opt_ctx_t;
typedef int parse_opt_ll_cb(struct parse_opt_ctx_t *ctx,
				const struct option *opt, int unset);

/*
 * `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
 *   homogeneous across the repository. Should be wrapped by N_() for
 *   translation.
 *
 * `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.
 *   Should be wrapped by N_() for translation.
 *
 * `flags`::
 *   mask of parse_opt_option_flags.
 *   PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs)
 *   PARSE_OPT_NOARG: says that this option does not take an argument
 *   PARSE_OPT_NONEG: says that this option cannot be negated
 *   PARSE_OPT_HIDDEN: this option is skipped in the default usage, and
 *                     shown only in the full usage.
 *   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.
 *   PARSE_OPT_NODASH: this option doesn't start with a dash.
 *   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.
 *   PARSE_OPT_NOCOMPLETE: by default all visible options are completable
 *			   by git-completion.bash. This option suppresses that.
 *   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.
 *
 * `callback`::
 *   pointer to the callback to use for OPTION_CALLBACK or
 *   OPTION_LOWLEVEL_CALLBACK.
 *
 * `defval`::
 *   default value to fill (*->value) with for PARSE_OPT_OPTARG.
 *   OPTION_{BIT,SET_INT} store the {mask,integer} to put in the value when met.
 *   CALLBACKS can use it like they want.
 */
struct option {
	enum parse_opt_type type;
	int short_name;
	const char *long_name;
	void *value;
	const char *argh;
	const char *help;

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

#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)

#define OPT_END()                   { OPTION_END }
#define OPT_ARGUMENT(l, h)          { OPTION_ARGUMENT, 0, (l), NULL, NULL, \
				      (h), PARSE_OPT_NOARG}
#define OPT_GROUP(h)                { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
#define OPT_BIT(s, l, v, h, b)      OPT_BIT_F(s, l, v, h, b, 0)
#define OPT_NEGBIT(s, l, v, h, b)   { OPTION_NEGBIT, (s), (l), (v), NULL, \
				      (h), PARSE_OPT_NOARG, NULL, (b) }
#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)
#define OPT_HIDDEN_BOOL(s, l, v, h) { OPTION_SET_INT, (s), (l), (v), NULL, \
				      (h), PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, 1}
#define OPT_CMDMODE(s, l, v, h, i)  { OPTION_CMDMODE, (s), (l), (v), NULL, \
				      (h), PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, (i) }
#define OPT_INTEGER(s, l, v, h)     { OPTION_INTEGER, (s), (l), (v), N_("n"), (h) }
#define OPT_MAGNITUDE(s, l, v, h)   { OPTION_MAGNITUDE, (s), (l), (v), \
				      N_("n"), (h), PARSE_OPT_NONEG }
#define OPT_STRING(s, l, v, a, h)   { OPTION_STRING,  (s), (l), (v), (a), (h) }
#define OPT_STRING_LIST(s, l, v, a, h) \
				    { OPTION_CALLBACK, (s), (l), (v), (a), \
				      (h), 0, &parse_opt_string_list }
#define OPT_UYN(s, l, v, h)         { OPTION_CALLBACK, (s), (l), (v), NULL, \
				      (h), PARSE_OPT_NOARG, &parse_opt_tertiary }
#define OPT_DATE(s, l, v, h) \
	{ OPTION_CALLBACK, (s), (l), (v), N_("time"),(h), 0,	\
	  parse_opt_approxidate_cb }
#define OPT_EXPIRY_DATE(s, l, v, h) \
	{ OPTION_CALLBACK, (s), (l), (v), N_("expiry-date"),(h), 0,	\
	  parse_opt_expiry_date_cb }
#define OPT_CALLBACK(s, l, v, a, h, f) \
	{ OPTION_CALLBACK, (s), (l), (v), (a), (h), 0, (f) }
#define OPT_NUMBER_CALLBACK(v, h, f) \
	{ OPTION_NUMBER, 0, NULL, (v), NULL, (h), \
	  PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) }
#define OPT_FILENAME(s, l, v, h)    { OPTION_FILENAME, (s), (l), (v), \
				       N_("file"), (h) }
#define OPT_COLOR_FLAG(s, l, v, h) \
	{ OPTION_CALLBACK, (s), (l), (v), N_("when"), (h), PARSE_OPT_OPTARG, \
		parse_opt_color_flag_cb, (intptr_t)"always" }

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

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

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

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

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

/*----- incremental advanced APIs -----*/

enum {
	PARSE_OPT_HELP = -1,
	PARSE_OPT_DONE,
	PARSE_OPT_NON_OPTION,
	PARSE_OPT_UNKNOWN
};

/*
 * 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.
 */
struct parse_opt_ctx_t {
	const char **argv;
	const char **out;
	int argc, cpidx, total;
	const char *opt;
	int flags;
	const char *prefix;
};

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

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

extern int parse_options_end(struct parse_opt_ctx_t *ctx);

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

/*----- some often used options -----*/
extern int parse_opt_abbrev_cb(const struct option *, const char *, int);
extern int parse_opt_approxidate_cb(const struct option *, const char *, int);
extern int parse_opt_expiry_date_cb(const struct option *, const char *, int);
extern int parse_opt_color_flag_cb(const struct option *, const char *, int);
extern int parse_opt_verbosity_cb(const struct option *, const char *, int);
extern int parse_opt_object_name(const struct option *, const char *, int);
extern int parse_opt_commits(const struct option *, const char *, int);
extern int parse_opt_tertiary(const struct option *, const char *, int);
extern int parse_opt_string_list(const struct option *, const char *, int);
extern int parse_opt_noop_cb(const struct option *, const char *, int);
extern int parse_opt_unknown_cb(const struct option *, const char *, int);
extern int parse_opt_passthru(const struct option *, const char *, int);
extern int parse_opt_passthru_argv(const struct option *, const char *, int);

#define OPT__VERBOSE(var, h)  OPT_COUNTUP('v', "verbose", (var), (h))
#define OPT__QUIET(var, h)    OPT_COUNTUP('q', "quiet",   (var), (h))
#define OPT__VERBOSITY(var) \
	{ OPTION_CALLBACK, 'v', "verbose", (var), NULL, N_("be more verbose"), \
	  PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
	{ OPTION_CALLBACK, 'q', "quiet", (var), NULL, N_("be more quiet"), \
	  PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
#define OPT__DRY_RUN(var, h)  OPT_BOOL('n', "dry-run", (var), (h))
#define OPT__FORCE(var, h, f) OPT_COUNTUP_F('f', "force",   (var), (h), (f))
#define OPT__ABBREV(var)  \
	{ OPTION_CALLBACK, 0, "abbrev", (var), N_("n"),	\
	  N_("use <n> digits to display SHA-1s"),	\
	  PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
#define OPT__COLOR(var, h) \
	OPT_COLOR_FLAG(0, "color", (var), (h))
#define OPT_COLUMN(s, l, v, h) \
	{ OPTION_CALLBACK, (s), (l), (v), N_("style"), (h), PARSE_OPT_OPTARG, parseopt_column_callback }
#define OPT_PASSTHRU(s, l, v, a, h, f) \
	{ OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru }
#define OPT_PASSTHRU_ARGV(s, l, v, a, h, f) \
	{ OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru_argv }
#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" \
	}
#define OPT_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("contains", v, h, PARSE_OPT_NONEG)
#define OPT_NO_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("no-contains", v, h, PARSE_OPT_NONEG)
#define OPT_WITH(v, h) _OPT_CONTAINS_OR_WITH("with", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
#define OPT_WITHOUT(v, h) _OPT_CONTAINS_OR_WITH("without", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)

#endif
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 */
db7244bd PH	11	OPTION_BIT,
2f4b97f9	12	OPTION_NEGBIT,
b04ba2bb	13	OPTION_COUNTUP,
db7244bd	14	OPTION_SET_INT,
11588263	15	OPTION_CMDMODE,
db7244bd	16	/* options with arguments (usually) */
4a59fd13 PH	17	OPTION_STRING,
4a59fd13 PH	18	OPTION_INTEGER,
2a514ed8	19	OPTION_MAGNITUDE,
ffe659f9	20	OPTION_CALLBACK,
b0b3a8b6	21	OPTION_LOWLEVEL_CALLBACK,
df217ed6	22	OPTION_FILENAME
4a59fd13 PH	23	};
	24
	25	enum parse_opt_flags {
	26	PARSE_OPT_KEEP_DASHDASH = 1,
a0ec9d25	27	PARSE_OPT_STOP_AT_NON_OPTION = 2,
a32a4eaa	28	PARSE_OPT_KEEP_ARGV0 = 4,
b5ce3a54	29	PARSE_OPT_KEEP_UNKNOWN = 8,
4b05548f	30	PARSE_OPT_NO_INTERNAL_HELP = 16
4a59fd13 PH	31	};
4a59fd13 PH	32
ffe659f9 PH	33	enum parse_opt_option_flags {
ffe659f9 PH	34	PARSE_OPT_OPTARG = 1,
f481e22a	35	PARSE_OPT_NOARG = 2,
db7244bd	36	PARSE_OPT_NONEG = 4,
dd3bf0f4	37	PARSE_OPT_HIDDEN = 8,
1cc6985c	38	PARSE_OPT_LASTARG_DEFAULT = 16,
51a9949e	39	PARSE_OPT_NODASH = 32,
29f25d49	40	PARSE_OPT_LITERAL_ARGHELP = 64,
b9d7f4b4	41	PARSE_OPT_SHELL_EVAL = 256,
ebc4a04e NTND	42	PARSE_OPT_NOCOMPLETE = 512,
ebc4a04e NTND	43	PARSE_OPT_COMP_ARG = 1024
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
54e6dc7d NTND	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
51a9949e RS	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.
b9d7f4b4 NTND	94	* PARSE_OPT_NOCOMPLETE: by default all visible options are completable
b9d7f4b4 NTND	95	* by git-completion.bash. This option suppresses that.
ebc4a04e NTND	96	* PARSE_OPT_COMP_ARG: this option forces to git-completion.bash to
	97	* complete an option as --name= not --name even if
	98	* the option takes optional argument.
9b3beb58 PH	99	*
9b3beb58 PH	100	* `callback`::
b0b3a8b6 JN	101	* pointer to the callback to use for OPTION_CALLBACK or
b0b3a8b6 JN	102	* OPTION_LOWLEVEL_CALLBACK.
9b3beb58 PH	103	*
	104	* `defval`::
	105	* default value to fill (*->value) with for PARSE_OPT_OPTARG.
d3c08114	106	* OPTION_{BIT,SET_INT} store the {mask,integer} to put in the value when met.
9b3beb58 PH	107	* CALLBACKS can use it like they want.
9b3beb58 PH	108	*/
4a59fd13 PH	109	struct option {
	110	enum parse_opt_type type;
	111	int short_name;
	112	const char *long_name;
	113	void *value;
d7a38c54 PH	114	const char *argh;
d7a38c54 PH	115	const char *help;
ffe659f9 PH	116
	117	int flags;
	118	parse_opt_cb *callback;
ffe659f9	119	intptr_t defval;
4a59fd13 PH	120	};
4a59fd13 PH	121
2de37349 NTND	122	#define OPT_BIT_F(s, l, v, h, b, f) { OPTION_BIT, (s), (l), (v), NULL, (h), \
	123	PARSE_OPT_NOARG\|(f), NULL, (b) }
	124	#define OPT_COUNTUP_F(s, l, v, h, f) { OPTION_COUNTUP, (s), (l), (v), NULL, \
	125	(h), PARSE_OPT_NOARG\|(f) }
	126	#define OPT_SET_INT_F(s, l, v, h, i, f) { OPTION_SET_INT, (s), (l), (v), NULL, \
	127	(h), PARSE_OPT_NOARG \| (f), NULL, (i) }
	128	#define OPT_BOOL_F(s, l, v, h, f) OPT_SET_INT_F(s, l, v, h, 1, f)
	129
4a59fd13	130	#define OPT_END() { OPTION_END }
34aec9f5 SB	131	#define OPT_ARGUMENT(l, h) { OPTION_ARGUMENT, 0, (l), NULL, NULL, \
34aec9f5 SB	132	(h), PARSE_OPT_NOARG}
d7a38c54	133	#define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
2de37349	134	#define OPT_BIT(s, l, v, h, b) OPT_BIT_F(s, l, v, h, b, 0)
34aec9f5 SB	135	#define OPT_NEGBIT(s, l, v, h, b) { OPTION_NEGBIT, (s), (l), (v), NULL, \
34aec9f5 SB	136	(h), PARSE_OPT_NOARG, NULL, (b) }
2de37349 NTND	137	#define OPT_COUNTUP(s, l, v, h) OPT_COUNTUP_F(s, l, v, h, 0)
	138	#define OPT_SET_INT(s, l, v, h, i) OPT_SET_INT_F(s, l, v, h, i, 0)
	139	#define OPT_BOOL(s, l, v, h) OPT_BOOL_F(s, l, v, h, 0)
4741edd5 SB	140	#define OPT_HIDDEN_BOOL(s, l, v, h) { OPTION_SET_INT, (s), (l), (v), NULL, \
4741edd5 SB	141	(h), PARSE_OPT_NOARG \| PARSE_OPT_HIDDEN, NULL, 1}
14691e38	142	#define OPT_CMDMODE(s, l, v, h, i) { OPTION_CMDMODE, (s), (l), (v), NULL, \
11588263	143	(h), PARSE_OPT_NOARG\|PARSE_OPT_NONEG, NULL, (i) }
54e6dc7d	144	#define OPT_INTEGER(s, l, v, h) { OPTION_INTEGER, (s), (l), (v), N_("n"), (h) }
2a514ed8 CB	145	#define OPT_MAGNITUDE(s, l, v, h) { OPTION_MAGNITUDE, (s), (l), (v), \
2a514ed8 CB	146	N_("n"), (h), PARSE_OPT_NONEG }
d7a38c54	147	#define OPT_STRING(s, l, v, a, h) { OPTION_STRING, (s), (l), (v), (a), (h) }
c8ba1639 JK	148	#define OPT_STRING_LIST(s, l, v, a, h) \
	149	{ OPTION_CALLBACK, (s), (l), (v), (a), \
	150	(h), 0, &parse_opt_string_list }
b475e442 NTND	151	#define OPT_UYN(s, l, v, h) { OPTION_CALLBACK, (s), (l), (v), NULL, \
b475e442 NTND	152	(h), PARSE_OPT_NOARG, &parse_opt_tertiary }
1f4a711a	153	#define OPT_DATE(s, l, v, h) \
54e6dc7d	154	{ OPTION_CALLBACK, (s), (l), (v), N_("time"),(h), 0, \
1f4a711a	155	parse_opt_approxidate_cb }
27ec394a	156	#define OPT_EXPIRY_DATE(s, l, v, h) \
e703d711	157	{ OPTION_CALLBACK, (s), (l), (v), N_("expiry-date"),(h), 0, \
27ec394a	158	parse_opt_expiry_date_cb }
ffe659f9 PH	159	#define OPT_CALLBACK(s, l, v, a, h, f) \
ffe659f9 PH	160	{ OPTION_CALLBACK, (s), (l), (v), (a), (h), 0, (f) }
e0319ff5 RS	161	#define OPT_NUMBER_CALLBACK(v, h, f) \
	162	{ OPTION_NUMBER, 0, NULL, (v), NULL, (h), \
	163	PARSE_OPT_NOARG \| PARSE_OPT_NONEG, (f) }
df217ed6	164	#define OPT_FILENAME(s, l, v, h) { OPTION_FILENAME, (s), (l), (v), \
54e6dc7d	165	N_("file"), (h) }
73e9da01	166	#define OPT_COLOR_FLAG(s, l, v, h) \
54e6dc7d	167	{ OPTION_CALLBACK, (s), (l), (v), N_("when"), (h), PARSE_OPT_OPTARG, \
73e9da01 ML	168	parse_opt_color_flag_cb, (intptr_t)"always" }
73e9da01 ML	169
6acec038 RS	170	#define OPT_NOOP_NOARG(s, l) \
6acec038 RS	171	{ OPTION_CALLBACK, (s), (l), NULL, NULL, \
54e6dc7d	172	N_("no-op (backward compatibility)"), \
6acec038 RS	173	PARSE_OPT_HIDDEN \| PARSE_OPT_NOARG, parse_opt_noop_cb }
6acec038 RS	174
4a59fd13	175	/* parse_options() will filter out the processed options and leave the
54e6dc7d NTND	176	* non-option arguments in argv[]. usagestr strings should be marked
54e6dc7d NTND	177	* for translation with N_().
4a59fd13 PH	178	* Returns the number of arguments left in argv[].
4a59fd13 PH	179	*/
37782920	180	extern int parse_options(int argc, const char *argv, const char prefix,
4a59fd13	181	const struct option *options,
d7a38c54 PH	182	const char * const usagestr[], int flags);
	183
	184	extern NORETURN void usage_with_options(const char * const *usagestr,
	185	const struct option *options);
4a59fd13	186
451bb210 CC	187	extern NORETURN void usage_msg_opt(const char *msg,
	188	const char * const *usagestr,
	189	const struct option *options);
	190
1f275b7c DI	191	extern int optbug(const struct option opt, const char reason);
1f275b7c DI	192	extern int opterror(const struct option opt, const char reason, int flags);
ff0a80af	193	#if defined(__GNUC__)
87fe5df3	194	#define opterror(o,r,f) (opterror((o),(r),(f)), const_error())
a469a101 JK	195	#endif
a469a101 JK	196
3ea3c215	197	/----- incremental advanced APIs -----/
7e7bbcb4	198
ee68b87a PH	199	enum {
	200	PARSE_OPT_HELP = -1,
	201	PARSE_OPT_DONE,
979240fe	202	PARSE_OPT_NON_OPTION,
4b05548f	203	PARSE_OPT_UNKNOWN
ee68b87a PH	204	};
ee68b87a PH	205
26141b5b PH	206	/*
	207	* It's okay for the caller to consume argv/argc in the usual way.
	208	* Other fields of that structure are private to parse-options and should not
	209	* be modified in any way.
	210	*/
7e7bbcb4 PH	211	struct parse_opt_ctx_t {
	212	const char **argv;
	213	const char **out;
5ad0d3d5	214	int argc, cpidx, total;
7e7bbcb4 PH	215	const char *opt;
7e7bbcb4 PH	216	int flags;
37782920	217	const char *prefix;
7e7bbcb4 PH	218	};
	219
	220	extern void parse_options_start(struct parse_opt_ctx_t *ctx,
37782920	221	int argc, const char *argv, const char prefix,
9ca1169f	222	const struct option *options, int flags);
7e7bbcb4	223
ff43ec3e PH	224	extern int parse_options_step(struct parse_opt_ctx_t *ctx,
	225	const struct option *options,
	226	const char * const usagestr[]);
	227
7e7bbcb4 PH	228	extern int parse_options_end(struct parse_opt_ctx_t *ctx);
7e7bbcb4 PH	229
023ff39b	230	extern struct option parse_options_concat(struct option a, struct option *b);
7e7bbcb4	231
0ce865b1 PH	232	/----- some often used options -----/
0ce865b1 PH	233	extern int parse_opt_abbrev_cb(const struct option , const char , int);
1f4a711a	234	extern int parse_opt_approxidate_cb(const struct option , const char , int);
27ec394a	235	extern int parse_opt_expiry_date_cb(const struct option , const char , int);
73e9da01	236	extern int parse_opt_color_flag_cb(const struct option , const char , int);
7f87aff2	237	extern int parse_opt_verbosity_cb(const struct option , const char , int);
b2172fdf	238	extern int parse_opt_object_name(const struct option , const char , int);
9d306b5a	239	extern int parse_opt_commits(const struct option , const char , int);
cb6020bb	240	extern int parse_opt_tertiary(const struct option , const char , int);
c8ba1639	241	extern int parse_opt_string_list(const struct option , const char , int);
6acec038	242	extern int parse_opt_noop_cb(const struct option , const char , int);
ce564eb1	243	extern int parse_opt_unknown_cb(const struct option , const char , int);
6b3ee18d	244	extern int parse_opt_passthru(const struct option , const char , int);
ffad85c5	245	extern int parse_opt_passthru_argv(const struct option , const char , int);
0ce865b1	246
212c0a6f NTND	247	#define OPT__VERBOSE(var, h) OPT_COUNTUP('v', "verbose", (var), (h))
212c0a6f NTND	248	#define OPT__QUIET(var, h) OPT_COUNTUP('q', "quiet", (var), (h))
7f87aff2	249	#define OPT__VERBOSITY(var) \
54e6dc7d	250	{ OPTION_CALLBACK, 'v', "verbose", (var), NULL, N_("be more verbose"), \
7f87aff2	251	PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
54e6dc7d	252	{ OPTION_CALLBACK, 'q', "quiet", (var), NULL, N_("be more quiet"), \
7f87aff2	253	PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
212c0a6f	254	#define OPT__DRY_RUN(var, h) OPT_BOOL('n', "dry-run", (var), (h))
1224781d	255	#define OPT__FORCE(var, h, f) OPT_COUNTUP_F('f', "force", (var), (h), (f))
0ce865b1	256	#define OPT__ABBREV(var) \
54e6dc7d NTND	257	{ OPTION_CALLBACK, 0, "abbrev", (var), N_("n"), \
54e6dc7d NTND	258	N_("use <n> digits to display SHA-1s"), \
0ce865b1	259	PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
73e9da01 ML	260	#define OPT__COLOR(var, h) \
73e9da01 ML	261	OPT_COLOR_FLAG(0, "color", (var), (h))
7e29b825	262	#define OPT_COLUMN(s, l, v, h) \
a054e049	263	{ OPTION_CALLBACK, (s), (l), (v), N_("style"), (h), PARSE_OPT_OPTARG, parseopt_column_callback }
6b3ee18d PT	264	#define OPT_PASSTHRU(s, l, v, a, h, f) \
6b3ee18d PT	265	{ OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru }
ffad85c5 PT	266	#define OPT_PASSTHRU_ARGV(s, l, v, a, h, f) \
ffad85c5 PT	267	{ OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru_argv }
f266c916 KN	268	#define _OPT_CONTAINS_OR_WITH(name, variable, help, flag) \
	269	{ OPTION_CALLBACK, 0, name, (variable), N_("commit"), (help), \
	270	PARSE_OPT_LASTARG_DEFAULT \| flag, \
	271	parse_opt_commits, (intptr_t) "HEAD" \
	272	}
eab98ee5	273	#define OPT_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("contains", v, h, PARSE_OPT_NONEG)
ac3f5a34	274	#define OPT_NO_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("no-contains", v, h, PARSE_OPT_NONEG)
eab98ee5	275	#define OPT_WITH(v, h) _OPT_CONTAINS_OR_WITH("with", v, h, PARSE_OPT_HIDDEN \| PARSE_OPT_NONEG)
ac3f5a34	276	#define OPT_WITHOUT(v, h) _OPT_CONTAINS_OR_WITH("without", v, h, PARSE_OPT_HIDDEN \| PARSE_OPT_NONEG)
0ce865b1	277
4a59fd13	278	#endif