refs: add a "for_each_replace_ref" function
[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;
23c17d4a 17 unsigned int indegree;
6eb8ae00
DB
18 unsigned long date;
19 struct commit_list *parents;
20 struct tree *tree;
bd1e17e2 21 char *buffer;
6eb8ae00
DB
22};
23
60ab26de 24extern int save_commit_buffer;
6eb8ae00
DB
25extern const char *commit_type;
26
ca135e7a
LT
27/* While we can decorate any object with a name, it's only used for commits.. */
28extern struct decoration name_decoration;
29struct name_decoration {
30 struct name_decoration *next;
31 char name[1];
32};
33
5d6ccf5c
JM
34struct commit *lookup_commit(const unsigned char *sha1);
35struct commit *lookup_commit_reference(const unsigned char *sha1);
f76412ed
JH
36struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
37 int quiet);
6eb8ae00 38
bd2c39f5
NP
39int parse_commit_buffer(struct commit *item, void *buffer, unsigned long size);
40
6eb8ae00
DB
41int parse_commit(struct commit *item);
42
836a3fd5
CC
43void unparse_commit(struct commit *item);
44
ac5155ef 45struct commit_list * commit_list_insert(struct commit *item, struct commit_list **list_p);
65319475 46unsigned commit_list_count(const struct commit_list *l);
f755494c 47struct commit_list * insert_by_date(struct commit *item, struct commit_list **list);
dd97f850 48
6eb8ae00
DB
49void free_commit_list(struct commit_list *list);
50
dd97f850
DB
51void sort_by_date(struct commit_list **list);
52
000182ea
LT
53/* Commit formats */
54enum cmit_fmt {
55 CMIT_FMT_RAW,
56 CMIT_FMT_MEDIUM,
57 CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
9b66ec04
LT
58 CMIT_FMT_SHORT,
59 CMIT_FMT_FULL,
ff56fe1c 60 CMIT_FMT_FULLER,
d87449c5 61 CMIT_FMT_ONELINE,
3eefc189 62 CMIT_FMT_EMAIL,
e52a5de4 63 CMIT_FMT_USERFORMAT,
6b9c58f4
JH
64
65 CMIT_FMT_UNSPECIFIED,
000182ea
LT
66};
67
4593fb84 68extern int non_ascii(int);
4da45bef 69struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
69cd8f63
AG
70extern char *reencode_commit_message(const struct commit *commit,
71 const char **encoding_p);
4da45bef 72extern void get_commit_format(const char *arg, struct rev_info *);
674d1727 73extern void format_commit_message(const struct commit *commit,
d36f8679
JK
74 const void *format, struct strbuf *sb,
75 enum date_mode dmode);
674d1727
PH
76extern void pretty_print_commit(enum cmit_fmt fmt, const struct commit*,
77 struct strbuf *,
78 int abbrev, const char *subject,
4593fb84 79 const char *after_subject, enum date_mode,
6bf4f1b4 80 int need_8bit_cte);
b02bd65f
DB
81void pp_user_info(const char *what, enum cmit_fmt fmt, struct strbuf *sb,
82 const char *line, enum date_mode dmode,
83 const char *encoding);
84void pp_title_line(enum cmit_fmt fmt,
85 const char **msg_p,
86 struct strbuf *sb,
87 const char *subject,
88 const char *after_subject,
89 const char *encoding,
267123b4 90 int need_8bit_cte);
b02bd65f
DB
91void pp_remainder(enum cmit_fmt fmt,
92 const char **msg_p,
93 struct strbuf *sb,
94 int indent);
95
e3bc7a3b 96
dd97f850
DB
97/** Removes the first commit from a list sorted by date, and adds all
98 * of its parents.
99 **/
a6080a0a 100struct commit *pop_most_recent_commit(struct commit_list **list,
58e28af6 101 unsigned int mark);
dd97f850 102
a3437b8c
JS
103struct commit *pop_commit(struct commit_list **stack);
104
f8f9c73c
JH
105void clear_commit_marks(struct commit *commit, unsigned int mark);
106
ab580ace
JS
107/*
108 * Performs an in-place topological sort of list supplied.
109 *
ab580ace
JS
110 * invariant of resulting list is:
111 * a reachable from b => ord(b) < ord(a)
4c8725f1
JH
112 * in addition, when lifo == 0, commits on parallel tracks are
113 * sorted in the dates order.
ab580ace 114 */
4c8725f1 115void sort_in_topological_order(struct commit_list ** list, int lifo);
5040f17e
JH
116
117struct commit_graft {
118 unsigned char sha1[20];
ed09aef0 119 int nr_parent; /* < 0 if shallow commit */
5040f17e
JH
120 unsigned char parent[FLEX_ARRAY][20]; /* more */
121};
122
123struct commit_graft *read_graft_line(char *buf, int len);
124int register_commit_graft(struct commit_graft *, int);
45163382 125struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
5040f17e 126
c0fa8255 127extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
53eda89b 128extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos, int cleanup);
5240c9d7 129extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
7c6f8aaf 130
ed09aef0 131extern int register_shallow(const unsigned char *sha1);
f53514bc 132extern int unregister_shallow(const unsigned char *sha1);
ed09aef0 133extern int write_shallow_commits(int fd, int use_pack_protocol);
f43117a6 134extern int is_repository_shallow(void);
ed09aef0 135extern struct commit_list *get_shallow_commits(struct object_array *heads,
f53514bc 136 int depth, int shallow_flag, int not_shallow_flag);
ed09aef0 137
7fcdb36e 138int is_descendant_of(struct commit *, struct commit_list *);
03840fc3 139int in_merge_bases(struct commit *, struct commit **, int);
58680165 140
3f061887 141extern int interactive_add(int argc, const char **argv, const char *prefix);
58680165 142
53b2c823
LT
143static inline int single_parent(struct commit *commit)
144{
145 return commit->parents && !commit->parents->next;
146}
147
98cf9c3b
JH
148struct commit_list *reduce_heads(struct commit_list *heads);
149
6eb8ae00 150#endif /* COMMIT_H */