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