git-fast-import.txt: --relative-marks takes no parameter
[git/dscho.git] / object.h
blobb6618d92bf04d549350d83b6237770c48734686f
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_array {
10         unsigned int nr;
11         unsigned int alloc;
12         struct object_array_entry {
13                 struct object *item;
14                 const char *name;
15                 unsigned mode;
16         } *objects;
19 #define OBJECT_ARRAY_INIT { 0, 0, NULL }
21 #define TYPE_BITS   3
22 #define FLAG_BITS  27
25  * The object type is stored in 3 bits.
26  */
27 struct object {
28         unsigned parsed : 1;
29         unsigned used : 1;
30         unsigned type : TYPE_BITS;
31         unsigned flags : FLAG_BITS;
32         unsigned char sha1[20];
35 extern const char *typename(unsigned int type);
36 extern int type_from_string(const char *str);
38 extern unsigned int get_max_object_index(void);
39 extern struct object *get_indexed_object(unsigned int);
42  * This can be used to see if we have heard of the object before, but
43  * it can return "yes we have, and here is a half-initialised object"
44  * for an object that we haven't loaded/parsed yet.
45  *
46  * When parsing a commit to create an in-core commit object, its
47  * parents list holds commit objects that represent its parents, but
48  * they are expected to be lazily initialized and do not know what
49  * their trees or parents are yet.  When this function returns such a
50  * half-initialised objects, the caller is expected to initialize them
51  * by calling parse_object() on them.
52  */
53 struct object *lookup_object(const unsigned char *sha1);
55 extern void *create_object(const unsigned char *sha1, int type, void *obj);
57 /** Returns the object, having parsed it to find out what it is. **/
58 struct object *parse_object(const unsigned char *sha1);
60 /* Given the result of read_sha1_file(), returns the object after
61  * parsing it.  eaten_p indicates if the object has a borrowed copy
62  * of buffer and the caller should not free() it.
63  */
64 struct object *parse_object_buffer(const unsigned char *sha1, enum object_type type, unsigned long size, void *buffer, int *eaten_p);
66 /** Returns the object, with potentially excess memory allocated. **/
67 struct object *lookup_unknown_object(const unsigned  char *sha1);
69 struct object_list *object_list_insert(struct object *item,
70                                        struct object_list **list_p);
72 int object_list_contains(struct object_list *list, struct object *obj);
74 /* Object array handling .. */
75 void add_object_array(struct object *obj, const char *name, struct object_array *array);
76 void add_object_array_with_mode(struct object *obj, const char *name, struct object_array *array, unsigned mode);
77 void object_array_remove_duplicates(struct object_array *);
79 #endif /* OBJECT_H */