pack-objects: turn off bitmaps when we split packs
[git.git] / commit.h
blob2e1492a6e4d1c5fc5bea3a48180f128601c3461e
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 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);
51 void parse_commit_or_die(struct commit *item);
54 * Associate an object buffer with the commit. The ownership of the
55 * memory is handed over to the commit, and must be free()-able.
57 void set_commit_buffer(struct commit *, void *buffer, unsigned long size);
60 * Get any cached object buffer associated with the commit. Returns NULL
61 * if none. The resulting memory should not be freed.
63 const void *get_cached_commit_buffer(const struct commit *, unsigned long *size);
66 * Get the commit's object contents, either from cache or by reading the object
67 * from disk. The resulting memory should not be modified, and must be given
68 * to unuse_commit_buffer when the caller is done.
70 const void *get_commit_buffer(const struct commit *, unsigned long *size);
73 * Tell the commit subsytem that we are done with a particular commit buffer.
74 * The commit and buffer should be the input and return value, respectively,
75 * from an earlier call to get_commit_buffer. The buffer may or may not be
76 * freed by this call; callers should not access the memory afterwards.
78 void unuse_commit_buffer(const struct commit *, const void *buffer);
81 * Free any cached object buffer associated with the commit.
83 void free_commit_buffer(struct commit *);
86 * Disassociate any cached object buffer from the commit, but do not free it.
87 * The buffer (or NULL, if none) is returned.
89 const void *detach_commit_buffer(struct commit *, unsigned long *sizep);
91 /* Find beginning and length of commit subject. */
92 int find_commit_subject(const char *commit_buffer, const char **subject);
94 struct commit_list *commit_list_insert(struct commit *item,
95 struct commit_list **list);
96 struct commit_list **commit_list_append(struct commit *commit,
97 struct commit_list **next);
98 unsigned commit_list_count(const struct commit_list *l);
99 struct commit_list *commit_list_insert_by_date(struct commit *item,
100 struct commit_list **list);
101 void commit_list_sort_by_date(struct commit_list **list);
103 /* Shallow copy of the input list */
104 struct commit_list *copy_commit_list(struct commit_list *list);
106 void free_commit_list(struct commit_list *list);
108 /* Commit formats */
109 enum cmit_fmt {
110 CMIT_FMT_RAW,
111 CMIT_FMT_MEDIUM,
112 CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
113 CMIT_FMT_SHORT,
114 CMIT_FMT_FULL,
115 CMIT_FMT_FULLER,
116 CMIT_FMT_ONELINE,
117 CMIT_FMT_EMAIL,
118 CMIT_FMT_USERFORMAT,
120 CMIT_FMT_UNSPECIFIED
123 struct pretty_print_context {
125 * Callers should tweak these to change the behavior of pp_* functions.
127 enum cmit_fmt fmt;
128 int abbrev;
129 const char *subject;
130 const char *after_subject;
131 int preserve_subject;
132 enum date_mode date_mode;
133 unsigned date_mode_explicit:1;
134 int need_8bit_cte;
135 char *notes_message;
136 struct reflog_walk_info *reflog_info;
137 const char *output_encoding;
138 struct string_list *mailmap;
139 int color;
140 struct ident_split *from_ident;
143 * Fields below here are manipulated internally by pp_* functions and
144 * should not be counted on by callers.
146 struct string_list in_body_headers;
149 struct userformat_want {
150 unsigned notes:1;
153 extern int has_non_ascii(const char *text);
154 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
155 extern const char *logmsg_reencode(const struct commit *commit,
156 char **commit_encoding,
157 const char *output_encoding);
158 extern void get_commit_format(const char *arg, struct rev_info *);
159 extern const char *format_subject(struct strbuf *sb, const char *msg,
160 const char *line_separator);
161 extern void userformat_find_requirements(const char *fmt, struct userformat_want *w);
162 extern void format_commit_message(const struct commit *commit,
163 const char *format, struct strbuf *sb,
164 const struct pretty_print_context *context);
165 extern void pretty_print_commit(struct pretty_print_context *pp,
166 const struct commit *commit,
167 struct strbuf *sb);
168 extern void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
169 struct strbuf *sb);
170 void pp_user_info(struct pretty_print_context *pp,
171 const char *what, struct strbuf *sb,
172 const char *line, const char *encoding);
173 void pp_title_line(struct pretty_print_context *pp,
174 const char **msg_p,
175 struct strbuf *sb,
176 const char *encoding,
177 int need_8bit_cte);
178 void pp_remainder(struct pretty_print_context *pp,
179 const char **msg_p,
180 struct strbuf *sb,
181 int indent);
184 /** Removes the first commit from a list sorted by date, and adds all
185 * of its parents.
187 struct commit *pop_most_recent_commit(struct commit_list **list,
188 unsigned int mark);
190 struct commit *pop_commit(struct commit_list **stack);
192 void clear_commit_marks(struct commit *commit, unsigned int mark);
193 void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark);
194 void clear_commit_marks_for_object_array(struct object_array *a, unsigned mark);
197 enum rev_sort_order {
198 REV_SORT_IN_GRAPH_ORDER = 0,
199 REV_SORT_BY_COMMIT_DATE,
200 REV_SORT_BY_AUTHOR_DATE
204 * Performs an in-place topological sort of list supplied.
206 * invariant of resulting list is:
207 * a reachable from b => ord(b) < ord(a)
208 * sort_order further specifies:
209 * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
210 * chain together.
211 * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
213 void sort_in_topological_order(struct commit_list **, enum rev_sort_order);
215 struct commit_graft {
216 unsigned char sha1[20];
217 int nr_parent; /* < 0 if shallow commit */
218 unsigned char parent[FLEX_ARRAY][20]; /* more */
220 typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
222 struct commit_graft *read_graft_line(char *buf, int len);
223 int register_commit_graft(struct commit_graft *, int);
224 struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
226 extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
227 extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos, int cleanup);
228 extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
230 /* largest positive number a signed 32-bit integer can contain */
231 #define INFINITE_DEPTH 0x7fffffff
233 struct sha1_array;
234 struct ref;
235 extern int register_shallow(const unsigned char *sha1);
236 extern int unregister_shallow(const unsigned char *sha1);
237 extern int for_each_commit_graft(each_commit_graft_fn, void *);
238 extern int is_repository_shallow(void);
239 extern struct commit_list *get_shallow_commits(struct object_array *heads,
240 int depth, int shallow_flag, int not_shallow_flag);
241 extern void check_shallow_file_for_update(void);
242 extern void set_alternate_shallow_file(const char *path, int override);
243 extern int write_shallow_commits(struct strbuf *out, int use_pack_protocol,
244 const struct sha1_array *extra);
245 extern void setup_alternate_shallow(struct lock_file *shallow_lock,
246 const char **alternate_shallow_file,
247 const struct sha1_array *extra);
248 extern const char *setup_temporary_shallow(const struct sha1_array *extra);
249 extern void advertise_shallow_grafts(int);
251 struct shallow_info {
252 struct sha1_array *shallow;
253 int *ours, nr_ours;
254 int *theirs, nr_theirs;
255 struct sha1_array *ref;
257 /* for receive-pack */
258 uint32_t **used_shallow;
259 int *need_reachability_test;
260 int *reachable;
261 int *shallow_ref;
262 struct commit **commits;
263 int nr_commits;
266 extern void prepare_shallow_info(struct shallow_info *, struct sha1_array *);
267 extern void clear_shallow_info(struct shallow_info *);
268 extern void remove_nonexistent_theirs_shallow(struct shallow_info *);
269 extern void assign_shallow_commits_to_refs(struct shallow_info *info,
270 uint32_t **used,
271 int *ref_status);
272 extern int delayed_reachability_test(struct shallow_info *si, int c);
273 extern void prune_shallow(int show_only);
275 int is_descendant_of(struct commit *, struct commit_list *);
276 int in_merge_bases(struct commit *, struct commit *);
277 int in_merge_bases_many(struct commit *, int, struct commit **);
279 extern int interactive_add(int argc, const char **argv, const char *prefix, int patch);
280 extern int run_add_interactive(const char *revision, const char *patch_mode,
281 const struct pathspec *pathspec);
283 static inline int single_parent(struct commit *commit)
285 return commit->parents && !commit->parents->next;
288 struct commit_list *reduce_heads(struct commit_list *heads);
290 struct commit_extra_header {
291 struct commit_extra_header *next;
292 char *key;
293 char *value;
294 size_t len;
297 extern void append_merge_tag_headers(struct commit_list *parents,
298 struct commit_extra_header ***tail);
300 extern int commit_tree(const char *msg, size_t msg_len,
301 const unsigned char *tree,
302 struct commit_list *parents, unsigned char *ret,
303 const char *author, const char *sign_commit);
305 extern int commit_tree_extended(const char *msg, size_t msg_len,
306 const unsigned char *tree,
307 struct commit_list *parents, unsigned char *ret,
308 const char *author, const char *sign_commit,
309 struct commit_extra_header *);
311 extern struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
313 extern void free_commit_extra_headers(struct commit_extra_header *extra);
315 struct merge_remote_desc {
316 struct object *obj; /* the named object, could be a tag */
317 const char *name;
319 #define merge_remote_util(commit) ((struct merge_remote_desc *)((commit)->util))
322 * Given "name" from the command line to merge, find the commit object
323 * and return it, while storing merge_remote_desc in its ->util field,
324 * to allow callers to tell if we are told to merge a tag.
326 struct commit *get_merge_parent(const char *name);
328 extern int parse_signed_commit(const struct commit *commit,
329 struct strbuf *message, struct strbuf *signature);
330 extern void print_commit_list(struct commit_list *list,
331 const char *format_cur,
332 const char *format_last);
335 * Check the signature of the given commit. The result of the check is stored
336 * in sig->check_result, 'G' for a good signature, 'U' for a good signature
337 * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
338 * at all. This may allocate memory for sig->gpg_output, sig->gpg_status,
339 * sig->signer and sig->key.
341 extern void check_commit_signature(const struct commit* commit, struct signature_check *sigc);
343 int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused);
345 LAST_ARG_MUST_BE_NULL
346 extern int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...);
348 #endif /* COMMIT_H */