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