ls-tree: disable negative pathspec because it's not supported
[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 #include "string-list.h"
10
11 struct commit_list {
12         struct commit *item;
13         struct commit_list *next;
14 };
15
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 };
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 struct name_decoration {
30         struct name_decoration *next;
31         int type;
32         char name[FLEX_ARRAY];
33 };
34
35 enum decoration_type {
36         DECORATION_NONE = 0,
37         DECORATION_REF_LOCAL,
38         DECORATION_REF_REMOTE,
39         DECORATION_REF_TAG,
40         DECORATION_REF_STASH,
41         DECORATION_REF_HEAD,
42         DECORATION_GRAFTED,
43 };
44
45 void add_name_decoration(enum decoration_type type, const char *name, struct object *obj);
46 const struct name_decoration *get_name_decoration(const struct object *obj);
47
48 struct commit *lookup_commit(const unsigned char *sha1);
49 struct commit *lookup_commit_reference(const unsigned char *sha1);
50 struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
51                                               int quiet);
52 struct commit *lookup_commit_reference_by_name(const char *name);
53
54 /*
55  * Look up object named by "sha1", dereference tag as necessary,
56  * get a commit and return it. If "sha1" does not dereference to
57  * a commit, use ref_name to report an error and die.
58  */
59 struct commit *lookup_commit_or_die(const unsigned char *sha1, const char *ref_name);
60
61 int parse_commit_buffer(struct commit *item, const void *buffer, unsigned long size);
62 int parse_commit(struct commit *item);
63 void parse_commit_or_die(struct commit *item);
64
65 /*
66  * Associate an object buffer with the commit. The ownership of the
67  * memory is handed over to the commit, and must be free()-able.
68  */
69 void set_commit_buffer(struct commit *, void *buffer, unsigned long size);
70
71 /*
72  * Get any cached object buffer associated with the commit. Returns NULL
73  * if none. The resulting memory should not be freed.
74  */
75 const void *get_cached_commit_buffer(const struct commit *, unsigned long *size);
76
77 /*
78  * Get the commit's object contents, either from cache or by reading the object
79  * from disk. The resulting memory should not be modified, and must be given
80  * to unuse_commit_buffer when the caller is done.
81  */
82 const void *get_commit_buffer(const struct commit *, unsigned long *size);
83
84 /*
85  * Tell the commit subsytem that we are done with a particular commit buffer.
86  * The commit and buffer should be the input and return value, respectively,
87  * from an earlier call to get_commit_buffer.  The buffer may or may not be
88  * freed by this call; callers should not access the memory afterwards.
89  */
90 void unuse_commit_buffer(const struct commit *, const void *buffer);
91
92 /*
93  * Free any cached object buffer associated with the commit.
94  */
95 void free_commit_buffer(struct commit *);
96
97 /*
98  * Disassociate any cached object buffer from the commit, but do not free it.
99  * The buffer (or NULL, if none) is returned.
100  */
101 const void *detach_commit_buffer(struct commit *, unsigned long *sizep);
102
103 /* Find beginning and length of commit subject. */
104 int find_commit_subject(const char *commit_buffer, const char **subject);
105
106 struct commit_list *commit_list_insert(struct commit *item,
107                                         struct commit_list **list);
108 struct commit_list **commit_list_append(struct commit *commit,
109                                         struct commit_list **next);
110 unsigned commit_list_count(const struct commit_list *l);
111 struct commit_list *commit_list_insert_by_date(struct commit *item,
112                                     struct commit_list **list);
113 void commit_list_sort_by_date(struct commit_list **list);
114
115 /* Shallow copy of the input list */
116 struct commit_list *copy_commit_list(struct commit_list *list);
117
118 void free_commit_list(struct commit_list *list);
119
120 /* Commit formats */
121 enum cmit_fmt {
122         CMIT_FMT_RAW,
123         CMIT_FMT_MEDIUM,
124         CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
125         CMIT_FMT_SHORT,
126         CMIT_FMT_FULL,
127         CMIT_FMT_FULLER,
128         CMIT_FMT_ONELINE,
129         CMIT_FMT_EMAIL,
130         CMIT_FMT_USERFORMAT,
131
132         CMIT_FMT_UNSPECIFIED
133 };
134
135 struct pretty_print_context {
136         /*
137          * Callers should tweak these to change the behavior of pp_* functions.
138          */
139         enum cmit_fmt fmt;
140         int abbrev;
141         const char *subject;
142         const char *after_subject;
143         int preserve_subject;
144         enum date_mode date_mode;
145         unsigned date_mode_explicit:1;
146         int need_8bit_cte;
147         char *notes_message;
148         struct reflog_walk_info *reflog_info;
149         const char *output_encoding;
150         struct string_list *mailmap;
151         int color;
152         struct ident_split *from_ident;
153
154         /*
155          * Fields below here are manipulated internally by pp_* functions and
156          * should not be counted on by callers.
157          */
158         struct string_list in_body_headers;
159 };
160
161 struct userformat_want {
162         unsigned notes:1;
163 };
164
165 extern int has_non_ascii(const char *text);
166 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
167 extern const char *logmsg_reencode(const struct commit *commit,
168                                    char **commit_encoding,
169                                    const char *output_encoding);
170 extern void get_commit_format(const char *arg, struct rev_info *);
171 extern const char *format_subject(struct strbuf *sb, const char *msg,
172                                   const char *line_separator);
173 extern void userformat_find_requirements(const char *fmt, struct userformat_want *w);
174 extern int commit_format_is_empty(enum cmit_fmt);
175 extern void format_commit_message(const struct commit *commit,
176                                   const char *format, struct strbuf *sb,
177                                   const struct pretty_print_context *context);
178 extern void pretty_print_commit(struct pretty_print_context *pp,
179                                 const struct commit *commit,
180                                 struct strbuf *sb);
181 extern void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
182                            struct strbuf *sb);
183 void pp_user_info(struct pretty_print_context *pp,
184                   const char *what, struct strbuf *sb,
185                   const char *line, const char *encoding);
186 void pp_title_line(struct pretty_print_context *pp,
187                    const char **msg_p,
188                    struct strbuf *sb,
189                    const char *encoding,
190                    int need_8bit_cte);
191 void pp_remainder(struct pretty_print_context *pp,
192                   const char **msg_p,
193                   struct strbuf *sb,
194                   int indent);
195
196
197 /** Removes the first commit from a list sorted by date, and adds all
198  * of its parents.
199  **/
200 struct commit *pop_most_recent_commit(struct commit_list **list,
201                                       unsigned int mark);
202
203 struct commit *pop_commit(struct commit_list **stack);
204
205 void clear_commit_marks(struct commit *commit, unsigned int mark);
206 void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark);
207 void clear_commit_marks_for_object_array(struct object_array *a, unsigned mark);
208
209
210 enum rev_sort_order {
211         REV_SORT_IN_GRAPH_ORDER = 0,
212         REV_SORT_BY_COMMIT_DATE,
213         REV_SORT_BY_AUTHOR_DATE
214 };
215
216 /*
217  * Performs an in-place topological sort of list supplied.
218  *
219  *   invariant of resulting list is:
220  *      a reachable from b => ord(b) < ord(a)
221  *   sort_order further specifies:
222  *   REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
223  *                            chain together.
224  *   REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
225  */
226 void sort_in_topological_order(struct commit_list **, enum rev_sort_order);
227
228 struct commit_graft {
229         unsigned char sha1[20];
230         int nr_parent; /* < 0 if shallow commit */
231         unsigned char parent[FLEX_ARRAY][20]; /* more */
232 };
233 typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
234
235 struct commit_graft *read_graft_line(char *buf, int len);
236 int register_commit_graft(struct commit_graft *, int);
237 struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
238
239 extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
240 extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos, int cleanup);
241 extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
242
243 /* largest positive number a signed 32-bit integer can contain */
244 #define INFINITE_DEPTH 0x7fffffff
245
246 struct sha1_array;
247 struct ref;
248 extern int register_shallow(const unsigned char *sha1);
249 extern int unregister_shallow(const unsigned char *sha1);
250 extern int for_each_commit_graft(each_commit_graft_fn, void *);
251 extern int is_repository_shallow(void);
252 extern struct commit_list *get_shallow_commits(struct object_array *heads,
253                 int depth, int shallow_flag, int not_shallow_flag);
254 extern void check_shallow_file_for_update(void);
255 extern void set_alternate_shallow_file(const char *path, int override);
256 extern int write_shallow_commits(struct strbuf *out, int use_pack_protocol,
257                                  const struct sha1_array *extra);
258 extern void setup_alternate_shallow(struct lock_file *shallow_lock,
259                                     const char **alternate_shallow_file,
260                                     const struct sha1_array *extra);
261 extern const char *setup_temporary_shallow(const struct sha1_array *extra);
262 extern void advertise_shallow_grafts(int);
263
264 struct shallow_info {
265         struct sha1_array *shallow;
266         int *ours, nr_ours;
267         int *theirs, nr_theirs;
268         struct sha1_array *ref;
269
270         /* for receive-pack */
271         uint32_t **used_shallow;
272         int *need_reachability_test;
273         int *reachable;
274         int *shallow_ref;
275         struct commit **commits;
276         int nr_commits;
277 };
278
279 extern void prepare_shallow_info(struct shallow_info *, struct sha1_array *);
280 extern void clear_shallow_info(struct shallow_info *);
281 extern void remove_nonexistent_theirs_shallow(struct shallow_info *);
282 extern void assign_shallow_commits_to_refs(struct shallow_info *info,
283                                            uint32_t **used,
284                                            int *ref_status);
285 extern int delayed_reachability_test(struct shallow_info *si, int c);
286 extern void prune_shallow(int show_only);
287 extern struct trace_key trace_shallow;
288
289 int is_descendant_of(struct commit *, struct commit_list *);
290 int in_merge_bases(struct commit *, struct commit *);
291 int in_merge_bases_many(struct commit *, int, struct commit **);
292
293 extern int interactive_add(int argc, const char **argv, const char *prefix, int patch);
294 extern int run_add_interactive(const char *revision, const char *patch_mode,
295                                const struct pathspec *pathspec);
296
297 static inline int single_parent(struct commit *commit)
298 {
299         return commit->parents && !commit->parents->next;
300 }
301
302 struct commit_list *reduce_heads(struct commit_list *heads);
303
304 struct commit_extra_header {
305         struct commit_extra_header *next;
306         char *key;
307         char *value;
308         size_t len;
309 };
310
311 extern void append_merge_tag_headers(struct commit_list *parents,
312                                      struct commit_extra_header ***tail);
313
314 extern int commit_tree(const char *msg, size_t msg_len,
315                        const unsigned char *tree,
316                        struct commit_list *parents, unsigned char *ret,
317                        const char *author, const char *sign_commit);
318
319 extern int commit_tree_extended(const char *msg, size_t msg_len,
320                                 const unsigned char *tree,
321                                 struct commit_list *parents, unsigned char *ret,
322                                 const char *author, const char *sign_commit,
323                                 struct commit_extra_header *);
324
325 extern struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
326
327 extern void free_commit_extra_headers(struct commit_extra_header *extra);
328
329 /*
330  * Search the commit object contents given by "msg" for the header "key".
331  * Returns a pointer to the start of the header contents, or NULL. The length
332  * of the header, up to the first newline, is returned via out_len.
333  *
334  * Note that some headers (like mergetag) may be multi-line. It is the caller's
335  * responsibility to parse further in this case!
336  */
337 extern const char *find_commit_header(const char *msg, const char *key,
338                                       size_t *out_len);
339
340 typedef void (*each_mergetag_fn)(struct commit *commit, struct commit_extra_header *extra,
341                                  void *cb_data);
342
343 extern void for_each_mergetag(each_mergetag_fn fn, struct commit *commit, void *data);
344
345 struct merge_remote_desc {
346         struct object *obj; /* the named object, could be a tag */
347         const char *name;
348 };
349 #define merge_remote_util(commit) ((struct merge_remote_desc *)((commit)->util))
350
351 /*
352  * Given "name" from the command line to merge, find the commit object
353  * and return it, while storing merge_remote_desc in its ->util field,
354  * to allow callers to tell if we are told to merge a tag.
355  */
356 struct commit *get_merge_parent(const char *name);
357
358 extern int parse_signed_commit(const struct commit *commit,
359                                struct strbuf *message, struct strbuf *signature);
360 extern int remove_signature(struct strbuf *buf);
361
362 extern void print_commit_list(struct commit_list *list,
363                               const char *format_cur,
364                               const char *format_last);
365
366 /*
367  * Check the signature of the given commit. The result of the check is stored
368  * in sig->check_result, 'G' for a good signature, 'U' for a good signature
369  * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
370  * at all.  This may allocate memory for sig->gpg_output, sig->gpg_status,
371  * sig->signer and sig->key.
372  */
373 extern void check_commit_signature(const struct commit *commit, struct signature_check *sigc);
374
375 int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused);
376
377 LAST_ARG_MUST_BE_NULL
378 extern int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...);
379
380 #endif /* COMMIT_H */