Documentation/describe: improve one-line summary
[git.git] / object.h
blob6416247defa133c5c7ca43c69dfe09ae00ac03f7
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 char *path;
22 unsigned mode;
23 } *objects;
26 #define OBJECT_ARRAY_INIT { 0, 0, NULL }
28 #define TYPE_BITS 3
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
42 #define FLAG_BITS 27
45 * The object type is stored in 3 bits.
47 struct object {
48 unsigned parsed : 1;
49 unsigned used : 1;
50 unsigned type : TYPE_BITS;
51 unsigned flags : FLAG_BITS;
52 unsigned char sha1[20];
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)
60 * Return the current number of buckets in the object hashmap.
62 extern unsigned int get_max_object_index(void);
65 * Return the object from the specified bucket in the object hashmap.
67 extern struct object *get_indexed_object(unsigned int);
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.
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.
81 struct object *lookup_object(const unsigned char *sha1);
83 extern void *create_object(const unsigned char *sha1, void *obj);
85 void *object_as_type(struct object *obj, enum object_type type, int quiet);
88 * Returns the object, having parsed it to find out what it is.
90 * Returns NULL if the object is missing or corrupt.
92 struct object *parse_object(const unsigned char *sha1);
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).
99 struct object *parse_object_or_die(const unsigned char *sha1, const char *name);
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.
105 struct object *parse_object_buffer(const unsigned char *sha1, enum object_type type, unsigned long size, void *buffer, int *eaten_p);
107 /** Returns the object, with potentially excess memory allocated. **/
108 struct object *lookup_unknown_object(const unsigned char *sha1);
110 struct object_list *object_list_insert(struct object *item,
111 struct object_list **list_p);
113 int object_list_contains(struct object_list *list, struct object *obj);
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);
119 typedef int (*object_array_each_func_t)(struct object_array_entry *, void *);
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.
126 void object_array_filter(struct object_array *array,
127 object_array_each_func_t want, void *cb_data);
130 * Remove from array all but the first entry with a given name.
131 * Warning: this function uses an O(N^2) algorithm.
133 void object_array_remove_duplicates(struct object_array *array);
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().
139 void object_array_clear(struct object_array *array);
141 void clear_object_flags(unsigned flags);
143 #endif /* OBJECT_H */