Fix "log" family not to be too agressive about showing notes
[git/dscho.git] / commit.h
blob2c0742b721fe1d4d78a7a63ed1c2ee1cf9c96ab8
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 char name[1];
34 struct commit *lookup_commit(const unsigned char *sha1);
35 struct commit *lookup_commit_reference(const unsigned char *sha1);
36 struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
37 int quiet);
39 int parse_commit_buffer(struct commit *item, void *buffer, unsigned long size);
41 int parse_commit(struct commit *item);
43 struct commit_list * commit_list_insert(struct commit *item, struct commit_list **list_p);
44 unsigned commit_list_count(const struct commit_list *l);
45 struct commit_list * insert_by_date(struct commit *item, struct commit_list **list);
47 void free_commit_list(struct commit_list *list);
49 void sort_by_date(struct commit_list **list);
51 /* Commit formats */
52 enum cmit_fmt {
53 CMIT_FMT_RAW,
54 CMIT_FMT_MEDIUM,
55 CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
56 CMIT_FMT_SHORT,
57 CMIT_FMT_FULL,
58 CMIT_FMT_FULLER,
59 CMIT_FMT_ONELINE,
60 CMIT_FMT_EMAIL,
61 CMIT_FMT_USERFORMAT,
63 CMIT_FMT_UNSPECIFIED,
66 struct pretty_print_context
68 int abbrev;
69 const char *subject;
70 const char *after_subject;
71 enum date_mode date_mode;
72 int need_8bit_cte;
73 int show_notes;
74 struct reflog_walk_info *reflog_info;
77 extern int non_ascii(int);
78 extern int has_non_ascii(const char *text);
79 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
80 extern char *reencode_commit_message(const struct commit *commit,
81 const char **encoding_p);
82 extern void get_commit_format(const char *arg, struct rev_info *);
83 extern void format_commit_message(const struct commit *commit,
84 const char *format, struct strbuf *sb,
85 const struct pretty_print_context *context);
86 extern void pretty_print_commit(enum cmit_fmt fmt, const struct commit *commit,
87 struct strbuf *sb,
88 const struct pretty_print_context *context);
89 void pp_user_info(const char *what, enum cmit_fmt fmt, struct strbuf *sb,
90 const char *line, enum date_mode dmode,
91 const char *encoding);
92 void pp_title_line(enum cmit_fmt fmt,
93 const char **msg_p,
94 struct strbuf *sb,
95 const char *subject,
96 const char *after_subject,
97 const char *encoding,
98 int need_8bit_cte);
99 void pp_remainder(enum cmit_fmt fmt,
100 const char **msg_p,
101 struct strbuf *sb,
102 int indent);
105 /** Removes the first commit from a list sorted by date, and adds all
106 * of its parents.
108 struct commit *pop_most_recent_commit(struct commit_list **list,
109 unsigned int mark);
111 struct commit *pop_commit(struct commit_list **stack);
113 void clear_commit_marks(struct commit *commit, unsigned int mark);
116 * Performs an in-place topological sort of list supplied.
118 * invariant of resulting list is:
119 * a reachable from b => ord(b) < ord(a)
120 * in addition, when lifo == 0, commits on parallel tracks are
121 * sorted in the dates order.
123 void sort_in_topological_order(struct commit_list ** list, int lifo);
125 struct commit_graft {
126 unsigned char sha1[20];
127 int nr_parent; /* < 0 if shallow commit */
128 unsigned char parent[FLEX_ARRAY][20]; /* more */
131 struct commit_graft *read_graft_line(char *buf, int len);
132 int register_commit_graft(struct commit_graft *, int);
133 struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
135 const unsigned char *lookup_replace_object(const unsigned char *sha1);
137 extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
138 extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos, int cleanup);
139 extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
141 extern int register_shallow(const unsigned char *sha1);
142 extern int unregister_shallow(const unsigned char *sha1);
143 extern int write_shallow_commits(struct strbuf *out, int use_pack_protocol);
144 extern int is_repository_shallow(void);
145 extern struct commit_list *get_shallow_commits(struct object_array *heads,
146 int depth, int shallow_flag, int not_shallow_flag);
148 int is_descendant_of(struct commit *, struct commit_list *);
149 int in_merge_bases(struct commit *, struct commit **, int);
151 extern int interactive_add(int argc, const char **argv, const char *prefix);
152 extern int run_add_interactive(const char *revision, const char *patch_mode,
153 const char **pathspec);
155 static inline int single_parent(struct commit *commit)
157 return commit->parents && !commit->parents->next;
160 struct commit_list *reduce_heads(struct commit_list *heads);
162 #endif /* COMMIT_H */