Andrew's git - gitweb.git/blob

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