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                const char *name;
  15                unsigned mode;
  16        } *objects;
  17};
  18
  19#define OBJECT_ARRAY_INIT { 0, 0, NULL }
  20
  21#define TYPE_BITS   3
  22#define FLAG_BITS  27
  23
  24/*
  25 * The object type is stored in 3 bits.
  26 */
  27struct object {
  28        unsigned parsed : 1;
  29        unsigned used : 1;
  30        unsigned type : TYPE_BITS;
  31        unsigned flags : FLAG_BITS;
  32        unsigned char sha1[20];
  33};
  34
  35extern const char *typename(unsigned int type);
  36extern int type_from_string(const char *str);
  37
  38extern unsigned int get_max_object_index(void);
  39extern struct object *get_indexed_object(unsigned int);
  40
  41/*
  42 * This can be used to see if we have heard of the object before, but
  43 * it can return "yes we have, and here is a half-initialised object"
  44 * for an object that we haven't loaded/parsed yet.
  45 *
  46 * When parsing a commit to create an in-core commit object, its
  47 * parents list holds commit objects that represent its parents, but
  48 * they are expected to be lazily initialized and do not know what
  49 * their trees or parents are yet.  When this function returns such a
  50 * half-initialised objects, the caller is expected to initialize them
  51 * by calling parse_object() on them.
  52 */
  53struct object *lookup_object(const unsigned char *sha1);
  54
  55extern void *create_object(const unsigned char *sha1, int type, void *obj);
  56
  57/*
  58 * Returns the object, having parsed it to find out what it is.
  59 *
  60 * Returns NULL if the object is missing or corrupt.
  61 */
  62struct object *parse_object(const unsigned char *sha1);
  63
  64/*
  65 * Like parse_object, but will die() instead of returning NULL. If the
  66 * "name" parameter is not NULL, it is included in the error message
  67 * (otherwise, the sha1 hex is given).
  68 */
  69struct object *parse_object_or_die(const unsigned char *sha1, const char *name);
  70
  71/* Given the result of read_sha1_file(), returns the object after
  72 * parsing it.  eaten_p indicates if the object has a borrowed copy
  73 * of buffer and the caller should not free() it.
  74 */
  75struct object *parse_object_buffer(const unsigned char *sha1, enum object_type type, unsigned long size, void *buffer, int *eaten_p);
  76
  77/** Returns the object, with potentially excess memory allocated. **/
  78struct object *lookup_unknown_object(const unsigned  char *sha1);
  79
  80struct object_list *object_list_insert(struct object *item,
  81                                       struct object_list **list_p);
  82
  83int object_list_contains(struct object_list *list, struct object *obj);
  84
  85/* Object array handling .. */
  86void add_object_array(struct object *obj, const char *name, struct object_array *array);
  87void add_object_array_with_mode(struct object *obj, const char *name, struct object_array *array, unsigned mode);
  88void object_array_remove_duplicates(struct object_array *);
  89
  90void clear_object_flags(unsigned flags);
  91
  92#endif /* OBJECT_H */