provide a helper to free commit buffer
[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"
6eb8ae00
DB
10
11struct commit_list {
12 struct commit *item;
13 struct commit_list *next;
14};
15
16struct commit {
17 struct object object;
d3ff6f55 18 void *util;
96c4f4a3 19 unsigned int index;
6eb8ae00
DB
20 unsigned long date;
21 struct commit_list *parents;
22 struct tree *tree;
bd1e17e2 23 char *buffer;
6eb8ae00
DB
24};
25
60ab26de 26extern int save_commit_buffer;
6eb8ae00
DB
27extern const char *commit_type;
28
ca135e7a
LT
29/* While we can decorate any object with a name, it's only used for commits.. */
30extern struct decoration name_decoration;
31struct name_decoration {
32 struct name_decoration *next;
eb3005e2 33 int type;
ca135e7a
LT
34 char name[1];
35};
36
5d6ccf5c
JM
37struct commit *lookup_commit(const unsigned char *sha1);
38struct commit *lookup_commit_reference(const unsigned char *sha1);
f76412ed
JH
39struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
40 int quiet);
a6fa5992 41struct commit *lookup_commit_reference_by_name(const char *name);
6eb8ae00 42
baf18fc2
NTND
43/*
44 * Look up object named by "sha1", dereference tag as necessary,
45 * get a commit and return it. If "sha1" does not dereference to
46 * a commit, use ref_name to report an error and die.
47 */
48struct commit *lookup_commit_or_die(const unsigned char *sha1, const char *ref_name);
49
cf7b1cad 50int parse_commit_buffer(struct commit *item, const void *buffer, unsigned long size);
6eb8ae00 51int parse_commit(struct commit *item);
7059dccc 52void parse_commit_or_die(struct commit *item);
6eb8ae00 53
0fb370da
JK
54/*
55 * Free any cached object buffer associated with the commit.
56 */
57void free_commit_buffer(struct commit *);
58
59/*
60 * Disassociate any cached object buffer from the commit, but do not free it.
61 * The buffer (or NULL, if none) is returned.
62 */
63const void *detach_commit_buffer(struct commit *);
64
11af2aae
CC
65/* Find beginning and length of commit subject. */
66int find_commit_subject(const char *commit_buffer, const char **subject);
67
47e44ed1
TF
68struct commit_list *commit_list_insert(struct commit *item,
69 struct commit_list **list);
89b5f1d9
RS
70struct commit_list **commit_list_append(struct commit *commit,
71 struct commit_list **next);
65319475 72unsigned commit_list_count(const struct commit_list *l);
47e44ed1
TF
73struct commit_list *commit_list_insert_by_date(struct commit *item,
74 struct commit_list **list);
75void commit_list_sort_by_date(struct commit_list **list);
dd97f850 76
53d00b39
TR
77/* Shallow copy of the input list */
78struct commit_list *copy_commit_list(struct commit_list *list);
79
6eb8ae00
DB
80void free_commit_list(struct commit_list *list);
81
000182ea
LT
82/* Commit formats */
83enum cmit_fmt {
84 CMIT_FMT_RAW,
85 CMIT_FMT_MEDIUM,
86 CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
9b66ec04
LT
87 CMIT_FMT_SHORT,
88 CMIT_FMT_FULL,
ff56fe1c 89 CMIT_FMT_FULLER,
d87449c5 90 CMIT_FMT_ONELINE,
3eefc189 91 CMIT_FMT_EMAIL,
e52a5de4 92 CMIT_FMT_USERFORMAT,
6b9c58f4 93
4b05548f 94 CMIT_FMT_UNSPECIFIED
000182ea
LT
95};
96
9cba13ca 97struct pretty_print_context {
10f2fbff
JK
98 /*
99 * Callers should tweak these to change the behavior of pp_* functions.
100 */
6bf13944 101 enum cmit_fmt fmt;
dd2e794a
TR
102 int abbrev;
103 const char *subject;
104 const char *after_subject;
9553d2b2 105 int preserve_subject;
dd2e794a 106 enum date_mode date_mode;
f026c756 107 unsigned date_mode_explicit:1;
dd2e794a 108 int need_8bit_cte;
ddf333f6 109 char *notes_message;
8f8f5476 110 struct reflog_walk_info *reflog_info;
177b29dc 111 const char *output_encoding;
0e2913b0 112 struct string_list *mailmap;
30825178 113 int color;
a9080475 114 struct ident_split *from_ident;
10f2fbff
JK
115
116 /*
117 * Fields below here are manipulated internally by pp_* functions and
118 * should not be counted on by callers.
119 */
a9080475 120 struct string_list in_body_headers;
dd2e794a
TR
121};
122
5b163603
JG
123struct userformat_want {
124 unsigned notes:1;
125};
126
28e9cf65 127extern int has_non_ascii(const char *text);
4da45bef 128struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
b000c59b
JK
129extern const char *logmsg_reencode(const struct commit *commit,
130 char **commit_encoding,
131 const char *output_encoding);
132extern void logmsg_free(const char *msg, const struct commit *commit);
4da45bef 133extern void get_commit_format(const char *arg, struct rev_info *);
c8f1444d
RJ
134extern const char *format_subject(struct strbuf *sb, const char *msg,
135 const char *line_separator);
5b163603 136extern void userformat_find_requirements(const char *fmt, struct userformat_want *w);
674d1727 137extern void format_commit_message(const struct commit *commit,
7f98ebc8 138 const char *format, struct strbuf *sb,
dd2e794a 139 const struct pretty_print_context *context);
10f2fbff 140extern void pretty_print_commit(struct pretty_print_context *pp,
6bf13944
JK
141 const struct commit *commit,
142 struct strbuf *sb);
8b8a5374
JK
143extern void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
144 struct strbuf *sb);
10f2fbff 145void pp_user_info(struct pretty_print_context *pp,
6bf13944
JK
146 const char *what, struct strbuf *sb,
147 const char *line, const char *encoding);
10f2fbff 148void pp_title_line(struct pretty_print_context *pp,
b02bd65f
DB
149 const char **msg_p,
150 struct strbuf *sb,
b02bd65f 151 const char *encoding,
267123b4 152 int need_8bit_cte);
10f2fbff 153void pp_remainder(struct pretty_print_context *pp,
b02bd65f
DB
154 const char **msg_p,
155 struct strbuf *sb,
156 int indent);
157
e3bc7a3b 158
dd97f850
DB
159/** Removes the first commit from a list sorted by date, and adds all
160 * of its parents.
161 **/
a6080a0a 162struct commit *pop_most_recent_commit(struct commit_list **list,
58e28af6 163 unsigned int mark);
dd97f850 164
a3437b8c
JS
165struct commit *pop_commit(struct commit_list **stack);
166
f8f9c73c 167void clear_commit_marks(struct commit *commit, unsigned int mark);
e895cb51 168void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark);
86a0a408 169void clear_commit_marks_for_object_array(struct object_array *a, unsigned mark);
f8f9c73c 170
08f704f2
JH
171
172enum rev_sort_order {
173 REV_SORT_IN_GRAPH_ORDER = 0,
81c6b38b
JH
174 REV_SORT_BY_COMMIT_DATE,
175 REV_SORT_BY_AUTHOR_DATE
08f704f2
JH
176};
177
ab580ace
JS
178/*
179 * Performs an in-place topological sort of list supplied.
180 *
ab580ace
JS
181 * invariant of resulting list is:
182 * a reachable from b => ord(b) < ord(a)
08f704f2
JH
183 * sort_order further specifies:
184 * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
185 * chain together.
186 * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
ab580ace 187 */
08f704f2 188void sort_in_topological_order(struct commit_list **, enum rev_sort_order);
5040f17e
JH
189
190struct commit_graft {
191 unsigned char sha1[20];
ed09aef0 192 int nr_parent; /* < 0 if shallow commit */
5040f17e
JH
193 unsigned char parent[FLEX_ARRAY][20]; /* more */
194};
09d46644 195typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
5040f17e
JH
196
197struct commit_graft *read_graft_line(char *buf, int len);
198int register_commit_graft(struct commit_graft *, int);
45163382 199struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
5040f17e 200
c0fa8255 201extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
53eda89b 202extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos, int cleanup);
5240c9d7 203extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
7c6f8aaf 204
41ccfdd9 205/* largest positive number a signed 32-bit integer can contain */
4dcb167f
NTND
206#define INFINITE_DEPTH 0x7fffffff
207
58babfff
NTND
208struct sha1_array;
209struct ref;
ed09aef0 210extern int register_shallow(const unsigned char *sha1);
f53514bc 211extern int unregister_shallow(const unsigned char *sha1);
09d46644 212extern int for_each_commit_graft(each_commit_graft_fn, void *);
f43117a6 213extern int is_repository_shallow(void);
ed09aef0 214extern struct commit_list *get_shallow_commits(struct object_array *heads,
f53514bc 215 int depth, int shallow_flag, int not_shallow_flag);
6035d6aa 216extern void check_shallow_file_for_update(void);
069c0532 217extern void set_alternate_shallow_file(const char *path, int override);
1a30f5a2
NTND
218extern int write_shallow_commits(struct strbuf *out, int use_pack_protocol,
219 const struct sha1_array *extra);
3125fe52 220extern void setup_alternate_shallow(struct lock_file *shallow_lock,
1a30f5a2
NTND
221 const char **alternate_shallow_file,
222 const struct sha1_array *extra);
0179c945 223extern const char *setup_temporary_shallow(const struct sha1_array *extra);
ad491366 224extern void advertise_shallow_grafts(int);
ed09aef0 225
58babfff
NTND
226struct shallow_info {
227 struct sha1_array *shallow;
228 int *ours, nr_ours;
229 int *theirs, nr_theirs;
230 struct sha1_array *ref;
0a1bc12b
NTND
231
232 /* for receive-pack */
233 uint32_t **used_shallow;
234 int *need_reachability_test;
235 int *reachable;
236 int *shallow_ref;
237 struct commit **commits;
238 int nr_commits;
58babfff
NTND
239};
240
241extern void prepare_shallow_info(struct shallow_info *, struct sha1_array *);
242extern void clear_shallow_info(struct shallow_info *);
243extern void remove_nonexistent_theirs_shallow(struct shallow_info *);
8e277383
NTND
244extern void assign_shallow_commits_to_refs(struct shallow_info *info,
245 uint32_t **used,
246 int *ref_status);
0a1bc12b 247extern int delayed_reachability_test(struct shallow_info *si, int c);
eab3296c 248extern void prune_shallow(int show_only);
ed09aef0 249
7fcdb36e 250int is_descendant_of(struct commit *, struct commit_list *);
a20efee9 251int in_merge_bases(struct commit *, struct commit *);
4c4b27e8 252int in_merge_bases_many(struct commit *, int, struct commit **);
58680165 253
b4bd4668 254extern int interactive_add(int argc, const char **argv, const char *prefix, int patch);
46b5139c 255extern int run_add_interactive(const char *revision, const char *patch_mode,
480ca644 256 const struct pathspec *pathspec);
58680165 257
53b2c823
LT
258static inline int single_parent(struct commit *commit)
259{
260 return commit->parents && !commit->parents->next;
261}
262
98cf9c3b
JH
263struct commit_list *reduce_heads(struct commit_list *heads);
264
5231c633
JH
265struct commit_extra_header {
266 struct commit_extra_header *next;
267 char *key;
268 char *value;
269 size_t len;
270};
271
272extern void append_merge_tag_headers(struct commit_list *parents,
273 struct commit_extra_header ***tail);
274
3ffefb54
JK
275extern int commit_tree(const char *msg, size_t msg_len,
276 const unsigned char *tree,
5231c633 277 struct commit_list *parents, unsigned char *ret,
ba3c69a9 278 const char *author, const char *sign_commit);
5231c633 279
3ffefb54
JK
280extern int commit_tree_extended(const char *msg, size_t msg_len,
281 const unsigned char *tree,
5231c633 282 struct commit_list *parents, unsigned char *ret,
ba3c69a9 283 const char *author, const char *sign_commit,
5231c633
JH
284 struct commit_extra_header *);
285
c871a1d1 286extern struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
ed7a42a0 287
5231c633 288extern void free_commit_extra_headers(struct commit_extra_header *extra);
40d52ff7 289
ae8e4c9c
JH
290struct merge_remote_desc {
291 struct object *obj; /* the named object, could be a tag */
292 const char *name;
293};
294#define merge_remote_util(commit) ((struct merge_remote_desc *)((commit)->util))
295
296/*
297 * Given "name" from the command line to merge, find the commit object
298 * and return it, while storing merge_remote_desc in its ->util field,
299 * to allow callers to tell if we are told to merge a tag.
300 */
301struct commit *get_merge_parent(const char *name);
302
0c37f1fc
JH
303extern int parse_signed_commit(const unsigned char *sha1,
304 struct strbuf *message, struct strbuf *signature);
efc7df45
NTND
305extern void print_commit_list(struct commit_list *list,
306 const char *format_cur,
307 const char *format_last);
308
ffb6d7d5 309/*
eb307ae7
SG
310 * Check the signature of the given commit. The result of the check is stored
311 * in sig->check_result, 'G' for a good signature, 'U' for a good signature
312 * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
313 * at all. This may allocate memory for sig->gpg_output, sig->gpg_status,
314 * sig->signer and sig->key.
ffb6d7d5
SG
315 */
316extern void check_commit_signature(const struct commit* commit, struct signature_check *sigc);
317
727377ff
JK
318int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused);
319
15048f8a
BP
320LAST_ARG_MUST_BE_NULL
321extern int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...);
322
6eb8ae00 323#endif /* COMMIT_H */