[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_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_OPT = 1 << 3,
	PARSE_OPT_NO_INTERNAL_HELP = 1 << 4,
	PARSE_OPT_ONE_SHOT = 1 << 5,
	PARSE_OPT_SHELL_EVAL = 1 << 6,
};

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_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.
 *   Is automatically enclosed in brackets when printed, unless it
 *   contains any of the following characters: ()<>[]|
 *   E.g. "name" is shown as "<name>" to indicate that a name value
 *   needs to be supplied, not the literal string "name", but
 *   "<start>,<end>" and "(this|that)" are printed verbatim.
 *
 * `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;

	enum parse_opt_option_flags 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_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_F(s, l, v, h, i, f)  { OPTION_SET_INT, (s), (l), (v), NULL, \
				      (h), PARSE_OPT_CMDMODE|PARSE_OPT_NOARG|PARSE_OPT_NONEG | (f), NULL, (i) }
#define OPT_CMDMODE(s, l, v, h, i)  OPT_CMDMODE_F(s, l, v, h, i, 0)

#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[],
		  enum parse_opt_flags 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);

/**
 * usage_msg_optf() is like usage_msg_opt() except that the first
 * argument is a format string, and optional format arguments follow
 * after the 3rd option.
 */
__attribute__((format (printf,1,4)))
void NORETURN usage_msg_optf(const char *fmt,
			     const char * const *usagestr,
			     const struct option *options, ...);

void die_for_incompatible_opt4(int opt1, const char *opt1_name,
			       int opt2, const char *opt2_name,
			       int opt3, const char *opt3_name,
			       int opt4, const char *opt4_name);


static inline void die_for_incompatible_opt3(int opt1, const char *opt1_name,
					     int opt2, const char *opt2_name,
					     int opt3, const char *opt3_name)
{
	die_for_incompatible_opt4(opt1, opt1_name,
				  opt2, opt2_name,
				  opt3, opt3_name,
				  0, "");
}

/*
 * 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;
	enum parse_opt_flags 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,
			 enum parse_opt_flags flags);

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