Prepare for 2.9.4
[alt-git.git] / commit.h
blob15ee924f2f02998d742464de6c31b55d391426b3
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 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;
160 * Fields below here are manipulated internally by pp_* functions and
161 * should not be counted on by callers.
163 struct string_list in_body_headers;
164 int graph_width;
167 struct userformat_want {
168 unsigned notes:1;
171 extern int has_non_ascii(const char *text);
172 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
173 extern const char *logmsg_reencode(const struct commit *commit,
174 char **commit_encoding,
175 const char *output_encoding);
176 extern void get_commit_format(const char *arg, struct rev_info *);
177 extern const char *format_subject(struct strbuf *sb, const char *msg,
178 const char *line_separator);
179 extern void userformat_find_requirements(const char *fmt, struct userformat_want *w);
180 extern int commit_format_is_empty(enum cmit_fmt);
181 extern const char *skip_blank_lines(const char *msg);
182 extern void format_commit_message(const struct commit *commit,
183 const char *format, struct strbuf *sb,
184 const struct pretty_print_context *context);
185 extern void pretty_print_commit(struct pretty_print_context *pp,
186 const struct commit *commit,
187 struct strbuf *sb);
188 extern void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
189 struct strbuf *sb);
190 void pp_user_info(struct pretty_print_context *pp,
191 const char *what, struct strbuf *sb,
192 const char *line, const char *encoding);
193 void pp_title_line(struct pretty_print_context *pp,
194 const char **msg_p,
195 struct strbuf *sb,
196 const char *encoding,
197 int need_8bit_cte);
198 void pp_remainder(struct pretty_print_context *pp,
199 const char **msg_p,
200 struct strbuf *sb,
201 int indent);
204 /** Removes the first commit from a list sorted by date, and adds all
205 * of its parents.
207 struct commit *pop_most_recent_commit(struct commit_list **list,
208 unsigned int mark);
210 struct commit *pop_commit(struct commit_list **stack);
212 void clear_commit_marks(struct commit *commit, unsigned int mark);
213 void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark);
214 void clear_commit_marks_for_object_array(struct object_array *a, unsigned mark);
217 enum rev_sort_order {
218 REV_SORT_IN_GRAPH_ORDER = 0,
219 REV_SORT_BY_COMMIT_DATE,
220 REV_SORT_BY_AUTHOR_DATE
224 * Performs an in-place topological sort of list supplied.
226 * invariant of resulting list is:
227 * a reachable from b => ord(b) < ord(a)
228 * sort_order further specifies:
229 * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
230 * chain together.
231 * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
233 void sort_in_topological_order(struct commit_list **, enum rev_sort_order);
235 struct commit_graft {
236 struct object_id oid;
237 int nr_parent; /* < 0 if shallow commit */
238 struct object_id parent[FLEX_ARRAY]; /* more */
240 typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
242 struct commit_graft *read_graft_line(char *buf, int len);
243 int register_commit_graft(struct commit_graft *, int);
244 struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
246 extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2);
247 extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos);
248 extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
250 /* To be used only when object flags after this call no longer matter */
251 extern struct commit_list *get_merge_bases_many_dirty(struct commit *one, int n, struct commit **twos);
253 /* largest positive number a signed 32-bit integer can contain */
254 #define INFINITE_DEPTH 0x7fffffff
256 struct sha1_array;
257 struct ref;
258 extern int register_shallow(const unsigned char *sha1);
259 extern int unregister_shallow(const unsigned char *sha1);
260 extern int for_each_commit_graft(each_commit_graft_fn, void *);
261 extern int is_repository_shallow(void);
262 extern struct commit_list *get_shallow_commits(struct object_array *heads,
263 int depth, int shallow_flag, int not_shallow_flag);
264 extern void set_alternate_shallow_file(const char *path, int override);
265 extern int write_shallow_commits(struct strbuf *out, int use_pack_protocol,
266 const struct sha1_array *extra);
267 extern void setup_alternate_shallow(struct lock_file *shallow_lock,
268 const char **alternate_shallow_file,
269 const struct sha1_array *extra);
270 extern const char *setup_temporary_shallow(const struct sha1_array *extra);
271 extern void advertise_shallow_grafts(int);
273 struct shallow_info {
274 struct sha1_array *shallow;
275 int *ours, nr_ours;
276 int *theirs, nr_theirs;
277 struct sha1_array *ref;
279 /* for receive-pack */
280 uint32_t **used_shallow;
281 int *need_reachability_test;
282 int *reachable;
283 int *shallow_ref;
284 struct commit **commits;
285 int nr_commits;
288 extern void prepare_shallow_info(struct shallow_info *, struct sha1_array *);
289 extern void clear_shallow_info(struct shallow_info *);
290 extern void remove_nonexistent_theirs_shallow(struct shallow_info *);
291 extern void assign_shallow_commits_to_refs(struct shallow_info *info,
292 uint32_t **used,
293 int *ref_status);
294 extern int delayed_reachability_test(struct shallow_info *si, int c);
295 extern void prune_shallow(int show_only);
296 extern struct trace_key trace_shallow;
298 int is_descendant_of(struct commit *, struct commit_list *);
299 int in_merge_bases(struct commit *, struct commit *);
300 int in_merge_bases_many(struct commit *, int, struct commit **);
302 extern int interactive_add(int argc, const char **argv, const char *prefix, int patch);
303 extern int run_add_interactive(const char *revision, const char *patch_mode,
304 const struct pathspec *pathspec);
306 static inline int single_parent(struct commit *commit)
308 return commit->parents && !commit->parents->next;
311 struct commit_list *reduce_heads(struct commit_list *heads);
313 struct commit_extra_header {
314 struct commit_extra_header *next;
315 char *key;
316 char *value;
317 size_t len;
320 extern void append_merge_tag_headers(struct commit_list *parents,
321 struct commit_extra_header ***tail);
323 extern int commit_tree(const char *msg, size_t msg_len,
324 const unsigned char *tree,
325 struct commit_list *parents, unsigned char *ret,
326 const char *author, const char *sign_commit);
328 extern int commit_tree_extended(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,
332 struct commit_extra_header *);
334 extern struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
336 extern void free_commit_extra_headers(struct commit_extra_header *extra);
339 * Search the commit object contents given by "msg" for the header "key".
340 * Returns a pointer to the start of the header contents, or NULL. The length
341 * of the header, up to the first newline, is returned via out_len.
343 * Note that some headers (like mergetag) may be multi-line. It is the caller's
344 * responsibility to parse further in this case!
346 extern const char *find_commit_header(const char *msg, const char *key,
347 size_t *out_len);
349 /* Find the end of the log message, the right place for a new trailer. */
350 extern int ignore_non_trailer(struct strbuf *sb);
352 typedef void (*each_mergetag_fn)(struct commit *commit, struct commit_extra_header *extra,
353 void *cb_data);
355 extern void for_each_mergetag(each_mergetag_fn fn, struct commit *commit, void *data);
357 struct merge_remote_desc {
358 struct object *obj; /* the named object, could be a tag */
359 char name[FLEX_ARRAY];
361 #define merge_remote_util(commit) ((struct merge_remote_desc *)((commit)->util))
362 extern void set_merge_remote_desc(struct commit *commit,
363 const char *name, struct object *obj);
366 * Given "name" from the command line to merge, find the commit object
367 * and return it, while storing merge_remote_desc in its ->util field,
368 * to allow callers to tell if we are told to merge a tag.
370 struct commit *get_merge_parent(const char *name);
372 extern int parse_signed_commit(const struct commit *commit,
373 struct strbuf *message, struct strbuf *signature);
374 extern int remove_signature(struct strbuf *buf);
376 extern void print_commit_list(struct commit_list *list,
377 const char *format_cur,
378 const char *format_last);
381 * Check the signature of the given commit. The result of the check is stored
382 * in sig->check_result, 'G' for a good signature, 'U' for a good signature
383 * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
384 * at all. This may allocate memory for sig->gpg_output, sig->gpg_status,
385 * sig->signer and sig->key.
387 extern int check_commit_signature(const struct commit *commit, struct signature_check *sigc);
389 int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused);
391 LAST_ARG_MUST_BE_NULL
392 extern int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...);
394 #endif /* COMMIT_H */