11 static int get_sha1_oneline(const char *, unsigned char *, struct commit_list *);
13 typedef int (*disambiguate_hint_fn)(const unsigned char *, void *);
15 struct disambiguate_state {
16 disambiguate_hint_fn fn;
18 unsigned char candidate[20];
19 unsigned candidate_exists:1;
20 unsigned candidate_checked:1;
21 unsigned candidate_ok:1;
22 unsigned disambiguate_fn_used:1;
24 unsigned always_call_fn:1;
27 static void update_candidates(struct disambiguate_state *ds, const unsigned char *current)
29 if (ds->always_call_fn) {
30 ds->ambiguous = ds->fn(current, ds->cb_data) ? 1 : 0;
33 if (!ds->candidate_exists) {
34 /* this is the first candidate */
35 hashcpy(ds->candidate, current);
36 ds->candidate_exists = 1;
38 } else if (!hashcmp(ds->candidate, current)) {
39 /* the same as what we already have seen */
44 /* cannot disambiguate between ds->candidate and current */
49 if (!ds->candidate_checked) {
50 ds->candidate_ok = ds->fn(ds->candidate, ds->cb_data);
51 ds->disambiguate_fn_used = 1;
52 ds->candidate_checked = 1;
55 if (!ds->candidate_ok) {
56 /* discard the candidate; we know it does not satisfy fn */
57 hashcpy(ds->candidate, current);
58 ds->candidate_checked = 0;
62 /* if we reach this point, we know ds->candidate satisfies fn */
63 if (ds->fn(current, ds->cb_data)) {
65 * if both current and candidate satisfy fn, we cannot
72 /* otherwise, current can be discarded and candidate is still good */
75 static void find_short_object_filename(int len, const char *hex_pfx, struct disambiguate_state *ds)
77 struct alternate_object_database *alt;
79 static struct alternate_object_database *fakeent;
83 * Create a "fake" alternate object database that
84 * points to our own object database, to make it
85 * easier to get a temporary working space in
86 * alt->name/alt->base while iterating over the
87 * object databases including our own.
89 const char *objdir = get_object_directory();
90 size_t objdir_len = strlen(objdir);
91 fakeent = xmalloc(st_add3(sizeof(*fakeent), objdir_len, 43));
92 memcpy(fakeent->base, objdir, objdir_len);
93 fakeent->name = fakeent->base + objdir_len + 1;
94 fakeent->name[-1] = '/';
96 fakeent->next = alt_odb_list;
98 xsnprintf(hex, sizeof(hex), "%.2s", hex_pfx);
99 for (alt = fakeent; alt && !ds->ambiguous; alt = alt->next) {
103 * every alt_odb struct has 42 extra bytes after the base
104 * for exactly this purpose
106 xsnprintf(alt->name, 42, "%.2s/", hex_pfx);
107 dir = opendir(alt->base);
111 while (!ds->ambiguous && (de = readdir(dir)) != NULL) {
112 unsigned char sha1[20];
114 if (strlen(de->d_name) != 38)
116 if (memcmp(de->d_name, hex_pfx + 2, len - 2))
118 memcpy(hex + 2, de->d_name, 38);
119 if (!get_sha1_hex(hex, sha1))
120 update_candidates(ds, sha1);
126 static int match_sha(unsigned len, const unsigned char *a, const unsigned char *b)
136 if ((*a ^ *b) & 0xf0)
141 static void unique_in_pack(int len,
142 const unsigned char *bin_pfx,
143 struct packed_git *p,
144 struct disambiguate_state *ds)
146 uint32_t num, last, i, first = 0;
147 const unsigned char *current = NULL;
150 num = p->num_objects;
152 while (first < last) {
153 uint32_t mid = (first + last) / 2;
154 const unsigned char *current;
157 current = nth_packed_object_sha1(p, mid);
158 cmp = hashcmp(bin_pfx, current);
171 * At this point, "first" is the location of the lowest object
172 * with an object name that could match "bin_pfx". See if we have
173 * 0, 1 or more objects that actually match(es).
175 for (i = first; i < num && !ds->ambiguous; i++) {
176 current = nth_packed_object_sha1(p, i);
177 if (!match_sha(len, bin_pfx, current))
179 update_candidates(ds, current);
183 static void find_short_packed_object(int len, const unsigned char *bin_pfx,
184 struct disambiguate_state *ds)
186 struct packed_git *p;
188 prepare_packed_git();
189 for (p = packed_git; p && !ds->ambiguous; p = p->next)
190 unique_in_pack(len, bin_pfx, p, ds);
193 #define SHORT_NAME_NOT_FOUND (-1)
194 #define SHORT_NAME_AMBIGUOUS (-2)
196 static int finish_object_disambiguation(struct disambiguate_state *ds,
200 return SHORT_NAME_AMBIGUOUS;
202 if (!ds->candidate_exists)
203 return SHORT_NAME_NOT_FOUND;
205 if (!ds->candidate_checked)
207 * If this is the only candidate, there is no point
208 * calling the disambiguation hint callback.
210 * On the other hand, if the current candidate
211 * replaced an earlier candidate that did _not_ pass
212 * the disambiguation hint callback, then we do have
213 * more than one objects that match the short name
214 * given, so we should make sure this one matches;
215 * otherwise, if we discovered this one and the one
216 * that we previously discarded in the reverse order,
217 * we would end up showing different results in the
220 ds->candidate_ok = (!ds->disambiguate_fn_used ||
221 ds->fn(ds->candidate, ds->cb_data));
223 if (!ds->candidate_ok)
224 return SHORT_NAME_AMBIGUOUS;
226 hashcpy(sha1, ds->candidate);
230 static int disambiguate_commit_only(const unsigned char *sha1, void *cb_data_unused)
232 int kind = sha1_object_info(sha1, NULL);
233 return kind == OBJ_COMMIT;
236 static int disambiguate_committish_only(const unsigned char *sha1, void *cb_data_unused)
241 kind = sha1_object_info(sha1, NULL);
242 if (kind == OBJ_COMMIT)
247 /* We need to do this the hard way... */
248 obj = deref_tag(parse_object(sha1), NULL, 0);
249 if (obj && obj->type == OBJ_COMMIT)
254 static int disambiguate_tree_only(const unsigned char *sha1, void *cb_data_unused)
256 int kind = sha1_object_info(sha1, NULL);
257 return kind == OBJ_TREE;
260 static int disambiguate_treeish_only(const unsigned char *sha1, void *cb_data_unused)
265 kind = sha1_object_info(sha1, NULL);
266 if (kind == OBJ_TREE || kind == OBJ_COMMIT)
271 /* We need to do this the hard way... */
272 obj = deref_tag(lookup_object(sha1), NULL, 0);
273 if (obj && (obj->type == OBJ_TREE || obj->type == OBJ_COMMIT))
278 static int disambiguate_blob_only(const unsigned char *sha1, void *cb_data_unused)
280 int kind = sha1_object_info(sha1, NULL);
281 return kind == OBJ_BLOB;
284 static int prepare_prefixes(const char *name, int len,
285 unsigned char *bin_pfx,
291 memset(hex_pfx, 'x', 40);
292 for (i = 0; i < len ;i++) {
293 unsigned char c = name[i];
295 if (c >= '0' && c <= '9')
297 else if (c >= 'a' && c <= 'f')
299 else if (c >= 'A' && c <='F') {
308 bin_pfx[i >> 1] |= val;
313 static int get_short_sha1(const char *name, int len, unsigned char *sha1,
318 unsigned char bin_pfx[20];
319 struct disambiguate_state ds;
320 int quietly = !!(flags & GET_SHA1_QUIETLY);
322 if (len < MINIMUM_ABBREV || len > 40)
324 if (prepare_prefixes(name, len, bin_pfx, hex_pfx) < 0)
329 memset(&ds, 0, sizeof(ds));
330 if (flags & GET_SHA1_COMMIT)
331 ds.fn = disambiguate_commit_only;
332 else if (flags & GET_SHA1_COMMITTISH)
333 ds.fn = disambiguate_committish_only;
334 else if (flags & GET_SHA1_TREE)
335 ds.fn = disambiguate_tree_only;
336 else if (flags & GET_SHA1_TREEISH)
337 ds.fn = disambiguate_treeish_only;
338 else if (flags & GET_SHA1_BLOB)
339 ds.fn = disambiguate_blob_only;
341 find_short_object_filename(len, hex_pfx, &ds);
342 find_short_packed_object(len, bin_pfx, &ds);
343 status = finish_object_disambiguation(&ds, sha1);
345 if (!quietly && (status == SHORT_NAME_AMBIGUOUS))
346 return error("short SHA1 %.*s is ambiguous.", len, hex_pfx);
350 int for_each_abbrev(const char *prefix, each_abbrev_fn fn, void *cb_data)
353 unsigned char bin_pfx[20];
354 struct disambiguate_state ds;
355 int len = strlen(prefix);
357 if (len < MINIMUM_ABBREV || len > 40)
359 if (prepare_prefixes(prefix, len, bin_pfx, hex_pfx) < 0)
364 memset(&ds, 0, sizeof(ds));
365 ds.always_call_fn = 1;
366 ds.cb_data = cb_data;
369 find_short_object_filename(len, hex_pfx, &ds);
370 find_short_packed_object(len, bin_pfx, &ds);
374 int find_unique_abbrev_r(char *hex, const unsigned char *sha1, int len)
378 sha1_to_hex_r(hex, sha1);
379 if (len == 40 || !len)
381 exists = has_sha1_file(sha1);
383 unsigned char sha1_ret[20];
384 status = get_short_sha1(hex, len, sha1_ret, GET_SHA1_QUIETLY);
387 : status == SHORT_NAME_NOT_FOUND) {
396 const char *find_unique_abbrev(const unsigned char *sha1, int len)
398 static char hex[GIT_SHA1_HEXSZ + 1];
399 find_unique_abbrev_r(hex, sha1, len);
403 static int ambiguous_path(const char *path, int len)
408 for (cnt = 0; cnt < len; cnt++) {
428 static inline int at_mark(const char *string, int len,
429 const char **suffix, int nr)
433 for (i = 0; i < nr; i++) {
434 int suffix_len = strlen(suffix[i]);
435 if (suffix_len <= len
436 && !memcmp(string, suffix[i], suffix_len))
442 static inline int upstream_mark(const char *string, int len)
444 const char *suffix[] = { "upstream", "u" };
445 return at_mark(string, len, suffix, ARRAY_SIZE(suffix));
448 static inline int push_mark(const char *string, int len)
450 const char *suffix[] = { "push" };
451 return at_mark(string, len, suffix, ARRAY_SIZE(suffix));
454 static inline int publish_mark(const char *string, int len)
456 const char *suffix[] = { "publish", "p" };
457 return at_mark(string, len, suffix, ARRAY_SIZE(suffix));
460 static int get_sha1_1(const char *name, int len, unsigned char *sha1, unsigned lookup_flags);
461 static int interpret_nth_prior_checkout(const char *name, int namelen, struct strbuf *buf);
463 static int get_sha1_basic(const char *str, int len, unsigned char *sha1,
466 static const char *warn_msg = "refname '%.*s' is ambiguous.";
467 static const char *object_name_msg = N_(
468 "Git normally never creates a ref that ends with 40 hex characters\n"
469 "because it will be ignored when you just specify 40-hex. These refs\n"
470 "may be created by mistake. For example,\n"
472 " git checkout -b $br $(git rev-parse ...)\n"
474 "where \"$br\" is somehow empty and a 40-hex ref is created. Please\n"
475 "examine these refs and maybe delete them. Turn this message off by\n"
476 "running \"git config advice.objectNameWarning false\"");
477 unsigned char tmp_sha1[20];
478 char *real_ref = NULL;
480 int at, reflog_len, nth_prior = 0;
482 if (len == 40 && !get_sha1_hex(str, sha1)) {
483 if (warn_ambiguous_refs && warn_on_object_refname_ambiguity) {
484 refs_found = dwim_ref(str, len, tmp_sha1, &real_ref);
485 if (refs_found > 0) {
486 warning(warn_msg, len, str);
487 if (advice_object_name_warning)
488 fprintf(stderr, "%s\n", _(object_name_msg));
495 /* basic@{time or number or -number} format to query ref-log */
497 if (len && str[len-1] == '}') {
498 for (at = len-4; at >= 0; at--) {
499 if (str[at] == '@' && str[at+1] == '{') {
500 if (str[at+2] == '-') {
502 /* @{-N} not at start */
507 if (!upstream_mark(str + at + 2, len - at - 3) &&
508 !push_mark(str + at + 2, len - at - 3) &&
509 !publish_mark(str + at + 2, len - at - 3)) {
510 reflog_len = (len-1) - (at+2);
518 /* Accept only unambiguous ref paths. */
519 if (len && ambiguous_path(str, len))
523 struct strbuf buf = STRBUF_INIT;
526 if (interpret_nth_prior_checkout(str, len, &buf) > 0) {
527 detached = (buf.len == 40 && !get_sha1_hex(buf.buf, sha1));
528 strbuf_release(&buf);
534 if (!len && reflog_len)
535 /* allow "@{...}" to mean the current branch reflog */
536 refs_found = dwim_ref("HEAD", 4, sha1, &real_ref);
538 refs_found = dwim_log(str, len, sha1, &real_ref);
540 refs_found = dwim_ref(str, len, sha1, &real_ref);
545 if (warn_ambiguous_refs && !(flags & GET_SHA1_QUIETLY) &&
547 !get_short_sha1(str, len, tmp_sha1, GET_SHA1_QUIETLY)))
548 warning(warn_msg, len, str);
552 unsigned long at_time;
553 unsigned long co_time;
556 /* Is it asking for N-th entry, or approxidate? */
557 for (i = nth = 0; 0 <= nth && i < reflog_len; i++) {
558 char ch = str[at+2+i];
559 if ('0' <= ch && ch <= '9')
560 nth = nth * 10 + ch - '0';
564 if (100000000 <= nth) {
571 char *tmp = xstrndup(str + at + 2, reflog_len);
572 at_time = approxidate_careful(tmp, &errors);
579 if (read_ref_at(real_ref, flags, at_time, nth, sha1, NULL,
580 &co_time, &co_tz, &co_cnt)) {
582 if (starts_with(real_ref, "refs/heads/")) {
584 len = strlen(real_ref + 11);
592 if (!(flags & GET_SHA1_QUIETLY)) {
593 warning("Log for '%.*s' only goes "
594 "back to %s.", len, str,
595 show_date(co_time, co_tz, DATE_MODE(RFC2822)));
598 if (flags & GET_SHA1_QUIETLY) {
601 die("Log for '%.*s' only has %d entries.",
611 static int get_parent(const char *name, int len,
612 unsigned char *result, int idx)
614 unsigned char sha1[20];
615 int ret = get_sha1_1(name, len, sha1, GET_SHA1_COMMITTISH);
616 struct commit *commit;
617 struct commit_list *p;
621 commit = lookup_commit_reference(sha1);
622 if (parse_commit(commit))
625 hashcpy(result, commit->object.oid.hash);
631 hashcpy(result, p->item->object.oid.hash);
639 static int get_nth_ancestor(const char *name, int len,
640 unsigned char *result, int generation)
642 unsigned char sha1[20];
643 struct commit *commit;
646 ret = get_sha1_1(name, len, sha1, GET_SHA1_COMMITTISH);
649 commit = lookup_commit_reference(sha1);
653 while (generation--) {
654 if (parse_commit(commit) || !commit->parents)
656 commit = commit->parents->item;
658 hashcpy(result, commit->object.oid.hash);
662 struct object *peel_to_type(const char *name, int namelen,
663 struct object *o, enum object_type expected_type)
665 if (name && !namelen)
666 namelen = strlen(name);
668 if (!o || (!o->parsed && !parse_object(o->oid.hash)))
670 if (expected_type == OBJ_ANY || o->type == expected_type)
672 if (o->type == OBJ_TAG)
673 o = ((struct tag*) o)->tagged;
674 else if (o->type == OBJ_COMMIT)
675 o = &(((struct commit *) o)->tree->object);
678 error("%.*s: expected %s type, but the object "
679 "dereferences to %s type",
680 namelen, name, typename(expected_type),
687 static int peel_onion(const char *name, int len, unsigned char *sha1)
689 unsigned char outer[20];
691 unsigned int expected_type = 0;
692 unsigned lookup_flags = 0;
696 * "ref^{type}" dereferences ref repeatedly until you cannot
697 * dereference anymore, or you get an object of given type,
698 * whichever comes first. "ref^{}" means just dereference
699 * tags until you get a non-tag. "ref^0" is a shorthand for
700 * "ref^{commit}". "commit^{tree}" could be used to find the
701 * top-level tree of the given commit.
703 if (len < 4 || name[len-1] != '}')
706 for (sp = name + len - 1; name <= sp; sp--) {
708 if (ch == '{' && name < sp && sp[-1] == '^')
714 sp++; /* beginning of type name, or closing brace for empty */
715 if (starts_with(sp, "commit}"))
716 expected_type = OBJ_COMMIT;
717 else if (starts_with(sp, "tag}"))
718 expected_type = OBJ_TAG;
719 else if (starts_with(sp, "tree}"))
720 expected_type = OBJ_TREE;
721 else if (starts_with(sp, "blob}"))
722 expected_type = OBJ_BLOB;
723 else if (starts_with(sp, "object}"))
724 expected_type = OBJ_ANY;
725 else if (sp[0] == '}')
726 expected_type = OBJ_NONE;
727 else if (sp[0] == '/')
728 expected_type = OBJ_COMMIT;
732 if (expected_type == OBJ_COMMIT)
733 lookup_flags = GET_SHA1_COMMITTISH;
734 else if (expected_type == OBJ_TREE)
735 lookup_flags = GET_SHA1_TREEISH;
737 if (get_sha1_1(name, sp - name - 2, outer, lookup_flags))
740 o = parse_object(outer);
743 if (!expected_type) {
744 o = deref_tag(o, name, sp - name - 2);
745 if (!o || (!o->parsed && !parse_object(o->oid.hash)))
747 hashcpy(sha1, o->oid.hash);
752 * At this point, the syntax look correct, so
753 * if we do not get the needed object, we should
756 o = peel_to_type(name, len, o, expected_type);
760 hashcpy(sha1, o->oid.hash);
762 /* "$commit^{/foo}" */
765 struct commit_list *list = NULL;
768 * $commit^{/}. Some regex implementation may reject.
769 * We don't need regex anyway. '' pattern always matches.
774 prefix = xstrndup(sp + 1, name + len - 1 - (sp + 1));
775 commit_list_insert((struct commit *)o, &list);
776 ret = get_sha1_oneline(prefix, sha1, list);
783 static int get_describe_name(const char *name, int len, unsigned char *sha1)
786 unsigned flags = GET_SHA1_QUIETLY | GET_SHA1_COMMIT;
788 for (cp = name + len - 1; name + 2 <= cp; cp--) {
791 /* We must be looking at g in "SOMETHING-g"
792 * for it to be describe output.
794 if (ch == 'g' && cp[-1] == '-') {
797 return get_short_sha1(cp, len, sha1, flags);
804 static int get_sha1_1(const char *name, int len, unsigned char *sha1, unsigned lookup_flags)
810 * "name~3" is "name^^^", "name~" is "name~1", and "name^" is "name^1".
813 for (cp = name + len - 1; name <= cp; cp--) {
815 if ('0' <= ch && ch <= '9')
817 if (ch == '~' || ch == '^')
824 int len1 = cp - name;
826 while (cp < name + len)
827 num = num * 10 + *cp++ - '0';
828 if (!num && len1 == len - 1)
830 if (has_suffix == '^')
831 return get_parent(name, len1, sha1, num);
832 /* else if (has_suffix == '~') -- goes without saying */
833 return get_nth_ancestor(name, len1, sha1, num);
836 ret = peel_onion(name, len, sha1);
840 ret = get_sha1_basic(name, len, sha1, lookup_flags);
844 /* It could be describe output that is "SOMETHING-gXXXX" */
845 ret = get_describe_name(name, len, sha1);
849 return get_short_sha1(name, len, sha1, lookup_flags);
853 * This interprets names like ':/Initial revision of "git"' by searching
854 * through history and returning the first commit whose message starts
855 * the given regular expression.
857 * For negative-matching, prefix the pattern-part with '!-', like: ':/!-WIP'.
859 * For a literal '!' character at the beginning of a pattern, you have to repeat
860 * that, like: ':/!!foo'
862 * For future extension, all other sequences beginning with ':/!' are reserved.
865 /* Remember to update object flag allocation in object.h */
866 #define ONELINE_SEEN (1u<<20)
868 static int handle_one_ref(const char *path, const struct object_id *oid,
869 int flag, void *cb_data)
871 struct commit_list **list = cb_data;
872 struct object *object = parse_object(oid->hash);
875 if (object->type == OBJ_TAG) {
876 object = deref_tag(object, path, strlen(path));
880 if (object->type != OBJ_COMMIT)
882 commit_list_insert((struct commit *)object, list);
886 static int get_sha1_oneline(const char *prefix, unsigned char *sha1,
887 struct commit_list *list)
889 struct commit_list *backup = NULL, *l;
894 if (prefix[0] == '!') {
897 if (prefix[0] == '-') {
900 } else if (prefix[0] != '!') {
905 if (regcomp(®ex, prefix, REG_EXTENDED))
908 for (l = list; l; l = l->next) {
909 l->item->object.flags |= ONELINE_SEEN;
910 commit_list_insert(l->item, &backup);
914 struct commit *commit;
917 commit = pop_most_recent_commit(&list, ONELINE_SEEN);
918 if (!parse_object(commit->object.oid.hash))
920 buf = get_commit_buffer(commit, NULL);
921 p = strstr(buf, "\n\n");
922 matches = negative ^ (p && !regexec(®ex, p + 2, 0, NULL, 0));
923 unuse_commit_buffer(commit, buf);
926 hashcpy(sha1, commit->object.oid.hash);
932 free_commit_list(list);
933 for (l = backup; l; l = l->next)
934 clear_commit_marks(l->item, ONELINE_SEEN);
935 free_commit_list(backup);
936 return found ? 0 : -1;
939 struct grab_nth_branch_switch_cbdata {
944 static int grab_nth_branch_switch(unsigned char *osha1, unsigned char *nsha1,
945 const char *email, unsigned long timestamp, int tz,
946 const char *message, void *cb_data)
948 struct grab_nth_branch_switch_cbdata *cb = cb_data;
949 const char *match = NULL, *target = NULL;
952 if (skip_prefix(message, "checkout: moving from ", &match))
953 target = strstr(match, " to ");
955 if (!match || !target)
957 if (--(cb->remaining) == 0) {
958 len = target - match;
959 strbuf_reset(&cb->buf);
960 strbuf_add(&cb->buf, match, len);
961 return 1; /* we are done */
967 * Parse @{-N} syntax, return the number of characters parsed
968 * if successful; otherwise signal an error with negative value.
970 static int interpret_nth_prior_checkout(const char *name, int namelen,
975 struct grab_nth_branch_switch_cbdata cb;
981 if (name[0] != '@' || name[1] != '{' || name[2] != '-')
983 brace = memchr(name, '}', namelen);
986 nth = strtol(name + 3, &num_end, 10);
987 if (num_end != brace)
992 strbuf_init(&cb.buf, 20);
995 if (0 < for_each_reflog_ent_reverse("HEAD", grab_nth_branch_switch, &cb)) {
997 strbuf_addbuf(buf, &cb.buf);
998 retval = brace - name + 1;
1001 strbuf_release(&cb.buf);
1005 int get_sha1_mb(const char *name, unsigned char *sha1)
1007 struct commit *one, *two;
1008 struct commit_list *mbs;
1009 unsigned char sha1_tmp[20];
1013 dots = strstr(name, "...");
1015 return get_sha1(name, sha1);
1017 st = get_sha1("HEAD", sha1_tmp);
1020 strbuf_init(&sb, dots - name);
1021 strbuf_add(&sb, name, dots - name);
1022 st = get_sha1_committish(sb.buf, sha1_tmp);
1023 strbuf_release(&sb);
1027 one = lookup_commit_reference_gently(sha1_tmp, 0);
1031 if (get_sha1_committish(dots[3] ? (dots + 3) : "HEAD", sha1_tmp))
1033 two = lookup_commit_reference_gently(sha1_tmp, 0);
1036 mbs = get_merge_bases(one, two);
1037 if (!mbs || mbs->next)
1041 hashcpy(sha1, mbs->item->object.oid.hash);
1043 free_commit_list(mbs);
1047 /* parse @something syntax, when 'something' is not {.*} */
1048 static int interpret_empty_at(const char *name, int namelen, int len, struct strbuf *buf)
1052 if (len || name[1] == '{')
1055 /* make sure it's a single @, or @@{.*}, not @foo */
1056 next = memchr(name + len + 1, '@', namelen - len - 1);
1057 if (next && next[1] != '{')
1060 next = name + namelen;
1061 if (next != name + 1)
1065 strbuf_add(buf, "HEAD", 4);
1069 static int reinterpret(const char *name, int namelen, int len, struct strbuf *buf)
1071 /* we have extra data, which might need further processing */
1072 struct strbuf tmp = STRBUF_INIT;
1073 int used = buf->len;
1076 strbuf_add(buf, name + len, namelen - len);
1077 ret = interpret_branch_name(buf->buf, buf->len, &tmp);
1078 /* that data was not interpreted, remove our cruft */
1080 strbuf_setlen(buf, used);
1084 strbuf_addbuf(buf, &tmp);
1085 strbuf_release(&tmp);
1086 /* tweak for size of {-N} versus expanded ref name */
1087 return ret - used + len;
1090 static void set_shortened_ref(struct strbuf *buf, const char *ref)
1092 char *s = shorten_unambiguous_ref(ref, 0);
1094 strbuf_addstr(buf, s);
1098 static int interpret_branch_mark(const char *name, int namelen,
1099 int at, struct strbuf *buf,
1100 int (*get_mark)(const char *, int),
1101 const char *(*get_data)(struct branch *,
1105 struct branch *branch;
1106 struct strbuf err = STRBUF_INIT;
1109 if (name[at + 1] != '{' || name[namelen - 1] != '}')
1112 len = get_mark(name + at + 2, namelen - at - 3);
1116 if (memchr(name, ':', at))
1120 char *name_str = xmemdupz(name, at);
1121 branch = branch_get(name_str);
1124 branch = branch_get(NULL);
1126 value = get_data(branch, &err);
1130 set_shortened_ref(buf, value);
1131 return len + at + 3;
1135 * This reads short-hand syntax that not only evaluates to a commit
1136 * object name, but also can act as if the end user spelled the name
1137 * of the branch from the command line.
1139 * - "@{-N}" finds the name of the Nth previous branch we were on, and
1140 * places the name of the branch in the given buf and returns the
1141 * number of characters parsed if successful.
1143 * - "<branch>@{upstream}" finds the name of the other ref that
1144 * <branch> is configured to merge with (missing <branch> defaults
1145 * to the current branch), and places the name of the branch in the
1146 * given buf and returns the number of characters parsed if
1149 * If the input is not of the accepted format, it returns a negative
1150 * number to signal an error.
1152 * If the input was ok but there are not N branch switches in the
1153 * reflog, it returns 0.
1155 int interpret_branch_name(const char *name, int namelen, struct strbuf *buf)
1159 int len = interpret_nth_prior_checkout(name, namelen, buf);
1162 namelen = strlen(name);
1165 return len; /* syntax Ok, not enough switches */
1166 } else if (len > 0) {
1168 return len; /* consumed all */
1170 return reinterpret(name, namelen, len, buf);
1174 (at = memchr(start, '@', namelen - (start - name)));
1177 len = interpret_empty_at(name, namelen, at - name, buf);
1179 return reinterpret(name, namelen, len, buf);
1181 len = interpret_branch_mark(name, namelen, at - name, buf,
1182 upstream_mark, branch_get_upstream);
1186 len = interpret_branch_mark(name, namelen, at - name, buf,
1187 push_mark, branch_get_push);
1191 len = interpret_branch_mark(name, namelen, at - name, buf,
1192 publish_mark, branch_get_publish);
1200 int strbuf_branchname(struct strbuf *sb, const char *name)
1202 int len = strlen(name);
1203 int used = interpret_branch_name(name, len, sb);
1209 strbuf_add(sb, name + used, len - used);
1213 int strbuf_check_branch_ref(struct strbuf *sb, const char *name)
1215 strbuf_branchname(sb, name);
1218 strbuf_splice(sb, 0, 0, "refs/heads/", 11);
1219 return check_refname_format(sb->buf, 0);
1223 * This is like "get_sha1_basic()", except it allows "sha1 expressions",
1224 * notably "xyz^" for "parent of xyz"
1226 int get_sha1(const char *name, unsigned char *sha1)
1228 struct object_context unused;
1229 return get_sha1_with_context(name, 0, sha1, &unused);
1233 * Many callers know that the user meant to name a commit-ish by
1234 * syntactical positions where the object name appears. Calling this
1235 * function allows the machinery to disambiguate shorter-than-unique
1236 * abbreviated object names between commit-ish and others.
1238 * Note that this does NOT error out when the named object is not a
1239 * commit-ish. It is merely to give a hint to the disambiguation
1242 int get_sha1_committish(const char *name, unsigned char *sha1)
1244 struct object_context unused;
1245 return get_sha1_with_context(name, GET_SHA1_COMMITTISH,
1249 int get_sha1_treeish(const char *name, unsigned char *sha1)
1251 struct object_context unused;
1252 return get_sha1_with_context(name, GET_SHA1_TREEISH,
1256 int get_sha1_commit(const char *name, unsigned char *sha1)
1258 struct object_context unused;
1259 return get_sha1_with_context(name, GET_SHA1_COMMIT,
1263 int get_sha1_tree(const char *name, unsigned char *sha1)
1265 struct object_context unused;
1266 return get_sha1_with_context(name, GET_SHA1_TREE,
1270 int get_sha1_blob(const char *name, unsigned char *sha1)
1272 struct object_context unused;
1273 return get_sha1_with_context(name, GET_SHA1_BLOB,
1277 /* Must be called only when object_name:filename doesn't exist. */
1278 static void diagnose_invalid_sha1_path(const char *prefix,
1279 const char *filename,
1280 const unsigned char *tree_sha1,
1281 const char *object_name,
1282 int object_name_len)
1284 unsigned char sha1[20];
1290 if (file_exists(filename))
1291 die("Path '%s' exists on disk, but not in '%.*s'.",
1292 filename, object_name_len, object_name);
1293 if (errno == ENOENT || errno == ENOTDIR) {
1294 char *fullname = xstrfmt("%s%s", prefix, filename);
1296 if (!get_tree_entry(tree_sha1, fullname,
1298 die("Path '%s' exists, but not '%s'.\n"
1299 "Did you mean '%.*s:%s' aka '%.*s:./%s'?",
1302 object_name_len, object_name,
1304 object_name_len, object_name,
1307 die("Path '%s' does not exist in '%.*s'",
1308 filename, object_name_len, object_name);
1312 /* Must be called only when :stage:filename doesn't exist. */
1313 static void diagnose_invalid_index_path(int stage,
1315 const char *filename)
1317 const struct cache_entry *ce;
1319 unsigned namelen = strlen(filename);
1320 struct strbuf fullname = STRBUF_INIT;
1325 /* Wrong stage number? */
1326 pos = cache_name_pos(filename, namelen);
1329 if (pos < active_nr) {
1330 ce = active_cache[pos];
1331 if (ce_namelen(ce) == namelen &&
1332 !memcmp(ce->name, filename, namelen))
1333 die("Path '%s' is in the index, but not at stage %d.\n"
1334 "Did you mean ':%d:%s'?",
1336 ce_stage(ce), filename);
1339 /* Confusion between relative and absolute filenames? */
1340 strbuf_addstr(&fullname, prefix);
1341 strbuf_addstr(&fullname, filename);
1342 pos = cache_name_pos(fullname.buf, fullname.len);
1345 if (pos < active_nr) {
1346 ce = active_cache[pos];
1347 if (ce_namelen(ce) == fullname.len &&
1348 !memcmp(ce->name, fullname.buf, fullname.len))
1349 die("Path '%s' is in the index, but not '%s'.\n"
1350 "Did you mean ':%d:%s' aka ':%d:./%s'?",
1351 fullname.buf, filename,
1352 ce_stage(ce), fullname.buf,
1353 ce_stage(ce), filename);
1356 if (file_exists(filename))
1357 die("Path '%s' exists on disk, but not in the index.", filename);
1358 if (errno == ENOENT || errno == ENOTDIR)
1359 die("Path '%s' does not exist (neither on disk nor in the index).",
1362 strbuf_release(&fullname);
1366 static char *resolve_relative_path(const char *rel)
1368 if (!starts_with(rel, "./") && !starts_with(rel, "../"))
1372 die("BUG: startup_info struct is not initialized.");
1374 if (!is_inside_work_tree())
1375 die("relative path syntax can't be used outside working tree.");
1377 /* die() inside prefix_path() if resolved path is outside worktree */
1378 return prefix_path(startup_info->prefix,
1379 startup_info->prefix ? strlen(startup_info->prefix) : 0,
1383 static int get_sha1_with_context_1(const char *name,
1386 unsigned char *sha1,
1387 struct object_context *oc)
1389 int ret, bracket_depth;
1390 int namelen = strlen(name);
1392 int only_to_die = flags & GET_SHA1_ONLY_TO_DIE;
1394 memset(oc, 0, sizeof(*oc));
1395 oc->mode = S_IFINVALID;
1396 ret = get_sha1_1(name, namelen, sha1, flags);
1400 * sha1:path --> object name of path in ent sha1
1401 * :path -> object name of absolute path in index
1402 * :./path -> object name of path relative to cwd in index
1403 * :[0-3]:path -> object name of path in index at stage
1404 * :/foo -> recent commit matching foo
1406 if (name[0] == ':') {
1408 const struct cache_entry *ce;
1409 char *new_path = NULL;
1411 if (!only_to_die && namelen > 2 && name[1] == '/') {
1412 struct commit_list *list = NULL;
1414 for_each_ref(handle_one_ref, &list);
1415 commit_list_sort_by_date(&list);
1416 return get_sha1_oneline(name + 2, sha1, list);
1420 name[1] < '0' || '3' < name[1])
1423 stage = name[1] - '0';
1426 new_path = resolve_relative_path(cp);
1428 namelen = namelen - (cp - name);
1431 namelen = strlen(cp);
1434 strlcpy(oc->path, cp, sizeof(oc->path));
1438 pos = cache_name_pos(cp, namelen);
1441 while (pos < active_nr) {
1442 ce = active_cache[pos];
1443 if (ce_namelen(ce) != namelen ||
1444 memcmp(ce->name, cp, namelen))
1446 if (ce_stage(ce) == stage) {
1447 hashcpy(sha1, ce->sha1);
1448 oc->mode = ce->ce_mode;
1454 if (only_to_die && name[1] && name[1] != '/')
1455 diagnose_invalid_index_path(stage, prefix, cp);
1459 for (cp = name, bracket_depth = 0; *cp; cp++) {
1462 else if (bracket_depth && *cp == '}')
1464 else if (!bracket_depth && *cp == ':')
1468 unsigned char tree_sha1[20];
1469 int len = cp - name;
1470 if (!get_sha1_1(name, len, tree_sha1, GET_SHA1_TREEISH)) {
1471 const char *filename = cp+1;
1472 char *new_filename = NULL;
1474 new_filename = resolve_relative_path(filename);
1476 filename = new_filename;
1477 if (flags & GET_SHA1_FOLLOW_SYMLINKS) {
1478 ret = get_tree_entry_follow_symlinks(tree_sha1,
1479 filename, sha1, &oc->symlink_path,
1482 ret = get_tree_entry(tree_sha1, filename,
1484 if (ret && only_to_die) {
1485 diagnose_invalid_sha1_path(prefix,
1491 hashcpy(oc->tree, tree_sha1);
1492 strlcpy(oc->path, filename, sizeof(oc->path));
1498 die("Invalid object name '%.*s'.", len, name);
1505 * Call this function when you know "name" given by the end user must
1506 * name an object but it doesn't; the function _may_ die with a better
1507 * diagnostic message than "no such object 'name'", e.g. "Path 'doc' does not
1508 * exist in 'HEAD'" when given "HEAD:doc", or it may return in which case
1509 * you have a chance to diagnose the error further.
1511 void maybe_die_on_misspelt_object_name(const char *name, const char *prefix)
1513 struct object_context oc;
1514 unsigned char sha1[20];
1515 get_sha1_with_context_1(name, GET_SHA1_ONLY_TO_DIE, prefix, sha1, &oc);
1518 int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc)
1520 if (flags & GET_SHA1_FOLLOW_SYMLINKS && flags & GET_SHA1_ONLY_TO_DIE)
1521 die("BUG: incompatible flags for get_sha1_with_context");
1522 return get_sha1_with_context_1(str, flags, NULL, sha1, orc);