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