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