8 #include "gpg-interface.h"
9 #include "string-list.h"
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
19 struct commit_list
*next
;
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.
30 struct commit_list
*parents
;
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().
37 struct tree
*maybe_tree
;
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
;
50 char name
[FLEX_ARRAY
];
53 enum decoration_type
{
56 DECORATION_REF_REMOTE
,
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
,
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
,
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);
91 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
92 #define parse_commit_internal(item, quiet, use) repo_parse_commit_internal(the_repository, item, quiet, use)
93 #define parse_commit_gently(item, quiet) repo_parse_commit_gently(the_repository, item, quiet)
94 #define parse_commit(item) repo_parse_commit(the_repository, item)
97 void parse_commit_or_die(struct commit
*item
);
100 struct buffer_slab
*allocate_commit_buffer_slab(void);
101 void free_commit_buffer_slab(struct buffer_slab
*bs
);
104 * Associate an object buffer with the commit. The ownership of the
105 * memory is handed over to the commit, and must be free()-able.
107 void set_commit_buffer(struct repository
*r
, struct commit
*, void *buffer
, unsigned long size
);
110 * Get any cached object buffer associated with the commit. Returns NULL
111 * if none. The resulting memory should not be freed.
113 const void *get_cached_commit_buffer(struct repository
*, const struct commit
*, unsigned long *size
);
116 * Get the commit's object contents, either from cache or by reading the object
117 * from disk. The resulting memory should not be modified, and must be given
118 * to unuse_commit_buffer when the caller is done.
120 const void *get_commit_buffer(const struct commit
*, unsigned long *size
);
123 * Tell the commit subsytem that we are done with a particular commit buffer.
124 * The commit and buffer should be the input and return value, respectively,
125 * from an earlier call to get_commit_buffer. The buffer may or may not be
126 * freed by this call; callers should not access the memory afterwards.
128 void unuse_commit_buffer(const struct commit
*, const void *buffer
);
131 * Free any cached object buffer associated with the commit.
133 void free_commit_buffer(struct commit
*);
135 struct tree
*get_commit_tree(const struct commit
*);
136 struct object_id
*get_commit_tree_oid(const struct commit
*);
139 * Release memory related to a commit, including the parent list and
140 * any cached object buffer.
142 void release_commit_memory(struct commit
*c
);
145 * Disassociate any cached object buffer from the commit, but do not free it.
146 * The buffer (or NULL, if none) is returned.
148 const void *detach_commit_buffer(struct commit
*, unsigned long *sizep
);
150 /* Find beginning and length of commit subject. */
151 int find_commit_subject(const char *commit_buffer
, const char **subject
);
153 struct commit_list
*commit_list_insert(struct commit
*item
,
154 struct commit_list
**list
);
155 struct commit_list
**commit_list_append(struct commit
*commit
,
156 struct commit_list
**next
);
157 unsigned commit_list_count(const struct commit_list
*l
);
158 struct commit_list
*commit_list_insert_by_date(struct commit
*item
,
159 struct commit_list
**list
);
160 void commit_list_sort_by_date(struct commit_list
**list
);
162 /* Shallow copy of the input list */
163 struct commit_list
*copy_commit_list(struct commit_list
*list
);
165 void free_commit_list(struct commit_list
*list
);
167 struct rev_info
; /* in revision.h, it circularly uses enum cmit_fmt */
169 extern int has_non_ascii(const char *text
);
170 extern const char *logmsg_reencode(const struct commit
*commit
,
171 char **commit_encoding
,
172 const char *output_encoding
);
173 extern const char *skip_blank_lines(const char *msg
);
175 /** Removes the first commit from a list sorted by date, and adds all
178 struct commit
*pop_most_recent_commit(struct commit_list
**list
,
181 struct commit
*pop_commit(struct commit_list
**stack
);
183 void clear_commit_marks(struct commit
*commit
, unsigned int mark
);
184 void clear_commit_marks_many(int nr
, struct commit
**commit
, unsigned int mark
);
187 enum rev_sort_order
{
188 REV_SORT_IN_GRAPH_ORDER
= 0,
189 REV_SORT_BY_COMMIT_DATE
,
190 REV_SORT_BY_AUTHOR_DATE
194 * Performs an in-place topological sort of list supplied.
196 * invariant of resulting list is:
197 * a reachable from b => ord(b) < ord(a)
198 * sort_order further specifies:
199 * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
201 * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
203 void sort_in_topological_order(struct commit_list
**, enum rev_sort_order
);
205 struct commit_graft
{
206 struct object_id oid
;
207 int nr_parent
; /* < 0 if shallow commit */
208 struct object_id parent
[FLEX_ARRAY
]; /* more */
210 typedef int (*each_commit_graft_fn
)(const struct commit_graft
*, void *);
212 struct commit_graft
*read_graft_line(struct strbuf
*line
);
213 int register_commit_graft(struct repository
*r
, struct commit_graft
*, int);
214 void prepare_commit_graft(struct repository
*r
);
215 struct commit_graft
*lookup_commit_graft(struct repository
*r
, const struct object_id
*oid
);
217 /* largest positive number a signed 32-bit integer can contain */
218 #define INFINITE_DEPTH 0x7fffffff
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);
239 struct shallow_info
{
240 struct oid_array
*shallow
;
242 int *theirs
, nr_theirs
;
243 struct oid_array
*ref
;
245 /* for receive-pack */
246 uint32_t **used_shallow
;
247 int *need_reachability_test
;
250 struct commit
**commits
;
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
,
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
;
264 extern int interactive_add(int argc
, const char **argv
, const char *prefix
, int patch
);
265 extern int run_add_interactive(const char *revision
, const char *patch_mode
,
266 const struct pathspec
*pathspec
);
268 struct commit_extra_header
{
269 struct commit_extra_header
*next
;
275 extern void append_merge_tag_headers(struct commit_list
*parents
,
276 struct commit_extra_header
***tail
);
278 extern int commit_tree(const char *msg
, size_t msg_len
,
279 const struct object_id
*tree
,
280 struct commit_list
*parents
, struct object_id
*ret
,
281 const char *author
, const char *sign_commit
);
283 extern int commit_tree_extended(const char *msg
, size_t msg_len
,
284 const struct object_id
*tree
,
285 struct commit_list
*parents
,
286 struct object_id
*ret
, const char *author
,
287 const char *sign_commit
,
288 struct commit_extra_header
*);
290 extern struct commit_extra_header
*read_commit_extra_headers(struct commit
*, const char **);
292 extern void free_commit_extra_headers(struct commit_extra_header
*extra
);
295 * Search the commit object contents given by "msg" for the header "key".
296 * Returns a pointer to the start of the header contents, or NULL. The length
297 * of the header, up to the first newline, is returned via out_len.
299 * Note that some headers (like mergetag) may be multi-line. It is the caller's
300 * responsibility to parse further in this case!
302 extern const char *find_commit_header(const char *msg
, const char *key
,
305 /* Find the end of the log message, the right place for a new trailer. */
306 extern size_t ignore_non_trailer(const char *buf
, size_t len
);
308 typedef int (*each_mergetag_fn
)(struct commit
*commit
, struct commit_extra_header
*extra
,
311 extern int for_each_mergetag(each_mergetag_fn fn
, struct commit
*commit
, void *data
);
313 struct merge_remote_desc
{
314 struct object
*obj
; /* the named object, could be a tag */
315 char name
[FLEX_ARRAY
];
317 extern struct merge_remote_desc
*merge_remote_util(struct commit
*);
318 extern void set_merge_remote_desc(struct commit
*commit
,
319 const char *name
, struct object
*obj
);
322 * Given "name" from the command line to merge, find the commit object
323 * and return it, while storing merge_remote_desc in its ->util field,
324 * to allow callers to tell if we are told to merge a tag.
326 struct commit
*get_merge_parent(const char *name
);
328 extern int parse_signed_commit(const struct commit
*commit
,
329 struct strbuf
*message
, struct strbuf
*signature
);
330 extern int remove_signature(struct strbuf
*buf
);
333 * Check the signature of the given commit. The result of the check is stored
334 * in sig->check_result, 'G' for a good signature, 'U' for a good signature
335 * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
336 * at all. This may allocate memory for sig->gpg_output, sig->gpg_status,
337 * sig->signer and sig->key.
339 extern int check_commit_signature(const struct commit
*commit
, struct signature_check
*sigc
);
341 int compare_commits_by_commit_date(const void *a_
, const void *b_
, void *unused
);
342 int compare_commits_by_gen_then_commit_date(const void *a_
, const void *b_
, void *unused
);
344 LAST_ARG_MUST_BE_NULL
345 extern int run_commit_hook(int editor_is_used
, const char *index_file
, const char *name
, ...);
347 #endif /* COMMIT_H */