formalize typename(), and add its reverse type_from_string()
[git/git.git] / object.h
CommitLineData
6eb8ae00
DB
1#ifndef OBJECT_H
2#define OBJECT_H
3
4struct object_list {
5 struct object *item;
6 struct object_list *next;
7};
8
27dedf0c
JH
9struct object_refs {
10 unsigned count;
3e4339e6 11 struct object *base;
8f1d2e6f 12 struct object *ref[FLEX_ARRAY]; /* more */
27dedf0c
JH
13};
14
1f1e895f
LT
15struct 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
885a86ab
LT
24#define TYPE_BITS 3
25#define FLAG_BITS 27
26
1974632c
LT
27/*
28 * The object type is stored in 3 bits.
29 */
6eb8ae00
DB
30struct object {
31 unsigned parsed : 1;
32 unsigned used : 1;
885a86ab
LT
33 unsigned type : TYPE_BITS;
34 unsigned flags : FLAG_BITS;
6eb8ae00 35 unsigned char sha1[20];
6eb8ae00
DB
36};
37
8805ccac 38extern int track_object_refs;
df843662
NP
39
40extern const char *typename(unsigned int type);
41extern int type_from_string(const char *str);
885a86ab 42
fc046a75
LT
43extern unsigned int get_max_object_index(void);
44extern struct object *get_indexed_object(unsigned int);
3e4339e6
LT
45extern struct object_refs *lookup_object_refs(struct object *);
46
89e4202f 47/** Internal only **/
5d6ccf5c 48struct object *lookup_object(const unsigned char *sha1);
6eb8ae00 49
89e4202f
DB
50/** Returns the object, having looked it up as being the given type. **/
51struct object *lookup_object_type(const unsigned char *sha1, const char *type);
52
5d6ccf5c 53void created_object(const unsigned char *sha1, struct object *obj);
6eb8ae00 54
e9eefa67 55/** Returns the object, having parsed it to find out what it is. **/
5d6ccf5c 56struct object *parse_object(const unsigned char *sha1);
e9eefa67 57
9f613ddd
JH
58/* Given the result of read_sha1_file(), returns the object after
59 * parsing it. eaten_p indicates if the object has a borrowed copy
60 * of buffer and the caller should not free() it.
61 */
62struct object *parse_object_buffer(const unsigned char *sha1, const char *type, unsigned long size, void *buffer, int *eaten_p);
63
66e481b0
DB
64/** Returns the object, with potentially excess memory allocated. **/
65struct object *lookup_unknown_object(const unsigned char *sha1);
66
27dedf0c
JH
67struct object_refs *alloc_object_refs(unsigned count);
68void set_object_refs(struct object *obj, struct object_refs *refs);
6eb8ae00
DB
69
70void mark_reachable(struct object *obj, unsigned int mask);
71
66e481b0
DB
72struct object_list *object_list_insert(struct object *item,
73 struct object_list **list_p);
74
680bab3d
DB
75void object_list_append(struct object *item,
76 struct object_list **list_p);
77
66e481b0
DB
78unsigned object_list_length(struct object_list *list);
79
80int object_list_contains(struct object_list *list, struct object *obj);
81
1f1e895f
LT
82/* Object array handling .. */
83void add_object_array(struct object *obj, const char *name, struct object_array *array);
84
6eb8ae00 85#endif /* OBJECT_H */