1#ifndef COMMIT_H
2#define COMMIT_H
3
4#include "object.h"
5#include "tree.h"
6#include "strbuf.h"
7#include "decorate.h"
8#include "gpg-interface.h"
9#include "string-list.h"
10
11struct commit_list {
12 struct commit *item;
13 struct commit_list *next;
14};
15
16struct commit {
17 struct object object;
18 void *util;
19 unsigned int index;
20 unsigned long date;
21 struct commit_list *parents;
22 struct tree *tree;
23};
24
25extern int save_commit_buffer;
26extern const char *commit_type;
27
28/* While we can decorate any object with a name, it's only used for commits.. */
29struct name_decoration {
30 struct name_decoration *next;
31 int type;
32 char name[FLEX_ARRAY];
33};
34
35enum decoration_type {
36 DECORATION_NONE = 0,
37 DECORATION_REF_LOCAL,
38 DECORATION_REF_REMOTE,
39 DECORATION_REF_TAG,
40 DECORATION_REF_STASH,
41 DECORATION_REF_HEAD,
42 DECORATION_GRAFTED,
43};
44
45void add_name_decoration(enum decoration_type type, const char *name, struct object *obj);
46const struct name_decoration *get_name_decoration(const struct object *obj);
47
48struct commit *lookup_commit(const unsigned char *sha1);
49struct commit *lookup_commit_reference(const unsigned char *sha1);
50struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
51 int quiet);
52struct commit *lookup_commit_reference_by_name(const char *name);
53
54/*
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.
58 */
59struct commit *lookup_commit_or_die(const unsigned char *sha1, const char *ref_name);
60
61int parse_commit_buffer(struct commit *item, const void *buffer, unsigned long size);
62int parse_commit_gently(struct commit *item, int quiet_on_missing);
63static inline int parse_commit(struct commit *item)
64{
65 return parse_commit_gently(item, 0);
66}
67void parse_commit_or_die(struct commit *item);
68
69/*
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.
72 */
73void set_commit_buffer(struct commit *, void *buffer, unsigned long size);
74
75/*
76 * Get any cached object buffer associated with the commit. Returns NULL
77 * if none. The resulting memory should not be freed.
78 */
79const void *get_cached_commit_buffer(const struct commit *, unsigned long *size);
80
81/*
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.
85 */
86const void *get_commit_buffer(const struct commit *, unsigned long *size);
87
88/*
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.
93 */
94void unuse_commit_buffer(const struct commit *, const void *buffer);
95
96/*
97 * Free any cached object buffer associated with the commit.
98 */
99void free_commit_buffer(struct commit *);
100
101/*
102 * Disassociate any cached object buffer from the commit, but do not free it.
103 * The buffer (or NULL, if none) is returned.
104 */
105const void *detach_commit_buffer(struct commit *, unsigned long *sizep);
106
107/* Find beginning and length of commit subject. */
108int find_commit_subject(const char *commit_buffer, const char **subject);
109
110struct commit_list *commit_list_insert(struct commit *item,
111 struct commit_list **list);
112struct commit_list **commit_list_append(struct commit *commit,
113 struct commit_list **next);
114unsigned commit_list_count(const struct commit_list *l);
115struct commit_list *commit_list_insert_by_date(struct commit *item,
116 struct commit_list **list);
117void commit_list_sort_by_date(struct commit_list **list);
118
119/* Shallow copy of the input list */
120struct commit_list *copy_commit_list(struct commit_list *list);
121
122void free_commit_list(struct commit_list *list);
123
124/* Commit formats */
125enum cmit_fmt {
126 CMIT_FMT_RAW,
127 CMIT_FMT_MEDIUM,
128 CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
129 CMIT_FMT_SHORT,
130 CMIT_FMT_FULL,
131 CMIT_FMT_FULLER,
132 CMIT_FMT_ONELINE,
133 CMIT_FMT_EMAIL,
134 CMIT_FMT_USERFORMAT,
135
136 CMIT_FMT_UNSPECIFIED
137};
138
139struct pretty_print_context {
140 /*
141 * Callers should tweak these to change the behavior of pp_* functions.
142 */
143 enum cmit_fmt fmt;
144 int abbrev;
145 const char *subject;
146 const char *after_subject;
147 int preserve_subject;
148 struct date_mode date_mode;
149 unsigned date_mode_explicit:1;
150 int expand_tabs_in_log;
151 int need_8bit_cte;
152 char *notes_message;
153 struct reflog_walk_info *reflog_info;
154 const char *output_encoding;
155 struct string_list *mailmap;
156 int color;
157 struct ident_split *from_ident;
158
159 /*
160 * Fields below here are manipulated internally by pp_* functions and
161 * should not be counted on by callers.
162 */
163 struct string_list in_body_headers;
164 int graph_width;
165};
166
167struct userformat_want {
168 unsigned notes:1;
169};
170
171extern int has_non_ascii(const char *text);
172struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
173extern const char *logmsg_reencode(const struct commit *commit,
174 char **commit_encoding,
175 const char *output_encoding);
176extern void get_commit_format(const char *arg, struct rev_info *);
177extern const char *format_subject(struct strbuf *sb, const char *msg,
178 const char *line_separator);
179extern void userformat_find_requirements(const char *fmt, struct userformat_want *w);
180extern int commit_format_is_empty(enum cmit_fmt);
181extern void format_commit_message(const struct commit *commit,
182 const char *format, struct strbuf *sb,
183 const struct pretty_print_context *context);
184extern void pretty_print_commit(struct pretty_print_context *pp,
185 const struct commit *commit,
186 struct strbuf *sb);
187extern void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
188 struct strbuf *sb);
189void pp_user_info(struct pretty_print_context *pp,
190 const char *what, struct strbuf *sb,
191 const char *line, const char *encoding);
192void pp_title_line(struct pretty_print_context *pp,
193 const char **msg_p,
194 struct strbuf *sb,
195 const char *encoding,
196 int need_8bit_cte);
197void pp_remainder(struct pretty_print_context *pp,
198 const char **msg_p,
199 struct strbuf *sb,
200 int indent);
201
202
203/** Removes the first commit from a list sorted by date, and adds all
204 * of its parents.
205 **/
206struct commit *pop_most_recent_commit(struct commit_list **list,
207 unsigned int mark);
208
209struct commit *pop_commit(struct commit_list **stack);
210
211void clear_commit_marks(struct commit *commit, unsigned int mark);
212void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark);
213void clear_commit_marks_for_object_array(struct object_array *a, unsigned mark);
214
215
216enum rev_sort_order {
217 REV_SORT_IN_GRAPH_ORDER = 0,
218 REV_SORT_BY_COMMIT_DATE,
219 REV_SORT_BY_AUTHOR_DATE
220};
221
222/*
223 * Performs an in-place topological sort of list supplied.
224 *
225 * invariant of resulting list is:
226 * a reachable from b => ord(b) < ord(a)
227 * sort_order further specifies:
228 * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
229 * chain together.
230 * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
231 */
232void sort_in_topological_order(struct commit_list **, enum rev_sort_order);
233
234struct commit_graft {
235 struct object_id oid;
236 int nr_parent; /* < 0 if shallow commit */
237 struct object_id parent[FLEX_ARRAY]; /* more */
238};
239typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
240
241struct commit_graft *read_graft_line(char *buf, int len);
242int register_commit_graft(struct commit_graft *, int);
243struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
244
245extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2);
246extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos);
247extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
248
249/* To be used only when object flags after this call no longer matter */
250extern struct commit_list *get_merge_bases_many_dirty(struct commit *one, int n, struct commit **twos);
251
252/* largest positive number a signed 32-bit integer can contain */
253#define INFINITE_DEPTH 0x7fffffff
254
255struct sha1_array;
256struct ref;
257extern int register_shallow(const unsigned char *sha1);
258extern int unregister_shallow(const unsigned char *sha1);
259extern int for_each_commit_graft(each_commit_graft_fn, void *);
260extern int is_repository_shallow(void);
261extern struct commit_list *get_shallow_commits(struct object_array *heads,
262 int depth, int shallow_flag, int not_shallow_flag);
263extern void set_alternate_shallow_file(const char *path, int override);
264extern int write_shallow_commits(struct strbuf *out, int use_pack_protocol,
265 const struct sha1_array *extra);
266extern void setup_alternate_shallow(struct lock_file *shallow_lock,
267 const char **alternate_shallow_file,
268 const struct sha1_array *extra);
269extern const char *setup_temporary_shallow(const struct sha1_array *extra);
270extern void advertise_shallow_grafts(int);
271
272struct shallow_info {
273 struct sha1_array *shallow;
274 int *ours, nr_ours;
275 int *theirs, nr_theirs;
276 struct sha1_array *ref;
277
278 /* for receive-pack */
279 uint32_t **used_shallow;
280 int *need_reachability_test;
281 int *reachable;
282 int *shallow_ref;
283 struct commit **commits;
284 int nr_commits;
285};
286
287extern void prepare_shallow_info(struct shallow_info *, struct sha1_array *);
288extern void clear_shallow_info(struct shallow_info *);
289extern void remove_nonexistent_theirs_shallow(struct shallow_info *);
290extern void assign_shallow_commits_to_refs(struct shallow_info *info,
291 uint32_t **used,
292 int *ref_status);
293extern int delayed_reachability_test(struct shallow_info *si, int c);
294extern void prune_shallow(int show_only);
295extern struct trace_key trace_shallow;
296
297int is_descendant_of(struct commit *, struct commit_list *);
298int in_merge_bases(struct commit *, struct commit *);
299int in_merge_bases_many(struct commit *, int, struct commit **);
300
301extern int interactive_add(int argc, const char **argv, const char *prefix, int patch);
302extern int run_add_interactive(const char *revision, const char *patch_mode,
303 const struct pathspec *pathspec);
304
305static inline int single_parent(struct commit *commit)
306{
307 return commit->parents && !commit->parents->next;
308}
309
310struct commit_list *reduce_heads(struct commit_list *heads);
311
312struct commit_extra_header {
313 struct commit_extra_header *next;
314 char *key;
315 char *value;
316 size_t len;
317};
318
319extern void append_merge_tag_headers(struct commit_list *parents,
320 struct commit_extra_header ***tail);
321
322extern int commit_tree(const char *msg, size_t msg_len,
323 const unsigned char *tree,
324 struct commit_list *parents, unsigned char *ret,
325 const char *author, const char *sign_commit);
326
327extern int commit_tree_extended(const char *msg, size_t msg_len,
328 const unsigned char *tree,
329 struct commit_list *parents, unsigned char *ret,
330 const char *author, const char *sign_commit,
331 struct commit_extra_header *);
332
333extern struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
334
335extern void free_commit_extra_headers(struct commit_extra_header *extra);
336
337/*
338 * Search the commit object contents given by "msg" for the header "key".
339 * Returns a pointer to the start of the header contents, or NULL. The length
340 * of the header, up to the first newline, is returned via out_len.
341 *
342 * Note that some headers (like mergetag) may be multi-line. It is the caller's
343 * responsibility to parse further in this case!
344 */
345extern const char *find_commit_header(const char *msg, const char *key,
346 size_t *out_len);
347
348/* Find the end of the log message, the right place for a new trailer. */
349extern int ignore_non_trailer(struct strbuf *sb);
350
351typedef void (*each_mergetag_fn)(struct commit *commit, struct commit_extra_header *extra,
352 void *cb_data);
353
354extern void for_each_mergetag(each_mergetag_fn fn, struct commit *commit, void *data);
355
356struct merge_remote_desc {
357 struct object *obj; /* the named object, could be a tag */
358 const char *name;
359};
360#define merge_remote_util(commit) ((struct merge_remote_desc *)((commit)->util))
361
362/*
363 * Given "name" from the command line to merge, find the commit object
364 * and return it, while storing merge_remote_desc in its ->util field,
365 * to allow callers to tell if we are told to merge a tag.
366 */
367struct commit *get_merge_parent(const char *name);
368
369extern int parse_signed_commit(const struct commit *commit,
370 struct strbuf *message, struct strbuf *signature);
371extern int remove_signature(struct strbuf *buf);
372
373extern void print_commit_list(struct commit_list *list,
374 const char *format_cur,
375 const char *format_last);
376
377/*
378 * Check the signature of the given commit. The result of the check is stored
379 * in sig->check_result, 'G' for a good signature, 'U' for a good signature
380 * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
381 * at all. This may allocate memory for sig->gpg_output, sig->gpg_status,
382 * sig->signer and sig->key.
383 */
384extern int check_commit_signature(const struct commit *commit, struct signature_check *sigc);
385
386int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused);
387
388LAST_ARG_MUST_BE_NULL
389extern int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...);
390
391#endif /* COMMIT_H */