Update draft release notes to 1.7.9.3 for the last time
[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         int type;
32         char name[1];
33 };
34
35 struct commit *lookup_commit(const unsigned char *sha1);
36 struct commit *lookup_commit_reference(const unsigned char *sha1);
37 struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
38                                               int quiet);
39 struct commit *lookup_commit_reference_by_name(const char *name);
40
41 /*
42  * Look up object named by "sha1", dereference tag as necessary,
43  * get a commit and return it. If "sha1" does not dereference to
44  * a commit, use ref_name to report an error and die.
45  */
46 struct commit *lookup_commit_or_die(const unsigned char *sha1, const char *ref_name);
47
48 int parse_commit_buffer(struct commit *item, const void *buffer, unsigned long size);
49 int parse_commit(struct commit *item);
50
51 /* Find beginning and length of commit subject. */
52 int find_commit_subject(const char *commit_buffer, const char **subject);
53
54 struct commit_list *commit_list_insert(struct commit *item,
55                                         struct commit_list **list);
56 unsigned commit_list_count(const struct commit_list *l);
57 struct commit_list *commit_list_insert_by_date(struct commit *item,
58                                     struct commit_list **list);
59 void commit_list_sort_by_date(struct commit_list **list);
60
61 void free_commit_list(struct commit_list *list);
62
63 /* Commit formats */
64 enum cmit_fmt {
65         CMIT_FMT_RAW,
66         CMIT_FMT_MEDIUM,
67         CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
68         CMIT_FMT_SHORT,
69         CMIT_FMT_FULL,
70         CMIT_FMT_FULLER,
71         CMIT_FMT_ONELINE,
72         CMIT_FMT_EMAIL,
73         CMIT_FMT_USERFORMAT,
74
75         CMIT_FMT_UNSPECIFIED
76 };
77
78 struct pretty_print_context {
79         enum cmit_fmt fmt;
80         int abbrev;
81         const char *subject;
82         const char *after_subject;
83         int preserve_subject;
84         enum date_mode date_mode;
85         int need_8bit_cte;
86         int show_notes;
87         struct reflog_walk_info *reflog_info;
88         const char *output_encoding;
89 };
90
91 struct userformat_want {
92         unsigned notes:1;
93 };
94
95 extern int has_non_ascii(const char *text);
96 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
97 extern char *logmsg_reencode(const struct commit *commit,
98                              const char *output_encoding);
99 extern char *reencode_commit_message(const struct commit *commit,
100                                      const char **encoding_p);
101 extern void get_commit_format(const char *arg, struct rev_info *);
102 extern const char *format_subject(struct strbuf *sb, const char *msg,
103                                   const char *line_separator);
104 extern void userformat_find_requirements(const char *fmt, struct userformat_want *w);
105 extern void format_commit_message(const struct commit *commit,
106                                   const char *format, struct strbuf *sb,
107                                   const struct pretty_print_context *context);
108 extern void pretty_print_commit(const struct pretty_print_context *pp,
109                                 const struct commit *commit,
110                                 struct strbuf *sb);
111 extern void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
112                            struct strbuf *sb);
113 void pp_user_info(const struct pretty_print_context *pp,
114                   const char *what, struct strbuf *sb,
115                   const char *line, const char *encoding);
116 void pp_title_line(const struct pretty_print_context *pp,
117                    const char **msg_p,
118                    struct strbuf *sb,
119                    const char *encoding,
120                    int need_8bit_cte);
121 void pp_remainder(const struct pretty_print_context *pp,
122                   const char **msg_p,
123                   struct strbuf *sb,
124                   int indent);
125
126
127 /** Removes the first commit from a list sorted by date, and adds all
128  * of its parents.
129  **/
130 struct commit *pop_most_recent_commit(struct commit_list **list,
131                                       unsigned int mark);
132
133 struct commit *pop_commit(struct commit_list **stack);
134
135 void clear_commit_marks(struct commit *commit, unsigned int mark);
136 void clear_commit_marks_for_object_array(struct object_array *a, unsigned mark);
137
138 /*
139  * Performs an in-place topological sort of list supplied.
140  *
141  *   invariant of resulting list is:
142  *      a reachable from b => ord(b) < ord(a)
143  *   in addition, when lifo == 0, commits on parallel tracks are
144  *   sorted in the dates order.
145  */
146 void sort_in_topological_order(struct commit_list ** list, int lifo);
147
148 struct commit_graft {
149         unsigned char sha1[20];
150         int nr_parent; /* < 0 if shallow commit */
151         unsigned char parent[FLEX_ARRAY][20]; /* more */
152 };
153 typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
154
155 struct commit_graft *read_graft_line(char *buf, int len);
156 int register_commit_graft(struct commit_graft *, int);
157 struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
158
159 extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
160 extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos, int cleanup);
161 extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
162
163 extern int register_shallow(const unsigned char *sha1);
164 extern int unregister_shallow(const unsigned char *sha1);
165 extern int for_each_commit_graft(each_commit_graft_fn, void *);
166 extern int is_repository_shallow(void);
167 extern struct commit_list *get_shallow_commits(struct object_array *heads,
168                 int depth, int shallow_flag, int not_shallow_flag);
169
170 int is_descendant_of(struct commit *, struct commit_list *);
171 int in_merge_bases(struct commit *, struct commit **, int);
172
173 extern int interactive_add(int argc, const char **argv, const char *prefix, int patch);
174 extern int run_add_interactive(const char *revision, const char *patch_mode,
175                                const char **pathspec);
176
177 static inline int single_parent(struct commit *commit)
178 {
179         return commit->parents && !commit->parents->next;
180 }
181
182 struct commit_list *reduce_heads(struct commit_list *heads);
183
184 struct commit_extra_header {
185         struct commit_extra_header *next;
186         char *key;
187         char *value;
188         size_t len;
189 };
190
191 extern void append_merge_tag_headers(struct commit_list *parents,
192                                      struct commit_extra_header ***tail);
193
194 extern int commit_tree(const struct strbuf *msg, unsigned char *tree,
195                        struct commit_list *parents, unsigned char *ret,
196                        const char *author, const char *sign_commit);
197
198 extern int commit_tree_extended(const struct strbuf *msg, unsigned char *tree,
199                                 struct commit_list *parents, unsigned char *ret,
200                                 const char *author, const char *sign_commit,
201                                 struct commit_extra_header *);
202
203 extern struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
204 extern struct commit_extra_header *read_commit_extra_header_lines(const char *buf, size_t len, const char **);
205
206 extern void free_commit_extra_headers(struct commit_extra_header *extra);
207
208 struct merge_remote_desc {
209         struct object *obj; /* the named object, could be a tag */
210         const char *name;
211 };
212 #define merge_remote_util(commit) ((struct merge_remote_desc *)((commit)->util))
213
214 /*
215  * Given "name" from the command line to merge, find the commit object
216  * and return it, while storing merge_remote_desc in its ->util field,
217  * to allow callers to tell if we are told to merge a tag.
218  */
219 struct commit *get_merge_parent(const char *name);
220
221 extern int parse_signed_commit(const unsigned char *sha1,
222                                struct strbuf *message, struct strbuf *signature);
223 #endif /* COMMIT_H */