2007-10-14 23:35:37 +00:00
|
|
|
#ifndef PARSE_OPTIONS_H
|
|
|
|
#define PARSE_OPTIONS_H
|
|
|
|
|
|
|
|
enum parse_opt_type {
|
2007-11-07 10:20:27 +00:00
|
|
|
/* special types */
|
2007-10-14 23:35:37 +00:00
|
|
|
OPTION_END,
|
2008-03-02 10:35:56 +00:00
|
|
|
OPTION_ARGUMENT,
|
2007-10-14 23:38:30 +00:00
|
|
|
OPTION_GROUP,
|
2009-05-07 19:45:08 +00:00
|
|
|
OPTION_NUMBER,
|
2007-11-07 10:20:27 +00:00
|
|
|
/* options with no arguments */
|
|
|
|
OPTION_BIT,
|
2009-05-07 19:44:17 +00:00
|
|
|
OPTION_NEGBIT,
|
parse-options: deprecate OPT_BOOLEAN
It is natural to expect that an option defined with OPT_BOOLEAN() could be
used in this way:
int option = -1; /* unspecified */
struct option options[] = {
OPT_BOOLEAN(0, "option", &option, "set option"),
OPT_END()
};
parse_options(ac, av, prefix, options, usage, 0);
if (option < 0)
... do the default thing ...
else if (!option)
... --no-option was given ...
else
... --option was given ...
to easily tell three cases apart:
- There is no mention of the `--option` on the command line;
- The variable is positively set with `--option`; or
- The variable is explicitly negated with `--no-option`.
Unfortunately, this is not the case. OPT_BOOLEAN() increments the variable
every time `--option` is given, and resets it to zero when `--no-option`
is given.
As a first step to remedy this, introduce a true boolean OPT_BOOL(), and
rename OPT_BOOLEAN() to OPT_COUNTUP(). To help transitioning, OPT_BOOLEAN
and OPTION_BOOLEAN are defined as deprecated synonyms to OPT_COUNTUP and
OPTION_COUNTUP respectively.
This is what db7244b (parse-options new features., 2007-11-07) from four
years ago started by marking OPTION_BOOLEAN as "INCR would have been a
better name".
Some existing users do depend on the count-up semantics; for example,
users of OPT__VERBOSE() could use it to raise the verbosity level with
repeated use of `-v` on the command line, but they probably should be
rewritten to use OPT__VERBOSITY() instead these days. I suspect that some
users of OPT__FORCE() may also use it to implement different level of
forcibleness but I didn't check.
On top of this patch, here are the remaining clean-up tasks that other
people can help:
- Look at each hit in "git grep -e OPT_BOOLEAN"; trace all uses of the
value that is set to the underlying variable, and if it can proven that
the variable is only used as a boolean, replace it with OPT_BOOL(). If
the caller does depend on the count-up semantics, replace it with
OPT_COUNTUP() instead.
- Same for OPTION_BOOLEAN; replace it with OPTION_SET_INT and arrange to
set 1 to the variable for a true boolean, and otherwise replace it with
OPTION_COUNTUP.
- Look at each hit in "git grep -e OPT__VERBOSE -e OPT__QUIET" and see if
they can be replaced with OPT__VERBOSITY().
I'll follow this message up with a separate patch as an example.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2011-09-27 23:56:49 +00:00
|
|
|
OPTION_COUNTUP,
|
2007-11-07 10:20:27 +00:00
|
|
|
OPTION_SET_INT,
|
2013-07-30 19:06:01 +00:00
|
|
|
OPTION_CMDMODE,
|
2007-11-07 10:20:27 +00:00
|
|
|
/* options with arguments (usually) */
|
2007-10-14 23:35:37 +00:00
|
|
|
OPTION_STRING,
|
|
|
|
OPTION_INTEGER,
|
2015-06-21 18:25:44 +00:00
|
|
|
OPTION_MAGNITUDE,
|
2007-10-14 23:45:45 +00:00
|
|
|
OPTION_CALLBACK,
|
parse-options: allow git commands to invent new option types
parse-options provides a variety of option behaviors, including
OPTION_CALLBACK, which should take care of just about any sane
behavior. All supported behaviors obey the following constraint:
A --foo option can only accept (and base its behavior on)
one argument, which would be the following command-line
argument in the "unsticked" form.
Alas, some existing git commands have options that do not obey that
constraint. For example, update-index --cacheinfo takes three
arguments, and update-index --resolve takes all later parameters as
arguments.
Introduces an OPTION_LOWLEVEL_CALLBACK backdoor to parse-options so
such option types can be supported without tempting inventors of other
commands through mention in the public API. Commands can set the
callback field to a function accepting three arguments: the option
parsing context, the option itself, and a flag indicating whether the
the option was negated. When the option is encountered, that function
is called to take over from get_value(). The return value should be
zero for success, -1 for usage errors.
Thanks to Stephen Boyd for API guidance.
Improved-by: Stephen Boyd <bebarino@gmail.com>
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-12-01 23:32:16 +00:00
|
|
|
OPTION_LOWLEVEL_CALLBACK,
|
2009-05-23 18:53:13 +00:00
|
|
|
OPTION_FILENAME
|
2007-10-14 23:35:37 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
enum parse_opt_flags {
|
|
|
|
PARSE_OPT_KEEP_DASHDASH = 1,
|
2008-02-29 01:45:09 +00:00
|
|
|
PARSE_OPT_STOP_AT_NON_OPTION = 2,
|
2008-06-23 22:31:31 +00:00
|
|
|
PARSE_OPT_KEEP_ARGV0 = 4,
|
2009-03-08 18:12:47 +00:00
|
|
|
PARSE_OPT_KEEP_UNKNOWN = 8,
|
2010-05-14 09:31:35 +00:00
|
|
|
PARSE_OPT_NO_INTERNAL_HELP = 16
|
2007-10-14 23:35:37 +00:00
|
|
|
};
|
|
|
|
|
2007-10-14 23:45:45 +00:00
|
|
|
enum parse_opt_option_flags {
|
|
|
|
PARSE_OPT_OPTARG = 1,
|
2007-10-15 22:32:38 +00:00
|
|
|
PARSE_OPT_NOARG = 2,
|
2007-11-07 10:20:27 +00:00
|
|
|
PARSE_OPT_NONEG = 4,
|
2007-11-19 09:21:44 +00:00
|
|
|
PARSE_OPT_HIDDEN = 8,
|
2008-07-08 10:34:08 +00:00
|
|
|
PARSE_OPT_LASTARG_DEFAULT = 16,
|
2009-05-07 19:45:42 +00:00
|
|
|
PARSE_OPT_NODASH = 32,
|
2009-05-21 07:33:17 +00:00
|
|
|
PARSE_OPT_LITERAL_ARGHELP = 64,
|
2018-02-09 11:01:40 +00:00
|
|
|
PARSE_OPT_SHELL_EVAL = 256,
|
2018-02-09 11:02:12 +00:00
|
|
|
PARSE_OPT_NOCOMPLETE = 512,
|
|
|
|
PARSE_OPT_COMP_ARG = 1024
|
2007-10-14 23:45:45 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
struct option;
|
|
|
|
typedef int parse_opt_cb(const struct option *, const char *arg, int unset);
|
|
|
|
|
parse-options: allow git commands to invent new option types
parse-options provides a variety of option behaviors, including
OPTION_CALLBACK, which should take care of just about any sane
behavior. All supported behaviors obey the following constraint:
A --foo option can only accept (and base its behavior on)
one argument, which would be the following command-line
argument in the "unsticked" form.
Alas, some existing git commands have options that do not obey that
constraint. For example, update-index --cacheinfo takes three
arguments, and update-index --resolve takes all later parameters as
arguments.
Introduces an OPTION_LOWLEVEL_CALLBACK backdoor to parse-options so
such option types can be supported without tempting inventors of other
commands through mention in the public API. Commands can set the
callback field to a function accepting three arguments: the option
parsing context, the option itself, and a flag indicating whether the
the option was negated. When the option is encountered, that function
is called to take over from get_value(). The return value should be
zero for success, -1 for usage errors.
Thanks to Stephen Boyd for API guidance.
Improved-by: Stephen Boyd <bebarino@gmail.com>
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-12-01 23:32:16 +00:00
|
|
|
struct parse_opt_ctx_t;
|
|
|
|
typedef int parse_opt_ll_cb(struct parse_opt_ctx_t *ctx,
|
|
|
|
const struct option *opt, int unset);
|
|
|
|
|
2007-11-05 12:03:22 +00:00
|
|
|
/*
|
|
|
|
* `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
|
2012-05-06 14:23:51 +00:00
|
|
|
* homogeneous across the repository. Should be wrapped by N_() for
|
|
|
|
* translation.
|
2007-11-05 12:03:22 +00:00
|
|
|
*
|
|
|
|
* `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.
|
2012-05-06 14:23:51 +00:00
|
|
|
* Should be wrapped by N_() for translation.
|
2007-11-05 12:03:22 +00:00
|
|
|
*
|
|
|
|
* `flags`::
|
|
|
|
* mask of parse_opt_option_flags.
|
2009-04-17 18:13:30 +00:00
|
|
|
* PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs)
|
2010-08-22 16:26:38 +00:00
|
|
|
* PARSE_OPT_NOARG: says that this option does not take an argument
|
2007-11-07 10:20:27 +00:00
|
|
|
* PARSE_OPT_NONEG: says that this option cannot be negated
|
2009-05-07 19:45:42 +00:00
|
|
|
* PARSE_OPT_HIDDEN: this option is skipped in the default usage, and
|
|
|
|
* shown only in the full usage.
|
2009-06-07 23:39:15 +00:00
|
|
|
* 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.
|
2009-05-07 19:45:42 +00:00
|
|
|
* PARSE_OPT_NODASH: this option doesn't start with a dash.
|
2009-05-21 07:33:17 +00:00
|
|
|
* 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.
|
2018-02-09 11:01:40 +00:00
|
|
|
* PARSE_OPT_NOCOMPLETE: by default all visible options are completable
|
|
|
|
* by git-completion.bash. This option suppresses that.
|
2018-02-09 11:02:12 +00:00
|
|
|
* 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.
|
2007-11-05 12:03:22 +00:00
|
|
|
*
|
|
|
|
* `callback`::
|
parse-options: allow git commands to invent new option types
parse-options provides a variety of option behaviors, including
OPTION_CALLBACK, which should take care of just about any sane
behavior. All supported behaviors obey the following constraint:
A --foo option can only accept (and base its behavior on)
one argument, which would be the following command-line
argument in the "unsticked" form.
Alas, some existing git commands have options that do not obey that
constraint. For example, update-index --cacheinfo takes three
arguments, and update-index --resolve takes all later parameters as
arguments.
Introduces an OPTION_LOWLEVEL_CALLBACK backdoor to parse-options so
such option types can be supported without tempting inventors of other
commands through mention in the public API. Commands can set the
callback field to a function accepting three arguments: the option
parsing context, the option itself, and a flag indicating whether the
the option was negated. When the option is encountered, that function
is called to take over from get_value(). The return value should be
zero for success, -1 for usage errors.
Thanks to Stephen Boyd for API guidance.
Improved-by: Stephen Boyd <bebarino@gmail.com>
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-12-01 23:32:16 +00:00
|
|
|
* pointer to the callback to use for OPTION_CALLBACK or
|
|
|
|
* OPTION_LOWLEVEL_CALLBACK.
|
2007-11-05 12:03:22 +00:00
|
|
|
*
|
|
|
|
* `defval`::
|
|
|
|
* default value to fill (*->value) with for PARSE_OPT_OPTARG.
|
2015-03-29 08:32:55 +00:00
|
|
|
* OPTION_{BIT,SET_INT} store the {mask,integer} to put in the value when met.
|
2007-11-05 12:03:22 +00:00
|
|
|
* CALLBACKS can use it like they want.
|
|
|
|
*/
|
2007-10-14 23:35:37 +00:00
|
|
|
struct option {
|
|
|
|
enum parse_opt_type type;
|
|
|
|
int short_name;
|
|
|
|
const char *long_name;
|
|
|
|
void *value;
|
2007-10-14 23:38:30 +00:00
|
|
|
const char *argh;
|
|
|
|
const char *help;
|
2007-10-14 23:45:45 +00:00
|
|
|
|
|
|
|
int flags;
|
|
|
|
parse_opt_cb *callback;
|
|
|
|
intptr_t defval;
|
2007-10-14 23:35:37 +00:00
|
|
|
};
|
|
|
|
|
2018-02-09 11:01:41 +00:00
|
|
|
#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)
|
|
|
|
|
2007-10-14 23:35:37 +00:00
|
|
|
#define OPT_END() { OPTION_END }
|
2009-06-04 23:43:57 +00:00
|
|
|
#define OPT_ARGUMENT(l, h) { OPTION_ARGUMENT, 0, (l), NULL, NULL, \
|
|
|
|
(h), PARSE_OPT_NOARG}
|
2007-10-14 23:38:30 +00:00
|
|
|
#define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
|
2018-02-09 11:01:41 +00:00
|
|
|
#define OPT_BIT(s, l, v, h, b) OPT_BIT_F(s, l, v, h, b, 0)
|
2009-06-04 23:43:57 +00:00
|
|
|
#define OPT_NEGBIT(s, l, v, h, b) { OPTION_NEGBIT, (s), (l), (v), NULL, \
|
|
|
|
(h), PARSE_OPT_NOARG, NULL, (b) }
|
2018-02-09 11:01:41 +00:00
|
|
|
#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)
|
2013-08-03 11:51:18 +00:00
|
|
|
#define OPT_HIDDEN_BOOL(s, l, v, h) { OPTION_SET_INT, (s), (l), (v), NULL, \
|
|
|
|
(h), PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, 1}
|
2015-07-29 20:18:37 +00:00
|
|
|
#define OPT_CMDMODE(s, l, v, h, i) { OPTION_CMDMODE, (s), (l), (v), NULL, \
|
2013-07-30 19:06:01 +00:00
|
|
|
(h), PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, (i) }
|
2012-05-06 14:23:51 +00:00
|
|
|
#define OPT_INTEGER(s, l, v, h) { OPTION_INTEGER, (s), (l), (v), N_("n"), (h) }
|
2015-06-21 18:25:44 +00:00
|
|
|
#define OPT_MAGNITUDE(s, l, v, h) { OPTION_MAGNITUDE, (s), (l), (v), \
|
|
|
|
N_("n"), (h), PARSE_OPT_NONEG }
|
2007-10-14 23:38:30 +00:00
|
|
|
#define OPT_STRING(s, l, v, a, h) { OPTION_STRING, (s), (l), (v), (a), (h) }
|
2011-06-09 15:55:23 +00:00
|
|
|
#define OPT_STRING_LIST(s, l, v, a, h) \
|
|
|
|
{ OPTION_CALLBACK, (s), (l), (v), (a), \
|
|
|
|
(h), 0, &parse_opt_string_list }
|
2018-03-07 01:05:01 +00:00
|
|
|
#define OPT_UYN(s, l, v, h) { OPTION_CALLBACK, (s), (l), (v), NULL, \
|
|
|
|
(h), PARSE_OPT_NOARG, &parse_opt_tertiary }
|
2008-03-24 14:02:21 +00:00
|
|
|
#define OPT_DATE(s, l, v, h) \
|
2012-05-06 14:23:51 +00:00
|
|
|
{ OPTION_CALLBACK, (s), (l), (v), N_("time"),(h), 0, \
|
2008-03-24 14:02:21 +00:00
|
|
|
parse_opt_approxidate_cb }
|
2013-04-25 18:13:49 +00:00
|
|
|
#define OPT_EXPIRY_DATE(s, l, v, h) \
|
2014-03-23 22:58:12 +00:00
|
|
|
{ OPTION_CALLBACK, (s), (l), (v), N_("expiry-date"),(h), 0, \
|
2013-04-25 18:13:49 +00:00
|
|
|
parse_opt_expiry_date_cb }
|
2007-10-14 23:45:45 +00:00
|
|
|
#define OPT_CALLBACK(s, l, v, a, h, f) \
|
|
|
|
{ OPTION_CALLBACK, (s), (l), (v), (a), (h), 0, (f) }
|
2009-05-07 19:45:08 +00:00
|
|
|
#define OPT_NUMBER_CALLBACK(v, h, f) \
|
|
|
|
{ OPTION_NUMBER, 0, NULL, (v), NULL, (h), \
|
|
|
|
PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) }
|
2009-05-23 18:53:13 +00:00
|
|
|
#define OPT_FILENAME(s, l, v, h) { OPTION_FILENAME, (s), (l), (v), \
|
2012-05-06 14:23:51 +00:00
|
|
|
N_("file"), (h) }
|
Add an optional argument for --color options
Make git-branch, git-show-branch, git-grep, and all the diff-based
programs accept an optional argument <when> for --color. The argument
is a colorbool: "always", "never", or "auto". If no argument is given,
"always" is used; --no-color is an alias for --color=never. This makes
the command-line interface consistent with other GNU tools, such as `ls'
and `grep', and with the git-config color options. Note that, without
an argument, --color and --no-color work exactly as before.
To implement this, two internal changes were made:
1. Allow the first argument of git_config_colorbool() to be NULL,
in which case it returns -1 if the argument isn't "always", "never",
or "auto".
2. Add OPT_COLOR_FLAG(), OPT__COLOR(), and parse_opt_color_flag_cb()
to the option parsing library. The callback uses
git_config_colorbool(), so color.h is now a dependency
of parse-options.c.
Signed-off-by: Mark Lodato <lodatom@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-02-17 04:55:58 +00:00
|
|
|
#define OPT_COLOR_FLAG(s, l, v, h) \
|
2012-05-06 14:23:51 +00:00
|
|
|
{ OPTION_CALLBACK, (s), (l), (v), N_("when"), (h), PARSE_OPT_OPTARG, \
|
Add an optional argument for --color options
Make git-branch, git-show-branch, git-grep, and all the diff-based
programs accept an optional argument <when> for --color. The argument
is a colorbool: "always", "never", or "auto". If no argument is given,
"always" is used; --no-color is an alias for --color=never. This makes
the command-line interface consistent with other GNU tools, such as `ls'
and `grep', and with the git-config color options. Note that, without
an argument, --color and --no-color work exactly as before.
To implement this, two internal changes were made:
1. Allow the first argument of git_config_colorbool() to be NULL,
in which case it returns -1 if the argument isn't "always", "never",
or "auto".
2. Add OPT_COLOR_FLAG(), OPT__COLOR(), and parse_opt_color_flag_cb()
to the option parsing library. The callback uses
git_config_colorbool(), so color.h is now a dependency
of parse-options.c.
Signed-off-by: Mark Lodato <lodatom@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-02-17 04:55:58 +00:00
|
|
|
parse_opt_color_flag_cb, (intptr_t)"always" }
|
|
|
|
|
2011-09-28 17:44:30 +00:00
|
|
|
#define OPT_NOOP_NOARG(s, l) \
|
|
|
|
{ OPTION_CALLBACK, (s), (l), NULL, NULL, \
|
2012-05-06 14:23:51 +00:00
|
|
|
N_("no-op (backward compatibility)"), \
|
2011-09-28 17:44:30 +00:00
|
|
|
PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, parse_opt_noop_cb }
|
|
|
|
|
2007-10-14 23:35:37 +00:00
|
|
|
/* parse_options() will filter out the processed options and leave the
|
2012-05-06 14:23:51 +00:00
|
|
|
* non-option arguments in argv[]. usagestr strings should be marked
|
|
|
|
* for translation with N_().
|
2007-10-14 23:35:37 +00:00
|
|
|
* Returns the number of arguments left in argv[].
|
|
|
|
*/
|
2009-05-23 18:53:12 +00:00
|
|
|
extern int parse_options(int argc, const char **argv, const char *prefix,
|
2007-10-14 23:35:37 +00:00
|
|
|
const struct option *options,
|
2007-10-14 23:38:30 +00:00
|
|
|
const char * const usagestr[], int flags);
|
|
|
|
|
|
|
|
extern NORETURN void usage_with_options(const char * const *usagestr,
|
|
|
|
const struct option *options);
|
2007-10-14 23:35:37 +00:00
|
|
|
|
2009-02-02 05:12:58 +00:00
|
|
|
extern NORETURN void usage_msg_opt(const char *msg,
|
|
|
|
const char * const *usagestr,
|
|
|
|
const struct option *options);
|
|
|
|
|
2011-08-11 09:15:37 +00:00
|
|
|
extern int optbug(const struct option *opt, const char *reason);
|
|
|
|
extern int opterror(const struct option *opt, const char *reason, int flags);
|
2014-05-06 15:17:50 +00:00
|
|
|
#if defined(__GNUC__)
|
2014-05-06 15:14:42 +00:00
|
|
|
#define opterror(o,r,f) (opterror((o),(r),(f)), const_error())
|
2012-12-15 17:42:10 +00:00
|
|
|
#endif
|
|
|
|
|
2009-04-17 18:13:30 +00:00
|
|
|
/*----- incremental advanced APIs -----*/
|
2008-06-23 19:59:37 +00:00
|
|
|
|
2008-06-23 20:28:04 +00:00
|
|
|
enum {
|
|
|
|
PARSE_OPT_HELP = -1,
|
|
|
|
PARSE_OPT_DONE,
|
2010-12-01 23:32:55 +00:00
|
|
|
PARSE_OPT_NON_OPTION,
|
2010-05-14 09:31:35 +00:00
|
|
|
PARSE_OPT_UNKNOWN
|
2008-06-23 20:28:04 +00:00
|
|
|
};
|
|
|
|
|
2008-06-23 20:55:11 +00:00
|
|
|
/*
|
|
|
|
* 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.
|
|
|
|
*/
|
2008-06-23 19:59:37 +00:00
|
|
|
struct parse_opt_ctx_t {
|
|
|
|
const char **argv;
|
|
|
|
const char **out;
|
2015-11-17 10:25:38 +00:00
|
|
|
int argc, cpidx, total;
|
2008-06-23 19:59:37 +00:00
|
|
|
const char *opt;
|
|
|
|
int flags;
|
2009-05-23 18:53:12 +00:00
|
|
|
const char *prefix;
|
2008-06-23 19:59:37 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
extern void parse_options_start(struct parse_opt_ctx_t *ctx,
|
2009-05-23 18:53:12 +00:00
|
|
|
int argc, const char **argv, const char *prefix,
|
2010-12-06 07:57:42 +00:00
|
|
|
const struct option *options, int flags);
|
2008-06-23 19:59:37 +00:00
|
|
|
|
2008-06-23 20:38:58 +00:00
|
|
|
extern int parse_options_step(struct parse_opt_ctx_t *ctx,
|
|
|
|
const struct option *options,
|
|
|
|
const char * const usagestr[]);
|
|
|
|
|
2008-06-23 19:59:37 +00:00
|
|
|
extern int parse_options_end(struct parse_opt_ctx_t *ctx);
|
|
|
|
|
2016-07-05 20:44:47 +00:00
|
|
|
extern struct option *parse_options_concat(struct option *a, struct option *b);
|
2008-06-23 19:59:37 +00:00
|
|
|
|
2007-10-14 09:05:12 +00:00
|
|
|
/*----- some often used options -----*/
|
|
|
|
extern int parse_opt_abbrev_cb(const struct option *, const char *, int);
|
2008-03-24 14:02:21 +00:00
|
|
|
extern int parse_opt_approxidate_cb(const struct option *, const char *, int);
|
2013-04-25 18:13:49 +00:00
|
|
|
extern int parse_opt_expiry_date_cb(const struct option *, const char *, int);
|
Add an optional argument for --color options
Make git-branch, git-show-branch, git-grep, and all the diff-based
programs accept an optional argument <when> for --color. The argument
is a colorbool: "always", "never", or "auto". If no argument is given,
"always" is used; --no-color is an alias for --color=never. This makes
the command-line interface consistent with other GNU tools, such as `ls'
and `grep', and with the git-config color options. Note that, without
an argument, --color and --no-color work exactly as before.
To implement this, two internal changes were made:
1. Allow the first argument of git_config_colorbool() to be NULL,
in which case it returns -1 if the argument isn't "always", "never",
or "auto".
2. Add OPT_COLOR_FLAG(), OPT__COLOR(), and parse_opt_color_flag_cb()
to the option parsing library. The callback uses
git_config_colorbool(), so color.h is now a dependency
of parse-options.c.
Signed-off-by: Mark Lodato <lodatom@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-02-17 04:55:58 +00:00
|
|
|
extern int parse_opt_color_flag_cb(const struct option *, const char *, int);
|
2008-11-15 00:14:24 +00:00
|
|
|
extern int parse_opt_verbosity_cb(const struct option *, const char *, int);
|
2015-07-07 16:06:08 +00:00
|
|
|
extern int parse_opt_object_name(const struct option *, const char *, int);
|
2015-07-07 16:06:14 +00:00
|
|
|
extern int parse_opt_commits(const struct option *, const char *, int);
|
2009-12-04 08:20:48 +00:00
|
|
|
extern int parse_opt_tertiary(const struct option *, const char *, int);
|
2011-06-09 15:55:23 +00:00
|
|
|
extern int parse_opt_string_list(const struct option *, const char *, int);
|
2011-09-28 17:44:30 +00:00
|
|
|
extern int parse_opt_noop_cb(const struct option *, const char *, int);
|
2016-09-05 09:44:52 +00:00
|
|
|
extern int parse_opt_unknown_cb(const struct option *, const char *, int);
|
2015-06-14 08:41:48 +00:00
|
|
|
extern int parse_opt_passthru(const struct option *, const char *, int);
|
2015-06-14 08:41:49 +00:00
|
|
|
extern int parse_opt_passthru_argv(const struct option *, const char *, int);
|
2007-10-14 09:05:12 +00:00
|
|
|
|
2013-12-07 05:02:53 +00:00
|
|
|
#define OPT__VERBOSE(var, h) OPT_COUNTUP('v', "verbose", (var), (h))
|
|
|
|
#define OPT__QUIET(var, h) OPT_COUNTUP('q', "quiet", (var), (h))
|
2008-11-15 00:14:24 +00:00
|
|
|
#define OPT__VERBOSITY(var) \
|
2012-05-06 14:23:51 +00:00
|
|
|
{ OPTION_CALLBACK, 'v', "verbose", (var), NULL, N_("be more verbose"), \
|
2008-11-15 00:14:24 +00:00
|
|
|
PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
|
2012-05-06 14:23:51 +00:00
|
|
|
{ OPTION_CALLBACK, 'q', "quiet", (var), NULL, N_("be more quiet"), \
|
2008-11-15 00:14:24 +00:00
|
|
|
PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
|
2013-12-07 05:02:53 +00:00
|
|
|
#define OPT__DRY_RUN(var, h) OPT_BOOL('n', "dry-run", (var), (h))
|
2018-02-09 11:01:42 +00:00
|
|
|
#define OPT__FORCE(var, h, f) OPT_COUNTUP_F('f', "force", (var), (h), (f))
|
2007-10-14 09:05:12 +00:00
|
|
|
#define OPT__ABBREV(var) \
|
2012-05-06 14:23:51 +00:00
|
|
|
{ OPTION_CALLBACK, 0, "abbrev", (var), N_("n"), \
|
|
|
|
N_("use <n> digits to display SHA-1s"), \
|
2007-10-14 09:05:12 +00:00
|
|
|
PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
|
Add an optional argument for --color options
Make git-branch, git-show-branch, git-grep, and all the diff-based
programs accept an optional argument <when> for --color. The argument
is a colorbool: "always", "never", or "auto". If no argument is given,
"always" is used; --no-color is an alias for --color=never. This makes
the command-line interface consistent with other GNU tools, such as `ls'
and `grep', and with the git-config color options. Note that, without
an argument, --color and --no-color work exactly as before.
To implement this, two internal changes were made:
1. Allow the first argument of git_config_colorbool() to be NULL,
in which case it returns -1 if the argument isn't "always", "never",
or "auto".
2. Add OPT_COLOR_FLAG(), OPT__COLOR(), and parse_opt_color_flag_cb()
to the option parsing library. The callback uses
git_config_colorbool(), so color.h is now a dependency
of parse-options.c.
Signed-off-by: Mark Lodato <lodatom@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-02-17 04:55:58 +00:00
|
|
|
#define OPT__COLOR(var, h) \
|
|
|
|
OPT_COLOR_FLAG(0, "color", (var), (h))
|
2012-04-21 04:44:32 +00:00
|
|
|
#define OPT_COLUMN(s, l, v, h) \
|
2012-08-20 12:31:50 +00:00
|
|
|
{ OPTION_CALLBACK, (s), (l), (v), N_("style"), (h), PARSE_OPT_OPTARG, parseopt_column_callback }
|
2015-06-14 08:41:48 +00:00
|
|
|
#define OPT_PASSTHRU(s, l, v, a, h, f) \
|
|
|
|
{ OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru }
|
2015-06-14 08:41:49 +00:00
|
|
|
#define OPT_PASSTHRU_ARGV(s, l, v, a, h, f) \
|
|
|
|
{ OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru_argv }
|
2015-07-07 16:06:15 +00:00
|
|
|
#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" \
|
|
|
|
}
|
2017-03-24 18:40:53 +00:00
|
|
|
#define OPT_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("contains", v, h, PARSE_OPT_NONEG)
|
ref-filter: add --no-contains option to tag/branch/for-each-ref
Change the tag, branch & for-each-ref commands to have a --no-contains
option in addition to their longstanding --contains options.
This allows for finding the last-good rollout tag given a known-bad
<commit>. Given a hypothetically bad commit cf5c7253e0, the git
version to revert to can be found with this hacky two-liner:
(git tag -l 'v[0-9]*'; git tag -l --contains cf5c7253e0 'v[0-9]*') |
sort | uniq -c | grep -E '^ *1 ' | awk '{print $2}' | tail -n 10
With this new --no-contains option the same can be achieved with:
git tag -l --no-contains cf5c7253e0 'v[0-9]*' | sort | tail -n 10
As the filtering machinery is shared between the tag, branch &
for-each-ref commands, implement this for those commands too. A
practical use for this with "branch" is e.g. finding branches which
were branched off between v2.8.0 and v2.10.0:
git branch --contains v2.8.0 --no-contains v2.10.0
The "describe" command also has a --contains option, but its semantics
are unrelated to what tag/branch/for-each-ref use --contains for. A
--no-contains option for "describe" wouldn't make any sense, other
than being exactly equivalent to not supplying --contains at all,
which would be confusing at best.
Add a --without option to "tag" as an alias for --no-contains, for
consistency with --with and --contains. The --with option is
undocumented, and possibly the only user of it is
Junio (<xmqqefy71iej.fsf@gitster.mtv.corp.google.com>). But it's
trivial to support, so let's do that.
The additions to the the test suite are inverse copies of the
corresponding --contains tests. With this change --no-contains for
tag, branch & for-each-ref is just as well tested as the existing
--contains option.
In addition to those tests, add a test for "tag" which asserts that
--no-contains won't find tree/blob tags, which is slightly
unintuitive, but consistent with how --contains works & is documented.
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-03-24 18:40:57 +00:00
|
|
|
#define OPT_NO_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("no-contains", v, h, PARSE_OPT_NONEG)
|
2017-03-24 18:40:53 +00:00
|
|
|
#define OPT_WITH(v, h) _OPT_CONTAINS_OR_WITH("with", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
|
ref-filter: add --no-contains option to tag/branch/for-each-ref
Change the tag, branch & for-each-ref commands to have a --no-contains
option in addition to their longstanding --contains options.
This allows for finding the last-good rollout tag given a known-bad
<commit>. Given a hypothetically bad commit cf5c7253e0, the git
version to revert to can be found with this hacky two-liner:
(git tag -l 'v[0-9]*'; git tag -l --contains cf5c7253e0 'v[0-9]*') |
sort | uniq -c | grep -E '^ *1 ' | awk '{print $2}' | tail -n 10
With this new --no-contains option the same can be achieved with:
git tag -l --no-contains cf5c7253e0 'v[0-9]*' | sort | tail -n 10
As the filtering machinery is shared between the tag, branch &
for-each-ref commands, implement this for those commands too. A
practical use for this with "branch" is e.g. finding branches which
were branched off between v2.8.0 and v2.10.0:
git branch --contains v2.8.0 --no-contains v2.10.0
The "describe" command also has a --contains option, but its semantics
are unrelated to what tag/branch/for-each-ref use --contains for. A
--no-contains option for "describe" wouldn't make any sense, other
than being exactly equivalent to not supplying --contains at all,
which would be confusing at best.
Add a --without option to "tag" as an alias for --no-contains, for
consistency with --with and --contains. The --with option is
undocumented, and possibly the only user of it is
Junio (<xmqqefy71iej.fsf@gitster.mtv.corp.google.com>). But it's
trivial to support, so let's do that.
The additions to the the test suite are inverse copies of the
corresponding --contains tests. With this change --no-contains for
tag, branch & for-each-ref is just as well tested as the existing
--contains option.
In addition to those tests, add a test for "tag" which asserts that
--no-contains won't find tree/blob tags, which is slightly
unintuitive, but consistent with how --contains works & is documented.
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-03-24 18:40:57 +00:00
|
|
|
#define OPT_WITHOUT(v, h) _OPT_CONTAINS_OR_WITH("without", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
|
2007-10-14 09:05:12 +00:00
|
|
|
|
2007-10-14 23:35:37 +00:00
|
|
|
#endif
|