builtin/notes: remove unnecessary free
[git/debian.git] / commit.h
blobda0db36eba2bf16277dbb7aadcb3384e29191ecc
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"
10 #include "pretty.h"
12 #define COMMIT_NOT_FROM_GRAPH 0xFFFFFFFF
13 #define GENERATION_NUMBER_INFINITY 0xFFFFFFFF
14 #define GENERATION_NUMBER_MAX 0x3FFFFFFF
15 #define GENERATION_NUMBER_ZERO 0
17 struct commit_list {
18 struct commit *item;
19 struct commit_list *next;
23 * The size of this struct matters in full repo walk operations like
24 * 'git clone' or 'git gc'. Consider using commit-slab to attach data
25 * to a commit instead of adding new fields here.
27 struct commit {
28 struct object object;
29 timestamp_t date;
30 struct commit_list *parents;
33 * If the commit is loaded from the commit-graph file, then this
34 * member may be NULL. Only access it through get_commit_tree()
35 * or get_commit_tree_oid().
37 struct tree *maybe_tree;
38 uint32_t graph_pos;
39 uint32_t generation;
40 unsigned int index;
43 extern int save_commit_buffer;
44 extern const char *commit_type;
46 /* While we can decorate any object with a name, it's only used for commits.. */
47 struct name_decoration {
48 struct name_decoration *next;
49 int type;
50 char name[FLEX_ARRAY];
53 enum decoration_type {
54 DECORATION_NONE = 0,
55 DECORATION_REF_LOCAL,
56 DECORATION_REF_REMOTE,
57 DECORATION_REF_TAG,
58 DECORATION_REF_STASH,
59 DECORATION_REF_HEAD,
60 DECORATION_GRAFTED,
63 void add_name_decoration(enum decoration_type type, const char *name, struct object *obj);
64 const struct name_decoration *get_name_decoration(const struct object *obj);
66 struct commit *lookup_commit(struct repository *r, const struct object_id *oid);
67 struct commit *lookup_commit_reference(struct repository *r,
68 const struct object_id *oid);
69 struct commit *lookup_commit_reference_gently(struct repository *r,
70 const struct object_id *oid,
71 int quiet);
72 struct commit *lookup_commit_reference_by_name(const char *name);
75 * Look up object named by "oid", dereference tag as necessary,
76 * get a commit and return it. If "oid" does not dereference to
77 * a commit, use ref_name to report an error and die.
79 struct commit *lookup_commit_or_die(const struct object_id *oid, const char *ref_name);
81 int parse_commit_buffer(struct repository *r, struct commit *item, const void *buffer, unsigned long size, int check_graph);
82 int parse_commit_internal(struct commit *item, int quiet_on_missing, int use_commit_graph);
83 int parse_commit_gently(struct commit *item, int quiet_on_missing);
84 static inline int parse_commit(struct commit *item)
86 return parse_commit_gently(item, 0);
88 void parse_commit_or_die(struct commit *item);
90 struct buffer_slab;
91 struct buffer_slab *allocate_commit_buffer_slab(void);
92 void free_commit_buffer_slab(struct buffer_slab *bs);
95 * Associate an object buffer with the commit. The ownership of the
96 * memory is handed over to the commit, and must be free()-able.
98 void set_commit_buffer(struct repository *r, struct commit *, void *buffer, unsigned long size);
101 * Get any cached object buffer associated with the commit. Returns NULL
102 * if none. The resulting memory should not be freed.
104 const void *get_cached_commit_buffer(struct repository *, const struct commit *, unsigned long *size);
107 * Get the commit's object contents, either from cache or by reading the object
108 * from disk. The resulting memory should not be modified, and must be given
109 * to unuse_commit_buffer when the caller is done.
111 const void *get_commit_buffer(const struct commit *, unsigned long *size);
114 * Tell the commit subsytem that we are done with a particular commit buffer.
115 * The commit and buffer should be the input and return value, respectively,
116 * from an earlier call to get_commit_buffer. The buffer may or may not be
117 * freed by this call; callers should not access the memory afterwards.
119 void unuse_commit_buffer(const struct commit *, const void *buffer);
122 * Free any cached object buffer associated with the commit.
124 void free_commit_buffer(struct commit *);
126 struct tree *get_commit_tree(const struct commit *);
127 struct object_id *get_commit_tree_oid(const struct commit *);
130 * Release memory related to a commit, including the parent list and
131 * any cached object buffer.
133 void release_commit_memory(struct commit *c);
136 * Disassociate any cached object buffer from the commit, but do not free it.
137 * The buffer (or NULL, if none) is returned.
139 const void *detach_commit_buffer(struct commit *, unsigned long *sizep);
141 /* Find beginning and length of commit subject. */
142 int find_commit_subject(const char *commit_buffer, const char **subject);
144 struct commit_list *commit_list_insert(struct commit *item,
145 struct commit_list **list);
146 struct commit_list **commit_list_append(struct commit *commit,
147 struct commit_list **next);
148 unsigned commit_list_count(const struct commit_list *l);
149 struct commit_list *commit_list_insert_by_date(struct commit *item,
150 struct commit_list **list);
151 void commit_list_sort_by_date(struct commit_list **list);
153 /* Shallow copy of the input list */
154 struct commit_list *copy_commit_list(struct commit_list *list);
156 void free_commit_list(struct commit_list *list);
158 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
160 extern int has_non_ascii(const char *text);
161 extern const char *logmsg_reencode(const struct commit *commit,
162 char **commit_encoding,
163 const char *output_encoding);
164 extern const char *skip_blank_lines(const char *msg);
166 /** Removes the first commit from a list sorted by date, and adds all
167 * of its parents.
169 struct commit *pop_most_recent_commit(struct commit_list **list,
170 unsigned int mark);
172 struct commit *pop_commit(struct commit_list **stack);
174 void clear_commit_marks(struct commit *commit, unsigned int mark);
175 void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark);
178 enum rev_sort_order {
179 REV_SORT_IN_GRAPH_ORDER = 0,
180 REV_SORT_BY_COMMIT_DATE,
181 REV_SORT_BY_AUTHOR_DATE
185 * Performs an in-place topological sort of list supplied.
187 * invariant of resulting list is:
188 * a reachable from b => ord(b) < ord(a)
189 * sort_order further specifies:
190 * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
191 * chain together.
192 * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
194 void sort_in_topological_order(struct commit_list **, enum rev_sort_order);
196 struct commit_graft {
197 struct object_id oid;
198 int nr_parent; /* < 0 if shallow commit */
199 struct object_id parent[FLEX_ARRAY]; /* more */
201 typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
203 struct commit_graft *read_graft_line(struct strbuf *line);
204 int register_commit_graft(struct repository *r, struct commit_graft *, int);
205 struct commit_graft *lookup_commit_graft(struct repository *r, const struct object_id *oid);
207 extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2);
208 extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos);
209 extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
211 /* To be used only when object flags after this call no longer matter */
212 extern struct commit_list *get_merge_bases_many_dirty(struct commit *one, int n, struct commit **twos);
214 /* largest positive number a signed 32-bit integer can contain */
215 #define INFINITE_DEPTH 0x7fffffff
217 struct oid_array;
218 struct ref;
219 extern int register_shallow(struct repository *r, const struct object_id *oid);
220 extern int unregister_shallow(const struct object_id *oid);
221 extern int for_each_commit_graft(each_commit_graft_fn, void *);
222 extern int is_repository_shallow(struct repository *r);
223 extern struct commit_list *get_shallow_commits(struct object_array *heads,
224 int depth, int shallow_flag, int not_shallow_flag);
225 extern struct commit_list *get_shallow_commits_by_rev_list(
226 int ac, const char **av, int shallow_flag, int not_shallow_flag);
227 extern void set_alternate_shallow_file(struct repository *r, const char *path, int override);
228 extern int write_shallow_commits(struct strbuf *out, int use_pack_protocol,
229 const struct oid_array *extra);
230 extern void setup_alternate_shallow(struct lock_file *shallow_lock,
231 const char **alternate_shallow_file,
232 const struct oid_array *extra);
233 extern const char *setup_temporary_shallow(const struct oid_array *extra);
234 extern void advertise_shallow_grafts(int);
236 struct shallow_info {
237 struct oid_array *shallow;
238 int *ours, nr_ours;
239 int *theirs, nr_theirs;
240 struct oid_array *ref;
242 /* for receive-pack */
243 uint32_t **used_shallow;
244 int *need_reachability_test;
245 int *reachable;
246 int *shallow_ref;
247 struct commit **commits;
248 int nr_commits;
251 extern void prepare_shallow_info(struct shallow_info *, struct oid_array *);
252 extern void clear_shallow_info(struct shallow_info *);
253 extern void remove_nonexistent_theirs_shallow(struct shallow_info *);
254 extern void assign_shallow_commits_to_refs(struct shallow_info *info,
255 uint32_t **used,
256 int *ref_status);
257 extern int delayed_reachability_test(struct shallow_info *si, int c);
258 extern void prune_shallow(int show_only);
259 extern struct trace_key trace_shallow;
261 int is_descendant_of(struct commit *, struct commit_list *);
262 int in_merge_bases(struct commit *, struct commit *);
263 int in_merge_bases_many(struct commit *, int, struct commit **);
265 extern int interactive_add(int argc, const char **argv, const char *prefix, int patch);
266 extern int run_add_interactive(const char *revision, const char *patch_mode,
267 const struct pathspec *pathspec);
270 * Takes a list of commits and returns a new list where those
271 * have been removed that can be reached from other commits in
272 * the list. It is useful for, e.g., reducing the commits
273 * randomly thrown at the git-merge command and removing
274 * redundant commits that the user shouldn't have given to it.
276 * This function destroys the STALE bit of the commit objects'
277 * flags.
279 extern struct commit_list *reduce_heads(struct commit_list *heads);
282 * Like `reduce_heads()`, except it replaces the list. Use this
283 * instead of `foo = reduce_heads(foo);` to avoid memory leaks.
285 extern void reduce_heads_replace(struct commit_list **heads);
287 struct commit_extra_header {
288 struct commit_extra_header *next;
289 char *key;
290 char *value;
291 size_t len;
294 extern void append_merge_tag_headers(struct commit_list *parents,
295 struct commit_extra_header ***tail);
297 extern int commit_tree(const char *msg, size_t msg_len,
298 const struct object_id *tree,
299 struct commit_list *parents, struct object_id *ret,
300 const char *author, const char *sign_commit);
302 extern int commit_tree_extended(const char *msg, size_t msg_len,
303 const struct object_id *tree,
304 struct commit_list *parents,
305 struct object_id *ret, const char *author,
306 const char *sign_commit,
307 struct commit_extra_header *);
309 extern struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
311 extern void free_commit_extra_headers(struct commit_extra_header *extra);
314 * Search the commit object contents given by "msg" for the header "key".
315 * Returns a pointer to the start of the header contents, or NULL. The length
316 * of the header, up to the first newline, is returned via out_len.
318 * Note that some headers (like mergetag) may be multi-line. It is the caller's
319 * responsibility to parse further in this case!
321 extern const char *find_commit_header(const char *msg, const char *key,
322 size_t *out_len);
324 /* Find the end of the log message, the right place for a new trailer. */
325 extern int ignore_non_trailer(const char *buf, size_t len);
327 typedef int (*each_mergetag_fn)(struct commit *commit, struct commit_extra_header *extra,
328 void *cb_data);
330 extern int for_each_mergetag(each_mergetag_fn fn, struct commit *commit, void *data);
332 struct merge_remote_desc {
333 struct object *obj; /* the named object, could be a tag */
334 char name[FLEX_ARRAY];
336 extern struct merge_remote_desc *merge_remote_util(struct commit *);
337 extern void set_merge_remote_desc(struct commit *commit,
338 const char *name, struct object *obj);
341 * Given "name" from the command line to merge, find the commit object
342 * and return it, while storing merge_remote_desc in its ->util field,
343 * to allow callers to tell if we are told to merge a tag.
345 struct commit *get_merge_parent(const char *name);
347 extern int parse_signed_commit(const struct commit *commit,
348 struct strbuf *message, struct strbuf *signature);
349 extern int remove_signature(struct strbuf *buf);
352 * Check the signature of the given commit. The result of the check is stored
353 * in sig->check_result, 'G' for a good signature, 'U' for a good signature
354 * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
355 * at all. This may allocate memory for sig->gpg_output, sig->gpg_status,
356 * sig->signer and sig->key.
358 extern int check_commit_signature(const struct commit *commit, struct signature_check *sigc);
360 int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused);
361 int compare_commits_by_gen_then_commit_date(const void *a_, const void *b_, void *unused);
363 LAST_ARG_MUST_BE_NULL
364 extern int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...);
366 #endif /* COMMIT_H */