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