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