Git 2.35.8
[git.git] / commit.h
blob3ea32766bcb00ada1c55f948ab6cc503b04c72a7
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 int no_graft_file_deprecated_advice;
45 extern const char *commit_type;
47 /* While we can decorate any object with a name, it's only used for commits.. */
48 struct name_decoration {
49 struct name_decoration *next;
50 int type;
51 char name[FLEX_ARRAY];
54 enum decoration_type {
55 DECORATION_NONE = 0,
56 DECORATION_REF_LOCAL,
57 DECORATION_REF_REMOTE,
58 DECORATION_REF_TAG,
59 DECORATION_REF_STASH,
60 DECORATION_REF_HEAD,
61 DECORATION_GRAFTED,
64 void add_name_decoration(enum decoration_type type, const char *name, struct object *obj);
65 const struct name_decoration *get_name_decoration(const struct object *obj);
67 struct commit *lookup_commit(struct repository *r, const struct object_id *oid);
68 struct commit *lookup_commit_reference(struct repository *r,
69 const struct object_id *oid);
70 struct commit *lookup_commit_reference_gently(struct repository *r,
71 const struct object_id *oid,
72 int quiet);
73 struct commit *lookup_commit_reference_by_name(const char *name);
76 * Look up object named by "oid", dereference tag as necessary,
77 * get a commit and return it. If "oid" does not dereference to
78 * a commit, use ref_name to report an error and die.
80 struct commit *lookup_commit_or_die(const struct object_id *oid, const char *ref_name);
82 int parse_commit_buffer(struct repository *r, struct commit *item, const void *buffer, unsigned long size, int check_graph);
83 int repo_parse_commit_internal(struct repository *r, struct commit *item,
84 int quiet_on_missing, int use_commit_graph);
85 int repo_parse_commit_gently(struct repository *r,
86 struct commit *item,
87 int quiet_on_missing);
88 static inline int repo_parse_commit(struct repository *r, struct commit *item)
90 return repo_parse_commit_gently(r, item, 0);
93 static inline int repo_parse_commit_no_graph(struct repository *r,
94 struct commit *commit)
96 return repo_parse_commit_internal(r, commit, 0, 0);
99 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
100 #define parse_commit_internal(item, quiet, use) repo_parse_commit_internal(the_repository, item, quiet, use)
101 #define parse_commit(item) repo_parse_commit(the_repository, item)
102 #endif
104 void parse_commit_or_die(struct commit *item);
106 struct buffer_slab;
107 struct buffer_slab *allocate_commit_buffer_slab(void);
108 void free_commit_buffer_slab(struct buffer_slab *bs);
111 * Associate an object buffer with the commit. The ownership of the
112 * memory is handed over to the commit, and must be free()-able.
114 void set_commit_buffer(struct repository *r, struct commit *, void *buffer, unsigned long size);
117 * Get any cached object buffer associated with the commit. Returns NULL
118 * if none. The resulting memory should not be freed.
120 const void *get_cached_commit_buffer(struct repository *, const struct commit *, unsigned long *size);
123 * Get the commit's object contents, either from cache or by reading the object
124 * from disk. The resulting memory should not be modified, and must be given
125 * to unuse_commit_buffer when the caller is done.
127 const void *repo_get_commit_buffer(struct repository *r,
128 const struct commit *,
129 unsigned long *size);
130 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
131 #define get_commit_buffer(c, s) repo_get_commit_buffer(the_repository, c, s)
132 #endif
135 * Tell the commit subsystem that we are done with a particular commit buffer.
136 * The commit and buffer should be the input and return value, respectively,
137 * from an earlier call to get_commit_buffer. The buffer may or may not be
138 * freed by this call; callers should not access the memory afterwards.
140 void repo_unuse_commit_buffer(struct repository *r,
141 const struct commit *,
142 const void *buffer);
143 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
144 #define unuse_commit_buffer(c, b) repo_unuse_commit_buffer(the_repository, c, b)
145 #endif
148 * Free any cached object buffer associated with the commit.
150 void free_commit_buffer(struct parsed_object_pool *pool, struct commit *);
152 struct tree *repo_get_commit_tree(struct repository *, const struct commit *);
153 #define get_commit_tree(c) repo_get_commit_tree(the_repository, c)
154 struct object_id *get_commit_tree_oid(const struct commit *);
157 * Release memory related to a commit, including the parent list and
158 * any cached object buffer.
160 void release_commit_memory(struct parsed_object_pool *pool, struct commit *c);
163 * Disassociate any cached object buffer from the commit, but do not free it.
164 * The buffer (or NULL, if none) is returned.
166 const void *detach_commit_buffer(struct commit *, unsigned long *sizep);
168 /* Find beginning and length of commit subject. */
169 int find_commit_subject(const char *commit_buffer, const char **subject);
171 /* Return length of the commit subject from commit log message. */
172 size_t commit_subject_length(const char *body);
174 struct commit_list *commit_list_insert(struct commit *item,
175 struct commit_list **list);
176 int commit_list_contains(struct commit *item,
177 struct commit_list *list);
178 struct commit_list **commit_list_append(struct commit *commit,
179 struct commit_list **next);
180 unsigned commit_list_count(const struct commit_list *l);
181 struct commit_list *commit_list_insert_by_date(struct commit *item,
182 struct commit_list **list);
183 void commit_list_sort_by_date(struct commit_list **list);
185 /* Shallow copy of the input list */
186 struct commit_list *copy_commit_list(struct commit_list *list);
188 /* Modify list in-place to reverse it, returning new head; list will be tail */
189 struct commit_list *reverse_commit_list(struct commit_list *list);
191 void free_commit_list(struct commit_list *list);
193 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
195 int has_non_ascii(const char *text);
196 const char *logmsg_reencode(const struct commit *commit,
197 char **commit_encoding,
198 const char *output_encoding);
199 const char *repo_logmsg_reencode(struct repository *r,
200 const struct commit *commit,
201 char **commit_encoding,
202 const char *output_encoding);
203 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
204 #define logmsg_reencode(c, enc, out) repo_logmsg_reencode(the_repository, c, enc, out)
205 #endif
207 const char *skip_blank_lines(const char *msg);
209 /** Removes the first commit from a list sorted by date, and adds all
210 * of its parents.
212 struct commit *pop_most_recent_commit(struct commit_list **list,
213 unsigned int mark);
215 struct commit *pop_commit(struct commit_list **stack);
217 void clear_commit_marks(struct commit *commit, unsigned int mark);
218 void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark);
221 enum rev_sort_order {
222 REV_SORT_IN_GRAPH_ORDER = 0,
223 REV_SORT_BY_COMMIT_DATE,
224 REV_SORT_BY_AUTHOR_DATE
228 * Performs an in-place topological sort of list supplied.
230 * invariant of resulting list is:
231 * a reachable from b => ord(b) < ord(a)
232 * sort_order further specifies:
233 * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
234 * chain together.
235 * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
237 void sort_in_topological_order(struct commit_list **, enum rev_sort_order);
239 struct commit_graft {
240 struct object_id oid;
241 int nr_parent; /* < 0 if shallow commit */
242 struct object_id parent[FLEX_ARRAY]; /* more */
244 typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
246 struct commit_graft *read_graft_line(struct strbuf *line);
247 /* commit_graft_pos returns an index into r->parsed_objects->grafts. */
248 int commit_graft_pos(struct repository *r, const struct object_id *oid);
249 int register_commit_graft(struct repository *r, struct commit_graft *, int);
250 void prepare_commit_graft(struct repository *r);
251 struct commit_graft *lookup_commit_graft(struct repository *r, const struct object_id *oid);
253 struct commit *get_fork_point(const char *refname, struct commit *commit);
255 /* largest positive number a signed 32-bit integer can contain */
256 #define INFINITE_DEPTH 0x7fffffff
258 struct oid_array;
259 struct ref;
260 int for_each_commit_graft(each_commit_graft_fn, void *);
262 int interactive_add(const char **argv, const char *prefix, int patch);
263 int run_add_interactive(const char *revision, const char *patch_mode,
264 const struct pathspec *pathspec);
266 struct commit_extra_header {
267 struct commit_extra_header *next;
268 char *key;
269 char *value;
270 size_t len;
273 void append_merge_tag_headers(struct commit_list *parents,
274 struct commit_extra_header ***tail);
276 int commit_tree(const char *msg, size_t msg_len,
277 const struct object_id *tree,
278 struct commit_list *parents, struct object_id *ret,
279 const char *author, const char *sign_commit);
281 int commit_tree_extended(const char *msg, size_t msg_len,
282 const struct object_id *tree,
283 struct commit_list *parents, struct object_id *ret,
284 const char *author, const char *committer,
285 const char *sign_commit, struct commit_extra_header *);
287 struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
289 void free_commit_extra_headers(struct commit_extra_header *extra);
292 * Search the commit object contents given by "msg" for the header "key".
293 * Returns a pointer to the start of the header contents, or NULL. The length
294 * of the header, up to the first newline, is returned via out_len.
296 * Note that some headers (like mergetag) may be multi-line. It is the caller's
297 * responsibility to parse further in this case!
299 const char *find_commit_header(const char *msg, const char *key,
300 size_t *out_len);
302 /* Find the end of the log message, the right place for a new trailer. */
303 size_t ignore_non_trailer(const char *buf, size_t len);
305 typedef int (*each_mergetag_fn)(struct commit *commit, struct commit_extra_header *extra,
306 void *cb_data);
308 int for_each_mergetag(each_mergetag_fn fn, struct commit *commit, void *data);
310 struct merge_remote_desc {
311 struct object *obj; /* the named object, could be a tag */
312 char name[FLEX_ARRAY];
314 struct merge_remote_desc *merge_remote_util(struct commit *);
315 void set_merge_remote_desc(struct commit *commit,
316 const char *name, struct object *obj);
319 * Given "name" from the command line to merge, find the commit object
320 * and return it, while storing merge_remote_desc in its ->util field,
321 * to allow callers to tell if we are told to merge a tag.
323 struct commit *get_merge_parent(const char *name);
325 int parse_signed_commit(const struct commit *commit,
326 struct strbuf *message, struct strbuf *signature,
327 const struct git_hash_algo *algop);
328 int remove_signature(struct strbuf *buf);
331 * Check the signature of the given commit. The result of the check is stored
332 * in sig->check_result, 'G' for a good signature, 'U' for a good signature
333 * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
334 * at all. This may allocate memory for sig->gpg_output, sig->gpg_status,
335 * sig->signer and sig->key.
337 int check_commit_signature(const struct commit *commit, struct signature_check *sigc);
339 /* record author-date for each commit object */
340 struct author_date_slab;
341 void record_author_date(struct author_date_slab *author_date,
342 struct commit *commit);
344 int compare_commits_by_author_date(const void *a_, const void *b_, void *unused);
347 * Verify a single commit with check_commit_signature() and die() if it is not
348 * a good signature. This isn't really suitable for general use, but is a
349 * helper to implement consistent logic for pull/merge --verify-signatures.
351 * The check_trust parameter is meant for backward-compatibility. The GPG
352 * interface verifies key trust with a default trust level that is below the
353 * default trust level for merge operations. Its value should be non-zero if
354 * the user hasn't set a minimum trust level explicitly in their configuration.
356 * If the user has set a minimum trust level, then that value should be obeyed
357 * and check_trust should be zero, even if the configured trust level is below
358 * the default trust level for merges.
360 void verify_merge_signature(struct commit *commit, int verbose,
361 int check_trust);
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);
366 LAST_ARG_MUST_BE_NULL
367 int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...);
369 /* Sign a commit or tag buffer, storing the result in a header. */
370 int sign_with_header(struct strbuf *buf, const char *keyid);
371 /* Parse the signature out of a header. */
372 int parse_buffer_signed_by_header(const char *buffer,
373 unsigned long size,
374 struct strbuf *payload,
375 struct strbuf *signature,
376 const struct git_hash_algo *algop);
378 #endif /* COMMIT_H */