]>
Commit | Line | Data |
---|---|---|
6eb8ae00 DB |
1 | #ifndef COMMIT_H |
2 | #define COMMIT_H | |
3 | ||
4 | #include "object.h" | |
5 | #include "tree.h" | |
674d1727 | 6 | #include "strbuf.h" |
ca135e7a | 7 | #include "decorate.h" |
ffb6d7d5 | 8 | #include "gpg-interface.h" |
a9080475 | 9 | #include "string-list.h" |
6eb8ae00 DB |
10 | |
11 | struct commit_list { | |
12 | struct commit *item; | |
13 | struct commit_list *next; | |
14 | }; | |
15 | ||
16 | struct commit { | |
17 | struct object object; | |
d3ff6f55 | 18 | void *util; |
96c4f4a3 | 19 | unsigned int index; |
6eb8ae00 DB |
20 | unsigned long date; |
21 | struct commit_list *parents; | |
22 | struct tree *tree; | |
23 | }; | |
24 | ||
60ab26de | 25 | extern int save_commit_buffer; |
6eb8ae00 DB |
26 | extern const char *commit_type; |
27 | ||
ca135e7a LT |
28 | /* While we can decorate any object with a name, it's only used for commits.. */ |
29 | extern struct decoration name_decoration; | |
30 | struct name_decoration { | |
31 | struct name_decoration *next; | |
eb3005e2 | 32 | int type; |
ca135e7a LT |
33 | char name[1]; |
34 | }; | |
35 | ||
5d6ccf5c JM |
36 | struct commit *lookup_commit(const unsigned char *sha1); |
37 | struct commit *lookup_commit_reference(const unsigned char *sha1); | |
f76412ed JH |
38 | struct commit *lookup_commit_reference_gently(const unsigned char *sha1, |
39 | int quiet); | |
a6fa5992 | 40 | struct commit *lookup_commit_reference_by_name(const char *name); |
6eb8ae00 | 41 | |
baf18fc2 NTND |
42 | /* |
43 | * Look up object named by "sha1", dereference tag as necessary, | |
44 | * get a commit and return it. If "sha1" does not dereference to | |
45 | * a commit, use ref_name to report an error and die. | |
46 | */ | |
47 | struct commit *lookup_commit_or_die(const unsigned char *sha1, const char *ref_name); | |
48 | ||
cf7b1cad | 49 | int parse_commit_buffer(struct commit *item, const void *buffer, unsigned long size); |
6eb8ae00 | 50 | int parse_commit(struct commit *item); |
7059dccc | 51 | void parse_commit_or_die(struct commit *item); |
6eb8ae00 | 52 | |
66c2827e JK |
53 | /* |
54 | * Associate an object buffer with the commit. The ownership of the | |
55 | * memory is handed over to the commit, and must be free()-able. | |
56 | */ | |
8597ea3a | 57 | void set_commit_buffer(struct commit *, void *buffer, unsigned long size); |
66c2827e | 58 | |
152ff1cc JK |
59 | /* |
60 | * Get any cached object buffer associated with the commit. Returns NULL | |
61 | * if none. The resulting memory should not be freed. | |
62 | */ | |
8597ea3a | 63 | const void *get_cached_commit_buffer(const struct commit *, unsigned long *size); |
152ff1cc JK |
64 | |
65 | /* | |
66 | * Get the commit's object contents, either from cache or by reading the object | |
67 | * from disk. The resulting memory should not be modified, and must be given | |
68 | * to unuse_commit_buffer when the caller is done. | |
69 | */ | |
8597ea3a | 70 | const void *get_commit_buffer(const struct commit *, unsigned long *size); |
152ff1cc JK |
71 | |
72 | /* | |
73 | * Tell the commit subsytem that we are done with a particular commit buffer. | |
74 | * The commit and buffer should be the input and return value, respectively, | |
75 | * from an earlier call to get_commit_buffer. The buffer may or may not be | |
76 | * freed by this call; callers should not access the memory afterwards. | |
77 | */ | |
78 | void unuse_commit_buffer(const struct commit *, const void *buffer); | |
79 | ||
0fb370da JK |
80 | /* |
81 | * Free any cached object buffer associated with the commit. | |
82 | */ | |
83 | void free_commit_buffer(struct commit *); | |
84 | ||
85 | /* | |
86 | * Disassociate any cached object buffer from the commit, but do not free it. | |
87 | * The buffer (or NULL, if none) is returned. | |
88 | */ | |
8597ea3a | 89 | const void *detach_commit_buffer(struct commit *, unsigned long *sizep); |
0fb370da | 90 | |
11af2aae CC |
91 | /* Find beginning and length of commit subject. */ |
92 | int find_commit_subject(const char *commit_buffer, const char **subject); | |
93 | ||
47e44ed1 TF |
94 | struct commit_list *commit_list_insert(struct commit *item, |
95 | struct commit_list **list); | |
89b5f1d9 RS |
96 | struct commit_list **commit_list_append(struct commit *commit, |
97 | struct commit_list **next); | |
65319475 | 98 | unsigned commit_list_count(const struct commit_list *l); |
47e44ed1 TF |
99 | struct commit_list *commit_list_insert_by_date(struct commit *item, |
100 | struct commit_list **list); | |
101 | void commit_list_sort_by_date(struct commit_list **list); | |
dd97f850 | 102 | |
53d00b39 TR |
103 | /* Shallow copy of the input list */ |
104 | struct commit_list *copy_commit_list(struct commit_list *list); | |
105 | ||
6eb8ae00 DB |
106 | void free_commit_list(struct commit_list *list); |
107 | ||
000182ea LT |
108 | /* Commit formats */ |
109 | enum cmit_fmt { | |
110 | CMIT_FMT_RAW, | |
111 | CMIT_FMT_MEDIUM, | |
112 | CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM, | |
9b66ec04 LT |
113 | CMIT_FMT_SHORT, |
114 | CMIT_FMT_FULL, | |
ff56fe1c | 115 | CMIT_FMT_FULLER, |
d87449c5 | 116 | CMIT_FMT_ONELINE, |
3eefc189 | 117 | CMIT_FMT_EMAIL, |
e52a5de4 | 118 | CMIT_FMT_USERFORMAT, |
6b9c58f4 | 119 | |
4b05548f | 120 | CMIT_FMT_UNSPECIFIED |
000182ea LT |
121 | }; |
122 | ||
9cba13ca | 123 | struct pretty_print_context { |
10f2fbff JK |
124 | /* |
125 | * Callers should tweak these to change the behavior of pp_* functions. | |
126 | */ | |
6bf13944 | 127 | enum cmit_fmt fmt; |
dd2e794a TR |
128 | int abbrev; |
129 | const char *subject; | |
130 | const char *after_subject; | |
9553d2b2 | 131 | int preserve_subject; |
dd2e794a | 132 | enum date_mode date_mode; |
f026c756 | 133 | unsigned date_mode_explicit:1; |
dd2e794a | 134 | int need_8bit_cte; |
ddf333f6 | 135 | char *notes_message; |
8f8f5476 | 136 | struct reflog_walk_info *reflog_info; |
177b29dc | 137 | const char *output_encoding; |
0e2913b0 | 138 | struct string_list *mailmap; |
30825178 | 139 | int color; |
a9080475 | 140 | struct ident_split *from_ident; |
10f2fbff JK |
141 | |
142 | /* | |
143 | * Fields below here are manipulated internally by pp_* functions and | |
144 | * should not be counted on by callers. | |
145 | */ | |
a9080475 | 146 | struct string_list in_body_headers; |
dd2e794a TR |
147 | }; |
148 | ||
5b163603 JG |
149 | struct userformat_want { |
150 | unsigned notes:1; | |
151 | }; | |
152 | ||
28e9cf65 | 153 | extern int has_non_ascii(const char *text); |
4da45bef | 154 | struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */ |
b000c59b JK |
155 | extern const char *logmsg_reencode(const struct commit *commit, |
156 | char **commit_encoding, | |
157 | const char *output_encoding); | |
4da45bef | 158 | extern void get_commit_format(const char *arg, struct rev_info *); |
c8f1444d RJ |
159 | extern const char *format_subject(struct strbuf *sb, const char *msg, |
160 | const char *line_separator); | |
5b163603 | 161 | extern void userformat_find_requirements(const char *fmt, struct userformat_want *w); |
674d1727 | 162 | extern void format_commit_message(const struct commit *commit, |
7f98ebc8 | 163 | const char *format, struct strbuf *sb, |
dd2e794a | 164 | const struct pretty_print_context *context); |
10f2fbff | 165 | extern void pretty_print_commit(struct pretty_print_context *pp, |
6bf13944 JK |
166 | const struct commit *commit, |
167 | struct strbuf *sb); | |
8b8a5374 JK |
168 | extern void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit, |
169 | struct strbuf *sb); | |
10f2fbff | 170 | void pp_user_info(struct pretty_print_context *pp, |
6bf13944 JK |
171 | const char *what, struct strbuf *sb, |
172 | const char *line, const char *encoding); | |
10f2fbff | 173 | void pp_title_line(struct pretty_print_context *pp, |
b02bd65f DB |
174 | const char **msg_p, |
175 | struct strbuf *sb, | |
b02bd65f | 176 | const char *encoding, |
267123b4 | 177 | int need_8bit_cte); |
10f2fbff | 178 | void pp_remainder(struct pretty_print_context *pp, |
b02bd65f DB |
179 | const char **msg_p, |
180 | struct strbuf *sb, | |
181 | int indent); | |
182 | ||
e3bc7a3b | 183 | |
dd97f850 DB |
184 | /** Removes the first commit from a list sorted by date, and adds all |
185 | * of its parents. | |
186 | **/ | |
a6080a0a | 187 | struct commit *pop_most_recent_commit(struct commit_list **list, |
58e28af6 | 188 | unsigned int mark); |
dd97f850 | 189 | |
a3437b8c JS |
190 | struct commit *pop_commit(struct commit_list **stack); |
191 | ||
f8f9c73c | 192 | void clear_commit_marks(struct commit *commit, unsigned int mark); |
e895cb51 | 193 | void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark); |
86a0a408 | 194 | void clear_commit_marks_for_object_array(struct object_array *a, unsigned mark); |
f8f9c73c | 195 | |
08f704f2 JH |
196 | |
197 | enum rev_sort_order { | |
198 | REV_SORT_IN_GRAPH_ORDER = 0, | |
81c6b38b JH |
199 | REV_SORT_BY_COMMIT_DATE, |
200 | REV_SORT_BY_AUTHOR_DATE | |
08f704f2 JH |
201 | }; |
202 | ||
ab580ace JS |
203 | /* |
204 | * Performs an in-place topological sort of list supplied. | |
205 | * | |
ab580ace JS |
206 | * invariant of resulting list is: |
207 | * a reachable from b => ord(b) < ord(a) | |
08f704f2 JH |
208 | * sort_order further specifies: |
209 | * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent | |
210 | * chain together. | |
211 | * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order. | |
ab580ace | 212 | */ |
08f704f2 | 213 | void sort_in_topological_order(struct commit_list **, enum rev_sort_order); |
5040f17e JH |
214 | |
215 | struct commit_graft { | |
216 | unsigned char sha1[20]; | |
ed09aef0 | 217 | int nr_parent; /* < 0 if shallow commit */ |
5040f17e JH |
218 | unsigned char parent[FLEX_ARRAY][20]; /* more */ |
219 | }; | |
09d46644 | 220 | typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *); |
5040f17e JH |
221 | |
222 | struct commit_graft *read_graft_line(char *buf, int len); | |
223 | int register_commit_graft(struct commit_graft *, int); | |
45163382 | 224 | struct commit_graft *lookup_commit_graft(const unsigned char *sha1); |
5040f17e | 225 | |
c0fa8255 | 226 | extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup); |
53eda89b | 227 | extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos, int cleanup); |
5240c9d7 | 228 | extern struct commit_list *get_octopus_merge_bases(struct commit_list *in); |
7c6f8aaf | 229 | |
41ccfdd9 | 230 | /* largest positive number a signed 32-bit integer can contain */ |
4dcb167f NTND |
231 | #define INFINITE_DEPTH 0x7fffffff |
232 | ||
58babfff NTND |
233 | struct sha1_array; |
234 | struct ref; | |
ed09aef0 | 235 | extern int register_shallow(const unsigned char *sha1); |
f53514bc | 236 | extern int unregister_shallow(const unsigned char *sha1); |
09d46644 | 237 | extern int for_each_commit_graft(each_commit_graft_fn, void *); |
f43117a6 | 238 | extern int is_repository_shallow(void); |
ed09aef0 | 239 | extern struct commit_list *get_shallow_commits(struct object_array *heads, |
f53514bc | 240 | int depth, int shallow_flag, int not_shallow_flag); |
6035d6aa | 241 | extern void check_shallow_file_for_update(void); |
069c0532 | 242 | extern void set_alternate_shallow_file(const char *path, int override); |
1a30f5a2 NTND |
243 | extern int write_shallow_commits(struct strbuf *out, int use_pack_protocol, |
244 | const struct sha1_array *extra); | |
3125fe52 | 245 | extern void setup_alternate_shallow(struct lock_file *shallow_lock, |
1a30f5a2 NTND |
246 | const char **alternate_shallow_file, |
247 | const struct sha1_array *extra); | |
0179c945 | 248 | extern const char *setup_temporary_shallow(const struct sha1_array *extra); |
ad491366 | 249 | extern void advertise_shallow_grafts(int); |
ed09aef0 | 250 | |
58babfff NTND |
251 | struct shallow_info { |
252 | struct sha1_array *shallow; | |
253 | int *ours, nr_ours; | |
254 | int *theirs, nr_theirs; | |
255 | struct sha1_array *ref; | |
0a1bc12b NTND |
256 | |
257 | /* for receive-pack */ | |
258 | uint32_t **used_shallow; | |
259 | int *need_reachability_test; | |
260 | int *reachable; | |
261 | int *shallow_ref; | |
262 | struct commit **commits; | |
263 | int nr_commits; | |
58babfff NTND |
264 | }; |
265 | ||
266 | extern void prepare_shallow_info(struct shallow_info *, struct sha1_array *); | |
267 | extern void clear_shallow_info(struct shallow_info *); | |
268 | extern void remove_nonexistent_theirs_shallow(struct shallow_info *); | |
8e277383 NTND |
269 | extern void assign_shallow_commits_to_refs(struct shallow_info *info, |
270 | uint32_t **used, | |
271 | int *ref_status); | |
0a1bc12b | 272 | extern int delayed_reachability_test(struct shallow_info *si, int c); |
eab3296c | 273 | extern void prune_shallow(int show_only); |
ed09aef0 | 274 | |
7fcdb36e | 275 | int is_descendant_of(struct commit *, struct commit_list *); |
a20efee9 | 276 | int in_merge_bases(struct commit *, struct commit *); |
4c4b27e8 | 277 | int in_merge_bases_many(struct commit *, int, struct commit **); |
58680165 | 278 | |
b4bd4668 | 279 | extern int interactive_add(int argc, const char **argv, const char *prefix, int patch); |
46b5139c | 280 | extern int run_add_interactive(const char *revision, const char *patch_mode, |
480ca644 | 281 | const struct pathspec *pathspec); |
58680165 | 282 | |
53b2c823 LT |
283 | static inline int single_parent(struct commit *commit) |
284 | { | |
285 | return commit->parents && !commit->parents->next; | |
286 | } | |
287 | ||
98cf9c3b JH |
288 | struct commit_list *reduce_heads(struct commit_list *heads); |
289 | ||
5231c633 JH |
290 | struct commit_extra_header { |
291 | struct commit_extra_header *next; | |
292 | char *key; | |
293 | char *value; | |
294 | size_t len; | |
295 | }; | |
296 | ||
297 | extern void append_merge_tag_headers(struct commit_list *parents, | |
298 | struct commit_extra_header ***tail); | |
299 | ||
3ffefb54 JK |
300 | extern int commit_tree(const char *msg, size_t msg_len, |
301 | const unsigned char *tree, | |
5231c633 | 302 | struct commit_list *parents, unsigned char *ret, |
ba3c69a9 | 303 | const char *author, const char *sign_commit); |
5231c633 | 304 | |
3ffefb54 JK |
305 | extern int commit_tree_extended(const char *msg, size_t msg_len, |
306 | const unsigned char *tree, | |
5231c633 | 307 | struct commit_list *parents, unsigned char *ret, |
ba3c69a9 | 308 | const char *author, const char *sign_commit, |
5231c633 JH |
309 | struct commit_extra_header *); |
310 | ||
c871a1d1 | 311 | extern struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **); |
ed7a42a0 | 312 | |
5231c633 | 313 | extern void free_commit_extra_headers(struct commit_extra_header *extra); |
40d52ff7 | 314 | |
ae8e4c9c JH |
315 | struct merge_remote_desc { |
316 | struct object *obj; /* the named object, could be a tag */ | |
317 | const char *name; | |
318 | }; | |
319 | #define merge_remote_util(commit) ((struct merge_remote_desc *)((commit)->util)) | |
320 | ||
321 | /* | |
322 | * Given "name" from the command line to merge, find the commit object | |
323 | * and return it, while storing merge_remote_desc in its ->util field, | |
324 | * to allow callers to tell if we are told to merge a tag. | |
325 | */ | |
326 | struct commit *get_merge_parent(const char *name); | |
327 | ||
218aa3a6 | 328 | extern int parse_signed_commit(const struct commit *commit, |
0c37f1fc | 329 | struct strbuf *message, struct strbuf *signature); |
efc7df45 NTND |
330 | extern void print_commit_list(struct commit_list *list, |
331 | const char *format_cur, | |
332 | const char *format_last); | |
333 | ||
ffb6d7d5 | 334 | /* |
eb307ae7 SG |
335 | * Check the signature of the given commit. The result of the check is stored |
336 | * in sig->check_result, 'G' for a good signature, 'U' for a good signature | |
337 | * from an untrusted signer, 'B' for a bad signature and 'N' for no signature | |
338 | * at all. This may allocate memory for sig->gpg_output, sig->gpg_status, | |
339 | * sig->signer and sig->key. | |
ffb6d7d5 SG |
340 | */ |
341 | extern void check_commit_signature(const struct commit* commit, struct signature_check *sigc); | |
342 | ||
727377ff JK |
343 | int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused); |
344 | ||
15048f8a BP |
345 | LAST_ARG_MUST_BE_NULL |
346 | extern int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...); | |
347 | ||
6eb8ae00 | 348 | #endif /* COMMIT_H */ |