]>
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 | #include "commit-slab.h" | |
12 | ||
13 | #define COMMIT_NOT_FROM_GRAPH 0xFFFFFFFF | |
14 | #define GENERATION_NUMBER_INFINITY 0xFFFFFFFF | |
15 | #define GENERATION_NUMBER_MAX 0x3FFFFFFF | |
16 | #define GENERATION_NUMBER_ZERO 0 | |
17 | ||
18 | struct commit_list { | |
19 | struct commit *item; | |
20 | struct commit_list *next; | |
21 | }; | |
22 | ||
23 | /* | |
24 | * The size of this struct matters in full repo walk operations like | |
25 | * 'git clone' or 'git gc'. Consider using commit-slab to attach data | |
26 | * to a commit instead of adding new fields here. | |
27 | */ | |
28 | struct commit { | |
29 | struct object object; | |
30 | timestamp_t date; | |
31 | struct commit_list *parents; | |
32 | ||
33 | /* | |
34 | * If the commit is loaded from the commit-graph file, then this | |
35 | * member may be NULL. Only access it through repo_get_commit_tree() | |
36 | * or get_commit_tree_oid(). | |
37 | */ | |
38 | struct tree *maybe_tree; | |
39 | unsigned int index; | |
40 | }; | |
41 | ||
42 | extern int save_commit_buffer; | |
43 | extern const char *commit_type; | |
44 | ||
45 | /* While we can decorate any object with a name, it's only used for commits.. */ | |
46 | struct name_decoration { | |
47 | struct name_decoration *next; | |
48 | int type; | |
49 | char name[FLEX_ARRAY]; | |
50 | }; | |
51 | ||
52 | enum decoration_type { | |
53 | DECORATION_NONE = 0, | |
54 | DECORATION_REF_LOCAL, | |
55 | DECORATION_REF_REMOTE, | |
56 | DECORATION_REF_TAG, | |
57 | DECORATION_REF_STASH, | |
58 | DECORATION_REF_HEAD, | |
59 | DECORATION_GRAFTED, | |
60 | }; | |
61 | ||
62 | void add_name_decoration(enum decoration_type type, const char *name, struct object *obj); | |
63 | const struct name_decoration *get_name_decoration(const struct object *obj); | |
64 | ||
65 | struct commit *lookup_commit(struct repository *r, const struct object_id *oid); | |
66 | struct commit *lookup_commit_reference(struct repository *r, | |
67 | const struct object_id *oid); | |
68 | struct commit *lookup_commit_reference_gently(struct repository *r, | |
69 | const struct object_id *oid, | |
70 | int quiet); | |
71 | struct commit *lookup_commit_reference_by_name(const char *name); | |
72 | ||
73 | /* | |
74 | * Look up object named by "oid", dereference tag as necessary, | |
75 | * get a commit and return it. If "oid" does not dereference to | |
76 | * a commit, use ref_name to report an error and die. | |
77 | */ | |
78 | struct commit *lookup_commit_or_die(const struct object_id *oid, const char *ref_name); | |
79 | ||
80 | int parse_commit_buffer(struct repository *r, struct commit *item, const void *buffer, unsigned long size, int check_graph); | |
81 | int repo_parse_commit_internal(struct repository *r, struct commit *item, | |
82 | int quiet_on_missing, int use_commit_graph); | |
83 | int repo_parse_commit_gently(struct repository *r, | |
84 | struct commit *item, | |
85 | int quiet_on_missing); | |
86 | static inline int repo_parse_commit(struct repository *r, struct commit *item) | |
87 | { | |
88 | return repo_parse_commit_gently(r, item, 0); | |
89 | } | |
90 | ||
91 | static inline int parse_commit_no_graph(struct commit *commit) | |
92 | { | |
93 | return repo_parse_commit_internal(the_repository, commit, 0, 0); | |
94 | } | |
95 | ||
96 | #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS | |
97 | #define parse_commit_internal(item, quiet, use) repo_parse_commit_internal(the_repository, item, quiet, use) | |
98 | #define parse_commit(item) repo_parse_commit(the_repository, item) | |
99 | #endif | |
100 | ||
101 | void parse_commit_or_die(struct commit *item); | |
102 | ||
103 | struct buffer_slab; | |
104 | struct buffer_slab *allocate_commit_buffer_slab(void); | |
105 | void free_commit_buffer_slab(struct buffer_slab *bs); | |
106 | ||
107 | /* | |
108 | * Associate an object buffer with the commit. The ownership of the | |
109 | * memory is handed over to the commit, and must be free()-able. | |
110 | */ | |
111 | void set_commit_buffer(struct repository *r, struct commit *, void *buffer, unsigned long size); | |
112 | ||
113 | /* | |
114 | * Get any cached object buffer associated with the commit. Returns NULL | |
115 | * if none. The resulting memory should not be freed. | |
116 | */ | |
117 | const void *get_cached_commit_buffer(struct repository *, const struct commit *, unsigned long *size); | |
118 | ||
119 | /* | |
120 | * Get the commit's object contents, either from cache or by reading the object | |
121 | * from disk. The resulting memory should not be modified, and must be given | |
122 | * to unuse_commit_buffer when the caller is done. | |
123 | */ | |
124 | const void *repo_get_commit_buffer(struct repository *r, | |
125 | const struct commit *, | |
126 | unsigned long *size); | |
127 | #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS | |
128 | #define get_commit_buffer(c, s) repo_get_commit_buffer(the_repository, c, s) | |
129 | #endif | |
130 | ||
131 | /* | |
132 | * Tell the commit subsystem that we are done with a particular commit buffer. | |
133 | * The commit and buffer should be the input and return value, respectively, | |
134 | * from an earlier call to get_commit_buffer. The buffer may or may not be | |
135 | * freed by this call; callers should not access the memory afterwards. | |
136 | */ | |
137 | void repo_unuse_commit_buffer(struct repository *r, | |
138 | const struct commit *, | |
139 | const void *buffer); | |
140 | #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS | |
141 | #define unuse_commit_buffer(c, b) repo_unuse_commit_buffer(the_repository, c, b) | |
142 | #endif | |
143 | ||
144 | /* | |
145 | * Free any cached object buffer associated with the commit. | |
146 | */ | |
147 | void free_commit_buffer(struct parsed_object_pool *pool, struct commit *); | |
148 | ||
149 | struct tree *repo_get_commit_tree(struct repository *, const struct commit *); | |
150 | #define get_commit_tree(c) repo_get_commit_tree(the_repository, c) | |
151 | struct object_id *get_commit_tree_oid(const struct commit *); | |
152 | ||
153 | /* | |
154 | * Release memory related to a commit, including the parent list and | |
155 | * any cached object buffer. | |
156 | */ | |
157 | void release_commit_memory(struct parsed_object_pool *pool, struct commit *c); | |
158 | ||
159 | /* | |
160 | * Disassociate any cached object buffer from the commit, but do not free it. | |
161 | * The buffer (or NULL, if none) is returned. | |
162 | */ | |
163 | const void *detach_commit_buffer(struct commit *, unsigned long *sizep); | |
164 | ||
165 | /* Find beginning and length of commit subject. */ | |
166 | int find_commit_subject(const char *commit_buffer, const char **subject); | |
167 | ||
168 | struct commit_list *commit_list_insert(struct commit *item, | |
169 | struct commit_list **list); | |
170 | int commit_list_contains(struct commit *item, | |
171 | struct commit_list *list); | |
172 | struct commit_list **commit_list_append(struct commit *commit, | |
173 | struct commit_list **next); | |
174 | unsigned commit_list_count(const struct commit_list *l); | |
175 | struct commit_list *commit_list_insert_by_date(struct commit *item, | |
176 | struct commit_list **list); | |
177 | void commit_list_sort_by_date(struct commit_list **list); | |
178 | ||
179 | /* Shallow copy of the input list */ | |
180 | struct commit_list *copy_commit_list(struct commit_list *list); | |
181 | ||
182 | /* Modify list in-place to reverse it, returning new head; list will be tail */ | |
183 | struct commit_list *reverse_commit_list(struct commit_list *list); | |
184 | ||
185 | void free_commit_list(struct commit_list *list); | |
186 | ||
187 | struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */ | |
188 | ||
189 | int has_non_ascii(const char *text); | |
190 | const char *logmsg_reencode(const struct commit *commit, | |
191 | char **commit_encoding, | |
192 | const char *output_encoding); | |
193 | const char *repo_logmsg_reencode(struct repository *r, | |
194 | const struct commit *commit, | |
195 | char **commit_encoding, | |
196 | const char *output_encoding); | |
197 | #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS | |
198 | #define logmsg_reencode(c, enc, out) repo_logmsg_reencode(the_repository, c, enc, out) | |
199 | #endif | |
200 | ||
201 | const char *skip_blank_lines(const char *msg); | |
202 | ||
203 | /** Removes the first commit from a list sorted by date, and adds all | |
204 | * of its parents. | |
205 | **/ | |
206 | struct commit *pop_most_recent_commit(struct commit_list **list, | |
207 | unsigned int mark); | |
208 | ||
209 | struct commit *pop_commit(struct commit_list **stack); | |
210 | ||
211 | void clear_commit_marks(struct commit *commit, unsigned int mark); | |
212 | void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark); | |
213 | ||
214 | ||
215 | enum rev_sort_order { | |
216 | REV_SORT_IN_GRAPH_ORDER = 0, | |
217 | REV_SORT_BY_COMMIT_DATE, | |
218 | REV_SORT_BY_AUTHOR_DATE | |
219 | }; | |
220 | ||
221 | /* | |
222 | * Performs an in-place topological sort of list supplied. | |
223 | * | |
224 | * invariant of resulting list is: | |
225 | * a reachable from b => ord(b) < ord(a) | |
226 | * sort_order further specifies: | |
227 | * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent | |
228 | * chain together. | |
229 | * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order. | |
230 | */ | |
231 | void sort_in_topological_order(struct commit_list **, enum rev_sort_order); | |
232 | ||
233 | struct commit_graft { | |
234 | struct object_id oid; | |
235 | int nr_parent; /* < 0 if shallow commit */ | |
236 | struct object_id parent[FLEX_ARRAY]; /* more */ | |
237 | }; | |
238 | typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *); | |
239 | ||
240 | struct commit_graft *read_graft_line(struct strbuf *line); | |
241 | /* commit_graft_pos returns an index into r->parsed_objects->grafts. */ | |
242 | int commit_graft_pos(struct repository *r, const unsigned char *sha1); | |
243 | int register_commit_graft(struct repository *r, struct commit_graft *, int); | |
244 | void prepare_commit_graft(struct repository *r); | |
245 | struct commit_graft *lookup_commit_graft(struct repository *r, const struct object_id *oid); | |
246 | ||
247 | struct commit *get_fork_point(const char *refname, struct commit *commit); | |
248 | ||
249 | /* largest positive number a signed 32-bit integer can contain */ | |
250 | #define INFINITE_DEPTH 0x7fffffff | |
251 | ||
252 | struct oid_array; | |
253 | struct ref; | |
254 | int for_each_commit_graft(each_commit_graft_fn, void *); | |
255 | ||
256 | int interactive_add(const char **argv, const char *prefix, int patch); | |
257 | int run_add_interactive(const char *revision, const char *patch_mode, | |
258 | const struct pathspec *pathspec); | |
259 | ||
260 | struct commit_extra_header { | |
261 | struct commit_extra_header *next; | |
262 | char *key; | |
263 | char *value; | |
264 | size_t len; | |
265 | }; | |
266 | ||
267 | void append_merge_tag_headers(struct commit_list *parents, | |
268 | struct commit_extra_header ***tail); | |
269 | ||
270 | int commit_tree(const char *msg, size_t msg_len, | |
271 | const struct object_id *tree, | |
272 | struct commit_list *parents, struct object_id *ret, | |
273 | const char *author, const char *sign_commit); | |
274 | ||
275 | int commit_tree_extended(const char *msg, size_t msg_len, | |
276 | const struct object_id *tree, | |
277 | struct commit_list *parents, struct object_id *ret, | |
278 | const char *author, const char *committer, | |
279 | const char *sign_commit, struct commit_extra_header *); | |
280 | ||
281 | struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **); | |
282 | ||
283 | void free_commit_extra_headers(struct commit_extra_header *extra); | |
284 | ||
285 | /* | |
286 | * Search the commit object contents given by "msg" for the header "key". | |
287 | * Returns a pointer to the start of the header contents, or NULL. The length | |
288 | * of the header, up to the first newline, is returned via out_len. | |
289 | * | |
290 | * Note that some headers (like mergetag) may be multi-line. It is the caller's | |
291 | * responsibility to parse further in this case! | |
292 | */ | |
293 | const char *find_commit_header(const char *msg, const char *key, | |
294 | size_t *out_len); | |
295 | ||
296 | /* Find the end of the log message, the right place for a new trailer. */ | |
297 | size_t ignore_non_trailer(const char *buf, size_t len); | |
298 | ||
299 | typedef int (*each_mergetag_fn)(struct commit *commit, struct commit_extra_header *extra, | |
300 | void *cb_data); | |
301 | ||
302 | int for_each_mergetag(each_mergetag_fn fn, struct commit *commit, void *data); | |
303 | ||
304 | struct merge_remote_desc { | |
305 | struct object *obj; /* the named object, could be a tag */ | |
306 | char name[FLEX_ARRAY]; | |
307 | }; | |
308 | struct merge_remote_desc *merge_remote_util(struct commit *); | |
309 | void set_merge_remote_desc(struct commit *commit, | |
310 | const char *name, struct object *obj); | |
311 | ||
312 | /* | |
313 | * Given "name" from the command line to merge, find the commit object | |
314 | * and return it, while storing merge_remote_desc in its ->util field, | |
315 | * to allow callers to tell if we are told to merge a tag. | |
316 | */ | |
317 | struct commit *get_merge_parent(const char *name); | |
318 | ||
319 | int parse_signed_commit(const struct commit *commit, | |
320 | struct strbuf *message, struct strbuf *signature); | |
321 | int remove_signature(struct strbuf *buf); | |
322 | ||
323 | /* | |
324 | * Check the signature of the given commit. The result of the check is stored | |
325 | * in sig->check_result, 'G' for a good signature, 'U' for a good signature | |
326 | * from an untrusted signer, 'B' for a bad signature and 'N' for no signature | |
327 | * at all. This may allocate memory for sig->gpg_output, sig->gpg_status, | |
328 | * sig->signer and sig->key. | |
329 | */ | |
330 | int check_commit_signature(const struct commit *commit, struct signature_check *sigc); | |
331 | ||
332 | /* record author-date for each commit object */ | |
333 | struct author_date_slab; | |
334 | void record_author_date(struct author_date_slab *author_date, | |
335 | struct commit *commit); | |
336 | ||
337 | int compare_commits_by_author_date(const void *a_, const void *b_, void *unused); | |
338 | ||
339 | /* | |
340 | * Verify a single commit with check_commit_signature() and die() if it is not | |
341 | * a good signature. This isn't really suitable for general use, but is a | |
342 | * helper to implement consistent logic for pull/merge --verify-signatures. | |
343 | * | |
344 | * The check_trust parameter is meant for backward-compatibility. The GPG | |
345 | * interface verifies key trust with a default trust level that is below the | |
346 | * default trust level for merge operations. Its value should be non-zero if | |
347 | * the user hasn't set a minimum trust level explicitly in their configuration. | |
348 | * | |
349 | * If the user has set a minimum trust level, then that value should be obeyed | |
350 | * and check_trust should be zero, even if the configured trust level is below | |
351 | * the default trust level for merges. | |
352 | */ | |
353 | void verify_merge_signature(struct commit *commit, int verbose, | |
354 | int check_trust); | |
355 | ||
356 | int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused); | |
357 | int compare_commits_by_gen_then_commit_date(const void *a_, const void *b_, void *unused); | |
358 | ||
359 | LAST_ARG_MUST_BE_NULL | |
360 | int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...); | |
361 | ||
362 | #endif /* COMMIT_H */ |