mirror of
https://github.com/git/git
synced 2024-08-28 20:20:07 +00:00
![SZEDER Gábor](/assets/img/avatar_default.png)
Several Git commands have subcommands to implement mutually exclusive "operation modes", and they usually parse their subcommand argument with a bunch of if-else if statements. Teach parse-options to handle subcommands as well, which will result in shorter and simpler code with consistent error handling and error messages on unknown or missing subcommand, and it will also make possible for our Bash completion script to handle subcommands programmatically. The approach is guided by the following observations: - Most subcommands [1] are implemented in dedicated functions, and most of those functions [2] either have a signature matching the 'int cmd_foo(int argc, const char **argc, const char *prefix)' signature of builtin commands or can be trivially converted to that signature, because they miss only that last prefix parameter or have no parameters at all. - Subcommand arguments only have long form, and they have no double dash prefix, no negated form, and no description, and they don't take any arguments, and can't be abbreviated. - There must be exactly one subcommand among the arguments, or zero if the command has a default operation mode. - All arguments following the subcommand are considered to be arguments of the subcommand, and, conversely, arguments meant for the subcommand may not preceed the subcommand. So in the end subcommand declaration and parsing would look something like this: parse_opt_subcommand_fn *fn = NULL; struct option builtin_commit_graph_options[] = { OPT_STRING(0, "object-dir", &opts.obj_dir, N_("dir"), N_("the object directory to store the graph")), OPT_SUBCOMMAND("verify", &fn, graph_verify), OPT_SUBCOMMAND("write", &fn, graph_write), OPT_END(), }; argc = parse_options(argc, argv, prefix, options, builtin_commit_graph_usage, 0); return fn(argc, argv, prefix); Here each OPT_SUBCOMMAND specifies the name of the subcommand and the function implementing it, and the address of the same 'fn' subcommand function pointer. parse_options() then processes the arguments until it finds the first argument matching one of the subcommands, sets 'fn' to the function associated with that subcommand, and returns, leaving the rest of the arguments unprocessed. If none of the listed subcommands is found among the arguments, parse_options() will show usage and abort. If a command has a default operation mode, 'fn' should be initialized to the function implementing that mode, and parse_options() should be invoked with the PARSE_OPT_SUBCOMMAND_OPTIONAL flag. In this case parse_options() won't error out when not finding any subcommands, but will return leaving 'fn' unchanged. Note that if that default operation mode has any --options, then the PARSE_OPT_KEEP_UNKNOWN_OPT flag is necessary as well (otherwise parse_options() would error out upon seeing the unknown option meant to the default operation mode). Some thoughts about the implementation: - The same pointer to 'fn' must be specified as 'value' for each OPT_SUBCOMMAND, because there can be only one set of mutually exclusive subcommands; parse_options() will BUG() otherwise. There are other ways to tell parse_options() where to put the function associated with the subcommand given on the command line, but I didn't like them: - Change parse_options()'s signature by adding a pointer to subcommand function to be set to the function associated with the given subcommand, affecting all callsites, even those that don't have subcommands. - Introduce a specific parse_options_and_subcommand() variant with that extra funcion parameter. - I decided against automatically calling the subcommand function from within parse_options(), because: - There are commands that have to perform additional actions after option parsing but before calling the function implementing the specified subcommand. - The return code of the subcommand is usually the return code of the git command, but preserving the return code of the automatically called subcommand function would have made the API awkward. - Also add a OPT_SUBCOMMAND_F() variant to allow specifying an option flag: we have two subcommands that are purposefully excluded from completion ('git remote rm' and 'git stash save'), so they'll have to be specified with the PARSE_OPT_NOCOMPLETE flag. - Some of the 'parse_opt_flags' don't make sense with subcommands, and using them is probably just an oversight or misunderstanding. Therefore parse_options() will BUG() when invoked with any of the following flags while the options array contains at least one OPT_SUBCOMMAND: - PARSE_OPT_KEEP_DASHDASH: parse_options() stops parsing arguments when encountering a "--" argument, so it doesn't make sense to expect and keep one before a subcommand, because it would prevent the parsing of the subcommand. However, this flag is allowed in combination with the PARSE_OPT_SUBCOMMAND_OPTIONAL flag, because the double dash might be meaningful for the command's default operation mode, e.g. to disambiguate refs and pathspecs. - PARSE_OPT_STOP_AT_NON_OPTION: As its name suggests, this flag tells parse_options() to stop as soon as it encouners a non-option argument, but subcommands are by definition not options... so how could they be parsed, then?! - PARSE_OPT_KEEP_UNKNOWN: This flag can be used to collect any unknown --options and then pass them to a different command or subsystem. Surely if a command has subcommands, then this functionality should rather be delegated to one of those subcommands, and not performed by the command itself. However, this flag is allowed in combination with the PARSE_OPT_SUBCOMMAND_OPTIONAL flag, making possible to pass --options to the default operation mode. - If the command with subcommands has a default operation mode, then all arguments to the command must preceed the arguments of the subcommand. AFAICT we don't have any commands where this makes a difference, because in those commands either only the command accepts any arguments ('notes' and 'remote'), or only the default subcommand ('reflog' and 'stash'), but never both. - The 'argv' array passed to subcommand functions currently starts with the name of the subcommand. Keep this behavior. AFAICT no subcommand functions depend on the actual content of 'argv[0]', but the parse_options() call handling their options expects that the options start at argv[1]. - To support handling subcommands programmatically in our Bash completion script, 'git cmd --git-completion-helper' will now list both subcommands and regular --options, if any. This means that the completion script will have to separate subcommands (i.e. words without a double dash prefix) from --options on its own, but that's rather easy to do, and it's not much work either, because the number of subcommands a command might have is rather low, and those commands accept only a single --option or none at all. An alternative would be to introduce a separate option that lists only subcommands, but then the completion script would need not one but two git invocations and command substitutions for commands with subcommands. Note that this change doesn't affect the behavior of our Bash completion script, because when completing the --option of a command with subcommands, e.g. for 'git notes --<TAB>', then all subcommands will be filtered out anyway, as none of them will match the word to be completed starting with that double dash prefix. [1] Except 'git rerere', because many of its subcommands are implemented in the bodies of the if-else if statements parsing the command's subcommand argument. [2] Except 'credential', 'credential-store' and 'fsmonitor--daemon', because some of the functions implementing their subcommands take special parameters. Signed-off-by: SZEDER Gábor <szeder.dev@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
395 lines
15 KiB
C
395 lines
15 KiB
C
#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,
|
|
OPTION_SUBCOMMAND,
|
|
/* 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,
|
|
PARSE_OPT_SUBCOMMAND_OPTIONAL = 1 << 7,
|
|
};
|
|
|
|
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_SUBCOMMAND,
|
|
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);
|
|
|
|
typedef int parse_opt_subcommand_fn(int argc, const char **argv,
|
|
const char *prefix);
|
|
|
|
/*
|
|
* `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 (without the leading dashes) or subcommand name,
|
|
* 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 and OPTION_SUBCOMMAND).
|
|
* 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; can only be a
|
|
* short option and can't accept arguments.
|
|
* 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
|
|
*
|
|
* `subcommand_fn`::
|
|
* pointer to a function to use for OPTION_SUBCOMMAND.
|
|
* It will be put in value when the subcommand is given on the command line.
|
|
*/
|
|
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;
|
|
parse_opt_subcommand_fn *subcommand_fn;
|
|
};
|
|
|
|
#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) }
|
|
|
|
#define OPT_SUBCOMMAND_F(l, v, fn, f) { \
|
|
.type = OPTION_SUBCOMMAND, \
|
|
.long_name = (l), \
|
|
.value = (v), \
|
|
.flags = (f), \
|
|
.subcommand_fn = (fn) }
|
|
#define OPT_SUBCOMMAND(l, v, fn) OPT_SUBCOMMAND_F((l), (v), (fn), 0)
|
|
|
|
/*
|
|
* 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;
|
|
unsigned has_subcommands;
|
|
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
|