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