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