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