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" |
cf394719 | 10 | #include "pretty.h" |
5284fc5c | 11 | #include "commit-slab.h" |
6eb8ae00 | 12 | |
177722b3 | 13 | #define COMMIT_NOT_FROM_GRAPH 0xFFFFFFFF |
83073cc9 DS |
14 | #define GENERATION_NUMBER_INFINITY 0xFFFFFFFF |
15 | #define GENERATION_NUMBER_MAX 0x3FFFFFFF | |
16 | #define GENERATION_NUMBER_ZERO 0 | |
177722b3 | 17 | |
6eb8ae00 DB |
18 | struct commit_list { |
19 | struct commit *item; | |
20 | struct commit_list *next; | |
21 | }; | |
22 | ||
9d2c9701 NTND |
23 | /* |
24 | * The size of this struct matters in full repo walk operations like | |
25 | * 'git clone' or 'git gc'. Consider using commit-slab to attach data | |
26 | * to a commit instead of adding new fields here. | |
27 | */ | |
6eb8ae00 DB |
28 | struct commit { |
29 | struct object object; | |
dddbad72 | 30 | timestamp_t date; |
6eb8ae00 | 31 | struct commit_list *parents; |
7b8a21db DS |
32 | |
33 | /* | |
34 | * If the commit is loaded from the commit-graph file, then this | |
301b8c7f | 35 | * member may be NULL. Only access it through repo_get_commit_tree() |
7b8a21db DS |
36 | * or get_commit_tree_oid(). |
37 | */ | |
891435d5 | 38 | struct tree *maybe_tree; |
177722b3 | 39 | uint32_t graph_pos; |
83073cc9 | 40 | uint32_t generation; |
25f859fd | 41 | unsigned int index; |
6eb8ae00 DB |
42 | }; |
43 | ||
60ab26de | 44 | extern int save_commit_buffer; |
6eb8ae00 DB |
45 | extern const char *commit_type; |
46 | ||
ca135e7a | 47 | /* While we can decorate any object with a name, it's only used for commits.. */ |
ca135e7a LT |
48 | struct name_decoration { |
49 | struct name_decoration *next; | |
eb3005e2 | 50 | int type; |
2e3dfb21 | 51 | char name[FLEX_ARRAY]; |
ca135e7a LT |
52 | }; |
53 | ||
662174d2 JK |
54 | enum decoration_type { |
55 | DECORATION_NONE = 0, | |
56 | DECORATION_REF_LOCAL, | |
57 | DECORATION_REF_REMOTE, | |
58 | DECORATION_REF_TAG, | |
59 | DECORATION_REF_STASH, | |
60 | DECORATION_REF_HEAD, | |
61 | DECORATION_GRAFTED, | |
62 | }; | |
63 | ||
64 | void add_name_decoration(enum decoration_type type, const char *name, struct object *obj); | |
2608c249 | 65 | const struct name_decoration *get_name_decoration(const struct object *obj); |
662174d2 | 66 | |
bacf1687 | 67 | struct commit *lookup_commit(struct repository *r, const struct object_id *oid); |
1f6c72fe SB |
68 | struct commit *lookup_commit_reference(struct repository *r, |
69 | const struct object_id *oid); | |
d9a05e74 | 70 | struct commit *lookup_commit_reference_gently(struct repository *r, |
21e1ee8f | 71 | const struct object_id *oid, |
f76412ed | 72 | int quiet); |
a6fa5992 | 73 | struct commit *lookup_commit_reference_by_name(const char *name); |
6eb8ae00 | 74 | |
baf18fc2 | 75 | /* |
bc83266a | 76 | * Look up object named by "oid", dereference tag as necessary, |
77 | * get a commit and return it. If "oid" does not dereference to | |
baf18fc2 NTND |
78 | * a commit, use ref_name to report an error and die. |
79 | */ | |
bc83266a | 80 | struct commit *lookup_commit_or_die(const struct object_id *oid, const char *ref_name); |
baf18fc2 | 81 | |
fd8030c7 | 82 | int parse_commit_buffer(struct repository *r, struct commit *item, const void *buffer, unsigned long size, int check_graph); |
9e5252ab SB |
83 | int repo_parse_commit_internal(struct repository *r, struct commit *item, |
84 | int quiet_on_missing, int use_commit_graph); | |
85 | int repo_parse_commit_gently(struct repository *r, | |
86 | struct commit *item, | |
87 | int quiet_on_missing); | |
88 | static inline int repo_parse_commit(struct repository *r, struct commit *item) | |
9cc2b07a | 89 | { |
9e5252ab | 90 | return repo_parse_commit_gently(r, item, 0); |
9cc2b07a | 91 | } |
43d35618 ÆAB |
92 | |
93 | static inline int parse_commit_no_graph(struct commit *commit) | |
94 | { | |
95 | return repo_parse_commit_internal(the_repository, commit, 0, 0); | |
96 | } | |
97 | ||
9e5252ab SB |
98 | #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS |
99 | #define parse_commit_internal(item, quiet, use) repo_parse_commit_internal(the_repository, item, quiet, use) | |
100 | #define parse_commit_gently(item, quiet) repo_parse_commit_gently(the_repository, item, quiet) | |
101 | #define parse_commit(item) repo_parse_commit(the_repository, item) | |
102 | #endif | |
103 | ||
7059dccc | 104 | void parse_commit_or_die(struct commit *item); |
6eb8ae00 | 105 | |
65ea9d4b SB |
106 | struct buffer_slab; |
107 | struct buffer_slab *allocate_commit_buffer_slab(void); | |
108 | void free_commit_buffer_slab(struct buffer_slab *bs); | |
109 | ||
66c2827e JK |
110 | /* |
111 | * Associate an object buffer with the commit. The ownership of the | |
112 | * memory is handed over to the commit, and must be free()-able. | |
113 | */ | |
1a40fc45 | 114 | void set_commit_buffer(struct repository *r, struct commit *, void *buffer, unsigned long size); |
66c2827e | 115 | |
152ff1cc JK |
116 | /* |
117 | * Get any cached object buffer associated with the commit. Returns NULL | |
118 | * if none. The resulting memory should not be freed. | |
119 | */ | |
4ff7e5c9 | 120 | const void *get_cached_commit_buffer(struct repository *, const struct commit *, unsigned long *size); |
152ff1cc JK |
121 | |
122 | /* | |
123 | * Get the commit's object contents, either from cache or by reading the object | |
124 | * from disk. The resulting memory should not be modified, and must be given | |
125 | * to unuse_commit_buffer when the caller is done. | |
126 | */ | |
07de3fd8 SB |
127 | const void *repo_get_commit_buffer(struct repository *r, |
128 | const struct commit *, | |
129 | unsigned long *size); | |
130 | #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS | |
131 | #define get_commit_buffer(c, s) repo_get_commit_buffer(the_repository, c, s) | |
132 | #endif | |
152ff1cc JK |
133 | |
134 | /* | |
135 | * Tell the commit subsytem that we are done with a particular commit buffer. | |
136 | * The commit and buffer should be the input and return value, respectively, | |
137 | * from an earlier call to get_commit_buffer. The buffer may or may not be | |
138 | * freed by this call; callers should not access the memory afterwards. | |
139 | */ | |
70315373 SB |
140 | void repo_unuse_commit_buffer(struct repository *r, |
141 | const struct commit *, | |
142 | const void *buffer); | |
143 | #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS | |
144 | #define unuse_commit_buffer(c, b) repo_unuse_commit_buffer(the_repository, c, b) | |
145 | #endif | |
152ff1cc | 146 | |
0fb370da JK |
147 | /* |
148 | * Free any cached object buffer associated with the commit. | |
149 | */ | |
6a7895fd | 150 | void free_commit_buffer(struct parsed_object_pool *pool, struct commit *); |
0fb370da | 151 | |
301b8c7f NTND |
152 | struct tree *repo_get_commit_tree(struct repository *, const struct commit *); |
153 | #define get_commit_tree(c) repo_get_commit_tree(the_repository, c) | |
5bb03de1 DS |
154 | struct object_id *get_commit_tree_oid(const struct commit *); |
155 | ||
14ba97f8 SB |
156 | /* |
157 | * Release memory related to a commit, including the parent list and | |
158 | * any cached object buffer. | |
159 | */ | |
6a7895fd | 160 | void release_commit_memory(struct parsed_object_pool *pool, struct commit *c); |
14ba97f8 | 161 | |
0fb370da JK |
162 | /* |
163 | * Disassociate any cached object buffer from the commit, but do not free it. | |
164 | * The buffer (or NULL, if none) is returned. | |
165 | */ | |
8597ea3a | 166 | const void *detach_commit_buffer(struct commit *, unsigned long *sizep); |
0fb370da | 167 | |
11af2aae CC |
168 | /* Find beginning and length of commit subject. */ |
169 | int find_commit_subject(const char *commit_buffer, const char **subject); | |
170 | ||
47e44ed1 TF |
171 | struct commit_list *commit_list_insert(struct commit *item, |
172 | struct commit_list **list); | |
89b5f1d9 RS |
173 | struct commit_list **commit_list_append(struct commit *commit, |
174 | struct commit_list **next); | |
65319475 | 175 | unsigned commit_list_count(const struct commit_list *l); |
47e44ed1 TF |
176 | struct commit_list *commit_list_insert_by_date(struct commit *item, |
177 | struct commit_list **list); | |
178 | void commit_list_sort_by_date(struct commit_list **list); | |
dd97f850 | 179 | |
53d00b39 TR |
180 | /* Shallow copy of the input list */ |
181 | struct commit_list *copy_commit_list(struct commit_list *list); | |
182 | ||
6eb8ae00 DB |
183 | void free_commit_list(struct commit_list *list); |
184 | ||
6d167fd7 RS |
185 | struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */ |
186 | ||
55454427 DL |
187 | int has_non_ascii(const char *text); |
188 | const char *logmsg_reencode(const struct commit *commit, | |
ad6dad09 DL |
189 | char **commit_encoding, |
190 | const char *output_encoding); | |
424510ed SB |
191 | const char *repo_logmsg_reencode(struct repository *r, |
192 | const struct commit *commit, | |
193 | char **commit_encoding, | |
194 | const char *output_encoding); | |
195 | #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS | |
196 | #define logmsg_reencode(c, enc, out) repo_logmsg_reencode(the_repository, c, enc, out) | |
197 | #endif | |
198 | ||
55454427 | 199 | const char *skip_blank_lines(const char *msg); |
e3bc7a3b | 200 | |
dd97f850 DB |
201 | /** Removes the first commit from a list sorted by date, and adds all |
202 | * of its parents. | |
203 | **/ | |
a6080a0a | 204 | struct commit *pop_most_recent_commit(struct commit_list **list, |
58e28af6 | 205 | unsigned int mark); |
dd97f850 | 206 | |
a3437b8c | 207 | struct commit *pop_commit(struct commit_list **stack); |
208 | ||
f8f9c73c | 209 | void clear_commit_marks(struct commit *commit, unsigned int mark); |
e895cb51 | 210 | void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark); |
f8f9c73c | 211 | |
08f704f2 JH |
212 | |
213 | enum rev_sort_order { | |
214 | REV_SORT_IN_GRAPH_ORDER = 0, | |
81c6b38b JH |
215 | REV_SORT_BY_COMMIT_DATE, |
216 | REV_SORT_BY_AUTHOR_DATE | |
08f704f2 JH |
217 | }; |
218 | ||
ab580ace JS |
219 | /* |
220 | * Performs an in-place topological sort of list supplied. | |
221 | * | |
ab580ace JS |
222 | * invariant of resulting list is: |
223 | * a reachable from b => ord(b) < ord(a) | |
08f704f2 JH |
224 | * sort_order further specifies: |
225 | * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent | |
226 | * chain together. | |
227 | * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order. | |
ab580ace | 228 | */ |
08f704f2 | 229 | void sort_in_topological_order(struct commit_list **, enum rev_sort_order); |
5040f17e JH |
230 | |
231 | struct commit_graft { | |
7683e2e6 | 232 | struct object_id oid; |
ed09aef0 | 233 | int nr_parent; /* < 0 if shallow commit */ |
7683e2e6 | 234 | struct object_id parent[FLEX_ARRAY]; /* more */ |
5040f17e | 235 | }; |
09d46644 | 236 | typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *); |
5040f17e | 237 | |
9a934032 | 238 | struct commit_graft *read_graft_line(struct strbuf *line); |
a3b78e83 | 239 | int register_commit_graft(struct repository *r, struct commit_graft *, int); |
20fd6d57 | 240 | void prepare_commit_graft(struct repository *r); |
b9dbddf6 | 241 | struct commit_graft *lookup_commit_graft(struct repository *r, const struct object_id *oid); |
5040f17e | 242 | |
103148aa PK |
243 | struct commit *get_fork_point(const char *refname, struct commit *commit); |
244 | ||
41ccfdd9 | 245 | /* largest positive number a signed 32-bit integer can contain */ |
4dcb167f NTND |
246 | #define INFINITE_DEPTH 0x7fffffff |
247 | ||
910650d2 | 248 | struct oid_array; |
58babfff | 249 | struct ref; |
55454427 DL |
250 | int register_shallow(struct repository *r, const struct object_id *oid); |
251 | int unregister_shallow(const struct object_id *oid); | |
252 | int for_each_commit_graft(each_commit_graft_fn, void *); | |
253 | int is_repository_shallow(struct repository *r); | |
254 | struct commit_list *get_shallow_commits(struct object_array *heads, | |
ad6dad09 | 255 | int depth, int shallow_flag, int not_shallow_flag); |
55454427 | 256 | struct commit_list *get_shallow_commits_by_rev_list( |
3d9ff4d7 | 257 | int ac, const char **av, int shallow_flag, int not_shallow_flag); |
55454427 DL |
258 | void set_alternate_shallow_file(struct repository *r, const char *path, int override); |
259 | int write_shallow_commits(struct strbuf *out, int use_pack_protocol, | |
ad6dad09 | 260 | const struct oid_array *extra); |
55454427 | 261 | void setup_alternate_shallow(struct lock_file *shallow_lock, |
ad6dad09 DL |
262 | const char **alternate_shallow_file, |
263 | const struct oid_array *extra); | |
55454427 DL |
264 | const char *setup_temporary_shallow(const struct oid_array *extra); |
265 | void advertise_shallow_grafts(int); | |
ed09aef0 | 266 | |
1e7d440b JT |
267 | /* |
268 | * Initialize with prepare_shallow_info() or zero-initialize (equivalent to | |
269 | * prepare_shallow_info with a NULL oid_array). | |
270 | */ | |
58babfff | 271 | struct shallow_info { |
910650d2 | 272 | struct oid_array *shallow; |
58babfff NTND |
273 | int *ours, nr_ours; |
274 | int *theirs, nr_theirs; | |
910650d2 | 275 | struct oid_array *ref; |
0a1bc12b NTND |
276 | |
277 | /* for receive-pack */ | |
278 | uint32_t **used_shallow; | |
279 | int *need_reachability_test; | |
280 | int *reachable; | |
281 | int *shallow_ref; | |
282 | struct commit **commits; | |
283 | int nr_commits; | |
58babfff NTND |
284 | }; |
285 | ||
55454427 DL |
286 | void prepare_shallow_info(struct shallow_info *, struct oid_array *); |
287 | void clear_shallow_info(struct shallow_info *); | |
288 | void remove_nonexistent_theirs_shallow(struct shallow_info *); | |
289 | void assign_shallow_commits_to_refs(struct shallow_info *info, | |
ad6dad09 DL |
290 | uint32_t **used, |
291 | int *ref_status); | |
55454427 | 292 | int delayed_reachability_test(struct shallow_info *si, int c); |
2588f6ed JS |
293 | #define PRUNE_SHOW_ONLY 1 |
294 | #define PRUNE_QUICK 2 | |
55454427 | 295 | void prune_shallow(unsigned options); |
6aa30857 | 296 | extern struct trace_key trace_shallow; |
ed09aef0 | 297 | |
55454427 DL |
298 | int interactive_add(int argc, const char **argv, const char *prefix, int patch); |
299 | int run_add_interactive(const char *revision, const char *patch_mode, | |
ad6dad09 | 300 | const struct pathspec *pathspec); |
58680165 | 301 | |
5231c633 JH |
302 | struct commit_extra_header { |
303 | struct commit_extra_header *next; | |
304 | char *key; | |
305 | char *value; | |
306 | size_t len; | |
307 | }; | |
308 | ||
55454427 | 309 | void append_merge_tag_headers(struct commit_list *parents, |
ad6dad09 | 310 | struct commit_extra_header ***tail); |
5231c633 | 311 | |
55454427 | 312 | int commit_tree(const char *msg, size_t msg_len, |
ad6dad09 DL |
313 | const struct object_id *tree, |
314 | struct commit_list *parents, struct object_id *ret, | |
315 | const char *author, const char *sign_commit); | |
5231c633 | 316 | |
55454427 | 317 | int commit_tree_extended(const char *msg, size_t msg_len, |
ad6dad09 DL |
318 | const struct object_id *tree, |
319 | struct commit_list *parents, | |
320 | struct object_id *ret, const char *author, | |
321 | const char *sign_commit, | |
322 | struct commit_extra_header *); | |
5231c633 | 323 | |
55454427 | 324 | struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **); |
ed7a42a0 | 325 | |
55454427 | 326 | void free_commit_extra_headers(struct commit_extra_header *extra); |
40d52ff7 | 327 | |
fe6eb7f2 JK |
328 | /* |
329 | * Search the commit object contents given by "msg" for the header "key". | |
330 | * Returns a pointer to the start of the header contents, or NULL. The length | |
331 | * of the header, up to the first newline, is returned via out_len. | |
332 | * | |
333 | * Note that some headers (like mergetag) may be multi-line. It is the caller's | |
334 | * responsibility to parse further in this case! | |
335 | */ | |
55454427 | 336 | const char *find_commit_header(const char *msg, const char *key, |
ad6dad09 | 337 | size_t *out_len); |
fe6eb7f2 | 338 | |
8c384589 | 339 | /* Find the end of the log message, the right place for a new trailer. */ |
55454427 | 340 | size_t ignore_non_trailer(const char *buf, size_t len); |
8c384589 | 341 | |
fef461ea | 342 | typedef int (*each_mergetag_fn)(struct commit *commit, struct commit_extra_header *extra, |
ad6dad09 | 343 | void *cb_data); |
063da62b | 344 | |
55454427 | 345 | int for_each_mergetag(each_mergetag_fn fn, struct commit *commit, void *data); |
063da62b | 346 | |
ae8e4c9c JH |
347 | struct merge_remote_desc { |
348 | struct object *obj; /* the named object, could be a tag */ | |
5447a76a | 349 | char name[FLEX_ARRAY]; |
ae8e4c9c | 350 | }; |
55454427 DL |
351 | struct merge_remote_desc *merge_remote_util(struct commit *); |
352 | void set_merge_remote_desc(struct commit *commit, | |
ad6dad09 | 353 | const char *name, struct object *obj); |
ae8e4c9c JH |
354 | |
355 | /* | |
356 | * Given "name" from the command line to merge, find the commit object | |
357 | * and return it, while storing merge_remote_desc in its ->util field, | |
358 | * to allow callers to tell if we are told to merge a tag. | |
359 | */ | |
360 | struct commit *get_merge_parent(const char *name); | |
361 | ||
55454427 | 362 | int parse_signed_commit(const struct commit *commit, |
ad6dad09 | 363 | struct strbuf *message, struct strbuf *signature); |
55454427 | 364 | int remove_signature(struct strbuf *buf); |
0b05ab6f | 365 | |
ffb6d7d5 | 366 | /* |
eb307ae7 SG |
367 | * Check the signature of the given commit. The result of the check is stored |
368 | * in sig->check_result, 'G' for a good signature, 'U' for a good signature | |
369 | * from an untrusted signer, 'B' for a bad signature and 'N' for no signature | |
370 | * at all. This may allocate memory for sig->gpg_output, sig->gpg_status, | |
371 | * sig->signer and sig->key. | |
ffb6d7d5 | 372 | */ |
55454427 | 373 | int check_commit_signature(const struct commit *commit, struct signature_check *sigc); |
ffb6d7d5 | 374 | |
5284fc5c DS |
375 | /* record author-date for each commit object */ |
376 | struct author_date_slab; | |
377 | void record_author_date(struct author_date_slab *author_date, | |
378 | struct commit *commit); | |
379 | ||
380 | int compare_commits_by_author_date(const void *a_, const void *b_, void *unused); | |
6d2035ee | 381 | |
edc4d47d JK |
382 | /* |
383 | * Verify a single commit with check_commit_signature() and die() if it is not | |
384 | * a good signature. This isn't really suitable for general use, but is a | |
385 | * helper to implement consistent logic for pull/merge --verify-signatures. | |
386 | */ | |
387 | void verify_merge_signature(struct commit *commit, int verbose); | |
388 | ||
727377ff | 389 | int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused); |
3afc679b | 390 | int compare_commits_by_gen_then_commit_date(const void *a_, const void *b_, void *unused); |
727377ff | 391 | |
15048f8a | 392 | LAST_ARG_MUST_BE_NULL |
b199d714 | 393 | int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...); |
15048f8a | 394 | |
6eb8ae00 | 395 | #endif /* COMMIT_H */ |