2015-06-13 19:37:26 +00:00
|
|
|
#ifndef REF_FILTER_H
|
|
|
|
#define REF_FILTER_H
|
|
|
|
|
2023-03-21 06:25:54 +00:00
|
|
|
#include "gettext.h"
|
2020-03-30 14:03:46 +00:00
|
|
|
#include "oid-array.h"
|
2015-06-13 19:37:26 +00:00
|
|
|
#include "refs.h"
|
|
|
|
#include "commit.h"
|
|
|
|
#include "parse-options.h"
|
|
|
|
|
|
|
|
/* Quoting styles */
|
|
|
|
#define QUOTE_NONE 0
|
|
|
|
#define QUOTE_SHELL 1
|
|
|
|
#define QUOTE_PERL 2
|
|
|
|
#define QUOTE_PYTHON 4
|
|
|
|
#define QUOTE_TCL 8
|
|
|
|
|
2015-09-10 15:48:23 +00:00
|
|
|
#define FILTER_REFS_TAGS 0x0002
|
|
|
|
#define FILTER_REFS_BRANCHES 0x0004
|
|
|
|
#define FILTER_REFS_REMOTES 0x0008
|
|
|
|
#define FILTER_REFS_OTHERS 0x0010
|
|
|
|
#define FILTER_REFS_ALL (FILTER_REFS_TAGS | FILTER_REFS_BRANCHES | \
|
|
|
|
FILTER_REFS_REMOTES | FILTER_REFS_OTHERS)
|
|
|
|
#define FILTER_REFS_DETACHED_HEAD 0x0020
|
|
|
|
#define FILTER_REFS_KIND_MASK (FILTER_REFS_ALL | FILTER_REFS_DETACHED_HEAD)
|
2015-06-13 19:37:28 +00:00
|
|
|
|
2015-08-22 03:39:37 +00:00
|
|
|
struct atom_value;
|
for-each-ref: delay parsing of --sort=<atom> options
The for-each-ref family of commands invoke parsers immediately when
it sees each --sort=<atom> option, and die before even seeing the
other options on the command line when the <atom> is unrecognised.
Instead, accumulate them in a string list, and have them parsed into
a ref_sorting structure after the command line parsing is done. As
a consequence, "git branch --sort=bogus -h" used to fail to give the
brief help, which arguably may have been a feature, now does so,
which is more consistent with how other options work.
The patch is smaller than the actual extent of the "damage" to the
codebase, thanks to the fact that the original code consistently
used OPT_REF_SORT() macro to handle command line options. We only
needed to replace the variable used for the list, and implementation
of the callback function used in the macro.
The old rule was for the users of the API to:
- Declare ref_sorting and ref_sorting_tail variables;
- OPT_REF_SORT() macro will instantiate ref_sorting instance (which
may barf and die) and append it to the tail;
- Append to the tail each ref_sorting read from the configuration
by parsing in the config callback (which may barf and die);
- See if ref_sorting is null and use ref_sorting_default() instead.
Now the rule is not all that different but is simpler:
- Declare ref_sorting_options string list.
- OPT_REF_SORT() macro will append it to the string list;
- Append to the string list the sort key read from the
configuration;
- call ref_sorting_options() to turn the string list to ref_sorting
structure (which also deals with the default value).
As side effects, this change also cleans up a few issues:
- 95be717c (parse_opt_ref_sorting: always use with NONEG flag,
2019-03-20) muses that "git for-each-ref --no-sort" should simply
clear the sort keys accumulated so far; it now does.
- The implementation detail of "struct ref_sorting" and the helper
function parse_ref_sorting() can now be private to the ref-filter
API implementation.
- If you set branch.sort to a bogus value, the any "git branch"
invocation, not only the listing mode, would abort with the
original code; now it doesn't
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2021-10-20 19:23:53 +00:00
|
|
|
struct ref_sorting;
|
2015-06-13 19:37:26 +00:00
|
|
|
|
for-each-ref: delay parsing of --sort=<atom> options
The for-each-ref family of commands invoke parsers immediately when
it sees each --sort=<atom> option, and die before even seeing the
other options on the command line when the <atom> is unrecognised.
Instead, accumulate them in a string list, and have them parsed into
a ref_sorting structure after the command line parsing is done. As
a consequence, "git branch --sort=bogus -h" used to fail to give the
brief help, which arguably may have been a feature, now does so,
which is more consistent with how other options work.
The patch is smaller than the actual extent of the "damage" to the
codebase, thanks to the fact that the original code consistently
used OPT_REF_SORT() macro to handle command line options. We only
needed to replace the variable used for the list, and implementation
of the callback function used in the macro.
The old rule was for the users of the API to:
- Declare ref_sorting and ref_sorting_tail variables;
- OPT_REF_SORT() macro will instantiate ref_sorting instance (which
may barf and die) and append it to the tail;
- Append to the tail each ref_sorting read from the configuration
by parsing in the config callback (which may barf and die);
- See if ref_sorting is null and use ref_sorting_default() instead.
Now the rule is not all that different but is simpler:
- Declare ref_sorting_options string list.
- OPT_REF_SORT() macro will append it to the string list;
- Append to the string list the sort key read from the
configuration;
- call ref_sorting_options() to turn the string list to ref_sorting
structure (which also deals with the default value).
As side effects, this change also cleans up a few issues:
- 95be717c (parse_opt_ref_sorting: always use with NONEG flag,
2019-03-20) muses that "git for-each-ref --no-sort" should simply
clear the sort keys accumulated so far; it now does.
- The implementation detail of "struct ref_sorting" and the helper
function parse_ref_sorting() can now be private to the ref-filter
API implementation.
- If you set branch.sort to a bogus value, the any "git branch"
invocation, not only the listing mode, would abort with the
original code; now it doesn't
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2021-10-20 19:23:53 +00:00
|
|
|
enum ref_sorting_order {
|
|
|
|
REF_SORTING_REVERSE = 1<<0,
|
|
|
|
REF_SORTING_ICASE = 1<<1,
|
|
|
|
REF_SORTING_VERSION = 1<<2,
|
|
|
|
REF_SORTING_DETACHED_HEAD_FIRST = 1<<3,
|
2015-06-13 19:37:26 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
struct ref_array_item {
|
2017-05-06 22:10:21 +00:00
|
|
|
struct object_id objectname;
|
2021-07-26 03:26:50 +00:00
|
|
|
const char *rest;
|
2015-06-13 19:37:26 +00:00
|
|
|
int flag;
|
2015-09-10 15:48:23 +00:00
|
|
|
unsigned int kind;
|
2015-06-13 19:37:26 +00:00
|
|
|
const char *symref;
|
2015-07-07 16:06:12 +00:00
|
|
|
struct commit *commit;
|
2015-06-13 19:37:26 +00:00
|
|
|
struct atom_value *value;
|
2015-06-13 19:37:29 +00:00
|
|
|
char refname[FLEX_ARRAY];
|
2015-06-13 19:37:26 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
struct ref_array {
|
|
|
|
int nr, alloc;
|
|
|
|
struct ref_array_item **items;
|
2015-09-23 18:11:11 +00:00
|
|
|
struct rev_info *revs;
|
2015-06-13 19:37:26 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
struct ref_filter {
|
|
|
|
const char **name_patterns;
|
2017-03-31 01:40:00 +00:00
|
|
|
struct oid_array points_at;
|
2015-07-07 16:06:16 +00:00
|
|
|
struct commit_list *with_commit;
|
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
|
|
|
struct commit_list *no_commit;
|
2020-09-16 02:08:40 +00:00
|
|
|
struct commit_list *reachable_from;
|
|
|
|
struct commit_list *unreachable_from;
|
2015-07-07 16:06:16 +00:00
|
|
|
|
2015-09-10 15:48:26 +00:00
|
|
|
unsigned int with_commit_tag_algo : 1,
|
2015-09-23 18:11:11 +00:00
|
|
|
match_as_path : 1,
|
2016-12-04 02:52:25 +00:00
|
|
|
ignore_case : 1,
|
2015-09-23 18:11:11 +00:00
|
|
|
detached : 1;
|
2015-09-11 15:04:16 +00:00
|
|
|
unsigned int kind,
|
|
|
|
lines;
|
2015-09-23 18:11:11 +00:00
|
|
|
int abbrev,
|
|
|
|
verbose;
|
2015-06-13 19:37:26 +00:00
|
|
|
};
|
|
|
|
|
2017-07-13 15:01:18 +00:00
|
|
|
struct ref_format {
|
|
|
|
/*
|
|
|
|
* Set these to define the format; make sure you call
|
|
|
|
* verify_ref_format() afterwards to finalize.
|
|
|
|
*/
|
|
|
|
const char *format;
|
2021-07-26 03:26:50 +00:00
|
|
|
const char *rest;
|
2017-07-13 15:01:18 +00:00
|
|
|
int quote_style;
|
2021-07-26 03:26:50 +00:00
|
|
|
int use_rest;
|
ref-filter: consult want_color() before emitting colors
When color placeholders like %(color:red) are used in a
ref-filter format, we unconditionally output the colors,
even if the user has asked us for no colors. This usually
isn't a problem when the user is constructing a --format on
the command line, but it means we may do the wrong thing
when the format is fed from a script or alias. For example:
$ git config alias.b 'branch --format=%(color:green)%(refname)'
$ git b --no-color
should probably omit the green color. Likewise, running:
$ git b >branches
should probably also omit the color, just as we would for
all baked-in coloring (and as we recently started to do for
user-specified colors in --pretty formats).
This commit makes both of those cases work by teaching
the ref-filter code to consult want_color() before
outputting any color. The color flag in ref_format defaults
to "-1", which means we'll consult color.ui, which in turn
defaults to the usual isatty() check on stdout. However,
callers like git-branch which support their own color config
(and command-line options) can override that.
The new tests independently cover all three of the callers
of ref-filter (for-each-ref, tag, and branch). Even though
these seem redundant, it confirms that we've correctly
plumbed through all of the necessary config to make colors
work by default.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-07-13 15:09:32 +00:00
|
|
|
int use_color;
|
2017-07-13 15:02:30 +00:00
|
|
|
|
|
|
|
/* Internal state to ref-filter */
|
|
|
|
int need_color_reset_at_eol;
|
2017-07-13 15:01:18 +00:00
|
|
|
};
|
|
|
|
|
2021-07-26 03:26:50 +00:00
|
|
|
#define REF_FORMAT_INIT { .use_color = -1 }
|
2017-07-13 15:01:18 +00:00
|
|
|
|
2015-07-07 16:06:11 +00:00
|
|
|
/* Macros for checking --merged and --no-merged options */
|
|
|
|
#define _OPT_MERGED_NO_MERGED(option, filter, h) \
|
|
|
|
{ OPTION_CALLBACK, 0, option, (filter), N_("commit"), (h), \
|
|
|
|
PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG, \
|
|
|
|
parse_opt_merge_filter, (intptr_t) "HEAD" \
|
|
|
|
}
|
|
|
|
#define OPT_MERGED(f, h) _OPT_MERGED_NO_MERGED("merged", f, h)
|
|
|
|
#define OPT_NO_MERGED(f, h) _OPT_MERGED_NO_MERGED("no-merged", f, h)
|
|
|
|
|
parse_opt_ref_sorting: always use with NONEG flag
The "--sort" parameter of for-each-ref, etc, does not handle negation,
and instead returns an error to the parse-options code. But neither
piece of code prints anything for the user, which may leave them
confused:
$ git for-each-ref --no-sort
$ echo $?
129
As the comment in the callback function notes, this probably should
clear the list, which would make it consistent with other list-like
options (i.e., anything that uses OPT_STRING_LIST currently).
Unfortunately that's a bit tricky due to the way the ref-filter code
works. But in the meantime, let's at least make the error a little less
confusing:
- switch to using PARSE_OPT_NONEG in the option definition, which will
cause the options code to produce a useful message
- since this was cut-and-pasted to four different spots, let's define
a single OPT_REF_SORT() macro that we can use everywhere
- the callback can use BUG_ON_OPT_NEG() to make sure the correct flags
are used (incidentally, this also satisfies -Wunused-parameters,
since we're now looking at "unset")
- expand the comment into a NEEDSWORK to make it clear that the
direction is right, but the details need to be worked out
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2019-03-20 20:22:15 +00:00
|
|
|
#define OPT_REF_SORT(var) \
|
for-each-ref: delay parsing of --sort=<atom> options
The for-each-ref family of commands invoke parsers immediately when
it sees each --sort=<atom> option, and die before even seeing the
other options on the command line when the <atom> is unrecognised.
Instead, accumulate them in a string list, and have them parsed into
a ref_sorting structure after the command line parsing is done. As
a consequence, "git branch --sort=bogus -h" used to fail to give the
brief help, which arguably may have been a feature, now does so,
which is more consistent with how other options work.
The patch is smaller than the actual extent of the "damage" to the
codebase, thanks to the fact that the original code consistently
used OPT_REF_SORT() macro to handle command line options. We only
needed to replace the variable used for the list, and implementation
of the callback function used in the macro.
The old rule was for the users of the API to:
- Declare ref_sorting and ref_sorting_tail variables;
- OPT_REF_SORT() macro will instantiate ref_sorting instance (which
may barf and die) and append it to the tail;
- Append to the tail each ref_sorting read from the configuration
by parsing in the config callback (which may barf and die);
- See if ref_sorting is null and use ref_sorting_default() instead.
Now the rule is not all that different but is simpler:
- Declare ref_sorting_options string list.
- OPT_REF_SORT() macro will append it to the string list;
- Append to the string list the sort key read from the
configuration;
- call ref_sorting_options() to turn the string list to ref_sorting
structure (which also deals with the default value).
As side effects, this change also cleans up a few issues:
- 95be717c (parse_opt_ref_sorting: always use with NONEG flag,
2019-03-20) muses that "git for-each-ref --no-sort" should simply
clear the sort keys accumulated so far; it now does.
- The implementation detail of "struct ref_sorting" and the helper
function parse_ref_sorting() can now be private to the ref-filter
API implementation.
- If you set branch.sort to a bogus value, the any "git branch"
invocation, not only the listing mode, would abort with the
original code; now it doesn't
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2021-10-20 19:23:53 +00:00
|
|
|
OPT_STRING_LIST(0, "sort", (var), \
|
|
|
|
N_("key"), N_("field name to sort on"))
|
parse_opt_ref_sorting: always use with NONEG flag
The "--sort" parameter of for-each-ref, etc, does not handle negation,
and instead returns an error to the parse-options code. But neither
piece of code prints anything for the user, which may leave them
confused:
$ git for-each-ref --no-sort
$ echo $?
129
As the comment in the callback function notes, this probably should
clear the list, which would make it consistent with other list-like
options (i.e., anything that uses OPT_STRING_LIST currently).
Unfortunately that's a bit tricky due to the way the ref-filter code
works. But in the meantime, let's at least make the error a little less
confusing:
- switch to using PARSE_OPT_NONEG in the option definition, which will
cause the options code to produce a useful message
- since this was cut-and-pasted to four different spots, let's define
a single OPT_REF_SORT() macro that we can use everywhere
- the callback can use BUG_ON_OPT_NEG() to make sure the correct flags
are used (incidentally, this also satisfies -Wunused-parameters,
since we're now looking at "unset")
- expand the comment into a NEEDSWORK to make it clear that the
direction is right, but the details need to be worked out
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2019-03-20 20:22:15 +00:00
|
|
|
|
2015-06-13 19:37:28 +00:00
|
|
|
/*
|
|
|
|
* API for filtering a set of refs. Based on the type of refs the user
|
|
|
|
* has requested, we iterate through those refs and apply filters
|
|
|
|
* as per the given ref_filter structure and finally store the
|
|
|
|
* filtered refs in the ref_array structure.
|
|
|
|
*/
|
|
|
|
int filter_refs(struct ref_array *array, struct ref_filter *filter, unsigned int type);
|
2015-06-13 19:37:26 +00:00
|
|
|
/* Clear all memory allocated to ref_array */
|
|
|
|
void ref_array_clear(struct ref_array *array);
|
|
|
|
/* Used to verify if the given format is correct and to parse out the used atoms */
|
2017-07-13 15:01:18 +00:00
|
|
|
int verify_ref_format(struct ref_format *format);
|
2015-06-13 19:37:26 +00:00
|
|
|
/* Sort the given ref_array as per the ref_sorting provided */
|
|
|
|
void ref_array_sort(struct ref_sorting *sort, struct ref_array *array);
|
2021-01-07 09:51:51 +00:00
|
|
|
/* Set REF_SORTING_* sort_flags for all elements of a sorting list */
|
|
|
|
void ref_sorting_set_sort_flags_all(struct ref_sorting *sorting, unsigned int mask, int on);
|
2017-01-10 08:49:39 +00:00
|
|
|
/* Based on the given format and quote_style, fill the strbuf */
|
2018-03-29 12:49:45 +00:00
|
|
|
int format_ref_array_item(struct ref_array_item *info,
|
2021-07-26 03:26:49 +00:00
|
|
|
struct ref_format *format,
|
2018-03-29 12:49:45 +00:00
|
|
|
struct strbuf *final_buf,
|
|
|
|
struct strbuf *error_buf);
|
2021-10-20 18:27:20 +00:00
|
|
|
/* Release a "struct ref_sorting" */
|
|
|
|
void ref_sorting_release(struct ref_sorting *);
|
for-each-ref: delay parsing of --sort=<atom> options
The for-each-ref family of commands invoke parsers immediately when
it sees each --sort=<atom> option, and die before even seeing the
other options on the command line when the <atom> is unrecognised.
Instead, accumulate them in a string list, and have them parsed into
a ref_sorting structure after the command line parsing is done. As
a consequence, "git branch --sort=bogus -h" used to fail to give the
brief help, which arguably may have been a feature, now does so,
which is more consistent with how other options work.
The patch is smaller than the actual extent of the "damage" to the
codebase, thanks to the fact that the original code consistently
used OPT_REF_SORT() macro to handle command line options. We only
needed to replace the variable used for the list, and implementation
of the callback function used in the macro.
The old rule was for the users of the API to:
- Declare ref_sorting and ref_sorting_tail variables;
- OPT_REF_SORT() macro will instantiate ref_sorting instance (which
may barf and die) and append it to the tail;
- Append to the tail each ref_sorting read from the configuration
by parsing in the config callback (which may barf and die);
- See if ref_sorting is null and use ref_sorting_default() instead.
Now the rule is not all that different but is simpler:
- Declare ref_sorting_options string list.
- OPT_REF_SORT() macro will append it to the string list;
- Append to the string list the sort key read from the
configuration;
- call ref_sorting_options() to turn the string list to ref_sorting
structure (which also deals with the default value).
As side effects, this change also cleans up a few issues:
- 95be717c (parse_opt_ref_sorting: always use with NONEG flag,
2019-03-20) muses that "git for-each-ref --no-sort" should simply
clear the sort keys accumulated so far; it now does.
- The implementation detail of "struct ref_sorting" and the helper
function parse_ref_sorting() can now be private to the ref-filter
API implementation.
- If you set branch.sort to a bogus value, the any "git branch"
invocation, not only the listing mode, would abort with the
original code; now it doesn't
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2021-10-20 19:23:53 +00:00
|
|
|
/* Convert list of sort options into ref_sorting */
|
|
|
|
struct ref_sorting *ref_sorting_options(struct string_list *);
|
2015-07-07 16:06:11 +00:00
|
|
|
/* Function to parse --merged and --no-merged options */
|
|
|
|
int parse_opt_merge_filter(const struct option *opt, const char *arg, int unset);
|
2017-01-10 08:49:38 +00:00
|
|
|
/* Get the current HEAD's description */
|
|
|
|
char *get_head_description(void);
|
2017-01-10 08:49:50 +00:00
|
|
|
/* Set up translated strings in the output. */
|
|
|
|
void setup_ref_filter_porcelain_msg(void);
|
2015-06-13 19:37:26 +00:00
|
|
|
|
2017-01-17 23:37:19 +00:00
|
|
|
/*
|
|
|
|
* Print a single ref, outside of any ref-filter. Note that the
|
|
|
|
* name must be a fully qualified refname.
|
|
|
|
*/
|
2018-04-06 18:58:32 +00:00
|
|
|
void pretty_print_ref(const char *name, const struct object_id *oid,
|
2021-07-26 03:26:49 +00:00
|
|
|
struct ref_format *format);
|
2017-01-17 23:37:19 +00:00
|
|
|
|
2018-04-06 18:59:45 +00:00
|
|
|
/*
|
|
|
|
* Push a single ref onto the array; this can be used to construct your own
|
|
|
|
* ref_array without using filter_refs().
|
|
|
|
*/
|
|
|
|
struct ref_array_item *ref_array_push(struct ref_array *array,
|
|
|
|
const char *refname,
|
|
|
|
const struct object_id *oid);
|
|
|
|
|
2015-06-13 19:37:26 +00:00
|
|
|
#endif /* REF_FILTER_H */
|