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