merge: abort if fails to commit
[git/git.git] / commit.h
CommitLineData
6eb8ae00
DB
1#ifndef COMMIT_H
2#define COMMIT_H
3
4#include "object.h"
5#include "tree.h"
674d1727 6#include "strbuf.h"
ca135e7a 7#include "decorate.h"
6eb8ae00
DB
8
9struct commit_list {
10 struct commit *item;
11 struct commit_list *next;
12};
13
14struct commit {
15 struct object object;
d3ff6f55 16 void *util;
23c17d4a 17 unsigned int indegree;
6eb8ae00
DB
18 unsigned long date;
19 struct commit_list *parents;
20 struct tree *tree;
bd1e17e2 21 char *buffer;
6eb8ae00
DB
22};
23
60ab26de 24extern int save_commit_buffer;
6eb8ae00
DB
25extern const char *commit_type;
26
ca135e7a
LT
27/* While we can decorate any object with a name, it's only used for commits.. */
28extern struct decoration name_decoration;
29struct name_decoration {
30 struct name_decoration *next;
eb3005e2 31 int type;
ca135e7a
LT
32 char name[1];
33};
34
5d6ccf5c
JM
35struct commit *lookup_commit(const unsigned char *sha1);
36struct commit *lookup_commit_reference(const unsigned char *sha1);
f76412ed
JH
37struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
38 int quiet);
a6fa5992 39struct commit *lookup_commit_reference_by_name(const char *name);
6eb8ae00 40
baf18fc2
NTND
41/*
42 * Look up object named by "sha1", dereference tag as necessary,
43 * get a commit and return it. If "sha1" does not dereference to
44 * a commit, use ref_name to report an error and die.
45 */
46struct commit *lookup_commit_or_die(const unsigned char *sha1, const char *ref_name);
47
cf7b1cad 48int parse_commit_buffer(struct commit *item, const void *buffer, unsigned long size);
6eb8ae00
DB
49int parse_commit(struct commit *item);
50
11af2aae
CC
51/* Find beginning and length of commit subject. */
52int find_commit_subject(const char *commit_buffer, const char **subject);
53
47e44ed1
TF
54struct commit_list *commit_list_insert(struct commit *item,
55 struct commit_list **list);
65319475 56unsigned commit_list_count(const struct commit_list *l);
47e44ed1
TF
57struct commit_list *commit_list_insert_by_date(struct commit *item,
58 struct commit_list **list);
59void commit_list_sort_by_date(struct commit_list **list);
dd97f850 60
6eb8ae00
DB
61void free_commit_list(struct commit_list *list);
62
000182ea
LT
63/* Commit formats */
64enum cmit_fmt {
65 CMIT_FMT_RAW,
66 CMIT_FMT_MEDIUM,
67 CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
9b66ec04
LT
68 CMIT_FMT_SHORT,
69 CMIT_FMT_FULL,
ff56fe1c 70 CMIT_FMT_FULLER,
d87449c5 71 CMIT_FMT_ONELINE,
3eefc189 72 CMIT_FMT_EMAIL,
e52a5de4 73 CMIT_FMT_USERFORMAT,
6b9c58f4 74
4b05548f 75 CMIT_FMT_UNSPECIFIED
000182ea
LT
76};
77
9cba13ca 78struct pretty_print_context {
6bf13944 79 enum cmit_fmt fmt;
dd2e794a
TR
80 int abbrev;
81 const char *subject;
82 const char *after_subject;
9553d2b2 83 int preserve_subject;
dd2e794a
TR
84 enum date_mode date_mode;
85 int need_8bit_cte;
66b2ed09 86 int show_notes;
8f8f5476 87 struct reflog_walk_info *reflog_info;
177b29dc 88 const char *output_encoding;
dd2e794a
TR
89};
90
5b163603
JG
91struct userformat_want {
92 unsigned notes:1;
93};
94
28e9cf65 95extern int has_non_ascii(const char *text);
4da45bef 96struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
177b29dc
PN
97extern char *logmsg_reencode(const struct commit *commit,
98 const char *output_encoding);
69cd8f63
AG
99extern char *reencode_commit_message(const struct commit *commit,
100 const char **encoding_p);
4da45bef 101extern void get_commit_format(const char *arg, struct rev_info *);
c8f1444d
RJ
102extern const char *format_subject(struct strbuf *sb, const char *msg,
103 const char *line_separator);
5b163603 104extern void userformat_find_requirements(const char *fmt, struct userformat_want *w);
674d1727 105extern void format_commit_message(const struct commit *commit,
7f98ebc8 106 const char *format, struct strbuf *sb,
dd2e794a 107 const struct pretty_print_context *context);
6bf13944
JK
108extern void pretty_print_commit(const struct pretty_print_context *pp,
109 const struct commit *commit,
110 struct strbuf *sb);
8b8a5374
JK
111extern void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
112 struct strbuf *sb);
6bf13944
JK
113void pp_user_info(const struct pretty_print_context *pp,
114 const char *what, struct strbuf *sb,
115 const char *line, const char *encoding);
116void pp_title_line(const struct pretty_print_context *pp,
b02bd65f
DB
117 const char **msg_p,
118 struct strbuf *sb,
b02bd65f 119 const char *encoding,
267123b4 120 int need_8bit_cte);
6bf13944 121void pp_remainder(const struct pretty_print_context *pp,
b02bd65f
DB
122 const char **msg_p,
123 struct strbuf *sb,
124 int indent);
125
e3bc7a3b 126
dd97f850
DB
127/** Removes the first commit from a list sorted by date, and adds all
128 * of its parents.
129 **/
a6080a0a 130struct commit *pop_most_recent_commit(struct commit_list **list,
58e28af6 131 unsigned int mark);
dd97f850 132
a3437b8c
JS
133struct commit *pop_commit(struct commit_list **stack);
134
f8f9c73c 135void clear_commit_marks(struct commit *commit, unsigned int mark);
86a0a408 136void clear_commit_marks_for_object_array(struct object_array *a, unsigned mark);
f8f9c73c 137
ab580ace
JS
138/*
139 * Performs an in-place topological sort of list supplied.
140 *
ab580ace
JS
141 * invariant of resulting list is:
142 * a reachable from b => ord(b) < ord(a)
4c8725f1
JH
143 * in addition, when lifo == 0, commits on parallel tracks are
144 * sorted in the dates order.
ab580ace 145 */
4c8725f1 146void sort_in_topological_order(struct commit_list ** list, int lifo);
5040f17e
JH
147
148struct commit_graft {
149 unsigned char sha1[20];
ed09aef0 150 int nr_parent; /* < 0 if shallow commit */
5040f17e
JH
151 unsigned char parent[FLEX_ARRAY][20]; /* more */
152};
09d46644 153typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
5040f17e
JH
154
155struct commit_graft *read_graft_line(char *buf, int len);
156int register_commit_graft(struct commit_graft *, int);
45163382 157struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
5040f17e 158
c0fa8255 159extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
53eda89b 160extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos, int cleanup);
5240c9d7 161extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
7c6f8aaf 162
ed09aef0 163extern int register_shallow(const unsigned char *sha1);
f53514bc 164extern int unregister_shallow(const unsigned char *sha1);
09d46644 165extern int for_each_commit_graft(each_commit_graft_fn, void *);
f43117a6 166extern int is_repository_shallow(void);
ed09aef0 167extern struct commit_list *get_shallow_commits(struct object_array *heads,
f53514bc 168 int depth, int shallow_flag, int not_shallow_flag);
ed09aef0 169
7fcdb36e 170int is_descendant_of(struct commit *, struct commit_list *);
03840fc3 171int in_merge_bases(struct commit *, struct commit **, int);
58680165 172
b4bd4668 173extern int interactive_add(int argc, const char **argv, const char *prefix, int patch);
46b5139c
TR
174extern int run_add_interactive(const char *revision, const char *patch_mode,
175 const char **pathspec);
58680165 176
53b2c823
LT
177static inline int single_parent(struct commit *commit)
178{
179 return commit->parents && !commit->parents->next;
180}
181
98cf9c3b
JH
182struct commit_list *reduce_heads(struct commit_list *heads);
183
40d52ff7
JK
184extern int commit_tree(const char *msg, unsigned char *tree,
185 struct commit_list *parents, unsigned char *ret,
186 const char *author);
187
6eb8ae00 188#endif /* COMMIT_H */