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