make the sender advertise shallow commits to the receiver
[git/git.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 #include "gpg-interface.h"
9 #include "string-list.h"
10
11 struct commit_list {
12 struct commit *item;
13 struct commit_list *next;
14 };
15
16 struct commit {
17 struct object object;
18 void *util;
19 unsigned int index;
20 unsigned long date;
21 struct commit_list *parents;
22 struct tree *tree;
23 char *buffer;
24 };
25
26 extern int save_commit_buffer;
27 extern const char *commit_type;
28
29 /* While we can decorate any object with a name, it's only used for commits.. */
30 extern struct decoration name_decoration;
31 struct name_decoration {
32 struct name_decoration *next;
33 int type;
34 char name[1];
35 };
36
37 struct commit *lookup_commit(const unsigned char *sha1);
38 struct commit *lookup_commit_reference(const unsigned char *sha1);
39 struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
40 int quiet);
41 struct commit *lookup_commit_reference_by_name(const char *name);
42
43 /*
44 * Look up object named by "sha1", dereference tag as necessary,
45 * get a commit and return it. If "sha1" does not dereference to
46 * a commit, use ref_name to report an error and die.
47 */
48 struct commit *lookup_commit_or_die(const unsigned char *sha1, const char *ref_name);
49
50 int parse_commit_buffer(struct commit *item, const void *buffer, unsigned long size);
51 int parse_commit(struct commit *item);
52
53 /* Find beginning and length of commit subject. */
54 int find_commit_subject(const char *commit_buffer, const char **subject);
55
56 struct commit_list *commit_list_insert(struct commit *item,
57 struct commit_list **list);
58 struct commit_list **commit_list_append(struct commit *commit,
59 struct commit_list **next);
60 unsigned commit_list_count(const struct commit_list *l);
61 struct commit_list *commit_list_insert_by_date(struct commit *item,
62 struct commit_list **list);
63 void commit_list_sort_by_date(struct commit_list **list);
64
65 /* Shallow copy of the input list */
66 struct commit_list *copy_commit_list(struct commit_list *list);
67
68 void free_commit_list(struct commit_list *list);
69
70 /* Commit formats */
71 enum cmit_fmt {
72 CMIT_FMT_RAW,
73 CMIT_FMT_MEDIUM,
74 CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
75 CMIT_FMT_SHORT,
76 CMIT_FMT_FULL,
77 CMIT_FMT_FULLER,
78 CMIT_FMT_ONELINE,
79 CMIT_FMT_EMAIL,
80 CMIT_FMT_USERFORMAT,
81
82 CMIT_FMT_UNSPECIFIED
83 };
84
85 struct pretty_print_context {
86 /*
87 * Callers should tweak these to change the behavior of pp_* functions.
88 */
89 enum cmit_fmt fmt;
90 int abbrev;
91 const char *subject;
92 const char *after_subject;
93 int preserve_subject;
94 enum date_mode date_mode;
95 unsigned date_mode_explicit:1;
96 int need_8bit_cte;
97 char *notes_message;
98 struct reflog_walk_info *reflog_info;
99 const char *output_encoding;
100 struct string_list *mailmap;
101 int color;
102 struct ident_split *from_ident;
103
104 /*
105 * Fields below here are manipulated internally by pp_* functions and
106 * should not be counted on by callers.
107 */
108 struct string_list in_body_headers;
109 };
110
111 struct userformat_want {
112 unsigned notes:1;
113 };
114
115 extern int has_non_ascii(const char *text);
116 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
117 extern char *logmsg_reencode(const struct commit *commit,
118 char **commit_encoding,
119 const char *output_encoding);
120 extern void logmsg_free(char *msg, const struct commit *commit);
121 extern void get_commit_format(const char *arg, struct rev_info *);
122 extern const char *format_subject(struct strbuf *sb, const char *msg,
123 const char *line_separator);
124 extern void userformat_find_requirements(const char *fmt, struct userformat_want *w);
125 extern void format_commit_message(const struct commit *commit,
126 const char *format, struct strbuf *sb,
127 const struct pretty_print_context *context);
128 extern void pretty_print_commit(struct pretty_print_context *pp,
129 const struct commit *commit,
130 struct strbuf *sb);
131 extern void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
132 struct strbuf *sb);
133 void pp_user_info(struct pretty_print_context *pp,
134 const char *what, struct strbuf *sb,
135 const char *line, const char *encoding);
136 void pp_title_line(struct pretty_print_context *pp,
137 const char **msg_p,
138 struct strbuf *sb,
139 const char *encoding,
140 int need_8bit_cte);
141 void pp_remainder(struct pretty_print_context *pp,
142 const char **msg_p,
143 struct strbuf *sb,
144 int indent);
145
146
147 /** Removes the first commit from a list sorted by date, and adds all
148 * of its parents.
149 **/
150 struct commit *pop_most_recent_commit(struct commit_list **list,
151 unsigned int mark);
152
153 struct commit *pop_commit(struct commit_list **stack);
154
155 void clear_commit_marks(struct commit *commit, unsigned int mark);
156 void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark);
157 void clear_commit_marks_for_object_array(struct object_array *a, unsigned mark);
158
159
160 enum rev_sort_order {
161 REV_SORT_IN_GRAPH_ORDER = 0,
162 REV_SORT_BY_COMMIT_DATE,
163 REV_SORT_BY_AUTHOR_DATE
164 };
165
166 /*
167 * Performs an in-place topological sort of list supplied.
168 *
169 * invariant of resulting list is:
170 * a reachable from b => ord(b) < ord(a)
171 * sort_order further specifies:
172 * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
173 * chain together.
174 * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
175 */
176 void sort_in_topological_order(struct commit_list **, enum rev_sort_order);
177
178 struct commit_graft {
179 unsigned char sha1[20];
180 int nr_parent; /* < 0 if shallow commit */
181 unsigned char parent[FLEX_ARRAY][20]; /* more */
182 };
183 typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
184
185 struct commit_graft *read_graft_line(char *buf, int len);
186 int register_commit_graft(struct commit_graft *, int);
187 struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
188
189 extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
190 extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos, int cleanup);
191 extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
192
193 /* largest positive number a signed 32-bit integer can contain */
194 #define INFINITE_DEPTH 0x7fffffff
195
196 extern int register_shallow(const unsigned char *sha1);
197 extern int unregister_shallow(const unsigned char *sha1);
198 extern int for_each_commit_graft(each_commit_graft_fn, void *);
199 extern int is_repository_shallow(void);
200 extern struct commit_list *get_shallow_commits(struct object_array *heads,
201 int depth, int shallow_flag, int not_shallow_flag);
202 extern void check_shallow_file_for_update(void);
203 extern void set_alternate_shallow_file(const char *path);
204 extern int write_shallow_commits(struct strbuf *out, int use_pack_protocol);
205 extern void setup_alternate_shallow(struct lock_file *shallow_lock,
206 const char **alternate_shallow_file);
207 extern char *setup_temporary_shallow(void);
208 extern void advertise_shallow_grafts(int);
209
210 int is_descendant_of(struct commit *, struct commit_list *);
211 int in_merge_bases(struct commit *, struct commit *);
212 int in_merge_bases_many(struct commit *, int, struct commit **);
213
214 extern int interactive_add(int argc, const char **argv, const char *prefix, int patch);
215 extern int run_add_interactive(const char *revision, const char *patch_mode,
216 const struct pathspec *pathspec);
217
218 static inline int single_parent(struct commit *commit)
219 {
220 return commit->parents && !commit->parents->next;
221 }
222
223 struct commit_list *reduce_heads(struct commit_list *heads);
224
225 struct commit_extra_header {
226 struct commit_extra_header *next;
227 char *key;
228 char *value;
229 size_t len;
230 };
231
232 extern void append_merge_tag_headers(struct commit_list *parents,
233 struct commit_extra_header ***tail);
234
235 extern int commit_tree(const struct strbuf *msg, unsigned char *tree,
236 struct commit_list *parents, unsigned char *ret,
237 const char *author, const char *sign_commit);
238
239 extern int commit_tree_extended(const struct strbuf *msg, unsigned char *tree,
240 struct commit_list *parents, unsigned char *ret,
241 const char *author, const char *sign_commit,
242 struct commit_extra_header *);
243
244 extern struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
245
246 extern void free_commit_extra_headers(struct commit_extra_header *extra);
247
248 struct merge_remote_desc {
249 struct object *obj; /* the named object, could be a tag */
250 const char *name;
251 };
252 #define merge_remote_util(commit) ((struct merge_remote_desc *)((commit)->util))
253
254 /*
255 * Given "name" from the command line to merge, find the commit object
256 * and return it, while storing merge_remote_desc in its ->util field,
257 * to allow callers to tell if we are told to merge a tag.
258 */
259 struct commit *get_merge_parent(const char *name);
260
261 extern int parse_signed_commit(const unsigned char *sha1,
262 struct strbuf *message, struct strbuf *signature);
263 extern void print_commit_list(struct commit_list *list,
264 const char *format_cur,
265 const char *format_last);
266
267 /*
268 * Check the signature of the given commit. The result of the check is stored
269 * in sig->check_result, 'G' for a good signature, 'U' for a good signature
270 * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
271 * at all. This may allocate memory for sig->gpg_output, sig->gpg_status,
272 * sig->signer and sig->key.
273 */
274 extern void check_commit_signature(const struct commit* commit, struct signature_check *sigc);
275
276 int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused);
277
278 #endif /* COMMIT_H */