Fix up docs where "--" isn't displayed correctly.
[alt-git.git] / commit.h
blobde142afe733a6ecd3bcec2abd9f71a358b4ae09d
1 #ifndef COMMIT_H
2 #define COMMIT_H
4 #include "object.h"
5 #include "tree.h"
7 struct commit_list {
8 struct commit *item;
9 struct commit_list *next;
12 struct commit {
13 struct object object;
14 unsigned long date;
15 struct commit_list *parents;
16 struct tree *tree;
17 char *buffer;
20 extern int save_commit_buffer;
21 extern const char *commit_type;
23 struct commit *lookup_commit(const unsigned char *sha1);
24 struct commit *lookup_commit_reference(const unsigned char *sha1);
25 struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
26 int quiet);
28 int parse_commit_buffer(struct commit *item, void *buffer, unsigned long size);
30 int parse_commit(struct commit *item);
32 struct commit_list * commit_list_insert(struct commit *item, struct commit_list **list_p);
33 struct commit_list * insert_by_date(struct commit *item, struct commit_list **list);
35 void free_commit_list(struct commit_list *list);
37 void sort_by_date(struct commit_list **list);
39 /* Commit formats */
40 enum cmit_fmt {
41 CMIT_FMT_RAW,
42 CMIT_FMT_MEDIUM,
43 CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
44 CMIT_FMT_SHORT,
45 CMIT_FMT_FULL,
46 CMIT_FMT_FULLER,
47 CMIT_FMT_ONELINE,
49 CMIT_FMT_UNSPECIFIED,
52 extern enum cmit_fmt get_commit_format(const char *arg);
53 extern unsigned long pretty_print_commit(enum cmit_fmt fmt, const struct commit *, unsigned long len, char *buf, unsigned long space, int abbrev);
55 /** Removes the first commit from a list sorted by date, and adds all
56 * of its parents.
57 **/
58 struct commit *pop_most_recent_commit(struct commit_list **list,
59 unsigned int mark);
61 struct commit *pop_commit(struct commit_list **stack);
63 void clear_commit_marks(struct commit *commit, unsigned int mark);
65 int count_parents(struct commit * commit);
68 * Performs an in-place topological sort of list supplied.
70 * Pre-conditions for sort_in_topological_order:
71 * all commits in input list and all parents of those
72 * commits must have object.util == NULL
74 * Pre-conditions for sort_in_topological_order_fn:
75 * all commits in input list and all parents of those
76 * commits must have getter(commit) == NULL
78 * Post-conditions:
79 * invariant of resulting list is:
80 * a reachable from b => ord(b) < ord(a)
81 * in addition, when lifo == 0, commits on parallel tracks are
82 * sorted in the dates order.
85 typedef void (*topo_sort_set_fn_t)(struct commit*, void *data);
86 typedef void* (*topo_sort_get_fn_t)(struct commit*);
88 void topo_sort_default_setter(struct commit *c, void *data);
89 void *topo_sort_default_getter(struct commit *c);
91 void sort_in_topological_order(struct commit_list ** list, int lifo);
92 void sort_in_topological_order_fn(struct commit_list ** list, int lifo,
93 topo_sort_set_fn_t setter,
94 topo_sort_get_fn_t getter);
96 struct commit_graft {
97 unsigned char sha1[20];
98 int nr_parent;
99 unsigned char parent[FLEX_ARRAY][20]; /* more */
102 struct commit_graft *read_graft_line(char *buf, int len);
103 int register_commit_graft(struct commit_graft *, int);
104 int read_graft_file(const char *graft_file);
106 #endif /* COMMIT_H */