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
9struct commit_list {
10 struct commit *item;
11 struct commit_list *next;
12};
13
14struct 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
24extern int save_commit_buffer;
25extern const char *commit_type;
26
27/* While we can decorate any object with a name, it's only used for commits.. */
28extern struct decoration name_decoration;
29struct name_decoration {
30 struct name_decoration *next;
31 char name[1];
32};
33
34struct commit *lookup_commit(const unsigned char *sha1);
35struct commit *lookup_commit_reference(const unsigned char *sha1);
36struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
37 int quiet);
38
39int parse_commit_buffer(struct commit *item, void *buffer, unsigned long size);
40
41int parse_commit(struct commit *item);
42
43/* Find beginning and length of commit subject. */
44int find_commit_subject(const char *commit_buffer, const char **subject);
45
46struct commit_list * commit_list_insert(struct commit *item, struct commit_list **list_p);
47unsigned commit_list_count(const struct commit_list *l);
48struct commit_list * insert_by_date(struct commit *item, struct commit_list **list);
49
50void free_commit_list(struct commit_list *list);
51
52void sort_by_date(struct commit_list **list);
53
54/* Commit formats */
55enum cmit_fmt {
56 CMIT_FMT_RAW,
57 CMIT_FMT_MEDIUM,
58 CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
59 CMIT_FMT_SHORT,
60 CMIT_FMT_FULL,
61 CMIT_FMT_FULLER,
62 CMIT_FMT_ONELINE,
63 CMIT_FMT_EMAIL,
64 CMIT_FMT_USERFORMAT,
65
66 CMIT_FMT_UNSPECIFIED,
67};
68
69struct pretty_print_context
70{
71 int abbrev;
72 const char *subject;
73 const char *after_subject;
74 enum date_mode date_mode;
75 int need_8bit_cte;
76 int show_notes;
77 struct reflog_walk_info *reflog_info;
78};
79
80struct userformat_want {
81 unsigned notes:1;
82};
83
84extern int has_non_ascii(const char *text);
85struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
86extern char *reencode_commit_message(const struct commit *commit,
87 const char **encoding_p);
88extern void get_commit_format(const char *arg, struct rev_info *);
89extern void userformat_find_requirements(const char *fmt, struct userformat_want *w);
90extern void format_commit_message(const struct commit *commit,
91 const char *format, struct strbuf *sb,
92 const struct pretty_print_context *context);
93extern void pretty_print_commit(enum cmit_fmt fmt, const struct commit *commit,
94 struct strbuf *sb,
95 const struct pretty_print_context *context);
96void pp_user_info(const char *what, enum cmit_fmt fmt, struct strbuf *sb,
97 const char *line, enum date_mode dmode,
98 const char *encoding);
99void pp_title_line(enum cmit_fmt fmt,
100 const char **msg_p,
101 struct strbuf *sb,
102 const char *subject,
103 const char *after_subject,
104 const char *encoding,
105 int need_8bit_cte);
106void pp_remainder(enum cmit_fmt fmt,
107 const char **msg_p,
108 struct strbuf *sb,
109 int indent);
110
111
112/** Removes the first commit from a list sorted by date, and adds all
113 * of its parents.
114 **/
115struct commit *pop_most_recent_commit(struct commit_list **list,
116 unsigned int mark);
117
118struct commit *pop_commit(struct commit_list **stack);
119
120void clear_commit_marks(struct commit *commit, unsigned int mark);
121
122/*
123 * Performs an in-place topological sort of list supplied.
124 *
125 * invariant of resulting list is:
126 * a reachable from b => ord(b) < ord(a)
127 * in addition, when lifo == 0, commits on parallel tracks are
128 * sorted in the dates order.
129 */
130void sort_in_topological_order(struct commit_list ** list, int lifo);
131
132struct commit_graft {
133 unsigned char sha1[20];
134 int nr_parent; /* < 0 if shallow commit */
135 unsigned char parent[FLEX_ARRAY][20]; /* more */
136};
137
138struct commit_graft *read_graft_line(char *buf, int len);
139int register_commit_graft(struct commit_graft *, int);
140struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
141
142const unsigned char *lookup_replace_object(const unsigned char *sha1);
143
144extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
145extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos, int cleanup);
146extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
147
148extern int register_shallow(const unsigned char *sha1);
149extern int unregister_shallow(const unsigned char *sha1);
150extern int write_shallow_commits(struct strbuf *out, int use_pack_protocol);
151extern int is_repository_shallow(void);
152extern struct commit_list *get_shallow_commits(struct object_array *heads,
153 int depth, int shallow_flag, int not_shallow_flag);
154
155int is_descendant_of(struct commit *, struct commit_list *);
156int in_merge_bases(struct commit *, struct commit **, int);
157
158extern int interactive_add(int argc, const char **argv, const char *prefix);
159extern int run_add_interactive(const char *revision, const char *patch_mode,
160 const char **pathspec);
161
162static inline int single_parent(struct commit *commit)
163{
164 return commit->parents && !commit->parents->next;
165}
166
167struct commit_list *reduce_heads(struct commit_list *heads);
168
169#endif /* COMMIT_H */