freshlybakedca.ke
Git fork
1#ifndef COMMIT_H
2#define COMMIT_H
3
4#include "object.h"
5#include "add-interactive.h"
6
7struct signature_check;
8struct strbuf;
9struct tree;
10
11#define COMMIT_NOT_FROM_GRAPH 0xFFFFFFFF
12#define GENERATION_NUMBER_INFINITY ((1ULL << 63) - 1)
13#define GENERATION_NUMBER_V1_MAX 0x3FFFFFFF
14#define GENERATION_NUMBER_ZERO 0
15#define GENERATION_NUMBER_V2_OFFSET_MAX ((1ULL << 31) - 1)
16
17struct commit_list {
18 struct commit *item;
19 struct commit_list *next;
20};
21
22/*
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.
26 */
27struct commit {
28 struct object object;
29 timestamp_t date;
30 struct commit_list *parents;
31
32 /*
33 * If the commit is loaded from the commit-graph file, then this
34 * member may be NULL. Only access it through repo_get_commit_tree()
35 * or get_commit_tree_oid().
36 */
37 struct tree *maybe_tree;
38 unsigned int index;
39};
40
41extern int save_commit_buffer;
42extern int no_graft_file_deprecated_advice;
43extern const char *commit_type;
44
45/* While we can decorate any object with a name, it's only used for commits.. */
46struct name_decoration {
47 struct name_decoration *next;
48 int type;
49 char name[FLEX_ARRAY];
50};
51
52enum decoration_type {
53 DECORATION_NONE = 0,
54 DECORATION_REF_LOCAL,
55 DECORATION_REF_REMOTE,
56 DECORATION_REF_TAG,
57 DECORATION_REF_STASH,
58 DECORATION_REF_HEAD,
59 DECORATION_GRAFTED,
60};
61
62void add_name_decoration(enum decoration_type type, const char *name, struct object *obj);
63const struct name_decoration *get_name_decoration(const struct object *obj);
64
65/*
66 * Look up commit named by "oid" respecting replacement objects.
67 * Returns NULL if "oid" is not a commit or does not exist.
68 */
69struct commit *lookup_commit_object(struct repository *r, const struct object_id *oid);
70
71/*
72 * Look up commit named by "oid" without replacement objects or
73 * checking for object existence. Returns the requested commit if it
74 * is found in the object cache, NULL if "oid" is in the object cache
75 * but is not a commit and a newly allocated unparsed commit object if
76 * "oid" is not in the object cache.
77 */
78struct commit *lookup_commit(struct repository *r, const struct object_id *oid);
79struct commit *lookup_commit_reference(struct repository *r,
80 const struct object_id *oid);
81struct commit *lookup_commit_reference_gently(struct repository *r,
82 const struct object_id *oid,
83 int quiet);
84struct commit *lookup_commit_reference_by_name(const char *name);
85struct commit *lookup_commit_reference_by_name_gently(const char *name,
86 int quiet);
87
88/*
89 * Look up object named by "oid", dereference tag as necessary,
90 * get a commit and return it. If "oid" does not dereference to
91 * a commit, use ref_name to report an error and die.
92 */
93struct commit *lookup_commit_or_die(const struct object_id *oid, const char *ref_name);
94
95int parse_commit_buffer(struct repository *r, struct commit *item, const void *buffer, unsigned long size, int check_graph);
96int repo_parse_commit_internal(struct repository *r, struct commit *item,
97 int quiet_on_missing, int use_commit_graph);
98int repo_parse_commit_gently(struct repository *r,
99 struct commit *item,
100 int quiet_on_missing);
101static inline int repo_parse_commit(struct repository *r, struct commit *item)
102{
103 return repo_parse_commit_gently(r, item, 0);
104}
105
106static inline int repo_parse_commit_no_graph(struct repository *r,
107 struct commit *commit)
108{
109 return repo_parse_commit_internal(r, commit, 0, 0);
110}
111
112void parse_commit_or_die(struct commit *item);
113
114void unparse_commit(struct repository *r, const struct object_id *oid);
115
116struct buffer_slab;
117struct buffer_slab *allocate_commit_buffer_slab(void);
118void free_commit_buffer_slab(struct buffer_slab *bs);
119
120/*
121 * Associate an object buffer with the commit. The ownership of the
122 * memory is handed over to the commit, and must be free()-able.
123 */
124void set_commit_buffer(struct repository *r, struct commit *, void *buffer, unsigned long size);
125
126/*
127 * Get any cached object buffer associated with the commit. Returns NULL
128 * if none. The resulting memory should not be freed.
129 */
130const void *get_cached_commit_buffer(struct repository *, const struct commit *, unsigned long *size);
131
132/*
133 * Get the commit's object contents, either from cache or by reading the object
134 * from disk. The resulting memory should not be modified, and must be given
135 * to repo_unuse_commit_buffer when the caller is done.
136 */
137const void *repo_get_commit_buffer(struct repository *r,
138 const struct commit *,
139 unsigned long *size);
140
141/*
142 * Tell the commit subsystem that we are done with a particular commit buffer.
143 * The commit and buffer should be the input and return value, respectively,
144 * from an earlier call to repo_get_commit_buffer. The buffer may or may not be
145 * freed by this call; callers should not access the memory afterwards.
146 */
147void repo_unuse_commit_buffer(struct repository *r,
148 const struct commit *,
149 const void *buffer);
150
151/*
152 * Free any cached object buffer associated with the commit.
153 */
154void free_commit_buffer(struct parsed_object_pool *pool, struct commit *);
155
156struct tree *repo_get_commit_tree(struct repository *, const struct commit *);
157struct object_id *get_commit_tree_oid(const struct commit *);
158
159/*
160 * Release memory related to a commit, including the parent list and
161 * any cached object buffer.
162 */
163void release_commit_memory(struct parsed_object_pool *pool, struct commit *c);
164
165/*
166 * Disassociate any cached object buffer from the commit, but do not free it.
167 * The buffer (or NULL, if none) is returned.
168 */
169const void *detach_commit_buffer(struct commit *, unsigned long *sizep);
170
171/* Find beginning and length of commit subject. */
172int find_commit_subject(const char *commit_buffer, const char **subject);
173
174/* Return length of the commit subject from commit log message. */
175size_t commit_subject_length(const char *body);
176
177struct commit_list *commit_list_insert(struct commit *item,
178 struct commit_list **list);
179int commit_list_contains(struct commit *item,
180 struct commit_list *list);
181struct commit_list **commit_list_append(struct commit *commit,
182 struct commit_list **next);
183unsigned commit_list_count(const struct commit_list *l);
184struct commit_list *commit_list_insert_by_date(struct commit *item,
185 struct commit_list **list);
186void commit_list_sort_by_date(struct commit_list **list);
187
188/* Shallow copy of the input list */
189struct commit_list *copy_commit_list(const struct commit_list *list);
190
191/* Modify list in-place to reverse it, returning new head; list will be tail */
192struct commit_list *reverse_commit_list(struct commit_list *list);
193
194void free_commit_list(struct commit_list *list);
195
196struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
197
198const char *repo_logmsg_reencode(struct repository *r,
199 const struct commit *commit,
200 char **commit_encoding,
201 const char *output_encoding);
202
203const char *skip_blank_lines(const char *msg);
204
205struct prio_queue;
206
207/* Removes the first commit from a prio_queue and adds its parents. */
208struct commit *pop_most_recent_commit(struct prio_queue *queue,
209 unsigned int mark);
210
211struct commit *pop_commit(struct commit_list **stack);
212
213void clear_commit_marks(struct commit *commit, unsigned int mark);
214void clear_commit_marks_many(size_t nr, struct commit **commit, unsigned int mark);
215
216
217enum rev_sort_order {
218 REV_SORT_IN_GRAPH_ORDER = 0,
219 REV_SORT_BY_COMMIT_DATE,
220 REV_SORT_BY_AUTHOR_DATE
221};
222
223/*
224 * Performs an in-place topological sort of list supplied.
225 *
226 * invariant of resulting list is:
227 * a reachable from b => ord(b) < ord(a)
228 * sort_order further specifies:
229 * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
230 * chain together.
231 * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
232 */
233void sort_in_topological_order(struct commit_list **, enum rev_sort_order);
234
235struct commit_graft {
236 struct object_id oid;
237 int nr_parent; /* < 0 if shallow commit */
238 struct object_id parent[FLEX_ARRAY]; /* more */
239};
240typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
241
242struct commit_graft *read_graft_line(struct strbuf *line);
243/* commit_graft_pos returns an index into r->parsed_objects->grafts. */
244int commit_graft_pos(struct repository *r, const struct object_id *oid);
245int register_commit_graft(struct repository *r, struct commit_graft *, int);
246void prepare_commit_graft(struct repository *r);
247struct commit_graft *lookup_commit_graft(struct repository *r, const struct object_id *oid);
248
249struct commit *get_fork_point(const char *refname, struct commit *commit);
250
251/* largest positive number a signed 32-bit integer can contain */
252#define INFINITE_DEPTH 0x7fffffff
253
254struct oid_array;
255struct ref;
256int for_each_commit_graft(each_commit_graft_fn, void *);
257
258int interactive_add(struct repository *repo,
259 const char **argv,
260 const char *prefix,
261 int patch, struct add_p_opt *add_p_opt);
262
263struct commit_extra_header {
264 struct commit_extra_header *next;
265 char *key;
266 char *value;
267 size_t len;
268};
269
270void append_merge_tag_headers(const struct commit_list *parents,
271 struct commit_extra_header ***tail);
272
273int commit_tree(const char *msg, size_t msg_len,
274 const struct object_id *tree,
275 const struct commit_list *parents, struct object_id *ret,
276 const char *author, const char *sign_commit);
277
278int commit_tree_extended(const char *msg, size_t msg_len,
279 const struct object_id *tree,
280 const struct commit_list *parents, struct object_id *ret,
281 const char *author, const char *committer,
282 const char *sign_commit, const struct commit_extra_header *);
283
284struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
285
286void free_commit_extra_headers(struct commit_extra_header *extra);
287
288/*
289 * Search the commit object contents given by "msg" for the header "key".
290 * Returns a pointer to the start of the header contents, or NULL. The length
291 * of the header, up to the first newline, is returned via out_len.
292 *
293 * Note that some headers (like mergetag) may be multi-line. It is the caller's
294 * responsibility to parse further in this case!
295 */
296const char *find_commit_header(const char *msg, const char *key,
297 size_t *out_len);
298
299/* Find the number of bytes to ignore from the end of a log message. */
300size_t ignored_log_message_bytes(const char *buf, size_t len);
301
302typedef int (*each_mergetag_fn)(struct commit *commit, struct commit_extra_header *extra,
303 void *cb_data);
304
305int for_each_mergetag(each_mergetag_fn fn, struct commit *commit, void *data);
306
307struct merge_remote_desc {
308 struct object *obj; /* the named object, could be a tag */
309 char name[FLEX_ARRAY];
310};
311struct merge_remote_desc *merge_remote_util(const struct commit *);
312void set_merge_remote_desc(struct commit *commit,
313 const char *name, struct object *obj);
314
315/*
316 * Given "name" from the command line to merge, find the commit object
317 * and return it, while storing merge_remote_desc in its ->util field,
318 * to allow callers to tell if we are told to merge a tag.
319 */
320struct commit *get_merge_parent(const char *name);
321
322int parse_signed_commit(const struct commit *commit,
323 struct strbuf *message, struct strbuf *signature,
324 const struct git_hash_algo *algop);
325int remove_signature(struct strbuf *buf);
326
327/*
328 * Check the signature of the given commit. The result of the check is stored
329 * in sig->check_result, 'G' for a good signature, 'U' for a good signature
330 * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
331 * at all. This may allocate memory for sig->gpg_output, sig->gpg_status,
332 * sig->signer and sig->key.
333 */
334int check_commit_signature(const struct commit *commit, struct signature_check *sigc);
335
336/* record author-date for each commit object */
337struct author_date_slab;
338void record_author_date(struct author_date_slab *author_date,
339 struct commit *commit);
340
341int compare_commits_by_author_date(const void *a_, const void *b_, void *unused);
342
343/*
344 * Verify a single commit with check_commit_signature() and die() if it is not
345 * a good signature. This isn't really suitable for general use, but is a
346 * helper to implement consistent logic for pull/merge --verify-signatures.
347 *
348 * The check_trust parameter is meant for backward-compatibility. The GPG
349 * interface verifies key trust with a default trust level that is below the
350 * default trust level for merge operations. Its value should be non-zero if
351 * the user hasn't set a minimum trust level explicitly in their configuration.
352 *
353 * If the user has set a minimum trust level, then that value should be obeyed
354 * and check_trust should be zero, even if the configured trust level is below
355 * the default trust level for merges.
356 */
357void verify_merge_signature(struct commit *commit, int verbose,
358 int check_trust);
359
360int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused);
361int compare_commits_by_gen_then_commit_date(const void *a_, const void *b_, void *unused);
362
363LAST_ARG_MUST_BE_NULL
364int run_commit_hook(int editor_is_used, const char *index_file,
365 int *invoked_hook, const char *name, ...);
366
367/* Sign a commit or tag buffer, storing the result in a header. */
368int sign_with_header(struct strbuf *buf, const char *keyid);
369/* Parse the signature out of a header. */
370int parse_buffer_signed_by_header(const char *buffer,
371 unsigned long size,
372 struct strbuf *payload,
373 struct strbuf *signature,
374 const struct git_hash_algo *algop);
375int add_header_signature(struct strbuf *buf, struct strbuf *sig, const struct git_hash_algo *algo);
376
377#endif /* COMMIT_H */