Merge branch 'esr/maint-doc-fast-import'
[git.git] / commit.h
blobb6ad8f3f307a46cd5a0555ab346abaa20013b13a
1 #ifndef COMMIT_H
2 #define COMMIT_H
4 #include "object.h"
5 #include "tree.h"
6 #include "strbuf.h"
7 #include "decorate.h"
9 struct commit_list {
10 struct commit *item;
11 struct commit_list *next;
14 struct commit {
15 struct object object;
16 void *util;
17 unsigned int indegree;
18 unsigned long date;
19 struct commit_list *parents;
20 struct tree *tree;
21 char *buffer;
24 extern int save_commit_buffer;
25 extern const char *commit_type;
27 /* While we can decorate any object with a name, it's only used for commits.. */
28 extern struct decoration name_decoration;
29 struct name_decoration {
30 struct name_decoration *next;
31 int type;
32 char name[1];
35 struct commit *lookup_commit(const unsigned char *sha1);
36 struct commit *lookup_commit_reference(const unsigned char *sha1);
37 struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
38 int quiet);
39 struct commit *lookup_commit_reference_by_name(const char *name);
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.
46 struct commit *lookup_commit_or_die(const unsigned char *sha1, const char *ref_name);
48 int parse_commit_buffer(struct commit *item, const void *buffer, unsigned long size);
49 int parse_commit(struct commit *item);
51 /* Find beginning and length of commit subject. */
52 int find_commit_subject(const char *commit_buffer, const char **subject);
54 struct commit_list *commit_list_insert(struct commit *item,
55 struct commit_list **list);
56 struct commit_list **commit_list_append(struct commit *commit,
57 struct commit_list **next);
58 unsigned commit_list_count(const struct commit_list *l);
59 struct commit_list *commit_list_insert_by_date(struct commit *item,
60 struct commit_list **list);
61 void commit_list_sort_by_date(struct commit_list **list);
63 void free_commit_list(struct commit_list *list);
65 /* Commit formats */
66 enum cmit_fmt {
67 CMIT_FMT_RAW,
68 CMIT_FMT_MEDIUM,
69 CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
70 CMIT_FMT_SHORT,
71 CMIT_FMT_FULL,
72 CMIT_FMT_FULLER,
73 CMIT_FMT_ONELINE,
74 CMIT_FMT_EMAIL,
75 CMIT_FMT_USERFORMAT,
77 CMIT_FMT_UNSPECIFIED
80 struct pretty_print_context {
81 enum cmit_fmt fmt;
82 int abbrev;
83 const char *subject;
84 const char *after_subject;
85 int preserve_subject;
86 enum date_mode date_mode;
87 unsigned date_mode_explicit:1;
88 int need_8bit_cte;
89 char *notes_message;
90 struct reflog_walk_info *reflog_info;
91 const char *output_encoding;
94 struct userformat_want {
95 unsigned notes:1;
98 extern int has_non_ascii(const char *text);
99 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
100 extern char *logmsg_reencode(const struct commit *commit,
101 const char *output_encoding);
102 extern void get_commit_format(const char *arg, struct rev_info *);
103 extern const char *format_subject(struct strbuf *sb, const char *msg,
104 const char *line_separator);
105 extern void userformat_find_requirements(const char *fmt, struct userformat_want *w);
106 extern void format_commit_message(const struct commit *commit,
107 const char *format, struct strbuf *sb,
108 const struct pretty_print_context *context);
109 extern void pretty_print_commit(const struct pretty_print_context *pp,
110 const struct commit *commit,
111 struct strbuf *sb);
112 extern void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
113 struct strbuf *sb);
114 void pp_user_info(const struct pretty_print_context *pp,
115 const char *what, struct strbuf *sb,
116 const char *line, const char *encoding);
117 void pp_title_line(const struct pretty_print_context *pp,
118 const char **msg_p,
119 struct strbuf *sb,
120 const char *encoding,
121 int need_8bit_cte);
122 void pp_remainder(const struct pretty_print_context *pp,
123 const char **msg_p,
124 struct strbuf *sb,
125 int indent);
128 /** Removes the first commit from a list sorted by date, and adds all
129 * of its parents.
131 struct commit *pop_most_recent_commit(struct commit_list **list,
132 unsigned int mark);
134 struct commit *pop_commit(struct commit_list **stack);
136 void clear_commit_marks(struct commit *commit, unsigned int mark);
137 void clear_commit_marks_for_object_array(struct object_array *a, unsigned mark);
140 * Performs an in-place topological sort of list supplied.
142 * invariant of resulting list is:
143 * a reachable from b => ord(b) < ord(a)
144 * in addition, when lifo == 0, commits on parallel tracks are
145 * sorted in the dates order.
147 void sort_in_topological_order(struct commit_list ** list, int lifo);
149 struct commit_graft {
150 unsigned char sha1[20];
151 int nr_parent; /* < 0 if shallow commit */
152 unsigned char parent[FLEX_ARRAY][20]; /* more */
154 typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
156 struct commit_graft *read_graft_line(char *buf, int len);
157 int register_commit_graft(struct commit_graft *, int);
158 struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
160 extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
161 extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos, int cleanup);
162 extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
164 extern int register_shallow(const unsigned char *sha1);
165 extern int unregister_shallow(const unsigned char *sha1);
166 extern int for_each_commit_graft(each_commit_graft_fn, void *);
167 extern int is_repository_shallow(void);
168 extern struct commit_list *get_shallow_commits(struct object_array *heads,
169 int depth, int shallow_flag, int not_shallow_flag);
171 int is_descendant_of(struct commit *, struct commit_list *);
172 int in_merge_bases(struct commit *, struct commit *);
174 extern int interactive_add(int argc, const char **argv, const char *prefix, int patch);
175 extern int run_add_interactive(const char *revision, const char *patch_mode,
176 const char **pathspec);
178 static inline int single_parent(struct commit *commit)
180 return commit->parents && !commit->parents->next;
183 struct commit_list *reduce_heads(struct commit_list *heads);
185 struct commit_extra_header {
186 struct commit_extra_header *next;
187 char *key;
188 char *value;
189 size_t len;
192 extern void append_merge_tag_headers(struct commit_list *parents,
193 struct commit_extra_header ***tail);
195 extern int commit_tree(const struct strbuf *msg, unsigned char *tree,
196 struct commit_list *parents, unsigned char *ret,
197 const char *author, const char *sign_commit);
199 extern int commit_tree_extended(const struct strbuf *msg, unsigned char *tree,
200 struct commit_list *parents, unsigned char *ret,
201 const char *author, const char *sign_commit,
202 struct commit_extra_header *);
204 extern struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
206 extern void free_commit_extra_headers(struct commit_extra_header *extra);
208 struct merge_remote_desc {
209 struct object *obj; /* the named object, could be a tag */
210 const char *name;
212 #define merge_remote_util(commit) ((struct merge_remote_desc *)((commit)->util))
215 * Given "name" from the command line to merge, find the commit object
216 * and return it, while storing merge_remote_desc in its ->util field,
217 * to allow callers to tell if we are told to merge a tag.
219 struct commit *get_merge_parent(const char *name);
221 extern int parse_signed_commit(const unsigned char *sha1,
222 struct strbuf *message, struct strbuf *signature);
223 extern void print_commit_list(struct commit_list *list,
224 const char *format_cur,
225 const char *format_last);
227 #endif /* COMMIT_H */