Add a generic "object decorator" interface, and make object refs use it
[git/git.git] / object.h
1 #ifndef OBJECT_H
2 #define OBJECT_H
3
4 struct object_list {
5 struct object *item;
6 struct object_list *next;
7 };
8
9 struct object_refs {
10 unsigned count;
11 struct object *ref[FLEX_ARRAY]; /* more */
12 };
13
14 struct 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
23 #define TYPE_BITS 3
24 #define FLAG_BITS 27
25
26 /*
27 * The object type is stored in 3 bits.
28 */
29 struct object {
30 unsigned parsed : 1;
31 unsigned used : 1;
32 unsigned type : TYPE_BITS;
33 unsigned flags : FLAG_BITS;
34 unsigned char sha1[20];
35 };
36
37 extern int track_object_refs;
38
39 extern const char *typename(unsigned int type);
40 extern int type_from_string(const char *str);
41
42 extern unsigned int get_max_object_index(void);
43 extern struct object *get_indexed_object(unsigned int);
44 extern struct object_refs *lookup_object_refs(struct object *);
45
46 /** Internal only **/
47 struct object *lookup_object(const unsigned char *sha1);
48
49 void created_object(const unsigned char *sha1, struct object *obj);
50
51 /** Returns the object, having parsed it to find out what it is. **/
52 struct object *parse_object(const unsigned char *sha1);
53
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 */
58 struct object *parse_object_buffer(const unsigned char *sha1, enum object_type type, unsigned long size, void *buffer, int *eaten_p);
59
60 /** Returns the object, with potentially excess memory allocated. **/
61 struct object *lookup_unknown_object(const unsigned char *sha1);
62
63 struct object_refs *alloc_object_refs(unsigned count);
64 void set_object_refs(struct object *obj, struct object_refs *refs);
65
66 void mark_reachable(struct object *obj, unsigned int mask);
67
68 struct object_list *object_list_insert(struct object *item,
69 struct object_list **list_p);
70
71 void object_list_append(struct object *item,
72 struct object_list **list_p);
73
74 unsigned object_list_length(struct object_list *list);
75
76 int object_list_contains(struct object_list *list, struct object *obj);
77
78 /* Object array handling .. */
79 void add_object_array(struct object *obj, const char *name, struct object_array *array);
80
81 #endif /* OBJECT_H */