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