t6003: add --author-date-order test
[git/jrn.git] / commit.h
blobe43dfd01823481a23b542e0a4ab1a5df8b493e70
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 index;
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);
42 * Look up object named by "sha1", dereference tag as necessary,
43 * get a commit and return it. If "sha1" does not dereference to
44 * a commit, use ref_name to report an error and die.
46 struct commit *lookup_commit_or_die(const unsigned char *sha1, const char *ref_name);
48 int parse_commit_buffer(struct commit *item, const void *buffer, unsigned long size);
49 int parse_commit(struct commit *item);
51 /* Find beginning and length of commit subject. */
52 int find_commit_subject(const char *commit_buffer, const char **subject);
54 struct commit_list *commit_list_insert(struct commit *item,
55 struct commit_list **list);
56 struct commit_list **commit_list_append(struct commit *commit,
57 struct commit_list **next);
58 unsigned commit_list_count(const struct commit_list *l);
59 struct commit_list *commit_list_insert_by_date(struct commit *item,
60 struct commit_list **list);
61 void commit_list_sort_by_date(struct commit_list **list);
63 void free_commit_list(struct commit_list *list);
65 /* Commit formats */
66 enum cmit_fmt {
67 CMIT_FMT_RAW,
68 CMIT_FMT_MEDIUM,
69 CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
70 CMIT_FMT_SHORT,
71 CMIT_FMT_FULL,
72 CMIT_FMT_FULLER,
73 CMIT_FMT_ONELINE,
74 CMIT_FMT_EMAIL,
75 CMIT_FMT_USERFORMAT,
77 CMIT_FMT_UNSPECIFIED
80 struct pretty_print_context {
81 enum cmit_fmt fmt;
82 int abbrev;
83 const char *subject;
84 const char *after_subject;
85 int preserve_subject;
86 enum date_mode date_mode;
87 unsigned date_mode_explicit:1;
88 int need_8bit_cte;
89 char *notes_message;
90 struct reflog_walk_info *reflog_info;
91 const char *output_encoding;
92 struct string_list *mailmap;
93 int color;
96 struct userformat_want {
97 unsigned notes:1;
100 extern int has_non_ascii(const char *text);
101 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
102 extern char *logmsg_reencode(const struct commit *commit,
103 const char *output_encoding);
104 extern void logmsg_free(char *msg, const struct commit *commit);
105 extern void get_commit_format(const char *arg, struct rev_info *);
106 extern const char *format_subject(struct strbuf *sb, const char *msg,
107 const char *line_separator);
108 extern void userformat_find_requirements(const char *fmt, struct userformat_want *w);
109 extern void format_commit_message(const struct commit *commit,
110 const char *format, struct strbuf *sb,
111 const struct pretty_print_context *context);
112 extern void pretty_print_commit(const struct pretty_print_context *pp,
113 const struct commit *commit,
114 struct strbuf *sb);
115 extern void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
116 struct strbuf *sb);
117 void pp_user_info(const struct pretty_print_context *pp,
118 const char *what, struct strbuf *sb,
119 const char *line, const char *encoding);
120 void pp_title_line(const struct pretty_print_context *pp,
121 const char **msg_p,
122 struct strbuf *sb,
123 const char *encoding,
124 int need_8bit_cte);
125 void pp_remainder(const struct pretty_print_context *pp,
126 const char **msg_p,
127 struct strbuf *sb,
128 int indent);
131 /** Removes the first commit from a list sorted by date, and adds all
132 * of its parents.
134 struct commit *pop_most_recent_commit(struct commit_list **list,
135 unsigned int mark);
137 struct commit *pop_commit(struct commit_list **stack);
139 void clear_commit_marks(struct commit *commit, unsigned int mark);
140 void clear_commit_marks_for_object_array(struct object_array *a, unsigned mark);
143 enum rev_sort_order {
144 REV_SORT_IN_GRAPH_ORDER = 0,
145 REV_SORT_BY_COMMIT_DATE,
146 REV_SORT_BY_AUTHOR_DATE
150 * Performs an in-place topological sort of list supplied.
152 * invariant of resulting list is:
153 * a reachable from b => ord(b) < ord(a)
154 * sort_order further specifies:
155 * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
156 * chain together.
157 * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
159 void sort_in_topological_order(struct commit_list **, enum rev_sort_order);
161 struct commit_graft {
162 unsigned char sha1[20];
163 int nr_parent; /* < 0 if shallow commit */
164 unsigned char parent[FLEX_ARRAY][20]; /* more */
166 typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
168 struct commit_graft *read_graft_line(char *buf, int len);
169 int register_commit_graft(struct commit_graft *, int);
170 struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
172 extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
173 extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos, int cleanup);
174 extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
176 /* largest positive number a signed 32-bit integer can contain */
177 #define INFINITE_DEPTH 0x7fffffff
179 extern int register_shallow(const unsigned char *sha1);
180 extern int unregister_shallow(const unsigned char *sha1);
181 extern int for_each_commit_graft(each_commit_graft_fn, void *);
182 extern int is_repository_shallow(void);
183 extern struct commit_list *get_shallow_commits(struct object_array *heads,
184 int depth, int shallow_flag, int not_shallow_flag);
186 int is_descendant_of(struct commit *, struct commit_list *);
187 int in_merge_bases(struct commit *, struct commit *);
189 extern int interactive_add(int argc, const char **argv, const char *prefix, int patch);
190 extern int run_add_interactive(const char *revision, const char *patch_mode,
191 const char **pathspec);
193 static inline int single_parent(struct commit *commit)
195 return commit->parents && !commit->parents->next;
198 struct commit_list *reduce_heads(struct commit_list *heads);
200 struct commit_extra_header {
201 struct commit_extra_header *next;
202 char *key;
203 char *value;
204 size_t len;
207 extern void append_merge_tag_headers(struct commit_list *parents,
208 struct commit_extra_header ***tail);
210 extern int commit_tree(const struct strbuf *msg, unsigned char *tree,
211 struct commit_list *parents, unsigned char *ret,
212 const char *author, const char *sign_commit);
214 extern int commit_tree_extended(const struct strbuf *msg, unsigned char *tree,
215 struct commit_list *parents, unsigned char *ret,
216 const char *author, const char *sign_commit,
217 struct commit_extra_header *);
219 extern struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
221 extern void free_commit_extra_headers(struct commit_extra_header *extra);
223 struct merge_remote_desc {
224 struct object *obj; /* the named object, could be a tag */
225 const char *name;
227 #define merge_remote_util(commit) ((struct merge_remote_desc *)((commit)->util))
230 * Given "name" from the command line to merge, find the commit object
231 * and return it, while storing merge_remote_desc in its ->util field,
232 * to allow callers to tell if we are told to merge a tag.
234 struct commit *get_merge_parent(const char *name);
236 extern int parse_signed_commit(const unsigned char *sha1,
237 struct strbuf *message, struct strbuf *signature);
238 extern void print_commit_list(struct commit_list *list,
239 const char *format_cur,
240 const char *format_last);
242 #endif /* COMMIT_H */