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