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 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 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 get_commit_tree() 35 * or get_commit_tree_oid(). 36 */ 37 struct tree *maybe_tree; 38 uint32_t graph_pos; 39 uint32_t generation; 40 unsigned int index; 41}; 42 43extern int save_commit_buffer; 44extern const char *commit_type; 45 46/* While we can decorate any object with a name, it's only used for commits.. */ 47struct name_decoration { 48 struct name_decoration *next; 49 int type; 50 char name[FLEX_ARRAY]; 51}; 52 53enum 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, 61}; 62 63void add_name_decoration(enum decoration_type type, const char *name, struct object *obj); 64const struct name_decoration *get_name_decoration(const struct object *obj); 65 66#define lookup_commit(r, o) lookup_commit_##r(o) 67struct commit *lookup_commit_the_repository(const struct object_id *oid); 68#define lookup_commit_reference(r, o) \ 69 lookup_commit_reference_##r(o) 70struct commit *lookup_commit_reference_the_repository(const struct object_id *oid); 71#define lookup_commit_reference_gently(r, o, q) \ 72 lookup_commit_reference_gently_##r(o, q) 73struct commit *lookup_commit_reference_gently_the_repository( 74 const struct object_id *oid, 75 int quiet); 76struct commit *lookup_commit_reference_by_name(const char *name); 77 78/* 79 * Look up object named by "oid", dereference tag as necessary, 80 * get a commit and return it. If "oid" does not dereference to 81 * a commit, use ref_name to report an error and die. 82 */ 83struct commit *lookup_commit_or_die(const struct object_id *oid, const char *ref_name); 84 85#define parse_commit_buffer(r, i, b, s, g) parse_commit_buffer_##r(i, b, s, g) 86int parse_commit_buffer_the_repository(struct commit *item, const void *buffer, unsigned long size, int check_graph); 87int parse_commit_gently(struct commit *item, int quiet_on_missing); 88static inline int parse_commit(struct commit *item) 89{ 90 return parse_commit_gently(item, 0); 91} 92void parse_commit_or_die(struct commit *item); 93 94/* 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. 97 */ 98#define set_commit_buffer(r, c, b, s) set_commit_buffer_##r(c, b, s) 99void set_commit_buffer_the_repository(struct commit *, void *buffer, unsigned long size); 100 101/* 102 * Get any cached object buffer associated with the commit. Returns NULL 103 * if none. The resulting memory should not be freed. 104 */ 105const void *get_cached_commit_buffer(const struct commit *, unsigned long *size); 106 107/* 108 * Get the commit's object contents, either from cache or by reading the object 109 * from disk. The resulting memory should not be modified, and must be given 110 * to unuse_commit_buffer when the caller is done. 111 */ 112const void *get_commit_buffer(const struct commit *, unsigned long *size); 113 114/* 115 * Tell the commit subsytem that we are done with a particular commit buffer. 116 * The commit and buffer should be the input and return value, respectively, 117 * from an earlier call to get_commit_buffer. The buffer may or may not be 118 * freed by this call; callers should not access the memory afterwards. 119 */ 120void unuse_commit_buffer(const struct commit *, const void *buffer); 121 122/* 123 * Free any cached object buffer associated with the commit. 124 */ 125void free_commit_buffer(struct commit *); 126 127struct tree *get_commit_tree(const struct commit *); 128struct object_id *get_commit_tree_oid(const struct commit *); 129 130/* 131 * Release memory related to a commit, including the parent list and 132 * any cached object buffer. 133 */ 134void release_commit_memory(struct commit *c); 135 136/* 137 * Disassociate any cached object buffer from the commit, but do not free it. 138 * The buffer (or NULL, if none) is returned. 139 */ 140const void *detach_commit_buffer(struct commit *, unsigned long *sizep); 141 142/* Find beginning and length of commit subject. */ 143int find_commit_subject(const char *commit_buffer, const char **subject); 144 145struct commit_list *commit_list_insert(struct commit *item, 146 struct commit_list **list); 147struct commit_list **commit_list_append(struct commit *commit, 148 struct commit_list **next); 149unsigned commit_list_count(const struct commit_list *l); 150struct commit_list *commit_list_insert_by_date(struct commit *item, 151 struct commit_list **list); 152void commit_list_sort_by_date(struct commit_list **list); 153 154/* Shallow copy of the input list */ 155struct commit_list *copy_commit_list(struct commit_list *list); 156 157void free_commit_list(struct commit_list *list); 158 159struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */ 160 161extern int has_non_ascii(const char *text); 162extern const char *logmsg_reencode(const struct commit *commit, 163 char **commit_encoding, 164 const char *output_encoding); 165extern const char *skip_blank_lines(const char *msg); 166 167/** Removes the first commit from a list sorted by date, and adds all 168 * of its parents. 169 **/ 170struct commit *pop_most_recent_commit(struct commit_list **list, 171 unsigned int mark); 172 173struct commit *pop_commit(struct commit_list **stack); 174 175void clear_commit_marks(struct commit *commit, unsigned int mark); 176void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark); 177 178 179enum rev_sort_order { 180 REV_SORT_IN_GRAPH_ORDER = 0, 181 REV_SORT_BY_COMMIT_DATE, 182 REV_SORT_BY_AUTHOR_DATE 183}; 184 185/* 186 * Performs an in-place topological sort of list supplied. 187 * 188 * invariant of resulting list is: 189 * a reachable from b => ord(b) < ord(a) 190 * sort_order further specifies: 191 * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent 192 * chain together. 193 * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order. 194 */ 195void sort_in_topological_order(struct commit_list **, enum rev_sort_order); 196 197struct commit_graft { 198 struct object_id oid; 199 int nr_parent; /* < 0 if shallow commit */ 200 struct object_id parent[FLEX_ARRAY]; /* more */ 201}; 202typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *); 203 204struct commit_graft *read_graft_line(struct strbuf *line); 205int register_commit_graft(struct repository *r, struct commit_graft *, int); 206struct commit_graft *lookup_commit_graft(struct repository *r, const struct object_id *oid); 207 208extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2); 209extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos); 210extern struct commit_list *get_octopus_merge_bases(struct commit_list *in); 211 212/* To be used only when object flags after this call no longer matter */ 213extern struct commit_list *get_merge_bases_many_dirty(struct commit *one, int n, struct commit **twos); 214 215/* largest positive number a signed 32-bit integer can contain */ 216#define INFINITE_DEPTH 0x7fffffff 217 218struct oid_array; 219struct ref; 220extern int register_shallow(struct repository *r, const struct object_id *oid); 221extern int unregister_shallow(const struct object_id *oid); 222extern int for_each_commit_graft(each_commit_graft_fn, void *); 223extern int is_repository_shallow(struct repository *r); 224extern struct commit_list *get_shallow_commits(struct object_array *heads, 225 int depth, int shallow_flag, int not_shallow_flag); 226extern struct commit_list *get_shallow_commits_by_rev_list( 227 int ac, const char **av, int shallow_flag, int not_shallow_flag); 228extern void set_alternate_shallow_file(struct repository *r, const char *path, int override); 229extern int write_shallow_commits(struct strbuf *out, int use_pack_protocol, 230 const struct oid_array *extra); 231extern void setup_alternate_shallow(struct lock_file *shallow_lock, 232 const char **alternate_shallow_file, 233 const struct oid_array *extra); 234extern const char *setup_temporary_shallow(const struct oid_array *extra); 235extern void advertise_shallow_grafts(int); 236 237struct shallow_info { 238 struct oid_array *shallow; 239 int *ours, nr_ours; 240 int *theirs, nr_theirs; 241 struct oid_array *ref; 242 243 /* for receive-pack */ 244 uint32_t **used_shallow; 245 int *need_reachability_test; 246 int *reachable; 247 int *shallow_ref; 248 struct commit **commits; 249 int nr_commits; 250}; 251 252extern void prepare_shallow_info(struct shallow_info *, struct oid_array *); 253extern void clear_shallow_info(struct shallow_info *); 254extern void remove_nonexistent_theirs_shallow(struct shallow_info *); 255extern void assign_shallow_commits_to_refs(struct shallow_info *info, 256 uint32_t **used, 257 int *ref_status); 258extern int delayed_reachability_test(struct shallow_info *si, int c); 259extern void prune_shallow(int show_only); 260extern struct trace_key trace_shallow; 261 262int is_descendant_of(struct commit *, struct commit_list *); 263int in_merge_bases(struct commit *, struct commit *); 264int in_merge_bases_many(struct commit *, int, struct commit **); 265 266extern int interactive_add(int argc, const char **argv, const char *prefix, int patch); 267extern int run_add_interactive(const char *revision, const char *patch_mode, 268 const struct pathspec *pathspec); 269 270/* 271 * Takes a list of commits and returns a new list where those 272 * have been removed that can be reached from other commits in 273 * the list. It is useful for, e.g., reducing the commits 274 * randomly thrown at the git-merge command and removing 275 * redundant commits that the user shouldn't have given to it. 276 * 277 * This function destroys the STALE bit of the commit objects' 278 * flags. 279 */ 280extern struct commit_list *reduce_heads(struct commit_list *heads); 281 282/* 283 * Like `reduce_heads()`, except it replaces the list. Use this 284 * instead of `foo = reduce_heads(foo);` to avoid memory leaks. 285 */ 286extern void reduce_heads_replace(struct commit_list **heads); 287 288struct commit_extra_header { 289 struct commit_extra_header *next; 290 char *key; 291 char *value; 292 size_t len; 293}; 294 295extern void append_merge_tag_headers(struct commit_list *parents, 296 struct commit_extra_header ***tail); 297 298extern int commit_tree(const char *msg, size_t msg_len, 299 const struct object_id *tree, 300 struct commit_list *parents, struct object_id *ret, 301 const char *author, const char *sign_commit); 302 303extern int commit_tree_extended(const char *msg, size_t msg_len, 304 const struct object_id *tree, 305 struct commit_list *parents, 306 struct object_id *ret, const char *author, 307 const char *sign_commit, 308 struct commit_extra_header *); 309 310extern struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **); 311 312extern void free_commit_extra_headers(struct commit_extra_header *extra); 313 314/* 315 * Search the commit object contents given by "msg" for the header "key". 316 * Returns a pointer to the start of the header contents, or NULL. The length 317 * of the header, up to the first newline, is returned via out_len. 318 * 319 * Note that some headers (like mergetag) may be multi-line. It is the caller's 320 * responsibility to parse further in this case! 321 */ 322extern const char *find_commit_header(const char *msg, const char *key, 323 size_t *out_len); 324 325/* Find the end of the log message, the right place for a new trailer. */ 326extern int ignore_non_trailer(const char *buf, size_t len); 327 328typedef int (*each_mergetag_fn)(struct commit *commit, struct commit_extra_header *extra, 329 void *cb_data); 330 331extern int for_each_mergetag(each_mergetag_fn fn, struct commit *commit, void *data); 332 333struct merge_remote_desc { 334 struct object *obj; /* the named object, could be a tag */ 335 char name[FLEX_ARRAY]; 336}; 337extern struct merge_remote_desc *merge_remote_util(struct commit *); 338extern void set_merge_remote_desc(struct commit *commit, 339 const char *name, struct object *obj); 340 341/* 342 * Given "name" from the command line to merge, find the commit object 343 * and return it, while storing merge_remote_desc in its ->util field, 344 * to allow callers to tell if we are told to merge a tag. 345 */ 346struct commit *get_merge_parent(const char *name); 347 348extern int parse_signed_commit(const struct commit *commit, 349 struct strbuf *message, struct strbuf *signature); 350extern int remove_signature(struct strbuf *buf); 351 352/* 353 * Check the signature of the given commit. The result of the check is stored 354 * in sig->check_result, 'G' for a good signature, 'U' for a good signature 355 * from an untrusted signer, 'B' for a bad signature and 'N' for no signature 356 * at all. This may allocate memory for sig->gpg_output, sig->gpg_status, 357 * sig->signer and sig->key. 358 */ 359extern int check_commit_signature(const struct commit *commit, struct signature_check *sigc); 360 361int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused); 362int compare_commits_by_gen_then_commit_date(const void *a_, const void *b_, void *unused); 363 364LAST_ARG_MUST_BE_NULL 365extern int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...); 366 367#endif /* COMMIT_H */