Documentation: bisect: reword one paragraph.
[git.git] / object.h
blobbdbf0facd47015b61a6fbf25eb358b6e256c86b6
1 #ifndef OBJECT_H
2 #define OBJECT_H
4 struct object_list {
5 struct object *item;
6 struct object_list *next;
7 };
9 struct object_refs {
10 unsigned count;
11 struct object *base;
12 struct object *ref[FLEX_ARRAY]; /* more */
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;
24 #define TYPE_BITS 3
25 #define FLAG_BITS 27
28 * The object type is stored in 3 bits.
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];
38 extern int track_object_refs;
40 extern const char *typename(unsigned int type);
41 extern int type_from_string(const char *str);
43 extern unsigned int get_max_object_index(void);
44 extern struct object *get_indexed_object(unsigned int);
45 extern struct object_refs *lookup_object_refs(struct object *);
47 /** Internal only **/
48 struct object *lookup_object(const unsigned char *sha1);
50 void created_object(const unsigned char *sha1, struct object *obj);
52 /** Returns the object, having parsed it to find out what it is. **/
53 struct object *parse_object(const unsigned char *sha1);
55 /* Given the result of read_sha1_file(), returns the object after
56 * parsing it. eaten_p indicates if the object has a borrowed copy
57 * of buffer and the caller should not free() it.
59 struct object *parse_object_buffer(const unsigned char *sha1, enum object_type type, unsigned long size, void *buffer, int *eaten_p);
61 /** Returns the object, with potentially excess memory allocated. **/
62 struct object *lookup_unknown_object(const unsigned char *sha1);
64 struct object_refs *alloc_object_refs(unsigned count);
65 void set_object_refs(struct object *obj, struct object_refs *refs);
67 void mark_reachable(struct object *obj, unsigned int mask);
69 struct object_list *object_list_insert(struct object *item,
70 struct object_list **list_p);
72 void object_list_append(struct object *item,
73 struct object_list **list_p);
75 unsigned object_list_length(struct object_list *list);
77 int object_list_contains(struct object_list *list, struct object *obj);
79 /* Object array handling .. */
80 void add_object_array(struct object *obj, const char *name, struct object_array *array);
82 #endif /* OBJECT_H */