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