]>
Commit | Line | Data |
---|---|---|
1 | #ifndef COMMIT_H | |
2 | #define COMMIT_H | |
3 | ||
4 | #include "object.h" | |
5 | #include "tree.h" | |
6 | #include "strbuf.h" | |
7 | #include "decorate.h" | |
8 | #include "gpg-interface.h" | |
9 | #include "string-list.h" | |
10 | #include "pretty.h" | |
11 | ||
12 | struct commit_list { | |
13 | struct commit *item; | |
14 | struct commit_list *next; | |
15 | }; | |
16 | ||
17 | struct commit { | |
18 | struct object object; | |
19 | void *util; | |
20 | unsigned int index; | |
21 | timestamp_t date; | |
22 | struct commit_list *parents; | |
23 | struct tree *tree; | |
24 | }; | |
25 | ||
26 | extern int save_commit_buffer; | |
27 | extern const char *commit_type; | |
28 | ||
29 | /* While we can decorate any object with a name, it's only used for commits.. */ | |
30 | struct name_decoration { | |
31 | struct name_decoration *next; | |
32 | int type; | |
33 | char name[FLEX_ARRAY]; | |
34 | }; | |
35 | ||
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); | |
47 | const struct name_decoration *get_name_decoration(const struct object *obj); | |
48 | ||
49 | struct commit *lookup_commit(const struct object_id *oid); | |
50 | struct commit *lookup_commit_reference(const struct object_id *oid); | |
51 | struct commit *lookup_commit_reference_gently(const struct object_id *oid, | |
52 | int quiet); | |
53 | struct commit *lookup_commit_reference_by_name(const char *name); | |
54 | ||
55 | /* | |
56 | * Look up object named by "oid", dereference tag as necessary, | |
57 | * get a commit and return it. If "oid" 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 struct object_id *oid, const char *ref_name); | |
61 | ||
62 | int parse_commit_buffer(struct commit *item, const void *buffer, unsigned long size); | |
63 | int parse_commit_gently(struct commit *item, int quiet_on_missing); | |
64 | static inline int parse_commit(struct commit *item) | |
65 | { | |
66 | return parse_commit_gently(item, 0); | |
67 | } | |
68 | void parse_commit_or_die(struct commit *item); | |
69 | ||
70 | /* | |
71 | * Associate an object buffer with the commit. The ownership of the | |
72 | * memory is handed over to the commit, and must be free()-able. | |
73 | */ | |
74 | void set_commit_buffer(struct commit *, void *buffer, unsigned long size); | |
75 | ||
76 | /* | |
77 | * Get any cached object buffer associated with the commit. Returns NULL | |
78 | * if none. The resulting memory should not be freed. | |
79 | */ | |
80 | const void *get_cached_commit_buffer(const struct commit *, unsigned long *size); | |
81 | ||
82 | /* | |
83 | * Get the commit's object contents, either from cache or by reading the object | |
84 | * from disk. The resulting memory should not be modified, and must be given | |
85 | * to unuse_commit_buffer when the caller is done. | |
86 | */ | |
87 | const void *get_commit_buffer(const struct commit *, unsigned long *size); | |
88 | ||
89 | /* | |
90 | * Tell the commit subsytem that we are done with a particular commit buffer. | |
91 | * The commit and buffer should be the input and return value, respectively, | |
92 | * from an earlier call to get_commit_buffer. The buffer may or may not be | |
93 | * freed by this call; callers should not access the memory afterwards. | |
94 | */ | |
95 | void unuse_commit_buffer(const struct commit *, const void *buffer); | |
96 | ||
97 | /* | |
98 | * Free any cached object buffer associated with the commit. | |
99 | */ | |
100 | void free_commit_buffer(struct commit *); | |
101 | ||
102 | /* | |
103 | * Disassociate any cached object buffer from the commit, but do not free it. | |
104 | * The buffer (or NULL, if none) is returned. | |
105 | */ | |
106 | const void *detach_commit_buffer(struct commit *, unsigned long *sizep); | |
107 | ||
108 | /* Find beginning and length of commit subject. */ | |
109 | int find_commit_subject(const char *commit_buffer, const char **subject); | |
110 | ||
111 | struct commit_list *commit_list_insert(struct commit *item, | |
112 | struct commit_list **list); | |
113 | struct commit_list **commit_list_append(struct commit *commit, | |
114 | struct commit_list **next); | |
115 | unsigned commit_list_count(const struct commit_list *l); | |
116 | struct commit_list *commit_list_insert_by_date(struct commit *item, | |
117 | struct commit_list **list); | |
118 | void commit_list_sort_by_date(struct commit_list **list); | |
119 | ||
120 | /* Shallow copy of the input list */ | |
121 | struct commit_list *copy_commit_list(struct commit_list *list); | |
122 | ||
123 | void free_commit_list(struct commit_list *list); | |
124 | ||
125 | struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */ | |
126 | ||
127 | extern int has_non_ascii(const char *text); | |
128 | extern const char *logmsg_reencode(const struct commit *commit, | |
129 | char **commit_encoding, | |
130 | const char *output_encoding); | |
131 | extern const char *skip_blank_lines(const char *msg); | |
132 | ||
133 | /** Removes the first commit from a list sorted by date, and adds all | |
134 | * of its parents. | |
135 | **/ | |
136 | struct commit *pop_most_recent_commit(struct commit_list **list, | |
137 | unsigned int mark); | |
138 | ||
139 | struct commit *pop_commit(struct commit_list **stack); | |
140 | ||
141 | void clear_commit_marks(struct commit *commit, unsigned int mark); | |
142 | void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark); | |
143 | ||
144 | ||
145 | enum rev_sort_order { | |
146 | REV_SORT_IN_GRAPH_ORDER = 0, | |
147 | REV_SORT_BY_COMMIT_DATE, | |
148 | REV_SORT_BY_AUTHOR_DATE | |
149 | }; | |
150 | ||
151 | /* | |
152 | * Performs an in-place topological sort of list supplied. | |
153 | * | |
154 | * invariant of resulting list is: | |
155 | * a reachable from b => ord(b) < ord(a) | |
156 | * sort_order further specifies: | |
157 | * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent | |
158 | * chain together. | |
159 | * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order. | |
160 | */ | |
161 | void sort_in_topological_order(struct commit_list **, enum rev_sort_order); | |
162 | ||
163 | struct commit_graft { | |
164 | struct object_id oid; | |
165 | int nr_parent; /* < 0 if shallow commit */ | |
166 | struct object_id parent[FLEX_ARRAY]; /* more */ | |
167 | }; | |
168 | typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *); | |
169 | ||
170 | struct commit_graft *read_graft_line(struct strbuf *line); | |
171 | int register_commit_graft(struct commit_graft *, int); | |
172 | struct commit_graft *lookup_commit_graft(const struct object_id *oid); | |
173 | ||
174 | extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2); | |
175 | extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos); | |
176 | extern struct commit_list *get_octopus_merge_bases(struct commit_list *in); | |
177 | ||
178 | /* To be used only when object flags after this call no longer matter */ | |
179 | extern struct commit_list *get_merge_bases_many_dirty(struct commit *one, int n, struct commit **twos); | |
180 | ||
181 | /* largest positive number a signed 32-bit integer can contain */ | |
182 | #define INFINITE_DEPTH 0x7fffffff | |
183 | ||
184 | struct oid_array; | |
185 | struct ref; | |
186 | extern int register_shallow(const struct object_id *oid); | |
187 | extern int unregister_shallow(const struct object_id *oid); | |
188 | extern int for_each_commit_graft(each_commit_graft_fn, void *); | |
189 | extern int is_repository_shallow(void); | |
190 | extern struct commit_list *get_shallow_commits(struct object_array *heads, | |
191 | int depth, int shallow_flag, int not_shallow_flag); | |
192 | extern struct commit_list *get_shallow_commits_by_rev_list( | |
193 | int ac, const char **av, int shallow_flag, int not_shallow_flag); | |
194 | extern void set_alternate_shallow_file(const char *path, int override); | |
195 | extern int write_shallow_commits(struct strbuf *out, int use_pack_protocol, | |
196 | const struct oid_array *extra); | |
197 | extern void setup_alternate_shallow(struct lock_file *shallow_lock, | |
198 | const char **alternate_shallow_file, | |
199 | const struct oid_array *extra); | |
200 | extern const char *setup_temporary_shallow(const struct oid_array *extra); | |
201 | extern void advertise_shallow_grafts(int); | |
202 | ||
203 | struct shallow_info { | |
204 | struct oid_array *shallow; | |
205 | int *ours, nr_ours; | |
206 | int *theirs, nr_theirs; | |
207 | struct oid_array *ref; | |
208 | ||
209 | /* for receive-pack */ | |
210 | uint32_t **used_shallow; | |
211 | int *need_reachability_test; | |
212 | int *reachable; | |
213 | int *shallow_ref; | |
214 | struct commit **commits; | |
215 | int nr_commits; | |
216 | }; | |
217 | ||
218 | extern void prepare_shallow_info(struct shallow_info *, struct oid_array *); | |
219 | extern void clear_shallow_info(struct shallow_info *); | |
220 | extern void remove_nonexistent_theirs_shallow(struct shallow_info *); | |
221 | extern void assign_shallow_commits_to_refs(struct shallow_info *info, | |
222 | uint32_t **used, | |
223 | int *ref_status); | |
224 | extern int delayed_reachability_test(struct shallow_info *si, int c); | |
225 | extern void prune_shallow(int show_only); | |
226 | extern struct trace_key trace_shallow; | |
227 | ||
228 | int is_descendant_of(struct commit *, struct commit_list *); | |
229 | int in_merge_bases(struct commit *, struct commit *); | |
230 | int in_merge_bases_many(struct commit *, int, struct commit **); | |
231 | ||
232 | extern int interactive_add(int argc, const char **argv, const char *prefix, int patch); | |
233 | extern int run_add_interactive(const char *revision, const char *patch_mode, | |
234 | const struct pathspec *pathspec); | |
235 | ||
236 | /* | |
237 | * Takes a list of commits and returns a new list where those | |
238 | * have been removed that can be reached from other commits in | |
239 | * the list. It is useful for, e.g., reducing the commits | |
240 | * randomly thrown at the git-merge command and removing | |
241 | * redundant commits that the user shouldn't have given to it. | |
242 | * | |
243 | * This function destroys the STALE bit of the commit objects' | |
244 | * flags. | |
245 | */ | |
246 | extern struct commit_list *reduce_heads(struct commit_list *heads); | |
247 | ||
248 | /* | |
249 | * Like `reduce_heads()`, except it replaces the list. Use this | |
250 | * instead of `foo = reduce_heads(foo);` to avoid memory leaks. | |
251 | */ | |
252 | extern void reduce_heads_replace(struct commit_list **heads); | |
253 | ||
254 | struct commit_extra_header { | |
255 | struct commit_extra_header *next; | |
256 | char *key; | |
257 | char *value; | |
258 | size_t len; | |
259 | }; | |
260 | ||
261 | extern void append_merge_tag_headers(struct commit_list *parents, | |
262 | struct commit_extra_header ***tail); | |
263 | ||
264 | extern int commit_tree(const char *msg, size_t msg_len, | |
265 | const unsigned char *tree, | |
266 | struct commit_list *parents, unsigned char *ret, | |
267 | const char *author, const char *sign_commit); | |
268 | ||
269 | extern int commit_tree_extended(const char *msg, size_t msg_len, | |
270 | const unsigned char *tree, | |
271 | struct commit_list *parents, unsigned char *ret, | |
272 | const char *author, const char *sign_commit, | |
273 | struct commit_extra_header *); | |
274 | ||
275 | extern struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **); | |
276 | ||
277 | extern void free_commit_extra_headers(struct commit_extra_header *extra); | |
278 | ||
279 | /* | |
280 | * Search the commit object contents given by "msg" for the header "key". | |
281 | * Returns a pointer to the start of the header contents, or NULL. The length | |
282 | * of the header, up to the first newline, is returned via out_len. | |
283 | * | |
284 | * Note that some headers (like mergetag) may be multi-line. It is the caller's | |
285 | * responsibility to parse further in this case! | |
286 | */ | |
287 | extern const char *find_commit_header(const char *msg, const char *key, | |
288 | size_t *out_len); | |
289 | ||
290 | /* Find the end of the log message, the right place for a new trailer. */ | |
291 | extern int ignore_non_trailer(const char *buf, size_t len); | |
292 | ||
293 | typedef void (*each_mergetag_fn)(struct commit *commit, struct commit_extra_header *extra, | |
294 | void *cb_data); | |
295 | ||
296 | extern void for_each_mergetag(each_mergetag_fn fn, struct commit *commit, void *data); | |
297 | ||
298 | struct merge_remote_desc { | |
299 | struct object *obj; /* the named object, could be a tag */ | |
300 | char name[FLEX_ARRAY]; | |
301 | }; | |
302 | #define merge_remote_util(commit) ((struct merge_remote_desc *)((commit)->util)) | |
303 | extern void set_merge_remote_desc(struct commit *commit, | |
304 | const char *name, struct object *obj); | |
305 | ||
306 | /* | |
307 | * Given "name" from the command line to merge, find the commit object | |
308 | * and return it, while storing merge_remote_desc in its ->util field, | |
309 | * to allow callers to tell if we are told to merge a tag. | |
310 | */ | |
311 | struct commit *get_merge_parent(const char *name); | |
312 | ||
313 | extern int parse_signed_commit(const struct commit *commit, | |
314 | struct strbuf *message, struct strbuf *signature); | |
315 | extern int remove_signature(struct strbuf *buf); | |
316 | ||
317 | /* | |
318 | * Check the signature of the given commit. The result of the check is stored | |
319 | * in sig->check_result, 'G' for a good signature, 'U' for a good signature | |
320 | * from an untrusted signer, 'B' for a bad signature and 'N' for no signature | |
321 | * at all. This may allocate memory for sig->gpg_output, sig->gpg_status, | |
322 | * sig->signer and sig->key. | |
323 | */ | |
324 | extern int check_commit_signature(const struct commit *commit, struct signature_check *sigc); | |
325 | ||
326 | int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused); | |
327 | ||
328 | LAST_ARG_MUST_BE_NULL | |
329 | extern int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...); | |
330 | ||
331 | #endif /* COMMIT_H */ |