Remove TYPE_* constant macros and use object_type enums consistently.
[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 *base;
12 struct object *ref[FLEX_ARRAY]; /* more */
13 };
14
15 struct object_array {
16 unsigned int nr;
17 unsigned int alloc;
18 struct object_array_entry {
19 struct object *item;
20 const char *name;
21 } *objects;
22 };
23
24 #define TYPE_BITS 3
25 #define FLAG_BITS 27
26
27 /*
28 * The object type is stored in 3 bits.
29 */
30 enum object_type {
31 OBJ_NONE = 0,
32 OBJ_COMMIT = 1,
33 OBJ_TREE = 2,
34 OBJ_BLOB = 3,
35 OBJ_TAG = 4,
36 /* 5/6 for future expansion */
37 OBJ_DELTA = 7,
38 OBJ_BAD,
39 };
40
41 struct object {
42 unsigned parsed : 1;
43 unsigned used : 1;
44 unsigned type : TYPE_BITS;
45 unsigned flags : FLAG_BITS;
46 unsigned char sha1[20];
47 };
48
49 extern int track_object_refs;
50 extern const char *type_names[9];
51
52 extern unsigned int get_max_object_index(void);
53 extern struct object *get_indexed_object(unsigned int);
54
55 static inline const char *typename(unsigned int type)
56 {
57 return type_names[type > OBJ_BAD ? OBJ_BAD : type];
58 }
59
60 extern struct object_refs *lookup_object_refs(struct object *);
61
62 /** Internal only **/
63 struct object *lookup_object(const unsigned char *sha1);
64
65 /** Returns the object, having looked it up as being the given type. **/
66 struct object *lookup_object_type(const unsigned char *sha1, const char *type);
67
68 void created_object(const unsigned char *sha1, struct object *obj);
69
70 /** Returns the object, having parsed it to find out what it is. **/
71 struct object *parse_object(const unsigned char *sha1);
72
73 /** Returns the object, with potentially excess memory allocated. **/
74 struct object *lookup_unknown_object(const unsigned char *sha1);
75
76 struct object_refs *alloc_object_refs(unsigned count);
77 void set_object_refs(struct object *obj, struct object_refs *refs);
78
79 void mark_reachable(struct object *obj, unsigned int mask);
80
81 struct object_list *object_list_insert(struct object *item,
82 struct object_list **list_p);
83
84 void object_list_append(struct object *item,
85 struct object_list **list_p);
86
87 unsigned object_list_length(struct object_list *list);
88
89 int object_list_contains(struct object_list *list, struct object *obj);
90
91 /* Object array handling .. */
92 void add_object_array(struct object *obj, const char *name, struct object_array *array);
93
94 #endif /* OBJECT_H */