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