diff.c: add dimming to moved line detection
[git/git.git] / diff.h
CommitLineData
be3cfa85
JH
1/*
2 * Copyright (C) 2005 Junio C Hamano
3 */
86436c28
JH
4#ifndef DIFF_H
5#define DIFF_H
6
1b0c7174 7#include "tree-walk.h"
64acde94 8#include "pathspec.h"
1ff57c13 9#include "object.h"
50f9a858 10
91539833 11struct rev_info;
ac1b3d12 12struct diff_options;
04245581 13struct diff_queue_struct;
a3c158d4 14struct strbuf;
a788d7d5
AB
15struct diff_filespec;
16struct userdiff_driver;
910650d2 17struct oid_array;
82889295 18struct commit;
72441af7
KS
19struct combine_diff_path;
20
21typedef int (*pathchange_fn_t)(struct diff_options *options,
22 struct combine_diff_path *path);
ac1b3d12
LT
23
24typedef void (*change_fn_t)(struct diff_options *options,
25 unsigned old_mode, unsigned new_mode,
94a0097a
BW
26 const struct object_id *old_oid,
27 const struct object_id *new_oid,
28 int old_oid_valid, int new_oid_valid,
e3d42c47
JL
29 const char *fullpath,
30 unsigned old_dirty_submodule, unsigned new_dirty_submodule);
ac1b3d12
LT
31
32typedef void (*add_remove_fn_t)(struct diff_options *options,
33 int addremove, unsigned mode,
c26022ea
BW
34 const struct object_id *oid,
35 int oid_valid,
e3d42c47 36 const char *fullpath, unsigned dirty_submodule);
ac1b3d12 37
04245581
JK
38typedef void (*diff_format_fn_t)(struct diff_queue_struct *q,
39 struct diff_options *options, void *data);
40
a3c158d4
BY
41typedef struct strbuf *(*diff_prefix_fn_t)(struct diff_options *opt, void *data);
42
c6744349
TH
43#define DIFF_FORMAT_RAW 0x0001
44#define DIFF_FORMAT_DIFFSTAT 0x0002
74e2abe5
JH
45#define DIFF_FORMAT_NUMSTAT 0x0004
46#define DIFF_FORMAT_SUMMARY 0x0008
47#define DIFF_FORMAT_PATCH 0x0010
ebd124c6 48#define DIFF_FORMAT_SHORTSTAT 0x0020
7df7c019 49#define DIFF_FORMAT_DIRSTAT 0x0040
c6744349
TH
50
51/* These override all above */
74e2abe5
JH
52#define DIFF_FORMAT_NAME 0x0100
53#define DIFF_FORMAT_NAME_STATUS 0x0200
54#define DIFF_FORMAT_CHECKDIFF 0x0400
c6744349
TH
55
56/* Same as output_format = 0 but we know that -s flag was given
57 * and we should not give default value to output_format.
58 */
74e2abe5 59#define DIFF_FORMAT_NO_OUTPUT 0x0800
c6744349 60
74e2abe5 61#define DIFF_FORMAT_CALLBACK 0x1000
04245581 62
8f67f8ae
PH
63#define DIFF_OPT_RECURSIVE (1 << 0)
64#define DIFF_OPT_TREE_IN_RECURSIVE (1 << 1)
65#define DIFF_OPT_BINARY (1 << 2)
66#define DIFF_OPT_TEXT (1 << 3)
67#define DIFF_OPT_FULL_INDEX (1 << 4)
68#define DIFF_OPT_SILENT_ON_REMOVE (1 << 5)
69#define DIFF_OPT_FIND_COPIES_HARDER (1 << 6)
70#define DIFF_OPT_FOLLOW_RENAMES (1 << 7)
90d43b07 71#define DIFF_OPT_RENAME_EMPTY (1 << 8)
882749a0 72/* (1 << 9) unused */
8f67f8ae 73#define DIFF_OPT_HAS_CHANGES (1 << 10)
90b19941 74#define DIFF_OPT_QUICK (1 << 11)
8f67f8ae
PH
75#define DIFF_OPT_NO_INDEX (1 << 12)
76#define DIFF_OPT_ALLOW_EXTERNAL (1 << 13)
77#define DIFF_OPT_EXIT_WITH_STATUS (1 << 14)
78#define DIFF_OPT_REVERSE_DIFF (1 << 15)
62c64895 79#define DIFF_OPT_CHECK_FAILED (1 << 16)
cd676a51 80#define DIFF_OPT_RELATIVE_NAME (1 << 17)
50fd9bd8 81#define DIFF_OPT_IGNORE_SUBMODULES (1 << 18)
f88d225f 82#define DIFF_OPT_DIRSTAT_CUMULATIVE (1 << 19)
fd33777b 83#define DIFF_OPT_DIRSTAT_BY_FILE (1 << 20)
c7534ef4 84#define DIFF_OPT_ALLOW_TEXTCONV (1 << 21)
f245194f 85#define DIFF_OPT_DIFF_FROM_CONTENTS (1 << 22)
9297f77e 86#define DIFF_OPT_DIRTY_SUBMODULES (1 << 24)
3bfc4504 87#define DIFF_OPT_IGNORE_UNTRACKED_IN_SUBMODULES (1 << 25)
4af574db 88#define DIFF_OPT_IGNORE_DIRTY_SUBMODULES (1 << 26)
aee9c7d6 89#define DIFF_OPT_OVERRIDE_SUBMODULE_CONFIG (1 << 27)
1c57a627 90#define DIFF_OPT_DIRSTAT_BY_LINE (1 << 28)
14937c2c 91#define DIFF_OPT_FUNCCONTEXT (1 << 29)
accccde4 92#define DIFF_OPT_PICKAXE_IGNORE_CASE (1 << 30)
9a93c668 93#define DIFF_OPT_DEFAULT_FOLLOW_RENAMES (1U << 31)
752c0c24 94
8f67f8ae 95#define DIFF_OPT_TST(opts, flag) ((opts)->flags & DIFF_OPT_##flag)
6c374008
JH
96#define DIFF_OPT_TOUCHED(opts, flag) ((opts)->touched_flags & DIFF_OPT_##flag)
97#define DIFF_OPT_SET(opts, flag) (((opts)->flags |= DIFF_OPT_##flag),((opts)->touched_flags |= DIFF_OPT_##flag))
98#define DIFF_OPT_CLR(opts, flag) (((opts)->flags &= ~DIFF_OPT_##flag),((opts)->touched_flags |= DIFF_OPT_##flag))
628d5c2b
KC
99#define DIFF_XDL_TST(opts, flag) ((opts)->xdl_opts & XDF_##flag)
100#define DIFF_XDL_SET(opts, flag) ((opts)->xdl_opts |= XDF_##flag)
101#define DIFF_XDL_CLR(opts, flag) ((opts)->xdl_opts &= ~XDF_##flag)
8f67f8ae 102
307ab20b
JH
103#define DIFF_WITH_ALG(opts, flag) (((opts)->xdl_opts & ~XDF_DIFF_ALGORITHM_MASK) | XDF_##flag)
104
882749a0
TR
105enum diff_words_type {
106 DIFF_WORDS_NONE = 0,
107 DIFF_WORDS_PORCELAIN,
108 DIFF_WORDS_PLAIN,
109 DIFF_WORDS_COLOR
110};
111
61cfbc05
JK
112enum diff_submodule_format {
113 DIFF_SUBMODULE_SHORT = 0,
fd47ae6a
JK
114 DIFF_SUBMODULE_LOG,
115 DIFF_SUBMODULE_INLINE_DIFF
61cfbc05
JK
116};
117
6b5ee137 118struct diff_options {
6b5ee137
JH
119 const char *orderfile;
120 const char *pickaxe;
2f3f8b21 121 const char *single_follow;
eab9a40b 122 const char *a_prefix, *b_prefix;
660e113c
JK
123 const char *line_prefix;
124 size_t line_prefix_length;
8f67f8ae 125 unsigned flags;
6c374008 126 unsigned touched_flags;
1ecc1cbd
JH
127
128 /* diff-filter bits */
129 unsigned int filter;
130
f1c96261 131 int use_color;
ee1e5412 132 int context;
6d0e674a 133 int interhunkcontext;
6b5ee137
JH
134 int break_opt;
135 int detect_rename;
467ddc14 136 int irreversible_delete;
fb13227e 137 int skip_stat_unmatch;
6b5ee137
JH
138 int line_termination;
139 int output_format;
140 int pickaxe_opts;
141 int rename_score;
8082d8d3 142 int rename_limit;
bf0ab10f 143 int needed_rename_limit;
f31027c9 144 int degraded_cc_to_c;
3ac942d4 145 int show_rename_progress;
712d2c7d 146 int dirstat_permille;
6b5ee137 147 int setup;
47dd0d59 148 int abbrev;
425a28e0 149 int ita_invisible_in_index;
b8767f79 150/* white-space error highlighting */
091f8e28
SB
151#define WSEH_NEW (1<<12)
152#define WSEH_CONTEXT (1<<13)
153#define WSEH_OLD (1<<14)
b8767f79 154 unsigned ws_error_highlight;
cd676a51
JH
155 const char *prefix;
156 int prefix_length;
698ce6f8 157 const char *stat_sep;
0d21efa5 158 long xdl_opts;
ac1b3d12 159
a2540023
JH
160 int stat_width;
161 int stat_name_width;
969fe57b 162 int stat_graph_width;
808e1db2 163 int stat_count;
2b6a5417 164 const char *word_regex;
882749a0 165 enum diff_words_type word_diff;
61cfbc05 166 enum diff_submodule_format submodule_format;
a2540023 167
34a5e1a2
JS
168 /* this is set by diffcore for DIFF_FORMAT_PATCH */
169 int found_changes;
170
44c48a90
JH
171 /* to support internal diff recursion by --follow hack*/
172 int found_follow;
173
6c374008
JH
174 void (*set_default)(struct diff_options *);
175
c0c77734
DB
176 FILE *file;
177 int close_file;
178
66f13625 179 struct pathspec pathspec;
72441af7 180 pathchange_fn_t pathchange;
ac1b3d12
LT
181 change_fn_t change;
182 add_remove_fn_t add_remove;
04245581
JK
183 diff_format_fn_t format_callback;
184 void *format_callback_data;
a3c158d4
BY
185 diff_prefix_fn_t output_prefix;
186 void *output_prefix_data;
ee7fb0b1
ZK
187
188 int diff_path_counter;
e6e045f8
SB
189
190 struct emitted_diff_symbols *emitted_symbols;
2e2d5ac1
SB
191 enum {
192 COLOR_MOVED_NO = 0,
176841f0 193 COLOR_MOVED_PLAIN = 1,
2e2d5ac1 194 COLOR_MOVED_ZEBRA = 2,
86b452e2 195 COLOR_MOVED_ZEBRA_DIM = 3,
2e2d5ac1
SB
196 } color_moved;
197 #define COLOR_MOVED_DEFAULT COLOR_MOVED_ZEBRA
198 #define COLOR_MOVED_MIN_BLOCK_LENGTH 3
6b5ee137
JH
199};
200
f3597138
SB
201void diff_emit_submodule_del(struct diff_options *o, const char *line);
202void diff_emit_submodule_add(struct diff_options *o, const char *line);
203void diff_emit_submodule_untracked(struct diff_options *o, const char *path);
204void diff_emit_submodule_modified(struct diff_options *o, const char *path);
205void diff_emit_submodule_header(struct diff_options *o, const char *header);
206void diff_emit_submodule_error(struct diff_options *o, const char *err);
207void diff_emit_submodule_pipethrough(struct diff_options *o,
208 const char *line, int len);
209
ce436973
JK
210enum color_diff {
211 DIFF_RESET = 0,
8dbf3eb6 212 DIFF_CONTEXT = 1,
ce436973
JK
213 DIFF_METAINFO = 2,
214 DIFF_FRAGINFO = 3,
215 DIFF_FILE_OLD = 4,
216 DIFF_FILE_NEW = 5,
217 DIFF_COMMIT = 6,
448c3ef1 218 DIFF_WHITESPACE = 7,
2e2d5ac1
SB
219 DIFF_FUNCINFO = 8,
220 DIFF_FILE_OLD_MOVED = 9,
221 DIFF_FILE_OLD_MOVED_ALT = 10,
86b452e2
SB
222 DIFF_FILE_OLD_MOVED_DIM = 11,
223 DIFF_FILE_OLD_MOVED_ALT_DIM = 12,
224 DIFF_FILE_NEW_MOVED = 13,
225 DIFF_FILE_NEW_MOVED_ALT = 14,
226 DIFF_FILE_NEW_MOVED_DIM = 15,
227 DIFF_FILE_NEW_MOVED_ALT_DIM = 16
ce436973
JK
228};
229const char *diff_get_color(int diff_use_color, enum color_diff ix);
8f67f8ae 230#define diff_get_color_opt(o, ix) \
f1c96261 231 diff_get_color((o)->use_color, ix)
8f67f8ae 232
ce436973 233
f1922234
JK
234const char *diff_line_prefix(struct diff_options *);
235
236
698ce6f8
JS
237extern const char mime_boundary_leader[];
238
72441af7 239extern struct combine_diff_path *diff_tree_paths(
fda94b41
BW
240 struct combine_diff_path *p, const struct object_id *oid,
241 const struct object_id **parents_oid, int nparent,
72441af7 242 struct strbuf *base, struct diff_options *opt);
66f414f8
BW
243extern int diff_tree_oid(const struct object_id *old_oid,
244 const struct object_id *new_oid,
245 const char *base, struct diff_options *opt);
7b8dea0c
BW
246extern int diff_root_tree_oid(const struct object_id *new_oid, const char *base,
247 struct diff_options *opt);
ac1b3d12 248
ea726d02
JH
249struct combine_diff_path {
250 struct combine_diff_path *next;
ea726d02 251 char *path;
2454c962 252 unsigned int mode;
1ff57c13 253 struct object_id oid;
2454c962 254 struct combine_diff_parent {
d416df88 255 char status;
2454c962 256 unsigned int mode;
1ff57c13 257 struct object_id oid;
2454c962 258 } parent[FLEX_ARRAY];
ea726d02 259};
2454c962 260#define combine_diff_path_size(n, l) \
5b442c4f
JK
261 st_add4(sizeof(struct combine_diff_path), (l), 1, \
262 st_mult(sizeof(struct combine_diff_parent), (n)))
ea726d02 263
91539833
LT
264extern void show_combined_diff(struct combine_diff_path *elem, int num_parent,
265 int dense, struct rev_info *);
ea726d02 266
b9acf54d 267extern void diff_tree_combined(const struct object_id *oid, const struct oid_array *parents, int dense, struct rev_info *rev);
0fe7c1de 268
82889295 269extern void diff_tree_combined_merge(const struct commit *commit, int dense, struct rev_info *rev);
af3feefa 270
a5a818ee
JH
271void diff_set_mnemonic_prefix(struct diff_options *options, const char *a, const char *b);
272
28b9264d
JH
273extern int diff_can_quit_early(struct diff_options *);
274
6b5ee137
JH
275extern void diff_addremove(struct diff_options *,
276 int addremove,
77eb2720 277 unsigned mode,
c26022ea
BW
278 const struct object_id *oid,
279 int oid_valid,
e3d42c47 280 const char *fullpath, unsigned dirty_submodule);
77eb2720 281
6b5ee137
JH
282extern void diff_change(struct diff_options *,
283 unsigned mode1, unsigned mode2,
94a0097a
BW
284 const struct object_id *old_oid,
285 const struct object_id *new_oid,
286 int old_oid_valid, int new_oid_valid,
e3d42c47
JL
287 const char *fullpath,
288 unsigned dirty_submodule1, unsigned dirty_submodule2);
77eb2720 289
fa7b2908 290extern struct diff_filepair *diff_unmerge(struct diff_options *, const char *path);
77eb2720 291
19feebc8 292#define DIFF_SETUP_REVERSE 1
f0c6b2a2
JH
293#define DIFF_SETUP_USE_CACHE 2
294#define DIFF_SETUP_USE_SIZE_CACHE 4
ce240675 295
dea007fb 296/*
b0d12fc9 297 * Poor man's alternative to parse-option, to allow both stuck form
dea007fb
MM
298 * (--option=value) and separate form (--option value).
299 */
300extern int parse_long_opt(const char *opt, const char **argv,
301 const char **optarg);
302
ef90d6d4 303extern int git_diff_basic_config(const char *var, const char *value, void *cb);
5b162879 304extern int git_diff_heuristic_config(const char *var, const char *value, void *cb);
5404c116 305extern void init_diff_ui_defaults(void);
ef90d6d4 306extern int git_diff_ui_config(const char *var, const char *value, void *cb);
6b5ee137 307extern void diff_setup(struct diff_options *);
a97262c6 308extern int diff_opt_parse(struct diff_options *, const char **, int, const char *);
28452655 309extern void diff_setup_done(struct diff_options *);
86436c28 310
6b14d7fa
JH
311#define DIFF_DETECT_RENAME 1
312#define DIFF_DETECT_COPY 2
313
367cec1c 314#define DIFF_PICKAXE_ALL 1
d01d8c67 315#define DIFF_PICKAXE_REGEX 2
f345b0a0 316
f506b8e8
JH
317#define DIFF_PICKAXE_KIND_S 4 /* traditional plumbing counter */
318#define DIFF_PICKAXE_KIND_G 8 /* grep in the patch */
319
6b5ee137 320extern void diffcore_std(struct diff_options *);
730f7284 321extern void diffcore_fix_diff_index(struct diff_options *);
f2ce9fde 322
dda2d79a
JH
323#define COMMON_DIFF_OPTIONS_HELP \
324"\ncommon diff options:\n" \
8082d8d3
JH
325" -z output diff-raw with lines terminated with NUL.\n" \
326" -p output patch format.\n" \
327" -u synonym for -p.\n" \
5c91da25
PB
328" --patch-with-raw\n" \
329" output both a patch and the diff-raw format.\n" \
d75f7952 330" --stat show diffstat instead of patch.\n" \
74e2abe5 331" --numstat show numeric diffstat instead of patch.\n" \
29353273
JS
332" --patch-with-stat\n" \
333" output a patch and prepend its diffstat.\n" \
8082d8d3 334" --name-only show only names of changed files.\n" \
946f5f7c 335" --name-status show names and status of changed files.\n" \
47dd0d59 336" --full-index show full object name on index lines.\n" \
913419fc 337" --abbrev=<n> abbreviate object names in diff-tree header and diff-raw.\n" \
8082d8d3
JH
338" -R swap input file pairs.\n" \
339" -B detect complete rewrites.\n" \
340" -M detect renames.\n" \
341" -C detect copies.\n" \
dda2d79a 342" --find-copies-harder\n" \
8082d8d3
JH
343" try unchanged files as candidate for copy detection.\n" \
344" -l<n> limit rename attempts up to <n> paths.\n" \
345" -O<file> reorder diffs according to the <file>.\n" \
346" -S<string> find filepair whose only one side contains the string.\n" \
dda2d79a 347" --pickaxe-all\n" \
ca49920f
SF
348" show all files diff when -S is used and hit is found.\n" \
349" -a --text treat all files as text.\n"
dda2d79a 350
38c6f780 351extern int diff_queue_is_empty(void);
6b5ee137 352extern void diff_flush(struct diff_options*);
f31027c9 353extern void diff_warn_rename_limit(const char *varname, int needed, int degraded_cc);
86436c28 354
e7baa4f4 355/* diff-raw status letters */
ca8c9156 356#define DIFF_STATUS_ADDED 'A'
e7baa4f4
JH
357#define DIFF_STATUS_COPIED 'C'
358#define DIFF_STATUS_DELETED 'D'
359#define DIFF_STATUS_MODIFIED 'M'
360#define DIFF_STATUS_RENAMED 'R'
361#define DIFF_STATUS_TYPE_CHANGED 'T'
362#define DIFF_STATUS_UNKNOWN 'X'
363#define DIFF_STATUS_UNMERGED 'U'
364
365/* these are not diff-raw status letters proper, but used by
366 * diffcore-filter insn to specify additional restrictions.
367 */
0b34379a 368#define DIFF_STATUS_FILTER_AON '*'
e7baa4f4
JH
369#define DIFF_STATUS_FILTER_BROKEN 'B'
370
d5e3b01e
JK
371/*
372 * This is different from find_unique_abbrev() in that
373 * it stuffs the result with dots for alignment.
374 */
d6cece51 375extern const char *diff_aligned_abbrev(const struct object_id *sha1, int);
47dd0d59 376
4bd5b7da
JH
377/* do not report anything on removed paths */
378#define DIFF_SILENT_ON_REMOVED 01
fb63d7f8
JH
379/* report racily-clean paths as modified */
380#define DIFF_RACY_IS_MODIFIED 02
4bd5b7da 381extern int run_diff_files(struct rev_info *revs, unsigned int option);
5c21ac0e 382extern int run_diff_index(struct rev_info *revs, int cached);
e09ad6e1 383
944cffbd 384extern int do_diff_cache(const struct object_id *, struct diff_options *);
bd25f288 385extern int diff_flush_patch_id(struct diff_options *, struct object_id *, int);
fcb3d0ad 386
da31b358
JH
387extern int diff_result_code(struct diff_options *, int);
388
e5f7a5d1 389extern void diff_no_index(struct rev_info *, int, const char **);
0569e9b8 390
018ec3c8 391extern int index_differs_from(const char *def, int diff_flags, int ita_invisible_in_index);
75f3ff2e 392
a64e6a44
JK
393/*
394 * Fill the contents of the filespec "df", respecting any textconv defined by
395 * its userdiff driver. The "driver" parameter must come from a
396 * previous call to get_textconv(), and therefore should either be NULL or have
397 * textconv enabled.
398 *
399 * Note that the memory ownership of the resulting buffer depends on whether
400 * the driver field is NULL. If it is, then the memory belongs to the filespec
401 * struct. If it is non-NULL, then "outbuf" points to a newly allocated buffer
402 * that should be freed by the caller.
403 */
a788d7d5
AB
404extern size_t fill_textconv(struct userdiff_driver *driver,
405 struct diff_filespec *df,
406 char **outbuf);
407
a64e6a44
JK
408/*
409 * Look up the userdiff driver for the given filespec, and return it if
410 * and only if it has textconv enabled (otherwise return NULL). The result
411 * can be passed to fill_textconv().
412 */
a788d7d5
AB
413extern struct userdiff_driver *get_textconv(struct diff_filespec *one);
414
3a35cb2e
JS
415/*
416 * Prepare diff_filespec and convert it using diff textconv API
417 * if the textconv driver exists.
418 * Return 1 if the conversion succeeds, 0 otherwise.
419 */
420extern int textconv_object(const char *path, unsigned mode, const struct object_id *oid, int oid_valid, char **buf, unsigned long *buf_size);
421
10ae7526
KB
422extern int parse_rename_score(const char **cp_p);
423
07924d4d
MP
424extern long parse_algorithm_value(const char *value);
425
0911c475
SB
426extern void print_stat_summary(FILE *fp, int files,
427 int insertions, int deletions);
4914c962 428extern void setup_diff_pager(struct diff_options *);
7f814632 429
86436c28 430#endif /* DIFF_H */