object.h 5.01 KB
Newer Older
1 2 3 4 5 6 7 8
#ifndef OBJECT_H
#define OBJECT_H

struct object_list {
	struct object *item;
	struct object_list *next;
};

9 10 11 12 13
struct object_array {
	unsigned int nr;
	unsigned int alloc;
	struct object_array_entry {
		struct object *item;
14 15 16 17 18 19 20
		/*
		 * name or NULL.  If non-NULL, the memory pointed to
		 * is owned by this object *except* if it points at
		 * object_array_slopbuf, which is a static copy of the
		 * empty string.
		 */
		char *name;
21
		char *path;
22
		unsigned mode;
23 24 25
	} *objects;
};

26 27
#define OBJECT_ARRAY_INIT { 0, 0, NULL }

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 36 37 38 39 40
 * builtin/blame.c:               12-13
 * bisect.c:                               16
 * bundle.c:                               16
 * http-push.c:                            16-----19
 * commit.c:                               16-----19
 * sha1_name.c:                                     20
41
 * list-objects-filter.c:                             21
42
 * builtin/fsck.c:  0--3
43
 */
44 45
#define FLAG_BITS  27

46 47 48
/*
 * The object type is stored in 3 bits.
 */
49 50
struct object {
	unsigned parsed : 1;
51 52
	unsigned type : TYPE_BITS;
	unsigned flags : FLAG_BITS;
53
	struct object_id oid;
54 55
};

56
extern const char *type_name(unsigned int type);
57 58
extern int type_from_string_gently(const char *str, ssize_t, int gentle);
#define type_from_string(str) type_from_string_gently(str, -1, 0)
59

60 61 62
/*
 * Return the current number of buckets in the object hashmap.
 */
63
extern unsigned int get_max_object_index(void);
64 65 66 67

/*
 * Return the object from the specified bucket in the object hashmap.
 */
68
extern struct object *get_indexed_object(unsigned int);
69

Junio C Hamano's avatar
Junio C Hamano committed
70 71 72 73 74 75 76 77 78 79 80 81
/*
 * This can be used to see if we have heard of the object before, but
 * it can return "yes we have, and here is a half-initialised object"
 * for an object that we haven't loaded/parsed yet.
 *
 * When parsing a commit to create an in-core commit object, its
 * parents list holds commit objects that represent its parents, but
 * they are expected to be lazily initialized and do not know what
 * their trees or parents are yet.  When this function returns such a
 * half-initialised objects, the caller is expected to initialize them
 * by calling parse_object() on them.
 */
82
struct object *lookup_object(const unsigned char *sha1);
83

84
extern void *create_object(const unsigned char *sha1, void *obj);
85

86 87
void *object_as_type(struct object *obj, enum object_type type, int quiet);

88 89 90 91 92
/*
 * Returns the object, having parsed it to find out what it is.
 *
 * Returns NULL if the object is missing or corrupt.
 */
93
struct object *parse_object(const struct object_id *oid);
94

95 96 97
/*
 * Like parse_object, but will die() instead of returning NULL. If the
 * "name" parameter is not NULL, it is included in the error message
98
 * (otherwise, the hex object ID is given).
99
 */
100
struct object *parse_object_or_die(const struct object_id *oid, const char *name);
101

102 103 104 105
/* Given the result of read_sha1_file(), returns the object after
 * parsing it.  eaten_p indicates if the object has a borrowed copy
 * of buffer and the caller should not free() it.
 */
106
struct object *parse_object_buffer(const struct object_id *oid, enum object_type type, unsigned long size, void *buffer, int *eaten_p);
107

108 109 110
/** Returns the object, with potentially excess memory allocated. **/
struct object *lookup_unknown_object(const unsigned  char *sha1);

Junio C Hamano's avatar
Junio C Hamano committed
111
struct object_list *object_list_insert(struct object *item,
112 113 114 115
				       struct object_list **list_p);

int object_list_contains(struct object_list *list, struct object *obj);

116 117
/* Object array handling .. */
void add_object_array(struct object *obj, const char *name, struct object_array *array);
118
void add_object_array_with_path(struct object *obj, const char *name, struct object_array *array, unsigned mode, const char *path);
119

120 121 122 123 124 125 126 127
/*
 * Returns NULL if the array is empty. Otherwise, returns the last object
 * after removing its entry from the array. Other resources associated
 * with that object are left in an unspecified state and should not be
 * examined.
 */
struct object *object_array_pop(struct object_array *array);

128 129 130 131 132 133 134 135 136 137
typedef int (*object_array_each_func_t)(struct object_array_entry *, void *);

/*
 * Apply want to each entry in array, retaining only the entries for
 * which the function returns true.  Preserve the order of the entries
 * that are retained.
 */
void object_array_filter(struct object_array *array,
			 object_array_each_func_t want, void *cb_data);

138 139 140 141 142
/*
 * Remove from array all but the first entry with a given name.
 * Warning: this function uses an O(N^2) algorithm.
 */
void object_array_remove_duplicates(struct object_array *array);
143

144 145 146 147 148 149
/*
 * Remove any objects from the array, freeing all used memory; afterwards
 * the array is ready to store more objects with add_object_array().
 */
void object_array_clear(struct object_array *array);

150 151
void clear_object_flags(unsigned flags);

152 153 154 155 156
/*
 * Clear the specified object flags from all in-core commit objects.
 */
extern void clear_commit_marks_all(unsigned int flags);

157
#endif /* OBJECT_H */