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