commit.h

   1 #ifndef COMMIT_H
   2 #define COMMIT_H
   3
   4 #include "object.h"
   5 #include "tree.h"
   6 #include "strbuf.h"
   7 #include "decorate.h"
   8
   9 struct commit_list {
  10         struct commit *item;
  11         struct commit_list *next;
  12 };
  13
  14 struct commit {
  15         struct object object;
  16         void *util;
  17         unsigned int indegree;
  18         unsigned long date;
  19         struct commit_list *parents;
  20         struct tree *tree;
  21         char *buffer;
  22 };
  23
  24 extern int save_commit_buffer;
  25 extern const char *commit_type;
  26
  27 /* While we can decorate any object with a name, it's only used for commits.. */
  28 extern struct decoration name_decoration;
  29 struct name_decoration {
  30         struct name_decoration *next;
  31         char name[1];
  32 };
  33
  34 struct commit *lookup_commit(const unsigned char *sha1);
  35 struct commit *lookup_commit_reference(const unsigned char *sha1);
  36 struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
  37                                               int quiet);
  38
  39 int parse_commit_buffer(struct commit *item, void *buffer, unsigned long size);
  40
  41 int parse_commit(struct commit *item);
  42
  43 void unparse_commit(struct commit *item);
  44
  45 struct commit_list * commit_list_insert(struct commit *item, struct commit_list **list_p);
  46 unsigned commit_list_count(const struct commit_list *l);
  47 struct commit_list * insert_by_date(struct commit *item, struct commit_list **list);
  48
  49 void free_commit_list(struct commit_list *list);
  50
  51 void sort_by_date(struct commit_list **list);
  52
  53 /* Commit formats */
  54 enum cmit_fmt {
  55         CMIT_FMT_RAW,
  56         CMIT_FMT_MEDIUM,
  57         CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
  58         CMIT_FMT_SHORT,
  59         CMIT_FMT_FULL,
  60         CMIT_FMT_FULLER,
  61         CMIT_FMT_ONELINE,
  62         CMIT_FMT_EMAIL,
  63         CMIT_FMT_USERFORMAT,
  64
  65         CMIT_FMT_UNSPECIFIED,
  66 };
  67
  68 extern int non_ascii(int);
  69 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
  70 extern char *reencode_commit_message(const struct commit *commit,
  71                                      const char **encoding_p);
  72 extern void get_commit_format(const char *arg, struct rev_info *);
  73 extern void format_commit_message(const struct commit *commit,
  74                                   const void *format, struct strbuf *sb,
  75                                   enum date_mode dmode);
  76 extern void pretty_print_commit(enum cmit_fmt fmt, const struct commit*,
  77                                 struct strbuf *,
  78                                 int abbrev, const char *subject,
  79                                 const char *after_subject, enum date_mode,
  80                                 int need_8bit_cte);
  81 void pp_user_info(const char *what, enum cmit_fmt fmt, struct strbuf *sb,
  82                    const char *line, enum date_mode dmode,
  83                    const char *encoding);
  84 void pp_title_line(enum cmit_fmt fmt,
  85                    const char **msg_p,
  86                    struct strbuf *sb,
  87                    const char *subject,
  88                    const char *after_subject,
  89                    const char *encoding,
  90                    int need_8bit_cte);
  91 void pp_remainder(enum cmit_fmt fmt,
  92                   const char **msg_p,
  93                   struct strbuf *sb,
  94                   int indent);
  95
  96
  97 /** Removes the first commit from a list sorted by date, and adds all
  98  * of its parents.
  99  **/
 100 struct commit *pop_most_recent_commit(struct commit_list **list,
 101                                       unsigned int mark);
 102
 103 struct commit *pop_commit(struct commit_list **stack);
 104
 105 void clear_commit_marks(struct commit *commit, unsigned int mark);
 106
 107 /*
 108  * Performs an in-place topological sort of list supplied.
 109  *
 110  *   invariant of resulting list is:
 111  *      a reachable from b => ord(b) < ord(a)
 112  *   in addition, when lifo == 0, commits on parallel tracks are
 113  *   sorted in the dates order.
 114  */
 115 void sort_in_topological_order(struct commit_list ** list, int lifo);
 116
 117 struct commit_graft {
 118         unsigned char sha1[20];
 119         int nr_parent; /* < 0 if shallow commit */
 120         unsigned char parent[FLEX_ARRAY][20]; /* more */
 121 };
 122
 123 struct commit_graft *read_graft_line(char *buf, int len);
 124 int register_commit_graft(struct commit_graft *, int);
 125 struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
 126
 127 const unsigned char *lookup_replace_object(const unsigned char *sha1);
 128
 129 extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
 130 extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos, int cleanup);
 131 extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
 132
 133 extern int register_shallow(const unsigned char *sha1);
 134 extern int unregister_shallow(const unsigned char *sha1);
 135 extern int write_shallow_commits(int fd, int use_pack_protocol);
 136 extern int is_repository_shallow(void);
 137 extern struct commit_list *get_shallow_commits(struct object_array *heads,
 138                 int depth, int shallow_flag, int not_shallow_flag);
 139
 140 int is_descendant_of(struct commit *, struct commit_list *);
 141 int in_merge_bases(struct commit *, struct commit **, int);
 142
 143 extern int interactive_add(int argc, const char **argv, const char *prefix);
 144
 145 static inline int single_parent(struct commit *commit)
 146 {
 147         return commit->parents && !commit->parents->next;
 148 }
 149
 150 struct commit_list *reduce_heads(struct commit_list *heads);
 151
 152 #endif /* COMMIT_H */