[thirdparty/git.git] / object.h

#ifndef OBJECT_H
#define OBJECT_H

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

struct object_array {
	unsigned int nr;
	unsigned int alloc;
	struct object_array_entry {
		struct object *item;
		/*
		 * 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;
		char *path;
		unsigned mode;
	} *objects;
};

#define OBJECT_ARRAY_INIT { 0, 0, NULL }

#define TYPE_BITS   3
/*
 * object flag allocation:
 * revision.h:      0---------10                                26
 * fetch-pack.c:    0---4
 * walker.c:        0-2
 * upload-pack.c:               11----------------19
 * builtin/blame.c:               12-13
 * bisect.c:                               16
 * bundle.c:                               16
 * http-push.c:                            16-----19
 * commit.c:                               16-----19
 * sha1_name.c:                                     20
 */
#define FLAG_BITS  27

/*
 * The object type is stored in 3 bits.
 */
struct object {
	unsigned parsed : 1;
	unsigned used : 1;
	unsigned type : TYPE_BITS;
	unsigned flags : FLAG_BITS;
	struct object_id oid;
};

extern const char *typename(unsigned int type);
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)

/*
 * Return the current number of buckets in the object hashmap.
 */
extern unsigned int get_max_object_index(void);

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

/*
 * 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.
 */
struct object *lookup_object(const unsigned char *sha1);

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

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

/*
 * Returns the object, having parsed it to find out what it is.
 *
 * Returns NULL if the object is missing or corrupt.
 */
struct object *parse_object(const unsigned char *sha1);

/*
 * Like parse_object, but will die() instead of returning NULL. If the
 * "name" parameter is not NULL, it is included in the error message
 * (otherwise, the sha1 hex is given).
 */
struct object *parse_object_or_die(const unsigned char *sha1, const char *name);

/* 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.
 */
struct object *parse_object_buffer(const unsigned char *sha1, enum object_type type, unsigned long size, void *buffer, int *eaten_p);

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

struct object_list *object_list_insert(struct object *item,
				       struct object_list **list_p);

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

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

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);

/*
 * 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);

/*
 * 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);

void clear_object_flags(unsigned flags);

#endif /* OBJECT_H */
Commit	Line	Data
	1	#ifndef OBJECT_H
	2	#define OBJECT_H
	3
	4	struct object_list {
	5	struct object *item;
	6	struct object_list *next;
	7	};
	8
	9	struct 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---4
	33	* walker.c: 0-2
	34	* upload-pack.c: 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	*/
	42	#define FLAG_BITS 27
	43
	44	/*
	45	* The object type is stored in 3 bits.
	46	*/
	47	struct object {
	48	unsigned parsed : 1;
	49	unsigned used : 1;
	50	unsigned type : TYPE_BITS;
	51	unsigned flags : FLAG_BITS;
	52	struct object_id oid;
	53	};
	54
	55	extern const char *typename(unsigned int type);
	56	extern 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	*/
	62	extern unsigned int get_max_object_index(void);
	63
	64	/*
	65	* Return the object from the specified bucket in the object hashmap.
	66	*/
	67	extern 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	*/
	81	struct object lookup_object(const unsigned char sha1);
	82
	83	extern void create_object(const unsigned char sha1, void *obj);
	84
	85	void 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	*/
	92	struct object parse_object(const unsigned char sha1);
	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 sha1 hex is given).
	98	*/
	99	struct object parse_object_or_die(const unsigned char sha1, 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	*/
	105	struct object parse_object_buffer(const unsigned char sha1, enum object_type type, unsigned long size, void buffer, int eaten_p);
	106
	107	/ Returns the object, with potentially excess memory allocated. /
	108	struct object lookup_unknown_object(const unsigned char sha1);
	109
	110	struct object_list object_list_insert(struct object item,
	111	struct object_list **list_p);
	112
	113	int object_list_contains(struct object_list list, struct object obj);
	114
	115	/* Object array handling .. */
	116	void add_object_array(struct object obj, const char name, struct object_array *array);
	117	void add_object_array_with_path(struct object obj, const char name, struct object_array array, unsigned mode, const char path);
	118
	119	typedef int (object_array_each_func_t)(struct object_array_entry , void *);
	120
	121	/*
	122	* Apply want to each entry in array, retaining only the entries for
	123	* which the function returns true. Preserve the order of the entries
	124	* that are retained.
	125	*/
	126	void object_array_filter(struct object_array *array,
	127	object_array_each_func_t want, void *cb_data);
	128
	129	/*
	130	* Remove from array all but the first entry with a given name.
	131	* Warning: this function uses an O(N^2) algorithm.
	132	*/
	133	void object_array_remove_duplicates(struct object_array *array);
	134
	135	/*
	136	* Remove any objects from the array, freeing all used memory; afterwards
	137	* the array is ready to store more objects with add_object_array().
	138	*/
	139	void object_array_clear(struct object_array *array);
	140
	141	void clear_object_flags(unsigned flags);
	142
	143	#endif /* OBJECT_H */