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