Merge branch 'jk/rev-list-no-bitmap-while-pruning' into maint
[git] / builtin / show-ref.c
1 #include "builtin.h"
2 #include "cache.h"
3 #include "refs.h"
4 #include "object.h"
5 #include "tag.h"
6 #include "string-list.h"
7 #include "parse-options.h"
8
9 static const char * const show_ref_usage[] = {
10         N_("git show-ref [-q | --quiet] [--verify] [--head] [-d | --dereference] [-s | --hash[=<n>]] [--abbrev[=<n>]] [--tags] [--heads] [--] [<pattern>...]"),
11         N_("git show-ref --exclude-existing[=pattern] < ref-list"),
12         NULL
13 };
14
15 static int deref_tags, show_head, tags_only, heads_only, found_match, verify,
16            quiet, hash_only, abbrev, exclude_arg;
17 static const char **pattern;
18 static const char *exclude_existing_arg;
19
20 static void show_one(const char *refname, const unsigned char *sha1)
21 {
22         const char *hex = find_unique_abbrev(sha1, abbrev);
23         if (hash_only)
24                 printf("%s\n", hex);
25         else
26                 printf("%s %s\n", hex, refname);
27 }
28
29 static int show_ref(const char *refname, const unsigned char *sha1, int flag, void *cbdata)
30 {
31         const char *hex;
32         unsigned char peeled[20];
33
34         if (show_head && !strcmp(refname, "HEAD"))
35                 goto match;
36
37         if (tags_only || heads_only) {
38                 int match;
39
40                 match = heads_only && starts_with(refname, "refs/heads/");
41                 match |= tags_only && starts_with(refname, "refs/tags/");
42                 if (!match)
43                         return 0;
44         }
45         if (pattern) {
46                 int reflen = strlen(refname);
47                 const char **p = pattern, *m;
48                 while ((m = *p++) != NULL) {
49                         int len = strlen(m);
50                         if (len > reflen)
51                                 continue;
52                         if (memcmp(m, refname + reflen - len, len))
53                                 continue;
54                         if (len == reflen)
55                                 goto match;
56                         /* "--verify" requires an exact match */
57                         if (verify)
58                                 continue;
59                         if (refname[reflen - len - 1] == '/')
60                                 goto match;
61                 }
62                 return 0;
63         }
64
65 match:
66         found_match++;
67
68         /* This changes the semantics slightly that even under quiet we
69          * detect and return error if the repository is corrupt and
70          * ref points at a nonexistent object.
71          */
72         if (!has_sha1_file(sha1))
73                 die("git show-ref: bad ref %s (%s)", refname,
74                     sha1_to_hex(sha1));
75
76         if (quiet)
77                 return 0;
78
79         show_one(refname, sha1);
80
81         if (!deref_tags)
82                 return 0;
83
84         if (!peel_ref(refname, peeled)) {
85                 hex = find_unique_abbrev(peeled, abbrev);
86                 printf("%s %s^{}\n", hex, refname);
87         }
88         return 0;
89 }
90
91 static int add_existing(const char *refname, const unsigned char *sha1, int flag, void *cbdata)
92 {
93         struct string_list *list = (struct string_list *)cbdata;
94         string_list_insert(list, refname);
95         return 0;
96 }
97
98 /*
99  * read "^(?:<anything>\s)?<refname>(?:\^\{\})?$" from the standard input,
100  * and
101  * (1) strip "^{}" at the end of line if any;
102  * (2) ignore if match is provided and does not head-match refname;
103  * (3) warn if refname is not a well-formed refname and skip;
104  * (4) ignore if refname is a ref that exists in the local repository;
105  * (5) otherwise output the line.
106  */
107 static int exclude_existing(const char *match)
108 {
109         static struct string_list existing_refs = STRING_LIST_INIT_DUP;
110         char buf[1024];
111         int matchlen = match ? strlen(match) : 0;
112
113         for_each_ref(add_existing, &existing_refs);
114         while (fgets(buf, sizeof(buf), stdin)) {
115                 char *ref;
116                 int len = strlen(buf);
117
118                 if (len > 0 && buf[len - 1] == '\n')
119                         buf[--len] = '\0';
120                 if (3 <= len && !strcmp(buf + len - 3, "^{}")) {
121                         len -= 3;
122                         buf[len] = '\0';
123                 }
124                 for (ref = buf + len; buf < ref; ref--)
125                         if (isspace(ref[-1]))
126                                 break;
127                 if (match) {
128                         int reflen = buf + len - ref;
129                         if (reflen < matchlen)
130                                 continue;
131                         if (strncmp(ref, match, matchlen))
132                                 continue;
133                 }
134                 if (check_refname_format(ref, 0)) {
135                         warning("ref '%s' ignored", ref);
136                         continue;
137                 }
138                 if (!string_list_has_string(&existing_refs, ref)) {
139                         printf("%s\n", buf);
140                 }
141         }
142         return 0;
143 }
144
145 static int hash_callback(const struct option *opt, const char *arg, int unset)
146 {
147         hash_only = 1;
148         /* Use full length SHA1 if no argument */
149         if (!arg)
150                 return 0;
151         return parse_opt_abbrev_cb(opt, arg, unset);
152 }
153
154 static int exclude_existing_callback(const struct option *opt, const char *arg,
155                                      int unset)
156 {
157         exclude_arg = 1;
158         *(const char **)opt->value = arg;
159         return 0;
160 }
161
162 static int help_callback(const struct option *opt, const char *arg, int unset)
163 {
164         return -1;
165 }
166
167 static const struct option show_ref_options[] = {
168         OPT_BOOL(0, "tags", &tags_only, N_("only show tags (can be combined with heads)")),
169         OPT_BOOL(0, "heads", &heads_only, N_("only show heads (can be combined with tags)")),
170         OPT_BOOL(0, "verify", &verify, N_("stricter reference checking, "
171                     "requires exact ref path")),
172         OPT_HIDDEN_BOOL('h', NULL, &show_head,
173                         N_("show the HEAD reference, even if it would be filtered out")),
174         OPT_BOOL(0, "head", &show_head,
175           N_("show the HEAD reference, even if it would be filtered out")),
176         OPT_BOOL('d', "dereference", &deref_tags,
177                     N_("dereference tags into object IDs")),
178         { OPTION_CALLBACK, 's', "hash", &abbrev, N_("n"),
179           N_("only show SHA1 hash using <n> digits"),
180           PARSE_OPT_OPTARG, &hash_callback },
181         OPT__ABBREV(&abbrev),
182         OPT__QUIET(&quiet,
183                    N_("do not print results to stdout (useful with --verify)")),
184         { OPTION_CALLBACK, 0, "exclude-existing", &exclude_existing_arg,
185           N_("pattern"), N_("show refs from stdin that aren't in local repository"),
186           PARSE_OPT_OPTARG | PARSE_OPT_NONEG, exclude_existing_callback },
187         { OPTION_CALLBACK, 0, "help-all", NULL, NULL, N_("show usage"),
188           PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, help_callback },
189         OPT_END()
190 };
191
192 int cmd_show_ref(int argc, const char **argv, const char *prefix)
193 {
194         if (argc == 2 && !strcmp(argv[1], "-h"))
195                 usage_with_options(show_ref_usage, show_ref_options);
196
197         argc = parse_options(argc, argv, prefix, show_ref_options,
198                              show_ref_usage, PARSE_OPT_NO_INTERNAL_HELP);
199
200         if (exclude_arg)
201                 return exclude_existing(exclude_existing_arg);
202
203         pattern = argv;
204         if (!*pattern)
205                 pattern = NULL;
206
207         if (verify) {
208                 if (!pattern)
209                         die("--verify requires a reference");
210                 while (*pattern) {
211                         unsigned char sha1[20];
212
213                         if (starts_with(*pattern, "refs/") &&
214                             !read_ref(*pattern, sha1)) {
215                                 if (!quiet)
216                                         show_one(*pattern, sha1);
217                         }
218                         else if (!quiet)
219                                 die("'%s' - not a valid ref", *pattern);
220                         else
221                                 return 1;
222                         pattern++;
223                 }
224                 return 0;
225         }
226
227         if (show_head)
228                 head_ref(show_ref, NULL);
229         for_each_ref(show_ref, NULL);
230         if (!found_match) {
231                 if (verify && !quiet)
232                         die("No match");
233                 return 1;
234         }
235         return 0;
236 }