10 static int get_sha1_oneline(const char *, unsigned char *, struct commit_list *);
12 typedef int (*disambiguate_hint_fn)(const unsigned char *, void *);
14 struct disambiguate_state {
15 disambiguate_hint_fn fn;
17 unsigned char candidate[20];
18 unsigned candidate_exists:1;
19 unsigned candidate_checked:1;
20 unsigned candidate_ok:1;
21 unsigned disambiguate_fn_used:1;
23 unsigned always_call_fn:1;
26 static void update_candidates(struct disambiguate_state *ds, const unsigned char *current)
28 if (ds->always_call_fn) {
29 ds->ambiguous = ds->fn(current, ds->cb_data) ? 1 : 0;
32 if (!ds->candidate_exists) {
33 /* this is the first candidate */
34 hashcpy(ds->candidate, current);
35 ds->candidate_exists = 1;
37 } else if (!hashcmp(ds->candidate, current)) {
38 /* the same as what we already have seen */
43 /* cannot disambiguate between ds->candidate and current */
48 if (!ds->candidate_checked) {
49 ds->candidate_ok = ds->fn(ds->candidate, ds->cb_data);
50 ds->disambiguate_fn_used = 1;
51 ds->candidate_checked = 1;
54 if (!ds->candidate_ok) {
55 /* discard the candidate; we know it does not satisfy fn */
56 hashcpy(ds->candidate, current);
57 ds->candidate_checked = 0;
61 /* if we reach this point, we know ds->candidate satisfies fn */
62 if (ds->fn(current, ds->cb_data)) {
64 * if both current and candidate satisfy fn, we cannot
71 /* otherwise, current can be discarded and candidate is still good */
74 static void find_short_object_filename(int len, const char *hex_pfx, struct disambiguate_state *ds)
76 struct alternate_object_database *alt;
78 static struct alternate_object_database *fakeent;
82 * Create a "fake" alternate object database that
83 * points to our own object database, to make it
84 * easier to get a temporary working space in
85 * alt->name/alt->base while iterating over the
86 * object databases including our own.
88 const char *objdir = get_object_directory();
89 int objdir_len = strlen(objdir);
90 int entlen = objdir_len + 43;
91 fakeent = xmalloc(sizeof(*fakeent) + entlen);
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 sprintf(hex, "%.2s", hex_pfx);
99 for (alt = fakeent; alt && !ds->ambiguous; alt = alt->next) {
102 sprintf(alt->name, "%.2s/", hex_pfx);
103 dir = opendir(alt->base);
107 while (!ds->ambiguous && (de = readdir(dir)) != NULL) {
108 unsigned char sha1[20];
110 if (strlen(de->d_name) != 38)
112 if (memcmp(de->d_name, hex_pfx + 2, len - 2))
114 memcpy(hex + 2, de->d_name, 38);
115 if (!get_sha1_hex(hex, sha1))
116 update_candidates(ds, sha1);
122 static int match_sha(unsigned len, const unsigned char *a, const unsigned char *b)
132 if ((*a ^ *b) & 0xf0)
137 static void unique_in_pack(int len,
138 const unsigned char *bin_pfx,
139 struct packed_git *p,
140 struct disambiguate_state *ds)
142 uint32_t num, last, i, first = 0;
143 const unsigned char *current = NULL;
146 num = p->num_objects;
148 while (first < last) {
149 uint32_t mid = (first + last) / 2;
150 const unsigned char *current;
153 current = nth_packed_object_sha1(p, mid);
154 cmp = hashcmp(bin_pfx, current);
167 * At this point, "first" is the location of the lowest object
168 * with an object name that could match "bin_pfx". See if we have
169 * 0, 1 or more objects that actually match(es).
171 for (i = first; i < num && !ds->ambiguous; i++) {
172 current = nth_packed_object_sha1(p, i);
173 if (!match_sha(len, bin_pfx, current))
175 update_candidates(ds, current);
179 static void find_short_packed_object(int len, const unsigned char *bin_pfx,
180 struct disambiguate_state *ds)
182 struct packed_git *p;
184 prepare_packed_git();
185 for (p = packed_git; p && !ds->ambiguous; p = p->next)
186 unique_in_pack(len, bin_pfx, p, ds);
189 #define SHORT_NAME_NOT_FOUND (-1)
190 #define SHORT_NAME_AMBIGUOUS (-2)
192 static int finish_object_disambiguation(struct disambiguate_state *ds,
196 return SHORT_NAME_AMBIGUOUS;
198 if (!ds->candidate_exists)
199 return SHORT_NAME_NOT_FOUND;
201 if (!ds->candidate_checked)
203 * If this is the only candidate, there is no point
204 * calling the disambiguation hint callback.
206 * On the other hand, if the current candidate
207 * replaced an earlier candidate that did _not_ pass
208 * the disambiguation hint callback, then we do have
209 * more than one objects that match the short name
210 * given, so we should make sure this one matches;
211 * otherwise, if we discovered this one and the one
212 * that we previously discarded in the reverse order,
213 * we would end up showing different results in the
216 ds->candidate_ok = (!ds->disambiguate_fn_used ||
217 ds->fn(ds->candidate, ds->cb_data));
219 if (!ds->candidate_ok)
220 return SHORT_NAME_AMBIGUOUS;
222 hashcpy(sha1, ds->candidate);
226 static int disambiguate_commit_only(const unsigned char *sha1, void *cb_data_unused)
228 int kind = sha1_object_info(sha1, NULL);
229 return kind == OBJ_COMMIT;
232 static int disambiguate_committish_only(const unsigned char *sha1, void *cb_data_unused)
237 kind = sha1_object_info(sha1, NULL);
238 if (kind == OBJ_COMMIT)
243 /* We need to do this the hard way... */
244 obj = deref_tag(parse_object(sha1), NULL, 0);
245 if (obj && obj->type == OBJ_COMMIT)
250 static int disambiguate_tree_only(const unsigned char *sha1, void *cb_data_unused)
252 int kind = sha1_object_info(sha1, NULL);
253 return kind == OBJ_TREE;
256 static int disambiguate_treeish_only(const unsigned char *sha1, void *cb_data_unused)
261 kind = sha1_object_info(sha1, NULL);
262 if (kind == OBJ_TREE || kind == OBJ_COMMIT)
267 /* We need to do this the hard way... */
268 obj = deref_tag(lookup_object(sha1), NULL, 0);
269 if (obj && (obj->type == OBJ_TREE || obj->type == OBJ_COMMIT))
274 static int disambiguate_blob_only(const unsigned char *sha1, void *cb_data_unused)
276 int kind = sha1_object_info(sha1, NULL);
277 return kind == OBJ_BLOB;
280 static int prepare_prefixes(const char *name, int len,
281 unsigned char *bin_pfx,
287 memset(hex_pfx, 'x', 40);
288 for (i = 0; i < len ;i++) {
289 unsigned char c = name[i];
291 if (c >= '0' && c <= '9')
293 else if (c >= 'a' && c <= 'f')
295 else if (c >= 'A' && c <='F') {
304 bin_pfx[i >> 1] |= val;
309 static int get_short_sha1(const char *name, int len, unsigned char *sha1,
314 unsigned char bin_pfx[20];
315 struct disambiguate_state ds;
316 int quietly = !!(flags & GET_SHA1_QUIETLY);
318 if (len < MINIMUM_ABBREV || len > 40)
320 if (prepare_prefixes(name, len, bin_pfx, hex_pfx) < 0)
325 memset(&ds, 0, sizeof(ds));
326 if (flags & GET_SHA1_COMMIT)
327 ds.fn = disambiguate_commit_only;
328 else if (flags & GET_SHA1_COMMITTISH)
329 ds.fn = disambiguate_committish_only;
330 else if (flags & GET_SHA1_TREE)
331 ds.fn = disambiguate_tree_only;
332 else if (flags & GET_SHA1_TREEISH)
333 ds.fn = disambiguate_treeish_only;
334 else if (flags & GET_SHA1_BLOB)
335 ds.fn = disambiguate_blob_only;
337 find_short_object_filename(len, hex_pfx, &ds);
338 find_short_packed_object(len, bin_pfx, &ds);
339 status = finish_object_disambiguation(&ds, sha1);
341 if (!quietly && (status == SHORT_NAME_AMBIGUOUS))
342 return error("short SHA1 %.*s is ambiguous.", len, hex_pfx);
346 int for_each_abbrev(const char *prefix, each_abbrev_fn fn, void *cb_data)
349 unsigned char bin_pfx[20];
350 struct disambiguate_state ds;
351 int len = strlen(prefix);
353 if (len < MINIMUM_ABBREV || len > 40)
355 if (prepare_prefixes(prefix, len, bin_pfx, hex_pfx) < 0)
360 memset(&ds, 0, sizeof(ds));
361 ds.always_call_fn = 1;
362 ds.cb_data = cb_data;
365 find_short_object_filename(len, hex_pfx, &ds);
366 find_short_packed_object(len, bin_pfx, &ds);
370 const char *find_unique_abbrev(const unsigned char *sha1, int len)
375 exists = has_sha1_file(sha1);
376 memcpy(hex, sha1_to_hex(sha1), 40);
377 if (len == 40 || !len)
380 unsigned char sha1_ret[20];
381 status = get_short_sha1(hex, len, sha1_ret, GET_SHA1_QUIETLY);
384 : status == SHORT_NAME_NOT_FOUND) {
393 static int ambiguous_path(const char *path, int len)
398 for (cnt = 0; cnt < len; cnt++) {
418 static inline int upstream_mark(const char *string, int len)
420 const char *suffix[] = { "@{upstream}", "@{u}" };
423 for (i = 0; i < ARRAY_SIZE(suffix); i++) {
424 int suffix_len = strlen(suffix[i]);
425 if (suffix_len <= len
426 && !memcmp(string, suffix[i], suffix_len))
432 static int get_sha1_1(const char *name, int len, unsigned char *sha1, unsigned lookup_flags);
433 static int interpret_nth_prior_checkout(const char *name, struct strbuf *buf);
435 static int get_sha1_basic(const char *str, int len, unsigned char *sha1)
437 static const char *warn_msg = "refname '%.*s' is ambiguous.";
438 static const char *object_name_msg = N_(
439 "Git normally never creates a ref that ends with 40 hex characters\n"
440 "because it will be ignored when you just specify 40-hex. These refs\n"
441 "may be created by mistake. For example,\n"
443 " git checkout -b $br $(git rev-parse ...)\n"
445 "where \"$br\" is somehow empty and a 40-hex ref is created. Please\n"
446 "examine these refs and maybe delete them. Turn this message off by\n"
447 "running \"git config advice.objectNameWarning false\"");
448 unsigned char tmp_sha1[20];
449 char *real_ref = NULL;
451 int at, reflog_len, nth_prior = 0;
453 if (len == 40 && !get_sha1_hex(str, sha1)) {
454 if (warn_ambiguous_refs && warn_on_object_refname_ambiguity) {
455 refs_found = dwim_ref(str, len, tmp_sha1, &real_ref);
456 if (refs_found > 0) {
457 warning(warn_msg, len, str);
458 if (advice_object_name_warning)
459 fprintf(stderr, "%s\n", _(object_name_msg));
466 /* basic@{time or number or -number} format to query ref-log */
468 if (len && str[len-1] == '}') {
469 for (at = len-4; at >= 0; at--) {
470 if (str[at] == '@' && str[at+1] == '{') {
471 if (str[at+2] == '-') {
473 /* @{-N} not at start */
478 if (!upstream_mark(str + at, len - at)) {
479 reflog_len = (len-1) - (at+2);
487 /* Accept only unambiguous ref paths. */
488 if (len && ambiguous_path(str, len))
492 struct strbuf buf = STRBUF_INIT;
495 if (interpret_nth_prior_checkout(str, &buf) > 0) {
496 detached = (buf.len == 40 && !get_sha1_hex(buf.buf, sha1));
497 strbuf_release(&buf);
503 if (!len && reflog_len)
504 /* allow "@{...}" to mean the current branch reflog */
505 refs_found = dwim_ref("HEAD", 4, sha1, &real_ref);
507 refs_found = dwim_log(str, len, sha1, &real_ref);
509 refs_found = dwim_ref(str, len, sha1, &real_ref);
514 if (warn_ambiguous_refs &&
516 !get_short_sha1(str, len, tmp_sha1, GET_SHA1_QUIETLY)))
517 warning(warn_msg, len, str);
521 unsigned long at_time;
522 unsigned long co_time;
525 /* Is it asking for N-th entry, or approxidate? */
526 for (i = nth = 0; 0 <= nth && i < reflog_len; i++) {
527 char ch = str[at+2+i];
528 if ('0' <= ch && ch <= '9')
529 nth = nth * 10 + ch - '0';
533 if (100000000 <= nth) {
540 char *tmp = xstrndup(str + at + 2, reflog_len);
541 at_time = approxidate_careful(tmp, &errors);
546 if (read_ref_at(real_ref, at_time, nth, sha1, NULL,
547 &co_time, &co_tz, &co_cnt)) {
549 if (starts_with(real_ref, "refs/heads/")) {
551 len = strlen(real_ref + 11);
559 warning("Log for '%.*s' only goes "
560 "back to %s.", len, str,
561 show_date(co_time, co_tz, DATE_RFC2822));
563 die("Log for '%.*s' only has %d entries.",
573 static int get_parent(const char *name, int len,
574 unsigned char *result, int idx)
576 unsigned char sha1[20];
577 int ret = get_sha1_1(name, len, sha1, GET_SHA1_COMMITTISH);
578 struct commit *commit;
579 struct commit_list *p;
583 commit = lookup_commit_reference(sha1);
584 if (parse_commit(commit))
587 hashcpy(result, commit->object.sha1);
593 hashcpy(result, p->item->object.sha1);
601 static int get_nth_ancestor(const char *name, int len,
602 unsigned char *result, int generation)
604 unsigned char sha1[20];
605 struct commit *commit;
608 ret = get_sha1_1(name, len, sha1, GET_SHA1_COMMITTISH);
611 commit = lookup_commit_reference(sha1);
615 while (generation--) {
616 if (parse_commit(commit) || !commit->parents)
618 commit = commit->parents->item;
620 hashcpy(result, commit->object.sha1);
624 struct object *peel_to_type(const char *name, int namelen,
625 struct object *o, enum object_type expected_type)
627 if (name && !namelen)
628 namelen = strlen(name);
630 if (!o || (!o->parsed && !parse_object(o->sha1)))
632 if (expected_type == OBJ_ANY || o->type == expected_type)
634 if (o->type == OBJ_TAG)
635 o = ((struct tag*) o)->tagged;
636 else if (o->type == OBJ_COMMIT)
637 o = &(((struct commit *) o)->tree->object);
640 error("%.*s: expected %s type, but the object "
641 "dereferences to %s type",
642 namelen, name, typename(expected_type),
649 static int peel_onion(const char *name, int len, unsigned char *sha1)
651 unsigned char outer[20];
653 unsigned int expected_type = 0;
654 unsigned lookup_flags = 0;
658 * "ref^{type}" dereferences ref repeatedly until you cannot
659 * dereference anymore, or you get an object of given type,
660 * whichever comes first. "ref^{}" means just dereference
661 * tags until you get a non-tag. "ref^0" is a shorthand for
662 * "ref^{commit}". "commit^{tree}" could be used to find the
663 * top-level tree of the given commit.
665 if (len < 4 || name[len-1] != '}')
668 for (sp = name + len - 1; name <= sp; sp--) {
670 if (ch == '{' && name < sp && sp[-1] == '^')
676 sp++; /* beginning of type name, or closing brace for empty */
677 if (starts_with(sp, "commit}"))
678 expected_type = OBJ_COMMIT;
679 else if (starts_with(sp, "tag}"))
680 expected_type = OBJ_TAG;
681 else if (starts_with(sp, "tree}"))
682 expected_type = OBJ_TREE;
683 else if (starts_with(sp, "blob}"))
684 expected_type = OBJ_BLOB;
685 else if (starts_with(sp, "object}"))
686 expected_type = OBJ_ANY;
687 else if (sp[0] == '}')
688 expected_type = OBJ_NONE;
689 else if (sp[0] == '/')
690 expected_type = OBJ_COMMIT;
694 if (expected_type == OBJ_COMMIT)
695 lookup_flags = GET_SHA1_COMMITTISH;
696 else if (expected_type == OBJ_TREE)
697 lookup_flags = GET_SHA1_TREEISH;
699 if (get_sha1_1(name, sp - name - 2, outer, lookup_flags))
702 o = parse_object(outer);
705 if (!expected_type) {
706 o = deref_tag(o, name, sp - name - 2);
707 if (!o || (!o->parsed && !parse_object(o->sha1)))
709 hashcpy(sha1, o->sha1);
714 * At this point, the syntax look correct, so
715 * if we do not get the needed object, we should
718 o = peel_to_type(name, len, o, expected_type);
722 hashcpy(sha1, o->sha1);
724 /* "$commit^{/foo}" */
727 struct commit_list *list = NULL;
730 * $commit^{/}. Some regex implementation may reject.
731 * We don't need regex anyway. '' pattern always matches.
736 prefix = xstrndup(sp + 1, name + len - 1 - (sp + 1));
737 commit_list_insert((struct commit *)o, &list);
738 ret = get_sha1_oneline(prefix, sha1, list);
745 static int get_describe_name(const char *name, int len, unsigned char *sha1)
748 unsigned flags = GET_SHA1_QUIETLY | GET_SHA1_COMMIT;
750 for (cp = name + len - 1; name + 2 <= cp; cp--) {
752 if (hexval(ch) & ~0377) {
753 /* We must be looking at g in "SOMETHING-g"
754 * for it to be describe output.
756 if (ch == 'g' && cp[-1] == '-') {
759 return get_short_sha1(cp, len, sha1, flags);
766 static int get_sha1_1(const char *name, int len, unsigned char *sha1, unsigned lookup_flags)
772 * "name~3" is "name^^^", "name~" is "name~1", and "name^" is "name^1".
775 for (cp = name + len - 1; name <= cp; cp--) {
777 if ('0' <= ch && ch <= '9')
779 if (ch == '~' || ch == '^')
786 int len1 = cp - name;
788 while (cp < name + len)
789 num = num * 10 + *cp++ - '0';
790 if (!num && len1 == len - 1)
792 if (has_suffix == '^')
793 return get_parent(name, len1, sha1, num);
794 /* else if (has_suffix == '~') -- goes without saying */
795 return get_nth_ancestor(name, len1, sha1, num);
798 ret = peel_onion(name, len, sha1);
802 ret = get_sha1_basic(name, len, sha1);
806 /* It could be describe output that is "SOMETHING-gXXXX" */
807 ret = get_describe_name(name, len, sha1);
811 return get_short_sha1(name, len, sha1, lookup_flags);
815 * This interprets names like ':/Initial revision of "git"' by searching
816 * through history and returning the first commit whose message starts
817 * the given regular expression.
819 * For future extension, ':/!' is reserved. If you want to match a message
820 * beginning with a '!', you have to repeat the exclamation mark.
822 #define ONELINE_SEEN (1u<<20)
824 static int handle_one_ref(const char *path,
825 const unsigned char *sha1, int flag, void *cb_data)
827 struct commit_list **list = cb_data;
828 struct object *object = parse_object(sha1);
831 if (object->type == OBJ_TAG) {
832 object = deref_tag(object, path, strlen(path));
836 if (object->type != OBJ_COMMIT)
838 commit_list_insert_by_date((struct commit *)object, list);
842 static int get_sha1_oneline(const char *prefix, unsigned char *sha1,
843 struct commit_list *list)
845 struct commit_list *backup = NULL, *l;
849 if (prefix[0] == '!') {
850 if (prefix[1] != '!')
851 die ("Invalid search pattern: %s", prefix);
855 if (regcomp(®ex, prefix, REG_EXTENDED))
856 die("Invalid search pattern: %s", prefix);
858 for (l = list; l; l = l->next) {
859 l->item->object.flags |= ONELINE_SEEN;
860 commit_list_insert(l->item, &backup);
863 char *p, *to_free = NULL;
864 struct commit *commit;
865 enum object_type type;
869 commit = pop_most_recent_commit(&list, ONELINE_SEEN);
870 if (!parse_object(commit->object.sha1))
875 p = read_sha1_file(commit->object.sha1, &type, &size);
881 p = strstr(p, "\n\n");
882 matches = p && !regexec(®ex, p + 2, 0, NULL, 0);
886 hashcpy(sha1, commit->object.sha1);
892 free_commit_list(list);
893 for (l = backup; l; l = l->next)
894 clear_commit_marks(l->item, ONELINE_SEEN);
895 free_commit_list(backup);
896 return found ? 0 : -1;
899 struct grab_nth_branch_switch_cbdata {
904 static int grab_nth_branch_switch(unsigned char *osha1, unsigned char *nsha1,
905 const char *email, unsigned long timestamp, int tz,
906 const char *message, void *cb_data)
908 struct grab_nth_branch_switch_cbdata *cb = cb_data;
909 const char *match = NULL, *target = NULL;
912 if (starts_with(message, "checkout: moving from ")) {
913 match = message + strlen("checkout: moving from ");
914 target = strstr(match, " to ");
917 if (!match || !target)
919 if (--(cb->remaining) == 0) {
920 len = target - match;
921 strbuf_reset(&cb->buf);
922 strbuf_add(&cb->buf, match, len);
923 return 1; /* we are done */
929 * Parse @{-N} syntax, return the number of characters parsed
930 * if successful; otherwise signal an error with negative value.
932 static int interpret_nth_prior_checkout(const char *name, struct strbuf *buf)
936 struct grab_nth_branch_switch_cbdata cb;
940 if (name[0] != '@' || name[1] != '{' || name[2] != '-')
942 brace = strchr(name, '}');
945 nth = strtol(name + 3, &num_end, 10);
946 if (num_end != brace)
951 strbuf_init(&cb.buf, 20);
954 if (0 < for_each_reflog_ent_reverse("HEAD", grab_nth_branch_switch, &cb)) {
956 strbuf_add(buf, cb.buf.buf, cb.buf.len);
957 retval = brace - name + 1;
960 strbuf_release(&cb.buf);
964 int get_sha1_mb(const char *name, unsigned char *sha1)
966 struct commit *one, *two;
967 struct commit_list *mbs;
968 unsigned char sha1_tmp[20];
972 dots = strstr(name, "...");
974 return get_sha1(name, sha1);
976 st = get_sha1("HEAD", sha1_tmp);
979 strbuf_init(&sb, dots - name);
980 strbuf_add(&sb, name, dots - name);
981 st = get_sha1_committish(sb.buf, sha1_tmp);
986 one = lookup_commit_reference_gently(sha1_tmp, 0);
990 if (get_sha1_committish(dots[3] ? (dots + 3) : "HEAD", sha1_tmp))
992 two = lookup_commit_reference_gently(sha1_tmp, 0);
995 mbs = get_merge_bases(one, two, 1);
996 if (!mbs || mbs->next)
1000 hashcpy(sha1, mbs->item->object.sha1);
1002 free_commit_list(mbs);
1006 /* parse @something syntax, when 'something' is not {.*} */
1007 static int interpret_empty_at(const char *name, int namelen, int len, struct strbuf *buf)
1011 if (len || name[1] == '{')
1014 /* make sure it's a single @, or @@{.*}, not @foo */
1015 next = strchr(name + len + 1, '@');
1016 if (next && next[1] != '{')
1019 next = name + namelen;
1020 if (next != name + 1)
1024 strbuf_add(buf, "HEAD", 4);
1028 static int reinterpret(const char *name, int namelen, int len, struct strbuf *buf)
1030 /* we have extra data, which might need further processing */
1031 struct strbuf tmp = STRBUF_INIT;
1032 int used = buf->len;
1035 strbuf_add(buf, name + len, namelen - len);
1036 ret = interpret_branch_name(buf->buf, buf->len, &tmp);
1037 /* that data was not interpreted, remove our cruft */
1039 strbuf_setlen(buf, used);
1043 strbuf_addbuf(buf, &tmp);
1044 strbuf_release(&tmp);
1045 /* tweak for size of {-N} versus expanded ref name */
1046 return ret - used + len;
1050 * This reads short-hand syntax that not only evaluates to a commit
1051 * object name, but also can act as if the end user spelled the name
1052 * of the branch from the command line.
1054 * - "@{-N}" finds the name of the Nth previous branch we were on, and
1055 * places the name of the branch in the given buf and returns the
1056 * number of characters parsed if successful.
1058 * - "<branch>@{upstream}" finds the name of the other ref that
1059 * <branch> is configured to merge with (missing <branch> defaults
1060 * to the current branch), and places the name of the branch in the
1061 * given buf and returns the number of characters parsed if
1064 * If the input is not of the accepted format, it returns a negative
1065 * number to signal an error.
1067 * If the input was ok but there are not N branch switches in the
1068 * reflog, it returns 0.
1070 int interpret_branch_name(const char *name, int namelen, struct strbuf *buf)
1073 struct branch *upstream;
1074 int len = interpret_nth_prior_checkout(name, buf);
1078 namelen = strlen(name);
1081 return len; /* syntax Ok, not enough switches */
1082 } else if (len > 0) {
1084 return len; /* consumed all */
1086 return reinterpret(name, namelen, len, buf);
1089 cp = strchr(name, '@');
1093 len = interpret_empty_at(name, namelen, cp - name, buf);
1095 return reinterpret(name, namelen, len, buf);
1097 tmp_len = upstream_mark(cp, namelen - (cp - name));
1101 len = cp + tmp_len - name;
1102 cp = xstrndup(name, cp - name);
1103 upstream = branch_get(*cp ? cp : NULL);
1105 * Upstream can be NULL only if cp refers to HEAD and HEAD
1106 * points to something different than a branch.
1109 die(_("HEAD does not point to a branch"));
1110 if (!upstream->merge || !upstream->merge[0]->dst) {
1111 if (!ref_exists(upstream->refname))
1112 die(_("No such branch: '%s'"), cp);
1113 if (!upstream->merge) {
1114 die(_("No upstream configured for branch '%s'"),
1118 _("Upstream branch '%s' not stored as a remote-tracking branch"),
1119 upstream->merge[0]->src);
1122 cp = shorten_unambiguous_ref(upstream->merge[0]->dst, 0);
1124 strbuf_addstr(buf, cp);
1129 int strbuf_branchname(struct strbuf *sb, const char *name)
1131 int len = strlen(name);
1132 int used = interpret_branch_name(name, len, sb);
1138 strbuf_add(sb, name + used, len - used);
1142 int strbuf_check_branch_ref(struct strbuf *sb, const char *name)
1144 strbuf_branchname(sb, name);
1147 strbuf_splice(sb, 0, 0, "refs/heads/", 11);
1148 return check_refname_format(sb->buf, 0);
1152 * This is like "get_sha1_basic()", except it allows "sha1 expressions",
1153 * notably "xyz^" for "parent of xyz"
1155 int get_sha1(const char *name, unsigned char *sha1)
1157 struct object_context unused;
1158 return get_sha1_with_context(name, 0, sha1, &unused);
1162 * Many callers know that the user meant to name a commit-ish by
1163 * syntactical positions where the object name appears. Calling this
1164 * function allows the machinery to disambiguate shorter-than-unique
1165 * abbreviated object names between commit-ish and others.
1167 * Note that this does NOT error out when the named object is not a
1168 * commit-ish. It is merely to give a hint to the disambiguation
1171 int get_sha1_committish(const char *name, unsigned char *sha1)
1173 struct object_context unused;
1174 return get_sha1_with_context(name, GET_SHA1_COMMITTISH,
1178 int get_sha1_treeish(const char *name, unsigned char *sha1)
1180 struct object_context unused;
1181 return get_sha1_with_context(name, GET_SHA1_TREEISH,
1185 int get_sha1_commit(const char *name, unsigned char *sha1)
1187 struct object_context unused;
1188 return get_sha1_with_context(name, GET_SHA1_COMMIT,
1192 int get_sha1_tree(const char *name, unsigned char *sha1)
1194 struct object_context unused;
1195 return get_sha1_with_context(name, GET_SHA1_TREE,
1199 int get_sha1_blob(const char *name, unsigned char *sha1)
1201 struct object_context unused;
1202 return get_sha1_with_context(name, GET_SHA1_BLOB,
1206 /* Must be called only when object_name:filename doesn't exist. */
1207 static void diagnose_invalid_sha1_path(const char *prefix,
1208 const char *filename,
1209 const unsigned char *tree_sha1,
1210 const char *object_name,
1211 int object_name_len)
1214 unsigned char sha1[20];
1220 if (!lstat(filename, &st))
1221 die("Path '%s' exists on disk, but not in '%.*s'.",
1222 filename, object_name_len, object_name);
1223 if (errno == ENOENT || errno == ENOTDIR) {
1224 char *fullname = xmalloc(strlen(filename)
1225 + strlen(prefix) + 1);
1226 strcpy(fullname, prefix);
1227 strcat(fullname, filename);
1229 if (!get_tree_entry(tree_sha1, fullname,
1231 die("Path '%s' exists, but not '%s'.\n"
1232 "Did you mean '%.*s:%s' aka '%.*s:./%s'?",
1235 object_name_len, object_name,
1237 object_name_len, object_name,
1240 die("Path '%s' does not exist in '%.*s'",
1241 filename, object_name_len, object_name);
1245 /* Must be called only when :stage:filename doesn't exist. */
1246 static void diagnose_invalid_index_path(int stage,
1248 const char *filename)
1251 const struct cache_entry *ce;
1253 unsigned namelen = strlen(filename);
1254 unsigned fullnamelen;
1260 /* Wrong stage number? */
1261 pos = cache_name_pos(filename, namelen);
1264 if (pos < active_nr) {
1265 ce = active_cache[pos];
1266 if (ce_namelen(ce) == namelen &&
1267 !memcmp(ce->name, filename, namelen))
1268 die("Path '%s' is in the index, but not at stage %d.\n"
1269 "Did you mean ':%d:%s'?",
1271 ce_stage(ce), filename);
1274 /* Confusion between relative and absolute filenames? */
1275 fullnamelen = namelen + strlen(prefix);
1276 fullname = xmalloc(fullnamelen + 1);
1277 strcpy(fullname, prefix);
1278 strcat(fullname, filename);
1279 pos = cache_name_pos(fullname, fullnamelen);
1282 if (pos < active_nr) {
1283 ce = active_cache[pos];
1284 if (ce_namelen(ce) == fullnamelen &&
1285 !memcmp(ce->name, fullname, fullnamelen))
1286 die("Path '%s' is in the index, but not '%s'.\n"
1287 "Did you mean ':%d:%s' aka ':%d:./%s'?",
1289 ce_stage(ce), fullname,
1290 ce_stage(ce), filename);
1293 if (!lstat(filename, &st))
1294 die("Path '%s' exists on disk, but not in the index.", filename);
1295 if (errno == ENOENT || errno == ENOTDIR)
1296 die("Path '%s' does not exist (neither on disk nor in the index).",
1303 static char *resolve_relative_path(const char *rel)
1305 if (!starts_with(rel, "./") && !starts_with(rel, "../"))
1309 die("BUG: startup_info struct is not initialized.");
1311 if (!is_inside_work_tree())
1312 die("relative path syntax can't be used outside working tree.");
1314 /* die() inside prefix_path() if resolved path is outside worktree */
1315 return prefix_path(startup_info->prefix,
1316 startup_info->prefix ? strlen(startup_info->prefix) : 0,
1320 static int get_sha1_with_context_1(const char *name,
1323 unsigned char *sha1,
1324 struct object_context *oc)
1326 int ret, bracket_depth;
1327 int namelen = strlen(name);
1329 int only_to_die = flags & GET_SHA1_ONLY_TO_DIE;
1331 memset(oc, 0, sizeof(*oc));
1332 oc->mode = S_IFINVALID;
1333 ret = get_sha1_1(name, namelen, sha1, flags);
1337 * sha1:path --> object name of path in ent sha1
1338 * :path -> object name of absolute path in index
1339 * :./path -> object name of path relative to cwd in index
1340 * :[0-3]:path -> object name of path in index at stage
1341 * :/foo -> recent commit matching foo
1343 if (name[0] == ':') {
1345 const struct cache_entry *ce;
1346 char *new_path = NULL;
1348 if (!only_to_die && namelen > 2 && name[1] == '/') {
1349 struct commit_list *list = NULL;
1350 for_each_ref(handle_one_ref, &list);
1351 return get_sha1_oneline(name + 2, sha1, list);
1355 name[1] < '0' || '3' < name[1])
1358 stage = name[1] - '0';
1361 new_path = resolve_relative_path(cp);
1363 namelen = namelen - (cp - name);
1366 namelen = strlen(cp);
1369 strncpy(oc->path, cp,
1371 oc->path[sizeof(oc->path)-1] = '\0';
1375 pos = cache_name_pos(cp, namelen);
1378 while (pos < active_nr) {
1379 ce = active_cache[pos];
1380 if (ce_namelen(ce) != namelen ||
1381 memcmp(ce->name, cp, namelen))
1383 if (ce_stage(ce) == stage) {
1384 hashcpy(sha1, ce->sha1);
1385 oc->mode = ce->ce_mode;
1391 if (only_to_die && name[1] && name[1] != '/')
1392 diagnose_invalid_index_path(stage, prefix, cp);
1396 for (cp = name, bracket_depth = 0; *cp; cp++) {
1399 else if (bracket_depth && *cp == '}')
1401 else if (!bracket_depth && *cp == ':')
1405 unsigned char tree_sha1[20];
1406 int len = cp - name;
1407 if (!get_sha1_1(name, len, tree_sha1, GET_SHA1_TREEISH)) {
1408 const char *filename = cp+1;
1409 char *new_filename = NULL;
1411 new_filename = resolve_relative_path(filename);
1413 filename = new_filename;
1414 ret = get_tree_entry(tree_sha1, filename, sha1, &oc->mode);
1415 if (ret && only_to_die) {
1416 diagnose_invalid_sha1_path(prefix, filename,
1420 hashcpy(oc->tree, tree_sha1);
1421 strncpy(oc->path, filename,
1423 oc->path[sizeof(oc->path)-1] = '\0';
1429 die("Invalid object name '%.*s'.", len, name);
1436 * Call this function when you know "name" given by the end user must
1437 * name an object but it doesn't; the function _may_ die with a better
1438 * diagnostic message than "no such object 'name'", e.g. "Path 'doc' does not
1439 * exist in 'HEAD'" when given "HEAD:doc", or it may return in which case
1440 * you have a chance to diagnose the error further.
1442 void maybe_die_on_misspelt_object_name(const char *name, const char *prefix)
1444 struct object_context oc;
1445 unsigned char sha1[20];
1446 get_sha1_with_context_1(name, GET_SHA1_ONLY_TO_DIE, prefix, sha1, &oc);
1449 int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc)
1451 return get_sha1_with_context_1(str, flags, NULL, sha1, orc);