]>
Commit | Line | Data |
---|---|---|
6eb8ae00 DB |
1 | #ifndef OBJECT_H |
2 | #define OBJECT_H | |
3 | ||
a64215b6 | 4 | #include "hash.h" |
ef3ca954 | 5 | |
65ea9d4b SB |
6 | struct buffer_slab; |
7 | ||
99bf115c SB |
8 | struct parsed_object_pool { |
9 | struct object **obj_hash; | |
10 | int nr_objs, obj_hash_size; | |
14ba97f8 SB |
11 | |
12 | /* TODO: migrate alloc_states to mem-pool? */ | |
13 | struct alloc_state *blob_state; | |
14 | struct alloc_state *tree_state; | |
15 | struct alloc_state *commit_state; | |
16 | struct alloc_state *tag_state; | |
17 | struct alloc_state *object_state; | |
6a1a79fd JN |
18 | |
19 | /* parent substitutions from .git/info/grafts and .git/shallow */ | |
20 | struct commit_graft **grafts; | |
21 | int grafts_alloc, grafts_nr; | |
eee4502b SB |
22 | |
23 | int is_shallow; | |
24 | struct stat_validity *shallow_stat; | |
25 | char *alternate_shallow_file; | |
2f6c767f SB |
26 | |
27 | int commit_graft_prepared; | |
ce16364e | 28 | int substituted_parent; |
65ea9d4b SB |
29 | |
30 | struct buffer_slab *buffer_slab; | |
99bf115c SB |
31 | }; |
32 | ||
33 | struct parsed_object_pool *parsed_object_pool_new(void); | |
34 | void parsed_object_pool_clear(struct parsed_object_pool *o); | |
35 | ||
6eb8ae00 DB |
36 | struct object_list { |
37 | struct object *item; | |
38 | struct object_list *next; | |
39 | }; | |
40 | ||
1f1e895f LT |
41 | struct object_array { |
42 | unsigned int nr; | |
43 | unsigned int alloc; | |
44 | struct object_array_entry { | |
45 | struct object *item; | |
31faeb20 MH |
46 | /* |
47 | * name or NULL. If non-NULL, the memory pointed to | |
48 | * is owned by this object *except* if it points at | |
49 | * object_array_slopbuf, which is a static copy of the | |
50 | * empty string. | |
51 | */ | |
52 | char *name; | |
9e0c3c4f | 53 | char *path; |
e5709a4a | 54 | unsigned mode; |
1f1e895f LT |
55 | } *objects; |
56 | }; | |
57 | ||
9865b6e6 | 58 | #define OBJECT_ARRAY_INIT { 0 } |
3cd47459 | 59 | |
208acbfb NTND |
60 | /* |
61 | * object flag allocation: | |
257418c5 | 62 | * revision.h: 0---------10 15 23------27 |
9c1e657a | 63 | * fetch-pack.c: 01 67 |
ec062838 | 64 | * negotiator/default.c: 2--5 |
3d1cf1e8 | 65 | * walker.c: 0-2 |
ba3ca1ed | 66 | * upload-pack.c: 4 11-----14 16-----19 |
3d1cf1e8 NTND |
67 | * builtin/blame.c: 12-13 |
68 | * bisect.c: 16 | |
69 | * bundle.c: 16 | |
64472d15 | 70 | * http-push.c: 11-----14 |
cb99a34e DS |
71 | * commit-graph.c: 15 |
72 | * commit-reach.c: 16-----19 | |
e5e5e088 | 73 | * sha1-name.c: 20 |
3d1cf1e8 NTND |
74 | * list-objects-filter.c: 21 |
75 | * builtin/fsck.c: 0--3 | |
4ddc79b2 | 76 | * builtin/gc.c: 0 |
3d1cf1e8 | 77 | * builtin/index-pack.c: 2021 |
7d3d226e | 78 | * reflog.c: 10--12 |
44cecbf8 | 79 | * builtin/show-branch.c: 0-------------------------------------------26 |
3d1cf1e8 | 80 | * builtin/unpack-objects.c: 2021 |
208acbfb | 81 | */ |
23c4319f | 82 | #define FLAG_BITS 28 |
885a86ab | 83 | |
a64215b6 EN |
84 | #define TYPE_BITS 3 |
85 | ||
86 | /* | |
87 | * Values in this enum (except those outside the 3 bit range) are part | |
88 | * of pack file format. See gitformat-pack(5) for more information. | |
89 | */ | |
90 | enum object_type { | |
91 | OBJ_BAD = -1, | |
92 | OBJ_NONE = 0, | |
93 | OBJ_COMMIT = 1, | |
94 | OBJ_TREE = 2, | |
95 | OBJ_BLOB = 3, | |
96 | OBJ_TAG = 4, | |
97 | /* 5 for future expansion */ | |
98 | OBJ_OFS_DELTA = 6, | |
99 | OBJ_REF_DELTA = 7, | |
100 | OBJ_ANY, | |
101 | OBJ_MAX | |
102 | }; | |
103 | ||
1974632c LT |
104 | /* |
105 | * The object type is stored in 3 bits. | |
106 | */ | |
6eb8ae00 DB |
107 | struct object { |
108 | unsigned parsed : 1; | |
885a86ab LT |
109 | unsigned type : TYPE_BITS; |
110 | unsigned flags : FLAG_BITS; | |
f2fd0760 | 111 | struct object_id oid; |
6eb8ae00 DB |
112 | }; |
113 | ||
55454427 DL |
114 | const char *type_name(unsigned int type); |
115 | int type_from_string_gently(const char *str, ssize_t, int gentle); | |
fe8e3b71 | 116 | #define type_from_string(str) type_from_string_gently(str, -1, 0) |
885a86ab | 117 | |
33bef7ea MH |
118 | /* |
119 | * Return the current number of buckets in the object hashmap. | |
120 | */ | |
55454427 | 121 | unsigned int get_max_object_index(void); |
33bef7ea MH |
122 | |
123 | /* | |
124 | * Return the object from the specified bucket in the object hashmap. | |
125 | */ | |
55454427 | 126 | struct object *get_indexed_object(unsigned int); |
3e4339e6 | 127 | |
628b06d7 JH |
128 | /* |
129 | * This can be used to see if we have heard of the object before, but | |
130 | * it can return "yes we have, and here is a half-initialised object" | |
131 | * for an object that we haven't loaded/parsed yet. | |
132 | * | |
133 | * When parsing a commit to create an in-core commit object, its | |
134 | * parents list holds commit objects that represent its parents, but | |
135 | * they are expected to be lazily initialized and do not know what | |
136 | * their trees or parents are yet. When this function returns such a | |
137 | * half-initialised objects, the caller is expected to initialize them | |
138 | * by calling parse_object() on them. | |
139 | */ | |
d0229abd | 140 | struct object *lookup_object(struct repository *r, const struct object_id *oid); |
6eb8ae00 | 141 | |
a378509e | 142 | void *create_object(struct repository *r, const struct object_id *oid, void *obj); |
6eb8ae00 | 143 | |
6da43d93 | 144 | void *object_as_type(struct object *obj, enum object_type type, int quiet); |
8ff226a9 | 145 | |
75a95490 JK |
146 | /* |
147 | * Returns the object, having parsed it to find out what it is. | |
148 | * | |
149 | * Returns NULL if the object is missing or corrupt. | |
150 | */ | |
c868d8e9 JK |
151 | enum parse_object_flags { |
152 | PARSE_OBJECT_SKIP_HASH_CHECK = 1 << 0, | |
153 | }; | |
8e4b0b60 | 154 | struct object *parse_object(struct repository *r, const struct object_id *oid); |
c868d8e9 JK |
155 | struct object *parse_object_with_flags(struct repository *r, |
156 | const struct object_id *oid, | |
157 | enum parse_object_flags flags); | |
e9eefa67 | 158 | |
75a95490 JK |
159 | /* |
160 | * Like parse_object, but will die() instead of returning NULL. If the | |
161 | * "name" parameter is not NULL, it is included in the error message | |
c251c83d | 162 | * (otherwise, the hex object ID is given). |
75a95490 | 163 | */ |
c251c83d | 164 | struct object *parse_object_or_die(const struct object_id *oid, const char *name); |
75a95490 | 165 | |
9f613ddd JH |
166 | /* Given the result of read_sha1_file(), returns the object after |
167 | * parsing it. eaten_p indicates if the object has a borrowed copy | |
168 | * of buffer and the caller should not free() it. | |
169 | */ | |
108ed1a3 | 170 | struct object *parse_object_buffer(struct repository *r, const struct object_id *oid, enum object_type type, unsigned long size, void *buffer, int *eaten_p); |
9f613ddd | 171 | |
542d6abb JK |
172 | /* |
173 | * Allocate and return an object struct, even if you do not know the type of | |
174 | * the object. The returned object may have its "type" field set to a real type | |
175 | * (if somebody previously called lookup_blob(), etc), or it may be set to | |
176 | * OBJ_NONE. In the latter case, subsequent calls to lookup_blob(), etc, will | |
177 | * set the type field as appropriate. | |
178 | * | |
179 | * Use this when you do not know the expected type of an object and want to | |
180 | * avoid parsing it for efficiency reasons. Try to avoid it otherwise; it | |
181 | * may allocate excess memory, since the returned object must be as large as | |
182 | * the maximum struct of any type. | |
183 | */ | |
45a187cc | 184 | struct object *lookup_unknown_object(struct repository *r, const struct object_id *oid); |
66e481b0 | 185 | |
7463064b JK |
186 | /* |
187 | * Dispatch to the appropriate lookup_blob(), lookup_commit(), etc, based on | |
188 | * "type". | |
189 | */ | |
190 | struct object *lookup_object_by_type(struct repository *r, const struct object_id *oid, | |
191 | enum object_type type); | |
192 | ||
a6080a0a | 193 | struct object_list *object_list_insert(struct object *item, |
66e481b0 DB |
194 | struct object_list **list_p); |
195 | ||
66e481b0 DB |
196 | int object_list_contains(struct object_list *list, struct object *obj); |
197 | ||
acac50dd JK |
198 | void object_list_free(struct object_list **list); |
199 | ||
1f1e895f LT |
200 | /* Object array handling .. */ |
201 | void add_object_array(struct object *obj, const char *name, struct object_array *array); | |
9e0c3c4f | 202 | void add_object_array_with_path(struct object *obj, const char *name, struct object_array *array, unsigned mode, const char *path); |
aeb4a51e | 203 | |
71992039 MÅ |
204 | /* |
205 | * Returns NULL if the array is empty. Otherwise, returns the last object | |
206 | * after removing its entry from the array. Other resources associated | |
207 | * with that object are left in an unspecified state and should not be | |
208 | * examined. | |
209 | */ | |
210 | struct object *object_array_pop(struct object_array *array); | |
211 | ||
aeb4a51e MH |
212 | typedef int (*object_array_each_func_t)(struct object_array_entry *, void *); |
213 | ||
214 | /* | |
215 | * Apply want to each entry in array, retaining only the entries for | |
216 | * which the function returns true. Preserve the order of the entries | |
217 | * that are retained. | |
218 | */ | |
219 | void object_array_filter(struct object_array *array, | |
220 | object_array_each_func_t want, void *cb_data); | |
221 | ||
1506510c MH |
222 | /* |
223 | * Remove from array all but the first entry with a given name. | |
224 | * Warning: this function uses an O(N^2) algorithm. | |
225 | */ | |
226 | void object_array_remove_duplicates(struct object_array *array); | |
1f1e895f | 227 | |
46be8231 JK |
228 | /* |
229 | * Remove any objects from the array, freeing all used memory; afterwards | |
230 | * the array is ready to store more objects with add_object_array(). | |
231 | */ | |
232 | void object_array_clear(struct object_array *array); | |
233 | ||
bcc0a3ea HV |
234 | void clear_object_flags(unsigned flags); |
235 | ||
4ad315fc | 236 | /* |
cd888845 RS |
237 | * Clear the specified object flags from all in-core commit objects from |
238 | * the specified repository. | |
4ad315fc | 239 | */ |
cd888845 | 240 | void repo_clear_commit_marks(struct repository *r, unsigned int flags); |
4ad315fc | 241 | |
6eb8ae00 | 242 | #endif /* OBJECT_H */ |