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