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