]>
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 |
d7f92784 AK |
14 | #define GENERATION_NUMBER_INFINITY ((1ULL << 63) - 1) |
15 | #define GENERATION_NUMBER_V1_MAX 0x3FFFFFFF | |
83073cc9 | 16 | #define GENERATION_NUMBER_ZERO 0 |
e8b63005 | 17 | #define GENERATION_NUMBER_V2_OFFSET_MAX ((1ULL << 31) - 1) |
177722b3 | 18 | |
6eb8ae00 DB |
19 | struct commit_list { |
20 | struct commit *item; | |
21 | struct commit_list *next; | |
22 | }; | |
23 | ||
9d2c9701 NTND |
24 | /* |
25 | * The size of this struct matters in full repo walk operations like | |
26 | * 'git clone' or 'git gc'. Consider using commit-slab to attach data | |
27 | * to a commit instead of adding new fields here. | |
28 | */ | |
6eb8ae00 DB |
29 | struct commit { |
30 | struct object object; | |
dddbad72 | 31 | timestamp_t date; |
6eb8ae00 | 32 | struct commit_list *parents; |
7b8a21db DS |
33 | |
34 | /* | |
35 | * If the commit is loaded from the commit-graph file, then this | |
301b8c7f | 36 | * member may be NULL. Only access it through repo_get_commit_tree() |
7b8a21db DS |
37 | * or get_commit_tree_oid(). |
38 | */ | |
891435d5 | 39 | struct tree *maybe_tree; |
25f859fd | 40 | unsigned int index; |
6eb8ae00 DB |
41 | }; |
42 | ||
60ab26de | 43 | extern int save_commit_buffer; |
ab628588 | 44 | extern int no_graft_file_deprecated_advice; |
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 | |
b8dbfd03 PW |
67 | /* |
68 | * Look up commit named by "oid" respecting replacement objects. | |
69 | * Returns NULL if "oid" is not a commit or does not exist. | |
70 | */ | |
71 | struct commit *lookup_commit_object(struct repository *r, const struct object_id *oid); | |
72 | ||
73 | /* | |
74 | * Look up commit named by "oid" without replacement objects or | |
75 | * checking for object existence. Returns the requested commit if it | |
76 | * is found in the object cache, NULL if "oid" is in the object cache | |
77 | * but is not a commit and a newly allocated unparsed commit object if | |
78 | * "oid" is not in the object cache. | |
79 | */ | |
bacf1687 | 80 | struct commit *lookup_commit(struct repository *r, const struct object_id *oid); |
1f6c72fe SB |
81 | struct commit *lookup_commit_reference(struct repository *r, |
82 | const struct object_id *oid); | |
d9a05e74 | 83 | struct commit *lookup_commit_reference_gently(struct repository *r, |
21e1ee8f | 84 | const struct object_id *oid, |
f76412ed | 85 | int quiet); |
a6fa5992 | 86 | struct commit *lookup_commit_reference_by_name(const char *name); |
6eb8ae00 | 87 | |
baf18fc2 | 88 | /* |
bc83266a | 89 | * Look up object named by "oid", dereference tag as necessary, |
90 | * get a commit and return it. If "oid" does not dereference to | |
baf18fc2 NTND |
91 | * a commit, use ref_name to report an error and die. |
92 | */ | |
bc83266a | 93 | struct commit *lookup_commit_or_die(const struct object_id *oid, const char *ref_name); |
baf18fc2 | 94 | |
fd8030c7 | 95 | int parse_commit_buffer(struct repository *r, struct commit *item, const void *buffer, unsigned long size, int check_graph); |
9e5252ab SB |
96 | int repo_parse_commit_internal(struct repository *r, struct commit *item, |
97 | int quiet_on_missing, int use_commit_graph); | |
98 | int repo_parse_commit_gently(struct repository *r, | |
99 | struct commit *item, | |
100 | int quiet_on_missing); | |
101 | static inline int repo_parse_commit(struct repository *r, struct commit *item) | |
9cc2b07a | 102 | { |
9e5252ab | 103 | return repo_parse_commit_gently(r, item, 0); |
9cc2b07a | 104 | } |
43d35618 | 105 | |
c4cc0831 DS |
106 | static inline int repo_parse_commit_no_graph(struct repository *r, |
107 | struct commit *commit) | |
43d35618 | 108 | { |
c4cc0831 | 109 | return repo_parse_commit_internal(r, commit, 0, 0); |
43d35618 ÆAB |
110 | } |
111 | ||
7059dccc | 112 | void parse_commit_or_die(struct commit *item); |
6eb8ae00 | 113 | |
65ea9d4b SB |
114 | struct buffer_slab; |
115 | struct buffer_slab *allocate_commit_buffer_slab(void); | |
116 | void free_commit_buffer_slab(struct buffer_slab *bs); | |
117 | ||
66c2827e JK |
118 | /* |
119 | * Associate an object buffer with the commit. The ownership of the | |
120 | * memory is handed over to the commit, and must be free()-able. | |
121 | */ | |
1a40fc45 | 122 | void set_commit_buffer(struct repository *r, struct commit *, void *buffer, unsigned long size); |
66c2827e | 123 | |
152ff1cc JK |
124 | /* |
125 | * Get any cached object buffer associated with the commit. Returns NULL | |
126 | * if none. The resulting memory should not be freed. | |
127 | */ | |
4ff7e5c9 | 128 | const void *get_cached_commit_buffer(struct repository *, const struct commit *, unsigned long *size); |
152ff1cc JK |
129 | |
130 | /* | |
131 | * Get the commit's object contents, either from cache or by reading the object | |
132 | * from disk. The resulting memory should not be modified, and must be given | |
c7c33f50 | 133 | * to repo_unuse_commit_buffer when the caller is done. |
152ff1cc | 134 | */ |
07de3fd8 SB |
135 | const void *repo_get_commit_buffer(struct repository *r, |
136 | const struct commit *, | |
137 | unsigned long *size); | |
152ff1cc JK |
138 | |
139 | /* | |
15beaaa3 | 140 | * Tell the commit subsystem that we are done with a particular commit buffer. |
152ff1cc | 141 | * The commit and buffer should be the input and return value, respectively, |
c7c33f50 | 142 | * from an earlier call to repo_get_commit_buffer. The buffer may or may not be |
152ff1cc JK |
143 | * freed by this call; callers should not access the memory afterwards. |
144 | */ | |
70315373 SB |
145 | void repo_unuse_commit_buffer(struct repository *r, |
146 | const struct commit *, | |
147 | const void *buffer); | |
152ff1cc | 148 | |
0fb370da JK |
149 | /* |
150 | * Free any cached object buffer associated with the commit. | |
151 | */ | |
6a7895fd | 152 | void free_commit_buffer(struct parsed_object_pool *pool, struct commit *); |
0fb370da | 153 | |
301b8c7f | 154 | struct tree *repo_get_commit_tree(struct repository *, const struct commit *); |
5bb03de1 DS |
155 | struct object_id *get_commit_tree_oid(const struct commit *); |
156 | ||
14ba97f8 SB |
157 | /* |
158 | * Release memory related to a commit, including the parent list and | |
159 | * any cached object buffer. | |
160 | */ | |
6a7895fd | 161 | void release_commit_memory(struct parsed_object_pool *pool, struct commit *c); |
14ba97f8 | 162 | |
0fb370da JK |
163 | /* |
164 | * Disassociate any cached object buffer from the commit, but do not free it. | |
165 | * The buffer (or NULL, if none) is returned. | |
166 | */ | |
8597ea3a | 167 | const void *detach_commit_buffer(struct commit *, unsigned long *sizep); |
0fb370da | 168 | |
11af2aae CC |
169 | /* Find beginning and length of commit subject. */ |
170 | int find_commit_subject(const char *commit_buffer, const char **subject); | |
171 | ||
6e0e2887 CM |
172 | /* Return length of the commit subject from commit log message. */ |
173 | size_t commit_subject_length(const char *body); | |
174 | ||
47e44ed1 TF |
175 | struct commit_list *commit_list_insert(struct commit *item, |
176 | struct commit_list **list); | |
597b2c39 DS |
177 | int commit_list_contains(struct commit *item, |
178 | struct commit_list *list); | |
89b5f1d9 RS |
179 | struct commit_list **commit_list_append(struct commit *commit, |
180 | struct commit_list **next); | |
65319475 | 181 | unsigned commit_list_count(const struct commit_list *l); |
47e44ed1 TF |
182 | struct commit_list *commit_list_insert_by_date(struct commit *item, |
183 | struct commit_list **list); | |
184 | void commit_list_sort_by_date(struct commit_list **list); | |
dd97f850 | 185 | |
53d00b39 TR |
186 | /* Shallow copy of the input list */ |
187 | struct commit_list *copy_commit_list(struct commit_list *list); | |
188 | ||
b0ca1205 EN |
189 | /* Modify list in-place to reverse it, returning new head; list will be tail */ |
190 | struct commit_list *reverse_commit_list(struct commit_list *list); | |
191 | ||
6eb8ae00 DB |
192 | void free_commit_list(struct commit_list *list); |
193 | ||
6d167fd7 RS |
194 | struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */ |
195 | ||
424510ed SB |
196 | const char *repo_logmsg_reencode(struct repository *r, |
197 | const struct commit *commit, | |
198 | char **commit_encoding, | |
199 | const char *output_encoding); | |
424510ed | 200 | |
55454427 | 201 | const char *skip_blank_lines(const char *msg); |
e3bc7a3b | 202 | |
dd97f850 DB |
203 | /** Removes the first commit from a list sorted by date, and adds all |
204 | * of its parents. | |
205 | **/ | |
a6080a0a | 206 | struct commit *pop_most_recent_commit(struct commit_list **list, |
58e28af6 | 207 | unsigned int mark); |
dd97f850 | 208 | |
a3437b8c JS |
209 | struct commit *pop_commit(struct commit_list **stack); |
210 | ||
f8f9c73c | 211 | void clear_commit_marks(struct commit *commit, unsigned int mark); |
e895cb51 | 212 | void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark); |
f8f9c73c | 213 | |
08f704f2 JH |
214 | |
215 | enum rev_sort_order { | |
216 | REV_SORT_IN_GRAPH_ORDER = 0, | |
81c6b38b JH |
217 | REV_SORT_BY_COMMIT_DATE, |
218 | REV_SORT_BY_AUTHOR_DATE | |
08f704f2 JH |
219 | }; |
220 | ||
ab580ace JS |
221 | /* |
222 | * Performs an in-place topological sort of list supplied. | |
223 | * | |
ab580ace JS |
224 | * invariant of resulting list is: |
225 | * a reachable from b => ord(b) < ord(a) | |
08f704f2 JH |
226 | * sort_order further specifies: |
227 | * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent | |
228 | * chain together. | |
229 | * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order. | |
ab580ace | 230 | */ |
08f704f2 | 231 | void sort_in_topological_order(struct commit_list **, enum rev_sort_order); |
5040f17e JH |
232 | |
233 | struct commit_graft { | |
7683e2e6 | 234 | struct object_id oid; |
ed09aef0 | 235 | int nr_parent; /* < 0 if shallow commit */ |
7683e2e6 | 236 | struct object_id parent[FLEX_ARRAY]; /* more */ |
5040f17e | 237 | }; |
09d46644 | 238 | typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *); |
5040f17e | 239 | |
9a934032 | 240 | struct commit_graft *read_graft_line(struct strbuf *line); |
183df649 | 241 | /* commit_graft_pos returns an index into r->parsed_objects->grafts. */ |
98c431b6 | 242 | int commit_graft_pos(struct repository *r, const struct object_id *oid); |
a3b78e83 | 243 | int register_commit_graft(struct repository *r, struct commit_graft *, int); |
20fd6d57 | 244 | void prepare_commit_graft(struct repository *r); |
b9dbddf6 | 245 | struct commit_graft *lookup_commit_graft(struct repository *r, const struct object_id *oid); |
2a69ff09 | 246 | void reset_commit_grafts(struct repository *r); |
5040f17e | 247 | |
103148aa PK |
248 | struct commit *get_fork_point(const char *refname, struct commit *commit); |
249 | ||
41ccfdd9 | 250 | /* largest positive number a signed 32-bit integer can contain */ |
4dcb167f NTND |
251 | #define INFINITE_DEPTH 0x7fffffff |
252 | ||
910650d2 | 253 | struct oid_array; |
58babfff | 254 | struct ref; |
55454427 | 255 | int for_each_commit_graft(each_commit_graft_fn, void *); |
ed09aef0 | 256 | |
e885a84f | 257 | int interactive_add(const char **argv, const char *prefix, int patch); |
58680165 | 258 | |
5231c633 JH |
259 | struct commit_extra_header { |
260 | struct commit_extra_header *next; | |
261 | char *key; | |
262 | char *value; | |
263 | size_t len; | |
264 | }; | |
265 | ||
55454427 | 266 | void append_merge_tag_headers(struct commit_list *parents, |
ad6dad09 | 267 | struct commit_extra_header ***tail); |
5231c633 | 268 | |
55454427 | 269 | int commit_tree(const char *msg, size_t msg_len, |
ad6dad09 DL |
270 | const struct object_id *tree, |
271 | struct commit_list *parents, struct object_id *ret, | |
272 | const char *author, const char *sign_commit); | |
5231c633 | 273 | |
55454427 | 274 | int commit_tree_extended(const char *msg, size_t msg_len, |
ad6dad09 | 275 | const struct object_id *tree, |
e8cbe211 PW |
276 | struct commit_list *parents, struct object_id *ret, |
277 | const char *author, const char *committer, | |
278 | const char *sign_commit, struct commit_extra_header *); | |
5231c633 | 279 | |
55454427 | 280 | struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **); |
ed7a42a0 | 281 | |
55454427 | 282 | void free_commit_extra_headers(struct commit_extra_header *extra); |
40d52ff7 | 283 | |
fe6eb7f2 JK |
284 | /* |
285 | * Search the commit object contents given by "msg" for the header "key". | |
cfc5cf42 | 286 | * Reads up to "len" bytes of "msg". |
fe6eb7f2 JK |
287 | * Returns a pointer to the start of the header contents, or NULL. The length |
288 | * of the header, up to the first newline, is returned via out_len. | |
289 | * | |
290 | * Note that some headers (like mergetag) may be multi-line. It is the caller's | |
291 | * responsibility to parse further in this case! | |
292 | */ | |
cfc5cf42 JC |
293 | const char *find_header_mem(const char *msg, size_t len, |
294 | const char *key, | |
295 | size_t *out_len); | |
296 | ||
55454427 | 297 | const char *find_commit_header(const char *msg, const char *key, |
ad6dad09 | 298 | size_t *out_len); |
fe6eb7f2 | 299 | |
8c384589 | 300 | /* Find the end of the log message, the right place for a new trailer. */ |
55454427 | 301 | size_t ignore_non_trailer(const char *buf, size_t len); |
8c384589 | 302 | |
fef461ea | 303 | typedef int (*each_mergetag_fn)(struct commit *commit, struct commit_extra_header *extra, |
ad6dad09 | 304 | void *cb_data); |
063da62b | 305 | |
55454427 | 306 | int for_each_mergetag(each_mergetag_fn fn, struct commit *commit, void *data); |
063da62b | 307 | |
ae8e4c9c JH |
308 | struct merge_remote_desc { |
309 | struct object *obj; /* the named object, could be a tag */ | |
5447a76a | 310 | char name[FLEX_ARRAY]; |
ae8e4c9c | 311 | }; |
55454427 DL |
312 | struct merge_remote_desc *merge_remote_util(struct commit *); |
313 | void set_merge_remote_desc(struct commit *commit, | |
ad6dad09 | 314 | const char *name, struct object *obj); |
ae8e4c9c JH |
315 | |
316 | /* | |
317 | * Given "name" from the command line to merge, find the commit object | |
318 | * and return it, while storing merge_remote_desc in its ->util field, | |
319 | * to allow callers to tell if we are told to merge a tag. | |
320 | */ | |
321 | struct commit *get_merge_parent(const char *name); | |
322 | ||
55454427 | 323 | int parse_signed_commit(const struct commit *commit, |
1fb5cf0d | 324 | struct strbuf *message, struct strbuf *signature, |
325 | const struct git_hash_algo *algop); | |
55454427 | 326 | int remove_signature(struct strbuf *buf); |
0b05ab6f | 327 | |
ffb6d7d5 | 328 | /* |
eb307ae7 SG |
329 | * Check the signature of the given commit. The result of the check is stored |
330 | * in sig->check_result, 'G' for a good signature, 'U' for a good signature | |
331 | * from an untrusted signer, 'B' for a bad signature and 'N' for no signature | |
332 | * at all. This may allocate memory for sig->gpg_output, sig->gpg_status, | |
333 | * sig->signer and sig->key. | |
ffb6d7d5 | 334 | */ |
55454427 | 335 | int check_commit_signature(const struct commit *commit, struct signature_check *sigc); |
ffb6d7d5 | 336 | |
5284fc5c DS |
337 | /* record author-date for each commit object */ |
338 | struct author_date_slab; | |
339 | void record_author_date(struct author_date_slab *author_date, | |
340 | struct commit *commit); | |
341 | ||
342 | int compare_commits_by_author_date(const void *a_, const void *b_, void *unused); | |
6d2035ee | 343 | |
edc4d47d JK |
344 | /* |
345 | * Verify a single commit with check_commit_signature() and die() if it is not | |
346 | * a good signature. This isn't really suitable for general use, but is a | |
347 | * helper to implement consistent logic for pull/merge --verify-signatures. | |
54887b46 HJI |
348 | * |
349 | * The check_trust parameter is meant for backward-compatibility. The GPG | |
350 | * interface verifies key trust with a default trust level that is below the | |
351 | * default trust level for merge operations. Its value should be non-zero if | |
352 | * the user hasn't set a minimum trust level explicitly in their configuration. | |
353 | * | |
354 | * If the user has set a minimum trust level, then that value should be obeyed | |
355 | * and check_trust should be zero, even if the configured trust level is below | |
356 | * the default trust level for merges. | |
edc4d47d | 357 | */ |
54887b46 HJI |
358 | void verify_merge_signature(struct commit *commit, int verbose, |
359 | int check_trust); | |
edc4d47d | 360 | |
727377ff | 361 | int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused); |
3afc679b | 362 | int compare_commits_by_gen_then_commit_date(const void *a_, const void *b_, void *unused); |
727377ff | 363 | |
15048f8a | 364 | LAST_ARG_MUST_BE_NULL |
a8cc5943 ÆAB |
365 | int run_commit_hook(int editor_is_used, const char *index_file, |
366 | int *invoked_hook, const char *name, ...); | |
15048f8a | 367 | |
937032e1 | 368 | /* Sign a commit or tag buffer, storing the result in a header. */ |
369 | int sign_with_header(struct strbuf *buf, const char *keyid); | |
370 | /* Parse the signature out of a header. */ | |
371 | int parse_buffer_signed_by_header(const char *buffer, | |
372 | unsigned long size, | |
373 | struct strbuf *payload, | |
374 | struct strbuf *signature, | |
375 | const struct git_hash_algo *algop); | |
376 | ||
6eb8ae00 | 377 | #endif /* COMMIT_H */ |