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