Merge branch 'cb/maint-orphan-merge-noclobber'
[git/kirr.git] / object.h
blob4d1d61546f0441bd198cda3ad153b35a91444b72
1 #ifndef OBJECT_H
2 #define OBJECT_H
4 struct object_list {
5 struct object *item;
6 struct object_list *next;
7 };
9 struct object_refs {
10 unsigned count;
11 struct object *ref[FLEX_ARRAY]; /* more */
14 struct object_array {
15 unsigned int nr;
16 unsigned int alloc;
17 struct object_array_entry {
18 struct object *item;
19 const char *name;
20 unsigned mode;
21 } *objects;
24 #define OBJECT_ARRAY_INIT { 0, 0, NULL }
26 #define TYPE_BITS 3
27 #define FLAG_BITS 27
30 * The object type is stored in 3 bits.
32 struct object {
33 unsigned parsed : 1;
34 unsigned used : 1;
35 unsigned type : TYPE_BITS;
36 unsigned flags : FLAG_BITS;
37 unsigned char sha1[20];
40 extern const char *typename(unsigned int type);
41 extern int type_from_string(const char *str);
43 extern unsigned int get_max_object_index(void);
44 extern struct object *get_indexed_object(unsigned int);
47 * This can be used to see if we have heard of the object before, but
48 * it can return "yes we have, and here is a half-initialised object"
49 * for an object that we haven't loaded/parsed yet.
51 * When parsing a commit to create an in-core commit object, its
52 * parents list holds commit objects that represent its parents, but
53 * they are expected to be lazily initialized and do not know what
54 * their trees or parents are yet. When this function returns such a
55 * half-initialised objects, the caller is expected to initialize them
56 * by calling parse_object() on them.
58 struct object *lookup_object(const unsigned char *sha1);
60 extern void *create_object(const unsigned char *sha1, int type, void *obj);
62 /** Returns the object, having parsed it to find out what it is. **/
63 struct object *parse_object(const unsigned char *sha1);
65 /* Given the result of read_sha1_file(), returns the object after
66 * parsing it. eaten_p indicates if the object has a borrowed copy
67 * of buffer and the caller should not free() it.
69 struct object *parse_object_buffer(const unsigned char *sha1, enum object_type type, unsigned long size, void *buffer, int *eaten_p);
71 /** Returns the object, with potentially excess memory allocated. **/
72 struct object *lookup_unknown_object(const unsigned char *sha1);
74 struct object_list *object_list_insert(struct object *item,
75 struct object_list **list_p);
77 int object_list_contains(struct object_list *list, struct object *obj);
79 /* Object array handling .. */
80 void add_object_array(struct object *obj, const char *name, struct object_array *array);
81 void add_object_array_with_mode(struct object *obj, const char *name, struct object_array *array, unsigned mode);
82 void object_array_remove_duplicates(struct object_array *);
84 #endif /* OBJECT_H */