Add a generic "object decorator" interface, and make object refs use it
[git/git.git] / object.h
CommitLineData
6eb8ae00
DB
1#ifndef OBJECT_H
2#define OBJECT_H
3
4struct object_list {
5 struct object *item;
6 struct object_list *next;
7};
8
27dedf0c
JH
9struct object_refs {
10 unsigned count;
8f1d2e6f 11 struct object *ref[FLEX_ARRAY]; /* more */
27dedf0c
JH
12};
13
1f1e895f
LT
14struct object_array {
15 unsigned int nr;
16 unsigned int alloc;
17 struct object_array_entry {
18 struct object *item;
19 const char *name;
20 } *objects;
21};
22
885a86ab
LT
23#define TYPE_BITS 3
24#define FLAG_BITS 27
25
1974632c
LT
26/*
27 * The object type is stored in 3 bits.
28 */
6eb8ae00
DB
29struct object {
30 unsigned parsed : 1;
31 unsigned used : 1;
885a86ab
LT
32 unsigned type : TYPE_BITS;
33 unsigned flags : FLAG_BITS;
6eb8ae00 34 unsigned char sha1[20];
6eb8ae00
DB
35};
36
8805ccac 37extern int track_object_refs;
df843662
NP
38
39extern const char *typename(unsigned int type);
40extern int type_from_string(const char *str);
885a86ab 41
fc046a75
LT
42extern unsigned int get_max_object_index(void);
43extern struct object *get_indexed_object(unsigned int);
3e4339e6
LT
44extern struct object_refs *lookup_object_refs(struct object *);
45
89e4202f 46/** Internal only **/
5d6ccf5c 47struct object *lookup_object(const unsigned char *sha1);
6eb8ae00 48
5d6ccf5c 49void created_object(const unsigned char *sha1, struct object *obj);
6eb8ae00 50
e9eefa67 51/** Returns the object, having parsed it to find out what it is. **/
5d6ccf5c 52struct object *parse_object(const unsigned char *sha1);
e9eefa67 53
9f613ddd
JH
54/* Given the result of read_sha1_file(), returns the object after
55 * parsing it. eaten_p indicates if the object has a borrowed copy
56 * of buffer and the caller should not free() it.
57 */
21666f1a 58struct object *parse_object_buffer(const unsigned char *sha1, enum object_type type, unsigned long size, void *buffer, int *eaten_p);
9f613ddd 59
66e481b0
DB
60/** Returns the object, with potentially excess memory allocated. **/
61struct object *lookup_unknown_object(const unsigned char *sha1);
62
27dedf0c
JH
63struct object_refs *alloc_object_refs(unsigned count);
64void set_object_refs(struct object *obj, struct object_refs *refs);
6eb8ae00
DB
65
66void mark_reachable(struct object *obj, unsigned int mask);
67
66e481b0
DB
68struct object_list *object_list_insert(struct object *item,
69 struct object_list **list_p);
70
680bab3d
DB
71void object_list_append(struct object *item,
72 struct object_list **list_p);
73
66e481b0
DB
74unsigned object_list_length(struct object_list *list);
75
76int object_list_contains(struct object_list *list, struct object *obj);
77
1f1e895f
LT
78/* Object array handling .. */
79void add_object_array(struct object *obj, const char *name, struct object_array *array);
80
6eb8ae00 81#endif /* OBJECT_H */