8 #include "gpg-interface.h"
9 #include "string-list.h"
11 #include "commit-slab.h"
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
20 struct commit_list
*next
;
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.
31 struct commit_list
*parents
;
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().
38 struct tree
*maybe_tree
;
44 extern int save_commit_buffer
;
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
;
51 char name
[FLEX_ARRAY
];
54 enum decoration_type
{
57 DECORATION_REF_REMOTE
,
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
,
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
,
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);
92 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
93 #define parse_commit_internal(item, quiet, use) repo_parse_commit_internal(the_repository, item, quiet, use)
94 #define parse_commit_gently(item, quiet) repo_parse_commit_gently(the_repository, item, quiet)
95 #define parse_commit(item) repo_parse_commit(the_repository, item)
98 void parse_commit_or_die(struct commit
*item
);
101 struct buffer_slab
*allocate_commit_buffer_slab(void);
102 void free_commit_buffer_slab(struct buffer_slab
*bs
);
105 * Associate an object buffer with the commit. The ownership of the
106 * memory is handed over to the commit, and must be free()-able.
108 void set_commit_buffer(struct repository
*r
, struct commit
*, void *buffer
, unsigned long size
);
111 * Get any cached object buffer associated with the commit. Returns NULL
112 * if none. The resulting memory should not be freed.
114 const void *get_cached_commit_buffer(struct repository
*, const struct commit
*, unsigned long *size
);
117 * Get the commit's object contents, either from cache or by reading the object
118 * from disk. The resulting memory should not be modified, and must be given
119 * to unuse_commit_buffer when the caller is done.
121 const void *repo_get_commit_buffer(struct repository
*r
,
122 const struct commit
*,
123 unsigned long *size
);
124 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
125 #define get_commit_buffer(c, s) repo_get_commit_buffer(the_repository, c, s)
129 * Tell the commit subsytem that we are done with a particular commit buffer.
130 * The commit and buffer should be the input and return value, respectively,
131 * from an earlier call to get_commit_buffer. The buffer may or may not be
132 * freed by this call; callers should not access the memory afterwards.
134 void repo_unuse_commit_buffer(struct repository
*r
,
135 const struct commit
*,
137 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
138 #define unuse_commit_buffer(c, b) repo_unuse_commit_buffer(the_repository, c, b)
142 * Free any cached object buffer associated with the commit.
144 void free_commit_buffer(struct parsed_object_pool
*pool
, struct commit
*);
146 struct tree
*repo_get_commit_tree(struct repository
*, const struct commit
*);
147 #define get_commit_tree(c) repo_get_commit_tree(the_repository, c)
148 struct object_id
*get_commit_tree_oid(const struct commit
*);
151 * Release memory related to a commit, including the parent list and
152 * any cached object buffer.
154 void release_commit_memory(struct parsed_object_pool
*pool
, struct commit
*c
);
157 * Disassociate any cached object buffer from the commit, but do not free it.
158 * The buffer (or NULL, if none) is returned.
160 const void *detach_commit_buffer(struct commit
*, unsigned long *sizep
);
162 /* Find beginning and length of commit subject. */
163 int find_commit_subject(const char *commit_buffer
, const char **subject
);
165 struct commit_list
*commit_list_insert(struct commit
*item
,
166 struct commit_list
**list
);
167 struct commit_list
**commit_list_append(struct commit
*commit
,
168 struct commit_list
**next
);
169 unsigned commit_list_count(const struct commit_list
*l
);
170 struct commit_list
*commit_list_insert_by_date(struct commit
*item
,
171 struct commit_list
**list
);
172 void commit_list_sort_by_date(struct commit_list
**list
);
174 /* Shallow copy of the input list */
175 struct commit_list
*copy_commit_list(struct commit_list
*list
);
177 void free_commit_list(struct commit_list
*list
);
179 struct rev_info
; /* in revision.h, it circularly uses enum cmit_fmt */
181 extern int has_non_ascii(const char *text
);
182 extern const char *logmsg_reencode(const struct commit
*commit
,
183 char **commit_encoding
,
184 const char *output_encoding
);
185 const char *repo_logmsg_reencode(struct repository
*r
,
186 const struct commit
*commit
,
187 char **commit_encoding
,
188 const char *output_encoding
);
189 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
190 #define logmsg_reencode(c, enc, out) repo_logmsg_reencode(the_repository, c, enc, out)
193 extern const char *skip_blank_lines(const char *msg
);
195 /** Removes the first commit from a list sorted by date, and adds all
198 struct commit
*pop_most_recent_commit(struct commit_list
**list
,
201 struct commit
*pop_commit(struct commit_list
**stack
);
203 void clear_commit_marks(struct commit
*commit
, unsigned int mark
);
204 void clear_commit_marks_many(int nr
, struct commit
**commit
, unsigned int mark
);
207 enum rev_sort_order
{
208 REV_SORT_IN_GRAPH_ORDER
= 0,
209 REV_SORT_BY_COMMIT_DATE
,
210 REV_SORT_BY_AUTHOR_DATE
214 * Performs an in-place topological sort of list supplied.
216 * invariant of resulting list is:
217 * a reachable from b => ord(b) < ord(a)
218 * sort_order further specifies:
219 * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
221 * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
223 void sort_in_topological_order(struct commit_list
**, enum rev_sort_order
);
225 struct commit_graft
{
226 struct object_id oid
;
227 int nr_parent
; /* < 0 if shallow commit */
228 struct object_id parent
[FLEX_ARRAY
]; /* more */
230 typedef int (*each_commit_graft_fn
)(const struct commit_graft
*, void *);
232 struct commit_graft
*read_graft_line(struct strbuf
*line
);
233 int register_commit_graft(struct repository
*r
, struct commit_graft
*, int);
234 void prepare_commit_graft(struct repository
*r
);
235 struct commit_graft
*lookup_commit_graft(struct repository
*r
, const struct object_id
*oid
);
237 struct commit
*get_fork_point(const char *refname
, struct commit
*commit
);
239 /* largest positive number a signed 32-bit integer can contain */
240 #define INFINITE_DEPTH 0x7fffffff
244 extern int register_shallow(struct repository
*r
, const struct object_id
*oid
);
245 extern int unregister_shallow(const struct object_id
*oid
);
246 extern int for_each_commit_graft(each_commit_graft_fn
, void *);
247 extern int is_repository_shallow(struct repository
*r
);
248 extern struct commit_list
*get_shallow_commits(struct object_array
*heads
,
249 int depth
, int shallow_flag
, int not_shallow_flag
);
250 extern struct commit_list
*get_shallow_commits_by_rev_list(
251 int ac
, const char **av
, int shallow_flag
, int not_shallow_flag
);
252 extern void set_alternate_shallow_file(struct repository
*r
, const char *path
, int override
);
253 extern int write_shallow_commits(struct strbuf
*out
, int use_pack_protocol
,
254 const struct oid_array
*extra
);
255 extern void setup_alternate_shallow(struct lock_file
*shallow_lock
,
256 const char **alternate_shallow_file
,
257 const struct oid_array
*extra
);
258 extern const char *setup_temporary_shallow(const struct oid_array
*extra
);
259 extern void advertise_shallow_grafts(int);
261 struct shallow_info
{
262 struct oid_array
*shallow
;
264 int *theirs
, nr_theirs
;
265 struct oid_array
*ref
;
267 /* for receive-pack */
268 uint32_t **used_shallow
;
269 int *need_reachability_test
;
272 struct commit
**commits
;
276 extern void prepare_shallow_info(struct shallow_info
*, struct oid_array
*);
277 extern void clear_shallow_info(struct shallow_info
*);
278 extern void remove_nonexistent_theirs_shallow(struct shallow_info
*);
279 extern void assign_shallow_commits_to_refs(struct shallow_info
*info
,
282 extern int delayed_reachability_test(struct shallow_info
*si
, int c
);
283 #define PRUNE_SHOW_ONLY 1
284 #define PRUNE_QUICK 2
285 extern void prune_shallow(unsigned options
);
286 extern struct trace_key trace_shallow
;
288 extern int interactive_add(int argc
, const char **argv
, const char *prefix
, int patch
);
289 extern int run_add_interactive(const char *revision
, const char *patch_mode
,
290 const struct pathspec
*pathspec
);
292 struct commit_extra_header
{
293 struct commit_extra_header
*next
;
299 extern void append_merge_tag_headers(struct commit_list
*parents
,
300 struct commit_extra_header
***tail
);
302 extern int commit_tree(const char *msg
, size_t msg_len
,
303 const struct object_id
*tree
,
304 struct commit_list
*parents
, struct object_id
*ret
,
305 const char *author
, const char *sign_commit
);
307 extern int commit_tree_extended(const char *msg
, size_t msg_len
,
308 const struct object_id
*tree
,
309 struct commit_list
*parents
,
310 struct object_id
*ret
, const char *author
,
311 const char *sign_commit
,
312 struct commit_extra_header
*);
314 extern struct commit_extra_header
*read_commit_extra_headers(struct commit
*, const char **);
316 extern void free_commit_extra_headers(struct commit_extra_header
*extra
);
319 * Search the commit object contents given by "msg" for the header "key".
320 * Returns a pointer to the start of the header contents, or NULL. The length
321 * of the header, up to the first newline, is returned via out_len.
323 * Note that some headers (like mergetag) may be multi-line. It is the caller's
324 * responsibility to parse further in this case!
326 extern const char *find_commit_header(const char *msg
, const char *key
,
329 /* Find the end of the log message, the right place for a new trailer. */
330 extern size_t ignore_non_trailer(const char *buf
, size_t len
);
332 typedef int (*each_mergetag_fn
)(struct commit
*commit
, struct commit_extra_header
*extra
,
335 extern int for_each_mergetag(each_mergetag_fn fn
, struct commit
*commit
, void *data
);
337 struct merge_remote_desc
{
338 struct object
*obj
; /* the named object, could be a tag */
339 char name
[FLEX_ARRAY
];
341 extern struct merge_remote_desc
*merge_remote_util(struct commit
*);
342 extern void set_merge_remote_desc(struct commit
*commit
,
343 const char *name
, struct object
*obj
);
346 * Given "name" from the command line to merge, find the commit object
347 * and return it, while storing merge_remote_desc in its ->util field,
348 * to allow callers to tell if we are told to merge a tag.
350 struct commit
*get_merge_parent(const char *name
);
352 extern int parse_signed_commit(const struct commit
*commit
,
353 struct strbuf
*message
, struct strbuf
*signature
);
354 extern int remove_signature(struct strbuf
*buf
);
357 * Check the signature of the given commit. The result of the check is stored
358 * in sig->check_result, 'G' for a good signature, 'U' for a good signature
359 * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
360 * at all. This may allocate memory for sig->gpg_output, sig->gpg_status,
361 * sig->signer and sig->key.
363 extern int check_commit_signature(const struct commit
*commit
, struct signature_check
*sigc
);
365 /* record author-date for each commit object */
366 struct author_date_slab
;
367 void record_author_date(struct author_date_slab
*author_date
,
368 struct commit
*commit
);
370 int compare_commits_by_author_date(const void *a_
, const void *b_
, void *unused
);
373 * Verify a single commit with check_commit_signature() and die() if it is not
374 * a good signature. This isn't really suitable for general use, but is a
375 * helper to implement consistent logic for pull/merge --verify-signatures.
377 void verify_merge_signature(struct commit
*commit
, int verbose
);
379 int compare_commits_by_commit_date(const void *a_
, const void *b_
, void *unused
);
380 int compare_commits_by_gen_then_commit_date(const void *a_
, const void *b_
, void *unused
);
382 LAST_ARG_MUST_BE_NULL
383 extern int run_commit_hook(int editor_is_used
, const char *index_file
, const char *name
, ...);
385 #endif /* COMMIT_H */