object: add repository argument to create_object
[git/git.git] / object.h
1 #ifndef OBJECT_H
2 #define OBJECT_H
3
4 struct parsed_object_pool {
5 struct object **obj_hash;
6 int nr_objs, obj_hash_size;
7 };
8
9 struct parsed_object_pool *parsed_object_pool_new(void);
10 void parsed_object_pool_clear(struct parsed_object_pool *o);
11
12 struct object_list {
13 struct object *item;
14 struct object_list *next;
15 };
16
17 struct object_array {
18 unsigned int nr;
19 unsigned int alloc;
20 struct object_array_entry {
21 struct object *item;
22 /*
23 * name or NULL. If non-NULL, the memory pointed to
24 * is owned by this object *except* if it points at
25 * object_array_slopbuf, which is a static copy of the
26 * empty string.
27 */
28 char *name;
29 char *path;
30 unsigned mode;
31 } *objects;
32 };
33
34 #define OBJECT_ARRAY_INIT { 0, 0, NULL }
35
36 #define TYPE_BITS 3
37 /*
38 * object flag allocation:
39 * revision.h: 0---------10 26
40 * fetch-pack.c: 0----5
41 * walker.c: 0-2
42 * upload-pack.c: 4 11----------------19
43 * builtin/blame.c: 12-13
44 * bisect.c: 16
45 * bundle.c: 16
46 * http-push.c: 16-----19
47 * commit.c: 16-----19
48 * sha1_name.c: 20
49 * list-objects-filter.c: 21
50 * builtin/fsck.c: 0--3
51 * builtin/index-pack.c: 2021
52 * builtin/pack-objects.c: 20
53 * builtin/reflog.c: 10--12
54 * builtin/unpack-objects.c: 2021
55 */
56 #define FLAG_BITS 27
57
58 /*
59 * The object type is stored in 3 bits.
60 */
61 struct object {
62 unsigned parsed : 1;
63 unsigned type : TYPE_BITS;
64 unsigned flags : FLAG_BITS;
65 struct object_id oid;
66 };
67
68 extern const char *type_name(unsigned int type);
69 extern int type_from_string_gently(const char *str, ssize_t, int gentle);
70 #define type_from_string(str) type_from_string_gently(str, -1, 0)
71
72 /*
73 * Return the current number of buckets in the object hashmap.
74 */
75 extern unsigned int get_max_object_index(void);
76
77 /*
78 * Return the object from the specified bucket in the object hashmap.
79 */
80 extern struct object *get_indexed_object(unsigned int);
81
82 /*
83 * This can be used to see if we have heard of the object before, but
84 * it can return "yes we have, and here is a half-initialised object"
85 * for an object that we haven't loaded/parsed yet.
86 *
87 * When parsing a commit to create an in-core commit object, its
88 * parents list holds commit objects that represent its parents, but
89 * they are expected to be lazily initialized and do not know what
90 * their trees or parents are yet. When this function returns such a
91 * half-initialised objects, the caller is expected to initialize them
92 * by calling parse_object() on them.
93 */
94 struct object *lookup_object(const unsigned char *sha1);
95
96 #define create_object(r, s, o) create_object_##r(s, o)
97 extern void *create_object_the_repository(const unsigned char *sha1, void *obj);
98
99 void *object_as_type(struct object *obj, enum object_type type, int quiet);
100
101 /*
102 * Returns the object, having parsed it to find out what it is.
103 *
104 * Returns NULL if the object is missing or corrupt.
105 */
106 struct object *parse_object(const struct object_id *oid);
107
108 /*
109 * Like parse_object, but will die() instead of returning NULL. If the
110 * "name" parameter is not NULL, it is included in the error message
111 * (otherwise, the hex object ID is given).
112 */
113 struct object *parse_object_or_die(const struct object_id *oid, const char *name);
114
115 /* Given the result of read_sha1_file(), returns the object after
116 * parsing it. eaten_p indicates if the object has a borrowed copy
117 * of buffer and the caller should not free() it.
118 */
119 struct object *parse_object_buffer(const struct object_id *oid, enum object_type type, unsigned long size, void *buffer, int *eaten_p);
120
121 /** Returns the object, with potentially excess memory allocated. **/
122 struct object *lookup_unknown_object(const unsigned char *sha1);
123
124 struct object_list *object_list_insert(struct object *item,
125 struct object_list **list_p);
126
127 int object_list_contains(struct object_list *list, struct object *obj);
128
129 /* Object array handling .. */
130 void add_object_array(struct object *obj, const char *name, struct object_array *array);
131 void add_object_array_with_path(struct object *obj, const char *name, struct object_array *array, unsigned mode, const char *path);
132
133 /*
134 * Returns NULL if the array is empty. Otherwise, returns the last object
135 * after removing its entry from the array. Other resources associated
136 * with that object are left in an unspecified state and should not be
137 * examined.
138 */
139 struct object *object_array_pop(struct object_array *array);
140
141 typedef int (*object_array_each_func_t)(struct object_array_entry *, void *);
142
143 /*
144 * Apply want to each entry in array, retaining only the entries for
145 * which the function returns true. Preserve the order of the entries
146 * that are retained.
147 */
148 void object_array_filter(struct object_array *array,
149 object_array_each_func_t want, void *cb_data);
150
151 /*
152 * Remove from array all but the first entry with a given name.
153 * Warning: this function uses an O(N^2) algorithm.
154 */
155 void object_array_remove_duplicates(struct object_array *array);
156
157 /*
158 * Remove any objects from the array, freeing all used memory; afterwards
159 * the array is ready to store more objects with add_object_array().
160 */
161 void object_array_clear(struct object_array *array);
162
163 void clear_object_flags(unsigned flags);
164
165 /*
166 * Clear the specified object flags from all in-core commit objects.
167 */
168 extern void clear_commit_marks_all(unsigned int flags);
169
170 #endif /* OBJECT_H */