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