commit: helper methods to reduce redundant blocks of code
[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;
eb3005e2 31 int type;
ca135e7a
LT
32 char name[1];
33};
34
5d6ccf5c
JM
35struct commit *lookup_commit(const unsigned char *sha1);
36struct commit *lookup_commit_reference(const unsigned char *sha1);
f76412ed
JH
37struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
38 int quiet);
a6fa5992 39struct commit *lookup_commit_reference_by_name(const char *name);
6eb8ae00 40
bd2c39f5
NP
41int parse_commit_buffer(struct commit *item, void *buffer, unsigned long size);
42
6eb8ae00
DB
43int parse_commit(struct commit *item);
44
11af2aae
CC
45/* Find beginning and length of commit subject. */
46int find_commit_subject(const char *commit_buffer, const char **subject);
47
ac5155ef 48struct commit_list * commit_list_insert(struct commit *item, struct commit_list **list_p);
65319475 49unsigned commit_list_count(const struct commit_list *l);
f755494c 50struct commit_list * insert_by_date(struct commit *item, struct commit_list **list);
dd97f850 51
6eb8ae00
DB
52void free_commit_list(struct commit_list *list);
53
dd97f850
DB
54void sort_by_date(struct commit_list **list);
55
000182ea
LT
56/* Commit formats */
57enum cmit_fmt {
58 CMIT_FMT_RAW,
59 CMIT_FMT_MEDIUM,
60 CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
9b66ec04
LT
61 CMIT_FMT_SHORT,
62 CMIT_FMT_FULL,
ff56fe1c 63 CMIT_FMT_FULLER,
d87449c5 64 CMIT_FMT_ONELINE,
3eefc189 65 CMIT_FMT_EMAIL,
e52a5de4 66 CMIT_FMT_USERFORMAT,
6b9c58f4 67
4b05548f 68 CMIT_FMT_UNSPECIFIED
000182ea
LT
69};
70
dd2e794a
TR
71struct pretty_print_context
72{
73 int abbrev;
74 const char *subject;
75 const char *after_subject;
76 enum date_mode date_mode;
77 int need_8bit_cte;
66b2ed09 78 int show_notes;
8f8f5476 79 struct reflog_walk_info *reflog_info;
dd2e794a
TR
80};
81
5b163603
JG
82struct userformat_want {
83 unsigned notes:1;
84};
85
28e9cf65 86extern int has_non_ascii(const char *text);
4da45bef 87struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
69cd8f63
AG
88extern char *reencode_commit_message(const struct commit *commit,
89 const char **encoding_p);
4da45bef 90extern void get_commit_format(const char *arg, struct rev_info *);
5b163603 91extern void userformat_find_requirements(const char *fmt, struct userformat_want *w);
674d1727 92extern void format_commit_message(const struct commit *commit,
7f98ebc8 93 const char *format, struct strbuf *sb,
dd2e794a
TR
94 const struct pretty_print_context *context);
95extern void pretty_print_commit(enum cmit_fmt fmt, const struct commit *commit,
96 struct strbuf *sb,
97 const struct pretty_print_context *context);
b02bd65f
DB
98void pp_user_info(const char *what, enum cmit_fmt fmt, struct strbuf *sb,
99 const char *line, enum date_mode dmode,
100 const char *encoding);
101void pp_title_line(enum cmit_fmt fmt,
102 const char **msg_p,
103 struct strbuf *sb,
104 const char *subject,
105 const char *after_subject,
106 const char *encoding,
267123b4 107 int need_8bit_cte);
b02bd65f
DB
108void pp_remainder(enum cmit_fmt fmt,
109 const char **msg_p,
110 struct strbuf *sb,
111 int indent);
112
e3bc7a3b 113
dd97f850
DB
114/** Removes the first commit from a list sorted by date, and adds all
115 * of its parents.
116 **/
a6080a0a 117struct commit *pop_most_recent_commit(struct commit_list **list,
58e28af6 118 unsigned int mark);
dd97f850 119
a3437b8c
JS
120struct commit *pop_commit(struct commit_list **stack);
121
f8f9c73c
JH
122void clear_commit_marks(struct commit *commit, unsigned int mark);
123
ab580ace
JS
124/*
125 * Performs an in-place topological sort of list supplied.
126 *
ab580ace
JS
127 * invariant of resulting list is:
128 * a reachable from b => ord(b) < ord(a)
4c8725f1
JH
129 * in addition, when lifo == 0, commits on parallel tracks are
130 * sorted in the dates order.
ab580ace 131 */
4c8725f1 132void sort_in_topological_order(struct commit_list ** list, int lifo);
5040f17e
JH
133
134struct commit_graft {
135 unsigned char sha1[20];
ed09aef0 136 int nr_parent; /* < 0 if shallow commit */
5040f17e
JH
137 unsigned char parent[FLEX_ARRAY][20]; /* more */
138};
139
140struct commit_graft *read_graft_line(char *buf, int len);
141int register_commit_graft(struct commit_graft *, int);
45163382 142struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
5040f17e 143
68095570
CC
144const unsigned char *lookup_replace_object(const unsigned char *sha1);
145
c0fa8255 146extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
53eda89b 147extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos, int cleanup);
5240c9d7 148extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
7c6f8aaf 149
ed09aef0 150extern int register_shallow(const unsigned char *sha1);
f53514bc 151extern int unregister_shallow(const unsigned char *sha1);
edace6f0 152extern int write_shallow_commits(struct strbuf *out, int use_pack_protocol);
f43117a6 153extern int is_repository_shallow(void);
ed09aef0 154extern struct commit_list *get_shallow_commits(struct object_array *heads,
f53514bc 155 int depth, int shallow_flag, int not_shallow_flag);
ed09aef0 156
7fcdb36e 157int is_descendant_of(struct commit *, struct commit_list *);
03840fc3 158int in_merge_bases(struct commit *, struct commit **, int);
58680165 159
3f061887 160extern int interactive_add(int argc, const char **argv, const char *prefix);
46b5139c
TR
161extern int run_add_interactive(const char *revision, const char *patch_mode,
162 const char **pathspec);
58680165 163
53b2c823
LT
164static inline int single_parent(struct commit *commit)
165{
166 return commit->parents && !commit->parents->next;
167}
168
98cf9c3b
JH
169struct commit_list *reduce_heads(struct commit_list *heads);
170
40d52ff7
JK
171extern int commit_tree(const char *msg, unsigned char *tree,
172 struct commit_list *parents, unsigned char *ret,
173 const char *author);
174
6eb8ae00 175#endif /* COMMIT_H */