commit: helper methods to reduce redundant blocks of code
[git/git.git] / commit.h
1 #ifndef COMMIT_H
2 #define COMMIT_H
3
4 #include "object.h"
5 #include "tree.h"
6 #include "strbuf.h"
7 #include "decorate.h"
8
9 struct commit_list {
10 struct commit *item;
11 struct commit_list *next;
12 };
13
14 struct commit {
15 struct object object;
16 void *util;
17 unsigned int indegree;
18 unsigned long date;
19 struct commit_list *parents;
20 struct tree *tree;
21 char *buffer;
22 };
23
24 extern int save_commit_buffer;
25 extern const char *commit_type;
26
27 /* While we can decorate any object with a name, it's only used for commits.. */
28 extern struct decoration name_decoration;
29 struct name_decoration {
30 struct name_decoration *next;
31 int type;
32 char name[1];
33 };
34
35 struct commit *lookup_commit(const unsigned char *sha1);
36 struct commit *lookup_commit_reference(const unsigned char *sha1);
37 struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
38 int quiet);
39 struct commit *lookup_commit_reference_by_name(const char *name);
40
41 int parse_commit_buffer(struct commit *item, void *buffer, unsigned long size);
42
43 int parse_commit(struct commit *item);
44
45 /* Find beginning and length of commit subject. */
46 int find_commit_subject(const char *commit_buffer, const char **subject);
47
48 struct commit_list * commit_list_insert(struct commit *item, struct commit_list **list_p);
49 unsigned commit_list_count(const struct commit_list *l);
50 struct commit_list * insert_by_date(struct commit *item, struct commit_list **list);
51
52 void free_commit_list(struct commit_list *list);
53
54 void sort_by_date(struct commit_list **list);
55
56 /* Commit formats */
57 enum cmit_fmt {
58 CMIT_FMT_RAW,
59 CMIT_FMT_MEDIUM,
60 CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
61 CMIT_FMT_SHORT,
62 CMIT_FMT_FULL,
63 CMIT_FMT_FULLER,
64 CMIT_FMT_ONELINE,
65 CMIT_FMT_EMAIL,
66 CMIT_FMT_USERFORMAT,
67
68 CMIT_FMT_UNSPECIFIED
69 };
70
71 struct 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;
78 int show_notes;
79 struct reflog_walk_info *reflog_info;
80 };
81
82 struct userformat_want {
83 unsigned notes:1;
84 };
85
86 extern int has_non_ascii(const char *text);
87 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
88 extern char *reencode_commit_message(const struct commit *commit,
89 const char **encoding_p);
90 extern void get_commit_format(const char *arg, struct rev_info *);
91 extern void userformat_find_requirements(const char *fmt, struct userformat_want *w);
92 extern void format_commit_message(const struct commit *commit,
93 const char *format, struct strbuf *sb,
94 const struct pretty_print_context *context);
95 extern void pretty_print_commit(enum cmit_fmt fmt, const struct commit *commit,
96 struct strbuf *sb,
97 const struct pretty_print_context *context);
98 void 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);
101 void 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,
107 int need_8bit_cte);
108 void pp_remainder(enum cmit_fmt fmt,
109 const char **msg_p,
110 struct strbuf *sb,
111 int indent);
112
113
114 /** Removes the first commit from a list sorted by date, and adds all
115 * of its parents.
116 **/
117 struct commit *pop_most_recent_commit(struct commit_list **list,
118 unsigned int mark);
119
120 struct commit *pop_commit(struct commit_list **stack);
121
122 void clear_commit_marks(struct commit *commit, unsigned int mark);
123
124 /*
125 * Performs an in-place topological sort of list supplied.
126 *
127 * invariant of resulting list is:
128 * a reachable from b => ord(b) < ord(a)
129 * in addition, when lifo == 0, commits on parallel tracks are
130 * sorted in the dates order.
131 */
132 void sort_in_topological_order(struct commit_list ** list, int lifo);
133
134 struct commit_graft {
135 unsigned char sha1[20];
136 int nr_parent; /* < 0 if shallow commit */
137 unsigned char parent[FLEX_ARRAY][20]; /* more */
138 };
139
140 struct commit_graft *read_graft_line(char *buf, int len);
141 int register_commit_graft(struct commit_graft *, int);
142 struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
143
144 const unsigned char *lookup_replace_object(const unsigned char *sha1);
145
146 extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
147 extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos, int cleanup);
148 extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
149
150 extern int register_shallow(const unsigned char *sha1);
151 extern int unregister_shallow(const unsigned char *sha1);
152 extern int write_shallow_commits(struct strbuf *out, int use_pack_protocol);
153 extern int is_repository_shallow(void);
154 extern struct commit_list *get_shallow_commits(struct object_array *heads,
155 int depth, int shallow_flag, int not_shallow_flag);
156
157 int is_descendant_of(struct commit *, struct commit_list *);
158 int in_merge_bases(struct commit *, struct commit **, int);
159
160 extern int interactive_add(int argc, const char **argv, const char *prefix);
161 extern int run_add_interactive(const char *revision, const char *patch_mode,
162 const char **pathspec);
163
164 static inline int single_parent(struct commit *commit)
165 {
166 return commit->parents && !commit->parents->next;
167 }
168
169 struct commit_list *reduce_heads(struct commit_list *heads);
170
171 extern int commit_tree(const char *msg, unsigned char *tree,
172 struct commit_list *parents, unsigned char *ret,
173 const char *author);
174
175 #endif /* COMMIT_H */