revision.c: generation-based topo-order algorithm
[git/git.git] / revision.h
CommitLineData
ae563542
LT
1#ifndef REVISION_H
2#define REVISION_H
3
ef3ca954 4#include "commit.h"
6b61ec05 5#include "parse-options.h"
0843acfd 6#include "grep.h"
894a9d33 7#include "notes.h"
cf394719 8#include "pretty.h"
19ecb564 9#include "diff.h"
87be2523 10#include "commit-slab-decl.h"
6b61ec05 11
208acbfb 12/* Remember to update object flag allocation in object.h */
ae563542
LT
13#define SEEN (1u<<0)
14#define UNINTERESTING (1u<<1)
7dc0fe3b 15#define TREESAME (1u<<2)
765ac8ec 16#define SHOWN (1u<<3)
7ae0b0cb 17#define TMP_MARK (1u<<4) /* for isolated cases; clean after use */
384e99a4 18#define BOUNDARY (1u<<5)
2b064697 19#define CHILD_SHOWN (1u<<6)
1b65a5aa 20#define ADDED (1u<<7) /* Parents already parsed and added? */
577ed5c2 21#define SYMMETRIC_LEFT (1u<<8)
adbbb31e 22#define PATCHSAME (1u<<9)
7f34a46f 23#define BOTTOM (1u<<10)
a0c9016a 24#define USER_GIVEN (1u<<25) /* given directly by the user */
1b32dece 25#define TRACK_LINEAR (1u<<26)
a0c9016a 26#define ALL_REV_FLAGS (((1u<<11)-1) | USER_GIVEN | TRACK_LINEAR)
b4542418
DS
27#define TOPO_WALK_EXPLORED (1u<<27)
28#define TOPO_WALK_INDEGREE (1u<<28)
ae563542 29
33e7018c
LH
30#define DECORATE_SHORT_REFS 1
31#define DECORATE_FULL_REFS 2
32
8efdc326 33struct rev_info;
91539833 34struct log_info;
894a9d33 35struct string_list;
53d00b39 36struct saved_parents;
87be2523 37define_shared_commit_slab(revision_sources, char *);
8efdc326 38
281eee47
JH
39struct rev_cmdline_info {
40 unsigned int nr;
41 unsigned int alloc;
42 struct rev_cmdline_entry {
43 struct object *item;
44 const char *name;
45 enum {
46 REV_CMD_REF,
47 REV_CMD_PARENTS_ONLY,
48 REV_CMD_LEFT,
49 REV_CMD_RIGHT,
a765499a 50 REV_CMD_MERGE_BASE,
281eee47
JH
51 REV_CMD_REV
52 } whence;
53 unsigned flags;
54 } *rev;
55};
56
ca92e59e
MZ
57#define REVISION_WALK_WALK 0
58#define REVISION_WALK_NO_WALK_SORTED 1
59#define REVISION_WALK_NO_WALK_UNSORTED 2
60
f0d9cc41
DS
61struct topo_walk_info;
62
ae563542
LT
63struct rev_info {
64 /* Starting list */
65 struct commit_list *commits;
1f1e895f 66 struct object_array pending;
ae563542 67
86ab4906
JH
68 /* Parents of shown commits */
69 struct object_array boundary_commits;
70
281eee47
JH
71 /* The end-points specified by the end user */
72 struct rev_cmdline_info cmdline;
73
e7b432c5
JH
74 /* excluding from --branches, --refs, etc. expansion */
75 struct string_list *ref_excludes;
76
ae563542
LT
77 /* Basic information */
78 const char *prefix;
02e54220 79 const char *def;
afe069d1 80 struct pathspec prune_data;
08f704f2 81
7ba82629
JK
82 /*
83 * Whether the arguments parsed by setup_revisions() included any
84 * "input" revisions that might still have yielded an empty pending
85 * list (e.g., patterns like "--all" or "--glob").
86 */
87 int rev_input_given;
88
a12cbe23
JK
89 /*
90 * Whether we read from stdin due to the --stdin option.
91 */
92 int read_from_stdin;
93
08f704f2
JH
94 /* topo-sort */
95 enum rev_sort_order sort_order;
96
e35b6ac5
SG
97 unsigned int early_output;
98
99 unsigned int ignore_missing:1,
2db1a43f 100 ignore_missing_links:1;
cdcefbc9 101
ae563542
LT
102 /* Traversal flags */
103 unsigned int dense:1,
53b2c823 104 prune:1,
ca92e59e 105 no_walk:2,
ae563542 106 remove_empty_trees:1,
9202434c 107 simplify_history:1,
ae563542 108 topo_order:1,
6546b593 109 simplify_merges:1,
78892e32 110 simplify_by_decoration:1,
ff9445be 111 single_worktree:1,
ae563542
LT
112 tag_objects:1,
113 tree_objects:1,
114 blob_objects:1,
5a48d240 115 verify_objects:1,
d9a83684 116 edge_hint:1,
1684c1b2 117 edge_hint_aggressive:1,
d9a83684 118 limited:1,
03a9683d 119 unpacked:1,
86ab4906 120 boundary:2,
f69c5018 121 count:1,
74bd9029 122 left_right:1,
60adf7d7
MG
123 left_only:1,
124 right_only:1,
885cf808
AS
125 rewrite_parents:1,
126 print_parents:1,
d467a525 127 show_decorations:1,
0053e902 128 reverse:1,
498bcd31 129 reverse_output_stage:1,
d7a17cad 130 cherry_pick:1,
adbbb31e 131 cherry_mark:1,
ad3f9a71 132 bisect:1,
ebdc94f3 133 ancestry_path:1,
12da1d1f 134 first_parent_only:1,
ce5b6f9b 135 line_level_traverse:1,
f3d618d2 136 tree_blobs_in_commit_order:1,
df11e196
JT
137
138 /* for internal use only */
139 exclude_promisor_objects:1;
ae563542 140
cd2bdc53
LT
141 /* Diff flags */
142 unsigned int diff:1,
143 full_diff:1,
144 show_root_diff:1,
145 no_commit_id:1,
146 verbose_header:1,
147 ignore_merges:1,
148 combine_merges:1,
149 dense_combined_merges:1,
150 always_show_header:1;
151
152 /* Format info */
91539833 153 unsigned int shown_one:1,
bd1470b8 154 shown_dashes:1,
02e54220 155 show_merge:1,
66b2ed09
JH
156 show_notes:1,
157 show_notes_given:1,
0c37f1fc 158 show_signature:1,
66b2ed09 159 pretty_given:1,
4da45bef 160 abbrev_commit:1,
0c47695a 161 abbrev_commit_given:1,
3a30aa17 162 zero_commit:1,
7fefda5c 163 use_terminator:1,
f4ea32f0 164 missing_newline:1,
9553d2b2
JK
165 date_mode_explicit:1,
166 preserve_subject:1;
8b3dce56 167 unsigned int disable_stdin:1;
1b32dece
NTND
168 /* --show-linear-break */
169 unsigned int track_linear:1,
170 track_first_time:1,
171 linear:1;
8b3dce56 172
a5481a6c 173 struct date_mode date_mode;
0893eec8
JH
174 int expand_tabs_in_log; /* unset if negative */
175 int expand_tabs_in_log_default;
106d710b 176
cd2bdc53
LT
177 unsigned int abbrev;
178 enum cmit_fmt commit_format;
91539833 179 struct log_info *loginfo;
596524b3 180 int nr, total;
698ce6f8 181 const char *mime_boundary;
108dab28
SB
182 const char *patch_suffix;
183 int numbered_files;
5fe10fe8 184 int reroll_count;
e1a37346 185 char *message_id;
a9080475 186 struct ident_split from_ident;
b079c50e 187 struct string_list *ref_message_ids;
5289c56a 188 int add_signoff;
20ff0680 189 const char *extra_headers;
52883fbd 190 const char *log_reencode;
2d9e4a47 191 const char *subject_prefix;
c112f689 192 int no_inline;
9fa3465d 193 int show_log_size;
0e2913b0 194 struct string_list *mailmap;
cd2bdc53 195
8ecae9b0 196 /* Filter by commit log message */
0843acfd 197 struct grep_opt grep_filter;
22dfa8a2
CJ
198 /* Negate the match of grep_filter */
199 int invert_grep;
8ecae9b0 200
7fefda5c
AS
201 /* Display history graph */
202 struct git_graph *graph;
203
ae563542 204 /* special limits */
d5db6c9e 205 int skip_count;
ae563542 206 int max_count;
dddbad72
JS
207 timestamp_t max_age;
208 timestamp_t min_age;
ad5aeede
MG
209 int min_parents;
210 int max_parents;
a330de31
VM
211 int (*include_check)(struct commit *, void *);
212 void *include_check_data;
8efdc326 213
cd2bdc53 214 /* diff info for patches and for paths limiting */
c4e05b1a 215 struct diff_options diffopt;
cd2bdc53 216 struct diff_options pruning;
c4e05b1a 217
8860fd42 218 struct reflog_walk_info *reflog_info;
f35f5603 219 struct decoration children;
faf0156b 220 struct decoration merge_simplification;
d0af663e 221 struct decoration treesame;
894a9d33
TR
222
223 /* notes-specific options: which refs to show */
224 struct display_notes_opt notes_opt;
f69c5018 225
126facf8
ES
226 /* interdiff */
227 const struct object_id *idiff_oid1;
228 const struct object_id *idiff_oid2;
5ac290f9 229 const char *idiff_title;
126facf8 230
31e2617a
ES
231 /* range-diff */
232 const char *rdiff1;
233 const char *rdiff2;
234 int creation_factor;
4ee99689 235 const char *rdiff_title;
31e2617a 236
f69c5018
TR
237 /* commit counts */
238 int count_left;
239 int count_right;
b388e14b 240 int count_same;
12da1d1f
TR
241
242 /* line level range that we are chasing */
243 struct decoration line_log_data;
53d00b39
TR
244
245 /* copies of the parent lists, for --full-diff display */
246 struct saved_parents *saved_parents_slab;
1b32dece
NTND
247
248 struct commit_list *previous_parents;
249 const char *break_bar;
87be2523
NTND
250
251 struct revision_sources *sources;
f0d9cc41
DS
252
253 struct topo_walk_info *topo_walk_info;
ae563542
LT
254};
255
d16ec9cd 256int ref_excluded(struct string_list *, const char *path);
ff32d342
JH
257void clear_ref_exclusion(struct string_list **);
258void add_ref_exclusion(struct string_list **, const char *exclude);
259
260
8efdc326 261#define REV_TREE_SAME 0
ceff8e7a
LT
262#define REV_TREE_NEW 1 /* Only new files */
263#define REV_TREE_OLD 2 /* Only files removed */
264#define REV_TREE_DIFFERENT 3 /* Mixed changes */
8efdc326 265
ae563542 266/* revision.c */
cdcefbc9 267typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
4dc1db0b 268extern volatile show_early_output_fn_t show_early_output;
8efdc326 269
32962c9b
JH
270struct setup_revision_opt {
271 const char *def;
b4490059 272 void (*tweak)(struct rev_info *, struct setup_revision_opt *);
9ef6aeb0 273 const char *submodule;
6d5b93f2 274 int assume_dashdash;
d5f6b1d7 275 unsigned revarg_opt;
32962c9b
JH
276};
277
d16ec9cd
NTND
278void init_revisions(struct rev_info *revs, const char *prefix);
279int setup_revisions(int argc, const char **argv, struct rev_info *revs,
280 struct setup_revision_opt *);
281void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
282 const struct option *options,
283 const char * const usagestr[]);
8e676e8b 284#define REVARG_CANNOT_BE_FILENAME 01
d5f6b1d7 285#define REVARG_COMMITTISH 02
d16ec9cd
NTND
286int handle_revision_arg(const char *arg, struct rev_info *revs,
287 int flags, unsigned revarg_opt);
5d6f0935 288
d16ec9cd
NTND
289void reset_revision_walk(void);
290int prepare_revision_walk(struct rev_info *revs);
291struct commit *get_revision(struct rev_info *revs);
292char *get_revision_mark(const struct rev_info *revs,
293 const struct commit *commit);
294void put_revision_mark(const struct rev_info *revs,
295 const struct commit *commit);
a4a88b2b 296
d16ec9cd
NTND
297void mark_parents_uninteresting(struct commit *commit);
298void mark_tree_uninteresting(struct tree *tree);
ae563542 299
d16ec9cd 300void show_object_with_name(FILE *, struct object *, const char *);
91f17516 301
d16ec9cd
NTND
302void add_pending_object(struct rev_info *revs,
303 struct object *obj, const char *name);
304void add_pending_oid(struct rev_info *revs,
305 const char *name, const struct object_id *oid,
306 unsigned int flags);
ae563542 307
d16ec9cd
NTND
308void add_head_to_pending(struct rev_info *);
309void add_reflogs_to_pending(struct rev_info *, unsigned int flags);
310void add_index_objects_to_pending(struct rev_info *, unsigned int flags);
3384a2df 311
252a7c02
LT
312enum commit_action {
313 commit_ignore,
314 commit_show,
315 commit_error
316};
317
d16ec9cd
NTND
318enum commit_action get_commit_action(struct rev_info *revs,
319 struct commit *commit);
320enum commit_action simplify_commit(struct rev_info *revs,
321 struct commit *commit);
252a7c02 322
c7edcae0
BY
323enum rewrite_result {
324 rewrite_one_ok,
325 rewrite_one_noparents,
326 rewrite_one_error
327};
328
329typedef enum rewrite_result (*rewrite_parent_fn_t)(struct rev_info *revs, struct commit **pp);
330
d16ec9cd
NTND
331int rewrite_parents(struct rev_info *revs,
332 struct commit *commit,
333 rewrite_parent_fn_t rewrite_parent);
53d00b39
TR
334
335/*
0131c490
JH
336 * The log machinery saves the original parent list so that
337 * get_saved_parents() can later tell what the real parents of the
338 * commits are, when commit->parents has been modified by history
339 * simpification.
53d00b39
TR
340 *
341 * get_saved_parents() will transparently return commit->parents if
342 * history simplification is off.
343 */
d16ec9cd 344struct commit_list *get_saved_parents(struct rev_info *revs, const struct commit *commit);
53d00b39 345
ae563542 346#endif