commit.c: allow get_cached_commit_buffer to handle arbitrary repositories
[git/git.git] / object.h
1 #ifndef OBJECT_H
2 #define OBJECT_H
3
4 struct buffer_slab;
5
6 struct parsed_object_pool {
7 struct object **obj_hash;
8 int nr_objs, obj_hash_size;
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;
17
18 /* parent substitutions from .git/info/grafts and .git/shallow */
19 struct commit_graft **grafts;
20 int grafts_alloc, grafts_nr;
21
22 int is_shallow;
23 struct stat_validity *shallow_stat;
24 char *alternate_shallow_file;
25
26 int commit_graft_prepared;
27
28 struct buffer_slab *buffer_slab;
29 };
30
31 struct parsed_object_pool *parsed_object_pool_new(void);
32 void parsed_object_pool_clear(struct parsed_object_pool *o);
33
34 struct object_list {
35 struct object *item;
36 struct object_list *next;
37 };
38
39 struct object_array {
40 unsigned int nr;
41 unsigned int alloc;
42 struct object_array_entry {
43 struct object *item;
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;
51 char *path;
52 unsigned mode;
53 } *objects;
54 };
55
56 #define OBJECT_ARRAY_INIT { 0, 0, NULL }
57
58 /*
59 * object flag allocation:
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
69 * sha1-name.c: 20
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
75 * builtin/show-branch.c: 0-------------------------------------------26
76 * builtin/unpack-objects.c: 2021
77 */
78 #define FLAG_BITS 27
79
80 /*
81 * The object type is stored in 3 bits.
82 */
83 struct object {
84 unsigned parsed : 1;
85 unsigned type : TYPE_BITS;
86 unsigned flags : FLAG_BITS;
87 struct object_id oid;
88 };
89
90 extern const char *type_name(unsigned int type);
91 extern 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)
93
94 /*
95 * Return the current number of buckets in the object hashmap.
96 */
97 extern unsigned int get_max_object_index(void);
98
99 /*
100 * Return the object from the specified bucket in the object hashmap.
101 */
102 extern struct object *get_indexed_object(unsigned int);
103
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 */
116 struct object *lookup_object(struct repository *r, const unsigned char *sha1);
117
118 extern void *create_object(struct repository *r, const unsigned char *sha1, void *obj);
119
120 void *object_as_type(struct repository *r, struct object *obj, enum object_type type, int quiet);
121
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 */
127 #define parse_object(r, oid) parse_object_##r(oid)
128 struct object *parse_object_the_repository(const struct object_id *oid);
129
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
133 * (otherwise, the hex object ID is given).
134 */
135 struct object *parse_object_or_die(const struct object_id *oid, const char *name);
136
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 */
141 #define parse_object_buffer(r, o, t, s, b, e) parse_object_buffer_##r(o, t, s, b, e)
142 struct object *parse_object_buffer_the_repository(const struct object_id *oid, enum object_type type, unsigned long size, void *buffer, int *eaten_p);
143
144 /** Returns the object, with potentially excess memory allocated. **/
145 struct object *lookup_unknown_object(const unsigned char *sha1);
146
147 struct object_list *object_list_insert(struct object *item,
148 struct object_list **list_p);
149
150 int object_list_contains(struct object_list *list, struct object *obj);
151
152 /* Object array handling .. */
153 void add_object_array(struct object *obj, const char *name, struct object_array *array);
154 void add_object_array_with_path(struct object *obj, const char *name, struct object_array *array, unsigned mode, const char *path);
155
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 */
162 struct object *object_array_pop(struct object_array *array);
163
164 typedef 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 */
171 void object_array_filter(struct object_array *array,
172 object_array_each_func_t want, void *cb_data);
173
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 */
178 void object_array_remove_duplicates(struct object_array *array);
179
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 */
184 void object_array_clear(struct object_array *array);
185
186 void clear_object_flags(unsigned flags);
187
188 /*
189 * Clear the specified object flags from all in-core commit objects.
190 */
191 extern void clear_commit_marks_all(unsigned int flags);
192
193 #endif /* OBJECT_H */