The sixth batch
[git.git] / revision.h
blob4134dc6029c40f39659b39927ba239aed845673b
1 #ifndef REVISION_H
2 #define REVISION_H
4 #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"
12 /* 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)
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.
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)
35 #define TOPO_WALK_EXPLORED (1u<<27)
36 #define TOPO_WALK_INDEGREE (1u<<28)
38 #define DECORATE_SHORT_REFS 1
39 #define DECORATE_FULL_REFS 2
41 struct log_info;
42 struct repository;
43 struct rev_info;
44 struct string_list;
45 struct saved_parents;
46 define_shared_commit_slab(revision_sources, char *);
48 struct rev_cmdline_info {
49 unsigned int nr;
50 unsigned int alloc;
51 struct rev_cmdline_entry {
52 struct object *item;
53 const char *name;
54 enum {
55 REV_CMD_REF,
56 REV_CMD_PARENTS_ONLY,
57 REV_CMD_LEFT,
58 REV_CMD_RIGHT,
59 REV_CMD_MERGE_BASE,
60 REV_CMD_REV
61 } whence;
62 unsigned flags;
63 } *rev;
66 #define REVISION_WALK_WALK 0
67 #define REVISION_WALK_NO_WALK_SORTED 1
68 #define REVISION_WALK_NO_WALK_UNSORTED 2
70 struct oidset;
71 struct topo_walk_info;
73 struct rev_info {
74 /* Starting list */
75 struct commit_list *commits;
76 struct object_array pending;
77 struct repository *repo;
79 /* Parents of shown commits */
80 struct object_array boundary_commits;
82 /* The end-points specified by the end user */
83 struct rev_cmdline_info cmdline;
85 /* excluding from --branches, --refs, etc. expansion */
86 struct string_list *ref_excludes;
88 /* Basic information */
89 const char *prefix;
90 const char *def;
91 struct pathspec prune_data;
94 * Whether the arguments parsed by setup_revisions() included any
95 * "input" revisions that might still have yielded an empty pending
96 * list (e.g., patterns like "--all" or "--glob").
98 int rev_input_given;
101 * Whether we read from stdin due to the --stdin option.
103 int read_from_stdin;
105 /* topo-sort */
106 enum rev_sort_order sort_order;
108 unsigned int early_output;
110 unsigned int ignore_missing:1,
111 ignore_missing_links:1;
113 /* Traversal flags */
114 unsigned int dense:1,
115 prune:1,
116 no_walk:2,
117 remove_empty_trees:1,
118 simplify_history:1,
119 topo_order:1,
120 simplify_merges:1,
121 simplify_by_decoration:1,
122 single_worktree:1,
123 tag_objects:1,
124 tree_objects:1,
125 blob_objects:1,
126 verify_objects:1,
127 edge_hint:1,
128 edge_hint_aggressive:1,
129 limited:1,
130 unpacked:1,
131 boundary:2,
132 count:1,
133 left_right:1,
134 left_only:1,
135 right_only:1,
136 rewrite_parents:1,
137 print_parents:1,
138 show_decorations:1,
139 reverse:1,
140 reverse_output_stage:1,
141 cherry_pick:1,
142 cherry_mark:1,
143 bisect:1,
144 ancestry_path:1,
145 first_parent_only:1,
146 line_level_traverse:1,
147 tree_blobs_in_commit_order:1,
150 * Blobs are shown without regard for their existence.
151 * But not so for trees: unless exclude_promisor_objects
152 * is set and the tree in question is a promisor object;
153 * OR ignore_missing_links is set, the revision walker
154 * dies with a "bad tree object HASH" message when
155 * encountering a missing tree. For callers that can
156 * handle missing trees and want them to be filterable
157 * and showable, set this to true. The revision walker
158 * will filter and show such a missing tree as usual,
159 * but will not attempt to recurse into this tree
160 * object.
162 do_not_die_on_missing_tree:1,
164 /* for internal use only */
165 exclude_promisor_objects:1;
167 /* Diff flags */
168 unsigned int diff:1,
169 full_diff:1,
170 show_root_diff:1,
171 no_commit_id:1,
172 verbose_header:1,
173 ignore_merges:1,
174 combine_merges:1,
175 combined_all_paths:1,
176 dense_combined_merges:1,
177 always_show_header:1;
179 /* Format info */
180 unsigned int shown_one:1,
181 shown_dashes:1,
182 show_merge:1,
183 show_notes:1,
184 show_notes_given:1,
185 show_signature:1,
186 pretty_given:1,
187 abbrev_commit:1,
188 abbrev_commit_given:1,
189 zero_commit:1,
190 use_terminator:1,
191 missing_newline:1,
192 date_mode_explicit:1,
193 preserve_subject:1;
194 unsigned int disable_stdin:1;
195 /* --show-linear-break */
196 unsigned int track_linear:1,
197 track_first_time:1,
198 linear:1;
200 struct date_mode date_mode;
201 int expand_tabs_in_log; /* unset if negative */
202 int expand_tabs_in_log_default;
204 unsigned int abbrev;
205 enum cmit_fmt commit_format;
206 struct log_info *loginfo;
207 int nr, total;
208 const char *mime_boundary;
209 const char *patch_suffix;
210 int numbered_files;
211 int reroll_count;
212 char *message_id;
213 struct ident_split from_ident;
214 struct string_list *ref_message_ids;
215 int add_signoff;
216 const char *extra_headers;
217 const char *log_reencode;
218 const char *subject_prefix;
219 int no_inline;
220 int show_log_size;
221 struct string_list *mailmap;
223 /* Filter by commit log message */
224 struct grep_opt grep_filter;
225 /* Negate the match of grep_filter */
226 int invert_grep;
228 /* Display history graph */
229 struct git_graph *graph;
231 /* special limits */
232 int skip_count;
233 int max_count;
234 timestamp_t max_age;
235 timestamp_t min_age;
236 int min_parents;
237 int max_parents;
238 int (*include_check)(struct commit *, void *);
239 void *include_check_data;
241 /* diff info for patches and for paths limiting */
242 struct diff_options diffopt;
243 struct diff_options pruning;
245 struct reflog_walk_info *reflog_info;
246 struct decoration children;
247 struct decoration merge_simplification;
248 struct decoration treesame;
250 /* notes-specific options: which refs to show */
251 struct display_notes_opt notes_opt;
253 /* interdiff */
254 const struct object_id *idiff_oid1;
255 const struct object_id *idiff_oid2;
256 const char *idiff_title;
258 /* range-diff */
259 const char *rdiff1;
260 const char *rdiff2;
261 int creation_factor;
262 const char *rdiff_title;
264 /* commit counts */
265 int count_left;
266 int count_right;
267 int count_same;
269 /* line level range that we are chasing */
270 struct decoration line_log_data;
272 /* copies of the parent lists, for --full-diff display */
273 struct saved_parents *saved_parents_slab;
275 struct commit_list *previous_parents;
276 const char *break_bar;
278 struct revision_sources *sources;
280 struct topo_walk_info *topo_walk_info;
283 int ref_excluded(struct string_list *, const char *path);
284 void clear_ref_exclusion(struct string_list **);
285 void add_ref_exclusion(struct string_list **, const char *exclude);
288 #define REV_TREE_SAME 0
289 #define REV_TREE_NEW 1 /* Only new files */
290 #define REV_TREE_OLD 2 /* Only files removed */
291 #define REV_TREE_DIFFERENT 3 /* Mixed changes */
293 /* revision.c */
294 typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
295 extern volatile show_early_output_fn_t show_early_output;
297 struct setup_revision_opt {
298 const char *def;
299 void (*tweak)(struct rev_info *, struct setup_revision_opt *);
300 const char *submodule; /* TODO: drop this and use rev_info->repo */
301 unsigned int assume_dashdash:1,
302 allow_exclude_promisor_objects:1;
303 unsigned revarg_opt;
306 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
307 #define init_revisions(revs, prefix) repo_init_revisions(the_repository, revs, prefix)
308 #endif
309 void repo_init_revisions(struct repository *r,
310 struct rev_info *revs,
311 const char *prefix);
312 int setup_revisions(int argc, const char **argv, struct rev_info *revs,
313 struct setup_revision_opt *);
314 void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
315 const struct option *options,
316 const char * const usagestr[]);
317 #define REVARG_CANNOT_BE_FILENAME 01
318 #define REVARG_COMMITTISH 02
319 int handle_revision_arg(const char *arg, struct rev_info *revs,
320 int flags, unsigned revarg_opt);
322 void reset_revision_walk(void);
323 int prepare_revision_walk(struct rev_info *revs);
324 struct commit *get_revision(struct rev_info *revs);
325 char *get_revision_mark(const struct rev_info *revs,
326 const struct commit *commit);
327 void put_revision_mark(const struct rev_info *revs,
328 const struct commit *commit);
330 void mark_parents_uninteresting(struct commit *commit);
331 void mark_tree_uninteresting(struct repository *r, struct tree *tree);
332 void mark_trees_uninteresting_sparse(struct repository *r, struct oidset *trees);
334 void show_object_with_name(FILE *, struct object *, const char *);
336 void add_pending_object(struct rev_info *revs,
337 struct object *obj, const char *name);
338 void add_pending_oid(struct rev_info *revs,
339 const char *name, const struct object_id *oid,
340 unsigned int flags);
342 void add_head_to_pending(struct rev_info *);
343 void add_reflogs_to_pending(struct rev_info *, unsigned int flags);
344 void add_index_objects_to_pending(struct rev_info *, unsigned int flags);
346 enum commit_action {
347 commit_ignore,
348 commit_show,
349 commit_error
352 enum commit_action get_commit_action(struct rev_info *revs,
353 struct commit *commit);
354 enum commit_action simplify_commit(struct rev_info *revs,
355 struct commit *commit);
357 enum rewrite_result {
358 rewrite_one_ok,
359 rewrite_one_noparents,
360 rewrite_one_error
363 typedef enum rewrite_result (*rewrite_parent_fn_t)(struct rev_info *revs, struct commit **pp);
365 int rewrite_parents(struct rev_info *revs,
366 struct commit *commit,
367 rewrite_parent_fn_t rewrite_parent);
370 * The log machinery saves the original parent list so that
371 * get_saved_parents() can later tell what the real parents of the
372 * commits are, when commit->parents has been modified by history
373 * simpification.
375 * get_saved_parents() will transparently return commit->parents if
376 * history simplification is off.
378 struct commit_list *get_saved_parents(struct rev_info *revs, const struct commit *commit);
380 #endif