convert run_add_interactive to use struct pathspec
[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 #include "gpg-interface.h"
9
10 struct commit_list {
11 struct commit *item;
12 struct commit_list *next;
13 };
14
15 struct commit {
16 struct object object;
17 void *util;
18 unsigned int index;
19 unsigned long date;
20 struct commit_list *parents;
21 struct tree *tree;
22 char *buffer;
23 };
24
25 extern int save_commit_buffer;
26 extern const char *commit_type;
27
28 /* While we can decorate any object with a name, it's only used for commits.. */
29 extern struct decoration name_decoration;
30 struct name_decoration {
31 struct name_decoration *next;
32 int type;
33 char name[1];
34 };
35
36 struct commit *lookup_commit(const unsigned char *sha1);
37 struct commit *lookup_commit_reference(const unsigned char *sha1);
38 struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
39 int quiet);
40 struct commit *lookup_commit_reference_by_name(const char *name);
41
42 /*
43 * Look up object named by "sha1", dereference tag as necessary,
44 * get a commit and return it. If "sha1" does not dereference to
45 * a commit, use ref_name to report an error and die.
46 */
47 struct commit *lookup_commit_or_die(const unsigned char *sha1, const char *ref_name);
48
49 int parse_commit_buffer(struct commit *item, const void *buffer, unsigned long size);
50 int parse_commit(struct commit *item);
51
52 /* Find beginning and length of commit subject. */
53 int find_commit_subject(const char *commit_buffer, const char **subject);
54
55 struct commit_list *commit_list_insert(struct commit *item,
56 struct commit_list **list);
57 struct commit_list **commit_list_append(struct commit *commit,
58 struct commit_list **next);
59 unsigned commit_list_count(const struct commit_list *l);
60 struct commit_list *commit_list_insert_by_date(struct commit *item,
61 struct commit_list **list);
62 void commit_list_sort_by_date(struct commit_list **list);
63
64 void free_commit_list(struct commit_list *list);
65
66 /* Commit formats */
67 enum cmit_fmt {
68 CMIT_FMT_RAW,
69 CMIT_FMT_MEDIUM,
70 CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
71 CMIT_FMT_SHORT,
72 CMIT_FMT_FULL,
73 CMIT_FMT_FULLER,
74 CMIT_FMT_ONELINE,
75 CMIT_FMT_EMAIL,
76 CMIT_FMT_USERFORMAT,
77
78 CMIT_FMT_UNSPECIFIED
79 };
80
81 struct pretty_print_context {
82 enum cmit_fmt fmt;
83 int abbrev;
84 const char *subject;
85 const char *after_subject;
86 int preserve_subject;
87 enum date_mode date_mode;
88 unsigned date_mode_explicit:1;
89 int need_8bit_cte;
90 char *notes_message;
91 struct reflog_walk_info *reflog_info;
92 const char *output_encoding;
93 struct string_list *mailmap;
94 int color;
95 };
96
97 struct userformat_want {
98 unsigned notes:1;
99 };
100
101 extern int has_non_ascii(const char *text);
102 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
103 extern char *logmsg_reencode(const struct commit *commit,
104 char **commit_encoding,
105 const char *output_encoding);
106 extern void logmsg_free(char *msg, const struct commit *commit);
107 extern void get_commit_format(const char *arg, struct rev_info *);
108 extern const char *format_subject(struct strbuf *sb, const char *msg,
109 const char *line_separator);
110 extern void userformat_find_requirements(const char *fmt, struct userformat_want *w);
111 extern void format_commit_message(const struct commit *commit,
112 const char *format, struct strbuf *sb,
113 const struct pretty_print_context *context);
114 extern void pretty_print_commit(const struct pretty_print_context *pp,
115 const struct commit *commit,
116 struct strbuf *sb);
117 extern void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
118 struct strbuf *sb);
119 void pp_user_info(const struct pretty_print_context *pp,
120 const char *what, struct strbuf *sb,
121 const char *line, const char *encoding);
122 void pp_title_line(const struct pretty_print_context *pp,
123 const char **msg_p,
124 struct strbuf *sb,
125 const char *encoding,
126 int need_8bit_cte);
127 void pp_remainder(const struct pretty_print_context *pp,
128 const char **msg_p,
129 struct strbuf *sb,
130 int indent);
131
132
133 /** Removes the first commit from a list sorted by date, and adds all
134 * of its parents.
135 **/
136 struct commit *pop_most_recent_commit(struct commit_list **list,
137 unsigned int mark);
138
139 struct commit *pop_commit(struct commit_list **stack);
140
141 void clear_commit_marks(struct commit *commit, unsigned int mark);
142 void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark);
143 void clear_commit_marks_for_object_array(struct object_array *a, unsigned mark);
144
145
146 enum rev_sort_order {
147 REV_SORT_IN_GRAPH_ORDER = 0,
148 REV_SORT_BY_COMMIT_DATE,
149 REV_SORT_BY_AUTHOR_DATE
150 };
151
152 /*
153 * Performs an in-place topological sort of list supplied.
154 *
155 * invariant of resulting list is:
156 * a reachable from b => ord(b) < ord(a)
157 * sort_order further specifies:
158 * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
159 * chain together.
160 * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
161 */
162 void sort_in_topological_order(struct commit_list **, enum rev_sort_order);
163
164 struct commit_graft {
165 unsigned char sha1[20];
166 int nr_parent; /* < 0 if shallow commit */
167 unsigned char parent[FLEX_ARRAY][20]; /* more */
168 };
169 typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
170
171 struct commit_graft *read_graft_line(char *buf, int len);
172 int register_commit_graft(struct commit_graft *, int);
173 struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
174
175 extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
176 extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos, int cleanup);
177 extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
178
179 /* largest positive number a signed 32-bit integer can contain */
180 #define INFINITE_DEPTH 0x7fffffff
181
182 extern int register_shallow(const unsigned char *sha1);
183 extern int unregister_shallow(const unsigned char *sha1);
184 extern int for_each_commit_graft(each_commit_graft_fn, void *);
185 extern int is_repository_shallow(void);
186 extern struct commit_list *get_shallow_commits(struct object_array *heads,
187 int depth, int shallow_flag, int not_shallow_flag);
188 extern void check_shallow_file_for_update(void);
189 extern void set_alternate_shallow_file(const char *path);
190
191 int is_descendant_of(struct commit *, struct commit_list *);
192 int in_merge_bases(struct commit *, struct commit *);
193 int in_merge_bases_many(struct commit *, int, struct commit **);
194
195 extern int interactive_add(int argc, const char **argv, const char *prefix, int patch);
196 extern int run_add_interactive(const char *revision, const char *patch_mode,
197 const struct pathspec *pathspec);
198
199 static inline int single_parent(struct commit *commit)
200 {
201 return commit->parents && !commit->parents->next;
202 }
203
204 struct commit_list *reduce_heads(struct commit_list *heads);
205
206 struct commit_extra_header {
207 struct commit_extra_header *next;
208 char *key;
209 char *value;
210 size_t len;
211 };
212
213 extern void append_merge_tag_headers(struct commit_list *parents,
214 struct commit_extra_header ***tail);
215
216 extern int commit_tree(const struct strbuf *msg, unsigned char *tree,
217 struct commit_list *parents, unsigned char *ret,
218 const char *author, const char *sign_commit);
219
220 extern int commit_tree_extended(const struct strbuf *msg, unsigned char *tree,
221 struct commit_list *parents, unsigned char *ret,
222 const char *author, const char *sign_commit,
223 struct commit_extra_header *);
224
225 extern struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
226
227 extern void free_commit_extra_headers(struct commit_extra_header *extra);
228
229 struct merge_remote_desc {
230 struct object *obj; /* the named object, could be a tag */
231 const char *name;
232 };
233 #define merge_remote_util(commit) ((struct merge_remote_desc *)((commit)->util))
234
235 /*
236 * Given "name" from the command line to merge, find the commit object
237 * and return it, while storing merge_remote_desc in its ->util field,
238 * to allow callers to tell if we are told to merge a tag.
239 */
240 struct commit *get_merge_parent(const char *name);
241
242 extern int parse_signed_commit(const unsigned char *sha1,
243 struct strbuf *message, struct strbuf *signature);
244 extern void print_commit_list(struct commit_list *list,
245 const char *format_cur,
246 const char *format_last);
247
248 /*
249 * Check the signature of the given commit. The result of the check is stored
250 * in sig->check_result, 'G' for a good signature, 'U' for a good signature
251 * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
252 * at all. This may allocate memory for sig->gpg_output, sig->gpg_status,
253 * sig->signer and sig->key.
254 */
255 extern void check_commit_signature(const struct commit* commit, struct signature_check *sigc);
256
257 #endif /* COMMIT_H */