Add git-for-each-ref: helper for language bindings
[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 struct object {
31 unsigned parsed : 1;
32 unsigned used : 1;
33 unsigned type : TYPE_BITS;
34 unsigned flags : FLAG_BITS;
35 unsigned char sha1[20];
36 };
37
38 extern int track_object_refs;
39 extern const char *type_names[9];
40
41 extern unsigned int get_max_object_index(void);
42 extern struct object *get_indexed_object(unsigned int);
43
44 static inline const char *typename(unsigned int type)
45 {
46 return type_names[type > OBJ_BAD ? OBJ_BAD : type];
47 }
48
49 extern struct object_refs *lookup_object_refs(struct object *);
50
51 /** Internal only **/
52 struct object *lookup_object(const unsigned char *sha1);
53
54 /** Returns the object, having looked it up as being the given type. **/
55 struct object *lookup_object_type(const unsigned char *sha1, const char *type);
56
57 void created_object(const unsigned char *sha1, struct object *obj);
58
59 /** Returns the object, having parsed it to find out what it is. **/
60 struct object *parse_object(const unsigned char *sha1);
61
62 /* Given the result of read_sha1_file(), returns the object after
63 * parsing it. eaten_p indicates if the object has a borrowed copy
64 * of buffer and the caller should not free() it.
65 */
66 struct object *parse_object_buffer(const unsigned char *sha1, const char *type, unsigned long size, void *buffer, int *eaten_p);
67
68 /** Returns the object, with potentially excess memory allocated. **/
69 struct object *lookup_unknown_object(const unsigned char *sha1);
70
71 struct object_refs *alloc_object_refs(unsigned count);
72 void set_object_refs(struct object *obj, struct object_refs *refs);
73
74 void mark_reachable(struct object *obj, unsigned int mask);
75
76 struct object_list *object_list_insert(struct object *item,
77 struct object_list **list_p);
78
79 void object_list_append(struct object *item,
80 struct object_list **list_p);
81
82 unsigned object_list_length(struct object_list *list);
83
84 int object_list_contains(struct object_list *list, struct object *obj);
85
86 /* Object array handling .. */
87 void add_object_array(struct object *obj, const char *name, struct object_array *array);
88
89 #endif /* OBJECT_H */