commit.h

   1 #ifndef COMMIT_H
   2 #define COMMIT_H
   3
   4 #include "object.h"
   5 #include "tree.h"
   6 #include "decorate.h"
   7
   8 struct commit_list {
   9         struct commit *item;
  10         struct commit_list *next;
  11 };
  12
  13 struct commit {
  14         struct object object;
  15         void *util;
  16         unsigned long date;
  17         struct commit_list *parents;
  18         struct tree *tree;
  19         char *buffer;
  20 };
  21
  22 extern int save_commit_buffer;
  23 extern const char *commit_type;
  24
  25 /* While we can decorate any object with a name, it's only used for commits.. */
  26 extern struct decoration name_decoration;
  27 struct name_decoration {
  28         struct name_decoration *next;
  29         char name[1];
  30 };
  31
  32 struct commit *lookup_commit(const unsigned char *sha1);
  33 struct commit *lookup_commit_reference(const unsigned char *sha1);
  34 struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
  35                                               int quiet);
  36
  37 int parse_commit_buffer(struct commit *item, void *buffer, unsigned long size);
  38
  39 int parse_commit(struct commit *item);
  40
  41 struct commit_list * commit_list_insert(struct commit *item, struct commit_list **list_p);
  42 struct commit_list * insert_by_date(struct commit *item, struct commit_list **list);
  43
  44 void free_commit_list(struct commit_list *list);
  45
  46 void sort_by_date(struct commit_list **list);
  47
  48 /* Commit formats */
  49 enum cmit_fmt {
  50         CMIT_FMT_RAW,
  51         CMIT_FMT_MEDIUM,
  52         CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
  53         CMIT_FMT_SHORT,
  54         CMIT_FMT_FULL,
  55         CMIT_FMT_FULLER,
  56         CMIT_FMT_ONELINE,
  57         CMIT_FMT_EMAIL,
  58         CMIT_FMT_USERFORMAT,
  59
  60         CMIT_FMT_UNSPECIFIED,
  61 };
  62
  63 extern enum cmit_fmt get_commit_format(const char *arg);
  64 extern long format_commit_message(const struct commit *commit, const void *template, char **buf_p, unsigned long *space_p);
  65 extern unsigned long pretty_print_commit(enum cmit_fmt fmt, const struct commit *, unsigned long len, char **buf_p, unsigned long *space_p, int abbrev, const char *subject, const char *after_subject, enum date_mode dmode);
  66
  67 /** Removes the first commit from a list sorted by date, and adds all
  68  * of its parents.
  69  **/
  70 struct commit *pop_most_recent_commit(struct commit_list **list,
  71                                       unsigned int mark);
  72
  73 struct commit *pop_commit(struct commit_list **stack);
  74
  75 void clear_commit_marks(struct commit *commit, unsigned int mark);
  76
  77 /*
  78  * Performs an in-place topological sort of list supplied.
  79  *
  80  * Pre-conditions for sort_in_topological_order:
  81  *   all commits in input list and all parents of those
  82  *   commits must have object.util == NULL
  83  *
  84  * Pre-conditions for sort_in_topological_order_fn:
  85  *   all commits in input list and all parents of those
  86  *   commits must have getter(commit) == NULL
  87  *
  88  * Post-conditions:
  89  *   invariant of resulting list is:
  90  *      a reachable from b => ord(b) < ord(a)
  91  *   in addition, when lifo == 0, commits on parallel tracks are
  92  *   sorted in the dates order.
  93  */
  94
  95 typedef void (*topo_sort_set_fn_t)(struct commit*, void *data);
  96 typedef void* (*topo_sort_get_fn_t)(struct commit*);
  97
  98 void topo_sort_default_setter(struct commit *c, void *data);
  99 void *topo_sort_default_getter(struct commit *c);
 100
 101 void sort_in_topological_order(struct commit_list ** list, int lifo);
 102 void sort_in_topological_order_fn(struct commit_list ** list, int lifo,
 103                                   topo_sort_set_fn_t setter,
 104                                   topo_sort_get_fn_t getter);
 105
 106 struct commit_graft {
 107         unsigned char sha1[20];
 108         int nr_parent; /* < 0 if shallow commit */
 109         unsigned char parent[FLEX_ARRAY][20]; /* more */
 110 };
 111
 112 struct commit_graft *read_graft_line(char *buf, int len);
 113 int register_commit_graft(struct commit_graft *, int);
 114 int read_graft_file(const char *graft_file);
 115
 116 extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
 117
 118 extern int register_shallow(const unsigned char *sha1);
 119 extern int unregister_shallow(const unsigned char *sha1);
 120 extern int write_shallow_commits(int fd, int use_pack_protocol);
 121 extern int is_repository_shallow(void);
 122 extern struct commit_list *get_shallow_commits(struct object_array *heads,
 123                 int depth, int shallow_flag, int not_shallow_flag);
 124
 125 int in_merge_bases(struct commit *, struct commit **, int);
 126 #endif /* COMMIT_H */