Documentation: point git-prune users to git-gc
[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                 unsigned mode;
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 const char *typename(unsigned int type);
39 extern int type_from_string(const char *str);
40
41 extern unsigned int get_max_object_index(void);
42 extern struct object *get_indexed_object(unsigned int);
43
44 /** Internal only **/
45 struct object *lookup_object(const unsigned char *sha1);
46
47 extern void *create_object(const unsigned char *sha1, int type, void *obj);
48
49 /** Returns the object, having parsed it to find out what it is. **/
50 struct object *parse_object(const unsigned char *sha1);
51
52 /* Given the result of read_sha1_file(), returns the object after
53  * parsing it.  eaten_p indicates if the object has a borrowed copy
54  * of buffer and the caller should not free() it.
55  */
56 struct object *parse_object_buffer(const unsigned char *sha1, enum object_type type, unsigned long size, void *buffer, int *eaten_p);
57
58 /** Returns the object, with potentially excess memory allocated. **/
59 struct object *lookup_unknown_object(const unsigned  char *sha1);
60
61 struct object_list *object_list_insert(struct object *item,
62                                        struct object_list **list_p);
63
64 void object_list_append(struct object *item,
65                         struct object_list **list_p);
66
67 unsigned object_list_length(struct object_list *list);
68
69 int object_list_contains(struct object_list *list, struct object *obj);
70
71 /* Object array handling .. */
72 void add_object_array(struct object *obj, const char *name, struct object_array *array);
73 void add_object_array_with_mode(struct object *obj, const char *name, struct object_array *array, unsigned mode);
74
75 #endif /* OBJECT_H */