apply.h: include missing header
[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)
99c9aa95
MD
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)
1b32dece 32#define TRACK_LINEAR (1u<<26)
99c9aa95 33#define ALL_REV_FLAGS (((1u<<11)-1) | NOT_USER_GIVEN | TRACK_LINEAR)
ae563542 34
b4542418
DS
35#define TOPO_WALK_EXPLORED (1u<<27)
36#define TOPO_WALK_INDEGREE (1u<<28)
ae563542 37
33e7018c
LH
38#define DECORATE_SHORT_REFS 1
39#define DECORATE_FULL_REFS 2
40
91539833 41struct log_info;
2abf3503
NTND
42struct repository;
43struct rev_info;
894a9d33 44struct string_list;
53d00b39 45struct saved_parents;
87be2523 46define_shared_commit_slab(revision_sources, char *);
8efdc326 47
281eee47
JH
48struct 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,
a765499a 59 REV_CMD_MERGE_BASE,
281eee47
JH
60 REV_CMD_REV
61 } whence;
62 unsigned flags;
63 } *rev;
64};
65
ca92e59e
MZ
66#define REVISION_WALK_WALK 0
67#define REVISION_WALK_NO_WALK_SORTED 1
68#define REVISION_WALK_NO_WALK_UNSORTED 2
69
f1f5de44 70struct oidset;
f0d9cc41
DS
71struct topo_walk_info;
72
ae563542
LT
73struct rev_info {
74 /* Starting list */
75 struct commit_list *commits;
1f1e895f 76 struct object_array pending;
2abf3503 77 struct repository *repo;
ae563542 78
86ab4906
JH
79 /* Parents of shown commits */
80 struct object_array boundary_commits;
81
281eee47
JH
82 /* The end-points specified by the end user */
83 struct rev_cmdline_info cmdline;
84
e7b432c5
JH
85 /* excluding from --branches, --refs, etc. expansion */
86 struct string_list *ref_excludes;
87
ae563542
LT
88 /* Basic information */
89 const char *prefix;
02e54220 90 const char *def;
afe069d1 91 struct pathspec prune_data;
08f704f2 92
7ba82629
JK
93 /*
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").
97 */
98 int rev_input_given;
99
a12cbe23
JK
100 /*
101 * Whether we read from stdin due to the --stdin option.
102 */
103 int read_from_stdin;
104
08f704f2
JH
105 /* topo-sort */
106 enum rev_sort_order sort_order;
107
e35b6ac5
SG
108 unsigned int early_output;
109
110 unsigned int ignore_missing:1,
2db1a43f 111 ignore_missing_links:1;
cdcefbc9 112
ae563542
LT
113 /* Traversal flags */
114 unsigned int dense:1,
53b2c823 115 prune:1,
ca92e59e 116 no_walk:2,
ae563542 117 remove_empty_trees:1,
9202434c 118 simplify_history:1,
ae563542 119 topo_order:1,
6546b593 120 simplify_merges:1,
78892e32 121 simplify_by_decoration:1,
ff9445be 122 single_worktree:1,
ae563542
LT
123 tag_objects:1,
124 tree_objects:1,
125 blob_objects:1,
5a48d240 126 verify_objects:1,
d9a83684 127 edge_hint:1,
1684c1b2 128 edge_hint_aggressive:1,
d9a83684 129 limited:1,
03a9683d 130 unpacked:1,
86ab4906 131 boundary:2,
f69c5018 132 count:1,
74bd9029 133 left_right:1,
60adf7d7
MG
134 left_only:1,
135 right_only:1,
885cf808
AS
136 rewrite_parents:1,
137 print_parents:1,
d467a525 138 show_decorations:1,
0053e902 139 reverse:1,
498bcd31 140 reverse_output_stage:1,
d7a17cad 141 cherry_pick:1,
adbbb31e 142 cherry_mark:1,
ad3f9a71 143 bisect:1,
ebdc94f3 144 ancestry_path:1,
12da1d1f 145 first_parent_only:1,
ce5b6f9b 146 line_level_traverse:1,
f3d618d2 147 tree_blobs_in_commit_order:1,
df11e196 148
7c0fe330
MD
149 /*
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.
161 */
162 do_not_die_on_missing_tree:1,
163
df11e196
JT
164 /* for internal use only */
165 exclude_promisor_objects:1;
ae563542 166
cd2bdc53
LT
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,
d76ce4f7 175 combined_all_paths:1,
cd2bdc53
LT
176 dense_combined_merges:1,
177 always_show_header:1;
178
179 /* Format info */
91539833 180 unsigned int shown_one:1,
bd1470b8 181 shown_dashes:1,
02e54220 182 show_merge:1,
66b2ed09
JH
183 show_notes:1,
184 show_notes_given:1,
0c37f1fc 185 show_signature:1,
66b2ed09 186 pretty_given:1,
4da45bef 187 abbrev_commit:1,
0c47695a 188 abbrev_commit_given:1,
3a30aa17 189 zero_commit:1,
7fefda5c 190 use_terminator:1,
f4ea32f0 191 missing_newline:1,
9553d2b2
JK
192 date_mode_explicit:1,
193 preserve_subject:1;
8b3dce56 194 unsigned int disable_stdin:1;
1b32dece
NTND
195 /* --show-linear-break */
196 unsigned int track_linear:1,
197 track_first_time:1,
198 linear:1;
8b3dce56 199
a5481a6c 200 struct date_mode date_mode;
0893eec8
JH
201 int expand_tabs_in_log; /* unset if negative */
202 int expand_tabs_in_log_default;
106d710b 203
cd2bdc53
LT
204 unsigned int abbrev;
205 enum cmit_fmt commit_format;
91539833 206 struct log_info *loginfo;
596524b3 207 int nr, total;
698ce6f8 208 const char *mime_boundary;
108dab28
SB
209 const char *patch_suffix;
210 int numbered_files;
5fe10fe8 211 int reroll_count;
e1a37346 212 char *message_id;
a9080475 213 struct ident_split from_ident;
b079c50e 214 struct string_list *ref_message_ids;
5289c56a 215 int add_signoff;
20ff0680 216 const char *extra_headers;
52883fbd 217 const char *log_reencode;
2d9e4a47 218 const char *subject_prefix;
c112f689 219 int no_inline;
9fa3465d 220 int show_log_size;
0e2913b0 221 struct string_list *mailmap;
cd2bdc53 222
8ecae9b0 223 /* Filter by commit log message */
0843acfd 224 struct grep_opt grep_filter;
22dfa8a2
CJ
225 /* Negate the match of grep_filter */
226 int invert_grep;
8ecae9b0 227
7fefda5c
AS
228 /* Display history graph */
229 struct git_graph *graph;
230
ae563542 231 /* special limits */
d5db6c9e 232 int skip_count;
ae563542 233 int max_count;
dddbad72
JS
234 timestamp_t max_age;
235 timestamp_t min_age;
ad5aeede
MG
236 int min_parents;
237 int max_parents;
a330de31
VM
238 int (*include_check)(struct commit *, void *);
239 void *include_check_data;
8efdc326 240
cd2bdc53 241 /* diff info for patches and for paths limiting */
c4e05b1a 242 struct diff_options diffopt;
cd2bdc53 243 struct diff_options pruning;
c4e05b1a 244
8860fd42 245 struct reflog_walk_info *reflog_info;
f35f5603 246 struct decoration children;
faf0156b 247 struct decoration merge_simplification;
d0af663e 248 struct decoration treesame;
894a9d33
TR
249
250 /* notes-specific options: which refs to show */
251 struct display_notes_opt notes_opt;
f69c5018 252
126facf8
ES
253 /* interdiff */
254 const struct object_id *idiff_oid1;
255 const struct object_id *idiff_oid2;
5ac290f9 256 const char *idiff_title;
126facf8 257
31e2617a
ES
258 /* range-diff */
259 const char *rdiff1;
260 const char *rdiff2;
261 int creation_factor;
4ee99689 262 const char *rdiff_title;
31e2617a 263
f69c5018
TR
264 /* commit counts */
265 int count_left;
266 int count_right;
b388e14b 267 int count_same;
12da1d1f
TR
268
269 /* line level range that we are chasing */
270 struct decoration line_log_data;
53d00b39
TR
271
272 /* copies of the parent lists, for --full-diff display */
273 struct saved_parents *saved_parents_slab;
1b32dece
NTND
274
275 struct commit_list *previous_parents;
276 const char *break_bar;
87be2523
NTND
277
278 struct revision_sources *sources;
f0d9cc41
DS
279
280 struct topo_walk_info *topo_walk_info;
ae563542
LT
281};
282
d16ec9cd 283int ref_excluded(struct string_list *, const char *path);
ff32d342
JH
284void clear_ref_exclusion(struct string_list **);
285void add_ref_exclusion(struct string_list **, const char *exclude);
286
287
8efdc326 288#define REV_TREE_SAME 0
ceff8e7a
LT
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 */
8efdc326 292
ae563542 293/* revision.c */
cdcefbc9 294typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
4dc1db0b 295extern volatile show_early_output_fn_t show_early_output;
8efdc326 296
32962c9b
JH
297struct setup_revision_opt {
298 const char *def;
b4490059 299 void (*tweak)(struct rev_info *, struct setup_revision_opt *);
2abf3503 300 const char *submodule; /* TODO: drop this and use rev_info->repo */
bbcde41a
MD
301 unsigned int assume_dashdash:1,
302 allow_exclude_promisor_objects:1;
d5f6b1d7 303 unsigned revarg_opt;
32962c9b
JH
304};
305
2abf3503
NTND
306#ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
307#define init_revisions(revs, prefix) repo_init_revisions(the_repository, revs, prefix)
308#endif
309void repo_init_revisions(struct repository *r,
310 struct rev_info *revs,
311 const char *prefix);
d16ec9cd
NTND
312int setup_revisions(int argc, const char **argv, struct rev_info *revs,
313 struct setup_revision_opt *);
314void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
315 const struct option *options,
316 const char * const usagestr[]);
8e676e8b 317#define REVARG_CANNOT_BE_FILENAME 01
d5f6b1d7 318#define REVARG_COMMITTISH 02
d16ec9cd
NTND
319int handle_revision_arg(const char *arg, struct rev_info *revs,
320 int flags, unsigned revarg_opt);
5d6f0935 321
d16ec9cd
NTND
322void reset_revision_walk(void);
323int prepare_revision_walk(struct rev_info *revs);
324struct commit *get_revision(struct rev_info *revs);
325char *get_revision_mark(const struct rev_info *revs,
326 const struct commit *commit);
327void put_revision_mark(const struct rev_info *revs,
328 const struct commit *commit);
a4a88b2b 329
d16ec9cd 330void mark_parents_uninteresting(struct commit *commit);
b3c7eef9 331void mark_tree_uninteresting(struct repository *r, struct tree *tree);
f1f5de44 332void mark_trees_uninteresting_sparse(struct repository *r, struct oidset *trees);
ae563542 333
d16ec9cd 334void show_object_with_name(FILE *, struct object *, const char *);
91f17516 335
d16ec9cd
NTND
336void add_pending_object(struct rev_info *revs,
337 struct object *obj, const char *name);
338void add_pending_oid(struct rev_info *revs,
339 const char *name, const struct object_id *oid,
340 unsigned int flags);
ae563542 341
d16ec9cd
NTND
342void add_head_to_pending(struct rev_info *);
343void add_reflogs_to_pending(struct rev_info *, unsigned int flags);
344void add_index_objects_to_pending(struct rev_info *, unsigned int flags);
3384a2df 345
252a7c02
LT
346enum commit_action {
347 commit_ignore,
348 commit_show,
349 commit_error
350};
351
d16ec9cd
NTND
352enum commit_action get_commit_action(struct rev_info *revs,
353 struct commit *commit);
354enum commit_action simplify_commit(struct rev_info *revs,
355 struct commit *commit);
252a7c02 356
c7edcae0
BY
357enum rewrite_result {
358 rewrite_one_ok,
359 rewrite_one_noparents,
360 rewrite_one_error
361};
362
363typedef enum rewrite_result (*rewrite_parent_fn_t)(struct rev_info *revs, struct commit **pp);
364
d16ec9cd
NTND
365int rewrite_parents(struct rev_info *revs,
366 struct commit *commit,
367 rewrite_parent_fn_t rewrite_parent);
53d00b39
TR
368
369/*
0131c490
JH
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.
53d00b39
TR
374 *
375 * get_saved_parents() will transparently return commit->parents if
376 * history simplification is off.
377 */
d16ec9cd 378struct commit_list *get_saved_parents(struct rev_info *revs, const struct commit *commit);
53d00b39 379
ae563542 380#endif