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