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