Accept tags in HEAD or MERGE_HEAD
[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 /*
42 * Look up object named by "sha1", dereference tag as necessary,
43 * get a commit and return it. If "sha1" does not dereference to
44 * a commit, use ref_name to report an error and die.
45 */
46 struct commit *lookup_commit_or_die(const unsigned char *sha1, const char *ref_name);
47
48 int parse_commit_buffer(struct commit *item, const void *buffer, unsigned long size);
49 int parse_commit(struct commit *item);
50
51 /* Find beginning and length of commit subject. */
52 int find_commit_subject(const char *commit_buffer, const char **subject);
53
54 struct commit_list *commit_list_insert(struct commit *item,
55 struct commit_list **list);
56 unsigned commit_list_count(const struct commit_list *l);
57 struct commit_list *commit_list_insert_by_date(struct commit *item,
58 struct commit_list **list);
59 void commit_list_sort_by_date(struct commit_list **list);
60
61 void free_commit_list(struct commit_list *list);
62
63 /* Commit formats */
64 enum cmit_fmt {
65 CMIT_FMT_RAW,
66 CMIT_FMT_MEDIUM,
67 CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
68 CMIT_FMT_SHORT,
69 CMIT_FMT_FULL,
70 CMIT_FMT_FULLER,
71 CMIT_FMT_ONELINE,
72 CMIT_FMT_EMAIL,
73 CMIT_FMT_USERFORMAT,
74
75 CMIT_FMT_UNSPECIFIED
76 };
77
78 struct pretty_print_context {
79 enum cmit_fmt fmt;
80 int abbrev;
81 const char *subject;
82 const char *after_subject;
83 int preserve_subject;
84 enum date_mode date_mode;
85 int need_8bit_cte;
86 int show_notes;
87 struct reflog_walk_info *reflog_info;
88 const char *output_encoding;
89 };
90
91 struct userformat_want {
92 unsigned notes:1;
93 };
94
95 extern int has_non_ascii(const char *text);
96 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
97 extern char *logmsg_reencode(const struct commit *commit,
98 const char *output_encoding);
99 extern char *reencode_commit_message(const struct commit *commit,
100 const char **encoding_p);
101 extern void get_commit_format(const char *arg, struct rev_info *);
102 extern const char *format_subject(struct strbuf *sb, const char *msg,
103 const char *line_separator);
104 extern void userformat_find_requirements(const char *fmt, struct userformat_want *w);
105 extern void format_commit_message(const struct commit *commit,
106 const char *format, struct strbuf *sb,
107 const struct pretty_print_context *context);
108 extern void pretty_print_commit(const struct pretty_print_context *pp,
109 const struct commit *commit,
110 struct strbuf *sb);
111 extern void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
112 struct strbuf *sb);
113 void pp_user_info(const struct pretty_print_context *pp,
114 const char *what, struct strbuf *sb,
115 const char *line, const char *encoding);
116 void pp_title_line(const struct pretty_print_context *pp,
117 const char **msg_p,
118 struct strbuf *sb,
119 const char *encoding,
120 int need_8bit_cte);
121 void pp_remainder(const struct pretty_print_context *pp,
122 const char **msg_p,
123 struct strbuf *sb,
124 int indent);
125
126
127 /** Removes the first commit from a list sorted by date, and adds all
128 * of its parents.
129 **/
130 struct commit *pop_most_recent_commit(struct commit_list **list,
131 unsigned int mark);
132
133 struct commit *pop_commit(struct commit_list **stack);
134
135 void clear_commit_marks(struct commit *commit, unsigned int mark);
136
137 /*
138 * Performs an in-place topological sort of list supplied.
139 *
140 * invariant of resulting list is:
141 * a reachable from b => ord(b) < ord(a)
142 * in addition, when lifo == 0, commits on parallel tracks are
143 * sorted in the dates order.
144 */
145 void sort_in_topological_order(struct commit_list ** list, int lifo);
146
147 struct commit_graft {
148 unsigned char sha1[20];
149 int nr_parent; /* < 0 if shallow commit */
150 unsigned char parent[FLEX_ARRAY][20]; /* more */
151 };
152
153 struct commit_graft *read_graft_line(char *buf, int len);
154 int register_commit_graft(struct commit_graft *, int);
155 struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
156
157 extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
158 extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos, int cleanup);
159 extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
160
161 extern int register_shallow(const unsigned char *sha1);
162 extern int unregister_shallow(const unsigned char *sha1);
163 extern int write_shallow_commits(struct strbuf *out, int use_pack_protocol);
164 extern int is_repository_shallow(void);
165 extern struct commit_list *get_shallow_commits(struct object_array *heads,
166 int depth, int shallow_flag, int not_shallow_flag);
167
168 int is_descendant_of(struct commit *, struct commit_list *);
169 int in_merge_bases(struct commit *, struct commit **, int);
170
171 extern int interactive_add(int argc, const char **argv, const char *prefix, int patch);
172 extern int run_add_interactive(const char *revision, const char *patch_mode,
173 const char **pathspec);
174
175 static inline int single_parent(struct commit *commit)
176 {
177 return commit->parents && !commit->parents->next;
178 }
179
180 struct commit_list *reduce_heads(struct commit_list *heads);
181
182 extern int commit_tree(const char *msg, unsigned char *tree,
183 struct commit_list *parents, unsigned char *ret,
184 const char *author);
185
186 #endif /* COMMIT_H */