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