Merge branch 'en/merge-strategy-docs' into maint
[git.git] / commit.h
blobdf42eb434f314bd9cf89e920efdb0fc29a86c4c5
1 #ifndef COMMIT_H
2 #define COMMIT_H
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"
13 #define COMMIT_NOT_FROM_GRAPH 0xFFFFFFFF
14 #define GENERATION_NUMBER_INFINITY ((1ULL << 63) - 1)
15 #define GENERATION_NUMBER_V1_MAX 0x3FFFFFFF
16 #define GENERATION_NUMBER_ZERO 0
17 #define GENERATION_NUMBER_V2_OFFSET_MAX ((1ULL << 31) - 1)
19 struct commit_list {
20 struct commit *item;
21 struct commit_list *next;
25 * The size of this struct matters in full repo walk operations like
26 * 'git clone' or 'git gc'. Consider using commit-slab to attach data
27 * to a commit instead of adding new fields here.
29 struct commit {
30 struct object object;
31 timestamp_t date;
32 struct commit_list *parents;
35 * If the commit is loaded from the commit-graph file, then this
36 * member may be NULL. Only access it through repo_get_commit_tree()
37 * or get_commit_tree_oid().
39 struct tree *maybe_tree;
40 unsigned int index;
43 extern int save_commit_buffer;
44 extern const char *commit_type;
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];
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,
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);
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);
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.
79 struct commit *lookup_commit_or_die(const struct object_id *oid, const char *ref_name);
81 int parse_commit_buffer(struct repository *r, struct commit *item, const void *buffer, unsigned long size, int check_graph);
82 int repo_parse_commit_internal(struct repository *r, struct commit *item,
83 int quiet_on_missing, int use_commit_graph);
84 int repo_parse_commit_gently(struct repository *r,
85 struct commit *item,
86 int quiet_on_missing);
87 static inline int repo_parse_commit(struct repository *r, struct commit *item)
89 return repo_parse_commit_gently(r, item, 0);
92 static inline int repo_parse_commit_no_graph(struct repository *r,
93 struct commit *commit)
95 return repo_parse_commit_internal(r, commit, 0, 0);
98 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
99 #define parse_commit_internal(item, quiet, use) repo_parse_commit_internal(the_repository, item, quiet, use)
100 #define parse_commit(item) repo_parse_commit(the_repository, item)
101 #endif
103 void parse_commit_or_die(struct commit *item);
105 struct buffer_slab;
106 struct buffer_slab *allocate_commit_buffer_slab(void);
107 void free_commit_buffer_slab(struct buffer_slab *bs);
110 * Associate an object buffer with the commit. The ownership of the
111 * memory is handed over to the commit, and must be free()-able.
113 void set_commit_buffer(struct repository *r, struct commit *, void *buffer, unsigned long size);
116 * Get any cached object buffer associated with the commit. Returns NULL
117 * if none. The resulting memory should not be freed.
119 const void *get_cached_commit_buffer(struct repository *, const struct commit *, unsigned long *size);
122 * Get the commit's object contents, either from cache or by reading the object
123 * from disk. The resulting memory should not be modified, and must be given
124 * to unuse_commit_buffer when the caller is done.
126 const void *repo_get_commit_buffer(struct repository *r,
127 const struct commit *,
128 unsigned long *size);
129 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
130 #define get_commit_buffer(c, s) repo_get_commit_buffer(the_repository, c, s)
131 #endif
134 * Tell the commit subsystem that we are done with a particular commit buffer.
135 * The commit and buffer should be the input and return value, respectively,
136 * from an earlier call to get_commit_buffer. The buffer may or may not be
137 * freed by this call; callers should not access the memory afterwards.
139 void repo_unuse_commit_buffer(struct repository *r,
140 const struct commit *,
141 const void *buffer);
142 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
143 #define unuse_commit_buffer(c, b) repo_unuse_commit_buffer(the_repository, c, b)
144 #endif
147 * Free any cached object buffer associated with the commit.
149 void free_commit_buffer(struct parsed_object_pool *pool, struct commit *);
151 struct tree *repo_get_commit_tree(struct repository *, const struct commit *);
152 #define get_commit_tree(c) repo_get_commit_tree(the_repository, c)
153 struct object_id *get_commit_tree_oid(const struct commit *);
156 * Release memory related to a commit, including the parent list and
157 * any cached object buffer.
159 void release_commit_memory(struct parsed_object_pool *pool, struct commit *c);
162 * Disassociate any cached object buffer from the commit, but do not free it.
163 * The buffer (or NULL, if none) is returned.
165 const void *detach_commit_buffer(struct commit *, unsigned long *sizep);
167 /* Find beginning and length of commit subject. */
168 int find_commit_subject(const char *commit_buffer, const char **subject);
170 /* Return length of the commit subject from commit log message. */
171 size_t commit_subject_length(const char *body);
173 struct commit_list *commit_list_insert(struct commit *item,
174 struct commit_list **list);
175 int commit_list_contains(struct commit *item,
176 struct commit_list *list);
177 struct commit_list **commit_list_append(struct commit *commit,
178 struct commit_list **next);
179 unsigned commit_list_count(const struct commit_list *l);
180 struct commit_list *commit_list_insert_by_date(struct commit *item,
181 struct commit_list **list);
182 void commit_list_sort_by_date(struct commit_list **list);
184 /* Shallow copy of the input list */
185 struct commit_list *copy_commit_list(struct commit_list *list);
187 /* Modify list in-place to reverse it, returning new head; list will be tail */
188 struct commit_list *reverse_commit_list(struct commit_list *list);
190 void free_commit_list(struct commit_list *list);
192 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
194 int has_non_ascii(const char *text);
195 const char *logmsg_reencode(const struct commit *commit,
196 char **commit_encoding,
197 const char *output_encoding);
198 const char *repo_logmsg_reencode(struct repository *r,
199 const struct commit *commit,
200 char **commit_encoding,
201 const char *output_encoding);
202 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
203 #define logmsg_reencode(c, enc, out) repo_logmsg_reencode(the_repository, c, enc, out)
204 #endif
206 const char *skip_blank_lines(const char *msg);
208 /** Removes the first commit from a list sorted by date, and adds all
209 * of its parents.
211 struct commit *pop_most_recent_commit(struct commit_list **list,
212 unsigned int mark);
214 struct commit *pop_commit(struct commit_list **stack);
216 void clear_commit_marks(struct commit *commit, unsigned int mark);
217 void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark);
220 enum rev_sort_order {
221 REV_SORT_IN_GRAPH_ORDER = 0,
222 REV_SORT_BY_COMMIT_DATE,
223 REV_SORT_BY_AUTHOR_DATE
227 * Performs an in-place topological sort of list supplied.
229 * invariant of resulting list is:
230 * a reachable from b => ord(b) < ord(a)
231 * sort_order further specifies:
232 * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
233 * chain together.
234 * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
236 void sort_in_topological_order(struct commit_list **, enum rev_sort_order);
238 struct commit_graft {
239 struct object_id oid;
240 int nr_parent; /* < 0 if shallow commit */
241 struct object_id parent[FLEX_ARRAY]; /* more */
243 typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
245 struct commit_graft *read_graft_line(struct strbuf *line);
246 /* commit_graft_pos returns an index into r->parsed_objects->grafts. */
247 int commit_graft_pos(struct repository *r, const struct object_id *oid);
248 int register_commit_graft(struct repository *r, struct commit_graft *, int);
249 void prepare_commit_graft(struct repository *r);
250 struct commit_graft *lookup_commit_graft(struct repository *r, const struct object_id *oid);
252 struct commit *get_fork_point(const char *refname, struct commit *commit);
254 /* largest positive number a signed 32-bit integer can contain */
255 #define INFINITE_DEPTH 0x7fffffff
257 struct oid_array;
258 struct ref;
259 int for_each_commit_graft(each_commit_graft_fn, void *);
261 int interactive_add(const char **argv, const char *prefix, int patch);
262 int run_add_interactive(const char *revision, const char *patch_mode,
263 const struct pathspec *pathspec);
265 struct commit_extra_header {
266 struct commit_extra_header *next;
267 char *key;
268 char *value;
269 size_t len;
272 void append_merge_tag_headers(struct commit_list *parents,
273 struct commit_extra_header ***tail);
275 int commit_tree(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 *sign_commit);
280 int commit_tree_extended(const char *msg, size_t msg_len,
281 const struct object_id *tree,
282 struct commit_list *parents, struct object_id *ret,
283 const char *author, const char *committer,
284 const char *sign_commit, struct commit_extra_header *);
286 struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
288 void free_commit_extra_headers(struct commit_extra_header *extra);
291 * Search the commit object contents given by "msg" for the header "key".
292 * Returns a pointer to the start of the header contents, or NULL. The length
293 * of the header, up to the first newline, is returned via out_len.
295 * Note that some headers (like mergetag) may be multi-line. It is the caller's
296 * responsibility to parse further in this case!
298 const char *find_commit_header(const char *msg, const char *key,
299 size_t *out_len);
301 /* Find the end of the log message, the right place for a new trailer. */
302 size_t ignore_non_trailer(const char *buf, size_t len);
304 typedef int (*each_mergetag_fn)(struct commit *commit, struct commit_extra_header *extra,
305 void *cb_data);
307 int for_each_mergetag(each_mergetag_fn fn, struct commit *commit, void *data);
309 struct merge_remote_desc {
310 struct object *obj; /* the named object, could be a tag */
311 char name[FLEX_ARRAY];
313 struct merge_remote_desc *merge_remote_util(struct commit *);
314 void set_merge_remote_desc(struct commit *commit,
315 const char *name, struct object *obj);
318 * Given "name" from the command line to merge, find the commit object
319 * and return it, while storing merge_remote_desc in its ->util field,
320 * to allow callers to tell if we are told to merge a tag.
322 struct commit *get_merge_parent(const char *name);
324 int parse_signed_commit(const struct commit *commit,
325 struct strbuf *message, struct strbuf *signature,
326 const struct git_hash_algo *algop);
327 int remove_signature(struct strbuf *buf);
330 * Check the signature of the given commit. The result of the check is stored
331 * in sig->check_result, 'G' for a good signature, 'U' for a good signature
332 * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
333 * at all. This may allocate memory for sig->gpg_output, sig->gpg_status,
334 * sig->signer and sig->key.
336 int check_commit_signature(const struct commit *commit, struct signature_check *sigc);
338 /* record author-date for each commit object */
339 struct author_date_slab;
340 void record_author_date(struct author_date_slab *author_date,
341 struct commit *commit);
343 int compare_commits_by_author_date(const void *a_, const void *b_, void *unused);
346 * Verify a single commit with check_commit_signature() and die() if it is not
347 * a good signature. This isn't really suitable for general use, but is a
348 * helper to implement consistent logic for pull/merge --verify-signatures.
350 * The check_trust parameter is meant for backward-compatibility. The GPG
351 * interface verifies key trust with a default trust level that is below the
352 * default trust level for merge operations. Its value should be non-zero if
353 * the user hasn't set a minimum trust level explicitly in their configuration.
355 * If the user has set a minimum trust level, then that value should be obeyed
356 * and check_trust should be zero, even if the configured trust level is below
357 * the default trust level for merges.
359 void verify_merge_signature(struct commit *commit, int verbose,
360 int check_trust);
362 int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused);
363 int compare_commits_by_gen_then_commit_date(const void *a_, const void *b_, void *unused);
365 LAST_ARG_MUST_BE_NULL
366 int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...);
368 /* Sign a commit or tag buffer, storing the result in a header. */
369 int sign_with_header(struct strbuf *buf, const char *keyid);
370 /* Parse the signature out of a header. */
371 int parse_buffer_signed_by_header(const char *buffer,
372 unsigned long size,
373 struct strbuf *payload,
374 struct strbuf *signature,
375 const struct git_hash_algo *algop);
377 #endif /* COMMIT_H */