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