Documentation/git-describe.txt: make description more readable
[git/git-bigfiles.git] / sha1_name.c
blob6298c37ae3a9b516ff75c122abf2181827f32bce
1 #include "cache.h"
2 #include "tag.h"
3 #include "commit.h"
4 #include "tree.h"
5 #include "blob.h"
6 #include "tree-walk.h"
7 #include "refs.h"
9 static int find_short_object_filename(int len, const char *name, unsigned char *sha1)
11 struct alternate_object_database *alt;
12 char hex[40];
13 int found = 0;
14 static struct alternate_object_database *fakeent;
16 if (!fakeent) {
17 const char *objdir = get_object_directory();
18 int objdir_len = strlen(objdir);
19 int entlen = objdir_len + 43;
20 fakeent = xmalloc(sizeof(*fakeent) + entlen);
21 memcpy(fakeent->base, objdir, objdir_len);
22 fakeent->name = fakeent->base + objdir_len + 1;
23 fakeent->name[-1] = '/';
25 fakeent->next = alt_odb_list;
27 sprintf(hex, "%.2s", name);
28 for (alt = fakeent; alt && found < 2; alt = alt->next) {
29 struct dirent *de;
30 DIR *dir;
31 sprintf(alt->name, "%.2s/", name);
32 dir = opendir(alt->base);
33 if (!dir)
34 continue;
35 while ((de = readdir(dir)) != NULL) {
36 if (strlen(de->d_name) != 38)
37 continue;
38 if (memcmp(de->d_name, name + 2, len - 2))
39 continue;
40 if (!found) {
41 memcpy(hex + 2, de->d_name, 38);
42 found++;
44 else if (memcmp(hex + 2, de->d_name, 38)) {
45 found = 2;
46 break;
49 closedir(dir);
51 if (found == 1)
52 return get_sha1_hex(hex, sha1) == 0;
53 return found;
56 static int match_sha(unsigned len, const unsigned char *a, const unsigned char *b)
58 do {
59 if (*a != *b)
60 return 0;
61 a++;
62 b++;
63 len -= 2;
64 } while (len > 1);
65 if (len)
66 if ((*a ^ *b) & 0xf0)
67 return 0;
68 return 1;
71 static int find_short_packed_object(int len, const unsigned char *match, unsigned char *sha1)
73 struct packed_git *p;
74 const unsigned char *found_sha1 = NULL;
75 int found = 0;
77 prepare_packed_git();
78 for (p = packed_git; p && found < 2; p = p->next) {
79 uint32_t num, last;
80 uint32_t first = 0;
81 open_pack_index(p);
82 num = p->num_objects;
83 last = num;
84 while (first < last) {
85 uint32_t mid = (first + last) / 2;
86 const unsigned char *now;
87 int cmp;
89 now = nth_packed_object_sha1(p, mid);
90 cmp = hashcmp(match, now);
91 if (!cmp) {
92 first = mid;
93 break;
95 if (cmp > 0) {
96 first = mid+1;
97 continue;
99 last = mid;
101 if (first < num) {
102 const unsigned char *now, *next;
103 now = nth_packed_object_sha1(p, first);
104 if (match_sha(len, match, now)) {
105 next = nth_packed_object_sha1(p, first+1);
106 if (!next|| !match_sha(len, match, next)) {
107 /* unique within this pack */
108 if (!found) {
109 found_sha1 = now;
110 found++;
112 else if (hashcmp(found_sha1, now)) {
113 found = 2;
114 break;
117 else {
118 /* not even unique within this pack */
119 found = 2;
120 break;
125 if (found == 1)
126 hashcpy(sha1, found_sha1);
127 return found;
130 #define SHORT_NAME_NOT_FOUND (-1)
131 #define SHORT_NAME_AMBIGUOUS (-2)
133 static int find_unique_short_object(int len, char *canonical,
134 unsigned char *res, unsigned char *sha1)
136 int has_unpacked, has_packed;
137 unsigned char unpacked_sha1[20], packed_sha1[20];
139 prepare_alt_odb();
140 has_unpacked = find_short_object_filename(len, canonical, unpacked_sha1);
141 has_packed = find_short_packed_object(len, res, packed_sha1);
142 if (!has_unpacked && !has_packed)
143 return SHORT_NAME_NOT_FOUND;
144 if (1 < has_unpacked || 1 < has_packed)
145 return SHORT_NAME_AMBIGUOUS;
146 if (has_unpacked != has_packed) {
147 hashcpy(sha1, (has_packed ? packed_sha1 : unpacked_sha1));
148 return 0;
150 /* Both have unique ones -- do they match? */
151 if (hashcmp(packed_sha1, unpacked_sha1))
152 return SHORT_NAME_AMBIGUOUS;
153 hashcpy(sha1, packed_sha1);
154 return 0;
157 static int get_short_sha1(const char *name, int len, unsigned char *sha1,
158 int quietly)
160 int i, status;
161 char canonical[40];
162 unsigned char res[20];
164 if (len < MINIMUM_ABBREV || len > 40)
165 return -1;
166 hashclr(res);
167 memset(canonical, 'x', 40);
168 for (i = 0; i < len ;i++) {
169 unsigned char c = name[i];
170 unsigned char val;
171 if (c >= '0' && c <= '9')
172 val = c - '0';
173 else if (c >= 'a' && c <= 'f')
174 val = c - 'a' + 10;
175 else if (c >= 'A' && c <='F') {
176 val = c - 'A' + 10;
177 c -= 'A' - 'a';
179 else
180 return -1;
181 canonical[i] = c;
182 if (!(i & 1))
183 val <<= 4;
184 res[i >> 1] |= val;
187 status = find_unique_short_object(i, canonical, res, sha1);
188 if (!quietly && (status == SHORT_NAME_AMBIGUOUS))
189 return error("short SHA1 %.*s is ambiguous.", len, canonical);
190 return status;
193 const char *find_unique_abbrev(const unsigned char *sha1, int len)
195 int status, is_null;
196 static char hex[41];
198 is_null = is_null_sha1(sha1);
199 memcpy(hex, sha1_to_hex(sha1), 40);
200 if (len == 40 || !len)
201 return hex;
202 while (len < 40) {
203 unsigned char sha1_ret[20];
204 status = get_short_sha1(hex, len, sha1_ret, 1);
205 if (!status ||
206 (is_null && status != SHORT_NAME_AMBIGUOUS)) {
207 hex[len] = 0;
208 return hex;
210 if (status != SHORT_NAME_AMBIGUOUS)
211 return NULL;
212 len++;
214 return NULL;
217 static int ambiguous_path(const char *path, int len)
219 int slash = 1;
220 int cnt;
222 for (cnt = 0; cnt < len; cnt++) {
223 switch (*path++) {
224 case '\0':
225 break;
226 case '/':
227 if (slash)
228 break;
229 slash = 1;
230 continue;
231 case '.':
232 continue;
233 default:
234 slash = 0;
235 continue;
237 break;
239 return slash;
242 int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref)
244 const char **p, *r;
245 int refs_found = 0;
247 *ref = NULL;
248 for (p = ref_rev_parse_rules; *p; p++) {
249 unsigned char sha1_from_ref[20];
250 unsigned char *this_result;
252 this_result = refs_found ? sha1_from_ref : sha1;
253 r = resolve_ref(mkpath(*p, len, str), this_result, 1, NULL);
254 if (r) {
255 if (!refs_found++)
256 *ref = xstrdup(r);
257 if (!warn_ambiguous_refs)
258 break;
261 return refs_found;
264 int dwim_log(const char *str, int len, unsigned char *sha1, char **log)
266 const char **p;
267 int logs_found = 0;
269 *log = NULL;
270 for (p = ref_rev_parse_rules; *p; p++) {
271 struct stat st;
272 unsigned char hash[20];
273 char path[PATH_MAX];
274 const char *ref, *it;
276 strcpy(path, mkpath(*p, len, str));
277 ref = resolve_ref(path, hash, 0, NULL);
278 if (!ref)
279 continue;
280 if (!stat(git_path("logs/%s", path), &st) &&
281 S_ISREG(st.st_mode))
282 it = path;
283 else if (strcmp(ref, path) &&
284 !stat(git_path("logs/%s", ref), &st) &&
285 S_ISREG(st.st_mode))
286 it = ref;
287 else
288 continue;
289 if (!logs_found++) {
290 *log = xstrdup(it);
291 hashcpy(sha1, hash);
293 if (!warn_ambiguous_refs)
294 break;
296 return logs_found;
299 static int get_sha1_basic(const char *str, int len, unsigned char *sha1)
301 static const char *warning = "warning: refname '%.*s' is ambiguous.\n";
302 char *real_ref = NULL;
303 int refs_found = 0;
304 int at, reflog_len;
306 if (len == 40 && !get_sha1_hex(str, sha1))
307 return 0;
309 /* basic@{time or number} format to query ref-log */
310 reflog_len = at = 0;
311 if (str[len-1] == '}') {
312 for (at = 0; at < len - 1; at++) {
313 if (str[at] == '@' && str[at+1] == '{') {
314 reflog_len = (len-1) - (at+2);
315 len = at;
316 break;
321 /* Accept only unambiguous ref paths. */
322 if (len && ambiguous_path(str, len))
323 return -1;
325 if (!len && reflog_len) {
326 /* allow "@{...}" to mean the current branch reflog */
327 refs_found = dwim_ref("HEAD", 4, sha1, &real_ref);
328 } else if (reflog_len)
329 refs_found = dwim_log(str, len, sha1, &real_ref);
330 else
331 refs_found = dwim_ref(str, len, sha1, &real_ref);
333 if (!refs_found)
334 return -1;
336 if (warn_ambiguous_refs && refs_found > 1)
337 fprintf(stderr, warning, len, str);
339 if (reflog_len) {
340 int nth, i;
341 unsigned long at_time;
342 unsigned long co_time;
343 int co_tz, co_cnt;
345 /* Is it asking for N-th entry, or approxidate? */
346 for (i = nth = 0; 0 <= nth && i < reflog_len; i++) {
347 char ch = str[at+2+i];
348 if ('0' <= ch && ch <= '9')
349 nth = nth * 10 + ch - '0';
350 else
351 nth = -1;
353 if (0 <= nth)
354 at_time = 0;
355 else {
356 char *tmp = xstrndup(str + at + 2, reflog_len);
357 at_time = approxidate(tmp);
358 free(tmp);
360 if (read_ref_at(real_ref, at_time, nth, sha1, NULL,
361 &co_time, &co_tz, &co_cnt)) {
362 if (at_time)
363 fprintf(stderr,
364 "warning: Log for '%.*s' only goes "
365 "back to %s.\n", len, str,
366 show_date(co_time, co_tz, DATE_RFC2822));
367 else
368 fprintf(stderr,
369 "warning: Log for '%.*s' only has "
370 "%d entries.\n", len, str, co_cnt);
374 free(real_ref);
375 return 0;
378 static int get_sha1_1(const char *name, int len, unsigned char *sha1);
380 static int get_parent(const char *name, int len,
381 unsigned char *result, int idx)
383 unsigned char sha1[20];
384 int ret = get_sha1_1(name, len, sha1);
385 struct commit *commit;
386 struct commit_list *p;
388 if (ret)
389 return ret;
390 commit = lookup_commit_reference(sha1);
391 if (!commit)
392 return -1;
393 if (parse_commit(commit))
394 return -1;
395 if (!idx) {
396 hashcpy(result, commit->object.sha1);
397 return 0;
399 p = commit->parents;
400 while (p) {
401 if (!--idx) {
402 hashcpy(result, p->item->object.sha1);
403 return 0;
405 p = p->next;
407 return -1;
410 static int get_nth_ancestor(const char *name, int len,
411 unsigned char *result, int generation)
413 unsigned char sha1[20];
414 struct commit *commit;
415 int ret;
417 ret = get_sha1_1(name, len, sha1);
418 if (ret)
419 return ret;
420 commit = lookup_commit_reference(sha1);
421 if (!commit)
422 return -1;
424 while (generation--) {
425 if (parse_commit(commit) || !commit->parents)
426 return -1;
427 commit = commit->parents->item;
429 hashcpy(result, commit->object.sha1);
430 return 0;
433 static int peel_onion(const char *name, int len, unsigned char *sha1)
435 unsigned char outer[20];
436 const char *sp;
437 unsigned int expected_type = 0;
438 struct object *o;
441 * "ref^{type}" dereferences ref repeatedly until you cannot
442 * dereference anymore, or you get an object of given type,
443 * whichever comes first. "ref^{}" means just dereference
444 * tags until you get a non-tag. "ref^0" is a shorthand for
445 * "ref^{commit}". "commit^{tree}" could be used to find the
446 * top-level tree of the given commit.
448 if (len < 4 || name[len-1] != '}')
449 return -1;
451 for (sp = name + len - 1; name <= sp; sp--) {
452 int ch = *sp;
453 if (ch == '{' && name < sp && sp[-1] == '^')
454 break;
456 if (sp <= name)
457 return -1;
459 sp++; /* beginning of type name, or closing brace for empty */
460 if (!strncmp(commit_type, sp, 6) && sp[6] == '}')
461 expected_type = OBJ_COMMIT;
462 else if (!strncmp(tree_type, sp, 4) && sp[4] == '}')
463 expected_type = OBJ_TREE;
464 else if (!strncmp(blob_type, sp, 4) && sp[4] == '}')
465 expected_type = OBJ_BLOB;
466 else if (sp[0] == '}')
467 expected_type = OBJ_NONE;
468 else
469 return -1;
471 if (get_sha1_1(name, sp - name - 2, outer))
472 return -1;
474 o = parse_object(outer);
475 if (!o)
476 return -1;
477 if (!expected_type) {
478 o = deref_tag(o, name, sp - name - 2);
479 if (!o || (!o->parsed && !parse_object(o->sha1)))
480 return -1;
481 hashcpy(sha1, o->sha1);
483 else {
484 /* At this point, the syntax look correct, so
485 * if we do not get the needed object, we should
486 * barf.
489 while (1) {
490 if (!o || (!o->parsed && !parse_object(o->sha1)))
491 return -1;
492 if (o->type == expected_type) {
493 hashcpy(sha1, o->sha1);
494 return 0;
496 if (o->type == OBJ_TAG)
497 o = ((struct tag*) o)->tagged;
498 else if (o->type == OBJ_COMMIT)
499 o = &(((struct commit *) o)->tree->object);
500 else
501 return error("%.*s: expected %s type, but the object dereferences to %s type",
502 len, name, typename(expected_type),
503 typename(o->type));
504 if (!o->parsed)
505 parse_object(o->sha1);
508 return 0;
511 static int get_describe_name(const char *name, int len, unsigned char *sha1)
513 const char *cp;
515 for (cp = name + len - 1; name + 2 <= cp; cp--) {
516 char ch = *cp;
517 if (hexval(ch) & ~0377) {
518 /* We must be looking at g in "SOMETHING-g"
519 * for it to be describe output.
521 if (ch == 'g' && cp[-1] == '-') {
522 cp++;
523 len -= cp - name;
524 return get_short_sha1(cp, len, sha1, 1);
528 return -1;
531 static int get_sha1_1(const char *name, int len, unsigned char *sha1)
533 int ret, has_suffix;
534 const char *cp;
537 * "name~3" is "name^^^", "name~" is "name~1", and "name^" is "name^1".
539 has_suffix = 0;
540 for (cp = name + len - 1; name <= cp; cp--) {
541 int ch = *cp;
542 if ('0' <= ch && ch <= '9')
543 continue;
544 if (ch == '~' || ch == '^')
545 has_suffix = ch;
546 break;
549 if (has_suffix) {
550 int num = 0;
551 int len1 = cp - name;
552 cp++;
553 while (cp < name + len)
554 num = num * 10 + *cp++ - '0';
555 if (!num && len1 == len - 1)
556 num = 1;
557 if (has_suffix == '^')
558 return get_parent(name, len1, sha1, num);
559 /* else if (has_suffix == '~') -- goes without saying */
560 return get_nth_ancestor(name, len1, sha1, num);
563 ret = peel_onion(name, len, sha1);
564 if (!ret)
565 return 0;
567 ret = get_sha1_basic(name, len, sha1);
568 if (!ret)
569 return 0;
571 /* It could be describe output that is "SOMETHING-gXXXX" */
572 ret = get_describe_name(name, len, sha1);
573 if (!ret)
574 return 0;
576 return get_short_sha1(name, len, sha1, 0);
579 static int handle_one_ref(const char *path,
580 const unsigned char *sha1, int flag, void *cb_data)
582 struct commit_list **list = cb_data;
583 struct object *object = parse_object(sha1);
584 if (!object)
585 return 0;
586 if (object->type == OBJ_TAG)
587 object = deref_tag(object, path, strlen(path));
588 if (object->type != OBJ_COMMIT)
589 return 0;
590 insert_by_date((struct commit *)object, list);
591 return 0;
595 * This interprets names like ':/Initial revision of "git"' by searching
596 * through history and returning the first commit whose message starts
597 * with the given string.
599 * For future extension, ':/!' is reserved. If you want to match a message
600 * beginning with a '!', you have to repeat the exclamation mark.
603 #define ONELINE_SEEN (1u<<20)
604 static int get_sha1_oneline(const char *prefix, unsigned char *sha1)
606 struct commit_list *list = NULL, *backup = NULL, *l;
607 int retval = -1;
608 char *temp_commit_buffer = NULL;
610 if (prefix[0] == '!') {
611 if (prefix[1] != '!')
612 die ("Invalid search pattern: %s", prefix);
613 prefix++;
615 for_each_ref(handle_one_ref, &list);
616 for (l = list; l; l = l->next)
617 commit_list_insert(l->item, &backup);
618 while (list) {
619 char *p;
620 struct commit *commit;
621 enum object_type type;
622 unsigned long size;
624 commit = pop_most_recent_commit(&list, ONELINE_SEEN);
625 parse_object(commit->object.sha1);
626 if (temp_commit_buffer)
627 free(temp_commit_buffer);
628 if (commit->buffer)
629 p = commit->buffer;
630 else {
631 p = read_sha1_file(commit->object.sha1, &type, &size);
632 if (!p)
633 continue;
634 temp_commit_buffer = p;
636 if (!(p = strstr(p, "\n\n")))
637 continue;
638 if (!prefixcmp(p + 2, prefix)) {
639 hashcpy(sha1, commit->object.sha1);
640 retval = 0;
641 break;
644 if (temp_commit_buffer)
645 free(temp_commit_buffer);
646 free_commit_list(list);
647 for (l = backup; l; l = l->next)
648 clear_commit_marks(l->item, ONELINE_SEEN);
649 return retval;
653 * This is like "get_sha1_basic()", except it allows "sha1 expressions",
654 * notably "xyz^" for "parent of xyz"
656 int get_sha1(const char *name, unsigned char *sha1)
658 unsigned unused;
659 return get_sha1_with_mode(name, sha1, &unused);
662 int get_sha1_with_mode(const char *name, unsigned char *sha1, unsigned *mode)
664 int ret, bracket_depth;
665 int namelen = strlen(name);
666 const char *cp;
668 *mode = S_IFINVALID;
669 ret = get_sha1_1(name, namelen, sha1);
670 if (!ret)
671 return ret;
672 /* sha1:path --> object name of path in ent sha1
673 * :path -> object name of path in index
674 * :[0-3]:path -> object name of path in index at stage
676 if (name[0] == ':') {
677 int stage = 0;
678 struct cache_entry *ce;
679 int pos;
680 if (namelen > 2 && name[1] == '/')
681 return get_sha1_oneline(name + 2, sha1);
682 if (namelen < 3 ||
683 name[2] != ':' ||
684 name[1] < '0' || '3' < name[1])
685 cp = name + 1;
686 else {
687 stage = name[1] - '0';
688 cp = name + 3;
690 namelen = namelen - (cp - name);
691 if (!active_cache)
692 read_cache();
693 pos = cache_name_pos(cp, namelen);
694 if (pos < 0)
695 pos = -pos - 1;
696 while (pos < active_nr) {
697 ce = active_cache[pos];
698 if (ce_namelen(ce) != namelen ||
699 memcmp(ce->name, cp, namelen))
700 break;
701 if (ce_stage(ce) == stage) {
702 hashcpy(sha1, ce->sha1);
703 *mode = ntohl(ce->ce_mode);
704 return 0;
706 pos++;
708 return -1;
710 for (cp = name, bracket_depth = 0; *cp; cp++) {
711 if (*cp == '{')
712 bracket_depth++;
713 else if (bracket_depth && *cp == '}')
714 bracket_depth--;
715 else if (!bracket_depth && *cp == ':')
716 break;
718 if (*cp == ':') {
719 unsigned char tree_sha1[20];
720 if (!get_sha1_1(name, cp-name, tree_sha1))
721 return get_tree_entry(tree_sha1, cp+1, sha1,
722 mode);
724 return ret;