Andrew's git - gitweb.git/blob

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