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