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 struct commit_list * commit_list_insert(struct commit *item, struct commit_list **list_p);
  44 unsigned commit_list_count(const struct commit_list *l);
  45 struct commit_list * insert_by_date(struct commit *item, struct commit_list **list);
  46
  47 void free_commit_list(struct commit_list *list);
  48
  49 void sort_by_date(struct commit_list **list);
  50
  51 /* Commit formats */
  52 enum cmit_fmt {
  53         CMIT_FMT_RAW,
  54         CMIT_FMT_MEDIUM,
  55         CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
  56         CMIT_FMT_SHORT,
  57         CMIT_FMT_FULL,
  58         CMIT_FMT_FULLER,
  59         CMIT_FMT_ONELINE,
  60         CMIT_FMT_EMAIL,
  61         CMIT_FMT_USERFORMAT,
  62
  63         CMIT_FMT_UNSPECIFIED
  64 };
  65
  66 struct pretty_print_context
  67 {
  68         int abbrev;
  69         const char *subject;
  70         const char *after_subject;
  71         enum date_mode date_mode;
  72         int need_8bit_cte;
  73         int show_notes;
  74         struct reflog_walk_info *reflog_info;
  75 };
  76
  77 struct userformat_want {
  78         unsigned notes:1;
  79 };
  80
  81 extern int has_non_ascii(const char *text);
  82 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
  83 extern char *reencode_commit_message(const struct commit *commit,
  84                                      const char **encoding_p);
  85 extern void get_commit_format(const char *arg, struct rev_info *);
  86 extern void userformat_find_requirements(const char *fmt, struct userformat_want *w);
  87 extern void format_commit_message(const struct commit *commit,
  88                                   const char *format, struct strbuf *sb,
  89                                   const struct pretty_print_context *context);
  90 extern void pretty_print_commit(enum cmit_fmt fmt, const struct commit *commit,
  91                                 struct strbuf *sb,
  92                                 const struct pretty_print_context *context);
  93 void pp_user_info(const char *what, enum cmit_fmt fmt, struct strbuf *sb,
  94                    const char *line, enum date_mode dmode,
  95                    const char *encoding);
  96 void pp_title_line(enum cmit_fmt fmt,
  97                    const char **msg_p,
  98                    struct strbuf *sb,
  99                    const char *subject,
 100                    const char *after_subject,
 101                    const char *encoding,
 102                    int need_8bit_cte);
 103 void pp_remainder(enum cmit_fmt fmt,
 104                   const char **msg_p,
 105                   struct strbuf *sb,
 106                   int indent);
 107
 108
 109 /** Removes the first commit from a list sorted by date, and adds all
 110  * of its parents.
 111  **/
 112 struct commit *pop_most_recent_commit(struct commit_list **list,
 113                                       unsigned int mark);
 114
 115 struct commit *pop_commit(struct commit_list **stack);
 116
 117 void clear_commit_marks(struct commit *commit, unsigned int mark);
 118
 119 /*
 120  * Performs an in-place topological sort of list supplied.
 121  *
 122  *   invariant of resulting list is:
 123  *      a reachable from b => ord(b) < ord(a)
 124  *   in addition, when lifo == 0, commits on parallel tracks are
 125  *   sorted in the dates order.
 126  */
 127 void sort_in_topological_order(struct commit_list ** list, int lifo);
 128
 129 struct commit_graft {
 130         unsigned char sha1[20];
 131         int nr_parent; /* < 0 if shallow commit */
 132         unsigned char parent[FLEX_ARRAY][20]; /* more */
 133 };
 134
 135 struct commit_graft *read_graft_line(char *buf, int len);
 136 int register_commit_graft(struct commit_graft *, int);
 137 struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
 138
 139 const unsigned char *lookup_replace_object(const unsigned char *sha1);
 140
 141 extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
 142 extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos, int cleanup);
 143 extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
 144
 145 extern int register_shallow(const unsigned char *sha1);
 146 extern int unregister_shallow(const unsigned char *sha1);
 147 extern int write_shallow_commits(struct strbuf *out, int use_pack_protocol);
 148 extern int is_repository_shallow(void);
 149 extern struct commit_list *get_shallow_commits(struct object_array *heads,
 150                 int depth, int shallow_flag, int not_shallow_flag);
 151
 152 int is_descendant_of(struct commit *, struct commit_list *);
 153 int in_merge_bases(struct commit *, struct commit **, int);
 154
 155 extern int interactive_add(int argc, const char **argv, const char *prefix);
 156 extern int run_add_interactive(const char *revision, const char *patch_mode,
 157                                const char **pathspec);
 158
 159 static inline int single_parent(struct commit *commit)
 160 {
 161         return commit->parents && !commit->parents->next;
 162 }
 163
 164 struct commit_list *reduce_heads(struct commit_list *heads);
 165
 166 extern int commit_tree(const char *msg, unsigned char *tree,
 167                 struct commit_list *parents, unsigned char *ret,
 168                 const char *author);
 169
 170 #endif /* COMMIT_H */