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