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