Merge branch 'post1.5.1/blame.el'
[git] / commit.h
1 #ifndef COMMIT_H
2 #define COMMIT_H
3
4 #include "object.h"
5 #include "tree.h"
6
7 struct commit_list {
8         struct commit *item;
9         struct commit_list *next;
10 };
11
12 struct commit {
13         struct object object;
14         void *util;
15         unsigned long date;
16         struct commit_list *parents;
17         struct tree *tree;
18         char *buffer;
19 };
20
21 extern int save_commit_buffer;
22 extern const char *commit_type;
23
24 struct commit *lookup_commit(const unsigned char *sha1);
25 struct commit *lookup_commit_reference(const unsigned char *sha1);
26 struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
27                                               int quiet);
28
29 int parse_commit_buffer(struct commit *item, void *buffer, unsigned long size);
30
31 int parse_commit(struct commit *item);
32
33 struct commit_list * commit_list_insert(struct commit *item, struct commit_list **list_p);
34 struct commit_list * insert_by_date(struct commit *item, struct commit_list **list);
35
36 void free_commit_list(struct commit_list *list);
37
38 void sort_by_date(struct commit_list **list);
39
40 /* Commit formats */
41 enum cmit_fmt {
42         CMIT_FMT_RAW,
43         CMIT_FMT_MEDIUM,
44         CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
45         CMIT_FMT_SHORT,
46         CMIT_FMT_FULL,
47         CMIT_FMT_FULLER,
48         CMIT_FMT_ONELINE,
49         CMIT_FMT_EMAIL,
50         CMIT_FMT_USERFORMAT,
51
52         CMIT_FMT_UNSPECIFIED,
53 };
54
55 extern enum cmit_fmt get_commit_format(const char *arg);
56 extern unsigned long pretty_print_commit(enum cmit_fmt fmt, const struct commit *, unsigned long len, char *buf, unsigned long space, int abbrev, const char *subject, const char *after_subject, int relative_date);
57
58 /** Removes the first commit from a list sorted by date, and adds all
59  * of its parents.
60  **/
61 struct commit *pop_most_recent_commit(struct commit_list **list, 
62                                       unsigned int mark);
63
64 struct commit *pop_commit(struct commit_list **stack);
65
66 void clear_commit_marks(struct commit *commit, unsigned int mark);
67
68 int count_parents(struct commit * commit);
69
70 /*
71  * Performs an in-place topological sort of list supplied.
72  *
73  * Pre-conditions for sort_in_topological_order:
74  *   all commits in input list and all parents of those
75  *   commits must have object.util == NULL
76  *
77  * Pre-conditions for sort_in_topological_order_fn:
78  *   all commits in input list and all parents of those
79  *   commits must have getter(commit) == NULL
80  *
81  * Post-conditions:
82  *   invariant of resulting list is:
83  *      a reachable from b => ord(b) < ord(a)
84  *   in addition, when lifo == 0, commits on parallel tracks are
85  *   sorted in the dates order.
86  */
87
88 typedef void (*topo_sort_set_fn_t)(struct commit*, void *data);
89 typedef void* (*topo_sort_get_fn_t)(struct commit*);
90
91 void topo_sort_default_setter(struct commit *c, void *data);
92 void *topo_sort_default_getter(struct commit *c);
93
94 void sort_in_topological_order(struct commit_list ** list, int lifo);
95 void sort_in_topological_order_fn(struct commit_list ** list, int lifo,
96                                   topo_sort_set_fn_t setter,
97                                   topo_sort_get_fn_t getter);
98
99 struct commit_graft {
100         unsigned char sha1[20];
101         int nr_parent; /* < 0 if shallow commit */
102         unsigned char parent[FLEX_ARRAY][20]; /* more */
103 };
104
105 struct commit_graft *read_graft_line(char *buf, int len);
106 int register_commit_graft(struct commit_graft *, int);
107 int read_graft_file(const char *graft_file);
108
109 extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
110
111 extern int register_shallow(const unsigned char *sha1);
112 extern int unregister_shallow(const unsigned char *sha1);
113 extern int write_shallow_commits(int fd, int use_pack_protocol);
114 extern int is_repository_shallow(void);
115 extern struct commit_list *get_shallow_commits(struct object_array *heads,
116                 int depth, int shallow_flag, int not_shallow_flag);
117
118 int in_merge_bases(struct commit *, struct commit **, int);
119 #endif /* COMMIT_H */