The eleventh (aka "ort") batch
[git.git] / object.h
blob59daadce21453c707bb439d047725b40d95f153d
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;
19 /* parent substitutions from .git/info/grafts and .git/shallow */
20 struct commit_graft **grafts;
21 int grafts_alloc, grafts_nr;
23 int is_shallow;
24 struct stat_validity *shallow_stat;
25 char *alternate_shallow_file;
27 int commit_graft_prepared;
28 int substituted_parent;
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 15 23------26
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: 11-----14
71 * commit-graph.c: 15
72 * commit-reach.c: 16-----19
73 * sha1-name.c: 20
74 * list-objects-filter.c: 21
75 * builtin/fsck.c: 0--3
76 * builtin/gc.c: 0
77 * builtin/index-pack.c: 2021
78 * builtin/pack-objects.c: 20
79 * builtin/reflog.c: 10--12
80 * builtin/show-branch.c: 0-------------------------------------------26
81 * builtin/unpack-objects.c: 2021
83 #define FLAG_BITS 28
86 * The object type is stored in 3 bits.
88 struct object {
89 unsigned parsed : 1;
90 unsigned type : TYPE_BITS;
91 unsigned flags : FLAG_BITS;
92 struct object_id oid;
95 const char *type_name(unsigned int type);
96 int type_from_string_gently(const char *str, ssize_t, int gentle);
97 #define type_from_string(str) type_from_string_gently(str, -1, 0)
100 * Return the current number of buckets in the object hashmap.
102 unsigned int get_max_object_index(void);
105 * Return the object from the specified bucket in the object hashmap.
107 struct object *get_indexed_object(unsigned int);
110 * This can be used to see if we have heard of the object before, but
111 * it can return "yes we have, and here is a half-initialised object"
112 * for an object that we haven't loaded/parsed yet.
114 * When parsing a commit to create an in-core commit object, its
115 * parents list holds commit objects that represent its parents, but
116 * they are expected to be lazily initialized and do not know what
117 * their trees or parents are yet. When this function returns such a
118 * half-initialised objects, the caller is expected to initialize them
119 * by calling parse_object() on them.
121 struct object *lookup_object(struct repository *r, const struct object_id *oid);
123 void *create_object(struct repository *r, const struct object_id *oid, void *obj);
125 void *object_as_type(struct object *obj, enum object_type type, int quiet);
128 * Returns the object, having parsed it to find out what it is.
130 * Returns NULL if the object is missing or corrupt.
132 struct object *parse_object(struct repository *r, const struct object_id *oid);
135 * Like parse_object, but will die() instead of returning NULL. If the
136 * "name" parameter is not NULL, it is included in the error message
137 * (otherwise, the hex object ID is given).
139 struct object *parse_object_or_die(const struct object_id *oid, const char *name);
141 /* Given the result of read_sha1_file(), returns the object after
142 * parsing it. eaten_p indicates if the object has a borrowed copy
143 * of buffer and the caller should not free() it.
145 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);
147 /** Returns the object, with potentially excess memory allocated. **/
148 struct object *lookup_unknown_object(const struct object_id *oid);
150 struct object_list *object_list_insert(struct object *item,
151 struct object_list **list_p);
153 int object_list_contains(struct object_list *list, struct object *obj);
155 void object_list_free(struct object_list **list);
157 /* Object array handling .. */
158 void add_object_array(struct object *obj, const char *name, struct object_array *array);
159 void add_object_array_with_path(struct object *obj, const char *name, struct object_array *array, unsigned mode, const char *path);
162 * Returns NULL if the array is empty. Otherwise, returns the last object
163 * after removing its entry from the array. Other resources associated
164 * with that object are left in an unspecified state and should not be
165 * examined.
167 struct object *object_array_pop(struct object_array *array);
169 typedef int (*object_array_each_func_t)(struct object_array_entry *, void *);
172 * Apply want to each entry in array, retaining only the entries for
173 * which the function returns true. Preserve the order of the entries
174 * that are retained.
176 void object_array_filter(struct object_array *array,
177 object_array_each_func_t want, void *cb_data);
180 * Remove from array all but the first entry with a given name.
181 * Warning: this function uses an O(N^2) algorithm.
183 void object_array_remove_duplicates(struct object_array *array);
186 * Remove any objects from the array, freeing all used memory; afterwards
187 * the array is ready to store more objects with add_object_array().
189 void object_array_clear(struct object_array *array);
191 void clear_object_flags(unsigned flags);
194 * Clear the specified object flags from all in-core commit objects from
195 * the specified repository.
197 void repo_clear_commit_marks(struct repository *r, unsigned int flags);
199 #endif /* OBJECT_H */