8 #include "gpg-interface.h"
9 #include "string-list.h"
13 struct commit_list
*next
;
21 struct commit_list
*parents
;
26 extern int save_commit_buffer
;
27 extern const char *commit_type
;
29 /* While we can decorate any object with a name, it's only used for commits.. */
30 extern struct decoration name_decoration
;
31 struct name_decoration
{
32 struct name_decoration
*next
;
37 struct commit
*lookup_commit(const unsigned char *sha1
);
38 struct commit
*lookup_commit_reference(const unsigned char *sha1
);
39 struct commit
*lookup_commit_reference_gently(const unsigned char *sha1
,
41 struct commit
*lookup_commit_reference_by_name(const char *name
);
44 * Look up object named by "sha1", dereference tag as necessary,
45 * get a commit and return it. If "sha1" does not dereference to
46 * a commit, use ref_name to report an error and die.
48 struct commit
*lookup_commit_or_die(const unsigned char *sha1
, const char *ref_name
);
50 int parse_commit_buffer(struct commit
*item
, const void *buffer
, unsigned long size
);
51 int parse_commit(struct commit
*item
);
52 void parse_commit_or_die(struct commit
*item
);
55 * Associate an object buffer with the commit. The ownership of the
56 * memory is handed over to the commit, and must be free()-able.
58 void set_commit_buffer(struct commit
*, void *buffer
);
61 * Free any cached object buffer associated with the commit.
63 void free_commit_buffer(struct commit
*);
66 * Disassociate any cached object buffer from the commit, but do not free it.
67 * The buffer (or NULL, if none) is returned.
69 const void *detach_commit_buffer(struct commit
*);
71 /* Find beginning and length of commit subject. */
72 int find_commit_subject(const char *commit_buffer
, const char **subject
);
74 struct commit_list
*commit_list_insert(struct commit
*item
,
75 struct commit_list
**list
);
76 struct commit_list
**commit_list_append(struct commit
*commit
,
77 struct commit_list
**next
);
78 unsigned commit_list_count(const struct commit_list
*l
);
79 struct commit_list
*commit_list_insert_by_date(struct commit
*item
,
80 struct commit_list
**list
);
81 void commit_list_sort_by_date(struct commit_list
**list
);
83 /* Shallow copy of the input list */
84 struct commit_list
*copy_commit_list(struct commit_list
*list
);
86 void free_commit_list(struct commit_list
*list
);
92 CMIT_FMT_DEFAULT
= CMIT_FMT_MEDIUM
,
103 struct pretty_print_context
{
105 * Callers should tweak these to change the behavior of pp_* functions.
110 const char *after_subject
;
111 int preserve_subject
;
112 enum date_mode date_mode
;
113 unsigned date_mode_explicit
:1;
116 struct reflog_walk_info
*reflog_info
;
117 const char *output_encoding
;
118 struct string_list
*mailmap
;
120 struct ident_split
*from_ident
;
123 * Fields below here are manipulated internally by pp_* functions and
124 * should not be counted on by callers.
126 struct string_list in_body_headers
;
129 struct userformat_want
{
133 extern int has_non_ascii(const char *text
);
134 struct rev_info
; /* in revision.h, it circularly uses enum cmit_fmt */
135 extern const char *logmsg_reencode(const struct commit
*commit
,
136 char **commit_encoding
,
137 const char *output_encoding
);
138 extern void logmsg_free(const char *msg
, const struct commit
*commit
);
139 extern void get_commit_format(const char *arg
, struct rev_info
*);
140 extern const char *format_subject(struct strbuf
*sb
, const char *msg
,
141 const char *line_separator
);
142 extern void userformat_find_requirements(const char *fmt
, struct userformat_want
*w
);
143 extern void format_commit_message(const struct commit
*commit
,
144 const char *format
, struct strbuf
*sb
,
145 const struct pretty_print_context
*context
);
146 extern void pretty_print_commit(struct pretty_print_context
*pp
,
147 const struct commit
*commit
,
149 extern void pp_commit_easy(enum cmit_fmt fmt
, const struct commit
*commit
,
151 void pp_user_info(struct pretty_print_context
*pp
,
152 const char *what
, struct strbuf
*sb
,
153 const char *line
, const char *encoding
);
154 void pp_title_line(struct pretty_print_context
*pp
,
157 const char *encoding
,
159 void pp_remainder(struct pretty_print_context
*pp
,
165 /** Removes the first commit from a list sorted by date, and adds all
168 struct commit
*pop_most_recent_commit(struct commit_list
**list
,
171 struct commit
*pop_commit(struct commit_list
**stack
);
173 void clear_commit_marks(struct commit
*commit
, unsigned int mark
);
174 void clear_commit_marks_many(int nr
, struct commit
**commit
, unsigned int mark
);
175 void clear_commit_marks_for_object_array(struct object_array
*a
, unsigned mark
);
178 enum rev_sort_order
{
179 REV_SORT_IN_GRAPH_ORDER
= 0,
180 REV_SORT_BY_COMMIT_DATE
,
181 REV_SORT_BY_AUTHOR_DATE
185 * Performs an in-place topological sort of list supplied.
187 * invariant of resulting list is:
188 * a reachable from b => ord(b) < ord(a)
189 * sort_order further specifies:
190 * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
192 * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
194 void sort_in_topological_order(struct commit_list
**, enum rev_sort_order
);
196 struct commit_graft
{
197 unsigned char sha1
[20];
198 int nr_parent
; /* < 0 if shallow commit */
199 unsigned char parent
[FLEX_ARRAY
][20]; /* more */
201 typedef int (*each_commit_graft_fn
)(const struct commit_graft
*, void *);
203 struct commit_graft
*read_graft_line(char *buf
, int len
);
204 int register_commit_graft(struct commit_graft
*, int);
205 struct commit_graft
*lookup_commit_graft(const unsigned char *sha1
);
207 extern struct commit_list
*get_merge_bases(struct commit
*rev1
, struct commit
*rev2
, int cleanup
);
208 extern struct commit_list
*get_merge_bases_many(struct commit
*one
, int n
, struct commit
**twos
, int cleanup
);
209 extern struct commit_list
*get_octopus_merge_bases(struct commit_list
*in
);
211 /* largest positive number a signed 32-bit integer can contain */
212 #define INFINITE_DEPTH 0x7fffffff
216 extern int register_shallow(const unsigned char *sha1
);
217 extern int unregister_shallow(const unsigned char *sha1
);
218 extern int for_each_commit_graft(each_commit_graft_fn
, void *);
219 extern int is_repository_shallow(void);
220 extern struct commit_list
*get_shallow_commits(struct object_array
*heads
,
221 int depth
, int shallow_flag
, int not_shallow_flag
);
222 extern void check_shallow_file_for_update(void);
223 extern void set_alternate_shallow_file(const char *path
, int override
);
224 extern int write_shallow_commits(struct strbuf
*out
, int use_pack_protocol
,
225 const struct sha1_array
*extra
);
226 extern void setup_alternate_shallow(struct lock_file
*shallow_lock
,
227 const char **alternate_shallow_file
,
228 const struct sha1_array
*extra
);
229 extern const char *setup_temporary_shallow(const struct sha1_array
*extra
);
230 extern void advertise_shallow_grafts(int);
232 struct shallow_info
{
233 struct sha1_array
*shallow
;
235 int *theirs
, nr_theirs
;
236 struct sha1_array
*ref
;
238 /* for receive-pack */
239 uint32_t **used_shallow
;
240 int *need_reachability_test
;
243 struct commit
**commits
;
247 extern void prepare_shallow_info(struct shallow_info
*, struct sha1_array
*);
248 extern void clear_shallow_info(struct shallow_info
*);
249 extern void remove_nonexistent_theirs_shallow(struct shallow_info
*);
250 extern void assign_shallow_commits_to_refs(struct shallow_info
*info
,
253 extern int delayed_reachability_test(struct shallow_info
*si
, int c
);
254 extern void prune_shallow(int show_only
);
256 int is_descendant_of(struct commit
*, struct commit_list
*);
257 int in_merge_bases(struct commit
*, struct commit
*);
258 int in_merge_bases_many(struct commit
*, int, struct commit
**);
260 extern int interactive_add(int argc
, const char **argv
, const char *prefix
, int patch
);
261 extern int run_add_interactive(const char *revision
, const char *patch_mode
,
262 const struct pathspec
*pathspec
);
264 static inline int single_parent(struct commit
*commit
)
266 return commit
->parents
&& !commit
->parents
->next
;
269 struct commit_list
*reduce_heads(struct commit_list
*heads
);
271 struct commit_extra_header
{
272 struct commit_extra_header
*next
;
278 extern void append_merge_tag_headers(struct commit_list
*parents
,
279 struct commit_extra_header
***tail
);
281 extern int commit_tree(const char *msg
, size_t msg_len
,
282 const unsigned char *tree
,
283 struct commit_list
*parents
, unsigned char *ret
,
284 const char *author
, const char *sign_commit
);
286 extern int commit_tree_extended(const char *msg
, size_t msg_len
,
287 const unsigned char *tree
,
288 struct commit_list
*parents
, unsigned char *ret
,
289 const char *author
, const char *sign_commit
,
290 struct commit_extra_header
*);
292 extern struct commit_extra_header
*read_commit_extra_headers(struct commit
*, const char **);
294 extern void free_commit_extra_headers(struct commit_extra_header
*extra
);
296 struct merge_remote_desc
{
297 struct object
*obj
; /* the named object, could be a tag */
300 #define merge_remote_util(commit) ((struct merge_remote_desc *)((commit)->util))
303 * Given "name" from the command line to merge, find the commit object
304 * and return it, while storing merge_remote_desc in its ->util field,
305 * to allow callers to tell if we are told to merge a tag.
307 struct commit
*get_merge_parent(const char *name
);
309 extern int parse_signed_commit(const unsigned char *sha1
,
310 struct strbuf
*message
, struct strbuf
*signature
);
311 extern void print_commit_list(struct commit_list
*list
,
312 const char *format_cur
,
313 const char *format_last
);
316 * Check the signature of the given commit. The result of the check is stored
317 * in sig->check_result, 'G' for a good signature, 'U' for a good signature
318 * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
319 * at all. This may allocate memory for sig->gpg_output, sig->gpg_status,
320 * sig->signer and sig->key.
322 extern void check_commit_signature(const struct commit
* commit
, struct signature_check
*sigc
);
324 int compare_commits_by_commit_date(const void *a_
, const void *b_
, void *unused
);
326 LAST_ARG_MUST_BE_NULL
327 extern int run_commit_hook(int editor_is_used
, const char *index_file
, const char *name
, ...);
329 #endif /* COMMIT_H */