Merge branch 'master' of git://git.kernel.org/pub/scm/git/git
[git/jnareb-git.git] / commit.h
blob87b4b6cc0c036d4b7d2ff67cf9d6e98c58f13793
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"
10 struct commit_list {
11 struct commit *item;
12 struct commit_list *next;
15 struct commit {
16 struct object object;
17 void *util;
18 unsigned int indegree;
19 unsigned long date;
20 struct commit_list *parents;
21 struct tree *tree;
22 char *buffer;
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 extern struct decoration name_decoration;
30 struct name_decoration {
31 struct name_decoration *next;
32 int type;
33 char name[1];
36 struct commit *lookup_commit(const unsigned char *sha1);
37 struct commit *lookup_commit_reference(const unsigned char *sha1);
38 struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
39 int quiet);
40 struct commit *lookup_commit_reference_by_name(const char *name);
43 * Look up object named by "sha1", dereference tag as necessary,
44 * get a commit and return it. If "sha1" does not dereference to
45 * a commit, use ref_name to report an error and die.
47 struct commit *lookup_commit_or_die(const unsigned char *sha1, const char *ref_name);
49 int parse_commit_buffer(struct commit *item, const void *buffer, unsigned long size);
50 int parse_commit(struct commit *item);
52 /* Find beginning and length of commit subject. */
53 int find_commit_subject(const char *commit_buffer, const char **subject);
55 struct commit_list *commit_list_insert(struct commit *item,
56 struct commit_list **list);
57 struct commit_list **commit_list_append(struct commit *commit,
58 struct commit_list **next);
59 unsigned commit_list_count(const struct commit_list *l);
60 struct commit_list *commit_list_insert_by_date(struct commit *item,
61 struct commit_list **list);
62 void commit_list_sort_by_date(struct commit_list **list);
64 void free_commit_list(struct commit_list *list);
66 /* Commit formats */
67 enum cmit_fmt {
68 CMIT_FMT_RAW,
69 CMIT_FMT_MEDIUM,
70 CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
71 CMIT_FMT_SHORT,
72 CMIT_FMT_FULL,
73 CMIT_FMT_FULLER,
74 CMIT_FMT_ONELINE,
75 CMIT_FMT_EMAIL,
76 CMIT_FMT_USERFORMAT,
78 CMIT_FMT_UNSPECIFIED
81 struct pretty_print_context {
82 enum cmit_fmt fmt;
83 int abbrev;
84 const char *subject;
85 const char *after_subject;
86 int preserve_subject;
87 enum date_mode date_mode;
88 unsigned date_mode_explicit:1;
89 int need_8bit_cte;
90 char *notes_message;
91 struct reflog_walk_info *reflog_info;
92 const char *output_encoding;
93 struct string_list *mailmap;
94 int color;
97 struct userformat_want {
98 unsigned notes:1;
101 extern int has_non_ascii(const char *text);
102 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
103 extern char *logmsg_reencode(const struct commit *commit,
104 const char *output_encoding);
105 extern void logmsg_free(char *msg, const struct commit *commit);
106 extern void get_commit_format(const char *arg, struct rev_info *);
107 extern const char *format_subject(struct strbuf *sb, const char *msg,
108 const char *line_separator);
109 extern void userformat_find_requirements(const char *fmt, struct userformat_want *w);
110 extern void format_commit_message(const struct commit *commit,
111 const char *format, struct strbuf *sb,
112 const struct pretty_print_context *context);
113 extern void pretty_print_commit(const struct pretty_print_context *pp,
114 const struct commit *commit,
115 struct strbuf *sb);
116 extern void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
117 struct strbuf *sb);
118 void pp_user_info(const struct pretty_print_context *pp,
119 const char *what, struct strbuf *sb,
120 const char *line, const char *encoding);
121 void pp_title_line(const struct pretty_print_context *pp,
122 const char **msg_p,
123 struct strbuf *sb,
124 const char *encoding,
125 int need_8bit_cte);
126 void pp_remainder(const struct pretty_print_context *pp,
127 const char **msg_p,
128 struct strbuf *sb,
129 int indent);
132 /** Removes the first commit from a list sorted by date, and adds all
133 * of its parents.
135 struct commit *pop_most_recent_commit(struct commit_list **list,
136 unsigned int mark);
138 struct commit *pop_commit(struct commit_list **stack);
140 void clear_commit_marks(struct commit *commit, unsigned int mark);
141 void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark);
142 void clear_commit_marks_for_object_array(struct object_array *a, unsigned mark);
145 * Performs an in-place topological sort of list supplied.
147 * invariant of resulting list is:
148 * a reachable from b => ord(b) < ord(a)
149 * in addition, when lifo == 0, commits on parallel tracks are
150 * sorted in the dates order.
152 void sort_in_topological_order(struct commit_list ** list, int lifo);
154 struct commit_graft {
155 unsigned char sha1[20];
156 int nr_parent; /* < 0 if shallow commit */
157 unsigned char parent[FLEX_ARRAY][20]; /* more */
159 typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
161 struct commit_graft *read_graft_line(char *buf, int len);
162 int register_commit_graft(struct commit_graft *, int);
163 struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
165 extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
166 extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos, int cleanup);
167 extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
169 /* largest postive number a signed 32-bit integer can contain */
170 #define INFINITE_DEPTH 0x7fffffff
172 extern int register_shallow(const unsigned char *sha1);
173 extern int unregister_shallow(const unsigned char *sha1);
174 extern int for_each_commit_graft(each_commit_graft_fn, void *);
175 extern int is_repository_shallow(void);
176 extern struct commit_list *get_shallow_commits(struct object_array *heads,
177 int depth, int shallow_flag, int not_shallow_flag);
179 int is_descendant_of(struct commit *, struct commit_list *);
180 int in_merge_bases(struct commit *, struct commit *);
181 int in_merge_bases_many(struct commit *, int, struct commit **);
183 extern int interactive_add(int argc, const char **argv, const char *prefix, int patch);
184 extern int run_add_interactive(const char *revision, const char *patch_mode,
185 const char **pathspec);
187 static inline int single_parent(struct commit *commit)
189 return commit->parents && !commit->parents->next;
192 struct commit_list *reduce_heads(struct commit_list *heads);
194 struct commit_extra_header {
195 struct commit_extra_header *next;
196 char *key;
197 char *value;
198 size_t len;
201 extern void append_merge_tag_headers(struct commit_list *parents,
202 struct commit_extra_header ***tail);
204 extern int commit_tree(const struct strbuf *msg, unsigned char *tree,
205 struct commit_list *parents, unsigned char *ret,
206 const char *author, const char *sign_commit);
208 extern int commit_tree_extended(const struct strbuf *msg, unsigned char *tree,
209 struct commit_list *parents, unsigned char *ret,
210 const char *author, const char *sign_commit,
211 struct commit_extra_header *);
213 extern struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
215 extern void free_commit_extra_headers(struct commit_extra_header *extra);
217 struct merge_remote_desc {
218 struct object *obj; /* the named object, could be a tag */
219 const char *name;
221 #define merge_remote_util(commit) ((struct merge_remote_desc *)((commit)->util))
224 * Given "name" from the command line to merge, find the commit object
225 * and return it, while storing merge_remote_desc in its ->util field,
226 * to allow callers to tell if we are told to merge a tag.
228 struct commit *get_merge_parent(const char *name);
230 extern int parse_signed_commit(const unsigned char *sha1,
231 struct strbuf *message, struct strbuf *signature);
232 extern void print_commit_list(struct commit_list *list,
233 const char *format_cur,
234 const char *format_last);
237 * Check the signature of the given commit. The result of the check is stored
238 * in sig->check_result, 'G' for a good signature, 'U' for a good signature
239 * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
240 * at all. This may allocate memory for sig->gpg_output, sig->gpg_status,
241 * sig->signer and sig->key.
243 extern void check_commit_signature(const struct commit* commit, struct signature_check *sigc);
245 #endif /* COMMIT_H */