THIS IS A TEST INSTANCE ONLY! REPOSITORIES CAN BE DELETED AT ANY TIME!

Git Source Code Mirror - This is a publish-only repository and all pull requests are ignored. Please follow Documentation/SubmittingPatches procedure for any of your improvements.
git
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

396 lines
14KB

  1. #ifndef COMMIT_H
  2. #define COMMIT_H
  3. #include "object.h"
  4. #include "tree.h"
  5. #include "strbuf.h"
  6. #include "decorate.h"
  7. #include "gpg-interface.h"
  8. #include "string-list.h"
  9. #include "pretty.h"
  10. #include "commit-slab.h"
  11. #define COMMIT_NOT_FROM_GRAPH 0xFFFFFFFF
  12. #define GENERATION_NUMBER_INFINITY 0xFFFFFFFF
  13. #define GENERATION_NUMBER_MAX 0x3FFFFFFF
  14. #define GENERATION_NUMBER_ZERO 0
  15. struct commit_list {
  16. struct commit *item;
  17. struct commit_list *next;
  18. };
  19. /*
  20. * The size of this struct matters in full repo walk operations like
  21. * 'git clone' or 'git gc'. Consider using commit-slab to attach data
  22. * to a commit instead of adding new fields here.
  23. */
  24. struct commit {
  25. struct object object;
  26. timestamp_t date;
  27. struct commit_list *parents;
  28. /*
  29. * If the commit is loaded from the commit-graph file, then this
  30. * member may be NULL. Only access it through repo_get_commit_tree()
  31. * or get_commit_tree_oid().
  32. */
  33. struct tree *maybe_tree;
  34. uint32_t graph_pos;
  35. uint32_t generation;
  36. unsigned int index;
  37. };
  38. extern int save_commit_buffer;
  39. extern const char *commit_type;
  40. /* While we can decorate any object with a name, it's only used for commits.. */
  41. struct name_decoration {
  42. struct name_decoration *next;
  43. int type;
  44. char name[FLEX_ARRAY];
  45. };
  46. enum decoration_type {
  47. DECORATION_NONE = 0,
  48. DECORATION_REF_LOCAL,
  49. DECORATION_REF_REMOTE,
  50. DECORATION_REF_TAG,
  51. DECORATION_REF_STASH,
  52. DECORATION_REF_HEAD,
  53. DECORATION_GRAFTED,
  54. };
  55. void add_name_decoration(enum decoration_type type, const char *name, struct object *obj);
  56. const struct name_decoration *get_name_decoration(const struct object *obj);
  57. struct commit *lookup_commit(struct repository *r, const struct object_id *oid);
  58. struct commit *lookup_commit_reference(struct repository *r,
  59. const struct object_id *oid);
  60. struct commit *lookup_commit_reference_gently(struct repository *r,
  61. const struct object_id *oid,
  62. int quiet);
  63. struct commit *lookup_commit_reference_by_name(const char *name);
  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. */
  69. struct commit *lookup_commit_or_die(const struct object_id *oid, const char *ref_name);
  70. int parse_commit_buffer(struct repository *r, struct commit *item, const void *buffer, unsigned long size, int check_graph);
  71. int repo_parse_commit_internal(struct repository *r, struct commit *item,
  72. int quiet_on_missing, int use_commit_graph);
  73. int repo_parse_commit_gently(struct repository *r,
  74. struct commit *item,
  75. int quiet_on_missing);
  76. static inline int repo_parse_commit(struct repository *r, struct commit *item)
  77. {
  78. return repo_parse_commit_gently(r, item, 0);
  79. }
  80. static inline int parse_commit_no_graph(struct commit *commit)
  81. {
  82. return repo_parse_commit_internal(the_repository, commit, 0, 0);
  83. }
  84. #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
  85. #define parse_commit_internal(item, quiet, use) repo_parse_commit_internal(the_repository, item, quiet, use)
  86. #define parse_commit_gently(item, quiet) repo_parse_commit_gently(the_repository, item, quiet)
  87. #define parse_commit(item) repo_parse_commit(the_repository, item)
  88. #endif
  89. void parse_commit_or_die(struct commit *item);
  90. struct buffer_slab;
  91. struct buffer_slab *allocate_commit_buffer_slab(void);
  92. void free_commit_buffer_slab(struct buffer_slab *bs);
  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. */
  97. void set_commit_buffer(struct repository *r, struct commit *, void *buffer, unsigned long size);
  98. /*
  99. * Get any cached object buffer associated with the commit. Returns NULL
  100. * if none. The resulting memory should not be freed.
  101. */
  102. const void *get_cached_commit_buffer(struct repository *, const struct commit *, unsigned long *size);
  103. /*
  104. * Get the commit's object contents, either from cache or by reading the object
  105. * from disk. The resulting memory should not be modified, and must be given
  106. * to unuse_commit_buffer when the caller is done.
  107. */
  108. const void *repo_get_commit_buffer(struct repository *r,
  109. const struct commit *,
  110. unsigned long *size);
  111. #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
  112. #define get_commit_buffer(c, s) repo_get_commit_buffer(the_repository, c, s)
  113. #endif
  114. /*
  115. * Tell the commit subsytem that we are done with a particular commit buffer.
  116. * The commit and buffer should be the input and return value, respectively,
  117. * from an earlier call to get_commit_buffer. The buffer may or may not be
  118. * freed by this call; callers should not access the memory afterwards.
  119. */
  120. void repo_unuse_commit_buffer(struct repository *r,
  121. const struct commit *,
  122. const void *buffer);
  123. #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
  124. #define unuse_commit_buffer(c, b) repo_unuse_commit_buffer(the_repository, c, b)
  125. #endif
  126. /*
  127. * Free any cached object buffer associated with the commit.
  128. */
  129. void free_commit_buffer(struct parsed_object_pool *pool, struct commit *);
  130. struct tree *repo_get_commit_tree(struct repository *, const struct commit *);
  131. #define get_commit_tree(c) repo_get_commit_tree(the_repository, c)
  132. struct object_id *get_commit_tree_oid(const struct commit *);
  133. /*
  134. * Release memory related to a commit, including the parent list and
  135. * any cached object buffer.
  136. */
  137. void release_commit_memory(struct parsed_object_pool *pool, struct commit *c);
  138. /*
  139. * Disassociate any cached object buffer from the commit, but do not free it.
  140. * The buffer (or NULL, if none) is returned.
  141. */
  142. const void *detach_commit_buffer(struct commit *, unsigned long *sizep);
  143. /* Find beginning and length of commit subject. */
  144. int find_commit_subject(const char *commit_buffer, const char **subject);
  145. struct commit_list *commit_list_insert(struct commit *item,
  146. struct commit_list **list);
  147. struct commit_list **commit_list_append(struct commit *commit,
  148. struct commit_list **next);
  149. unsigned commit_list_count(const struct commit_list *l);
  150. struct commit_list *commit_list_insert_by_date(struct commit *item,
  151. struct commit_list **list);
  152. void commit_list_sort_by_date(struct commit_list **list);
  153. /* Shallow copy of the input list */
  154. struct commit_list *copy_commit_list(struct commit_list *list);
  155. void free_commit_list(struct commit_list *list);
  156. struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
  157. int has_non_ascii(const char *text);
  158. const char *logmsg_reencode(const struct commit *commit,
  159. char **commit_encoding,
  160. const char *output_encoding);
  161. const char *repo_logmsg_reencode(struct repository *r,
  162. const struct commit *commit,
  163. char **commit_encoding,
  164. const char *output_encoding);
  165. #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
  166. #define logmsg_reencode(c, enc, out) repo_logmsg_reencode(the_repository, c, enc, out)
  167. #endif
  168. const char *skip_blank_lines(const char *msg);
  169. /** Removes the first commit from a list sorted by date, and adds all
  170. * of its parents.
  171. **/
  172. struct commit *pop_most_recent_commit(struct commit_list **list,
  173. unsigned int mark);
  174. struct commit *pop_commit(struct commit_list **stack);
  175. void clear_commit_marks(struct commit *commit, unsigned int mark);
  176. void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark);
  177. enum 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. * Performs an in-place topological sort of list supplied.
  184. *
  185. * invariant of resulting list is:
  186. * a reachable from b => ord(b) < ord(a)
  187. * sort_order further specifies:
  188. * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
  189. * chain together.
  190. * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
  191. */
  192. void sort_in_topological_order(struct commit_list **, enum rev_sort_order);
  193. struct commit_graft {
  194. struct object_id oid;
  195. int nr_parent; /* < 0 if shallow commit */
  196. struct object_id parent[FLEX_ARRAY]; /* more */
  197. };
  198. typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
  199. struct commit_graft *read_graft_line(struct strbuf *line);
  200. int register_commit_graft(struct repository *r, struct commit_graft *, int);
  201. void prepare_commit_graft(struct repository *r);
  202. struct commit_graft *lookup_commit_graft(struct repository *r, const struct object_id *oid);
  203. struct commit *get_fork_point(const char *refname, struct commit *commit);
  204. /* largest positive number a signed 32-bit integer can contain */
  205. #define INFINITE_DEPTH 0x7fffffff
  206. struct oid_array;
  207. struct ref;
  208. int register_shallow(struct repository *r, const struct object_id *oid);
  209. int unregister_shallow(const struct object_id *oid);
  210. int for_each_commit_graft(each_commit_graft_fn, void *);
  211. int is_repository_shallow(struct repository *r);
  212. struct commit_list *get_shallow_commits(struct object_array *heads,
  213. int depth, int shallow_flag, int not_shallow_flag);
  214. struct commit_list *get_shallow_commits_by_rev_list(
  215. int ac, const char **av, int shallow_flag, int not_shallow_flag);
  216. void set_alternate_shallow_file(struct repository *r, const char *path, int override);
  217. int write_shallow_commits(struct strbuf *out, int use_pack_protocol,
  218. const struct oid_array *extra);
  219. void setup_alternate_shallow(struct lock_file *shallow_lock,
  220. const char **alternate_shallow_file,
  221. const struct oid_array *extra);
  222. const char *setup_temporary_shallow(const struct oid_array *extra);
  223. void advertise_shallow_grafts(int);
  224. /*
  225. * Initialize with prepare_shallow_info() or zero-initialize (equivalent to
  226. * prepare_shallow_info with a NULL oid_array).
  227. */
  228. struct shallow_info {
  229. struct oid_array *shallow;
  230. int *ours, nr_ours;
  231. int *theirs, nr_theirs;
  232. struct oid_array *ref;
  233. /* for receive-pack */
  234. uint32_t **used_shallow;
  235. int *need_reachability_test;
  236. int *reachable;
  237. int *shallow_ref;
  238. struct commit **commits;
  239. int nr_commits;
  240. };
  241. void prepare_shallow_info(struct shallow_info *, struct oid_array *);
  242. void clear_shallow_info(struct shallow_info *);
  243. void remove_nonexistent_theirs_shallow(struct shallow_info *);
  244. void assign_shallow_commits_to_refs(struct shallow_info *info,
  245. uint32_t **used,
  246. int *ref_status);
  247. int delayed_reachability_test(struct shallow_info *si, int c);
  248. #define PRUNE_SHOW_ONLY 1
  249. #define PRUNE_QUICK 2
  250. void prune_shallow(unsigned options);
  251. extern struct trace_key trace_shallow;
  252. int interactive_add(int argc, const char **argv, const char *prefix, int patch);
  253. int run_add_interactive(const char *revision, const char *patch_mode,
  254. const struct pathspec *pathspec);
  255. struct commit_extra_header {
  256. struct commit_extra_header *next;
  257. char *key;
  258. char *value;
  259. size_t len;
  260. };
  261. void append_merge_tag_headers(struct commit_list *parents,
  262. struct commit_extra_header ***tail);
  263. int commit_tree(const char *msg, size_t msg_len,
  264. const struct object_id *tree,
  265. struct commit_list *parents, struct object_id *ret,
  266. const char *author, const char *sign_commit);
  267. int commit_tree_extended(const char *msg, size_t msg_len,
  268. const struct object_id *tree,
  269. struct commit_list *parents,
  270. struct object_id *ret, const char *author,
  271. const char *sign_commit,
  272. struct commit_extra_header *);
  273. struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
  274. void free_commit_extra_headers(struct commit_extra_header *extra);
  275. /*
  276. * Search the commit object contents given by "msg" for the header "key".
  277. * Returns a pointer to the start of the header contents, or NULL. The length
  278. * of the header, up to the first newline, is returned via out_len.
  279. *
  280. * Note that some headers (like mergetag) may be multi-line. It is the caller's
  281. * responsibility to parse further in this case!
  282. */
  283. const char *find_commit_header(const char *msg, const char *key,
  284. size_t *out_len);
  285. /* Find the end of the log message, the right place for a new trailer. */
  286. size_t ignore_non_trailer(const char *buf, size_t len);
  287. typedef int (*each_mergetag_fn)(struct commit *commit, struct commit_extra_header *extra,
  288. void *cb_data);
  289. int for_each_mergetag(each_mergetag_fn fn, struct commit *commit, void *data);
  290. struct merge_remote_desc {
  291. struct object *obj; /* the named object, could be a tag */
  292. char name[FLEX_ARRAY];
  293. };
  294. struct merge_remote_desc *merge_remote_util(struct commit *);
  295. void set_merge_remote_desc(struct commit *commit,
  296. const char *name, struct object *obj);
  297. /*
  298. * Given "name" from the command line to merge, find the commit object
  299. * and return it, while storing merge_remote_desc in its ->util field,
  300. * to allow callers to tell if we are told to merge a tag.
  301. */
  302. struct commit *get_merge_parent(const char *name);
  303. int parse_signed_commit(const struct commit *commit,
  304. struct strbuf *message, struct strbuf *signature);
  305. int remove_signature(struct strbuf *buf);
  306. /*
  307. * Check the signature of the given commit. The result of the check is stored
  308. * in sig->check_result, 'G' for a good signature, 'U' for a good signature
  309. * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
  310. * at all. This may allocate memory for sig->gpg_output, sig->gpg_status,
  311. * sig->signer and sig->key.
  312. */
  313. int check_commit_signature(const struct commit *commit, struct signature_check *sigc);
  314. /* record author-date for each commit object */
  315. struct author_date_slab;
  316. void record_author_date(struct author_date_slab *author_date,
  317. struct commit *commit);
  318. int compare_commits_by_author_date(const void *a_, const void *b_, void *unused);
  319. /*
  320. * Verify a single commit with check_commit_signature() and die() if it is not
  321. * a good signature. This isn't really suitable for general use, but is a
  322. * helper to implement consistent logic for pull/merge --verify-signatures.
  323. */
  324. void verify_merge_signature(struct commit *commit, int verbose);
  325. int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused);
  326. int compare_commits_by_gen_then_commit_date(const void *a_, const void *b_, void *unused);
  327. LAST_ARG_MUST_BE_NULL
  328. int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...);
  329. #endif /* COMMIT_H */