11 #include "sha1-array.h"
14 static int get_oid_oneline(const char *, struct object_id
*, struct commit_list
*);
16 typedef int (*disambiguate_hint_fn
)(const struct object_id
*, void *);
18 struct disambiguate_state
{
19 int len
; /* length of prefix in hex chars */
20 char hex_pfx
[GIT_MAX_HEXSZ
+ 1];
21 struct object_id bin_pfx
;
23 disambiguate_hint_fn fn
;
25 struct object_id candidate
;
26 unsigned candidate_exists
:1;
27 unsigned candidate_checked
:1;
28 unsigned candidate_ok
:1;
29 unsigned disambiguate_fn_used
:1;
31 unsigned always_call_fn
:1;
34 static void update_candidates(struct disambiguate_state
*ds
, const struct object_id
*current
)
36 if (ds
->always_call_fn
) {
37 ds
->ambiguous
= ds
->fn(current
, ds
->cb_data
) ? 1 : 0;
40 if (!ds
->candidate_exists
) {
41 /* this is the first candidate */
42 oidcpy(&ds
->candidate
, current
);
43 ds
->candidate_exists
= 1;
45 } else if (!oidcmp(&ds
->candidate
, current
)) {
46 /* the same as what we already have seen */
51 /* cannot disambiguate between ds->candidate and current */
56 if (!ds
->candidate_checked
) {
57 ds
->candidate_ok
= ds
->fn(&ds
->candidate
, ds
->cb_data
);
58 ds
->disambiguate_fn_used
= 1;
59 ds
->candidate_checked
= 1;
62 if (!ds
->candidate_ok
) {
63 /* discard the candidate; we know it does not satisfy fn */
64 oidcpy(&ds
->candidate
, current
);
65 ds
->candidate_checked
= 0;
69 /* if we reach this point, we know ds->candidate satisfies fn */
70 if (ds
->fn(current
, ds
->cb_data
)) {
72 * if both current and candidate satisfy fn, we cannot
79 /* otherwise, current can be discarded and candidate is still good */
82 static int append_loose_object(const struct object_id
*oid
, const char *path
,
85 oid_array_append(data
, oid
);
89 static int match_sha(unsigned, const unsigned char *, const unsigned char *);
91 static void find_short_object_filename(struct disambiguate_state
*ds
)
93 int subdir_nr
= ds
->bin_pfx
.hash
[0];
94 struct alternate_object_database
*alt
;
95 static struct alternate_object_database
*fakeent
;
99 * Create a "fake" alternate object database that
100 * points to our own object database, to make it
101 * easier to get a temporary working space in
102 * alt->name/alt->base while iterating over the
103 * object databases including our own.
105 fakeent
= alloc_alt_odb(get_object_directory());
107 fakeent
->next
= alt_odb_list
;
109 for (alt
= fakeent
; alt
&& !ds
->ambiguous
; alt
= alt
->next
) {
112 if (!alt
->loose_objects_subdir_seen
[subdir_nr
]) {
113 struct strbuf
*buf
= alt_scratch_buf(alt
);
114 for_each_file_in_obj_subdir(subdir_nr
, buf
,
117 &alt
->loose_objects_cache
);
118 alt
->loose_objects_subdir_seen
[subdir_nr
] = 1;
121 pos
= oid_array_lookup(&alt
->loose_objects_cache
, &ds
->bin_pfx
);
124 while (!ds
->ambiguous
&& pos
< alt
->loose_objects_cache
.nr
) {
125 const struct object_id
*oid
;
126 oid
= alt
->loose_objects_cache
.oid
+ pos
;
127 if (!match_sha(ds
->len
, ds
->bin_pfx
.hash
, oid
->hash
))
129 update_candidates(ds
, oid
);
135 static int match_sha(unsigned len
, const unsigned char *a
, const unsigned char *b
)
145 if ((*a
^ *b
) & 0xf0)
150 static void unique_in_pack(struct packed_git
*p
,
151 struct disambiguate_state
*ds
)
153 uint32_t num
, last
, i
, first
= 0;
154 const struct object_id
*current
= NULL
;
156 if (open_pack_index(p
) || !p
->num_objects
)
159 num
= p
->num_objects
;
161 while (first
< last
) {
162 uint32_t mid
= first
+ (last
- first
) / 2;
163 const unsigned char *current
;
166 current
= nth_packed_object_sha1(p
, mid
);
167 cmp
= hashcmp(ds
->bin_pfx
.hash
, current
);
180 * At this point, "first" is the location of the lowest object
181 * with an object name that could match "bin_pfx". See if we have
182 * 0, 1 or more objects that actually match(es).
184 for (i
= first
; i
< num
&& !ds
->ambiguous
; i
++) {
185 struct object_id oid
;
186 current
= nth_packed_object_oid(&oid
, p
, i
);
187 if (!match_sha(ds
->len
, ds
->bin_pfx
.hash
, current
->hash
))
189 update_candidates(ds
, current
);
193 static void find_short_packed_object(struct disambiguate_state
*ds
)
195 struct packed_git
*p
;
197 prepare_packed_git();
198 for (p
= packed_git
; p
&& !ds
->ambiguous
; p
= p
->next
)
199 unique_in_pack(p
, ds
);
202 #define SHORT_NAME_NOT_FOUND (-1)
203 #define SHORT_NAME_AMBIGUOUS (-2)
205 static int finish_object_disambiguation(struct disambiguate_state
*ds
,
206 struct object_id
*oid
)
209 return SHORT_NAME_AMBIGUOUS
;
211 if (!ds
->candidate_exists
)
212 return SHORT_NAME_NOT_FOUND
;
214 if (!ds
->candidate_checked
)
216 * If this is the only candidate, there is no point
217 * calling the disambiguation hint callback.
219 * On the other hand, if the current candidate
220 * replaced an earlier candidate that did _not_ pass
221 * the disambiguation hint callback, then we do have
222 * more than one objects that match the short name
223 * given, so we should make sure this one matches;
224 * otherwise, if we discovered this one and the one
225 * that we previously discarded in the reverse order,
226 * we would end up showing different results in the
229 ds
->candidate_ok
= (!ds
->disambiguate_fn_used
||
230 ds
->fn(&ds
->candidate
, ds
->cb_data
));
232 if (!ds
->candidate_ok
)
233 return SHORT_NAME_AMBIGUOUS
;
235 oidcpy(oid
, &ds
->candidate
);
239 static int disambiguate_commit_only(const struct object_id
*oid
, void *cb_data_unused
)
241 int kind
= oid_object_info(oid
, NULL
);
242 return kind
== OBJ_COMMIT
;
245 static int disambiguate_committish_only(const struct object_id
*oid
, void *cb_data_unused
)
250 kind
= oid_object_info(oid
, NULL
);
251 if (kind
== OBJ_COMMIT
)
256 /* We need to do this the hard way... */
257 obj
= deref_tag(parse_object(oid
), NULL
, 0);
258 if (obj
&& obj
->type
== OBJ_COMMIT
)
263 static int disambiguate_tree_only(const struct object_id
*oid
, void *cb_data_unused
)
265 int kind
= oid_object_info(oid
, NULL
);
266 return kind
== OBJ_TREE
;
269 static int disambiguate_treeish_only(const struct object_id
*oid
, void *cb_data_unused
)
274 kind
= oid_object_info(oid
, NULL
);
275 if (kind
== OBJ_TREE
|| kind
== OBJ_COMMIT
)
280 /* We need to do this the hard way... */
281 obj
= deref_tag(parse_object(oid
), NULL
, 0);
282 if (obj
&& (obj
->type
== OBJ_TREE
|| obj
->type
== OBJ_COMMIT
))
287 static int disambiguate_blob_only(const struct object_id
*oid
, void *cb_data_unused
)
289 int kind
= oid_object_info(oid
, NULL
);
290 return kind
== OBJ_BLOB
;
293 static disambiguate_hint_fn default_disambiguate_hint
;
295 int set_disambiguate_hint_config(const char *var
, const char *value
)
297 static const struct {
299 disambiguate_hint_fn fn
;
302 { "commit", disambiguate_commit_only
},
303 { "committish", disambiguate_committish_only
},
304 { "tree", disambiguate_tree_only
},
305 { "treeish", disambiguate_treeish_only
},
306 { "blob", disambiguate_blob_only
}
311 return config_error_nonbool(var
);
313 for (i
= 0; i
< ARRAY_SIZE(hints
); i
++) {
314 if (!strcasecmp(value
, hints
[i
].name
)) {
315 default_disambiguate_hint
= hints
[i
].fn
;
320 return error("unknown hint type for '%s': %s", var
, value
);
323 static int init_object_disambiguation(const char *name
, int len
,
324 struct disambiguate_state
*ds
)
328 if (len
< MINIMUM_ABBREV
|| len
> GIT_SHA1_HEXSZ
)
331 memset(ds
, 0, sizeof(*ds
));
333 for (i
= 0; i
< len
;i
++) {
334 unsigned char c
= name
[i
];
336 if (c
>= '0' && c
<= '9')
338 else if (c
>= 'a' && c
<= 'f')
340 else if (c
>= 'A' && c
<='F') {
349 ds
->bin_pfx
.hash
[i
>> 1] |= val
;
353 ds
->hex_pfx
[len
] = '\0';
358 static int show_ambiguous_object(const struct object_id
*oid
, void *data
)
360 const struct disambiguate_state
*ds
= data
;
361 struct strbuf desc
= STRBUF_INIT
;
365 if (ds
->fn
&& !ds
->fn(oid
, ds
->cb_data
))
368 type
= oid_object_info(oid
, NULL
);
369 if (type
== OBJ_COMMIT
) {
370 struct commit
*commit
= lookup_commit(oid
);
372 struct pretty_print_context pp
= {0};
373 pp
.date_mode
.type
= DATE_SHORT
;
374 format_commit_message(commit
, " %ad - %s", &desc
, &pp
);
376 } else if (type
== OBJ_TAG
) {
377 struct tag
*tag
= lookup_tag(oid
);
378 if (!parse_tag(tag
) && tag
->tag
)
379 strbuf_addf(&desc
, " %s", tag
->tag
);
383 find_unique_abbrev(oid
, DEFAULT_ABBREV
),
384 type_name(type
) ? type_name(type
) : "unknown type",
387 strbuf_release(&desc
);
391 static int get_short_oid(const char *name
, int len
, struct object_id
*oid
,
395 struct disambiguate_state ds
;
396 int quietly
= !!(flags
& GET_OID_QUIETLY
);
398 if (init_object_disambiguation(name
, len
, &ds
) < 0)
401 if (HAS_MULTI_BITS(flags
& GET_OID_DISAMBIGUATORS
))
402 die("BUG: multiple get_short_oid disambiguator flags");
404 if (flags
& GET_OID_COMMIT
)
405 ds
.fn
= disambiguate_commit_only
;
406 else if (flags
& GET_OID_COMMITTISH
)
407 ds
.fn
= disambiguate_committish_only
;
408 else if (flags
& GET_OID_TREE
)
409 ds
.fn
= disambiguate_tree_only
;
410 else if (flags
& GET_OID_TREEISH
)
411 ds
.fn
= disambiguate_treeish_only
;
412 else if (flags
& GET_OID_BLOB
)
413 ds
.fn
= disambiguate_blob_only
;
415 ds
.fn
= default_disambiguate_hint
;
417 find_short_object_filename(&ds
);
418 find_short_packed_object(&ds
);
419 status
= finish_object_disambiguation(&ds
, oid
);
421 if (!quietly
&& (status
== SHORT_NAME_AMBIGUOUS
)) {
422 error(_("short SHA1 %s is ambiguous"), ds
.hex_pfx
);
425 * We may still have ambiguity if we simply saw a series of
426 * candidates that did not satisfy our hint function. In
427 * that case, we still want to show them, so disable the hint
433 advise(_("The candidates are:"));
434 for_each_abbrev(ds
.hex_pfx
, show_ambiguous_object
, &ds
);
440 static int collect_ambiguous(const struct object_id
*oid
, void *data
)
442 oid_array_append(data
, oid
);
446 int for_each_abbrev(const char *prefix
, each_abbrev_fn fn
, void *cb_data
)
448 struct oid_array collect
= OID_ARRAY_INIT
;
449 struct disambiguate_state ds
;
452 if (init_object_disambiguation(prefix
, strlen(prefix
), &ds
) < 0)
455 ds
.always_call_fn
= 1;
456 ds
.fn
= collect_ambiguous
;
457 ds
.cb_data
= &collect
;
458 find_short_object_filename(&ds
);
459 find_short_packed_object(&ds
);
461 ret
= oid_array_for_each_unique(&collect
, fn
, cb_data
);
462 oid_array_clear(&collect
);
467 * Return the slot of the most-significant bit set in "val". There are various
468 * ways to do this quickly with fls() or __builtin_clzl(), but speed is
469 * probably not a big deal here.
471 static unsigned msb(unsigned long val
)
479 struct min_abbrev_data
{
480 unsigned int init_len
;
481 unsigned int cur_len
;
483 const struct object_id
*oid
;
486 static inline char get_hex_char_from_oid(const struct object_id
*oid
,
489 static const char hex
[] = "0123456789abcdef";
492 return hex
[oid
->hash
[pos
>> 1] >> 4];
494 return hex
[oid
->hash
[pos
>> 1] & 0xf];
497 static int extend_abbrev_len(const struct object_id
*oid
, void *cb_data
)
499 struct min_abbrev_data
*mad
= cb_data
;
501 unsigned int i
= mad
->init_len
;
502 while (mad
->hex
[i
] && mad
->hex
[i
] == get_hex_char_from_oid(oid
, i
))
505 if (i
< GIT_MAX_RAWSZ
&& i
>= mad
->cur_len
)
506 mad
->cur_len
= i
+ 1;
511 static void find_abbrev_len_for_pack(struct packed_git
*p
,
512 struct min_abbrev_data
*mad
)
515 uint32_t num
, first
= 0;
516 struct object_id oid
;
517 const struct object_id
*mad_oid
;
519 if (open_pack_index(p
) || !p
->num_objects
)
522 num
= p
->num_objects
;
524 match
= bsearch_pack(mad_oid
, p
, &first
);
527 * first is now the position in the packfile where we would insert
528 * mad->hash if it does not exist (or the position of mad->hash if
529 * it does exist). Hence, we consider a maximum of two objects
530 * nearby for the abbreviation length.
534 if (nth_packed_object_oid(&oid
, p
, first
))
535 extend_abbrev_len(&oid
, mad
);
536 } else if (first
< num
- 1) {
537 if (nth_packed_object_oid(&oid
, p
, first
+ 1))
538 extend_abbrev_len(&oid
, mad
);
541 if (nth_packed_object_oid(&oid
, p
, first
- 1))
542 extend_abbrev_len(&oid
, mad
);
544 mad
->init_len
= mad
->cur_len
;
547 static void find_abbrev_len_packed(struct min_abbrev_data
*mad
)
549 struct packed_git
*p
;
551 prepare_packed_git();
552 for (p
= packed_git
; p
; p
= p
->next
)
553 find_abbrev_len_for_pack(p
, mad
);
556 int find_unique_abbrev_r(char *hex
, const struct object_id
*oid
, int len
)
558 struct disambiguate_state ds
;
559 struct min_abbrev_data mad
;
560 struct object_id oid_ret
;
562 unsigned long count
= approximate_object_count();
564 * Add one because the MSB only tells us the highest bit set,
565 * not including the value of all the _other_ bits (so "15"
566 * is only one off of 2^4, but the MSB is the 3rd bit.
568 len
= msb(count
) + 1;
570 * We now know we have on the order of 2^len objects, which
571 * expects a collision at 2^(len/2). But we also care about hex
572 * chars, not bits, and there are 4 bits per hex. So all
573 * together we need to divide by 2 and round up.
575 len
= DIV_ROUND_UP(len
, 2);
577 * For very small repos, we stick with our regular fallback.
579 if (len
< FALLBACK_DEFAULT_ABBREV
)
580 len
= FALLBACK_DEFAULT_ABBREV
;
583 oid_to_hex_r(hex
, oid
);
584 if (len
== GIT_SHA1_HEXSZ
|| !len
)
585 return GIT_SHA1_HEXSZ
;
592 find_abbrev_len_packed(&mad
);
594 if (init_object_disambiguation(hex
, mad
.cur_len
, &ds
) < 0)
597 ds
.fn
= extend_abbrev_len
;
598 ds
.always_call_fn
= 1;
599 ds
.cb_data
= (void *)&mad
;
601 find_short_object_filename(&ds
);
602 (void)finish_object_disambiguation(&ds
, &oid_ret
);
604 hex
[mad
.cur_len
] = 0;
608 const char *find_unique_abbrev(const struct object_id
*oid
, int len
)
611 static char hexbuffer
[4][GIT_MAX_HEXSZ
+ 1];
612 char *hex
= hexbuffer
[bufno
];
613 bufno
= (bufno
+ 1) % ARRAY_SIZE(hexbuffer
);
614 find_unique_abbrev_r(hex
, oid
, len
);
618 static int ambiguous_path(const char *path
, int len
)
623 for (cnt
= 0; cnt
< len
; cnt
++) {
643 static inline int at_mark(const char *string
, int len
,
644 const char **suffix
, int nr
)
648 for (i
= 0; i
< nr
; i
++) {
649 int suffix_len
= strlen(suffix
[i
]);
650 if (suffix_len
<= len
651 && !strncasecmp(string
, suffix
[i
], suffix_len
))
657 static inline int upstream_mark(const char *string
, int len
)
659 const char *suffix
[] = { "@{upstream}", "@{u}" };
660 return at_mark(string
, len
, suffix
, ARRAY_SIZE(suffix
));
663 static inline int push_mark(const char *string
, int len
)
665 const char *suffix
[] = { "@{push}" };
666 return at_mark(string
, len
, suffix
, ARRAY_SIZE(suffix
));
669 static int get_oid_1(const char *name
, int len
, struct object_id
*oid
, unsigned lookup_flags
);
670 static int interpret_nth_prior_checkout(const char *name
, int namelen
, struct strbuf
*buf
);
672 static int get_oid_basic(const char *str
, int len
, struct object_id
*oid
,
675 static const char *warn_msg
= "refname '%.*s' is ambiguous.";
676 static const char *object_name_msg
= N_(
677 "Git normally never creates a ref that ends with 40 hex characters\n"
678 "because it will be ignored when you just specify 40-hex. These refs\n"
679 "may be created by mistake. For example,\n"
681 " git checkout -b $br $(git rev-parse ...)\n"
683 "where \"$br\" is somehow empty and a 40-hex ref is created. Please\n"
684 "examine these refs and maybe delete them. Turn this message off by\n"
685 "running \"git config advice.objectNameWarning false\"");
686 struct object_id tmp_oid
;
687 char *real_ref
= NULL
;
689 int at
, reflog_len
, nth_prior
= 0;
691 if (len
== GIT_SHA1_HEXSZ
&& !get_oid_hex(str
, oid
)) {
692 if (warn_ambiguous_refs
&& warn_on_object_refname_ambiguity
) {
693 refs_found
= dwim_ref(str
, len
, &tmp_oid
, &real_ref
);
694 if (refs_found
> 0) {
695 warning(warn_msg
, len
, str
);
696 if (advice_object_name_warning
)
697 fprintf(stderr
, "%s\n", _(object_name_msg
));
704 /* basic@{time or number or -number} format to query ref-log */
706 if (len
&& str
[len
-1] == '}') {
707 for (at
= len
-4; at
>= 0; at
--) {
708 if (str
[at
] == '@' && str
[at
+1] == '{') {
709 if (str
[at
+2] == '-') {
711 /* @{-N} not at start */
716 if (!upstream_mark(str
+ at
, len
- at
) &&
717 !push_mark(str
+ at
, len
- at
)) {
718 reflog_len
= (len
-1) - (at
+2);
726 /* Accept only unambiguous ref paths. */
727 if (len
&& ambiguous_path(str
, len
))
731 struct strbuf buf
= STRBUF_INIT
;
734 if (interpret_nth_prior_checkout(str
, len
, &buf
) > 0) {
735 detached
= (buf
.len
== GIT_SHA1_HEXSZ
&& !get_oid_hex(buf
.buf
, oid
));
736 strbuf_release(&buf
);
742 if (!len
&& reflog_len
)
743 /* allow "@{...}" to mean the current branch reflog */
744 refs_found
= dwim_ref("HEAD", 4, oid
, &real_ref
);
746 refs_found
= dwim_log(str
, len
, oid
, &real_ref
);
748 refs_found
= dwim_ref(str
, len
, oid
, &real_ref
);
753 if (warn_ambiguous_refs
&& !(flags
& GET_OID_QUIETLY
) &&
755 !get_short_oid(str
, len
, &tmp_oid
, GET_OID_QUIETLY
)))
756 warning(warn_msg
, len
, str
);
764 /* Is it asking for N-th entry, or approxidate? */
765 for (i
= nth
= 0; 0 <= nth
&& i
< reflog_len
; i
++) {
766 char ch
= str
[at
+2+i
];
767 if ('0' <= ch
&& ch
<= '9')
768 nth
= nth
* 10 + ch
- '0';
772 if (100000000 <= nth
) {
779 char *tmp
= xstrndup(str
+ at
+ 2, reflog_len
);
780 at_time
= approxidate_careful(tmp
, &errors
);
787 if (read_ref_at(real_ref
, flags
, at_time
, nth
, oid
, NULL
,
788 &co_time
, &co_tz
, &co_cnt
)) {
790 if (starts_with(real_ref
, "refs/heads/")) {
792 len
= strlen(real_ref
+ 11);
800 if (!(flags
& GET_OID_QUIETLY
)) {
801 warning("Log for '%.*s' only goes "
802 "back to %s.", len
, str
,
803 show_date(co_time
, co_tz
, DATE_MODE(RFC2822
)));
806 if (flags
& GET_OID_QUIETLY
) {
809 die("Log for '%.*s' only has %d entries.",
819 static int get_parent(const char *name
, int len
,
820 struct object_id
*result
, int idx
)
822 struct object_id oid
;
823 int ret
= get_oid_1(name
, len
, &oid
, GET_OID_COMMITTISH
);
824 struct commit
*commit
;
825 struct commit_list
*p
;
829 commit
= lookup_commit_reference(&oid
);
830 if (parse_commit(commit
))
833 oidcpy(result
, &commit
->object
.oid
);
839 oidcpy(result
, &p
->item
->object
.oid
);
847 static int get_nth_ancestor(const char *name
, int len
,
848 struct object_id
*result
, int generation
)
850 struct object_id oid
;
851 struct commit
*commit
;
854 ret
= get_oid_1(name
, len
, &oid
, GET_OID_COMMITTISH
);
857 commit
= lookup_commit_reference(&oid
);
861 while (generation
--) {
862 if (parse_commit(commit
) || !commit
->parents
)
864 commit
= commit
->parents
->item
;
866 oidcpy(result
, &commit
->object
.oid
);
870 struct object
*peel_to_type(const char *name
, int namelen
,
871 struct object
*o
, enum object_type expected_type
)
873 if (name
&& !namelen
)
874 namelen
= strlen(name
);
876 if (!o
|| (!o
->parsed
&& !parse_object(&o
->oid
)))
878 if (expected_type
== OBJ_ANY
|| o
->type
== expected_type
)
880 if (o
->type
== OBJ_TAG
)
881 o
= ((struct tag
*) o
)->tagged
;
882 else if (o
->type
== OBJ_COMMIT
)
883 o
= &(((struct commit
*) o
)->tree
->object
);
886 error("%.*s: expected %s type, but the object "
887 "dereferences to %s type",
888 namelen
, name
, type_name(expected_type
),
895 static int peel_onion(const char *name
, int len
, struct object_id
*oid
,
896 unsigned lookup_flags
)
898 struct object_id outer
;
900 unsigned int expected_type
= 0;
904 * "ref^{type}" dereferences ref repeatedly until you cannot
905 * dereference anymore, or you get an object of given type,
906 * whichever comes first. "ref^{}" means just dereference
907 * tags until you get a non-tag. "ref^0" is a shorthand for
908 * "ref^{commit}". "commit^{tree}" could be used to find the
909 * top-level tree of the given commit.
911 if (len
< 4 || name
[len
-1] != '}')
914 for (sp
= name
+ len
- 1; name
<= sp
; sp
--) {
916 if (ch
== '{' && name
< sp
&& sp
[-1] == '^')
922 sp
++; /* beginning of type name, or closing brace for empty */
923 if (starts_with(sp
, "commit}"))
924 expected_type
= OBJ_COMMIT
;
925 else if (starts_with(sp
, "tag}"))
926 expected_type
= OBJ_TAG
;
927 else if (starts_with(sp
, "tree}"))
928 expected_type
= OBJ_TREE
;
929 else if (starts_with(sp
, "blob}"))
930 expected_type
= OBJ_BLOB
;
931 else if (starts_with(sp
, "object}"))
932 expected_type
= OBJ_ANY
;
933 else if (sp
[0] == '}')
934 expected_type
= OBJ_NONE
;
935 else if (sp
[0] == '/')
936 expected_type
= OBJ_COMMIT
;
940 lookup_flags
&= ~GET_OID_DISAMBIGUATORS
;
941 if (expected_type
== OBJ_COMMIT
)
942 lookup_flags
|= GET_OID_COMMITTISH
;
943 else if (expected_type
== OBJ_TREE
)
944 lookup_flags
|= GET_OID_TREEISH
;
946 if (get_oid_1(name
, sp
- name
- 2, &outer
, lookup_flags
))
949 o
= parse_object(&outer
);
952 if (!expected_type
) {
953 o
= deref_tag(o
, name
, sp
- name
- 2);
954 if (!o
|| (!o
->parsed
&& !parse_object(&o
->oid
)))
956 oidcpy(oid
, &o
->oid
);
961 * At this point, the syntax look correct, so
962 * if we do not get the needed object, we should
965 o
= peel_to_type(name
, len
, o
, expected_type
);
969 oidcpy(oid
, &o
->oid
);
971 /* "$commit^{/foo}" */
974 struct commit_list
*list
= NULL
;
977 * $commit^{/}. Some regex implementation may reject.
978 * We don't need regex anyway. '' pattern always matches.
983 prefix
= xstrndup(sp
+ 1, name
+ len
- 1 - (sp
+ 1));
984 commit_list_insert((struct commit
*)o
, &list
);
985 ret
= get_oid_oneline(prefix
, oid
, list
);
992 static int get_describe_name(const char *name
, int len
, struct object_id
*oid
)
995 unsigned flags
= GET_OID_QUIETLY
| GET_OID_COMMIT
;
997 for (cp
= name
+ len
- 1; name
+ 2 <= cp
; cp
--) {
1000 /* We must be looking at g in "SOMETHING-g"
1001 * for it to be describe output.
1003 if (ch
== 'g' && cp
[-1] == '-') {
1006 return get_short_oid(cp
, len
, oid
, flags
);
1013 static int get_oid_1(const char *name
, int len
, struct object_id
*oid
, unsigned lookup_flags
)
1015 int ret
, has_suffix
;
1019 * "name~3" is "name^^^", "name~" is "name~1", and "name^" is "name^1".
1022 for (cp
= name
+ len
- 1; name
<= cp
; cp
--) {
1024 if ('0' <= ch
&& ch
<= '9')
1026 if (ch
== '~' || ch
== '^')
1033 int len1
= cp
- name
;
1035 while (cp
< name
+ len
)
1036 num
= num
* 10 + *cp
++ - '0';
1037 if (!num
&& len1
== len
- 1)
1039 if (has_suffix
== '^')
1040 return get_parent(name
, len1
, oid
, num
);
1041 /* else if (has_suffix == '~') -- goes without saying */
1042 return get_nth_ancestor(name
, len1
, oid
, num
);
1045 ret
= peel_onion(name
, len
, oid
, lookup_flags
);
1049 ret
= get_oid_basic(name
, len
, oid
, lookup_flags
);
1053 /* It could be describe output that is "SOMETHING-gXXXX" */
1054 ret
= get_describe_name(name
, len
, oid
);
1058 return get_short_oid(name
, len
, oid
, lookup_flags
);
1062 * This interprets names like ':/Initial revision of "git"' by searching
1063 * through history and returning the first commit whose message starts
1064 * the given regular expression.
1066 * For negative-matching, prefix the pattern-part with '!-', like: ':/!-WIP'.
1068 * For a literal '!' character at the beginning of a pattern, you have to repeat
1069 * that, like: ':/!!foo'
1071 * For future extension, all other sequences beginning with ':/!' are reserved.
1074 /* Remember to update object flag allocation in object.h */
1075 #define ONELINE_SEEN (1u<<20)
1077 static int handle_one_ref(const char *path
, const struct object_id
*oid
,
1078 int flag
, void *cb_data
)
1080 struct commit_list
**list
= cb_data
;
1081 struct object
*object
= parse_object(oid
);
1084 if (object
->type
== OBJ_TAG
) {
1085 object
= deref_tag(object
, path
, strlen(path
));
1089 if (object
->type
!= OBJ_COMMIT
)
1091 commit_list_insert((struct commit
*)object
, list
);
1095 static int get_oid_oneline(const char *prefix
, struct object_id
*oid
,
1096 struct commit_list
*list
)
1098 struct commit_list
*backup
= NULL
, *l
;
1103 if (prefix
[0] == '!') {
1106 if (prefix
[0] == '-') {
1109 } else if (prefix
[0] != '!') {
1114 if (regcomp(®ex
, prefix
, REG_EXTENDED
))
1117 for (l
= list
; l
; l
= l
->next
) {
1118 l
->item
->object
.flags
|= ONELINE_SEEN
;
1119 commit_list_insert(l
->item
, &backup
);
1122 const char *p
, *buf
;
1123 struct commit
*commit
;
1126 commit
= pop_most_recent_commit(&list
, ONELINE_SEEN
);
1127 if (!parse_object(&commit
->object
.oid
))
1129 buf
= get_commit_buffer(commit
, NULL
);
1130 p
= strstr(buf
, "\n\n");
1131 matches
= negative
^ (p
&& !regexec(®ex
, p
+ 2, 0, NULL
, 0));
1132 unuse_commit_buffer(commit
, buf
);
1135 oidcpy(oid
, &commit
->object
.oid
);
1141 free_commit_list(list
);
1142 for (l
= backup
; l
; l
= l
->next
)
1143 clear_commit_marks(l
->item
, ONELINE_SEEN
);
1144 free_commit_list(backup
);
1145 return found
? 0 : -1;
1148 struct grab_nth_branch_switch_cbdata
{
1153 static int grab_nth_branch_switch(struct object_id
*ooid
, struct object_id
*noid
,
1154 const char *email
, timestamp_t timestamp
, int tz
,
1155 const char *message
, void *cb_data
)
1157 struct grab_nth_branch_switch_cbdata
*cb
= cb_data
;
1158 const char *match
= NULL
, *target
= NULL
;
1161 if (skip_prefix(message
, "checkout: moving from ", &match
))
1162 target
= strstr(match
, " to ");
1164 if (!match
|| !target
)
1166 if (--(cb
->remaining
) == 0) {
1167 len
= target
- match
;
1168 strbuf_reset(&cb
->buf
);
1169 strbuf_add(&cb
->buf
, match
, len
);
1170 return 1; /* we are done */
1176 * Parse @{-N} syntax, return the number of characters parsed
1177 * if successful; otherwise signal an error with negative value.
1179 static int interpret_nth_prior_checkout(const char *name
, int namelen
,
1184 struct grab_nth_branch_switch_cbdata cb
;
1190 if (name
[0] != '@' || name
[1] != '{' || name
[2] != '-')
1192 brace
= memchr(name
, '}', namelen
);
1195 nth
= strtol(name
+ 3, &num_end
, 10);
1196 if (num_end
!= brace
)
1201 strbuf_init(&cb
.buf
, 20);
1204 if (0 < for_each_reflog_ent_reverse("HEAD", grab_nth_branch_switch
, &cb
)) {
1206 strbuf_addbuf(buf
, &cb
.buf
);
1207 retval
= brace
- name
+ 1;
1210 strbuf_release(&cb
.buf
);
1214 int get_oid_mb(const char *name
, struct object_id
*oid
)
1216 struct commit
*one
, *two
;
1217 struct commit_list
*mbs
;
1218 struct object_id oid_tmp
;
1222 dots
= strstr(name
, "...");
1224 return get_oid(name
, oid
);
1226 st
= get_oid("HEAD", &oid_tmp
);
1229 strbuf_init(&sb
, dots
- name
);
1230 strbuf_add(&sb
, name
, dots
- name
);
1231 st
= get_oid_committish(sb
.buf
, &oid_tmp
);
1232 strbuf_release(&sb
);
1236 one
= lookup_commit_reference_gently(&oid_tmp
, 0);
1240 if (get_oid_committish(dots
[3] ? (dots
+ 3) : "HEAD", &oid_tmp
))
1242 two
= lookup_commit_reference_gently(&oid_tmp
, 0);
1245 mbs
= get_merge_bases(one
, two
);
1246 if (!mbs
|| mbs
->next
)
1250 oidcpy(oid
, &mbs
->item
->object
.oid
);
1252 free_commit_list(mbs
);
1256 /* parse @something syntax, when 'something' is not {.*} */
1257 static int interpret_empty_at(const char *name
, int namelen
, int len
, struct strbuf
*buf
)
1261 if (len
|| name
[1] == '{')
1264 /* make sure it's a single @, or @@{.*}, not @foo */
1265 next
= memchr(name
+ len
+ 1, '@', namelen
- len
- 1);
1266 if (next
&& next
[1] != '{')
1269 next
= name
+ namelen
;
1270 if (next
!= name
+ 1)
1274 strbuf_add(buf
, "HEAD", 4);
1278 static int reinterpret(const char *name
, int namelen
, int len
,
1279 struct strbuf
*buf
, unsigned allowed
)
1281 /* we have extra data, which might need further processing */
1282 struct strbuf tmp
= STRBUF_INIT
;
1283 int used
= buf
->len
;
1286 strbuf_add(buf
, name
+ len
, namelen
- len
);
1287 ret
= interpret_branch_name(buf
->buf
, buf
->len
, &tmp
, allowed
);
1288 /* that data was not interpreted, remove our cruft */
1290 strbuf_setlen(buf
, used
);
1294 strbuf_addbuf(buf
, &tmp
);
1295 strbuf_release(&tmp
);
1296 /* tweak for size of {-N} versus expanded ref name */
1297 return ret
- used
+ len
;
1300 static void set_shortened_ref(struct strbuf
*buf
, const char *ref
)
1302 char *s
= shorten_unambiguous_ref(ref
, 0);
1304 strbuf_addstr(buf
, s
);
1308 static int branch_interpret_allowed(const char *refname
, unsigned allowed
)
1313 if ((allowed
& INTERPRET_BRANCH_LOCAL
) &&
1314 starts_with(refname
, "refs/heads/"))
1316 if ((allowed
& INTERPRET_BRANCH_REMOTE
) &&
1317 starts_with(refname
, "refs/remotes/"))
1323 static int interpret_branch_mark(const char *name
, int namelen
,
1324 int at
, struct strbuf
*buf
,
1325 int (*get_mark
)(const char *, int),
1326 const char *(*get_data
)(struct branch
*,
1331 struct branch
*branch
;
1332 struct strbuf err
= STRBUF_INIT
;
1335 len
= get_mark(name
+ at
, namelen
- at
);
1339 if (memchr(name
, ':', at
))
1343 char *name_str
= xmemdupz(name
, at
);
1344 branch
= branch_get(name_str
);
1347 branch
= branch_get(NULL
);
1349 value
= get_data(branch
, &err
);
1353 if (!branch_interpret_allowed(value
, allowed
))
1356 set_shortened_ref(buf
, value
);
1360 int interpret_branch_name(const char *name
, int namelen
, struct strbuf
*buf
,
1368 namelen
= strlen(name
);
1370 if (!allowed
|| (allowed
& INTERPRET_BRANCH_LOCAL
)) {
1371 len
= interpret_nth_prior_checkout(name
, namelen
, buf
);
1373 return len
; /* syntax Ok, not enough switches */
1374 } else if (len
> 0) {
1376 return len
; /* consumed all */
1378 return reinterpret(name
, namelen
, len
, buf
, allowed
);
1383 (at
= memchr(start
, '@', namelen
- (start
- name
)));
1386 if (!allowed
|| (allowed
& INTERPRET_BRANCH_HEAD
)) {
1387 len
= interpret_empty_at(name
, namelen
, at
- name
, buf
);
1389 return reinterpret(name
, namelen
, len
, buf
,
1393 len
= interpret_branch_mark(name
, namelen
, at
- name
, buf
,
1394 upstream_mark
, branch_get_upstream
,
1399 len
= interpret_branch_mark(name
, namelen
, at
- name
, buf
,
1400 push_mark
, branch_get_push
,
1409 void strbuf_branchname(struct strbuf
*sb
, const char *name
, unsigned allowed
)
1411 int len
= strlen(name
);
1412 int used
= interpret_branch_name(name
, len
, sb
, allowed
);
1416 strbuf_add(sb
, name
+ used
, len
- used
);
1419 int strbuf_check_branch_ref(struct strbuf
*sb
, const char *name
)
1421 if (startup_info
->have_repository
)
1422 strbuf_branchname(sb
, name
, INTERPRET_BRANCH_LOCAL
);
1424 strbuf_addstr(sb
, name
);
1427 * This splice must be done even if we end up rejecting the
1428 * name; builtin/branch.c::copy_or_rename_branch() still wants
1429 * to see what the name expanded to so that "branch -m" can be
1430 * used as a tool to correct earlier mistakes.
1432 strbuf_splice(sb
, 0, 0, "refs/heads/", 11);
1435 !strcmp(sb
->buf
, "refs/heads/HEAD"))
1438 return check_refname_format(sb
->buf
, 0);
1442 * This is like "get_oid_basic()", except it allows "object ID expressions",
1443 * notably "xyz^" for "parent of xyz"
1445 int get_oid(const char *name
, struct object_id
*oid
)
1447 struct object_context unused
;
1448 return get_oid_with_context(name
, 0, oid
, &unused
);
1453 * Many callers know that the user meant to name a commit-ish by
1454 * syntactical positions where the object name appears. Calling this
1455 * function allows the machinery to disambiguate shorter-than-unique
1456 * abbreviated object names between commit-ish and others.
1458 * Note that this does NOT error out when the named object is not a
1459 * commit-ish. It is merely to give a hint to the disambiguation
1462 int get_oid_committish(const char *name
, struct object_id
*oid
)
1464 struct object_context unused
;
1465 return get_oid_with_context(name
, GET_OID_COMMITTISH
,
1469 int get_oid_treeish(const char *name
, struct object_id
*oid
)
1471 struct object_context unused
;
1472 return get_oid_with_context(name
, GET_OID_TREEISH
,
1476 int get_oid_commit(const char *name
, struct object_id
*oid
)
1478 struct object_context unused
;
1479 return get_oid_with_context(name
, GET_OID_COMMIT
,
1483 int get_oid_tree(const char *name
, struct object_id
*oid
)
1485 struct object_context unused
;
1486 return get_oid_with_context(name
, GET_OID_TREE
,
1490 int get_oid_blob(const char *name
, struct object_id
*oid
)
1492 struct object_context unused
;
1493 return get_oid_with_context(name
, GET_OID_BLOB
,
1497 /* Must be called only when object_name:filename doesn't exist. */
1498 static void diagnose_invalid_oid_path(const char *prefix
,
1499 const char *filename
,
1500 const struct object_id
*tree_oid
,
1501 const char *object_name
,
1502 int object_name_len
)
1504 struct object_id oid
;
1510 if (file_exists(filename
))
1511 die("Path '%s' exists on disk, but not in '%.*s'.",
1512 filename
, object_name_len
, object_name
);
1513 if (is_missing_file_error(errno
)) {
1514 char *fullname
= xstrfmt("%s%s", prefix
, filename
);
1516 if (!get_tree_entry(tree_oid
, fullname
, &oid
, &mode
)) {
1517 die("Path '%s' exists, but not '%s'.\n"
1518 "Did you mean '%.*s:%s' aka '%.*s:./%s'?",
1521 object_name_len
, object_name
,
1523 object_name_len
, object_name
,
1526 die("Path '%s' does not exist in '%.*s'",
1527 filename
, object_name_len
, object_name
);
1531 /* Must be called only when :stage:filename doesn't exist. */
1532 static void diagnose_invalid_index_path(int stage
,
1534 const char *filename
)
1536 const struct cache_entry
*ce
;
1538 unsigned namelen
= strlen(filename
);
1539 struct strbuf fullname
= STRBUF_INIT
;
1544 /* Wrong stage number? */
1545 pos
= cache_name_pos(filename
, namelen
);
1548 if (pos
< active_nr
) {
1549 ce
= active_cache
[pos
];
1550 if (ce_namelen(ce
) == namelen
&&
1551 !memcmp(ce
->name
, filename
, namelen
))
1552 die("Path '%s' is in the index, but not at stage %d.\n"
1553 "Did you mean ':%d:%s'?",
1555 ce_stage(ce
), filename
);
1558 /* Confusion between relative and absolute filenames? */
1559 strbuf_addstr(&fullname
, prefix
);
1560 strbuf_addstr(&fullname
, filename
);
1561 pos
= cache_name_pos(fullname
.buf
, fullname
.len
);
1564 if (pos
< active_nr
) {
1565 ce
= active_cache
[pos
];
1566 if (ce_namelen(ce
) == fullname
.len
&&
1567 !memcmp(ce
->name
, fullname
.buf
, fullname
.len
))
1568 die("Path '%s' is in the index, but not '%s'.\n"
1569 "Did you mean ':%d:%s' aka ':%d:./%s'?",
1570 fullname
.buf
, filename
,
1571 ce_stage(ce
), fullname
.buf
,
1572 ce_stage(ce
), filename
);
1575 if (file_exists(filename
))
1576 die("Path '%s' exists on disk, but not in the index.", filename
);
1577 if (is_missing_file_error(errno
))
1578 die("Path '%s' does not exist (neither on disk nor in the index).",
1581 strbuf_release(&fullname
);
1585 static char *resolve_relative_path(const char *rel
)
1587 if (!starts_with(rel
, "./") && !starts_with(rel
, "../"))
1590 if (!is_inside_work_tree())
1591 die("relative path syntax can't be used outside working tree.");
1593 /* die() inside prefix_path() if resolved path is outside worktree */
1594 return prefix_path(startup_info
->prefix
,
1595 startup_info
->prefix
? strlen(startup_info
->prefix
) : 0,
1599 static int get_oid_with_context_1(const char *name
,
1602 struct object_id
*oid
,
1603 struct object_context
*oc
)
1605 int ret
, bracket_depth
;
1606 int namelen
= strlen(name
);
1608 int only_to_die
= flags
& GET_OID_ONLY_TO_DIE
;
1611 flags
|= GET_OID_QUIETLY
;
1613 memset(oc
, 0, sizeof(*oc
));
1614 oc
->mode
= S_IFINVALID
;
1615 strbuf_init(&oc
->symlink_path
, 0);
1616 ret
= get_oid_1(name
, namelen
, oid
, flags
);
1620 * sha1:path --> object name of path in ent sha1
1621 * :path -> object name of absolute path in index
1622 * :./path -> object name of path relative to cwd in index
1623 * :[0-3]:path -> object name of path in index at stage
1624 * :/foo -> recent commit matching foo
1626 if (name
[0] == ':') {
1628 const struct cache_entry
*ce
;
1629 char *new_path
= NULL
;
1631 if (!only_to_die
&& namelen
> 2 && name
[1] == '/') {
1632 struct commit_list
*list
= NULL
;
1634 for_each_ref(handle_one_ref
, &list
);
1635 commit_list_sort_by_date(&list
);
1636 return get_oid_oneline(name
+ 2, oid
, list
);
1640 name
[1] < '0' || '3' < name
[1])
1643 stage
= name
[1] - '0';
1646 new_path
= resolve_relative_path(cp
);
1648 namelen
= namelen
- (cp
- name
);
1651 namelen
= strlen(cp
);
1654 if (flags
& GET_OID_RECORD_PATH
)
1655 oc
->path
= xstrdup(cp
);
1659 pos
= cache_name_pos(cp
, namelen
);
1662 while (pos
< active_nr
) {
1663 ce
= active_cache
[pos
];
1664 if (ce_namelen(ce
) != namelen
||
1665 memcmp(ce
->name
, cp
, namelen
))
1667 if (ce_stage(ce
) == stage
) {
1668 oidcpy(oid
, &ce
->oid
);
1669 oc
->mode
= ce
->ce_mode
;
1675 if (only_to_die
&& name
[1] && name
[1] != '/')
1676 diagnose_invalid_index_path(stage
, prefix
, cp
);
1680 for (cp
= name
, bracket_depth
= 0; *cp
; cp
++) {
1683 else if (bracket_depth
&& *cp
== '}')
1685 else if (!bracket_depth
&& *cp
== ':')
1689 struct object_id tree_oid
;
1690 int len
= cp
- name
;
1691 unsigned sub_flags
= flags
;
1693 sub_flags
&= ~GET_OID_DISAMBIGUATORS
;
1694 sub_flags
|= GET_OID_TREEISH
;
1696 if (!get_oid_1(name
, len
, &tree_oid
, sub_flags
)) {
1697 const char *filename
= cp
+1;
1698 char *new_filename
= NULL
;
1700 new_filename
= resolve_relative_path(filename
);
1702 filename
= new_filename
;
1703 if (flags
& GET_OID_FOLLOW_SYMLINKS
) {
1704 ret
= get_tree_entry_follow_symlinks(tree_oid
.hash
,
1705 filename
, oid
->hash
, &oc
->symlink_path
,
1708 ret
= get_tree_entry(&tree_oid
, filename
, oid
,
1710 if (ret
&& only_to_die
) {
1711 diagnose_invalid_oid_path(prefix
,
1717 hashcpy(oc
->tree
, tree_oid
.hash
);
1718 if (flags
& GET_OID_RECORD_PATH
)
1719 oc
->path
= xstrdup(filename
);
1725 die("Invalid object name '%.*s'.", len
, name
);
1732 * Call this function when you know "name" given by the end user must
1733 * name an object but it doesn't; the function _may_ die with a better
1734 * diagnostic message than "no such object 'name'", e.g. "Path 'doc' does not
1735 * exist in 'HEAD'" when given "HEAD:doc", or it may return in which case
1736 * you have a chance to diagnose the error further.
1738 void maybe_die_on_misspelt_object_name(const char *name
, const char *prefix
)
1740 struct object_context oc
;
1741 struct object_id oid
;
1742 get_oid_with_context_1(name
, GET_OID_ONLY_TO_DIE
, prefix
, &oid
, &oc
);
1745 int get_oid_with_context(const char *str
, unsigned flags
, struct object_id
*oid
, struct object_context
*oc
)
1747 if (flags
& GET_OID_FOLLOW_SYMLINKS
&& flags
& GET_OID_ONLY_TO_DIE
)
1748 die("BUG: incompatible flags for get_sha1_with_context");
1749 return get_oid_with_context_1(str
, flags
, NULL
, oid
, oc
);