git-multimail: update to release 1.2.0
[git.git] / commit.h
blob5d58be0017a8eb26cd3f58c1e3b0b610f684beba
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_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);
124 /* Commit formats */
125 enum 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,
136 CMIT_FMT_UNSPECIFIED
139 struct pretty_print_context {
141 * Callers should tweak these to change the behavior of pp_* functions.
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 need_8bit_cte;
151 char *notes_message;
152 struct reflog_walk_info *reflog_info;
153 const char *output_encoding;
154 struct string_list *mailmap;
155 int color;
156 struct ident_split *from_ident;
159 * Fields below here are manipulated internally by pp_* functions and
160 * should not be counted on by callers.
162 struct string_list in_body_headers;
165 struct userformat_want {
166 unsigned notes:1;
169 extern int has_non_ascii(const char *text);
170 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
171 extern const char *logmsg_reencode(const struct commit *commit,
172 char **commit_encoding,
173 const char *output_encoding);
174 extern void get_commit_format(const char *arg, struct rev_info *);
175 extern const char *format_subject(struct strbuf *sb, const char *msg,
176 const char *line_separator);
177 extern void userformat_find_requirements(const char *fmt, struct userformat_want *w);
178 extern int commit_format_is_empty(enum cmit_fmt);
179 extern void format_commit_message(const struct commit *commit,
180 const char *format, struct strbuf *sb,
181 const struct pretty_print_context *context);
182 extern void pretty_print_commit(struct pretty_print_context *pp,
183 const struct commit *commit,
184 struct strbuf *sb);
185 extern void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
186 struct strbuf *sb);
187 void pp_user_info(struct pretty_print_context *pp,
188 const char *what, struct strbuf *sb,
189 const char *line, const char *encoding);
190 void pp_title_line(struct pretty_print_context *pp,
191 const char **msg_p,
192 struct strbuf *sb,
193 const char *encoding,
194 int need_8bit_cte);
195 void pp_remainder(struct pretty_print_context *pp,
196 const char **msg_p,
197 struct strbuf *sb,
198 int indent);
201 /** Removes the first commit from a list sorted by date, and adds all
202 * of its parents.
204 struct commit *pop_most_recent_commit(struct commit_list **list,
205 unsigned int mark);
207 struct commit *pop_commit(struct commit_list **stack);
209 void clear_commit_marks(struct commit *commit, unsigned int mark);
210 void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark);
211 void clear_commit_marks_for_object_array(struct object_array *a, unsigned mark);
214 enum rev_sort_order {
215 REV_SORT_IN_GRAPH_ORDER = 0,
216 REV_SORT_BY_COMMIT_DATE,
217 REV_SORT_BY_AUTHOR_DATE
221 * Performs an in-place topological sort of list supplied.
223 * invariant of resulting list is:
224 * a reachable from b => ord(b) < ord(a)
225 * sort_order further specifies:
226 * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
227 * chain together.
228 * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
230 void sort_in_topological_order(struct commit_list **, enum rev_sort_order);
232 struct commit_graft {
233 struct object_id oid;
234 int nr_parent; /* < 0 if shallow commit */
235 struct object_id parent[FLEX_ARRAY]; /* more */
237 typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
239 struct commit_graft *read_graft_line(char *buf, int len);
240 int register_commit_graft(struct commit_graft *, int);
241 struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
243 extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2);
244 extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos);
245 extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
247 /* To be used only when object flags after this call no longer matter */
248 extern struct commit_list *get_merge_bases_many_dirty(struct commit *one, int n, struct commit **twos);
250 /* largest positive number a signed 32-bit integer can contain */
251 #define INFINITE_DEPTH 0x7fffffff
253 struct sha1_array;
254 struct ref;
255 extern int register_shallow(const unsigned char *sha1);
256 extern int unregister_shallow(const unsigned char *sha1);
257 extern int for_each_commit_graft(each_commit_graft_fn, void *);
258 extern int is_repository_shallow(void);
259 extern struct commit_list *get_shallow_commits(struct object_array *heads,
260 int depth, int shallow_flag, int not_shallow_flag);
261 extern void set_alternate_shallow_file(const char *path, int override);
262 extern int write_shallow_commits(struct strbuf *out, int use_pack_protocol,
263 const struct sha1_array *extra);
264 extern void setup_alternate_shallow(struct lock_file *shallow_lock,
265 const char **alternate_shallow_file,
266 const struct sha1_array *extra);
267 extern const char *setup_temporary_shallow(const struct sha1_array *extra);
268 extern void advertise_shallow_grafts(int);
270 struct shallow_info {
271 struct sha1_array *shallow;
272 int *ours, nr_ours;
273 int *theirs, nr_theirs;
274 struct sha1_array *ref;
276 /* for receive-pack */
277 uint32_t **used_shallow;
278 int *need_reachability_test;
279 int *reachable;
280 int *shallow_ref;
281 struct commit **commits;
282 int nr_commits;
285 extern void prepare_shallow_info(struct shallow_info *, struct sha1_array *);
286 extern void clear_shallow_info(struct shallow_info *);
287 extern void remove_nonexistent_theirs_shallow(struct shallow_info *);
288 extern void assign_shallow_commits_to_refs(struct shallow_info *info,
289 uint32_t **used,
290 int *ref_status);
291 extern int delayed_reachability_test(struct shallow_info *si, int c);
292 extern void prune_shallow(int show_only);
293 extern struct trace_key trace_shallow;
295 int is_descendant_of(struct commit *, struct commit_list *);
296 int in_merge_bases(struct commit *, struct commit *);
297 int in_merge_bases_many(struct commit *, int, struct commit **);
299 extern int interactive_add(int argc, const char **argv, const char *prefix, int patch);
300 extern int run_add_interactive(const char *revision, const char *patch_mode,
301 const struct pathspec *pathspec);
303 static inline int single_parent(struct commit *commit)
305 return commit->parents && !commit->parents->next;
308 struct commit_list *reduce_heads(struct commit_list *heads);
310 struct commit_extra_header {
311 struct commit_extra_header *next;
312 char *key;
313 char *value;
314 size_t len;
317 extern void append_merge_tag_headers(struct commit_list *parents,
318 struct commit_extra_header ***tail);
320 extern int commit_tree(const char *msg, size_t msg_len,
321 const unsigned char *tree,
322 struct commit_list *parents, unsigned char *ret,
323 const char *author, const char *sign_commit);
325 extern int commit_tree_extended(const char *msg, size_t msg_len,
326 const unsigned char *tree,
327 struct commit_list *parents, unsigned char *ret,
328 const char *author, const char *sign_commit,
329 struct commit_extra_header *);
331 extern struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
333 extern void free_commit_extra_headers(struct commit_extra_header *extra);
336 * Search the commit object contents given by "msg" for the header "key".
337 * Returns a pointer to the start of the header contents, or NULL. The length
338 * of the header, up to the first newline, is returned via out_len.
340 * Note that some headers (like mergetag) may be multi-line. It is the caller's
341 * responsibility to parse further in this case!
343 extern const char *find_commit_header(const char *msg, const char *key,
344 size_t *out_len);
346 /* Find the end of the log message, the right place for a new trailer. */
347 extern int ignore_non_trailer(struct strbuf *sb);
349 typedef void (*each_mergetag_fn)(struct commit *commit, struct commit_extra_header *extra,
350 void *cb_data);
352 extern void for_each_mergetag(each_mergetag_fn fn, struct commit *commit, void *data);
354 struct merge_remote_desc {
355 struct object *obj; /* the named object, could be a tag */
356 const char *name;
358 #define merge_remote_util(commit) ((struct merge_remote_desc *)((commit)->util))
361 * Given "name" from the command line to merge, find the commit object
362 * and return it, while storing merge_remote_desc in its ->util field,
363 * to allow callers to tell if we are told to merge a tag.
365 struct commit *get_merge_parent(const char *name);
367 extern int parse_signed_commit(const struct commit *commit,
368 struct strbuf *message, struct strbuf *signature);
369 extern int remove_signature(struct strbuf *buf);
371 extern void print_commit_list(struct commit_list *list,
372 const char *format_cur,
373 const char *format_last);
376 * Check the signature of the given commit. The result of the check is stored
377 * in sig->check_result, 'G' for a good signature, 'U' for a good signature
378 * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
379 * at all. This may allocate memory for sig->gpg_output, sig->gpg_status,
380 * sig->signer and sig->key.
382 extern int check_commit_signature(const struct commit *commit, struct signature_check *sigc);
384 int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused);
386 LAST_ARG_MUST_BE_NULL
387 extern int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...);
389 #endif /* COMMIT_H */