Git 1.7.12.4
[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
1f1e895f
LT
9struct object_array {
10 unsigned int nr;
11 unsigned int alloc;
12 struct object_array_entry {
13 struct object *item;
14 const char *name;
e5709a4a 15 unsigned mode;
1f1e895f
LT
16 } *objects;
17};
18
3cd47459
TF
19#define OBJECT_ARRAY_INIT { 0, 0, NULL }
20
885a86ab
LT
21#define TYPE_BITS 3
22#define FLAG_BITS 27
23
1974632c
LT
24/*
25 * The object type is stored in 3 bits.
26 */
6eb8ae00
DB
27struct object {
28 unsigned parsed : 1;
29 unsigned used : 1;
885a86ab
LT
30 unsigned type : TYPE_BITS;
31 unsigned flags : FLAG_BITS;
6eb8ae00 32 unsigned char sha1[20];
6eb8ae00
DB
33};
34
df843662
NP
35extern const char *typename(unsigned int type);
36extern int type_from_string(const char *str);
885a86ab 37
fc046a75
LT
38extern unsigned int get_max_object_index(void);
39extern struct object *get_indexed_object(unsigned int);
3e4339e6 40
628b06d7
JH
41/*
42 * This can be used to see if we have heard of the object before, but
43 * it can return "yes we have, and here is a half-initialised object"
44 * for an object that we haven't loaded/parsed yet.
45 *
46 * When parsing a commit to create an in-core commit object, its
47 * parents list holds commit objects that represent its parents, but
48 * they are expected to be lazily initialized and do not know what
49 * their trees or parents are yet. When this function returns such a
50 * half-initialised objects, the caller is expected to initialize them
51 * by calling parse_object() on them.
52 */
5d6ccf5c 53struct object *lookup_object(const unsigned char *sha1);
6eb8ae00 54
100c5f3b 55extern void *create_object(const unsigned char *sha1, int type, void *obj);
6eb8ae00 56
e9eefa67 57/** Returns the object, having parsed it to find out what it is. **/
5d6ccf5c 58struct object *parse_object(const unsigned char *sha1);
e9eefa67 59
9f613ddd
JH
60/* Given the result of read_sha1_file(), returns the object after
61 * parsing it. eaten_p indicates if the object has a borrowed copy
62 * of buffer and the caller should not free() it.
63 */
21666f1a 64struct object *parse_object_buffer(const unsigned char *sha1, enum object_type type, unsigned long size, void *buffer, int *eaten_p);
9f613ddd 65
66e481b0
DB
66/** Returns the object, with potentially excess memory allocated. **/
67struct object *lookup_unknown_object(const unsigned char *sha1);
68
a6080a0a 69struct object_list *object_list_insert(struct object *item,
66e481b0
DB
70 struct object_list **list_p);
71
66e481b0
DB
72int object_list_contains(struct object_list *list, struct object *obj);
73
1f1e895f
LT
74/* Object array handling .. */
75void add_object_array(struct object *obj, const char *name, struct object_array *array);
e5709a4a 76void add_object_array_with_mode(struct object *obj, const char *name, struct object_array *array, unsigned mode);
b2a6d1c6 77void object_array_remove_duplicates(struct object_array *);
1f1e895f 78
bcc0a3ea
HV
79void clear_object_flags(unsigned flags);
80
6eb8ae00 81#endif /* OBJECT_H */