commit.c: allow get_cached_commit_buffer to handle arbitrary repositories
[git/git.git] / object.h
CommitLineData
6eb8ae00
DB
1#ifndef OBJECT_H
2#define OBJECT_H
3
65ea9d4b
SB
4struct buffer_slab;
5
99bf115c
SB
6struct parsed_object_pool {
7 struct object **obj_hash;
8 int nr_objs, obj_hash_size;
14ba97f8
SB
9
10 /* TODO: migrate alloc_states to mem-pool? */
11 struct alloc_state *blob_state;
12 struct alloc_state *tree_state;
13 struct alloc_state *commit_state;
14 struct alloc_state *tag_state;
15 struct alloc_state *object_state;
16 unsigned commit_count;
6a1a79fd
JN
17
18 /* parent substitutions from .git/info/grafts and .git/shallow */
19 struct commit_graft **grafts;
20 int grafts_alloc, grafts_nr;
eee4502b
SB
21
22 int is_shallow;
23 struct stat_validity *shallow_stat;
24 char *alternate_shallow_file;
2f6c767f
SB
25
26 int commit_graft_prepared;
65ea9d4b
SB
27
28 struct buffer_slab *buffer_slab;
99bf115c
SB
29};
30
31struct parsed_object_pool *parsed_object_pool_new(void);
32void parsed_object_pool_clear(struct parsed_object_pool *o);
33
6eb8ae00
DB
34struct object_list {
35 struct object *item;
36 struct object_list *next;
37};
38
1f1e895f
LT
39struct object_array {
40 unsigned int nr;
41 unsigned int alloc;
42 struct object_array_entry {
43 struct object *item;
31faeb20
MH
44 /*
45 * name or NULL. If non-NULL, the memory pointed to
46 * is owned by this object *except* if it points at
47 * object_array_slopbuf, which is a static copy of the
48 * empty string.
49 */
50 char *name;
9e0c3c4f 51 char *path;
e5709a4a 52 unsigned mode;
1f1e895f
LT
53 } *objects;
54};
55
3cd47459
TF
56#define OBJECT_ARRAY_INIT { 0, 0, NULL }
57
208acbfb
NTND
58/*
59 * object flag allocation:
3d1cf1e8
NTND
60 * revision.h: 0---------10 26
61 * fetch-pack.c: 0----5
62 * walker.c: 0-2
63 * upload-pack.c: 4 11----------------19
64 * builtin/blame.c: 12-13
65 * bisect.c: 16
66 * bundle.c: 16
67 * http-push.c: 16-----19
68 * commit.c: 16-----19
e5e5e088 69 * sha1-name.c: 20
3d1cf1e8
NTND
70 * list-objects-filter.c: 21
71 * builtin/fsck.c: 0--3
72 * builtin/index-pack.c: 2021
73 * builtin/pack-objects.c: 20
74 * builtin/reflog.c: 10--12
44cecbf8 75 * builtin/show-branch.c: 0-------------------------------------------26
3d1cf1e8 76 * builtin/unpack-objects.c: 2021
208acbfb 77 */
885a86ab
LT
78#define FLAG_BITS 27
79
1974632c
LT
80/*
81 * The object type is stored in 3 bits.
82 */
6eb8ae00
DB
83struct object {
84 unsigned parsed : 1;
885a86ab
LT
85 unsigned type : TYPE_BITS;
86 unsigned flags : FLAG_BITS;
f2fd0760 87 struct object_id oid;
6eb8ae00
DB
88};
89
debca9d2 90extern const char *type_name(unsigned int type);
fe8e3b71
JS
91extern int type_from_string_gently(const char *str, ssize_t, int gentle);
92#define type_from_string(str) type_from_string_gently(str, -1, 0)
885a86ab 93
33bef7ea
MH
94/*
95 * Return the current number of buckets in the object hashmap.
96 */
fc046a75 97extern unsigned int get_max_object_index(void);
33bef7ea
MH
98
99/*
100 * Return the object from the specified bucket in the object hashmap.
101 */
fc046a75 102extern struct object *get_indexed_object(unsigned int);
3e4339e6 103
628b06d7
JH
104/*
105 * This can be used to see if we have heard of the object before, but
106 * it can return "yes we have, and here is a half-initialised object"
107 * for an object that we haven't loaded/parsed yet.
108 *
109 * When parsing a commit to create an in-core commit object, its
110 * parents list holds commit objects that represent its parents, but
111 * they are expected to be lazily initialized and do not know what
112 * their trees or parents are yet. When this function returns such a
113 * half-initialised objects, the caller is expected to initialize them
114 * by calling parse_object() on them.
115 */
94c09a71 116struct object *lookup_object(struct repository *r, const unsigned char *sha1);
6eb8ae00 117
341e45e4 118extern void *create_object(struct repository *r, const unsigned char *sha1, void *obj);
6eb8ae00 119
a962da1e 120void *object_as_type(struct repository *r, struct object *obj, enum object_type type, int quiet);
8ff226a9 121
75a95490
JK
122/*
123 * Returns the object, having parsed it to find out what it is.
124 *
125 * Returns NULL if the object is missing or corrupt.
126 */
109cd76d
SB
127#define parse_object(r, oid) parse_object_##r(oid)
128struct object *parse_object_the_repository(const struct object_id *oid);
e9eefa67 129
75a95490
JK
130/*
131 * Like parse_object, but will die() instead of returning NULL. If the
132 * "name" parameter is not NULL, it is included in the error message
c251c83d 133 * (otherwise, the hex object ID is given).
75a95490 134 */
c251c83d 135struct object *parse_object_or_die(const struct object_id *oid, const char *name);
75a95490 136
9f613ddd
JH
137/* Given the result of read_sha1_file(), returns the object after
138 * parsing it. eaten_p indicates if the object has a borrowed copy
139 * of buffer and the caller should not free() it.
140 */
1ec5bfd2
SB
141#define parse_object_buffer(r, o, t, s, b, e) parse_object_buffer_##r(o, t, s, b, e)
142struct object *parse_object_buffer_the_repository(const struct object_id *oid, enum object_type type, unsigned long size, void *buffer, int *eaten_p);
9f613ddd 143
66e481b0
DB
144/** Returns the object, with potentially excess memory allocated. **/
145struct object *lookup_unknown_object(const unsigned char *sha1);
146
a6080a0a 147struct object_list *object_list_insert(struct object *item,
66e481b0
DB
148 struct object_list **list_p);
149
66e481b0
DB
150int object_list_contains(struct object_list *list, struct object *obj);
151
1f1e895f
LT
152/* Object array handling .. */
153void add_object_array(struct object *obj, const char *name, struct object_array *array);
9e0c3c4f 154void add_object_array_with_path(struct object *obj, const char *name, struct object_array *array, unsigned mode, const char *path);
aeb4a51e 155
71992039
156/*
157 * Returns NULL if the array is empty. Otherwise, returns the last object
158 * after removing its entry from the array. Other resources associated
159 * with that object are left in an unspecified state and should not be
160 * examined.
161 */
162struct object *object_array_pop(struct object_array *array);
163
aeb4a51e
MH
164typedef int (*object_array_each_func_t)(struct object_array_entry *, void *);
165
166/*
167 * Apply want to each entry in array, retaining only the entries for
168 * which the function returns true. Preserve the order of the entries
169 * that are retained.
170 */
171void object_array_filter(struct object_array *array,
172 object_array_each_func_t want, void *cb_data);
173
1506510c
MH
174/*
175 * Remove from array all but the first entry with a given name.
176 * Warning: this function uses an O(N^2) algorithm.
177 */
178void object_array_remove_duplicates(struct object_array *array);
1f1e895f 179
46be8231
JK
180/*
181 * Remove any objects from the array, freeing all used memory; afterwards
182 * the array is ready to store more objects with add_object_array().
183 */
184void object_array_clear(struct object_array *array);
185
bcc0a3ea
HV
186void clear_object_flags(unsigned flags);
187
4ad315fc
RS
188/*
189 * Clear the specified object flags from all in-core commit objects.
190 */
191extern void clear_commit_marks_all(unsigned int flags);
192
6eb8ae00 193#endif /* OBJECT_H */