1#ifndef REVISION_H
2#define REVISION_H
3
4#include "parse-options.h"
5#include "grep.h"
6#include "notes.h"
7#include "commit.h"
8
9#define SEEN (1u<<0)
10#define UNINTERESTING (1u<<1)
11#define TREESAME (1u<<2)
12#define SHOWN (1u<<3)
13#define TMP_MARK (1u<<4) /* for isolated cases; clean after use */
14#define BOUNDARY (1u<<5)
15#define CHILD_SHOWN (1u<<6)
16#define ADDED (1u<<7) /* Parents already parsed and added? */
17#define SYMMETRIC_LEFT (1u<<8)
18#define PATCHSAME (1u<<9)
19#define BOTTOM (1u<<10)
20#define ALL_REV_FLAGS ((1u<<11)-1)
21
22#define DECORATE_SHORT_REFS 1
23#define DECORATE_FULL_REFS 2
24
25struct rev_info;
26struct log_info;
27struct string_list;
28struct saved_parents;
29
30struct rev_cmdline_info {
31 unsigned int nr;
32 unsigned int alloc;
33 struct rev_cmdline_entry {
34 struct object *item;
35 const char *name;
36 enum {
37 REV_CMD_REF,
38 REV_CMD_PARENTS_ONLY,
39 REV_CMD_LEFT,
40 REV_CMD_RIGHT,
41 REV_CMD_MERGE_BASE,
42 REV_CMD_REV
43 } whence;
44 unsigned flags;
45 } *rev;
46};
47
48#define REVISION_WALK_WALK 0
49#define REVISION_WALK_NO_WALK_SORTED 1
50#define REVISION_WALK_NO_WALK_UNSORTED 2
51
52struct rev_info {
53 /* Starting list */
54 struct commit_list *commits;
55 struct object_array pending;
56
57 /* Parents of shown commits */
58 struct object_array boundary_commits;
59
60 /* The end-points specified by the end user */
61 struct rev_cmdline_info cmdline;
62
63 /* Basic information */
64 const char *prefix;
65 const char *def;
66 struct pathspec prune_data;
67
68 /* topo-sort */
69 enum rev_sort_order sort_order;
70
71 unsigned int early_output:1,
72 ignore_missing:1;
73
74 /* Traversal flags */
75 unsigned int dense:1,
76 prune:1,
77 no_walk:2,
78 show_all:1,
79 remove_empty_trees:1,
80 simplify_history:1,
81 topo_order:1,
82 simplify_merges:1,
83 simplify_by_decoration:1,
84 tag_objects:1,
85 tree_objects:1,
86 blob_objects:1,
87 verify_objects:1,
88 edge_hint:1,
89 limited:1,
90 unpacked:1,
91 boundary:2,
92 count:1,
93 left_right:1,
94 left_only:1,
95 right_only:1,
96 rewrite_parents:1,
97 print_parents:1,
98 show_source:1,
99 show_decorations:1,
100 reverse:1,
101 reverse_output_stage:1,
102 cherry_pick:1,
103 cherry_mark:1,
104 bisect:1,
105 ancestry_path:1,
106 first_parent_only:1,
107 line_level_traverse:1;
108
109 /* Diff flags */
110 unsigned int diff:1,
111 full_diff:1,
112 show_root_diff:1,
113 no_commit_id:1,
114 verbose_header:1,
115 ignore_merges:1,
116 combine_merges:1,
117 dense_combined_merges:1,
118 always_show_header:1;
119
120 /* Format info */
121 unsigned int shown_one:1,
122 shown_dashes:1,
123 show_merge:1,
124 show_notes:1,
125 show_notes_given:1,
126 show_signature:1,
127 pretty_given:1,
128 abbrev_commit:1,
129 abbrev_commit_given:1,
130 use_terminator:1,
131 missing_newline:1,
132 date_mode_explicit:1,
133 preserve_subject:1;
134 unsigned int disable_stdin:1;
135 unsigned int leak_pending:1;
136
137 enum date_mode date_mode;
138
139 unsigned int abbrev;
140 enum cmit_fmt commit_format;
141 struct log_info *loginfo;
142 int nr, total;
143 const char *mime_boundary;
144 const char *patch_suffix;
145 int numbered_files;
146 int reroll_count;
147 char *message_id;
148 struct ident_split from_ident;
149 struct string_list *ref_message_ids;
150 int add_signoff;
151 const char *extra_headers;
152 const char *log_reencode;
153 const char *subject_prefix;
154 int no_inline;
155 int show_log_size;
156 struct string_list *mailmap;
157
158 /* Filter by commit log message */
159 struct grep_opt grep_filter;
160
161 /* Display history graph */
162 struct git_graph *graph;
163
164 /* special limits */
165 int skip_count;
166 int max_count;
167 unsigned long max_age;
168 unsigned long min_age;
169 int min_parents;
170 int max_parents;
171 int (*include_check)(struct commit *, void *);
172 void *include_check_data;
173
174 /* diff info for patches and for paths limiting */
175 struct diff_options diffopt;
176 struct diff_options pruning;
177
178 struct reflog_walk_info *reflog_info;
179 struct decoration children;
180 struct decoration merge_simplification;
181 struct decoration treesame;
182
183 /* notes-specific options: which refs to show */
184 struct display_notes_opt notes_opt;
185
186 /* commit counts */
187 int count_left;
188 int count_right;
189 int count_same;
190
191 /* line level range that we are chasing */
192 struct decoration line_log_data;
193
194 /* copies of the parent lists, for --full-diff display */
195 struct saved_parents *saved_parents_slab;
196};
197
198#define REV_TREE_SAME 0
199#define REV_TREE_NEW 1 /* Only new files */
200#define REV_TREE_OLD 2 /* Only files removed */
201#define REV_TREE_DIFFERENT 3 /* Mixed changes */
202
203/* revision.c */
204typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
205extern volatile show_early_output_fn_t show_early_output;
206
207struct setup_revision_opt {
208 const char *def;
209 void (*tweak)(struct rev_info *, struct setup_revision_opt *);
210 const char *submodule;
211 int assume_dashdash;
212 unsigned revarg_opt;
213};
214
215extern void init_revisions(struct rev_info *revs, const char *prefix);
216extern int setup_revisions(int argc, const char **argv, struct rev_info *revs,
217 struct setup_revision_opt *);
218extern void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
219 const struct option *options,
220 const char * const usagestr[]);
221#define REVARG_CANNOT_BE_FILENAME 01
222#define REVARG_COMMITTISH 02
223extern int handle_revision_arg(const char *arg, struct rev_info *revs,
224 int flags, unsigned revarg_opt);
225
226extern void reset_revision_walk(void);
227extern int prepare_revision_walk(struct rev_info *revs);
228extern struct commit *get_revision(struct rev_info *revs);
229extern char *get_revision_mark(const struct rev_info *revs,
230 const struct commit *commit);
231extern void put_revision_mark(const struct rev_info *revs,
232 const struct commit *commit);
233
234extern void mark_parents_uninteresting(struct commit *commit);
235extern void mark_tree_uninteresting(struct tree *tree);
236
237struct name_path {
238 struct name_path *up;
239 int elem_len;
240 const char *elem;
241};
242
243char *path_name(const struct name_path *path, const char *name);
244
245extern void show_object_with_name(FILE *, struct object *,
246 const struct name_path *, const char *);
247
248extern void add_object(struct object *obj,
249 struct object_array *p,
250 struct name_path *path,
251 const char *name);
252
253extern void add_pending_object(struct rev_info *revs,
254 struct object *obj, const char *name);
255extern void add_pending_sha1(struct rev_info *revs,
256 const char *name, const unsigned char *sha1,
257 unsigned int flags);
258
259extern void add_head_to_pending(struct rev_info *);
260
261enum commit_action {
262 commit_ignore,
263 commit_show,
264 commit_error
265};
266
267extern enum commit_action get_commit_action(struct rev_info *revs,
268 struct commit *commit);
269extern enum commit_action simplify_commit(struct rev_info *revs,
270 struct commit *commit);
271
272enum rewrite_result {
273 rewrite_one_ok,
274 rewrite_one_noparents,
275 rewrite_one_error
276};
277
278typedef enum rewrite_result (*rewrite_parent_fn_t)(struct rev_info *revs, struct commit **pp);
279
280extern int rewrite_parents(struct rev_info *revs, struct commit *commit,
281 rewrite_parent_fn_t rewrite_parent);
282
283/*
284 * Save a copy of the parent list, and return the saved copy. This is
285 * used by the log machinery to retrieve the original parents when
286 * commit->parents has been modified by history simpification.
287 *
288 * You may only call save_parents() once per commit (this is checked
289 * for non-root commits).
290 *
291 * get_saved_parents() will transparently return commit->parents if
292 * history simplification is off.
293 */
294extern void save_parents(struct rev_info *revs, struct commit *commit);
295extern struct commit_list *get_saved_parents(struct rev_info *revs, const struct commit *commit);
296extern void free_saved_parents(struct rev_info *revs);
297
298#endif