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