Gitweb: make line number toggling work for Firefox and Safari
[git/mingw/4msysgit.git] / object.h
blobdc5df8ce1d9579a28477f91300aa7a49f37ad4e4
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;
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.
20 char *name;
21 unsigned mode;
22 struct object_context *context;
23 } *objects;
26 #define OBJECT_ARRAY_INIT { 0, 0, NULL }
28 #define TYPE_BITS 3
29 #define FLAG_BITS 27
32 * The object type is stored in 3 bits.
34 struct object {
35 unsigned parsed : 1;
36 unsigned used : 1;
37 unsigned type : TYPE_BITS;
38 unsigned flags : FLAG_BITS;
39 unsigned char sha1[20];
42 extern const char *typename(unsigned int type);
43 extern int type_from_string(const char *str);
45 extern unsigned int get_max_object_index(void);
46 extern struct object *get_indexed_object(unsigned int);
49 * This can be used to see if we have heard of the object before, but
50 * it can return "yes we have, and here is a half-initialised object"
51 * for an object that we haven't loaded/parsed yet.
53 * When parsing a commit to create an in-core commit object, its
54 * parents list holds commit objects that represent its parents, but
55 * they are expected to be lazily initialized and do not know what
56 * their trees or parents are yet. When this function returns such a
57 * half-initialised objects, the caller is expected to initialize them
58 * by calling parse_object() on them.
60 struct object *lookup_object(const unsigned char *sha1);
62 extern void *create_object(const unsigned char *sha1, int type, void *obj);
65 * Returns the object, having parsed it to find out what it is.
67 * Returns NULL if the object is missing or corrupt.
69 struct object *parse_object(const unsigned char *sha1);
72 * Like parse_object, but will die() instead of returning NULL. If the
73 * "name" parameter is not NULL, it is included in the error message
74 * (otherwise, the sha1 hex is given).
76 struct object *parse_object_or_die(const unsigned char *sha1, const char *name);
78 /* Given the result of read_sha1_file(), returns the object after
79 * parsing it. eaten_p indicates if the object has a borrowed copy
80 * of buffer and the caller should not free() it.
82 struct object *parse_object_buffer(const unsigned char *sha1, enum object_type type, unsigned long size, void *buffer, int *eaten_p);
84 /** Returns the object, with potentially excess memory allocated. **/
85 struct object *lookup_unknown_object(const unsigned char *sha1);
87 struct object_list *object_list_insert(struct object *item,
88 struct object_list **list_p);
90 int object_list_contains(struct object_list *list, struct object *obj);
92 /* Object array handling .. */
93 void add_object_array(struct object *obj, const char *name, struct object_array *array);
94 void add_object_array_with_mode(struct object *obj, const char *name, struct object_array *array, unsigned mode);
95 void add_object_array_with_context(struct object *obj, const char *name, struct object_array *array, struct object_context *context);
97 typedef int (*object_array_each_func_t)(struct object_array_entry *, void *);
100 * Apply want to each entry in array, retaining only the entries for
101 * which the function returns true. Preserve the order of the entries
102 * that are retained.
104 void object_array_filter(struct object_array *array,
105 object_array_each_func_t want, void *cb_data);
108 * Remove from array all but the first entry with a given name.
109 * Warning: this function uses an O(N^2) algorithm.
111 void object_array_remove_duplicates(struct object_array *array);
113 void clear_object_flags(unsigned flags);
115 #endif /* OBJECT_H */