Merge branch 'rs/plug-leak-in-pack-bitmaps' into maint
[git.git] / commit.h
blob9f189cb054266cd8f8c084853afbb678ca56c9e9
1 #ifndef COMMIT_H
2 #define COMMIT_H
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"
11 struct commit_list {
12 struct commit *item;
13 struct commit_list *next;
16 struct 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;
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;
31 int type;
32 char name[FLEX_ARRAY];
35 enum 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,
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,
51 int quiet);
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(struct commit *item);
63 void parse_commit_or_die(struct commit *item);
66 * Associate an object buffer with the commit. The ownership of the
67 * memory is handed over to the commit, and must be free()-able.
69 void set_commit_buffer(struct commit *, void *buffer, unsigned long size);
72 * Get any cached object buffer associated with the commit. Returns NULL
73 * if none. The resulting memory should not be freed.
75 const void *get_cached_commit_buffer(const struct commit *, unsigned long *size);
78 * Get the commit's object contents, either from cache or by reading the object
79 * from disk. The resulting memory should not be modified, and must be given
80 * to unuse_commit_buffer when the caller is done.
82 const void *get_commit_buffer(const struct commit *, unsigned long *size);
85 * Tell the commit subsytem that we are done with a particular commit buffer.
86 * The commit and buffer should be the input and return value, respectively,
87 * from an earlier call to get_commit_buffer. The buffer may or may not be
88 * freed by this call; callers should not access the memory afterwards.
90 void unuse_commit_buffer(const struct commit *, const void *buffer);
93 * Free any cached object buffer associated with the commit.
95 void free_commit_buffer(struct commit *);
98 * Disassociate any cached object buffer from the commit, but do not free it.
99 * The buffer (or NULL, if none) is returned.
101 const void *detach_commit_buffer(struct commit *, unsigned long *sizep);
103 /* Find beginning and length of commit subject. */
104 int find_commit_subject(const char *commit_buffer, const char **subject);
106 struct commit_list *commit_list_insert(struct commit *item,
107 struct commit_list **list);
108 struct commit_list **commit_list_append(struct commit *commit,
109 struct commit_list **next);
110 unsigned commit_list_count(const struct commit_list *l);
111 struct commit_list *commit_list_insert_by_date(struct commit *item,
112 struct commit_list **list);
113 void commit_list_sort_by_date(struct commit_list **list);
115 /* Shallow copy of the input list */
116 struct commit_list *copy_commit_list(struct commit_list *list);
118 void free_commit_list(struct commit_list *list);
120 /* Commit formats */
121 enum cmit_fmt {
122 CMIT_FMT_RAW,
123 CMIT_FMT_MEDIUM,
124 CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
125 CMIT_FMT_SHORT,
126 CMIT_FMT_FULL,
127 CMIT_FMT_FULLER,
128 CMIT_FMT_ONELINE,
129 CMIT_FMT_EMAIL,
130 CMIT_FMT_USERFORMAT,
132 CMIT_FMT_UNSPECIFIED
135 struct pretty_print_context {
137 * Callers should tweak these to change the behavior of pp_* functions.
139 enum cmit_fmt fmt;
140 int abbrev;
141 const char *subject;
142 const char *after_subject;
143 int preserve_subject;
144 enum date_mode date_mode;
145 unsigned date_mode_explicit:1;
146 int need_8bit_cte;
147 char *notes_message;
148 struct reflog_walk_info *reflog_info;
149 const char *output_encoding;
150 struct string_list *mailmap;
151 int color;
152 struct ident_split *from_ident;
155 * Fields below here are manipulated internally by pp_* functions and
156 * should not be counted on by callers.
158 struct string_list in_body_headers;
161 struct userformat_want {
162 unsigned notes:1;
165 extern int has_non_ascii(const char *text);
166 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
167 extern const char *logmsg_reencode(const struct commit *commit,
168 char **commit_encoding,
169 const char *output_encoding);
170 extern void get_commit_format(const char *arg, struct rev_info *);
171 extern const char *format_subject(struct strbuf *sb, const char *msg,
172 const char *line_separator);
173 extern void userformat_find_requirements(const char *fmt, struct userformat_want *w);
174 extern int commit_format_is_empty(enum cmit_fmt);
175 extern void format_commit_message(const struct commit *commit,
176 const char *format, struct strbuf *sb,
177 const struct pretty_print_context *context);
178 extern void pretty_print_commit(struct pretty_print_context *pp,
179 const struct commit *commit,
180 struct strbuf *sb);
181 extern void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
182 struct strbuf *sb);
183 void pp_user_info(struct pretty_print_context *pp,
184 const char *what, struct strbuf *sb,
185 const char *line, const char *encoding);
186 void pp_title_line(struct pretty_print_context *pp,
187 const char **msg_p,
188 struct strbuf *sb,
189 const char *encoding,
190 int need_8bit_cte);
191 void pp_remainder(struct pretty_print_context *pp,
192 const char **msg_p,
193 struct strbuf *sb,
194 int indent);
197 /** Removes the first commit from a list sorted by date, and adds all
198 * of its parents.
200 struct commit *pop_most_recent_commit(struct commit_list **list,
201 unsigned int mark);
203 struct commit *pop_commit(struct commit_list **stack);
205 void clear_commit_marks(struct commit *commit, unsigned int mark);
206 void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark);
207 void clear_commit_marks_for_object_array(struct object_array *a, unsigned mark);
210 enum rev_sort_order {
211 REV_SORT_IN_GRAPH_ORDER = 0,
212 REV_SORT_BY_COMMIT_DATE,
213 REV_SORT_BY_AUTHOR_DATE
217 * Performs an in-place topological sort of list supplied.
219 * invariant of resulting list is:
220 * a reachable from b => ord(b) < ord(a)
221 * sort_order further specifies:
222 * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
223 * chain together.
224 * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
226 void sort_in_topological_order(struct commit_list **, enum rev_sort_order);
228 struct commit_graft {
229 unsigned char sha1[20];
230 int nr_parent; /* < 0 if shallow commit */
231 unsigned char parent[FLEX_ARRAY][20]; /* more */
233 typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
235 struct commit_graft *read_graft_line(char *buf, int len);
236 int register_commit_graft(struct commit_graft *, int);
237 struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
239 extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2);
240 extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos);
241 extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
243 /* To be used only when object flags after this call no longer matter */
244 extern struct commit_list *get_merge_bases_many_dirty(struct commit *one, int n, struct commit **twos);
246 /* largest positive number a signed 32-bit integer can contain */
247 #define INFINITE_DEPTH 0x7fffffff
249 struct sha1_array;
250 struct ref;
251 extern int register_shallow(const unsigned char *sha1);
252 extern int unregister_shallow(const unsigned char *sha1);
253 extern int for_each_commit_graft(each_commit_graft_fn, void *);
254 extern int is_repository_shallow(void);
255 extern struct commit_list *get_shallow_commits(struct object_array *heads,
256 int depth, int shallow_flag, int not_shallow_flag);
257 extern void set_alternate_shallow_file(const char *path, int override);
258 extern int write_shallow_commits(struct strbuf *out, int use_pack_protocol,
259 const struct sha1_array *extra);
260 extern void setup_alternate_shallow(struct lock_file *shallow_lock,
261 const char **alternate_shallow_file,
262 const struct sha1_array *extra);
263 extern const char *setup_temporary_shallow(const struct sha1_array *extra);
264 extern void advertise_shallow_grafts(int);
266 struct shallow_info {
267 struct sha1_array *shallow;
268 int *ours, nr_ours;
269 int *theirs, nr_theirs;
270 struct sha1_array *ref;
272 /* for receive-pack */
273 uint32_t **used_shallow;
274 int *need_reachability_test;
275 int *reachable;
276 int *shallow_ref;
277 struct commit **commits;
278 int nr_commits;
281 extern void prepare_shallow_info(struct shallow_info *, struct sha1_array *);
282 extern void clear_shallow_info(struct shallow_info *);
283 extern void remove_nonexistent_theirs_shallow(struct shallow_info *);
284 extern void assign_shallow_commits_to_refs(struct shallow_info *info,
285 uint32_t **used,
286 int *ref_status);
287 extern int delayed_reachability_test(struct shallow_info *si, int c);
288 extern void prune_shallow(int show_only);
289 extern struct trace_key trace_shallow;
291 int is_descendant_of(struct commit *, struct commit_list *);
292 int in_merge_bases(struct commit *, struct commit *);
293 int in_merge_bases_many(struct commit *, int, struct commit **);
295 extern int interactive_add(int argc, const char **argv, const char *prefix, int patch);
296 extern int run_add_interactive(const char *revision, const char *patch_mode,
297 const struct pathspec *pathspec);
299 static inline int single_parent(struct commit *commit)
301 return commit->parents && !commit->parents->next;
304 struct commit_list *reduce_heads(struct commit_list *heads);
306 struct commit_extra_header {
307 struct commit_extra_header *next;
308 char *key;
309 char *value;
310 size_t len;
313 extern void append_merge_tag_headers(struct commit_list *parents,
314 struct commit_extra_header ***tail);
316 extern int commit_tree(const char *msg, size_t msg_len,
317 const unsigned char *tree,
318 struct commit_list *parents, unsigned char *ret,
319 const char *author, const char *sign_commit);
321 extern int commit_tree_extended(const char *msg, size_t msg_len,
322 const unsigned char *tree,
323 struct commit_list *parents, unsigned char *ret,
324 const char *author, const char *sign_commit,
325 struct commit_extra_header *);
327 extern struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
329 extern void free_commit_extra_headers(struct commit_extra_header *extra);
332 * Search the commit object contents given by "msg" for the header "key".
333 * Returns a pointer to the start of the header contents, or NULL. The length
334 * of the header, up to the first newline, is returned via out_len.
336 * Note that some headers (like mergetag) may be multi-line. It is the caller's
337 * responsibility to parse further in this case!
339 extern const char *find_commit_header(const char *msg, const char *key,
340 size_t *out_len);
342 /* Find the end of the log message, the right place for a new trailer. */
343 extern int ignore_non_trailer(struct strbuf *sb);
345 typedef void (*each_mergetag_fn)(struct commit *commit, struct commit_extra_header *extra,
346 void *cb_data);
348 extern void for_each_mergetag(each_mergetag_fn fn, struct commit *commit, void *data);
350 struct merge_remote_desc {
351 struct object *obj; /* the named object, could be a tag */
352 const char *name;
354 #define merge_remote_util(commit) ((struct merge_remote_desc *)((commit)->util))
357 * Given "name" from the command line to merge, find the commit object
358 * and return it, while storing merge_remote_desc in its ->util field,
359 * to allow callers to tell if we are told to merge a tag.
361 struct commit *get_merge_parent(const char *name);
363 extern int parse_signed_commit(const struct commit *commit,
364 struct strbuf *message, struct strbuf *signature);
365 extern int remove_signature(struct strbuf *buf);
367 extern void print_commit_list(struct commit_list *list,
368 const char *format_cur,
369 const char *format_last);
372 * Check the signature of the given commit. The result of the check is stored
373 * in sig->check_result, 'G' for a good signature, 'U' for a good signature
374 * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
375 * at all. This may allocate memory for sig->gpg_output, sig->gpg_status,
376 * sig->signer and sig->key.
378 extern void check_commit_signature(const struct commit *commit, struct signature_check *sigc);
380 int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused);
382 LAST_ARG_MUST_BE_NULL
383 extern int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...);
385 #endif /* COMMIT_H */