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