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