Add a generic "object decorator" interface, and make object refs use it
[git/git.git] / commit.h
CommitLineData
6eb8ae00
DB
1#ifndef COMMIT_H
2#define COMMIT_H
3
4#include "object.h"
5#include "tree.h"
6
7struct commit_list {
8 struct commit *item;
9 struct commit_list *next;
10};
11
12struct commit {
13 struct object object;
d3ff6f55 14 void *util;
6eb8ae00
DB
15 unsigned long date;
16 struct commit_list *parents;
17 struct tree *tree;
bd1e17e2 18 char *buffer;
6eb8ae00
DB
19};
20
60ab26de 21extern int save_commit_buffer;
6eb8ae00
DB
22extern const char *commit_type;
23
5d6ccf5c
JM
24struct commit *lookup_commit(const unsigned char *sha1);
25struct commit *lookup_commit_reference(const unsigned char *sha1);
f76412ed
JH
26struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
27 int quiet);
6eb8ae00 28
bd2c39f5
NP
29int parse_commit_buffer(struct commit *item, void *buffer, unsigned long size);
30
6eb8ae00
DB
31int parse_commit(struct commit *item);
32
ac5155ef 33struct commit_list * commit_list_insert(struct commit *item, struct commit_list **list_p);
f755494c 34struct commit_list * insert_by_date(struct commit *item, struct commit_list **list);
dd97f850 35
6eb8ae00
DB
36void free_commit_list(struct commit_list *list);
37
dd97f850
DB
38void sort_by_date(struct commit_list **list);
39
000182ea
LT
40/* Commit formats */
41enum cmit_fmt {
42 CMIT_FMT_RAW,
43 CMIT_FMT_MEDIUM,
44 CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
9b66ec04
LT
45 CMIT_FMT_SHORT,
46 CMIT_FMT_FULL,
ff56fe1c 47 CMIT_FMT_FULLER,
d87449c5 48 CMIT_FMT_ONELINE,
3eefc189 49 CMIT_FMT_EMAIL,
e52a5de4 50 CMIT_FMT_USERFORMAT,
6b9c58f4
JH
51
52 CMIT_FMT_UNSPECIFIED,
000182ea
LT
53};
54
9b66ec04 55extern enum cmit_fmt get_commit_format(const char *arg);
3dfb9278 56extern 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);
e3bc7a3b 57
dd97f850
DB
58/** Removes the first commit from a list sorted by date, and adds all
59 * of its parents.
60 **/
58e28af6
DB
61struct commit *pop_most_recent_commit(struct commit_list **list,
62 unsigned int mark);
dd97f850 63
a3437b8c
JS
64struct commit *pop_commit(struct commit_list **stack);
65
f8f9c73c
JH
66void clear_commit_marks(struct commit *commit, unsigned int mark);
67
a3437b8c 68int count_parents(struct commit * commit);
ab580ace
JS
69
70/*
71 * Performs an in-place topological sort of list supplied.
72 *
6b6dcfc2 73 * Pre-conditions for sort_in_topological_order:
ab580ace
JS
74 * all commits in input list and all parents of those
75 * commits must have object.util == NULL
6b6dcfc2
FK
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:
ab580ace
JS
82 * invariant of resulting list is:
83 * a reachable from b => ord(b) < ord(a)
4c8725f1
JH
84 * in addition, when lifo == 0, commits on parallel tracks are
85 * sorted in the dates order.
ab580ace 86 */
6b6dcfc2
FK
87
88typedef void (*topo_sort_set_fn_t)(struct commit*, void *data);
89typedef void* (*topo_sort_get_fn_t)(struct commit*);
90
91void topo_sort_default_setter(struct commit *c, void *data);
92void *topo_sort_default_getter(struct commit *c);
93
4c8725f1 94void sort_in_topological_order(struct commit_list ** list, int lifo);
6b6dcfc2
FK
95void 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);
5040f17e
JH
98
99struct commit_graft {
100 unsigned char sha1[20];
ed09aef0 101 int nr_parent; /* < 0 if shallow commit */
5040f17e
JH
102 unsigned char parent[FLEX_ARRAY][20]; /* more */
103};
104
105struct commit_graft *read_graft_line(char *buf, int len);
106int register_commit_graft(struct commit_graft *, int);
107int read_graft_file(const char *graft_file);
108
c0fa8255 109extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
7c6f8aaf 110
ed09aef0 111extern int register_shallow(const unsigned char *sha1);
f53514bc 112extern int unregister_shallow(const unsigned char *sha1);
ed09aef0 113extern int write_shallow_commits(int fd, int use_pack_protocol);
f43117a6 114extern int is_repository_shallow(void);
ed09aef0 115extern struct commit_list *get_shallow_commits(struct object_array *heads,
f53514bc 116 int depth, int shallow_flag, int not_shallow_flag);
ed09aef0 117
03840fc3 118int in_merge_bases(struct commit *, struct commit **, int);
6eb8ae00 119#endif /* COMMIT_H */