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