11 #include "sha1-array.h"
13 #include "object-store.h"
14 #include "repository.h"
16 static int get_oid_oneline(const char *, struct object_id
*, struct commit_list
*);
18 typedef int (*disambiguate_hint_fn
)(const struct object_id
*, void *);
20 struct disambiguate_state
{
21 int len
; /* length of prefix in hex chars */
22 char hex_pfx
[GIT_MAX_HEXSZ
+ 1];
23 struct object_id bin_pfx
;
25 disambiguate_hint_fn fn
;
27 struct object_id candidate
;
28 unsigned candidate_exists
:1;
29 unsigned candidate_checked
:1;
30 unsigned candidate_ok
:1;
31 unsigned disambiguate_fn_used
:1;
33 unsigned always_call_fn
:1;
36 static void update_candidates(struct disambiguate_state
*ds
, const struct object_id
*current
)
38 if (ds
->always_call_fn
) {
39 ds
->ambiguous
= ds
->fn(current
, ds
->cb_data
) ? 1 : 0;
42 if (!ds
->candidate_exists
) {
43 /* this is the first candidate */
44 oidcpy(&ds
->candidate
, current
);
45 ds
->candidate_exists
= 1;
47 } else if (!oidcmp(&ds
->candidate
, current
)) {
48 /* the same as what we already have seen */
53 /* cannot disambiguate between ds->candidate and current */
58 if (!ds
->candidate_checked
) {
59 ds
->candidate_ok
= ds
->fn(&ds
->candidate
, ds
->cb_data
);
60 ds
->disambiguate_fn_used
= 1;
61 ds
->candidate_checked
= 1;
64 if (!ds
->candidate_ok
) {
65 /* discard the candidate; we know it does not satisfy fn */
66 oidcpy(&ds
->candidate
, current
);
67 ds
->candidate_checked
= 0;
71 /* if we reach this point, we know ds->candidate satisfies fn */
72 if (ds
->fn(current
, ds
->cb_data
)) {
74 * if both current and candidate satisfy fn, we cannot
81 /* otherwise, current can be discarded and candidate is still good */
84 static int append_loose_object(const struct object_id
*oid
, const char *path
,
87 oid_array_append(data
, oid
);
91 static int match_sha(unsigned, const unsigned char *, const unsigned char *);
93 static void find_short_object_filename(struct disambiguate_state
*ds
)
95 int subdir_nr
= ds
->bin_pfx
.hash
[0];
96 struct alternate_object_database
*alt
;
97 static struct alternate_object_database
*fakeent
;
101 * Create a "fake" alternate object database that
102 * points to our own object database, to make it
103 * easier to get a temporary working space in
104 * alt->name/alt->base while iterating over the
105 * object databases including our own.
107 fakeent
= alloc_alt_odb(get_object_directory());
109 fakeent
->next
= the_repository
->objects
->alt_odb_list
;
111 for (alt
= fakeent
; alt
&& !ds
->ambiguous
; alt
= alt
->next
) {
114 if (!alt
->loose_objects_subdir_seen
[subdir_nr
]) {
115 struct strbuf
*buf
= alt_scratch_buf(alt
);
116 for_each_file_in_obj_subdir(subdir_nr
, buf
,
119 &alt
->loose_objects_cache
);
120 alt
->loose_objects_subdir_seen
[subdir_nr
] = 1;
123 pos
= oid_array_lookup(&alt
->loose_objects_cache
, &ds
->bin_pfx
);
126 while (!ds
->ambiguous
&& pos
< alt
->loose_objects_cache
.nr
) {
127 const struct object_id
*oid
;
128 oid
= alt
->loose_objects_cache
.oid
+ pos
;
129 if (!match_sha(ds
->len
, ds
->bin_pfx
.hash
, oid
->hash
))
131 update_candidates(ds
, oid
);
137 static int match_sha(unsigned len
, const unsigned char *a
, const unsigned char *b
)
147 if ((*a
^ *b
) & 0xf0)
152 static void unique_in_pack(struct packed_git
*p
,
153 struct disambiguate_state
*ds
)
155 uint32_t num
, i
, first
= 0;
156 const struct object_id
*current
= NULL
;
158 if (open_pack_index(p
) || !p
->num_objects
)
161 num
= p
->num_objects
;
162 bsearch_pack(&ds
->bin_pfx
, p
, &first
);
165 * At this point, "first" is the location of the lowest object
166 * with an object name that could match "bin_pfx". See if we have
167 * 0, 1 or more objects that actually match(es).
169 for (i
= first
; i
< num
&& !ds
->ambiguous
; i
++) {
170 struct object_id oid
;
171 current
= nth_packed_object_oid(&oid
, p
, i
);
172 if (!match_sha(ds
->len
, ds
->bin_pfx
.hash
, current
->hash
))
174 update_candidates(ds
, current
);
178 static void find_short_packed_object(struct disambiguate_state
*ds
)
180 struct packed_git
*p
;
182 for (p
= get_packed_git(the_repository
); p
&& !ds
->ambiguous
;
184 unique_in_pack(p
, ds
);
187 #define SHORT_NAME_NOT_FOUND (-1)
188 #define SHORT_NAME_AMBIGUOUS (-2)
190 static int finish_object_disambiguation(struct disambiguate_state
*ds
,
191 struct object_id
*oid
)
194 return SHORT_NAME_AMBIGUOUS
;
196 if (!ds
->candidate_exists
)
197 return SHORT_NAME_NOT_FOUND
;
199 if (!ds
->candidate_checked
)
201 * If this is the only candidate, there is no point
202 * calling the disambiguation hint callback.
204 * On the other hand, if the current candidate
205 * replaced an earlier candidate that did _not_ pass
206 * the disambiguation hint callback, then we do have
207 * more than one objects that match the short name
208 * given, so we should make sure this one matches;
209 * otherwise, if we discovered this one and the one
210 * that we previously discarded in the reverse order,
211 * we would end up showing different results in the
214 ds
->candidate_ok
= (!ds
->disambiguate_fn_used
||
215 ds
->fn(&ds
->candidate
, ds
->cb_data
));
217 if (!ds
->candidate_ok
)
218 return SHORT_NAME_AMBIGUOUS
;
220 oidcpy(oid
, &ds
->candidate
);
224 static int disambiguate_commit_only(const struct object_id
*oid
, void *cb_data_unused
)
226 int kind
= oid_object_info(the_repository
, oid
, NULL
);
227 return kind
== OBJ_COMMIT
;
230 static int disambiguate_committish_only(const struct object_id
*oid
, void *cb_data_unused
)
235 kind
= oid_object_info(the_repository
, oid
, NULL
);
236 if (kind
== OBJ_COMMIT
)
241 /* We need to do this the hard way... */
242 obj
= deref_tag(parse_object(oid
), NULL
, 0);
243 if (obj
&& obj
->type
== OBJ_COMMIT
)
248 static int disambiguate_tree_only(const struct object_id
*oid
, void *cb_data_unused
)
250 int kind
= oid_object_info(the_repository
, oid
, NULL
);
251 return kind
== OBJ_TREE
;
254 static int disambiguate_treeish_only(const struct object_id
*oid
, void *cb_data_unused
)
259 kind
= oid_object_info(the_repository
, oid
, NULL
);
260 if (kind
== OBJ_TREE
|| kind
== OBJ_COMMIT
)
265 /* We need to do this the hard way... */
266 obj
= deref_tag(parse_object(oid
), NULL
, 0);
267 if (obj
&& (obj
->type
== OBJ_TREE
|| obj
->type
== OBJ_COMMIT
))
272 static int disambiguate_blob_only(const struct object_id
*oid
, void *cb_data_unused
)
274 int kind
= oid_object_info(the_repository
, oid
, NULL
);
275 return kind
== OBJ_BLOB
;
278 static disambiguate_hint_fn default_disambiguate_hint
;
280 int set_disambiguate_hint_config(const char *var
, const char *value
)
282 static const struct {
284 disambiguate_hint_fn fn
;
287 { "commit", disambiguate_commit_only
},
288 { "committish", disambiguate_committish_only
},
289 { "tree", disambiguate_tree_only
},
290 { "treeish", disambiguate_treeish_only
},
291 { "blob", disambiguate_blob_only
}
296 return config_error_nonbool(var
);
298 for (i
= 0; i
< ARRAY_SIZE(hints
); i
++) {
299 if (!strcasecmp(value
, hints
[i
].name
)) {
300 default_disambiguate_hint
= hints
[i
].fn
;
305 return error("unknown hint type for '%s': %s", var
, value
);
308 static int init_object_disambiguation(const char *name
, int len
,
309 struct disambiguate_state
*ds
)
313 if (len
< MINIMUM_ABBREV
|| len
> the_hash_algo
->hexsz
)
316 memset(ds
, 0, sizeof(*ds
));
318 for (i
= 0; i
< len
;i
++) {
319 unsigned char c
= name
[i
];
321 if (c
>= '0' && c
<= '9')
323 else if (c
>= 'a' && c
<= 'f')
325 else if (c
>= 'A' && c
<='F') {
334 ds
->bin_pfx
.hash
[i
>> 1] |= val
;
338 ds
->hex_pfx
[len
] = '\0';
339 prepare_alt_odb(the_repository
);
343 static int show_ambiguous_object(const struct object_id
*oid
, void *data
)
345 const struct disambiguate_state
*ds
= data
;
346 struct strbuf desc
= STRBUF_INIT
;
349 if (ds
->fn
&& !ds
->fn(oid
, ds
->cb_data
))
352 type
= oid_object_info(the_repository
, oid
, NULL
);
353 if (type
== OBJ_COMMIT
) {
354 struct commit
*commit
= lookup_commit(oid
);
356 struct pretty_print_context pp
= {0};
357 pp
.date_mode
.type
= DATE_SHORT
;
358 format_commit_message(commit
, " %ad - %s", &desc
, &pp
);
360 } else if (type
== OBJ_TAG
) {
361 struct tag
*tag
= lookup_tag(oid
);
362 if (!parse_tag(tag
) && tag
->tag
)
363 strbuf_addf(&desc
, " %s", tag
->tag
);
367 find_unique_abbrev(oid
, DEFAULT_ABBREV
),
368 type_name(type
) ? type_name(type
) : "unknown type",
371 strbuf_release(&desc
);
375 static int collect_ambiguous(const struct object_id
*oid
, void *data
)
377 oid_array_append(data
, oid
);
381 static int sort_ambiguous(const void *a
, const void *b
)
383 int a_type
= oid_object_info(the_repository
, a
, NULL
);
384 int b_type
= oid_object_info(the_repository
, b
, NULL
);
389 * Sorts by hash within the same object type, just as
390 * oid_array_for_each_unique() would do.
392 if (a_type
== b_type
)
396 * Between object types show tags, then commits, and finally
399 * The object_type enum is commit, tree, blob, tag, but we
400 * want tag, commit, tree blob. Cleverly (perhaps too
401 * cleverly) do that with modulus, since the enum assigns 1 to
402 * commit, so tag becomes 0.
404 a_type_sort
= a_type
% 4;
405 b_type_sort
= b_type
% 4;
406 return a_type_sort
> b_type_sort
? 1 : -1;
409 static int get_short_oid(const char *name
, int len
, struct object_id
*oid
,
413 struct disambiguate_state ds
;
414 int quietly
= !!(flags
& GET_OID_QUIETLY
);
416 if (init_object_disambiguation(name
, len
, &ds
) < 0)
419 if (HAS_MULTI_BITS(flags
& GET_OID_DISAMBIGUATORS
))
420 BUG("multiple get_short_oid disambiguator flags");
422 if (flags
& GET_OID_COMMIT
)
423 ds
.fn
= disambiguate_commit_only
;
424 else if (flags
& GET_OID_COMMITTISH
)
425 ds
.fn
= disambiguate_committish_only
;
426 else if (flags
& GET_OID_TREE
)
427 ds
.fn
= disambiguate_tree_only
;
428 else if (flags
& GET_OID_TREEISH
)
429 ds
.fn
= disambiguate_treeish_only
;
430 else if (flags
& GET_OID_BLOB
)
431 ds
.fn
= disambiguate_blob_only
;
433 ds
.fn
= default_disambiguate_hint
;
435 find_short_object_filename(&ds
);
436 find_short_packed_object(&ds
);
437 status
= finish_object_disambiguation(&ds
, oid
);
439 if (!quietly
&& (status
== SHORT_NAME_AMBIGUOUS
)) {
440 struct oid_array collect
= OID_ARRAY_INIT
;
442 error(_("short SHA1 %s is ambiguous"), ds
.hex_pfx
);
445 * We may still have ambiguity if we simply saw a series of
446 * candidates that did not satisfy our hint function. In
447 * that case, we still want to show them, so disable the hint
453 advise(_("The candidates are:"));
454 for_each_abbrev(ds
.hex_pfx
, collect_ambiguous
, &collect
);
455 QSORT(collect
.oid
, collect
.nr
, sort_ambiguous
);
457 if (oid_array_for_each(&collect
, show_ambiguous_object
, &ds
))
458 BUG("show_ambiguous_object shouldn't return non-zero");
459 oid_array_clear(&collect
);
465 int for_each_abbrev(const char *prefix
, each_abbrev_fn fn
, void *cb_data
)
467 struct oid_array collect
= OID_ARRAY_INIT
;
468 struct disambiguate_state ds
;
471 if (init_object_disambiguation(prefix
, strlen(prefix
), &ds
) < 0)
474 ds
.always_call_fn
= 1;
475 ds
.fn
= collect_ambiguous
;
476 ds
.cb_data
= &collect
;
477 find_short_object_filename(&ds
);
478 find_short_packed_object(&ds
);
480 ret
= oid_array_for_each_unique(&collect
, fn
, cb_data
);
481 oid_array_clear(&collect
);
486 * Return the slot of the most-significant bit set in "val". There are various
487 * ways to do this quickly with fls() or __builtin_clzl(), but speed is
488 * probably not a big deal here.
490 static unsigned msb(unsigned long val
)
498 struct min_abbrev_data
{
499 unsigned int init_len
;
500 unsigned int cur_len
;
502 const struct object_id
*oid
;
505 static inline char get_hex_char_from_oid(const struct object_id
*oid
,
508 static const char hex
[] = "0123456789abcdef";
511 return hex
[oid
->hash
[pos
>> 1] >> 4];
513 return hex
[oid
->hash
[pos
>> 1] & 0xf];
516 static int extend_abbrev_len(const struct object_id
*oid
, void *cb_data
)
518 struct min_abbrev_data
*mad
= cb_data
;
520 unsigned int i
= mad
->init_len
;
521 while (mad
->hex
[i
] && mad
->hex
[i
] == get_hex_char_from_oid(oid
, i
))
524 if (i
< GIT_MAX_RAWSZ
&& i
>= mad
->cur_len
)
525 mad
->cur_len
= i
+ 1;
530 static void find_abbrev_len_for_pack(struct packed_git
*p
,
531 struct min_abbrev_data
*mad
)
534 uint32_t num
, first
= 0;
535 struct object_id oid
;
536 const struct object_id
*mad_oid
;
538 if (open_pack_index(p
) || !p
->num_objects
)
541 num
= p
->num_objects
;
543 match
= bsearch_pack(mad_oid
, p
, &first
);
546 * first is now the position in the packfile where we would insert
547 * mad->hash if it does not exist (or the position of mad->hash if
548 * it does exist). Hence, we consider a maximum of two objects
549 * nearby for the abbreviation length.
553 if (nth_packed_object_oid(&oid
, p
, first
))
554 extend_abbrev_len(&oid
, mad
);
555 } else if (first
< num
- 1) {
556 if (nth_packed_object_oid(&oid
, p
, first
+ 1))
557 extend_abbrev_len(&oid
, mad
);
560 if (nth_packed_object_oid(&oid
, p
, first
- 1))
561 extend_abbrev_len(&oid
, mad
);
563 mad
->init_len
= mad
->cur_len
;
566 static void find_abbrev_len_packed(struct min_abbrev_data
*mad
)
568 struct packed_git
*p
;
570 for (p
= get_packed_git(the_repository
); p
; p
= p
->next
)
571 find_abbrev_len_for_pack(p
, mad
);
574 int find_unique_abbrev_r(char *hex
, const struct object_id
*oid
, int len
)
576 struct disambiguate_state ds
;
577 struct min_abbrev_data mad
;
578 struct object_id oid_ret
;
579 const unsigned hexsz
= the_hash_algo
->hexsz
;
582 unsigned long count
= approximate_object_count();
584 * Add one because the MSB only tells us the highest bit set,
585 * not including the value of all the _other_ bits (so "15"
586 * is only one off of 2^4, but the MSB is the 3rd bit.
588 len
= msb(count
) + 1;
590 * We now know we have on the order of 2^len objects, which
591 * expects a collision at 2^(len/2). But we also care about hex
592 * chars, not bits, and there are 4 bits per hex. So all
593 * together we need to divide by 2 and round up.
595 len
= DIV_ROUND_UP(len
, 2);
597 * For very small repos, we stick with our regular fallback.
599 if (len
< FALLBACK_DEFAULT_ABBREV
)
600 len
= FALLBACK_DEFAULT_ABBREV
;
603 oid_to_hex_r(hex
, oid
);
604 if (len
== hexsz
|| !len
)
612 find_abbrev_len_packed(&mad
);
614 if (init_object_disambiguation(hex
, mad
.cur_len
, &ds
) < 0)
617 ds
.fn
= extend_abbrev_len
;
618 ds
.always_call_fn
= 1;
619 ds
.cb_data
= (void *)&mad
;
621 find_short_object_filename(&ds
);
622 (void)finish_object_disambiguation(&ds
, &oid_ret
);
624 hex
[mad
.cur_len
] = 0;
628 const char *find_unique_abbrev(const struct object_id
*oid
, int len
)
631 static char hexbuffer
[4][GIT_MAX_HEXSZ
+ 1];
632 char *hex
= hexbuffer
[bufno
];
633 bufno
= (bufno
+ 1) % ARRAY_SIZE(hexbuffer
);
634 find_unique_abbrev_r(hex
, oid
, len
);
638 static int ambiguous_path(const char *path
, int len
)
643 for (cnt
= 0; cnt
< len
; cnt
++) {
663 static inline int at_mark(const char *string
, int len
,
664 const char **suffix
, int nr
)
668 for (i
= 0; i
< nr
; i
++) {
669 int suffix_len
= strlen(suffix
[i
]);
670 if (suffix_len
<= len
671 && !strncasecmp(string
, suffix
[i
], suffix_len
))
677 static inline int upstream_mark(const char *string
, int len
)
679 const char *suffix
[] = { "@{upstream}", "@{u}" };
680 return at_mark(string
, len
, suffix
, ARRAY_SIZE(suffix
));
683 static inline int push_mark(const char *string
, int len
)
685 const char *suffix
[] = { "@{push}" };
686 return at_mark(string
, len
, suffix
, ARRAY_SIZE(suffix
));
689 static int get_oid_1(const char *name
, int len
, struct object_id
*oid
, unsigned lookup_flags
);
690 static int interpret_nth_prior_checkout(const char *name
, int namelen
, struct strbuf
*buf
);
692 static int get_oid_basic(const char *str
, int len
, struct object_id
*oid
,
695 static const char *warn_msg
= "refname '%.*s' is ambiguous.";
696 static const char *object_name_msg
= N_(
697 "Git normally never creates a ref that ends with 40 hex characters\n"
698 "because it will be ignored when you just specify 40-hex. These refs\n"
699 "may be created by mistake. For example,\n"
701 " git checkout -b $br $(git rev-parse ...)\n"
703 "where \"$br\" is somehow empty and a 40-hex ref is created. Please\n"
704 "examine these refs and maybe delete them. Turn this message off by\n"
705 "running \"git config advice.objectNameWarning false\"");
706 struct object_id tmp_oid
;
707 char *real_ref
= NULL
;
709 int at
, reflog_len
, nth_prior
= 0;
711 if (len
== the_hash_algo
->hexsz
&& !get_oid_hex(str
, oid
)) {
712 if (warn_ambiguous_refs
&& warn_on_object_refname_ambiguity
) {
713 refs_found
= dwim_ref(str
, len
, &tmp_oid
, &real_ref
);
714 if (refs_found
> 0) {
715 warning(warn_msg
, len
, str
);
716 if (advice_object_name_warning
)
717 fprintf(stderr
, "%s\n", _(object_name_msg
));
724 /* basic@{time or number or -number} format to query ref-log */
726 if (len
&& str
[len
-1] == '}') {
727 for (at
= len
-4; at
>= 0; at
--) {
728 if (str
[at
] == '@' && str
[at
+1] == '{') {
729 if (str
[at
+2] == '-') {
731 /* @{-N} not at start */
736 if (!upstream_mark(str
+ at
, len
- at
) &&
737 !push_mark(str
+ at
, len
- at
)) {
738 reflog_len
= (len
-1) - (at
+2);
746 /* Accept only unambiguous ref paths. */
747 if (len
&& ambiguous_path(str
, len
))
751 struct strbuf buf
= STRBUF_INIT
;
754 if (interpret_nth_prior_checkout(str
, len
, &buf
) > 0) {
755 detached
= (buf
.len
== the_hash_algo
->hexsz
&& !get_oid_hex(buf
.buf
, oid
));
756 strbuf_release(&buf
);
762 if (!len
&& reflog_len
)
763 /* allow "@{...}" to mean the current branch reflog */
764 refs_found
= dwim_ref("HEAD", 4, oid
, &real_ref
);
766 refs_found
= dwim_log(str
, len
, oid
, &real_ref
);
768 refs_found
= dwim_ref(str
, len
, oid
, &real_ref
);
773 if (warn_ambiguous_refs
&& !(flags
& GET_OID_QUIETLY
) &&
775 !get_short_oid(str
, len
, &tmp_oid
, GET_OID_QUIETLY
)))
776 warning(warn_msg
, len
, str
);
784 /* Is it asking for N-th entry, or approxidate? */
785 for (i
= nth
= 0; 0 <= nth
&& i
< reflog_len
; i
++) {
786 char ch
= str
[at
+2+i
];
787 if ('0' <= ch
&& ch
<= '9')
788 nth
= nth
* 10 + ch
- '0';
792 if (100000000 <= nth
) {
799 char *tmp
= xstrndup(str
+ at
+ 2, reflog_len
);
800 at_time
= approxidate_careful(tmp
, &errors
);
807 if (read_ref_at(real_ref
, flags
, at_time
, nth
, oid
, NULL
,
808 &co_time
, &co_tz
, &co_cnt
)) {
810 if (starts_with(real_ref
, "refs/heads/")) {
812 len
= strlen(real_ref
+ 11);
820 if (!(flags
& GET_OID_QUIETLY
)) {
821 warning("Log for '%.*s' only goes "
822 "back to %s.", len
, str
,
823 show_date(co_time
, co_tz
, DATE_MODE(RFC2822
)));
826 if (flags
& GET_OID_QUIETLY
) {
829 die("Log for '%.*s' only has %d entries.",
839 static int get_parent(const char *name
, int len
,
840 struct object_id
*result
, int idx
)
842 struct object_id oid
;
843 int ret
= get_oid_1(name
, len
, &oid
, GET_OID_COMMITTISH
);
844 struct commit
*commit
;
845 struct commit_list
*p
;
849 commit
= lookup_commit_reference(&oid
);
850 if (parse_commit(commit
))
853 oidcpy(result
, &commit
->object
.oid
);
859 oidcpy(result
, &p
->item
->object
.oid
);
867 static int get_nth_ancestor(const char *name
, int len
,
868 struct object_id
*result
, int generation
)
870 struct object_id oid
;
871 struct commit
*commit
;
874 ret
= get_oid_1(name
, len
, &oid
, GET_OID_COMMITTISH
);
877 commit
= lookup_commit_reference(&oid
);
881 while (generation
--) {
882 if (parse_commit(commit
) || !commit
->parents
)
884 commit
= commit
->parents
->item
;
886 oidcpy(result
, &commit
->object
.oid
);
890 struct object
*peel_to_type(const char *name
, int namelen
,
891 struct object
*o
, enum object_type expected_type
)
893 if (name
&& !namelen
)
894 namelen
= strlen(name
);
896 if (!o
|| (!o
->parsed
&& !parse_object(&o
->oid
)))
898 if (expected_type
== OBJ_ANY
|| o
->type
== expected_type
)
900 if (o
->type
== OBJ_TAG
)
901 o
= ((struct tag
*) o
)->tagged
;
902 else if (o
->type
== OBJ_COMMIT
)
903 o
= &(get_commit_tree(((struct commit
*)o
))->object
);
906 error("%.*s: expected %s type, but the object "
907 "dereferences to %s type",
908 namelen
, name
, type_name(expected_type
),
915 static int peel_onion(const char *name
, int len
, struct object_id
*oid
,
916 unsigned lookup_flags
)
918 struct object_id outer
;
920 unsigned int expected_type
= 0;
924 * "ref^{type}" dereferences ref repeatedly until you cannot
925 * dereference anymore, or you get an object of given type,
926 * whichever comes first. "ref^{}" means just dereference
927 * tags until you get a non-tag. "ref^0" is a shorthand for
928 * "ref^{commit}". "commit^{tree}" could be used to find the
929 * top-level tree of the given commit.
931 if (len
< 4 || name
[len
-1] != '}')
934 for (sp
= name
+ len
- 1; name
<= sp
; sp
--) {
936 if (ch
== '{' && name
< sp
&& sp
[-1] == '^')
942 sp
++; /* beginning of type name, or closing brace for empty */
943 if (starts_with(sp
, "commit}"))
944 expected_type
= OBJ_COMMIT
;
945 else if (starts_with(sp
, "tag}"))
946 expected_type
= OBJ_TAG
;
947 else if (starts_with(sp
, "tree}"))
948 expected_type
= OBJ_TREE
;
949 else if (starts_with(sp
, "blob}"))
950 expected_type
= OBJ_BLOB
;
951 else if (starts_with(sp
, "object}"))
952 expected_type
= OBJ_ANY
;
953 else if (sp
[0] == '}')
954 expected_type
= OBJ_NONE
;
955 else if (sp
[0] == '/')
956 expected_type
= OBJ_COMMIT
;
960 lookup_flags
&= ~GET_OID_DISAMBIGUATORS
;
961 if (expected_type
== OBJ_COMMIT
)
962 lookup_flags
|= GET_OID_COMMITTISH
;
963 else if (expected_type
== OBJ_TREE
)
964 lookup_flags
|= GET_OID_TREEISH
;
966 if (get_oid_1(name
, sp
- name
- 2, &outer
, lookup_flags
))
969 o
= parse_object(&outer
);
972 if (!expected_type
) {
973 o
= deref_tag(o
, name
, sp
- name
- 2);
974 if (!o
|| (!o
->parsed
&& !parse_object(&o
->oid
)))
976 oidcpy(oid
, &o
->oid
);
981 * At this point, the syntax look correct, so
982 * if we do not get the needed object, we should
985 o
= peel_to_type(name
, len
, o
, expected_type
);
989 oidcpy(oid
, &o
->oid
);
991 /* "$commit^{/foo}" */
994 struct commit_list
*list
= NULL
;
997 * $commit^{/}. Some regex implementation may reject.
998 * We don't need regex anyway. '' pattern always matches.
1003 prefix
= xstrndup(sp
+ 1, name
+ len
- 1 - (sp
+ 1));
1004 commit_list_insert((struct commit
*)o
, &list
);
1005 ret
= get_oid_oneline(prefix
, oid
, list
);
1012 static int get_describe_name(const char *name
, int len
, struct object_id
*oid
)
1015 unsigned flags
= GET_OID_QUIETLY
| GET_OID_COMMIT
;
1017 for (cp
= name
+ len
- 1; name
+ 2 <= cp
; cp
--) {
1019 if (!isxdigit(ch
)) {
1020 /* We must be looking at g in "SOMETHING-g"
1021 * for it to be describe output.
1023 if (ch
== 'g' && cp
[-1] == '-') {
1026 return get_short_oid(cp
, len
, oid
, flags
);
1033 static int get_oid_1(const char *name
, int len
, struct object_id
*oid
, unsigned lookup_flags
)
1035 int ret
, has_suffix
;
1039 * "name~3" is "name^^^", "name~" is "name~1", and "name^" is "name^1".
1042 for (cp
= name
+ len
- 1; name
<= cp
; cp
--) {
1044 if ('0' <= ch
&& ch
<= '9')
1046 if (ch
== '~' || ch
== '^')
1053 int len1
= cp
- name
;
1055 while (cp
< name
+ len
)
1056 num
= num
* 10 + *cp
++ - '0';
1057 if (!num
&& len1
== len
- 1)
1059 if (has_suffix
== '^')
1060 return get_parent(name
, len1
, oid
, num
);
1061 /* else if (has_suffix == '~') -- goes without saying */
1062 return get_nth_ancestor(name
, len1
, oid
, num
);
1065 ret
= peel_onion(name
, len
, oid
, lookup_flags
);
1069 ret
= get_oid_basic(name
, len
, oid
, lookup_flags
);
1073 /* It could be describe output that is "SOMETHING-gXXXX" */
1074 ret
= get_describe_name(name
, len
, oid
);
1078 return get_short_oid(name
, len
, oid
, lookup_flags
);
1082 * This interprets names like ':/Initial revision of "git"' by searching
1083 * through history and returning the first commit whose message starts
1084 * the given regular expression.
1086 * For negative-matching, prefix the pattern-part with '!-', like: ':/!-WIP'.
1088 * For a literal '!' character at the beginning of a pattern, you have to repeat
1089 * that, like: ':/!!foo'
1091 * For future extension, all other sequences beginning with ':/!' are reserved.
1094 /* Remember to update object flag allocation in object.h */
1095 #define ONELINE_SEEN (1u<<20)
1097 static int handle_one_ref(const char *path
, const struct object_id
*oid
,
1098 int flag
, void *cb_data
)
1100 struct commit_list
**list
= cb_data
;
1101 struct object
*object
= parse_object(oid
);
1104 if (object
->type
== OBJ_TAG
) {
1105 object
= deref_tag(object
, path
, strlen(path
));
1109 if (object
->type
!= OBJ_COMMIT
)
1111 commit_list_insert((struct commit
*)object
, list
);
1115 static int get_oid_oneline(const char *prefix
, struct object_id
*oid
,
1116 struct commit_list
*list
)
1118 struct commit_list
*backup
= NULL
, *l
;
1123 if (prefix
[0] == '!') {
1126 if (prefix
[0] == '-') {
1129 } else if (prefix
[0] != '!') {
1134 if (regcomp(®ex
, prefix
, REG_EXTENDED
))
1137 for (l
= list
; l
; l
= l
->next
) {
1138 l
->item
->object
.flags
|= ONELINE_SEEN
;
1139 commit_list_insert(l
->item
, &backup
);
1142 const char *p
, *buf
;
1143 struct commit
*commit
;
1146 commit
= pop_most_recent_commit(&list
, ONELINE_SEEN
);
1147 if (!parse_object(&commit
->object
.oid
))
1149 buf
= get_commit_buffer(commit
, NULL
);
1150 p
= strstr(buf
, "\n\n");
1151 matches
= negative
^ (p
&& !regexec(®ex
, p
+ 2, 0, NULL
, 0));
1152 unuse_commit_buffer(commit
, buf
);
1155 oidcpy(oid
, &commit
->object
.oid
);
1161 free_commit_list(list
);
1162 for (l
= backup
; l
; l
= l
->next
)
1163 clear_commit_marks(l
->item
, ONELINE_SEEN
);
1164 free_commit_list(backup
);
1165 return found
? 0 : -1;
1168 struct grab_nth_branch_switch_cbdata
{
1173 static int grab_nth_branch_switch(struct object_id
*ooid
, struct object_id
*noid
,
1174 const char *email
, timestamp_t timestamp
, int tz
,
1175 const char *message
, void *cb_data
)
1177 struct grab_nth_branch_switch_cbdata
*cb
= cb_data
;
1178 const char *match
= NULL
, *target
= NULL
;
1181 if (skip_prefix(message
, "checkout: moving from ", &match
))
1182 target
= strstr(match
, " to ");
1184 if (!match
|| !target
)
1186 if (--(cb
->remaining
) == 0) {
1187 len
= target
- match
;
1188 strbuf_reset(&cb
->buf
);
1189 strbuf_add(&cb
->buf
, match
, len
);
1190 return 1; /* we are done */
1196 * Parse @{-N} syntax, return the number of characters parsed
1197 * if successful; otherwise signal an error with negative value.
1199 static int interpret_nth_prior_checkout(const char *name
, int namelen
,
1204 struct grab_nth_branch_switch_cbdata cb
;
1210 if (name
[0] != '@' || name
[1] != '{' || name
[2] != '-')
1212 brace
= memchr(name
, '}', namelen
);
1215 nth
= strtol(name
+ 3, &num_end
, 10);
1216 if (num_end
!= brace
)
1221 strbuf_init(&cb
.buf
, 20);
1224 if (0 < for_each_reflog_ent_reverse("HEAD", grab_nth_branch_switch
, &cb
)) {
1226 strbuf_addbuf(buf
, &cb
.buf
);
1227 retval
= brace
- name
+ 1;
1230 strbuf_release(&cb
.buf
);
1234 int get_oid_mb(const char *name
, struct object_id
*oid
)
1236 struct commit
*one
, *two
;
1237 struct commit_list
*mbs
;
1238 struct object_id oid_tmp
;
1242 dots
= strstr(name
, "...");
1244 return get_oid(name
, oid
);
1246 st
= get_oid("HEAD", &oid_tmp
);
1249 strbuf_init(&sb
, dots
- name
);
1250 strbuf_add(&sb
, name
, dots
- name
);
1251 st
= get_oid_committish(sb
.buf
, &oid_tmp
);
1252 strbuf_release(&sb
);
1256 one
= lookup_commit_reference_gently(&oid_tmp
, 0);
1260 if (get_oid_committish(dots
[3] ? (dots
+ 3) : "HEAD", &oid_tmp
))
1262 two
= lookup_commit_reference_gently(&oid_tmp
, 0);
1265 mbs
= get_merge_bases(one
, two
);
1266 if (!mbs
|| mbs
->next
)
1270 oidcpy(oid
, &mbs
->item
->object
.oid
);
1272 free_commit_list(mbs
);
1276 /* parse @something syntax, when 'something' is not {.*} */
1277 static int interpret_empty_at(const char *name
, int namelen
, int len
, struct strbuf
*buf
)
1281 if (len
|| name
[1] == '{')
1284 /* make sure it's a single @, or @@{.*}, not @foo */
1285 next
= memchr(name
+ len
+ 1, '@', namelen
- len
- 1);
1286 if (next
&& next
[1] != '{')
1289 next
= name
+ namelen
;
1290 if (next
!= name
+ 1)
1294 strbuf_add(buf
, "HEAD", 4);
1298 static int reinterpret(const char *name
, int namelen
, int len
,
1299 struct strbuf
*buf
, unsigned allowed
)
1301 /* we have extra data, which might need further processing */
1302 struct strbuf tmp
= STRBUF_INIT
;
1303 int used
= buf
->len
;
1306 strbuf_add(buf
, name
+ len
, namelen
- len
);
1307 ret
= interpret_branch_name(buf
->buf
, buf
->len
, &tmp
, allowed
);
1308 /* that data was not interpreted, remove our cruft */
1310 strbuf_setlen(buf
, used
);
1314 strbuf_addbuf(buf
, &tmp
);
1315 strbuf_release(&tmp
);
1316 /* tweak for size of {-N} versus expanded ref name */
1317 return ret
- used
+ len
;
1320 static void set_shortened_ref(struct strbuf
*buf
, const char *ref
)
1322 char *s
= shorten_unambiguous_ref(ref
, 0);
1324 strbuf_addstr(buf
, s
);
1328 static int branch_interpret_allowed(const char *refname
, unsigned allowed
)
1333 if ((allowed
& INTERPRET_BRANCH_LOCAL
) &&
1334 starts_with(refname
, "refs/heads/"))
1336 if ((allowed
& INTERPRET_BRANCH_REMOTE
) &&
1337 starts_with(refname
, "refs/remotes/"))
1343 static int interpret_branch_mark(const char *name
, int namelen
,
1344 int at
, struct strbuf
*buf
,
1345 int (*get_mark
)(const char *, int),
1346 const char *(*get_data
)(struct branch
*,
1351 struct branch
*branch
;
1352 struct strbuf err
= STRBUF_INIT
;
1355 len
= get_mark(name
+ at
, namelen
- at
);
1359 if (memchr(name
, ':', at
))
1363 char *name_str
= xmemdupz(name
, at
);
1364 branch
= branch_get(name_str
);
1367 branch
= branch_get(NULL
);
1369 value
= get_data(branch
, &err
);
1373 if (!branch_interpret_allowed(value
, allowed
))
1376 set_shortened_ref(buf
, value
);
1380 int interpret_branch_name(const char *name
, int namelen
, struct strbuf
*buf
,
1388 namelen
= strlen(name
);
1390 if (!allowed
|| (allowed
& INTERPRET_BRANCH_LOCAL
)) {
1391 len
= interpret_nth_prior_checkout(name
, namelen
, buf
);
1393 return len
; /* syntax Ok, not enough switches */
1394 } else if (len
> 0) {
1396 return len
; /* consumed all */
1398 return reinterpret(name
, namelen
, len
, buf
, allowed
);
1403 (at
= memchr(start
, '@', namelen
- (start
- name
)));
1406 if (!allowed
|| (allowed
& INTERPRET_BRANCH_HEAD
)) {
1407 len
= interpret_empty_at(name
, namelen
, at
- name
, buf
);
1409 return reinterpret(name
, namelen
, len
, buf
,
1413 len
= interpret_branch_mark(name
, namelen
, at
- name
, buf
,
1414 upstream_mark
, branch_get_upstream
,
1419 len
= interpret_branch_mark(name
, namelen
, at
- name
, buf
,
1420 push_mark
, branch_get_push
,
1429 void strbuf_branchname(struct strbuf
*sb
, const char *name
, unsigned allowed
)
1431 int len
= strlen(name
);
1432 int used
= interpret_branch_name(name
, len
, sb
, allowed
);
1436 strbuf_add(sb
, name
+ used
, len
- used
);
1439 int strbuf_check_branch_ref(struct strbuf
*sb
, const char *name
)
1441 if (startup_info
->have_repository
)
1442 strbuf_branchname(sb
, name
, INTERPRET_BRANCH_LOCAL
);
1444 strbuf_addstr(sb
, name
);
1447 * This splice must be done even if we end up rejecting the
1448 * name; builtin/branch.c::copy_or_rename_branch() still wants
1449 * to see what the name expanded to so that "branch -m" can be
1450 * used as a tool to correct earlier mistakes.
1452 strbuf_splice(sb
, 0, 0, "refs/heads/", 11);
1455 !strcmp(sb
->buf
, "refs/heads/HEAD"))
1458 return check_refname_format(sb
->buf
, 0);
1462 * This is like "get_oid_basic()", except it allows "object ID expressions",
1463 * notably "xyz^" for "parent of xyz"
1465 int get_oid(const char *name
, struct object_id
*oid
)
1467 struct object_context unused
;
1468 return get_oid_with_context(name
, 0, oid
, &unused
);
1473 * Many callers know that the user meant to name a commit-ish by
1474 * syntactical positions where the object name appears. Calling this
1475 * function allows the machinery to disambiguate shorter-than-unique
1476 * abbreviated object names between commit-ish and others.
1478 * Note that this does NOT error out when the named object is not a
1479 * commit-ish. It is merely to give a hint to the disambiguation
1482 int get_oid_committish(const char *name
, struct object_id
*oid
)
1484 struct object_context unused
;
1485 return get_oid_with_context(name
, GET_OID_COMMITTISH
,
1489 int get_oid_treeish(const char *name
, struct object_id
*oid
)
1491 struct object_context unused
;
1492 return get_oid_with_context(name
, GET_OID_TREEISH
,
1496 int get_oid_commit(const char *name
, struct object_id
*oid
)
1498 struct object_context unused
;
1499 return get_oid_with_context(name
, GET_OID_COMMIT
,
1503 int get_oid_tree(const char *name
, struct object_id
*oid
)
1505 struct object_context unused
;
1506 return get_oid_with_context(name
, GET_OID_TREE
,
1510 int get_oid_blob(const char *name
, struct object_id
*oid
)
1512 struct object_context unused
;
1513 return get_oid_with_context(name
, GET_OID_BLOB
,
1517 /* Must be called only when object_name:filename doesn't exist. */
1518 static void diagnose_invalid_oid_path(const char *prefix
,
1519 const char *filename
,
1520 const struct object_id
*tree_oid
,
1521 const char *object_name
,
1522 int object_name_len
)
1524 struct object_id oid
;
1530 if (file_exists(filename
))
1531 die("Path '%s' exists on disk, but not in '%.*s'.",
1532 filename
, object_name_len
, object_name
);
1533 if (is_missing_file_error(errno
)) {
1534 char *fullname
= xstrfmt("%s%s", prefix
, filename
);
1536 if (!get_tree_entry(tree_oid
, fullname
, &oid
, &mode
)) {
1537 die("Path '%s' exists, but not '%s'.\n"
1538 "Did you mean '%.*s:%s' aka '%.*s:./%s'?",
1541 object_name_len
, object_name
,
1543 object_name_len
, object_name
,
1546 die("Path '%s' does not exist in '%.*s'",
1547 filename
, object_name_len
, object_name
);
1551 /* Must be called only when :stage:filename doesn't exist. */
1552 static void diagnose_invalid_index_path(int stage
,
1554 const char *filename
)
1556 const struct cache_entry
*ce
;
1558 unsigned namelen
= strlen(filename
);
1559 struct strbuf fullname
= STRBUF_INIT
;
1564 /* Wrong stage number? */
1565 pos
= cache_name_pos(filename
, namelen
);
1568 if (pos
< active_nr
) {
1569 ce
= active_cache
[pos
];
1570 if (ce_namelen(ce
) == namelen
&&
1571 !memcmp(ce
->name
, filename
, namelen
))
1572 die("Path '%s' is in the index, but not at stage %d.\n"
1573 "Did you mean ':%d:%s'?",
1575 ce_stage(ce
), filename
);
1578 /* Confusion between relative and absolute filenames? */
1579 strbuf_addstr(&fullname
, prefix
);
1580 strbuf_addstr(&fullname
, filename
);
1581 pos
= cache_name_pos(fullname
.buf
, fullname
.len
);
1584 if (pos
< active_nr
) {
1585 ce
= active_cache
[pos
];
1586 if (ce_namelen(ce
) == fullname
.len
&&
1587 !memcmp(ce
->name
, fullname
.buf
, fullname
.len
))
1588 die("Path '%s' is in the index, but not '%s'.\n"
1589 "Did you mean ':%d:%s' aka ':%d:./%s'?",
1590 fullname
.buf
, filename
,
1591 ce_stage(ce
), fullname
.buf
,
1592 ce_stage(ce
), filename
);
1595 if (file_exists(filename
))
1596 die("Path '%s' exists on disk, but not in the index.", filename
);
1597 if (is_missing_file_error(errno
))
1598 die("Path '%s' does not exist (neither on disk nor in the index).",
1601 strbuf_release(&fullname
);
1605 static char *resolve_relative_path(const char *rel
)
1607 if (!starts_with(rel
, "./") && !starts_with(rel
, "../"))
1610 if (!is_inside_work_tree())
1611 die("relative path syntax can't be used outside working tree.");
1613 /* die() inside prefix_path() if resolved path is outside worktree */
1614 return prefix_path(startup_info
->prefix
,
1615 startup_info
->prefix
? strlen(startup_info
->prefix
) : 0,
1619 static int get_oid_with_context_1(const char *name
,
1622 struct object_id
*oid
,
1623 struct object_context
*oc
)
1625 int ret
, bracket_depth
;
1626 int namelen
= strlen(name
);
1628 int only_to_die
= flags
& GET_OID_ONLY_TO_DIE
;
1631 flags
|= GET_OID_QUIETLY
;
1633 memset(oc
, 0, sizeof(*oc
));
1634 oc
->mode
= S_IFINVALID
;
1635 strbuf_init(&oc
->symlink_path
, 0);
1636 ret
= get_oid_1(name
, namelen
, oid
, flags
);
1640 * sha1:path --> object name of path in ent sha1
1641 * :path -> object name of absolute path in index
1642 * :./path -> object name of path relative to cwd in index
1643 * :[0-3]:path -> object name of path in index at stage
1644 * :/foo -> recent commit matching foo
1646 if (name
[0] == ':') {
1648 const struct cache_entry
*ce
;
1649 char *new_path
= NULL
;
1651 if (!only_to_die
&& namelen
> 2 && name
[1] == '/') {
1652 struct commit_list
*list
= NULL
;
1654 for_each_ref(handle_one_ref
, &list
);
1655 commit_list_sort_by_date(&list
);
1656 return get_oid_oneline(name
+ 2, oid
, list
);
1660 name
[1] < '0' || '3' < name
[1])
1663 stage
= name
[1] - '0';
1666 new_path
= resolve_relative_path(cp
);
1668 namelen
= namelen
- (cp
- name
);
1671 namelen
= strlen(cp
);
1674 if (flags
& GET_OID_RECORD_PATH
)
1675 oc
->path
= xstrdup(cp
);
1679 pos
= cache_name_pos(cp
, namelen
);
1682 while (pos
< active_nr
) {
1683 ce
= active_cache
[pos
];
1684 if (ce_namelen(ce
) != namelen
||
1685 memcmp(ce
->name
, cp
, namelen
))
1687 if (ce_stage(ce
) == stage
) {
1688 oidcpy(oid
, &ce
->oid
);
1689 oc
->mode
= ce
->ce_mode
;
1695 if (only_to_die
&& name
[1] && name
[1] != '/')
1696 diagnose_invalid_index_path(stage
, prefix
, cp
);
1700 for (cp
= name
, bracket_depth
= 0; *cp
; cp
++) {
1703 else if (bracket_depth
&& *cp
== '}')
1705 else if (!bracket_depth
&& *cp
== ':')
1709 struct object_id tree_oid
;
1710 int len
= cp
- name
;
1711 unsigned sub_flags
= flags
;
1713 sub_flags
&= ~GET_OID_DISAMBIGUATORS
;
1714 sub_flags
|= GET_OID_TREEISH
;
1716 if (!get_oid_1(name
, len
, &tree_oid
, sub_flags
)) {
1717 const char *filename
= cp
+1;
1718 char *new_filename
= NULL
;
1720 new_filename
= resolve_relative_path(filename
);
1722 filename
= new_filename
;
1723 if (flags
& GET_OID_FOLLOW_SYMLINKS
) {
1724 ret
= get_tree_entry_follow_symlinks(&tree_oid
,
1725 filename
, oid
, &oc
->symlink_path
,
1728 ret
= get_tree_entry(&tree_oid
, filename
, oid
,
1730 if (ret
&& only_to_die
) {
1731 diagnose_invalid_oid_path(prefix
,
1737 if (flags
& GET_OID_RECORD_PATH
)
1738 oc
->path
= xstrdup(filename
);
1744 die("Invalid object name '%.*s'.", len
, name
);
1751 * Call this function when you know "name" given by the end user must
1752 * name an object but it doesn't; the function _may_ die with a better
1753 * diagnostic message than "no such object 'name'", e.g. "Path 'doc' does not
1754 * exist in 'HEAD'" when given "HEAD:doc", or it may return in which case
1755 * you have a chance to diagnose the error further.
1757 void maybe_die_on_misspelt_object_name(const char *name
, const char *prefix
)
1759 struct object_context oc
;
1760 struct object_id oid
;
1761 get_oid_with_context_1(name
, GET_OID_ONLY_TO_DIE
, prefix
, &oid
, &oc
);
1764 int get_oid_with_context(const char *str
, unsigned flags
, struct object_id
*oid
, struct object_context
*oc
)
1766 if (flags
& GET_OID_FOLLOW_SYMLINKS
&& flags
& GET_OID_ONLY_TO_DIE
)
1767 BUG("incompatible flags for get_sha1_with_context");
1768 return get_oid_with_context_1(str
, flags
, NULL
, oid
, oc
);