fast-import: fix read of uninitialized argv memory
[git.git] / commit.h
bloba9f177ba488a7002409eb2cdee1f7e9c3673529f
1 #ifndef COMMIT_H
2 #define COMMIT_H
4 #include "object.h"
5 #include "tree.h"
6 #include "strbuf.h"
7 #include "decorate.h"
8 #include "gpg-interface.h"
9 #include "string-list.h"
11 struct commit_list {
12 struct commit *item;
13 struct commit_list *next;
16 struct commit {
17 struct object object;
18 void *util;
19 unsigned int index;
20 unsigned long date;
21 struct commit_list *parents;
22 struct tree *tree;
23 char *buffer;
26 extern int save_commit_buffer;
27 extern const char *commit_type;
29 /* While we can decorate any object with a name, it's only used for commits.. */
30 extern struct decoration name_decoration;
31 struct name_decoration {
32 struct name_decoration *next;
33 int type;
34 char name[1];
37 struct commit *lookup_commit(const unsigned char *sha1);
38 struct commit *lookup_commit_reference(const unsigned char *sha1);
39 struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
40 int quiet);
41 struct commit *lookup_commit_reference_by_name(const char *name);
44 * Look up object named by "sha1", dereference tag as necessary,
45 * get a commit and return it. If "sha1" does not dereference to
46 * a commit, use ref_name to report an error and die.
48 struct commit *lookup_commit_or_die(const unsigned char *sha1, const char *ref_name);
50 int parse_commit_buffer(struct commit *item, const void *buffer, unsigned long size);
51 int parse_commit(struct commit *item);
52 void parse_commit_or_die(struct commit *item);
54 /* Find beginning and length of commit subject. */
55 int find_commit_subject(const char *commit_buffer, const char **subject);
57 struct commit_list *commit_list_insert(struct commit *item,
58 struct commit_list **list);
59 struct commit_list **commit_list_append(struct commit *commit,
60 struct commit_list **next);
61 unsigned commit_list_count(const struct commit_list *l);
62 struct commit_list *commit_list_insert_by_date(struct commit *item,
63 struct commit_list **list);
64 void commit_list_sort_by_date(struct commit_list **list);
66 /* Shallow copy of the input list */
67 struct commit_list *copy_commit_list(struct commit_list *list);
69 void free_commit_list(struct commit_list *list);
71 /* Commit formats */
72 enum cmit_fmt {
73 CMIT_FMT_RAW,
74 CMIT_FMT_MEDIUM,
75 CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
76 CMIT_FMT_SHORT,
77 CMIT_FMT_FULL,
78 CMIT_FMT_FULLER,
79 CMIT_FMT_ONELINE,
80 CMIT_FMT_EMAIL,
81 CMIT_FMT_USERFORMAT,
83 CMIT_FMT_UNSPECIFIED
86 struct pretty_print_context {
88 * Callers should tweak these to change the behavior of pp_* functions.
90 enum cmit_fmt fmt;
91 int abbrev;
92 const char *subject;
93 const char *after_subject;
94 int preserve_subject;
95 enum date_mode date_mode;
96 unsigned date_mode_explicit:1;
97 int need_8bit_cte;
98 char *notes_message;
99 struct reflog_walk_info *reflog_info;
100 const char *output_encoding;
101 struct string_list *mailmap;
102 int color;
103 struct ident_split *from_ident;
106 * Fields below here are manipulated internally by pp_* functions and
107 * should not be counted on by callers.
109 struct string_list in_body_headers;
112 struct userformat_want {
113 unsigned notes:1;
116 extern int has_non_ascii(const char *text);
117 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
118 extern char *logmsg_reencode(const struct commit *commit,
119 char **commit_encoding,
120 const char *output_encoding);
121 extern void logmsg_free(char *msg, const struct commit *commit);
122 extern void get_commit_format(const char *arg, struct rev_info *);
123 extern const char *format_subject(struct strbuf *sb, const char *msg,
124 const char *line_separator);
125 extern void userformat_find_requirements(const char *fmt, struct userformat_want *w);
126 extern void format_commit_message(const struct commit *commit,
127 const char *format, struct strbuf *sb,
128 const struct pretty_print_context *context);
129 extern void pretty_print_commit(struct pretty_print_context *pp,
130 const struct commit *commit,
131 struct strbuf *sb);
132 extern void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
133 struct strbuf *sb);
134 void pp_user_info(struct pretty_print_context *pp,
135 const char *what, struct strbuf *sb,
136 const char *line, const char *encoding);
137 void pp_title_line(struct pretty_print_context *pp,
138 const char **msg_p,
139 struct strbuf *sb,
140 const char *encoding,
141 int need_8bit_cte);
142 void pp_remainder(struct pretty_print_context *pp,
143 const char **msg_p,
144 struct strbuf *sb,
145 int indent);
148 /** Removes the first commit from a list sorted by date, and adds all
149 * of its parents.
151 struct commit *pop_most_recent_commit(struct commit_list **list,
152 unsigned int mark);
154 struct commit *pop_commit(struct commit_list **stack);
156 void clear_commit_marks(struct commit *commit, unsigned int mark);
157 void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark);
158 void clear_commit_marks_for_object_array(struct object_array *a, unsigned mark);
161 enum rev_sort_order {
162 REV_SORT_IN_GRAPH_ORDER = 0,
163 REV_SORT_BY_COMMIT_DATE,
164 REV_SORT_BY_AUTHOR_DATE
168 * Performs an in-place topological sort of list supplied.
170 * invariant of resulting list is:
171 * a reachable from b => ord(b) < ord(a)
172 * sort_order further specifies:
173 * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
174 * chain together.
175 * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
177 void sort_in_topological_order(struct commit_list **, enum rev_sort_order);
179 struct commit_graft {
180 unsigned char sha1[20];
181 int nr_parent; /* < 0 if shallow commit */
182 unsigned char parent[FLEX_ARRAY][20]; /* more */
184 typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
186 struct commit_graft *read_graft_line(char *buf, int len);
187 int register_commit_graft(struct commit_graft *, int);
188 struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
190 extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
191 extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos, int cleanup);
192 extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
194 /* largest positive number a signed 32-bit integer can contain */
195 #define INFINITE_DEPTH 0x7fffffff
197 struct sha1_array;
198 struct ref;
199 extern int register_shallow(const unsigned char *sha1);
200 extern int unregister_shallow(const unsigned char *sha1);
201 extern int for_each_commit_graft(each_commit_graft_fn, void *);
202 extern int is_repository_shallow(void);
203 extern struct commit_list *get_shallow_commits(struct object_array *heads,
204 int depth, int shallow_flag, int not_shallow_flag);
205 extern void check_shallow_file_for_update(void);
206 extern void set_alternate_shallow_file(const char *path, int override);
207 extern int write_shallow_commits(struct strbuf *out, int use_pack_protocol,
208 const struct sha1_array *extra);
209 extern void setup_alternate_shallow(struct lock_file *shallow_lock,
210 const char **alternate_shallow_file,
211 const struct sha1_array *extra);
212 extern const char *setup_temporary_shallow(const struct sha1_array *extra);
213 extern void advertise_shallow_grafts(int);
215 struct shallow_info {
216 struct sha1_array *shallow;
217 int *ours, nr_ours;
218 int *theirs, nr_theirs;
219 struct sha1_array *ref;
221 /* for receive-pack */
222 uint32_t **used_shallow;
223 int *need_reachability_test;
224 int *reachable;
225 int *shallow_ref;
226 struct commit **commits;
227 int nr_commits;
230 extern void prepare_shallow_info(struct shallow_info *, struct sha1_array *);
231 extern void clear_shallow_info(struct shallow_info *);
232 extern void remove_nonexistent_theirs_shallow(struct shallow_info *);
233 extern void assign_shallow_commits_to_refs(struct shallow_info *info,
234 uint32_t **used,
235 int *ref_status);
236 extern int delayed_reachability_test(struct shallow_info *si, int c);
237 extern void prune_shallow(int show_only);
239 int is_descendant_of(struct commit *, struct commit_list *);
240 int in_merge_bases(struct commit *, struct commit *);
241 int in_merge_bases_many(struct commit *, int, struct commit **);
243 extern int interactive_add(int argc, const char **argv, const char *prefix, int patch);
244 extern int run_add_interactive(const char *revision, const char *patch_mode,
245 const struct pathspec *pathspec);
247 static inline int single_parent(struct commit *commit)
249 return commit->parents && !commit->parents->next;
252 struct commit_list *reduce_heads(struct commit_list *heads);
254 struct commit_extra_header {
255 struct commit_extra_header *next;
256 char *key;
257 char *value;
258 size_t len;
261 extern void append_merge_tag_headers(struct commit_list *parents,
262 struct commit_extra_header ***tail);
264 extern int commit_tree(const struct strbuf *msg, const unsigned char *tree,
265 struct commit_list *parents, unsigned char *ret,
266 const char *author, const char *sign_commit);
268 extern int commit_tree_extended(const struct strbuf *msg, const unsigned char *tree,
269 struct commit_list *parents, unsigned char *ret,
270 const char *author, const char *sign_commit,
271 struct commit_extra_header *);
273 extern struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
275 extern void free_commit_extra_headers(struct commit_extra_header *extra);
277 struct merge_remote_desc {
278 struct object *obj; /* the named object, could be a tag */
279 const char *name;
281 #define merge_remote_util(commit) ((struct merge_remote_desc *)((commit)->util))
284 * Given "name" from the command line to merge, find the commit object
285 * and return it, while storing merge_remote_desc in its ->util field,
286 * to allow callers to tell if we are told to merge a tag.
288 struct commit *get_merge_parent(const char *name);
290 extern int parse_signed_commit(const unsigned char *sha1,
291 struct strbuf *message, struct strbuf *signature);
292 extern void print_commit_list(struct commit_list *list,
293 const char *format_cur,
294 const char *format_last);
297 * Check the signature of the given commit. The result of the check is stored
298 * in sig->check_result, 'G' for a good signature, 'U' for a good signature
299 * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
300 * at all. This may allocate memory for sig->gpg_output, sig->gpg_status,
301 * sig->signer and sig->key.
303 extern void check_commit_signature(const struct commit* commit, struct signature_check *sigc);
305 int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused);
307 LAST_ARG_MUST_BE_NULL
308 extern int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...);
310 #endif /* COMMIT_H */