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