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