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