fetch-pack: introduce negotiator API
[git/git.git] / object.h
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 /*
29 * object flag allocation:
30 * revision.h: 0---------10 26
31 * fetch-pack.c: 01
32 * negotiator/default.c: 2--5
33 * walker.c: 0-2
34 * upload-pack.c: 4 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 * list-objects-filter.c: 21
42 * builtin/fsck.c: 0--3
43 * builtin/index-pack.c: 2021
44 * builtin/pack-objects.c: 20
45 * builtin/reflog.c: 10--12
46 * builtin/unpack-objects.c: 2021
47 */
48 #define FLAG_BITS 27
49
50 /*
51 * The object type is stored in 3 bits.
52 */
53 struct object {
54 unsigned parsed : 1;
55 unsigned type : TYPE_BITS;
56 unsigned flags : FLAG_BITS;
57 struct object_id oid;
58 };
59
60 extern const char *type_name(unsigned int type);
61 extern int type_from_string_gently(const char *str, ssize_t, int gentle);
62 #define type_from_string(str) type_from_string_gently(str, -1, 0)
63
64 /*
65 * Return the current number of buckets in the object hashmap.
66 */
67 extern unsigned int get_max_object_index(void);
68
69 /*
70 * Return the object from the specified bucket in the object hashmap.
71 */
72 extern struct object *get_indexed_object(unsigned int);
73
74 /*
75 * This can be used to see if we have heard of the object before, but
76 * it can return "yes we have, and here is a half-initialised object"
77 * for an object that we haven't loaded/parsed yet.
78 *
79 * When parsing a commit to create an in-core commit object, its
80 * parents list holds commit objects that represent its parents, but
81 * they are expected to be lazily initialized and do not know what
82 * their trees or parents are yet. When this function returns such a
83 * half-initialised objects, the caller is expected to initialize them
84 * by calling parse_object() on them.
85 */
86 struct object *lookup_object(const unsigned char *sha1);
87
88 extern void *create_object(const unsigned char *sha1, void *obj);
89
90 void *object_as_type(struct object *obj, enum object_type type, int quiet);
91
92 /*
93 * Returns the object, having parsed it to find out what it is.
94 *
95 * Returns NULL if the object is missing or corrupt.
96 */
97 struct object *parse_object(const struct object_id *oid);
98
99 /*
100 * Like parse_object, but will die() instead of returning NULL. If the
101 * "name" parameter is not NULL, it is included in the error message
102 * (otherwise, the hex object ID is given).
103 */
104 struct object *parse_object_or_die(const struct object_id *oid, const char *name);
105
106 /* Given the result of read_sha1_file(), returns the object after
107 * parsing it. eaten_p indicates if the object has a borrowed copy
108 * of buffer and the caller should not free() it.
109 */
110 struct object *parse_object_buffer(const struct object_id *oid, enum object_type type, unsigned long size, void *buffer, int *eaten_p);
111
112 /** Returns the object, with potentially excess memory allocated. **/
113 struct object *lookup_unknown_object(const unsigned char *sha1);
114
115 struct object_list *object_list_insert(struct object *item,
116 struct object_list **list_p);
117
118 int object_list_contains(struct object_list *list, struct object *obj);
119
120 /* Object array handling .. */
121 void add_object_array(struct object *obj, const char *name, struct object_array *array);
122 void add_object_array_with_path(struct object *obj, const char *name, struct object_array *array, unsigned mode, const char *path);
123
124 /*
125 * Returns NULL if the array is empty. Otherwise, returns the last object
126 * after removing its entry from the array. Other resources associated
127 * with that object are left in an unspecified state and should not be
128 * examined.
129 */
130 struct object *object_array_pop(struct object_array *array);
131
132 typedef int (*object_array_each_func_t)(struct object_array_entry *, void *);
133
134 /*
135 * Apply want to each entry in array, retaining only the entries for
136 * which the function returns true. Preserve the order of the entries
137 * that are retained.
138 */
139 void object_array_filter(struct object_array *array,
140 object_array_each_func_t want, void *cb_data);
141
142 /*
143 * Remove from array all but the first entry with a given name.
144 * Warning: this function uses an O(N^2) algorithm.
145 */
146 void object_array_remove_duplicates(struct object_array *array);
147
148 /*
149 * Remove any objects from the array, freeing all used memory; afterwards
150 * the array is ready to store more objects with add_object_array().
151 */
152 void object_array_clear(struct object_array *array);
153
154 void clear_object_flags(unsigned flags);
155
156 /*
157 * Clear the specified object flags from all in-core commit objects.
158 */
159 extern void clear_commit_marks_all(unsigned int flags);
160
161 #endif /* OBJECT_H */