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