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