git.oblomov.eu Git - git/blob - object.h

   1 #ifndef OBJECT_H
   2 #define OBJECT_H
   3
   4 struct parsed_object_pool {
   5         struct object **obj_hash;
   6         int nr_objs, obj_hash_size;
   7
   8         /* TODO: migrate alloc_states to mem-pool? */
   9         struct alloc_state *blob_state;
  10         struct alloc_state *tree_state;
  11         struct alloc_state *commit_state;
  12         struct alloc_state *tag_state;
  13         struct alloc_state *object_state;
  14         unsigned commit_count;
  15
  16         /* parent substitutions from .git/info/grafts and .git/shallow */
  17         struct commit_graft **grafts;
  18         int grafts_alloc, grafts_nr;
  19
  20         int is_shallow;
  21         struct stat_validity *shallow_stat;
  22         char *alternate_shallow_file;
  23
  24         int commit_graft_prepared;
  25 };
  26
  27 struct parsed_object_pool *parsed_object_pool_new(void);
  28 void parsed_object_pool_clear(struct parsed_object_pool *o);
  29
  30 struct object_list {
  31         struct object *item;
  32         struct object_list *next;
  33 };
  34
  35 struct object_array {
  36         unsigned int nr;
  37         unsigned int alloc;
  38         struct object_array_entry {
  39                 struct object *item;
  40                 /*
  41                  * name or NULL.  If non-NULL, the memory pointed to
  42                  * is owned by this object *except* if it points at
  43                  * object_array_slopbuf, which is a static copy of the
  44                  * empty string.
  45                  */
  46                 char *name;
  47                 char *path;
  48                 unsigned mode;
  49         } *objects;
  50 };
  51
  52 #define OBJECT_ARRAY_INIT { 0, 0, NULL }
  53
  54 /*
  55  * object flag allocation:
  56  * revision.h:               0---------10                              2526
  57  * fetch-pack.c:             01
  58  * negotiator/default.c:       2--5
  59  * walker.c:                 0-2
  60  * upload-pack.c:                4       11----------------19
  61  * builtin/blame.c:                        12-13
  62  * bisect.c:                                        16
  63  * bundle.c:                                        16
  64  * http-push.c:                                     16-----19
  65  * commit.c:                                        16-----19
  66  * sha1-name.c:                                              20
  67  * list-objects-filter.c:                                      21
  68  * builtin/fsck.c:           0--3
  69  * builtin/index-pack.c:                                     2021
  70  * builtin/pack-objects.c:                                   20
  71  * builtin/reflog.c:                   10--12
  72  * builtin/show-branch.c:    0-------------------------------------------26
  73  * builtin/unpack-objects.c:                                 2021
  74  */
  75 #define FLAG_BITS  27
  76
  77 /*
  78  * The object type is stored in 3 bits.
  79  */
  80 struct object {
  81         unsigned parsed : 1;
  82         unsigned type : TYPE_BITS;
  83         unsigned flags : FLAG_BITS;
  84         struct object_id oid;
  85 };
  86
  87 extern const char *type_name(unsigned int type);
  88 extern int type_from_string_gently(const char *str, ssize_t, int gentle);
  89 #define type_from_string(str) type_from_string_gently(str, -1, 0)
  90
  91 /*
  92  * Return the current number of buckets in the object hashmap.
  93  */
  94 extern unsigned int get_max_object_index(void);
  95
  96 /*
  97  * Return the object from the specified bucket in the object hashmap.
  98  */
  99 extern struct object *get_indexed_object(unsigned int);
 100
 101 /*
 102  * This can be used to see if we have heard of the object before, but
 103  * it can return "yes we have, and here is a half-initialised object"
 104  * for an object that we haven't loaded/parsed yet.
 105  *
 106  * When parsing a commit to create an in-core commit object, its
 107  * parents list holds commit objects that represent its parents, but
 108  * they are expected to be lazily initialized and do not know what
 109  * their trees or parents are yet.  When this function returns such a
 110  * half-initialised objects, the caller is expected to initialize them
 111  * by calling parse_object() on them.
 112  */
 113 struct object *lookup_object(const unsigned char *sha1);
 114
 115 extern void *create_object(struct repository *r, const unsigned char *sha1, void *obj);
 116
 117 void *object_as_type(struct object *obj, enum object_type type, int quiet);
 118
 119 /*
 120  * Returns the object, having parsed it to find out what it is.
 121  *
 122  * Returns NULL if the object is missing or corrupt.
 123  */
 124 struct object *parse_object(const struct object_id *oid);
 125
 126 /*
 127  * Like parse_object, but will die() instead of returning NULL. If the
 128  * "name" parameter is not NULL, it is included in the error message
 129  * (otherwise, the hex object ID is given).
 130  */
 131 struct object *parse_object_or_die(const struct object_id *oid, const char *name);
 132
 133 /* Given the result of read_sha1_file(), returns the object after
 134  * parsing it.  eaten_p indicates if the object has a borrowed copy
 135  * of buffer and the caller should not free() it.
 136  */
 137 struct object *parse_object_buffer(const struct object_id *oid, enum object_type type, unsigned long size, void *buffer, int *eaten_p);
 138
 139 /** Returns the object, with potentially excess memory allocated. **/
 140 struct object *lookup_unknown_object(const unsigned  char *sha1);
 141
 142 struct object_list *object_list_insert(struct object *item,
 143                                        struct object_list **list_p);
 144
 145 int object_list_contains(struct object_list *list, struct object *obj);
 146
 147 /* Object array handling .. */
 148 void add_object_array(struct object *obj, const char *name, struct object_array *array);
 149 void add_object_array_with_path(struct object *obj, const char *name, struct object_array *array, unsigned mode, const char *path);
 150
 151 /*
 152  * Returns NULL if the array is empty. Otherwise, returns the last object
 153  * after removing its entry from the array. Other resources associated
 154  * with that object are left in an unspecified state and should not be
 155  * examined.
 156  */
 157 struct object *object_array_pop(struct object_array *array);
 158
 159 typedef int (*object_array_each_func_t)(struct object_array_entry *, void *);
 160
 161 /*
 162  * Apply want to each entry in array, retaining only the entries for
 163  * which the function returns true.  Preserve the order of the entries
 164  * that are retained.
 165  */
 166 void object_array_filter(struct object_array *array,
 167                          object_array_each_func_t want, void *cb_data);
 168
 169 /*
 170  * Remove from array all but the first entry with a given name.
 171  * Warning: this function uses an O(N^2) algorithm.
 172  */
 173 void object_array_remove_duplicates(struct object_array *array);
 174
 175 /*
 176  * Remove any objects from the array, freeing all used memory; afterwards
 177  * the array is ready to store more objects with add_object_array().
 178  */
 179 void object_array_clear(struct object_array *array);
 180
 181 void clear_object_flags(unsigned flags);
 182
 183 /*
 184  * Clear the specified object flags from all in-core commit objects.
 185  */
 186 extern void clear_commit_marks_all(unsigned int flags);
 187
 188 #endif /* OBJECT_H */