Start the post 2.27 cycle
[git.git] / builtin / show-ref.c
blobae60b4acf2f444631d477104b7c5bc15e5311658
1 #include "builtin.h"
2 #include "cache.h"
3 #include "config.h"
4 #include "refs.h"
5 #include "object-store.h"
6 #include "object.h"
7 #include "tag.h"
8 #include "string-list.h"
9 #include "parse-options.h"
11 static const char * const show_ref_usage[] = {
12 N_("git show-ref [-q | --quiet] [--verify] [--head] [-d | --dereference] [-s | --hash[=<n>]] [--abbrev[=<n>]] [--tags] [--heads] [--] [<pattern>...]"),
13 N_("git show-ref --exclude-existing[=<pattern>]"),
14 NULL
17 static int deref_tags, show_head, tags_only, heads_only, found_match, verify,
18 quiet, hash_only, abbrev, exclude_arg;
19 static const char **pattern;
20 static const char *exclude_existing_arg;
22 static void show_one(const char *refname, const struct object_id *oid)
24 const char *hex;
25 struct object_id peeled;
27 if (!has_object_file(oid))
28 die("git show-ref: bad ref %s (%s)", refname,
29 oid_to_hex(oid));
31 if (quiet)
32 return;
34 hex = find_unique_abbrev(oid, abbrev);
35 if (hash_only)
36 printf("%s\n", hex);
37 else
38 printf("%s %s\n", hex, refname);
40 if (!deref_tags)
41 return;
43 if (!peel_ref(refname, &peeled)) {
44 hex = find_unique_abbrev(&peeled, abbrev);
45 printf("%s %s^{}\n", hex, refname);
49 static int show_ref(const char *refname, const struct object_id *oid,
50 int flag, void *cbdata)
52 if (show_head && !strcmp(refname, "HEAD"))
53 goto match;
55 if (tags_only || heads_only) {
56 int match;
58 match = heads_only && starts_with(refname, "refs/heads/");
59 match |= tags_only && starts_with(refname, "refs/tags/");
60 if (!match)
61 return 0;
63 if (pattern) {
64 int reflen = strlen(refname);
65 const char **p = pattern, *m;
66 while ((m = *p++) != NULL) {
67 int len = strlen(m);
68 if (len > reflen)
69 continue;
70 if (memcmp(m, refname + reflen - len, len))
71 continue;
72 if (len == reflen)
73 goto match;
74 if (refname[reflen - len - 1] == '/')
75 goto match;
77 return 0;
80 match:
81 found_match++;
83 show_one(refname, oid);
85 return 0;
88 static int add_existing(const char *refname, const struct object_id *oid,
89 int flag, void *cbdata)
91 struct string_list *list = (struct string_list *)cbdata;
92 string_list_insert(list, refname);
93 return 0;
97 * read "^(?:<anything>\s)?<refname>(?:\^\{\})?$" from the standard input,
98 * and
99 * (1) strip "^{}" at the end of line if any;
100 * (2) ignore if match is provided and does not head-match refname;
101 * (3) warn if refname is not a well-formed refname and skip;
102 * (4) ignore if refname is a ref that exists in the local repository;
103 * (5) otherwise output the line.
105 static int exclude_existing(const char *match)
107 static struct string_list existing_refs = STRING_LIST_INIT_DUP;
108 char buf[1024];
109 int matchlen = match ? strlen(match) : 0;
111 for_each_ref(add_existing, &existing_refs);
112 while (fgets(buf, sizeof(buf), stdin)) {
113 char *ref;
114 int len = strlen(buf);
116 if (len > 0 && buf[len - 1] == '\n')
117 buf[--len] = '\0';
118 if (3 <= len && !strcmp(buf + len - 3, "^{}")) {
119 len -= 3;
120 buf[len] = '\0';
122 for (ref = buf + len; buf < ref; ref--)
123 if (isspace(ref[-1]))
124 break;
125 if (match) {
126 int reflen = buf + len - ref;
127 if (reflen < matchlen)
128 continue;
129 if (strncmp(ref, match, matchlen))
130 continue;
132 if (check_refname_format(ref, 0)) {
133 warning("ref '%s' ignored", ref);
134 continue;
136 if (!string_list_has_string(&existing_refs, ref)) {
137 printf("%s\n", buf);
140 return 0;
143 static int hash_callback(const struct option *opt, const char *arg, int unset)
145 hash_only = 1;
146 /* Use full length SHA1 if no argument */
147 if (!arg)
148 return 0;
149 return parse_opt_abbrev_cb(opt, arg, unset);
152 static int exclude_existing_callback(const struct option *opt, const char *arg,
153 int unset)
155 BUG_ON_OPT_NEG(unset);
156 exclude_arg = 1;
157 *(const char **)opt->value = arg;
158 return 0;
161 static const struct option show_ref_options[] = {
162 OPT_BOOL(0, "tags", &tags_only, N_("only show tags (can be combined with heads)")),
163 OPT_BOOL(0, "heads", &heads_only, N_("only show heads (can be combined with tags)")),
164 OPT_BOOL(0, "verify", &verify, N_("stricter reference checking, "
165 "requires exact ref path")),
166 OPT_HIDDEN_BOOL('h', NULL, &show_head,
167 N_("show the HEAD reference, even if it would be filtered out")),
168 OPT_BOOL(0, "head", &show_head,
169 N_("show the HEAD reference, even if it would be filtered out")),
170 OPT_BOOL('d', "dereference", &deref_tags,
171 N_("dereference tags into object IDs")),
172 OPT_CALLBACK_F('s', "hash", &abbrev, N_("n"),
173 N_("only show SHA1 hash using <n> digits"),
174 PARSE_OPT_OPTARG, &hash_callback),
175 OPT__ABBREV(&abbrev),
176 OPT__QUIET(&quiet,
177 N_("do not print results to stdout (useful with --verify)")),
178 OPT_CALLBACK_F(0, "exclude-existing", &exclude_existing_arg,
179 N_("pattern"), N_("show refs from stdin that aren't in local repository"),
180 PARSE_OPT_OPTARG | PARSE_OPT_NONEG, exclude_existing_callback),
181 OPT_END()
184 int cmd_show_ref(int argc, const char **argv, const char *prefix)
186 git_config(git_default_config, NULL);
188 argc = parse_options(argc, argv, prefix, show_ref_options,
189 show_ref_usage, 0);
191 if (exclude_arg)
192 return exclude_existing(exclude_existing_arg);
194 pattern = argv;
195 if (!*pattern)
196 pattern = NULL;
198 if (verify) {
199 if (!pattern)
200 die("--verify requires a reference");
201 while (*pattern) {
202 struct object_id oid;
204 if ((starts_with(*pattern, "refs/") || !strcmp(*pattern, "HEAD")) &&
205 !read_ref(*pattern, &oid)) {
206 show_one(*pattern, &oid);
208 else if (!quiet)
209 die("'%s' - not a valid ref", *pattern);
210 else
211 return 1;
212 pattern++;
214 return 0;
217 if (show_head)
218 head_ref(show_ref, NULL);
219 for_each_ref(show_ref, NULL);
220 if (!found_match) {
221 if (verify && !quiet)
222 die("No match");
223 return 1;
225 return 0;