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