8 #include "gpg-interface.h"
9 #include "string-list.h"
13 struct commit_list
*next
;
21 struct commit_list
*parents
;
25 extern int save_commit_buffer
;
26 extern const char *commit_type
;
28 /* While we can decorate any object with a name, it's only used for commits.. */
29 struct name_decoration
{
30 struct name_decoration
*next
;
32 char name
[FLEX_ARRAY
];
35 enum decoration_type
{
38 DECORATION_REF_REMOTE
,
45 void add_name_decoration(enum decoration_type type
, const char *name
, struct object
*obj
);
46 const struct name_decoration
*get_name_decoration(const struct object
*obj
);
48 struct commit
*lookup_commit(const unsigned char *sha1
);
49 struct commit
*lookup_commit_reference(const unsigned char *sha1
);
50 struct commit
*lookup_commit_reference_gently(const unsigned char *sha1
,
52 struct commit
*lookup_commit_reference_by_name(const char *name
);
55 * Look up object named by "sha1", dereference tag as necessary,
56 * get a commit and return it. If "sha1" does not dereference to
57 * a commit, use ref_name to report an error and die.
59 struct commit
*lookup_commit_or_die(const unsigned char *sha1
, const char *ref_name
);
61 int parse_commit_buffer(struct commit
*item
, const void *buffer
, unsigned long size
);
62 int parse_commit_gently(struct commit
*item
, int quiet_on_missing
);
63 static inline int parse_commit(struct commit
*item
)
65 return parse_commit_gently(item
, 0);
67 void parse_commit_or_die(struct commit
*item
);
70 * Associate an object buffer with the commit. The ownership of the
71 * memory is handed over to the commit, and must be free()-able.
73 void set_commit_buffer(struct commit
*, void *buffer
, unsigned long size
);
76 * Get any cached object buffer associated with the commit. Returns NULL
77 * if none. The resulting memory should not be freed.
79 const void *get_cached_commit_buffer(const struct commit
*, unsigned long *size
);
82 * Get the commit's object contents, either from cache or by reading the object
83 * from disk. The resulting memory should not be modified, and must be given
84 * to unuse_commit_buffer when the caller is done.
86 const void *get_commit_buffer(const struct commit
*, unsigned long *size
);
89 * Tell the commit subsytem that we are done with a particular commit buffer.
90 * The commit and buffer should be the input and return value, respectively,
91 * from an earlier call to get_commit_buffer. The buffer may or may not be
92 * freed by this call; callers should not access the memory afterwards.
94 void unuse_commit_buffer(const struct commit
*, const void *buffer
);
97 * Free any cached object buffer associated with the commit.
99 void free_commit_buffer(struct commit
*);
102 * Disassociate any cached object buffer from the commit, but do not free it.
103 * The buffer (or NULL, if none) is returned.
105 const void *detach_commit_buffer(struct commit
*, unsigned long *sizep
);
107 /* Find beginning and length of commit subject. */
108 int find_commit_subject(const char *commit_buffer
, const char **subject
);
110 struct commit_list
*commit_list_insert(struct commit
*item
,
111 struct commit_list
**list
);
112 struct commit_list
**commit_list_append(struct commit
*commit
,
113 struct commit_list
**next
);
114 unsigned commit_list_count(const struct commit_list
*l
);
115 struct commit_list
*commit_list_insert_by_date(struct commit
*item
,
116 struct commit_list
**list
);
117 void commit_list_sort_by_date(struct commit_list
**list
);
119 /* Shallow copy of the input list */
120 struct commit_list
*copy_commit_list(struct commit_list
*list
);
122 void free_commit_list(struct commit_list
*list
);
128 CMIT_FMT_DEFAULT
= CMIT_FMT_MEDIUM
,
140 static inline int cmit_fmt_is_mail(enum cmit_fmt fmt
)
142 return (fmt
== CMIT_FMT_EMAIL
|| fmt
== CMIT_FMT_MBOXRD
);
145 struct pretty_print_context
{
147 * Callers should tweak these to change the behavior of pp_* functions.
152 const char *after_subject
;
153 int preserve_subject
;
154 struct date_mode date_mode
;
155 unsigned date_mode_explicit
:1;
156 int expand_tabs_in_log
;
159 struct reflog_walk_info
*reflog_info
;
160 const char *output_encoding
;
161 struct string_list
*mailmap
;
163 struct ident_split
*from_ident
;
166 * Fields below here are manipulated internally by pp_* functions and
167 * should not be counted on by callers.
169 struct string_list in_body_headers
;
173 struct userformat_want
{
177 extern int has_non_ascii(const char *text
);
178 struct rev_info
; /* in revision.h, it circularly uses enum cmit_fmt */
179 extern const char *logmsg_reencode(const struct commit
*commit
,
180 char **commit_encoding
,
181 const char *output_encoding
);
182 extern void get_commit_format(const char *arg
, struct rev_info
*);
183 extern const char *format_subject(struct strbuf
*sb
, const char *msg
,
184 const char *line_separator
);
185 extern void userformat_find_requirements(const char *fmt
, struct userformat_want
*w
);
186 extern int commit_format_is_empty(enum cmit_fmt
);
187 extern void format_commit_message(const struct commit
*commit
,
188 const char *format
, struct strbuf
*sb
,
189 const struct pretty_print_context
*context
);
190 extern void pretty_print_commit(struct pretty_print_context
*pp
,
191 const struct commit
*commit
,
193 extern void pp_commit_easy(enum cmit_fmt fmt
, const struct commit
*commit
,
195 void pp_user_info(struct pretty_print_context
*pp
,
196 const char *what
, struct strbuf
*sb
,
197 const char *line
, const char *encoding
);
198 void pp_title_line(struct pretty_print_context
*pp
,
201 const char *encoding
,
203 void pp_remainder(struct pretty_print_context
*pp
,
209 /** Removes the first commit from a list sorted by date, and adds all
212 struct commit
*pop_most_recent_commit(struct commit_list
**list
,
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
);
219 void clear_commit_marks_for_object_array(struct object_array
*a
, unsigned mark
);
222 enum rev_sort_order
{
223 REV_SORT_IN_GRAPH_ORDER
= 0,
224 REV_SORT_BY_COMMIT_DATE
,
225 REV_SORT_BY_AUTHOR_DATE
229 * Performs an in-place topological sort of list supplied.
231 * invariant of resulting list is:
232 * a reachable from b => ord(b) < ord(a)
233 * sort_order further specifies:
234 * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
236 * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
238 void sort_in_topological_order(struct commit_list
**, enum rev_sort_order
);
240 struct commit_graft
{
241 struct object_id oid
;
242 int nr_parent
; /* < 0 if shallow commit */
243 struct object_id parent
[FLEX_ARRAY
]; /* more */
245 typedef int (*each_commit_graft_fn
)(const struct commit_graft
*, void *);
247 struct commit_graft
*read_graft_line(char *buf
, int len
);
248 int register_commit_graft(struct commit_graft
*, int);
249 struct commit_graft
*lookup_commit_graft(const unsigned char *sha1
);
251 extern struct commit_list
*get_merge_bases(struct commit
*rev1
, struct commit
*rev2
);
252 extern struct commit_list
*get_merge_bases_many(struct commit
*one
, int n
, struct commit
**twos
);
253 extern struct commit_list
*get_octopus_merge_bases(struct commit_list
*in
);
255 /* To be used only when object flags after this call no longer matter */
256 extern struct commit_list
*get_merge_bases_many_dirty(struct commit
*one
, int n
, struct commit
**twos
);
258 /* largest positive number a signed 32-bit integer can contain */
259 #define INFINITE_DEPTH 0x7fffffff
263 extern int register_shallow(const unsigned char *sha1
);
264 extern int unregister_shallow(const unsigned char *sha1
);
265 extern int for_each_commit_graft(each_commit_graft_fn
, void *);
266 extern int is_repository_shallow(void);
267 extern struct commit_list
*get_shallow_commits(struct object_array
*heads
,
268 int depth
, int shallow_flag
, int not_shallow_flag
);
269 extern void set_alternate_shallow_file(const char *path
, int override
);
270 extern int write_shallow_commits(struct strbuf
*out
, int use_pack_protocol
,
271 const struct sha1_array
*extra
);
272 extern void setup_alternate_shallow(struct lock_file
*shallow_lock
,
273 const char **alternate_shallow_file
,
274 const struct sha1_array
*extra
);
275 extern const char *setup_temporary_shallow(const struct sha1_array
*extra
);
276 extern void advertise_shallow_grafts(int);
278 struct shallow_info
{
279 struct sha1_array
*shallow
;
281 int *theirs
, nr_theirs
;
282 struct sha1_array
*ref
;
284 /* for receive-pack */
285 uint32_t **used_shallow
;
286 int *need_reachability_test
;
289 struct commit
**commits
;
293 extern void prepare_shallow_info(struct shallow_info
*, struct sha1_array
*);
294 extern void clear_shallow_info(struct shallow_info
*);
295 extern void remove_nonexistent_theirs_shallow(struct shallow_info
*);
296 extern void assign_shallow_commits_to_refs(struct shallow_info
*info
,
299 extern int delayed_reachability_test(struct shallow_info
*si
, int c
);
300 extern void prune_shallow(int show_only
);
301 extern struct trace_key trace_shallow
;
303 int is_descendant_of(struct commit
*, struct commit_list
*);
304 int in_merge_bases(struct commit
*, struct commit
*);
305 int in_merge_bases_many(struct commit
*, int, struct commit
**);
307 extern int interactive_add(int argc
, const char **argv
, const char *prefix
, int patch
);
308 extern int run_add_interactive(const char *revision
, const char *patch_mode
,
309 const struct pathspec
*pathspec
);
311 static inline int single_parent(struct commit
*commit
)
313 return commit
->parents
&& !commit
->parents
->next
;
316 struct commit_list
*reduce_heads(struct commit_list
*heads
);
318 struct commit_extra_header
{
319 struct commit_extra_header
*next
;
325 extern void append_merge_tag_headers(struct commit_list
*parents
,
326 struct commit_extra_header
***tail
);
328 extern int commit_tree(const char *msg
, size_t msg_len
,
329 const unsigned char *tree
,
330 struct commit_list
*parents
, unsigned char *ret
,
331 const char *author
, const char *sign_commit
);
333 extern int commit_tree_extended(const char *msg
, size_t msg_len
,
334 const unsigned char *tree
,
335 struct commit_list
*parents
, unsigned char *ret
,
336 const char *author
, const char *sign_commit
,
337 struct commit_extra_header
*);
339 extern struct commit_extra_header
*read_commit_extra_headers(struct commit
*, const char **);
341 extern void free_commit_extra_headers(struct commit_extra_header
*extra
);
344 * Search the commit object contents given by "msg" for the header "key".
345 * Returns a pointer to the start of the header contents, or NULL. The length
346 * of the header, up to the first newline, is returned via out_len.
348 * Note that some headers (like mergetag) may be multi-line. It is the caller's
349 * responsibility to parse further in this case!
351 extern const char *find_commit_header(const char *msg
, const char *key
,
354 /* Find the end of the log message, the right place for a new trailer. */
355 extern int ignore_non_trailer(struct strbuf
*sb
);
357 typedef void (*each_mergetag_fn
)(struct commit
*commit
, struct commit_extra_header
*extra
,
360 extern void for_each_mergetag(each_mergetag_fn fn
, struct commit
*commit
, void *data
);
362 struct merge_remote_desc
{
363 struct object
*obj
; /* the named object, could be a tag */
366 #define merge_remote_util(commit) ((struct merge_remote_desc *)((commit)->util))
369 * Given "name" from the command line to merge, find the commit object
370 * and return it, while storing merge_remote_desc in its ->util field,
371 * to allow callers to tell if we are told to merge a tag.
373 struct commit
*get_merge_parent(const char *name
);
375 extern int parse_signed_commit(const struct commit
*commit
,
376 struct strbuf
*message
, struct strbuf
*signature
);
377 extern int remove_signature(struct strbuf
*buf
);
379 extern void print_commit_list(struct commit_list
*list
,
380 const char *format_cur
,
381 const char *format_last
);
384 * Check the signature of the given commit. The result of the check is stored
385 * in sig->check_result, 'G' for a good signature, 'U' for a good signature
386 * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
387 * at all. This may allocate memory for sig->gpg_output, sig->gpg_status,
388 * sig->signer and sig->key.
390 extern int check_commit_signature(const struct commit
*commit
, struct signature_check
*sigc
);
392 int compare_commits_by_commit_date(const void *a_
, const void *b_
, void *unused
);
394 LAST_ARG_MUST_BE_NULL
395 extern int run_commit_hook(int editor_is_used
, const char *index_file
, const char *name
, ...);
397 #endif /* COMMIT_H */