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