Git 1.9-rc0
[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;
31faeb20
MH
14 /*
15 * name or NULL. If non-NULL, the memory pointed to
16 * is owned by this object *except* if it points at
17 * object_array_slopbuf, which is a static copy of the
18 * empty string.
19 */
20 char *name;
e5709a4a 21 unsigned mode;
afa15f3c 22 struct object_context *context;
1f1e895f
LT
23 } *objects;
24};
25
3cd47459
TF
26#define OBJECT_ARRAY_INIT { 0, 0, NULL }
27
885a86ab
LT
28#define TYPE_BITS 3
29#define FLAG_BITS 27
30
1974632c
LT
31/*
32 * The object type is stored in 3 bits.
33 */
6eb8ae00
DB
34struct object {
35 unsigned parsed : 1;
36 unsigned used : 1;
885a86ab
LT
37 unsigned type : TYPE_BITS;
38 unsigned flags : FLAG_BITS;
6eb8ae00 39 unsigned char sha1[20];
6eb8ae00
DB
40};
41
df843662
NP
42extern const char *typename(unsigned int type);
43extern int type_from_string(const char *str);
885a86ab 44
fc046a75
LT
45extern unsigned int get_max_object_index(void);
46extern struct object *get_indexed_object(unsigned int);
3e4339e6 47
628b06d7
JH
48/*
49 * This can be used to see if we have heard of the object before, but
50 * it can return "yes we have, and here is a half-initialised object"
51 * for an object that we haven't loaded/parsed yet.
52 *
53 * When parsing a commit to create an in-core commit object, its
54 * parents list holds commit objects that represent its parents, but
55 * they are expected to be lazily initialized and do not know what
56 * their trees or parents are yet. When this function returns such a
57 * half-initialised objects, the caller is expected to initialize them
58 * by calling parse_object() on them.
59 */
5d6ccf5c 60struct object *lookup_object(const unsigned char *sha1);
6eb8ae00 61
100c5f3b 62extern void *create_object(const unsigned char *sha1, int type, void *obj);
6eb8ae00 63
75a95490
JK
64/*
65 * Returns the object, having parsed it to find out what it is.
66 *
67 * Returns NULL if the object is missing or corrupt.
68 */
5d6ccf5c 69struct object *parse_object(const unsigned char *sha1);
e9eefa67 70
75a95490
JK
71/*
72 * Like parse_object, but will die() instead of returning NULL. If the
73 * "name" parameter is not NULL, it is included in the error message
74 * (otherwise, the sha1 hex is given).
75 */
76struct object *parse_object_or_die(const unsigned char *sha1, const char *name);
77
9f613ddd
JH
78/* Given the result of read_sha1_file(), returns the object after
79 * parsing it. eaten_p indicates if the object has a borrowed copy
80 * of buffer and the caller should not free() it.
81 */
21666f1a 82struct object *parse_object_buffer(const unsigned char *sha1, enum object_type type, unsigned long size, void *buffer, int *eaten_p);
9f613ddd 83
66e481b0
DB
84/** Returns the object, with potentially excess memory allocated. **/
85struct object *lookup_unknown_object(const unsigned char *sha1);
86
a6080a0a 87struct object_list *object_list_insert(struct object *item,
66e481b0
DB
88 struct object_list **list_p);
89
66e481b0
DB
90int object_list_contains(struct object_list *list, struct object *obj);
91
1f1e895f
LT
92/* Object array handling .. */
93void add_object_array(struct object *obj, const char *name, struct object_array *array);
e5709a4a 94void add_object_array_with_mode(struct object *obj, const char *name, struct object_array *array, unsigned mode);
afa15f3c 95void add_object_array_with_context(struct object *obj, const char *name, struct object_array *array, struct object_context *context);
aeb4a51e
MH
96
97typedef int (*object_array_each_func_t)(struct object_array_entry *, void *);
98
99/*
100 * Apply want to each entry in array, retaining only the entries for
101 * which the function returns true. Preserve the order of the entries
102 * that are retained.
103 */
104void object_array_filter(struct object_array *array,
105 object_array_each_func_t want, void *cb_data);
106
1506510c
MH
107/*
108 * Remove from array all but the first entry with a given name.
109 * Warning: this function uses an O(N^2) algorithm.
110 */
111void object_array_remove_duplicates(struct object_array *array);
1f1e895f 112
bcc0a3ea
HV
113void clear_object_flags(unsigned flags);
114
6eb8ae00 115#endif /* OBJECT_H */