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