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