Merge branch 'maint'
[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"
674d1727 6#include "strbuf.h"
ca135e7a 7#include "decorate.h"
6eb8ae00
DB
8
9struct commit_list {
10 struct commit *item;
11 struct commit_list *next;
12};
13
14struct commit {
15 struct object object;
d3ff6f55 16 void *util;
6eb8ae00
DB
17 unsigned long date;
18 struct commit_list *parents;
19 struct tree *tree;
bd1e17e2 20 char *buffer;
6eb8ae00
DB
21};
22
60ab26de 23extern int save_commit_buffer;
6eb8ae00
DB
24extern const char *commit_type;
25
ca135e7a
LT
26/* While we can decorate any object with a name, it's only used for commits.. */
27extern struct decoration name_decoration;
28struct name_decoration {
29 struct name_decoration *next;
30 char name[1];
31};
32
5d6ccf5c
JM
33struct commit *lookup_commit(const unsigned char *sha1);
34struct commit *lookup_commit_reference(const unsigned char *sha1);
f76412ed
JH
35struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
36 int quiet);
6eb8ae00 37
bd2c39f5
NP
38int parse_commit_buffer(struct commit *item, void *buffer, unsigned long size);
39
6eb8ae00
DB
40int parse_commit(struct commit *item);
41
ac5155ef 42struct commit_list * commit_list_insert(struct commit *item, struct commit_list **list_p);
f755494c 43struct commit_list * insert_by_date(struct commit *item, struct commit_list **list);
dd97f850 44
6eb8ae00
DB
45void free_commit_list(struct commit_list *list);
46
dd97f850
DB
47void sort_by_date(struct commit_list **list);
48
000182ea
LT
49/* Commit formats */
50enum cmit_fmt {
51 CMIT_FMT_RAW,
52 CMIT_FMT_MEDIUM,
53 CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
9b66ec04
LT
54 CMIT_FMT_SHORT,
55 CMIT_FMT_FULL,
ff56fe1c 56 CMIT_FMT_FULLER,
d87449c5 57 CMIT_FMT_ONELINE,
3eefc189 58 CMIT_FMT_EMAIL,
e52a5de4 59 CMIT_FMT_USERFORMAT,
6b9c58f4
JH
60
61 CMIT_FMT_UNSPECIFIED,
000182ea
LT
62};
63
9b66ec04 64extern enum cmit_fmt get_commit_format(const char *arg);
674d1727
PH
65extern void format_commit_message(const struct commit *commit,
66 const void *format, struct strbuf *sb);
67extern void pretty_print_commit(enum cmit_fmt fmt, const struct commit*,
68 struct strbuf *,
69 int abbrev, const char *subject,
70 const char *after_subject, enum date_mode);
e3bc7a3b 71
dd97f850
DB
72/** Removes the first commit from a list sorted by date, and adds all
73 * of its parents.
74 **/
a6080a0a 75struct commit *pop_most_recent_commit(struct commit_list **list,
58e28af6 76 unsigned int mark);
dd97f850 77
a3437b8c
JS
78struct commit *pop_commit(struct commit_list **stack);
79
f8f9c73c
JH
80void clear_commit_marks(struct commit *commit, unsigned int mark);
81
ab580ace
JS
82/*
83 * Performs an in-place topological sort of list supplied.
84 *
6b6dcfc2 85 * Pre-conditions for sort_in_topological_order:
ab580ace
JS
86 * all commits in input list and all parents of those
87 * commits must have object.util == NULL
6b6dcfc2
FK
88 *
89 * Pre-conditions for sort_in_topological_order_fn:
90 * all commits in input list and all parents of those
91 * commits must have getter(commit) == NULL
92 *
93 * Post-conditions:
ab580ace
JS
94 * invariant of resulting list is:
95 * a reachable from b => ord(b) < ord(a)
4c8725f1
JH
96 * in addition, when lifo == 0, commits on parallel tracks are
97 * sorted in the dates order.
ab580ace 98 */
6b6dcfc2
FK
99
100typedef void (*topo_sort_set_fn_t)(struct commit*, void *data);
101typedef void* (*topo_sort_get_fn_t)(struct commit*);
102
103void topo_sort_default_setter(struct commit *c, void *data);
104void *topo_sort_default_getter(struct commit *c);
105
4c8725f1 106void sort_in_topological_order(struct commit_list ** list, int lifo);
6b6dcfc2
FK
107void sort_in_topological_order_fn(struct commit_list ** list, int lifo,
108 topo_sort_set_fn_t setter,
109 topo_sort_get_fn_t getter);
5040f17e
JH
110
111struct commit_graft {
112 unsigned char sha1[20];
ed09aef0 113 int nr_parent; /* < 0 if shallow commit */
5040f17e
JH
114 unsigned char parent[FLEX_ARRAY][20]; /* more */
115};
116
117struct commit_graft *read_graft_line(char *buf, int len);
118int register_commit_graft(struct commit_graft *, int);
119int read_graft_file(const char *graft_file);
120
c0fa8255 121extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
7c6f8aaf 122
ed09aef0 123extern int register_shallow(const unsigned char *sha1);
f53514bc 124extern int unregister_shallow(const unsigned char *sha1);
ed09aef0 125extern int write_shallow_commits(int fd, int use_pack_protocol);
f43117a6 126extern int is_repository_shallow(void);
ed09aef0 127extern struct commit_list *get_shallow_commits(struct object_array *heads,
f53514bc 128 int depth, int shallow_flag, int not_shallow_flag);
ed09aef0 129
03840fc3 130int in_merge_bases(struct commit *, struct commit **, int);
58680165
KH
131
132extern int interactive_add(void);
133extern void add_files_to_cache(int verbose, const char *prefix, const char **files);
d8b7db0a 134extern int rerere(void);
58680165 135
6eb8ae00 136#endif /* COMMIT_H */