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