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