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