[PATCH] Updates to glossary
[git.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         unsigned long date;
15         struct commit_list *parents;
16         struct tree *tree;
17         char *buffer;
18 };
19
20 extern const char *commit_type;
21
22 struct commit *lookup_commit(const unsigned char *sha1);
23 struct commit *lookup_commit_reference(const unsigned char *sha1);
24
25 int parse_commit_buffer(struct commit *item, void *buffer, unsigned long size);
26
27 int parse_commit(struct commit *item);
28
29 struct commit_list * commit_list_insert(struct commit *item, struct commit_list **list_p);
30 struct commit_list * insert_by_date(struct commit *item, struct commit_list **list);
31
32 void free_commit_list(struct commit_list *list);
33
34 void sort_by_date(struct commit_list **list);
35
36 /* Commit formats */
37 enum cmit_fmt {
38         CMIT_FMT_RAW,
39         CMIT_FMT_MEDIUM,
40         CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
41         CMIT_FMT_SHORT,
42         CMIT_FMT_FULL,
43         CMIT_FMT_ONELINE,
44 };
45
46 extern enum cmit_fmt get_commit_format(const char *arg);
47 extern unsigned long pretty_print_commit(enum cmit_fmt fmt, const char *msg, unsigned long len, char *buf, unsigned long space);
48
49 /** Removes the first commit from a list sorted by date, and adds all
50  * of its parents.
51  **/
52 struct commit *pop_most_recent_commit(struct commit_list **list, 
53                                       unsigned int mark);
54
55 struct commit *pop_commit(struct commit_list **stack);
56
57 int count_parents(struct commit * commit);
58
59 /*
60  * Performs an in-place topological sort of list supplied.
61  *
62  * Pre-conditions:
63  *   all commits in input list and all parents of those
64  *   commits must have object.util == NULL
65  *        
66  * Post-conditions: 
67  *   invariant of resulting list is:
68  *      a reachable from b => ord(b) < ord(a)
69  */
70 void sort_in_topological_order(struct commit_list ** list);
71 #endif /* COMMIT_H */