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