Merge branch 'km/doc-workflows-typofix'
[git/debian.git] / commit.h
blobc3af512f8b1b90b3963d0921f7ec0d0a43a2fcbe
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
14 struct commit_list {
15 struct commit *item;
16 struct commit_list *next;
19 struct commit {
20 struct object object;
21 void *util;
22 timestamp_t date;
23 struct commit_list *parents;
26 * If the commit is loaded from the commit-graph file, then this
27 * member may be NULL. Only access it through get_commit_tree()
28 * or get_commit_tree_oid().
30 struct tree *maybe_tree;
31 uint32_t graph_pos;
32 unsigned int index;
35 extern int save_commit_buffer;
36 extern const char *commit_type;
38 /* While we can decorate any object with a name, it's only used for commits.. */
39 struct name_decoration {
40 struct name_decoration *next;
41 int type;
42 char name[FLEX_ARRAY];
45 enum decoration_type {
46 DECORATION_NONE = 0,
47 DECORATION_REF_LOCAL,
48 DECORATION_REF_REMOTE,
49 DECORATION_REF_TAG,
50 DECORATION_REF_STASH,
51 DECORATION_REF_HEAD,
52 DECORATION_GRAFTED,
55 void add_name_decoration(enum decoration_type type, const char *name, struct object *obj);
56 const struct name_decoration *get_name_decoration(const struct object *obj);
58 struct commit *lookup_commit(const struct object_id *oid);
59 struct commit *lookup_commit_reference(const struct object_id *oid);
60 struct commit *lookup_commit_reference_gently(const struct object_id *oid,
61 int quiet);
62 struct commit *lookup_commit_reference_by_name(const char *name);
65 * Look up object named by "oid", dereference tag as necessary,
66 * get a commit and return it. If "oid" does not dereference to
67 * a commit, use ref_name to report an error and die.
69 struct commit *lookup_commit_or_die(const struct object_id *oid, const char *ref_name);
71 int parse_commit_buffer(struct commit *item, const void *buffer, unsigned long size);
72 int parse_commit_gently(struct commit *item, int quiet_on_missing);
73 static inline int parse_commit(struct commit *item)
75 return parse_commit_gently(item, 0);
77 void parse_commit_or_die(struct commit *item);
80 * Associate an object buffer with the commit. The ownership of the
81 * memory is handed over to the commit, and must be free()-able.
83 void set_commit_buffer(struct commit *, void *buffer, unsigned long size);
86 * Get any cached object buffer associated with the commit. Returns NULL
87 * if none. The resulting memory should not be freed.
89 const void *get_cached_commit_buffer(const struct commit *, unsigned long *size);
92 * Get the commit's object contents, either from cache or by reading the object
93 * from disk. The resulting memory should not be modified, and must be given
94 * to unuse_commit_buffer when the caller is done.
96 const void *get_commit_buffer(const struct commit *, unsigned long *size);
99 * Tell the commit subsytem that we are done with a particular commit buffer.
100 * The commit and buffer should be the input and return value, respectively,
101 * from an earlier call to get_commit_buffer. The buffer may or may not be
102 * freed by this call; callers should not access the memory afterwards.
104 void unuse_commit_buffer(const struct commit *, const void *buffer);
107 * Free any cached object buffer associated with the commit.
109 void free_commit_buffer(struct commit *);
111 struct tree *get_commit_tree(const struct commit *);
112 struct object_id *get_commit_tree_oid(const struct commit *);
115 * Disassociate any cached object buffer from the commit, but do not free it.
116 * The buffer (or NULL, if none) is returned.
118 const void *detach_commit_buffer(struct commit *, unsigned long *sizep);
120 /* Find beginning and length of commit subject. */
121 int find_commit_subject(const char *commit_buffer, const char **subject);
123 struct commit_list *commit_list_insert(struct commit *item,
124 struct commit_list **list);
125 struct commit_list **commit_list_append(struct commit *commit,
126 struct commit_list **next);
127 unsigned commit_list_count(const struct commit_list *l);
128 struct commit_list *commit_list_insert_by_date(struct commit *item,
129 struct commit_list **list);
130 void commit_list_sort_by_date(struct commit_list **list);
132 /* Shallow copy of the input list */
133 struct commit_list *copy_commit_list(struct commit_list *list);
135 void free_commit_list(struct commit_list *list);
137 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
139 extern int has_non_ascii(const char *text);
140 extern const char *logmsg_reencode(const struct commit *commit,
141 char **commit_encoding,
142 const char *output_encoding);
143 extern const char *skip_blank_lines(const char *msg);
145 /** Removes the first commit from a list sorted by date, and adds all
146 * of its parents.
148 struct commit *pop_most_recent_commit(struct commit_list **list,
149 unsigned int mark);
151 struct commit *pop_commit(struct commit_list **stack);
153 void clear_commit_marks(struct commit *commit, unsigned int mark);
154 void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark);
157 enum rev_sort_order {
158 REV_SORT_IN_GRAPH_ORDER = 0,
159 REV_SORT_BY_COMMIT_DATE,
160 REV_SORT_BY_AUTHOR_DATE
164 * Performs an in-place topological sort of list supplied.
166 * invariant of resulting list is:
167 * a reachable from b => ord(b) < ord(a)
168 * sort_order further specifies:
169 * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
170 * chain together.
171 * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
173 void sort_in_topological_order(struct commit_list **, enum rev_sort_order);
175 struct commit_graft {
176 struct object_id oid;
177 int nr_parent; /* < 0 if shallow commit */
178 struct object_id parent[FLEX_ARRAY]; /* more */
180 typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
182 struct commit_graft *read_graft_line(struct strbuf *line);
183 int register_commit_graft(struct commit_graft *, int);
184 struct commit_graft *lookup_commit_graft(const struct object_id *oid);
186 extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2);
187 extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos);
188 extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
190 /* To be used only when object flags after this call no longer matter */
191 extern struct commit_list *get_merge_bases_many_dirty(struct commit *one, int n, struct commit **twos);
193 /* largest positive number a signed 32-bit integer can contain */
194 #define INFINITE_DEPTH 0x7fffffff
196 struct oid_array;
197 struct ref;
198 extern int register_shallow(const struct object_id *oid);
199 extern int unregister_shallow(const struct object_id *oid);
200 extern int for_each_commit_graft(each_commit_graft_fn, void *);
201 extern int is_repository_shallow(void);
202 extern struct commit_list *get_shallow_commits(struct object_array *heads,
203 int depth, int shallow_flag, int not_shallow_flag);
204 extern struct commit_list *get_shallow_commits_by_rev_list(
205 int ac, const char **av, int shallow_flag, int not_shallow_flag);
206 extern void set_alternate_shallow_file(const char *path, int override);
207 extern int write_shallow_commits(struct strbuf *out, int use_pack_protocol,
208 const struct oid_array *extra);
209 extern void setup_alternate_shallow(struct lock_file *shallow_lock,
210 const char **alternate_shallow_file,
211 const struct oid_array *extra);
212 extern const char *setup_temporary_shallow(const struct oid_array *extra);
213 extern void advertise_shallow_grafts(int);
215 struct shallow_info {
216 struct oid_array *shallow;
217 int *ours, nr_ours;
218 int *theirs, nr_theirs;
219 struct oid_array *ref;
221 /* for receive-pack */
222 uint32_t **used_shallow;
223 int *need_reachability_test;
224 int *reachable;
225 int *shallow_ref;
226 struct commit **commits;
227 int nr_commits;
230 extern void prepare_shallow_info(struct shallow_info *, struct oid_array *);
231 extern void clear_shallow_info(struct shallow_info *);
232 extern void remove_nonexistent_theirs_shallow(struct shallow_info *);
233 extern void assign_shallow_commits_to_refs(struct shallow_info *info,
234 uint32_t **used,
235 int *ref_status);
236 extern int delayed_reachability_test(struct shallow_info *si, int c);
237 extern void prune_shallow(int show_only);
238 extern struct trace_key trace_shallow;
240 int is_descendant_of(struct commit *, struct commit_list *);
241 int in_merge_bases(struct commit *, struct commit *);
242 int in_merge_bases_many(struct commit *, int, struct commit **);
244 extern int interactive_add(int argc, const char **argv, const char *prefix, int patch);
245 extern int run_add_interactive(const char *revision, const char *patch_mode,
246 const struct pathspec *pathspec);
249 * Takes a list of commits and returns a new list where those
250 * have been removed that can be reached from other commits in
251 * the list. It is useful for, e.g., reducing the commits
252 * randomly thrown at the git-merge command and removing
253 * redundant commits that the user shouldn't have given to it.
255 * This function destroys the STALE bit of the commit objects'
256 * flags.
258 extern struct commit_list *reduce_heads(struct commit_list *heads);
261 * Like `reduce_heads()`, except it replaces the list. Use this
262 * instead of `foo = reduce_heads(foo);` to avoid memory leaks.
264 extern void reduce_heads_replace(struct commit_list **heads);
266 struct commit_extra_header {
267 struct commit_extra_header *next;
268 char *key;
269 char *value;
270 size_t len;
273 extern void append_merge_tag_headers(struct commit_list *parents,
274 struct commit_extra_header ***tail);
276 extern int commit_tree(const char *msg, size_t msg_len,
277 const struct object_id *tree,
278 struct commit_list *parents, struct object_id *ret,
279 const char *author, const char *sign_commit);
281 extern int commit_tree_extended(const char *msg, size_t msg_len,
282 const struct object_id *tree,
283 struct commit_list *parents,
284 struct object_id *ret, const char *author,
285 const char *sign_commit,
286 struct commit_extra_header *);
288 extern struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
290 extern void free_commit_extra_headers(struct commit_extra_header *extra);
293 * Search the commit object contents given by "msg" for the header "key".
294 * Returns a pointer to the start of the header contents, or NULL. The length
295 * of the header, up to the first newline, is returned via out_len.
297 * Note that some headers (like mergetag) may be multi-line. It is the caller's
298 * responsibility to parse further in this case!
300 extern const char *find_commit_header(const char *msg, const char *key,
301 size_t *out_len);
303 /* Find the end of the log message, the right place for a new trailer. */
304 extern int ignore_non_trailer(const char *buf, size_t len);
306 typedef int (*each_mergetag_fn)(struct commit *commit, struct commit_extra_header *extra,
307 void *cb_data);
309 extern int for_each_mergetag(each_mergetag_fn fn, struct commit *commit, void *data);
311 struct merge_remote_desc {
312 struct object *obj; /* the named object, could be a tag */
313 char name[FLEX_ARRAY];
315 #define merge_remote_util(commit) ((struct merge_remote_desc *)((commit)->util))
316 extern void set_merge_remote_desc(struct commit *commit,
317 const char *name, struct object *obj);
320 * Given "name" from the command line to merge, find the commit object
321 * and return it, while storing merge_remote_desc in its ->util field,
322 * to allow callers to tell if we are told to merge a tag.
324 struct commit *get_merge_parent(const char *name);
326 extern int parse_signed_commit(const struct commit *commit,
327 struct strbuf *message, struct strbuf *signature);
328 extern int remove_signature(struct strbuf *buf);
331 * Check the signature of the given commit. The result of the check is stored
332 * in sig->check_result, 'G' for a good signature, 'U' for a good signature
333 * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
334 * at all. This may allocate memory for sig->gpg_output, sig->gpg_status,
335 * sig->signer and sig->key.
337 extern int check_commit_signature(const struct commit *commit, struct signature_check *sigc);
339 int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused);
341 LAST_ARG_MUST_BE_NULL
342 extern int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...);
344 #endif /* COMMIT_H */