git-am.txt: add an 'a', say what 'it' is, simplify a sentence
[git] / 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 extern int non_ascii(int);
67 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
68 extern char *reencode_commit_message(const struct commit *commit,
69                                      const char **encoding_p);
70 extern void get_commit_format(const char *arg, struct rev_info *);
71 extern void format_commit_message(const struct commit *commit,
72                                   const void *format, struct strbuf *sb,
73                                   enum date_mode dmode);
74 extern void pretty_print_commit(enum cmit_fmt fmt, const struct commit*,
75                                 struct strbuf *,
76                                 int abbrev, const char *subject,
77                                 const char *after_subject, enum date_mode,
78                                 int need_8bit_cte);
79 void pp_user_info(const char *what, enum cmit_fmt fmt, struct strbuf *sb,
80                    const char *line, enum date_mode dmode,
81                    const char *encoding);
82 void pp_title_line(enum cmit_fmt fmt,
83                    const char **msg_p,
84                    struct strbuf *sb,
85                    const char *subject,
86                    const char *after_subject,
87                    const char *encoding,
88                    int need_8bit_cte);
89 void pp_remainder(enum cmit_fmt fmt,
90                   const char **msg_p,
91                   struct strbuf *sb,
92                   int indent);
93
94
95 /** Removes the first commit from a list sorted by date, and adds all
96  * of its parents.
97  **/
98 struct commit *pop_most_recent_commit(struct commit_list **list,
99                                       unsigned int mark);
100
101 struct commit *pop_commit(struct commit_list **stack);
102
103 void clear_commit_marks(struct commit *commit, unsigned int mark);
104
105 /*
106  * Performs an in-place topological sort of list supplied.
107  *
108  *   invariant of resulting list is:
109  *      a reachable from b => ord(b) < ord(a)
110  *   in addition, when lifo == 0, commits on parallel tracks are
111  *   sorted in the dates order.
112  */
113 void sort_in_topological_order(struct commit_list ** list, int lifo);
114
115 struct commit_graft {
116         unsigned char sha1[20];
117         int nr_parent; /* < 0 if shallow commit */
118         unsigned char parent[FLEX_ARRAY][20]; /* more */
119 };
120
121 struct commit_graft *read_graft_line(char *buf, int len);
122 int register_commit_graft(struct commit_graft *, int);
123 struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
124
125 extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
126 extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos, int cleanup);
127 extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
128
129 extern int register_shallow(const unsigned char *sha1);
130 extern int unregister_shallow(const unsigned char *sha1);
131 extern int write_shallow_commits(int fd, int use_pack_protocol);
132 extern int is_repository_shallow(void);
133 extern struct commit_list *get_shallow_commits(struct object_array *heads,
134                 int depth, int shallow_flag, int not_shallow_flag);
135
136 int is_descendant_of(struct commit *, struct commit_list *);
137 int in_merge_bases(struct commit *, struct commit **, int);
138
139 extern int interactive_add(int argc, const char **argv, const char *prefix);
140
141 static inline int single_parent(struct commit *commit)
142 {
143         return commit->parents && !commit->parents->next;
144 }
145
146 struct commit_list *reduce_heads(struct commit_list *heads);
147
148 #endif /* COMMIT_H */