diff-options.txt: describe --stat-{width,name-width,count}
[git/dscho.git] / commit.h
blobb3c3bb70c5e737ed18df7ca665c85e339e1f3292
1 #ifndef COMMIT_H
2 #define COMMIT_H
4 #include "object.h"
5 #include "tree.h"
6 #include "strbuf.h"
7 #include "decorate.h"
9 struct commit_list {
10         struct commit *item;
11         struct commit_list *next;
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;
24 extern int save_commit_buffer;
25 extern const char *commit_type;
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];
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);
41 int parse_commit_buffer(struct commit *item, const void *buffer, unsigned long size);
42 int parse_commit(struct commit *item);
44 /* Find beginning and length of commit subject. */
45 int find_commit_subject(const char *commit_buffer, const char **subject);
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);
54 void free_commit_list(struct commit_list *list);
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,
68         CMIT_FMT_UNSPECIFIED
71 struct pretty_print_context {
72         int abbrev;
73         const char *subject;
74         const char *after_subject;
75         enum date_mode date_mode;
76         int need_8bit_cte;
77         int show_notes;
78         struct reflog_walk_info *reflog_info;
79         const char *output_encoding;
82 struct userformat_want {
83         unsigned notes:1;
86 extern int has_non_ascii(const char *text);
87 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
88 extern char *logmsg_reencode(const struct commit *commit,
89                              const char *output_encoding);
90 extern char *reencode_commit_message(const struct commit *commit,
91                                      const char **encoding_p);
92 extern void get_commit_format(const char *arg, struct rev_info *);
93 extern const char *format_subject(struct strbuf *sb, const char *msg,
94                                   const char *line_separator);
95 extern void userformat_find_requirements(const char *fmt, struct userformat_want *w);
96 extern void format_commit_message(const struct commit *commit,
97                                   const char *format, struct strbuf *sb,
98                                   const struct pretty_print_context *context);
99 extern void pretty_print_commit(enum cmit_fmt fmt, const struct commit *commit,
100                                 struct strbuf *sb,
101                                 const struct pretty_print_context *context);
102 void pp_user_info(const char *what, enum cmit_fmt fmt, struct strbuf *sb,
103                    const char *line, enum date_mode dmode,
104                    const char *encoding);
105 void pp_title_line(enum cmit_fmt fmt,
106                    const char **msg_p,
107                    struct strbuf *sb,
108                    const char *subject,
109                    const char *after_subject,
110                    const char *encoding,
111                    int need_8bit_cte);
112 void pp_remainder(enum cmit_fmt fmt,
113                   const char **msg_p,
114                   struct strbuf *sb,
115                   int indent);
118 /** Removes the first commit from a list sorted by date, and adds all
119  * of its parents.
120  **/
121 struct commit *pop_most_recent_commit(struct commit_list **list,
122                                       unsigned int mark);
124 struct commit *pop_commit(struct commit_list **stack);
126 void clear_commit_marks(struct commit *commit, unsigned int mark);
129  * Performs an in-place topological sort of list supplied.
131  *   invariant of resulting list is:
132  *      a reachable from b => ord(b) < ord(a)
133  *   in addition, when lifo == 0, commits on parallel tracks are
134  *   sorted in the dates order.
135  */
136 void sort_in_topological_order(struct commit_list ** list, int lifo);
138 struct commit_graft {
139         unsigned char sha1[20];
140         int nr_parent; /* < 0 if shallow commit */
141         unsigned char parent[FLEX_ARRAY][20]; /* more */
144 struct commit_graft *read_graft_line(char *buf, int len);
145 int register_commit_graft(struct commit_graft *, int);
146 struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
148 const unsigned char *lookup_replace_object(const unsigned char *sha1);
150 extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
151 extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos, int cleanup);
152 extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
154 extern int register_shallow(const unsigned char *sha1);
155 extern int unregister_shallow(const unsigned char *sha1);
156 extern int write_shallow_commits(struct strbuf *out, int use_pack_protocol);
157 extern int is_repository_shallow(void);
158 extern struct commit_list *get_shallow_commits(struct object_array *heads,
159                 int depth, int shallow_flag, int not_shallow_flag);
161 int is_descendant_of(struct commit *, struct commit_list *);
162 int in_merge_bases(struct commit *, struct commit **, int);
164 extern int interactive_add(int argc, const char **argv, const char *prefix);
165 extern int run_add_interactive(const char *revision, const char *patch_mode,
166                                const char **pathspec);
168 static inline int single_parent(struct commit *commit)
170         return commit->parents && !commit->parents->next;
173 struct commit_list *reduce_heads(struct commit_list *heads);
175 extern int commit_tree(const char *msg, unsigned char *tree,
176                 struct commit_list *parents, unsigned char *ret,
177                 const char *author);
179 #endif /* COMMIT_H */