Add const to parse_{commit,tag}_buffer()
[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, const void *buffer, unsigned long size);
42 int parse_commit(struct commit *item);
43
44 /* Find beginning and length of commit subject. */
45 int find_commit_subject(const char *commit_buffer, const char **subject);
46
47 struct commit_list *commit_list_insert(struct commit *item,
48 struct commit_list **list);
49 unsigned commit_list_count(const struct commit_list *l);
50 struct commit_list *commit_list_insert_by_date(struct commit *item,
51 struct commit_list **list);
52 void commit_list_sort_by_date(struct commit_list **list);
53
54 void free_commit_list(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 const char *output_encoding;
81 };
82
83 struct userformat_want {
84 unsigned notes:1;
85 };
86
87 extern int has_non_ascii(const char *text);
88 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
89 extern char *logmsg_reencode(const struct commit *commit,
90 const char *output_encoding);
91 extern char *reencode_commit_message(const struct commit *commit,
92 const char **encoding_p);
93 extern void get_commit_format(const char *arg, struct rev_info *);
94 extern void userformat_find_requirements(const char *fmt, struct userformat_want *w);
95 extern void format_commit_message(const struct commit *commit,
96 const char *format, struct strbuf *sb,
97 const struct pretty_print_context *context);
98 extern void pretty_print_commit(enum cmit_fmt fmt, const struct commit *commit,
99 struct strbuf *sb,
100 const struct pretty_print_context *context);
101 void pp_user_info(const char *what, enum cmit_fmt fmt, struct strbuf *sb,
102 const char *line, enum date_mode dmode,
103 const char *encoding);
104 void pp_title_line(enum cmit_fmt fmt,
105 const char **msg_p,
106 struct strbuf *sb,
107 const char *subject,
108 const char *after_subject,
109 const char *encoding,
110 int need_8bit_cte);
111 void pp_remainder(enum cmit_fmt fmt,
112 const char **msg_p,
113 struct strbuf *sb,
114 int indent);
115
116
117 /** Removes the first commit from a list sorted by date, and adds all
118 * of its parents.
119 **/
120 struct commit *pop_most_recent_commit(struct commit_list **list,
121 unsigned int mark);
122
123 struct commit *pop_commit(struct commit_list **stack);
124
125 void clear_commit_marks(struct commit *commit, unsigned int mark);
126
127 /*
128 * Performs an in-place topological sort of list supplied.
129 *
130 * invariant of resulting list is:
131 * a reachable from b => ord(b) < ord(a)
132 * in addition, when lifo == 0, commits on parallel tracks are
133 * sorted in the dates order.
134 */
135 void sort_in_topological_order(struct commit_list ** list, int lifo);
136
137 struct commit_graft {
138 unsigned char sha1[20];
139 int nr_parent; /* < 0 if shallow commit */
140 unsigned char parent[FLEX_ARRAY][20]; /* more */
141 };
142
143 struct commit_graft *read_graft_line(char *buf, int len);
144 int register_commit_graft(struct commit_graft *, int);
145 struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
146
147 const unsigned char *lookup_replace_object(const unsigned char *sha1);
148
149 extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
150 extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos, int cleanup);
151 extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
152
153 extern int register_shallow(const unsigned char *sha1);
154 extern int unregister_shallow(const unsigned char *sha1);
155 extern int write_shallow_commits(struct strbuf *out, int use_pack_protocol);
156 extern int is_repository_shallow(void);
157 extern struct commit_list *get_shallow_commits(struct object_array *heads,
158 int depth, int shallow_flag, int not_shallow_flag);
159
160 int is_descendant_of(struct commit *, struct commit_list *);
161 int in_merge_bases(struct commit *, struct commit **, int);
162
163 extern int interactive_add(int argc, const char **argv, const char *prefix);
164 extern int run_add_interactive(const char *revision, const char *patch_mode,
165 const char **pathspec);
166
167 static inline int single_parent(struct commit *commit)
168 {
169 return commit->parents && !commit->parents->next;
170 }
171
172 struct commit_list *reduce_heads(struct commit_list *heads);
173
174 extern int commit_tree(const char *msg, unsigned char *tree,
175 struct commit_list *parents, unsigned char *ret,
176 const char *author);
177
178 #endif /* COMMIT_H */