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