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

#ifndef PARSE_OPTIONS_H
#define PARSE_OPTIONS_H

/**
 * Refer to Documentation/technical/api-parse-options.txt for the API doc.
 */

enum parse_opt_type {
	/* special types */
	OPTION_END,
	OPTION_ARGUMENT,
	OPTION_GROUP,
	OPTION_NUMBER,
	OPTION_ALIAS,
	/* options with no arguments */
	OPTION_BIT,
	OPTION_NEGBIT,
	OPTION_BITOP,
	OPTION_COUNTUP,
	OPTION_SET_INT,
	/* 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 << 0,
	PARSE_OPT_STOP_AT_NON_OPTION = 1 << 1,
	PARSE_OPT_KEEP_ARGV0 = 1 << 2,
	PARSE_OPT_KEEP_UNKNOWN = 1 << 3,
	PARSE_OPT_NO_INTERNAL_HELP = 1 << 4,
	PARSE_OPT_ONE_SHOT = 1 << 5,
};

enum parse_opt_option_flags {
	PARSE_OPT_OPTARG  = 1 << 0,
	PARSE_OPT_NOARG   = 1 << 1,
	PARSE_OPT_NONEG   = 1 << 2,
	PARSE_OPT_HIDDEN  = 1 << 3,
	PARSE_OPT_LASTARG_DEFAULT = 1 << 4,
	PARSE_OPT_NODASH = 1 << 5,
	PARSE_OPT_LITERAL_ARGHELP = 1 << 6,
	PARSE_OPT_FROM_ALIAS = 1 << 7,
	PARSE_OPT_SHELL_EVAL = 1 << 8,
	PARSE_OPT_NOCOMPLETE = 1 << 9,
	PARSE_OPT_COMP_ARG = 1 << 10,
	PARSE_OPT_CMDMODE = 1 << 11,
};

enum parse_opt_result {
	PARSE_OPT_COMPLETE = -3,
	PARSE_OPT_HELP = -2,
	PARSE_OPT_ERROR = -1,	/* must be the same as error() */
	PARSE_OPT_DONE = 0,	/* fixed so that "return 0" works */
	PARSE_OPT_NON_OPTION,
	PARSE_OPT_UNKNOWN
};

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

struct parse_opt_ctx_t;
typedef enum parse_opt_result parse_opt_ll_cb(struct parse_opt_ctx_t *ctx,
					      const struct option *opt,
					      const char *arg, 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. Does not
 *   begin in capital letter, and does not end with a full stop.
 *   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
 *
 * `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.
 *
 * `ll_callback`::
 *   pointer to the callback to use for OPTION_LOWLEVEL_CALLBACK
 *
 */
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;
	parse_opt_ll_cb *ll_callback;
	intptr_t extra;
};

#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_CALLBACK_F(s, l, v, a, h, f, cb)			\
	{ OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), (cb) }
#define OPT_STRING_F(s, l, v, a, h, f)   { OPTION_STRING,  (s), (l), (v), (a), (h), (f) }
#define OPT_INTEGER_F(s, l, v, h, f)     { OPTION_INTEGER, (s), (l), (v), N_("n"), (h), (f) }

#define OPT_END()                   { OPTION_END }
#define OPT_ARGUMENT(l, v, h)       { OPTION_ARGUMENT, 0, (l), (v), NULL, \
				      (h), PARSE_OPT_NOARG, NULL, 1 }
#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_BITOP(s, l, v, h, set, clear) { OPTION_BITOP, (s), (l), (v), NULL, (h), \
					    PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, \
					    (set), NULL, (clear) }
#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_SET_INT, (s), (l), (v), NULL, \
				      (h), PARSE_OPT_CMDMODE|PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, (i) }
#define OPT_INTEGER(s, l, v, h)     OPT_INTEGER_F(s, l, v, h, 0)
#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)   OPT_STRING_F(s, l, v, a, h, 0)
#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_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) OPT_CALLBACK_F(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 }

#define OPT_ALIAS(s, l, source_long_name) \
	{ OPTION_ALIAS, (s), (l), (source_long_name) }

/*
 * parse_options() will filter out the processed options and leave the
 * non-option arguments in argv[]. argv0 is assumed program name and
 * skipped.
 *
 * usagestr strings should be marked for translation with N_().
 *
 * Returns the number of arguments left in argv[].
 *
 * In one-shot mode, argv0 is not a program name, argv[] is left
 * untouched and parse_options() returns the number of options
 * processed.
 */
int parse_options(int argc, const char **argv, const char *prefix,
		  const struct option *options,
		  const char * const usagestr[], int flags);

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

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

int optbug(const struct option *opt, const char *reason);
const char *optname(const struct option *opt, int flags);

/*
 * 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)

/*
 * Similar to the assertions above, but checks that "arg" is always non-NULL.
 * This assertion also implies BUG_ON_OPT_NEG(), letting you declare both
 * assertions in a single line.
 */
#define BUG_ON_OPT_NEG_NOARG(unset, arg) do { \
	BUG_ON_OPT_NEG(unset); \
	if(!(arg)) \
		BUG("option callback expects an argument"); \
} while(0)

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

/*
 * 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;
	const char **alias_groups; /* must be in groups of 3 elements! */
	struct option *updated_options;
};

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

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

int parse_options_end(struct parse_opt_ctx_t *ctx);

struct option *parse_options_dup(const struct option *a);
struct option *parse_options_concat(const struct option *a, const struct option *b);

/*----- some often used options -----*/
int parse_opt_abbrev_cb(const struct option *, const char *, int);
int parse_opt_expiry_date_cb(const struct option *, const char *, int);
int parse_opt_color_flag_cb(const struct option *, const char *, int);
int parse_opt_verbosity_cb(const struct option *, const char *, int);
/* value is struct oid_array* */
int parse_opt_object_name(const struct option *, const char *, int);
/* value is struct object_id* */
int parse_opt_object_id(const struct option *, const char *, int);
int parse_opt_commits(const struct option *, const char *, int);
int parse_opt_commit(const struct option *, const char *, int);
int parse_opt_tertiary(const struct option *, const char *, int);
int parse_opt_string_list(const struct option *, const char *, int);
int parse_opt_noop_cb(const struct option *, const char *, int);
enum parse_opt_result parse_opt_unknown_cb(struct parse_opt_ctx_t *ctx,
					   const struct option *,
					   const char *, int);
int parse_opt_passthru(const struct option *, const char *, int);
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 object names"),	\
	  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)
#define OPT_CLEANUP(v) OPT_STRING(0, "cleanup", v, N_("mode"), N_("how to strip spaces and #comments from message"))
#define OPT_PATHSPEC_FROM_FILE(v) OPT_FILENAME(0, "pathspec-from-file", v, N_("read pathspec from file"))
#define OPT_PATHSPEC_FILE_NUL(v)  OPT_BOOL(0, "pathspec-file-nul", v, N_("with --pathspec-from-file, pathspec elements are separated with NUL character"))
#define OPT_AUTOSTASH(v) OPT_BOOL(0, "autostash", v, N_("automatically stash/stash pop before and after"))

#endif
Commit	Line	Data
4a59fd13 PH	1	#ifndef PARSE_OPTIONS_H
	2	#define PARSE_OPTIONS_H
	3
7db03054 HW	4	/**
	5	* Refer to Documentation/technical/api-parse-options.txt for the API doc.
	6	*/
	7
4a59fd13	8	enum parse_opt_type {
db7244bd	9	/* special types */
4a59fd13	10	OPTION_END,
580d5bff	11	OPTION_ARGUMENT,
d7a38c54	12	OPTION_GROUP,
e0319ff5	13	OPTION_NUMBER,
5c387428	14	OPTION_ALIAS,
db7244bd PH	15	/* options with no arguments */
db7244bd PH	16	OPTION_BIT,
2f4b97f9	17	OPTION_NEGBIT,
f62470c6	18	OPTION_BITOP,
b04ba2bb	19	OPTION_COUNTUP,
db7244bd	20	OPTION_SET_INT,
db7244bd	21	/* options with arguments (usually) */
4a59fd13 PH	22	OPTION_STRING,
4a59fd13 PH	23	OPTION_INTEGER,
2a514ed8	24	OPTION_MAGNITUDE,
ffe659f9	25	OPTION_CALLBACK,
b0b3a8b6	26	OPTION_LOWLEVEL_CALLBACK,
df217ed6	27	OPTION_FILENAME
4a59fd13 PH	28	};
	29
	30	enum parse_opt_flags {
0171dbcb AH	31	PARSE_OPT_KEEP_DASHDASH = 1 << 0,
	32	PARSE_OPT_STOP_AT_NON_OPTION = 1 << 1,
	33	PARSE_OPT_KEEP_ARGV0 = 1 << 2,
	34	PARSE_OPT_KEEP_UNKNOWN = 1 << 3,
	35	PARSE_OPT_NO_INTERNAL_HELP = 1 << 4,
	36	PARSE_OPT_ONE_SHOT = 1 << 5,
4a59fd13 PH	37	};
4a59fd13 PH	38
ffe659f9	39	enum parse_opt_option_flags {
0171dbcb AH	40	PARSE_OPT_OPTARG = 1 << 0,
	41	PARSE_OPT_NOARG = 1 << 1,
	42	PARSE_OPT_NONEG = 1 << 2,
	43	PARSE_OPT_HIDDEN = 1 << 3,
	44	PARSE_OPT_LASTARG_DEFAULT = 1 << 4,
	45	PARSE_OPT_NODASH = 1 << 5,
	46	PARSE_OPT_LITERAL_ARGHELP = 1 << 6,
64cc539f	47	PARSE_OPT_FROM_ALIAS = 1 << 7,
0171dbcb AH	48	PARSE_OPT_SHELL_EVAL = 1 << 8,
	49	PARSE_OPT_NOCOMPLETE = 1 << 9,
	50	PARSE_OPT_COMP_ARG = 1 << 10,
	51	PARSE_OPT_CMDMODE = 1 << 11,
ffe659f9 PH	52	};
ffe659f9 PH	53
19800bdc RS	54	enum parse_opt_result {
	55	PARSE_OPT_COMPLETE = -3,
	56	PARSE_OPT_HELP = -2,
	57	PARSE_OPT_ERROR = -1, /* must be the same as error() */
	58	PARSE_OPT_DONE = 0, /* fixed so that "return 0" works */
	59	PARSE_OPT_NON_OPTION,
	60	PARSE_OPT_UNKNOWN
	61	};
	62
ffe659f9 PH	63	struct option;
	64	typedef int parse_opt_cb(const struct option , const char arg, int unset);
	65
b0b3a8b6	66	struct parse_opt_ctx_t;
f41179f1	67	typedef enum parse_opt_result parse_opt_ll_cb(struct parse_opt_ctx_t *ctx,
3ebbe289 NTND	68	const struct option *opt,
3ebbe289 NTND	69	const char *arg, int unset);
b0b3a8b6	70
9b3beb58 PH	71	/*
	72	* `type`::
	73	* holds the type of the option, you must have an OPTION_END last in your
	74	* array.
	75	*
	76	* `short_name`::
	77	* the character to use as a short option name, '\0' if none.
	78	*
	79	* `long_name`::
	80	* the long option name, without the leading dashes, NULL if none.
	81	*
	82	* `value`::
	83	* stores pointers to the values to be filled.
	84	*
	85	* `argh`::
4ca7994b JH	86	* token to explain the kind of argument this option wants. Does not
	87	* begin in capital letter, and does not end with a full stop.
	88	* Should be wrapped by N_() for translation.
9b3beb58 PH	89	*
	90	* `help`::
	91	* the short help associated to what the option does.
	92	* Must never be NULL (except for OPTION_END).
	93	* OPTION_GROUP uses this pointer to store the group header.
54e6dc7d	94	* Should be wrapped by N_() for translation.
9b3beb58 PH	95	*
	96	* `flags`::
	97	* mask of parse_opt_option_flags.
3ea3c215	98	* PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs)
ef45e4da	99	* PARSE_OPT_NOARG: says that this option does not take an argument
db7244bd	100	* PARSE_OPT_NONEG: says that this option cannot be negated
51a9949e RS	101	* PARSE_OPT_HIDDEN: this option is skipped in the default usage, and
51a9949e RS	102	* shown only in the full usage.
e169b974 SB	103	* PARSE_OPT_LASTARG_DEFAULT: says that this option will take the default
	104	* value if no argument is given when the option
	105	* is last on the command line. If the option is
	106	* not last it will require an argument.
	107	* Should not be used with PARSE_OPT_OPTARG.
51a9949e	108	* PARSE_OPT_NODASH: this option doesn't start with a dash.
29f25d49 SB	109	* PARSE_OPT_LITERAL_ARGHELP: says that argh shouldn't be enclosed in brackets
	110	* (i.e. '<argh>') in the help message.
	111	* Useful for options with multiple parameters.
b9d7f4b4 NTND	112	* PARSE_OPT_NOCOMPLETE: by default all visible options are completable
b9d7f4b4 NTND	113	* by git-completion.bash. This option suppresses that.
ebc4a04e NTND	114	* PARSE_OPT_COMP_ARG: this option forces to git-completion.bash to
	115	* complete an option as --name= not --name even if
	116	* the option takes optional argument.
9b3beb58 PH	117	*
9b3beb58 PH	118	* `callback`::
bf3ff338	119	* pointer to the callback to use for OPTION_CALLBACK
9b3beb58 PH	120	*
	121	* `defval`::
	122	* default value to fill (*->value) with for PARSE_OPT_OPTARG.
d3c08114	123	* OPTION_{BIT,SET_INT} store the {mask,integer} to put in the value when met.
9b3beb58	124	* CALLBACKS can use it like they want.
bf3ff338 NTND	125	*
	126	* `ll_callback`::
	127	* pointer to the callback to use for OPTION_LOWLEVEL_CALLBACK
	128	*
9b3beb58	129	*/
4a59fd13 PH	130	struct option {
	131	enum parse_opt_type type;
	132	int short_name;
	133	const char *long_name;
	134	void *value;
d7a38c54 PH	135	const char *argh;
d7a38c54 PH	136	const char *help;
ffe659f9 PH	137
	138	int flags;
	139	parse_opt_cb *callback;
ffe659f9	140	intptr_t defval;
bf3ff338	141	parse_opt_ll_cb *ll_callback;
f62470c6	142	intptr_t extra;
4a59fd13 PH	143	};
4a59fd13 PH	144
2de37349 NTND	145	#define OPT_BIT_F(s, l, v, h, b, f) { OPTION_BIT, (s), (l), (v), NULL, (h), \
	146	PARSE_OPT_NOARG\|(f), NULL, (b) }
	147	#define OPT_COUNTUP_F(s, l, v, h, f) { OPTION_COUNTUP, (s), (l), (v), NULL, \
	148	(h), PARSE_OPT_NOARG\|(f) }
	149	#define OPT_SET_INT_F(s, l, v, h, i, f) { OPTION_SET_INT, (s), (l), (v), NULL, \
	150	(h), PARSE_OPT_NOARG \| (f), NULL, (i) }
	151	#define OPT_BOOL_F(s, l, v, h, f) OPT_SET_INT_F(s, l, v, h, 1, f)
d473e2e0 NTND	152	#define OPT_CALLBACK_F(s, l, v, a, h, f, cb) \
d473e2e0 NTND	153	{ OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), (cb) }
31fba9d3	154	#define OPT_STRING_F(s, l, v, a, h, f) { OPTION_STRING, (s), (l), (v), (a), (h), (f) }
16ed6c97	155	#define OPT_INTEGER_F(s, l, v, h, f) { OPTION_INTEGER, (s), (l), (v), N_("n"), (h), (f) }
2de37349	156
4a59fd13	157	#define OPT_END() { OPTION_END }
1a85b49b JS	158	#define OPT_ARGUMENT(l, v, h) { OPTION_ARGUMENT, 0, (l), (v), NULL, \
1a85b49b JS	159	(h), PARSE_OPT_NOARG, NULL, 1 }
d7a38c54	160	#define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
2de37349	161	#define OPT_BIT(s, l, v, h, b) OPT_BIT_F(s, l, v, h, b, 0)
f62470c6 NTND	162	#define OPT_BITOP(s, l, v, h, set, clear) { OPTION_BITOP, (s), (l), (v), NULL, (h), \
f62470c6 NTND	163	PARSE_OPT_NOARG\|PARSE_OPT_NONEG, NULL, \
bf3ff338	164	(set), NULL, (clear) }
34aec9f5 SB	165	#define OPT_NEGBIT(s, l, v, h, b) { OPTION_NEGBIT, (s), (l), (v), NULL, \
34aec9f5 SB	166	(h), PARSE_OPT_NOARG, NULL, (b) }
2de37349 NTND	167	#define OPT_COUNTUP(s, l, v, h) OPT_COUNTUP_F(s, l, v, h, 0)
	168	#define OPT_SET_INT(s, l, v, h, i) OPT_SET_INT_F(s, l, v, h, i, 0)
	169	#define OPT_BOOL(s, l, v, h) OPT_BOOL_F(s, l, v, h, 0)
4741edd5 SB	170	#define OPT_HIDDEN_BOOL(s, l, v, h) { OPTION_SET_INT, (s), (l), (v), NULL, \
4741edd5 SB	171	(h), PARSE_OPT_NOARG \| PARSE_OPT_HIDDEN, NULL, 1}
bc8620b4 PB	172	#define OPT_CMDMODE(s, l, v, h, i) { OPTION_SET_INT, (s), (l), (v), NULL, \
bc8620b4 PB	173	(h), PARSE_OPT_CMDMODE\|PARSE_OPT_NOARG\|PARSE_OPT_NONEG, NULL, (i) }
16ed6c97	174	#define OPT_INTEGER(s, l, v, h) OPT_INTEGER_F(s, l, v, h, 0)
2a514ed8 CB	175	#define OPT_MAGNITUDE(s, l, v, h) { OPTION_MAGNITUDE, (s), (l), (v), \
2a514ed8 CB	176	N_("n"), (h), PARSE_OPT_NONEG }
31fba9d3	177	#define OPT_STRING(s, l, v, a, h) OPT_STRING_F(s, l, v, a, h, 0)
c8ba1639 JK	178	#define OPT_STRING_LIST(s, l, v, a, h) \
	179	{ OPTION_CALLBACK, (s), (l), (v), (a), \
	180	(h), 0, &parse_opt_string_list }
b475e442 NTND	181	#define OPT_UYN(s, l, v, h) { OPTION_CALLBACK, (s), (l), (v), NULL, \
b475e442 NTND	182	(h), PARSE_OPT_NOARG, &parse_opt_tertiary }
27ec394a	183	#define OPT_EXPIRY_DATE(s, l, v, h) \
e703d711	184	{ OPTION_CALLBACK, (s), (l), (v), N_("expiry-date"),(h), 0, \
27ec394a	185	parse_opt_expiry_date_cb }
d473e2e0	186	#define OPT_CALLBACK(s, l, v, a, h, f) OPT_CALLBACK_F(s, l, v, a, h, 0, f)
e0319ff5 RS	187	#define OPT_NUMBER_CALLBACK(v, h, f) \
	188	{ OPTION_NUMBER, 0, NULL, (v), NULL, (h), \
	189	PARSE_OPT_NOARG \| PARSE_OPT_NONEG, (f) }
df217ed6	190	#define OPT_FILENAME(s, l, v, h) { OPTION_FILENAME, (s), (l), (v), \
54e6dc7d	191	N_("file"), (h) }
73e9da01	192	#define OPT_COLOR_FLAG(s, l, v, h) \
54e6dc7d	193	{ OPTION_CALLBACK, (s), (l), (v), N_("when"), (h), PARSE_OPT_OPTARG, \
73e9da01 ML	194	parse_opt_color_flag_cb, (intptr_t)"always" }
73e9da01 ML	195
6acec038 RS	196	#define OPT_NOOP_NOARG(s, l) \
6acec038 RS	197	{ OPTION_CALLBACK, (s), (l), NULL, NULL, \
54e6dc7d	198	N_("no-op (backward compatibility)"), \
6acec038 RS	199	PARSE_OPT_HIDDEN \| PARSE_OPT_NOARG, parse_opt_noop_cb }
6acec038 RS	200
5c387428 NTND	201	#define OPT_ALIAS(s, l, source_long_name) \
	202	{ OPTION_ALIAS, (s), (l), (source_long_name) }
	203
202fbb33 NTND	204	/*
	205	* parse_options() will filter out the processed options and leave the
	206	* non-option arguments in argv[]. argv0 is assumed program name and
	207	* skipped.
	208	*
	209	* usagestr strings should be marked for translation with N_().
	210	*
4a59fd13	211	* Returns the number of arguments left in argv[].
202fbb33 NTND	212	*
	213	* In one-shot mode, argv0 is not a program name, argv[] is left
	214	* untouched and parse_options() returns the number of options
	215	* processed.
4a59fd13	216	*/
1987b0b2 NTND	217	int parse_options(int argc, const char *argv, const char prefix,
	218	const struct option *options,
	219	const char * const usagestr[], int flags);
d7a38c54	220
1987b0b2 NTND	221	NORETURN void usage_with_options(const char * const *usagestr,
1987b0b2 NTND	222	const struct option *options);
4a59fd13	223
1987b0b2 NTND	224	NORETURN void usage_msg_opt(const char *msg,
	225	const char * const *usagestr,
	226	const struct option *options);
451bb210	227
1987b0b2	228	int optbug(const struct option opt, const char reason);
9440b831	229	const char optname(const struct option opt, int flags);
a469a101	230
517fe807 JK	231	/*
	232	* Use these assertions for callbacks that expect to be called with NONEG and
	233	* NOARG respectively, and do not otherwise handle the "unset" and "arg"
	234	* parameters.
	235	*/
	236	#define BUG_ON_OPT_NEG(unset) do { \
	237	if ((unset)) \
	238	BUG("option callback does not expect negation"); \
	239	} while (0)
	240	#define BUG_ON_OPT_ARG(arg) do { \
	241	if ((arg)) \
	242	BUG("option callback does not expect an argument"); \
	243	} while (0)
	244
cbdeab98 BR	245	/*
	246	* Similar to the assertions above, but checks that "arg" is always non-NULL.
	247	* This assertion also implies BUG_ON_OPT_NEG(), letting you declare both
	248	* assertions in a single line.
	249	*/
	250	#define BUG_ON_OPT_NEG_NOARG(unset, arg) do { \
	251	BUG_ON_OPT_NEG(unset); \
	252	if(!(arg)) \
	253	BUG("option callback expects an argument"); \
	254	} while(0)
	255
3ea3c215	256	/----- incremental advanced APIs -----/
7e7bbcb4	257
26141b5b PH	258	/*
	259	* It's okay for the caller to consume argv/argc in the usual way.
	260	* Other fields of that structure are private to parse-options and should not
	261	* be modified in any way.
	262	*/
7e7bbcb4 PH	263	struct parse_opt_ctx_t {
	264	const char **argv;
	265	const char **out;
5ad0d3d5	266	int argc, cpidx, total;
7e7bbcb4 PH	267	const char *opt;
7e7bbcb4 PH	268	int flags;
37782920	269	const char *prefix;
5c387428 NTND	270	const char *alias_groups; / must be in groups of 3 elements! */
5c387428 NTND	271	struct option *updated_options;
7e7bbcb4 PH	272	};
7e7bbcb4 PH	273
1987b0b2 NTND	274	void parse_options_start(struct parse_opt_ctx_t *ctx,
	275	int argc, const char *argv, const char prefix,
	276	const struct option *options, int flags);
7e7bbcb4	277
1987b0b2 NTND	278	int parse_options_step(struct parse_opt_ctx_t *ctx,
	279	const struct option *options,
	280	const char * const usagestr[]);
ff43ec3e	281
1987b0b2	282	int parse_options_end(struct parse_opt_ctx_t *ctx);
7e7bbcb4	283
20871822	284	struct option parse_options_dup(const struct option a);
c8407857	285	struct option parse_options_concat(const struct option a, const struct option *b);
7e7bbcb4	286
0ce865b1	287	/----- some often used options -----/
1987b0b2 NTND	288	int parse_opt_abbrev_cb(const struct option , const char , int);
	289	int parse_opt_expiry_date_cb(const struct option , const char , int);
	290	int parse_opt_color_flag_cb(const struct option , const char , int);
	291	int parse_opt_verbosity_cb(const struct option , const char , int);
33898531	292	/* value is struct oid_array* */
1987b0b2	293	int parse_opt_object_name(const struct option , const char , int);
33898531 PW	294	/* value is struct object_id* */
33898531 PW	295	int parse_opt_object_id(const struct option , const char , int);
1987b0b2	296	int parse_opt_commits(const struct option , const char , int);
7d3488eb	297	int parse_opt_commit(const struct option , const char , int);
1987b0b2 NTND	298	int parse_opt_tertiary(const struct option , const char , int);
	299	int parse_opt_string_list(const struct option , const char , int);
	300	int parse_opt_noop_cb(const struct option , const char , int);
567fce1e JS	301	enum parse_opt_result parse_opt_unknown_cb(struct parse_opt_ctx_t *ctx,
	302	const struct option *,
	303	const char *, int);
1987b0b2 NTND	304	int parse_opt_passthru(const struct option , const char , int);
1987b0b2 NTND	305	int parse_opt_passthru_argv(const struct option , const char , int);
0ce865b1	306
212c0a6f NTND	307	#define OPT__VERBOSE(var, h) OPT_COUNTUP('v', "verbose", (var), (h))
212c0a6f NTND	308	#define OPT__QUIET(var, h) OPT_COUNTUP('q', "quiet", (var), (h))
7f87aff2	309	#define OPT__VERBOSITY(var) \
54e6dc7d	310	{ OPTION_CALLBACK, 'v', "verbose", (var), NULL, N_("be more verbose"), \
7f87aff2	311	PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
54e6dc7d	312	{ OPTION_CALLBACK, 'q', "quiet", (var), NULL, N_("be more quiet"), \
7f87aff2	313	PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
212c0a6f	314	#define OPT__DRY_RUN(var, h) OPT_BOOL('n', "dry-run", (var), (h))
1224781d	315	#define OPT__FORCE(var, h, f) OPT_COUNTUP_F('f', "force", (var), (h), (f))
0ce865b1	316	#define OPT__ABBREV(var) \
54e6dc7d	317	{ OPTION_CALLBACK, 0, "abbrev", (var), N_("n"), \
4279000d	318	N_("use <n> digits to display object names"), \
0ce865b1	319	PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
73e9da01 ML	320	#define OPT__COLOR(var, h) \
73e9da01 ML	321	OPT_COLOR_FLAG(0, "color", (var), (h))
7e29b825	322	#define OPT_COLUMN(s, l, v, h) \
a054e049	323	{ OPTION_CALLBACK, (s), (l), (v), N_("style"), (h), PARSE_OPT_OPTARG, parseopt_column_callback }
6b3ee18d PT	324	#define OPT_PASSTHRU(s, l, v, a, h, f) \
6b3ee18d PT	325	{ OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru }
ffad85c5 PT	326	#define OPT_PASSTHRU_ARGV(s, l, v, a, h, f) \
ffad85c5 PT	327	{ OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru_argv }
f266c916 KN	328	#define _OPT_CONTAINS_OR_WITH(name, variable, help, flag) \
	329	{ OPTION_CALLBACK, 0, name, (variable), N_("commit"), (help), \
	330	PARSE_OPT_LASTARG_DEFAULT \| flag, \
	331	parse_opt_commits, (intptr_t) "HEAD" \
	332	}
eab98ee5	333	#define OPT_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("contains", v, h, PARSE_OPT_NONEG)
ac3f5a34	334	#define OPT_NO_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("no-contains", v, h, PARSE_OPT_NONEG)
eab98ee5	335	#define OPT_WITH(v, h) _OPT_CONTAINS_OR_WITH("with", v, h, PARSE_OPT_HIDDEN \| PARSE_OPT_NONEG)
ac3f5a34	336	#define OPT_WITHOUT(v, h) _OPT_CONTAINS_OR_WITH("without", v, h, PARSE_OPT_HIDDEN \| PARSE_OPT_NONEG)
ca04dc96	337	#define OPT_CLEANUP(v) OPT_STRING(0, "cleanup", v, N_("mode"), N_("how to strip spaces and #comments from message"))
add97702 AM	338	#define OPT_PATHSPEC_FROM_FILE(v) OPT_FILENAME(0, "pathspec-from-file", v, N_("read pathspec from file"))
add97702 AM	339	#define OPT_PATHSPEC_FILE_NUL(v) OPT_BOOL(0, "pathspec-file-nul", v, N_("with --pathspec-from-file, pathspec elements are separated with NUL character"))
a03b5553	340	#define OPT_AUTOSTASH(v) OPT_BOOL(0, "autostash", v, N_("automatically stash/stash pop before and after"))
0ce865b1	341
4a59fd13	342	#endif