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 struct name_decoration
{
31 struct name_decoration
*next
;
33 char name
[FLEX_ARRAY
];
36 enum decoration_type
{
39 DECORATION_REF_REMOTE
,
46 void add_name_decoration(enum decoration_type type
, const char *name
, struct object
*obj
);
47 const struct name_decoration
*get_name_decoration(const struct object
*obj
);
49 struct commit
*lookup_commit(const unsigned char *sha1
);
50 struct commit
*lookup_commit_reference(const unsigned char *sha1
);
51 struct commit
*lookup_commit_reference_gently(const unsigned char *sha1
,
53 struct commit
*lookup_commit_reference_by_name(const char *name
);
56 * Look up object named by "sha1", dereference tag as necessary,
57 * get a commit and return it. If "sha1" does not dereference to
58 * a commit, use ref_name to report an error and die.
60 struct commit
*lookup_commit_or_die(const unsigned char *sha1
, const char *ref_name
);
62 int parse_commit_buffer(struct commit
*item
, const void *buffer
, unsigned long size
);
63 int parse_commit(struct commit
*item
);
64 void parse_commit_or_die(struct commit
*item
);
66 /* Find beginning and length of commit subject. */
67 int find_commit_subject(const char *commit_buffer
, const char **subject
);
69 struct commit_list
*commit_list_insert(struct commit
*item
,
70 struct commit_list
**list
);
71 struct commit_list
**commit_list_append(struct commit
*commit
,
72 struct commit_list
**next
);
73 unsigned commit_list_count(const struct commit_list
*l
);
74 struct commit_list
*commit_list_insert_by_date(struct commit
*item
,
75 struct commit_list
**list
);
76 void commit_list_sort_by_date(struct commit_list
**list
);
78 /* Shallow copy of the input list */
79 struct commit_list
*copy_commit_list(struct commit_list
*list
);
81 void free_commit_list(struct commit_list
*list
);
87 CMIT_FMT_DEFAULT
= CMIT_FMT_MEDIUM
,
98 struct pretty_print_context
{
100 * Callers should tweak these to change the behavior of pp_* functions.
105 const char *after_subject
;
106 int preserve_subject
;
107 enum date_mode date_mode
;
108 unsigned date_mode_explicit
:1;
111 struct reflog_walk_info
*reflog_info
;
112 const char *output_encoding
;
113 struct string_list
*mailmap
;
115 struct ident_split
*from_ident
;
118 * Fields below here are manipulated internally by pp_* functions and
119 * should not be counted on by callers.
121 struct string_list in_body_headers
;
124 struct userformat_want
{
128 extern int has_non_ascii(const char *text
);
129 struct rev_info
; /* in revision.h, it circularly uses enum cmit_fmt */
130 extern char *logmsg_reencode(const struct commit
*commit
,
131 char **commit_encoding
,
132 const char *output_encoding
);
133 extern void logmsg_free(char *msg
, const struct commit
*commit
);
134 extern void get_commit_format(const char *arg
, struct rev_info
*);
135 extern const char *format_subject(struct strbuf
*sb
, const char *msg
,
136 const char *line_separator
);
137 extern void userformat_find_requirements(const char *fmt
, struct userformat_want
*w
);
138 extern void format_commit_message(const struct commit
*commit
,
139 const char *format
, struct strbuf
*sb
,
140 const struct pretty_print_context
*context
);
141 extern void pretty_print_commit(struct pretty_print_context
*pp
,
142 const struct commit
*commit
,
144 extern void pp_commit_easy(enum cmit_fmt fmt
, const struct commit
*commit
,
146 void pp_user_info(struct pretty_print_context
*pp
,
147 const char *what
, struct strbuf
*sb
,
148 const char *line
, const char *encoding
);
149 void pp_title_line(struct pretty_print_context
*pp
,
152 const char *encoding
,
154 void pp_remainder(struct pretty_print_context
*pp
,
160 /** Removes the first commit from a list sorted by date, and adds all
163 struct commit
*pop_most_recent_commit(struct commit_list
**list
,
166 struct commit
*pop_commit(struct commit_list
**stack
);
168 void clear_commit_marks(struct commit
*commit
, unsigned int mark
);
169 void clear_commit_marks_many(int nr
, struct commit
**commit
, unsigned int mark
);
170 void clear_commit_marks_for_object_array(struct object_array
*a
, unsigned mark
);
173 enum rev_sort_order
{
174 REV_SORT_IN_GRAPH_ORDER
= 0,
175 REV_SORT_BY_COMMIT_DATE
,
176 REV_SORT_BY_AUTHOR_DATE
180 * Performs an in-place topological sort of list supplied.
182 * invariant of resulting list is:
183 * a reachable from b => ord(b) < ord(a)
184 * sort_order further specifies:
185 * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
187 * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
189 void sort_in_topological_order(struct commit_list
**, enum rev_sort_order
);
191 struct commit_graft
{
192 unsigned char sha1
[20];
193 int nr_parent
; /* < 0 if shallow commit */
194 unsigned char parent
[FLEX_ARRAY
][20]; /* more */
196 typedef int (*each_commit_graft_fn
)(const struct commit_graft
*, void *);
198 struct commit_graft
*read_graft_line(char *buf
, int len
);
199 int register_commit_graft(struct commit_graft
*, int);
200 struct commit_graft
*lookup_commit_graft(const unsigned char *sha1
);
202 extern struct commit_list
*get_merge_bases(struct commit
*rev1
, struct commit
*rev2
, int cleanup
);
203 extern struct commit_list
*get_merge_bases_many(struct commit
*one
, int n
, struct commit
**twos
, int cleanup
);
204 extern struct commit_list
*get_octopus_merge_bases(struct commit_list
*in
);
206 /* largest positive number a signed 32-bit integer can contain */
207 #define INFINITE_DEPTH 0x7fffffff
211 extern int register_shallow(const unsigned char *sha1
);
212 extern int unregister_shallow(const unsigned char *sha1
);
213 extern int for_each_commit_graft(each_commit_graft_fn
, void *);
214 extern int is_repository_shallow(void);
215 extern struct commit_list
*get_shallow_commits(struct object_array
*heads
,
216 int depth
, int shallow_flag
, int not_shallow_flag
);
217 extern void check_shallow_file_for_update(void);
218 extern void set_alternate_shallow_file(const char *path
, int override
);
219 extern int write_shallow_commits(struct strbuf
*out
, int use_pack_protocol
,
220 const struct sha1_array
*extra
);
221 extern void setup_alternate_shallow(struct lock_file
*shallow_lock
,
222 const char **alternate_shallow_file
,
223 const struct sha1_array
*extra
);
224 extern const char *setup_temporary_shallow(const struct sha1_array
*extra
);
225 extern void advertise_shallow_grafts(int);
227 struct shallow_info
{
228 struct sha1_array
*shallow
;
230 int *theirs
, nr_theirs
;
231 struct sha1_array
*ref
;
233 /* for receive-pack */
234 uint32_t **used_shallow
;
235 int *need_reachability_test
;
238 struct commit
**commits
;
242 extern void prepare_shallow_info(struct shallow_info
*, struct sha1_array
*);
243 extern void clear_shallow_info(struct shallow_info
*);
244 extern void remove_nonexistent_theirs_shallow(struct shallow_info
*);
245 extern void assign_shallow_commits_to_refs(struct shallow_info
*info
,
248 extern int delayed_reachability_test(struct shallow_info
*si
, int c
);
249 extern void prune_shallow(int show_only
);
251 int is_descendant_of(struct commit
*, struct commit_list
*);
252 int in_merge_bases(struct commit
*, struct commit
*);
253 int in_merge_bases_many(struct commit
*, int, struct commit
**);
255 extern int interactive_add(int argc
, const char **argv
, const char *prefix
, int patch
);
256 extern int run_add_interactive(const char *revision
, const char *patch_mode
,
257 const struct pathspec
*pathspec
);
259 static inline int single_parent(struct commit
*commit
)
261 return commit
->parents
&& !commit
->parents
->next
;
264 struct commit_list
*reduce_heads(struct commit_list
*heads
);
266 struct commit_extra_header
{
267 struct commit_extra_header
*next
;
273 extern void append_merge_tag_headers(struct commit_list
*parents
,
274 struct commit_extra_header
***tail
);
276 extern int commit_tree(const struct strbuf
*msg
, const unsigned char *tree
,
277 struct commit_list
*parents
, unsigned char *ret
,
278 const char *author
, const char *sign_commit
);
280 extern int commit_tree_extended(const struct strbuf
*msg
, const unsigned char *tree
,
281 struct commit_list
*parents
, unsigned char *ret
,
282 const char *author
, const char *sign_commit
,
283 struct commit_extra_header
*);
285 extern struct commit_extra_header
*read_commit_extra_headers(struct commit
*, const char **);
287 extern void free_commit_extra_headers(struct commit_extra_header
*extra
);
289 struct merge_remote_desc
{
290 struct object
*obj
; /* the named object, could be a tag */
293 #define merge_remote_util(commit) ((struct merge_remote_desc *)((commit)->util))
296 * Given "name" from the command line to merge, find the commit object
297 * and return it, while storing merge_remote_desc in its ->util field,
298 * to allow callers to tell if we are told to merge a tag.
300 struct commit
*get_merge_parent(const char *name
);
302 extern int parse_signed_commit(const unsigned char *sha1
,
303 struct strbuf
*message
, struct strbuf
*signature
);
304 extern void print_commit_list(struct commit_list
*list
,
305 const char *format_cur
,
306 const char *format_last
);
309 * Check the signature of the given commit. The result of the check is stored
310 * in sig->check_result, 'G' for a good signature, 'U' for a good signature
311 * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
312 * at all. This may allocate memory for sig->gpg_output, sig->gpg_status,
313 * sig->signer and sig->key.
315 extern void check_commit_signature(const struct commit
* commit
, struct signature_check
*sigc
);
317 int compare_commits_by_commit_date(const void *a_
, const void *b_
, void *unused
);
319 LAST_ARG_MUST_BE_NULL
320 extern int run_commit_hook(int editor_is_used
, const char *index_file
, const char *name
, ...);
322 #endif /* COMMIT_H */