Merge branch 'dl/honor-cflags-in-hdr-check'
[git/git.git] / commit.h
1 #ifndef COMMIT_H
2 #define COMMIT_H
3
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"
11 #include "commit-slab.h"
12
13 #define COMMIT_NOT_FROM_GRAPH 0xFFFFFFFF
14 #define GENERATION_NUMBER_INFINITY 0xFFFFFFFF
15 #define GENERATION_NUMBER_MAX 0x3FFFFFFF
16 #define GENERATION_NUMBER_ZERO 0
17
18 struct commit_list {
19 struct commit *item;
20 struct commit_list *next;
21 };
22
23 /*
24 * The size of this struct matters in full repo walk operations like
25 * 'git clone' or 'git gc'. Consider using commit-slab to attach data
26 * to a commit instead of adding new fields here.
27 */
28 struct commit {
29 struct object object;
30 timestamp_t date;
31 struct commit_list *parents;
32
33 /*
34 * If the commit is loaded from the commit-graph file, then this
35 * member may be NULL. Only access it through repo_get_commit_tree()
36 * or get_commit_tree_oid().
37 */
38 struct tree *maybe_tree;
39 uint32_t graph_pos;
40 uint32_t generation;
41 unsigned int index;
42 };
43
44 extern int save_commit_buffer;
45 extern const char *commit_type;
46
47 /* While we can decorate any object with a name, it's only used for commits.. */
48 struct name_decoration {
49 struct name_decoration *next;
50 int type;
51 char name[FLEX_ARRAY];
52 };
53
54 enum decoration_type {
55 DECORATION_NONE = 0,
56 DECORATION_REF_LOCAL,
57 DECORATION_REF_REMOTE,
58 DECORATION_REF_TAG,
59 DECORATION_REF_STASH,
60 DECORATION_REF_HEAD,
61 DECORATION_GRAFTED,
62 };
63
64 void add_name_decoration(enum decoration_type type, const char *name, struct object *obj);
65 const struct name_decoration *get_name_decoration(const struct object *obj);
66
67 struct commit *lookup_commit(struct repository *r, const struct object_id *oid);
68 struct commit *lookup_commit_reference(struct repository *r,
69 const struct object_id *oid);
70 struct commit *lookup_commit_reference_gently(struct repository *r,
71 const struct object_id *oid,
72 int quiet);
73 struct commit *lookup_commit_reference_by_name(const char *name);
74
75 /*
76 * Look up object named by "oid", dereference tag as necessary,
77 * get a commit and return it. If "oid" does not dereference to
78 * a commit, use ref_name to report an error and die.
79 */
80 struct commit *lookup_commit_or_die(const struct object_id *oid, const char *ref_name);
81
82 int parse_commit_buffer(struct repository *r, struct commit *item, const void *buffer, unsigned long size, int check_graph);
83 int repo_parse_commit_internal(struct repository *r, struct commit *item,
84 int quiet_on_missing, int use_commit_graph);
85 int repo_parse_commit_gently(struct repository *r,
86 struct commit *item,
87 int quiet_on_missing);
88 static inline int repo_parse_commit(struct repository *r, struct commit *item)
89 {
90 return repo_parse_commit_gently(r, item, 0);
91 }
92
93 static inline int parse_commit_no_graph(struct commit *commit)
94 {
95 return repo_parse_commit_internal(the_repository, commit, 0, 0);
96 }
97
98 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
99 #define parse_commit_internal(item, quiet, use) repo_parse_commit_internal(the_repository, item, quiet, use)
100 #define parse_commit_gently(item, quiet) repo_parse_commit_gently(the_repository, item, quiet)
101 #define parse_commit(item) repo_parse_commit(the_repository, item)
102 #endif
103
104 void parse_commit_or_die(struct commit *item);
105
106 struct buffer_slab;
107 struct buffer_slab *allocate_commit_buffer_slab(void);
108 void free_commit_buffer_slab(struct buffer_slab *bs);
109
110 /*
111 * Associate an object buffer with the commit. The ownership of the
112 * memory is handed over to the commit, and must be free()-able.
113 */
114 void set_commit_buffer(struct repository *r, struct commit *, void *buffer, unsigned long size);
115
116 /*
117 * Get any cached object buffer associated with the commit. Returns NULL
118 * if none. The resulting memory should not be freed.
119 */
120 const void *get_cached_commit_buffer(struct repository *, const struct commit *, unsigned long *size);
121
122 /*
123 * Get the commit's object contents, either from cache or by reading the object
124 * from disk. The resulting memory should not be modified, and must be given
125 * to unuse_commit_buffer when the caller is done.
126 */
127 const void *repo_get_commit_buffer(struct repository *r,
128 const struct commit *,
129 unsigned long *size);
130 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
131 #define get_commit_buffer(c, s) repo_get_commit_buffer(the_repository, c, s)
132 #endif
133
134 /*
135 * Tell the commit subsytem that we are done with a particular commit buffer.
136 * The commit and buffer should be the input and return value, respectively,
137 * from an earlier call to get_commit_buffer. The buffer may or may not be
138 * freed by this call; callers should not access the memory afterwards.
139 */
140 void repo_unuse_commit_buffer(struct repository *r,
141 const struct commit *,
142 const void *buffer);
143 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
144 #define unuse_commit_buffer(c, b) repo_unuse_commit_buffer(the_repository, c, b)
145 #endif
146
147 /*
148 * Free any cached object buffer associated with the commit.
149 */
150 void free_commit_buffer(struct parsed_object_pool *pool, struct commit *);
151
152 struct tree *repo_get_commit_tree(struct repository *, const struct commit *);
153 #define get_commit_tree(c) repo_get_commit_tree(the_repository, c)
154 struct object_id *get_commit_tree_oid(const struct commit *);
155
156 /*
157 * Release memory related to a commit, including the parent list and
158 * any cached object buffer.
159 */
160 void release_commit_memory(struct parsed_object_pool *pool, struct commit *c);
161
162 /*
163 * Disassociate any cached object buffer from the commit, but do not free it.
164 * The buffer (or NULL, if none) is returned.
165 */
166 const void *detach_commit_buffer(struct commit *, unsigned long *sizep);
167
168 /* Find beginning and length of commit subject. */
169 int find_commit_subject(const char *commit_buffer, const char **subject);
170
171 struct commit_list *commit_list_insert(struct commit *item,
172 struct commit_list **list);
173 struct commit_list **commit_list_append(struct commit *commit,
174 struct commit_list **next);
175 unsigned commit_list_count(const struct commit_list *l);
176 struct commit_list *commit_list_insert_by_date(struct commit *item,
177 struct commit_list **list);
178 void commit_list_sort_by_date(struct commit_list **list);
179
180 /* Shallow copy of the input list */
181 struct commit_list *copy_commit_list(struct commit_list *list);
182
183 void free_commit_list(struct commit_list *list);
184
185 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
186
187 int has_non_ascii(const char *text);
188 const char *logmsg_reencode(const struct commit *commit,
189 char **commit_encoding,
190 const char *output_encoding);
191 const char *repo_logmsg_reencode(struct repository *r,
192 const struct commit *commit,
193 char **commit_encoding,
194 const char *output_encoding);
195 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
196 #define logmsg_reencode(c, enc, out) repo_logmsg_reencode(the_repository, c, enc, out)
197 #endif
198
199 const char *skip_blank_lines(const char *msg);
200
201 /** Removes the first commit from a list sorted by date, and adds all
202 * of its parents.
203 **/
204 struct commit *pop_most_recent_commit(struct commit_list **list,
205 unsigned int mark);
206
207 struct commit *pop_commit(struct commit_list **stack);
208
209 void clear_commit_marks(struct commit *commit, unsigned int mark);
210 void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark);
211
212
213 enum rev_sort_order {
214 REV_SORT_IN_GRAPH_ORDER = 0,
215 REV_SORT_BY_COMMIT_DATE,
216 REV_SORT_BY_AUTHOR_DATE
217 };
218
219 /*
220 * Performs an in-place topological sort of list supplied.
221 *
222 * invariant of resulting list is:
223 * a reachable from b => ord(b) < ord(a)
224 * sort_order further specifies:
225 * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
226 * chain together.
227 * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
228 */
229 void sort_in_topological_order(struct commit_list **, enum rev_sort_order);
230
231 struct commit_graft {
232 struct object_id oid;
233 int nr_parent; /* < 0 if shallow commit */
234 struct object_id parent[FLEX_ARRAY]; /* more */
235 };
236 typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
237
238 struct commit_graft *read_graft_line(struct strbuf *line);
239 int register_commit_graft(struct repository *r, struct commit_graft *, int);
240 void prepare_commit_graft(struct repository *r);
241 struct commit_graft *lookup_commit_graft(struct repository *r, const struct object_id *oid);
242
243 struct commit *get_fork_point(const char *refname, struct commit *commit);
244
245 /* largest positive number a signed 32-bit integer can contain */
246 #define INFINITE_DEPTH 0x7fffffff
247
248 struct oid_array;
249 struct ref;
250 int register_shallow(struct repository *r, const struct object_id *oid);
251 int unregister_shallow(const struct object_id *oid);
252 int for_each_commit_graft(each_commit_graft_fn, void *);
253 int is_repository_shallow(struct repository *r);
254 struct commit_list *get_shallow_commits(struct object_array *heads,
255 int depth, int shallow_flag, int not_shallow_flag);
256 struct commit_list *get_shallow_commits_by_rev_list(
257 int ac, const char **av, int shallow_flag, int not_shallow_flag);
258 void set_alternate_shallow_file(struct repository *r, const char *path, int override);
259 int write_shallow_commits(struct strbuf *out, int use_pack_protocol,
260 const struct oid_array *extra);
261 void setup_alternate_shallow(struct lock_file *shallow_lock,
262 const char **alternate_shallow_file,
263 const struct oid_array *extra);
264 const char *setup_temporary_shallow(const struct oid_array *extra);
265 void advertise_shallow_grafts(int);
266
267 /*
268 * Initialize with prepare_shallow_info() or zero-initialize (equivalent to
269 * prepare_shallow_info with a NULL oid_array).
270 */
271 struct shallow_info {
272 struct oid_array *shallow;
273 int *ours, nr_ours;
274 int *theirs, nr_theirs;
275 struct oid_array *ref;
276
277 /* for receive-pack */
278 uint32_t **used_shallow;
279 int *need_reachability_test;
280 int *reachable;
281 int *shallow_ref;
282 struct commit **commits;
283 int nr_commits;
284 };
285
286 void prepare_shallow_info(struct shallow_info *, struct oid_array *);
287 void clear_shallow_info(struct shallow_info *);
288 void remove_nonexistent_theirs_shallow(struct shallow_info *);
289 void assign_shallow_commits_to_refs(struct shallow_info *info,
290 uint32_t **used,
291 int *ref_status);
292 int delayed_reachability_test(struct shallow_info *si, int c);
293 #define PRUNE_SHOW_ONLY 1
294 #define PRUNE_QUICK 2
295 void prune_shallow(unsigned options);
296 extern struct trace_key trace_shallow;
297
298 int interactive_add(int argc, const char **argv, const char *prefix, int patch);
299 int run_add_interactive(const char *revision, const char *patch_mode,
300 const struct pathspec *pathspec);
301
302 struct commit_extra_header {
303 struct commit_extra_header *next;
304 char *key;
305 char *value;
306 size_t len;
307 };
308
309 void append_merge_tag_headers(struct commit_list *parents,
310 struct commit_extra_header ***tail);
311
312 int commit_tree(const char *msg, size_t msg_len,
313 const struct object_id *tree,
314 struct commit_list *parents, struct object_id *ret,
315 const char *author, const char *sign_commit);
316
317 int commit_tree_extended(const char *msg, size_t msg_len,
318 const struct object_id *tree,
319 struct commit_list *parents,
320 struct object_id *ret, const char *author,
321 const char *sign_commit,
322 struct commit_extra_header *);
323
324 struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
325
326 void free_commit_extra_headers(struct commit_extra_header *extra);
327
328 /*
329 * Search the commit object contents given by "msg" for the header "key".
330 * Returns a pointer to the start of the header contents, or NULL. The length
331 * of the header, up to the first newline, is returned via out_len.
332 *
333 * Note that some headers (like mergetag) may be multi-line. It is the caller's
334 * responsibility to parse further in this case!
335 */
336 const char *find_commit_header(const char *msg, const char *key,
337 size_t *out_len);
338
339 /* Find the end of the log message, the right place for a new trailer. */
340 size_t ignore_non_trailer(const char *buf, size_t len);
341
342 typedef int (*each_mergetag_fn)(struct commit *commit, struct commit_extra_header *extra,
343 void *cb_data);
344
345 int for_each_mergetag(each_mergetag_fn fn, struct commit *commit, void *data);
346
347 struct merge_remote_desc {
348 struct object *obj; /* the named object, could be a tag */
349 char name[FLEX_ARRAY];
350 };
351 struct merge_remote_desc *merge_remote_util(struct commit *);
352 void set_merge_remote_desc(struct commit *commit,
353 const char *name, struct object *obj);
354
355 /*
356 * Given "name" from the command line to merge, find the commit object
357 * and return it, while storing merge_remote_desc in its ->util field,
358 * to allow callers to tell if we are told to merge a tag.
359 */
360 struct commit *get_merge_parent(const char *name);
361
362 int parse_signed_commit(const struct commit *commit,
363 struct strbuf *message, struct strbuf *signature);
364 int remove_signature(struct strbuf *buf);
365
366 /*
367 * Check the signature of the given commit. The result of the check is stored
368 * in sig->check_result, 'G' for a good signature, 'U' for a good signature
369 * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
370 * at all. This may allocate memory for sig->gpg_output, sig->gpg_status,
371 * sig->signer and sig->key.
372 */
373 int check_commit_signature(const struct commit *commit, struct signature_check *sigc);
374
375 /* record author-date for each commit object */
376 struct author_date_slab;
377 void record_author_date(struct author_date_slab *author_date,
378 struct commit *commit);
379
380 int compare_commits_by_author_date(const void *a_, const void *b_, void *unused);
381
382 /*
383 * Verify a single commit with check_commit_signature() and die() if it is not
384 * a good signature. This isn't really suitable for general use, but is a
385 * helper to implement consistent logic for pull/merge --verify-signatures.
386 */
387 void verify_merge_signature(struct commit *commit, int verbose);
388
389 int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused);
390 int compare_commits_by_gen_then_commit_date(const void *a_, const void *b_, void *unused);
391
392 LAST_ARG_MUST_BE_NULL
393 int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...);
394
395 #endif /* COMMIT_H */