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