Merge branch 'sg/test-bash-version-fix'
[git.git] / object.h
blob796792cb32a7ae86b253df05671e1ed4736e4d15
1 #ifndef OBJECT_H
2 #define OBJECT_H
4 #include "cache.h"
6 struct buffer_slab;
8 struct parsed_object_pool {
9 struct object **obj_hash;
10 int nr_objs, obj_hash_size;
12 /* TODO: migrate alloc_states to mem-pool? */
13 struct alloc_state *blob_state;
14 struct alloc_state *tree_state;
15 struct alloc_state *commit_state;
16 struct alloc_state *tag_state;
17 struct alloc_state *object_state;
18 unsigned commit_count;
20 /* parent substitutions from .git/info/grafts and .git/shallow */
21 struct commit_graft **grafts;
22 int grafts_alloc, grafts_nr;
24 int is_shallow;
25 struct stat_validity *shallow_stat;
26 char *alternate_shallow_file;
28 int commit_graft_prepared;
30 struct buffer_slab *buffer_slab;
33 struct parsed_object_pool *parsed_object_pool_new(void);
34 void parsed_object_pool_clear(struct parsed_object_pool *o);
36 struct object_list {
37 struct object *item;
38 struct object_list *next;
41 struct object_array {
42 unsigned int nr;
43 unsigned int alloc;
44 struct object_array_entry {
45 struct object *item;
47 * name or NULL. If non-NULL, the memory pointed to
48 * is owned by this object *except* if it points at
49 * object_array_slopbuf, which is a static copy of the
50 * empty string.
52 char *name;
53 char *path;
54 unsigned mode;
55 } *objects;
58 #define OBJECT_ARRAY_INIT { 0, 0, NULL }
61 * object flag allocation:
62 * revision.h: 0---------10 25----28
63 * fetch-pack.c: 01
64 * negotiator/default.c: 2--5
65 * walker.c: 0-2
66 * upload-pack.c: 4 11-----14 16-----19
67 * builtin/blame.c: 12-13
68 * bisect.c: 16
69 * bundle.c: 16
70 * http-push.c: 16-----19
71 * commit-reach.c: 15-------19
72 * sha1-name.c: 20
73 * list-objects-filter.c: 21
74 * builtin/fsck.c: 0--3
75 * builtin/index-pack.c: 2021
76 * builtin/pack-objects.c: 20
77 * builtin/reflog.c: 10--12
78 * builtin/show-branch.c: 0-------------------------------------------26
79 * builtin/unpack-objects.c: 2021
81 #define FLAG_BITS 29
84 * The object type is stored in 3 bits.
86 struct object {
87 unsigned parsed : 1;
88 unsigned type : TYPE_BITS;
89 unsigned flags : FLAG_BITS;
90 struct object_id oid;
93 extern const char *type_name(unsigned int type);
94 extern int type_from_string_gently(const char *str, ssize_t, int gentle);
95 #define type_from_string(str) type_from_string_gently(str, -1, 0)
98 * Return the current number of buckets in the object hashmap.
100 extern unsigned int get_max_object_index(void);
103 * Return the object from the specified bucket in the object hashmap.
105 extern struct object *get_indexed_object(unsigned int);
108 * This can be used to see if we have heard of the object before, but
109 * it can return "yes we have, and here is a half-initialised object"
110 * for an object that we haven't loaded/parsed yet.
112 * When parsing a commit to create an in-core commit object, its
113 * parents list holds commit objects that represent its parents, but
114 * they are expected to be lazily initialized and do not know what
115 * their trees or parents are yet. When this function returns such a
116 * half-initialised objects, the caller is expected to initialize them
117 * by calling parse_object() on them.
119 struct object *lookup_object(struct repository *r, const unsigned char *sha1);
121 extern void *create_object(struct repository *r, const unsigned char *sha1, void *obj);
123 void *object_as_type(struct repository *r, struct object *obj, enum object_type type, int quiet);
126 * Returns the object, having parsed it to find out what it is.
128 * Returns NULL if the object is missing or corrupt.
130 struct object *parse_object(struct repository *r, const struct object_id *oid);
133 * Like parse_object, but will die() instead of returning NULL. If the
134 * "name" parameter is not NULL, it is included in the error message
135 * (otherwise, the hex object ID is given).
137 struct object *parse_object_or_die(const struct object_id *oid, const char *name);
139 /* Given the result of read_sha1_file(), returns the object after
140 * parsing it. eaten_p indicates if the object has a borrowed copy
141 * of buffer and the caller should not free() it.
143 struct object *parse_object_buffer(struct repository *r, const struct object_id *oid, enum object_type type, unsigned long size, void *buffer, int *eaten_p);
145 /** Returns the object, with potentially excess memory allocated. **/
146 struct object *lookup_unknown_object(const unsigned char *sha1);
148 struct object_list *object_list_insert(struct object *item,
149 struct object_list **list_p);
151 int object_list_contains(struct object_list *list, struct object *obj);
153 /* Object array handling .. */
154 void add_object_array(struct object *obj, const char *name, struct object_array *array);
155 void add_object_array_with_path(struct object *obj, const char *name, struct object_array *array, unsigned mode, const char *path);
158 * Returns NULL if the array is empty. Otherwise, returns the last object
159 * after removing its entry from the array. Other resources associated
160 * with that object are left in an unspecified state and should not be
161 * examined.
163 struct object *object_array_pop(struct object_array *array);
165 typedef int (*object_array_each_func_t)(struct object_array_entry *, void *);
168 * Apply want to each entry in array, retaining only the entries for
169 * which the function returns true. Preserve the order of the entries
170 * that are retained.
172 void object_array_filter(struct object_array *array,
173 object_array_each_func_t want, void *cb_data);
176 * Remove from array all but the first entry with a given name.
177 * Warning: this function uses an O(N^2) algorithm.
179 void object_array_remove_duplicates(struct object_array *array);
182 * Remove any objects from the array, freeing all used memory; afterwards
183 * the array is ready to store more objects with add_object_array().
185 void object_array_clear(struct object_array *array);
187 void clear_object_flags(unsigned flags);
190 * Clear the specified object flags from all in-core commit objects.
192 extern void clear_commit_marks_all(unsigned int flags);
194 #endif /* OBJECT_H */