.mailmap: update email address of Andrey Mazo
[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"
15af58c1 10#include "oidset.h"
50f9a858 11
4a1b13a3
NTND
12struct combine_diff_path;
13struct commit;
14struct diff_filespec;
ac1b3d12 15struct diff_options;
04245581 16struct diff_queue_struct;
910650d2 17struct oid_array;
4a288478 18struct option;
b78ea5fc 19struct repository;
4a1b13a3
NTND
20struct rev_info;
21struct strbuf;
22struct userdiff_driver;
72441af7
KS
23
24typedef int (*pathchange_fn_t)(struct diff_options *options,
25 struct combine_diff_path *path);
ac1b3d12
LT
26
27typedef void (*change_fn_t)(struct diff_options *options,
28 unsigned old_mode, unsigned new_mode,
94a0097a
BW
29 const struct object_id *old_oid,
30 const struct object_id *new_oid,
31 int old_oid_valid, int new_oid_valid,
e3d42c47
JL
32 const char *fullpath,
33 unsigned old_dirty_submodule, unsigned new_dirty_submodule);
ac1b3d12
LT
34
35typedef void (*add_remove_fn_t)(struct diff_options *options,
36 int addremove, unsigned mode,
c26022ea
BW
37 const struct object_id *oid,
38 int oid_valid,
e3d42c47 39 const char *fullpath, unsigned dirty_submodule);
ac1b3d12 40
04245581
JK
41typedef void (*diff_format_fn_t)(struct diff_queue_struct *q,
42 struct diff_options *options, void *data);
43
a3c158d4
BY
44typedef struct strbuf *(*diff_prefix_fn_t)(struct diff_options *opt, void *data);
45
c6744349
TH
46#define DIFF_FORMAT_RAW 0x0001
47#define DIFF_FORMAT_DIFFSTAT 0x0002
74e2abe5
JH
48#define DIFF_FORMAT_NUMSTAT 0x0004
49#define DIFF_FORMAT_SUMMARY 0x0008
50#define DIFF_FORMAT_PATCH 0x0010
ebd124c6 51#define DIFF_FORMAT_SHORTSTAT 0x0020
7df7c019 52#define DIFF_FORMAT_DIRSTAT 0x0040
c6744349
TH
53
54/* These override all above */
74e2abe5
JH
55#define DIFF_FORMAT_NAME 0x0100
56#define DIFF_FORMAT_NAME_STATUS 0x0200
57#define DIFF_FORMAT_CHECKDIFF 0x0400
c6744349
TH
58
59/* Same as output_format = 0 but we know that -s flag was given
60 * and we should not give default value to output_format.
61 */
74e2abe5 62#define DIFF_FORMAT_NO_OUTPUT 0x0800
c6744349 63
74e2abe5 64#define DIFF_FORMAT_CALLBACK 0x1000
04245581 65
02f2f56b
BW
66#define DIFF_FLAGS_INIT { 0 }
67struct diff_flags {
2b393ef3
NTND
68 unsigned recursive;
69 unsigned tree_in_recursive;
70 unsigned binary;
71 unsigned text;
72 unsigned full_index;
73 unsigned silent_on_remove;
74 unsigned find_copies_harder;
75 unsigned follow_renames;
76 unsigned rename_empty;
77 unsigned has_changes;
78 unsigned quick;
79 unsigned no_index;
80 unsigned allow_external;
81 unsigned exit_with_status;
82 unsigned reverse_diff;
83 unsigned check_failed;
84 unsigned relative_name;
85 unsigned ignore_submodules;
86 unsigned dirstat_cumulative;
87 unsigned dirstat_by_file;
88 unsigned allow_textconv;
89 unsigned textconv_set_via_cmdline;
90 unsigned diff_from_contents;
91 unsigned dirty_submodules;
92 unsigned ignore_untracked_in_submodules;
93 unsigned ignore_dirty_submodules;
94 unsigned override_submodule_config;
95 unsigned dirstat_by_line;
96 unsigned funccontext;
97 unsigned default_follow_renames;
98 unsigned stat_with_summary;
99 unsigned suppress_diff_headers;
100 unsigned dual_color_diffed_diffs;
430be36e 101 unsigned suppress_hunk_header_line_count;
02f2f56b
BW
102};
103
104static inline void diff_flags_or(struct diff_flags *a,
105 const struct diff_flags *b)
106{
107 char *tmp_a = (char *)a;
108 const char *tmp_b = (const char *)b;
109 int i;
110
111 for (i = 0; i < sizeof(struct diff_flags); i++)
112 tmp_a[i] |= tmp_b[i];
113}
114
628d5c2b
KC
115#define DIFF_XDL_TST(opts, flag) ((opts)->xdl_opts & XDF_##flag)
116#define DIFF_XDL_SET(opts, flag) ((opts)->xdl_opts |= XDF_##flag)
117#define DIFF_XDL_CLR(opts, flag) ((opts)->xdl_opts &= ~XDF_##flag)
8f67f8ae 118
307ab20b
JH
119#define DIFF_WITH_ALG(opts, flag) (((opts)->xdl_opts & ~XDF_DIFF_ALGORITHM_MASK) | XDF_##flag)
120
882749a0
TR
121enum diff_words_type {
122 DIFF_WORDS_NONE = 0,
123 DIFF_WORDS_PORCELAIN,
124 DIFF_WORDS_PLAIN,
125 DIFF_WORDS_COLOR
126};
127
61cfbc05
JK
128enum diff_submodule_format {
129 DIFF_SUBMODULE_SHORT = 0,
fd47ae6a
JK
130 DIFF_SUBMODULE_LOG,
131 DIFF_SUBMODULE_INLINE_DIFF
61cfbc05
JK
132};
133
6b5ee137 134struct diff_options {
6b5ee137
JH
135 const char *orderfile;
136 const char *pickaxe;
2f3f8b21 137 const char *single_follow;
eab9a40b 138 const char *a_prefix, *b_prefix;
660e113c
JK
139 const char *line_prefix;
140 size_t line_prefix_length;
02f2f56b 141 struct diff_flags flags;
1ecc1cbd
JH
142
143 /* diff-filter bits */
144 unsigned int filter;
145
f1c96261 146 int use_color;
ee1e5412 147 int context;
6d0e674a 148 int interhunkcontext;
6b5ee137
JH
149 int break_opt;
150 int detect_rename;
467ddc14 151 int irreversible_delete;
fb13227e 152 int skip_stat_unmatch;
6b5ee137
JH
153 int line_termination;
154 int output_format;
929ed70a 155 unsigned pickaxe_opts;
6b5ee137 156 int rename_score;
8082d8d3 157 int rename_limit;
bf0ab10f 158 int needed_rename_limit;
f31027c9 159 int degraded_cc_to_c;
3ac942d4 160 int show_rename_progress;
712d2c7d 161 int dirstat_permille;
6b5ee137 162 int setup;
47dd0d59 163 int abbrev;
425a28e0 164 int ita_invisible_in_index;
b8767f79 165/* white-space error highlighting */
091f8e28
SB
166#define WSEH_NEW (1<<12)
167#define WSEH_CONTEXT (1<<13)
168#define WSEH_OLD (1<<14)
b8767f79 169 unsigned ws_error_highlight;
cd676a51
JH
170 const char *prefix;
171 int prefix_length;
698ce6f8 172 const char *stat_sep;
7f125ff9 173 int xdl_opts;
ac1b3d12 174
2477ab2e
JT
175 /* see Documentation/diff-options.txt */
176 char **anchors;
177 size_t anchors_nr, anchors_alloc;
178
a2540023
JH
179 int stat_width;
180 int stat_name_width;
969fe57b 181 int stat_graph_width;
808e1db2 182 int stat_count;
2b6a5417 183 const char *word_regex;
882749a0 184 enum diff_words_type word_diff;
61cfbc05 185 enum diff_submodule_format submodule_format;
a2540023 186
15af58c1
SB
187 struct oidset *objfind;
188
34a5e1a2
JS
189 /* this is set by diffcore for DIFF_FORMAT_PATCH */
190 int found_changes;
191
44c48a90
JH
192 /* to support internal diff recursion by --follow hack*/
193 int found_follow;
194
6c374008
JH
195 void (*set_default)(struct diff_options *);
196
c0c77734
DB
197 FILE *file;
198 int close_file;
199
7648b79e
SB
200#define OUTPUT_INDICATOR_NEW 0
201#define OUTPUT_INDICATOR_OLD 1
202#define OUTPUT_INDICATOR_CONTEXT 2
203 char output_indicators[3];
204
66f13625 205 struct pathspec pathspec;
72441af7 206 pathchange_fn_t pathchange;
ac1b3d12
LT
207 change_fn_t change;
208 add_remove_fn_t add_remove;
a937b37e 209 void *change_fn_data;
04245581
JK
210 diff_format_fn_t format_callback;
211 void *format_callback_data;
a3c158d4
BY
212 diff_prefix_fn_t output_prefix;
213 void *output_prefix_data;
ee7fb0b1
ZK
214
215 int diff_path_counter;
e6e045f8
SB
216
217 struct emitted_diff_symbols *emitted_symbols;
2e2d5ac1
SB
218 enum {
219 COLOR_MOVED_NO = 0,
176841f0 220 COLOR_MOVED_PLAIN = 1,
51da15eb
SB
221 COLOR_MOVED_BLOCKS = 2,
222 COLOR_MOVED_ZEBRA = 3,
223 COLOR_MOVED_ZEBRA_DIM = 4,
2e2d5ac1
SB
224 } color_moved;
225 #define COLOR_MOVED_DEFAULT COLOR_MOVED_ZEBRA
f0b8fb6e 226 #define COLOR_MOVED_MIN_ALNUM_COUNT 20
ca1f4ae4
SB
227
228 /* XDF_WHITESPACE_FLAGS regarding block detection are set at 2, 3, 4 */
229 #define COLOR_MOVED_WS_ALLOW_INDENTATION_CHANGE (1<<5)
d173e799
SB
230 #define COLOR_MOVED_WS_ERROR (1<<0)
231 unsigned color_moved_ws_handling;
b78ea5fc
NTND
232
233 struct repository *repo;
4a288478 234 struct option *parseopts;
6b5ee137
JH
235};
236
cdb5330a
NTND
237unsigned diff_filter_bit(char status);
238
f3597138
SB
239void diff_emit_submodule_del(struct diff_options *o, const char *line);
240void diff_emit_submodule_add(struct diff_options *o, const char *line);
241void diff_emit_submodule_untracked(struct diff_options *o, const char *path);
242void diff_emit_submodule_modified(struct diff_options *o, const char *path);
243void diff_emit_submodule_header(struct diff_options *o, const char *header);
244void diff_emit_submodule_error(struct diff_options *o, const char *err);
245void diff_emit_submodule_pipethrough(struct diff_options *o,
246 const char *line, int len);
247
ce436973
JK
248enum color_diff {
249 DIFF_RESET = 0,
8dbf3eb6 250 DIFF_CONTEXT = 1,
ce436973
JK
251 DIFF_METAINFO = 2,
252 DIFF_FRAGINFO = 3,
253 DIFF_FILE_OLD = 4,
254 DIFF_FILE_NEW = 5,
255 DIFF_COMMIT = 6,
448c3ef1 256 DIFF_WHITESPACE = 7,
2e2d5ac1
SB
257 DIFF_FUNCINFO = 8,
258 DIFF_FILE_OLD_MOVED = 9,
259 DIFF_FILE_OLD_MOVED_ALT = 10,
86b452e2
SB
260 DIFF_FILE_OLD_MOVED_DIM = 11,
261 DIFF_FILE_OLD_MOVED_ALT_DIM = 12,
262 DIFF_FILE_NEW_MOVED = 13,
263 DIFF_FILE_NEW_MOVED_ALT = 14,
264 DIFF_FILE_NEW_MOVED_DIM = 15,
a7be92ac
JS
265 DIFF_FILE_NEW_MOVED_ALT_DIM = 16,
266 DIFF_CONTEXT_DIM = 17,
267 DIFF_FILE_OLD_DIM = 18,
268 DIFF_FILE_NEW_DIM = 19,
269 DIFF_CONTEXT_BOLD = 20,
270 DIFF_FILE_OLD_BOLD = 21,
271 DIFF_FILE_NEW_BOLD = 22,
ce436973
JK
272};
273const char *diff_get_color(int diff_use_color, enum color_diff ix);
8f67f8ae 274#define diff_get_color_opt(o, ix) \
f1c96261 275 diff_get_color((o)->use_color, ix)
8f67f8ae 276
ce436973 277
f1922234
JK
278const char *diff_line_prefix(struct diff_options *);
279
280
698ce6f8
JS
281extern const char mime_boundary_leader[];
282
f758a7f8 283struct combine_diff_path *diff_tree_paths(
fda94b41
BW
284 struct combine_diff_path *p, const struct object_id *oid,
285 const struct object_id **parents_oid, int nparent,
72441af7 286 struct strbuf *base, struct diff_options *opt);
f758a7f8
NTND
287int diff_tree_oid(const struct object_id *old_oid,
288 const struct object_id *new_oid,
289 const char *base, struct diff_options *opt);
290int diff_root_tree_oid(const struct object_id *new_oid, const char *base,
291 struct diff_options *opt);
ac1b3d12 292
ea726d02
JH
293struct combine_diff_path {
294 struct combine_diff_path *next;
ea726d02 295 char *path;
2454c962 296 unsigned int mode;
1ff57c13 297 struct object_id oid;
2454c962 298 struct combine_diff_parent {
d416df88 299 char status;
2454c962 300 unsigned int mode;
1ff57c13 301 struct object_id oid;
d76ce4f7 302 struct strbuf path;
2454c962 303 } parent[FLEX_ARRAY];
ea726d02 304};
2454c962 305#define combine_diff_path_size(n, l) \
5b442c4f
JK
306 st_add4(sizeof(struct combine_diff_path), (l), 1, \
307 st_mult(sizeof(struct combine_diff_parent), (n)))
ea726d02 308
f758a7f8
NTND
309void show_combined_diff(struct combine_diff_path *elem, int num_parent,
310 int dense, struct rev_info *);
ea726d02 311
f758a7f8 312void diff_tree_combined(const struct object_id *oid, const struct oid_array *parents, int dense, struct rev_info *rev);
0fe7c1de 313
f758a7f8 314void diff_tree_combined_merge(const struct commit *commit, int dense, struct rev_info *rev);
af3feefa 315
a5a818ee
JH
316void diff_set_mnemonic_prefix(struct diff_options *options, const char *a, const char *b);
317
f758a7f8 318int diff_can_quit_early(struct diff_options *);
28b9264d 319
f758a7f8
NTND
320void diff_addremove(struct diff_options *,
321 int addremove,
322 unsigned mode,
323 const struct object_id *oid,
324 int oid_valid,
325 const char *fullpath, unsigned dirty_submodule);
77eb2720 326
f758a7f8
NTND
327void diff_change(struct diff_options *,
328 unsigned mode1, unsigned mode2,
329 const struct object_id *old_oid,
330 const struct object_id *new_oid,
331 int old_oid_valid, int new_oid_valid,
332 const char *fullpath,
333 unsigned dirty_submodule1, unsigned dirty_submodule2);
77eb2720 334
f758a7f8 335struct diff_filepair *diff_unmerge(struct diff_options *, const char *path);
77eb2720 336
19feebc8 337#define DIFF_SETUP_REVERSE 1
f0c6b2a2 338#define DIFF_SETUP_USE_SIZE_CACHE 4
ce240675 339
dea007fb 340/*
b0d12fc9 341 * Poor man's alternative to parse-option, to allow both stuck form
dea007fb
MM
342 * (--option=value) and separate form (--option value).
343 */
f758a7f8
NTND
344int parse_long_opt(const char *opt, const char **argv,
345 const char **optarg);
346
347int git_diff_basic_config(const char *var, const char *value, void *cb);
348int git_diff_heuristic_config(const char *var, const char *value, void *cb);
349void init_diff_ui_defaults(void);
350int git_diff_ui_config(const char *var, const char *value, void *cb);
e6757652
NTND
351#ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
352#define diff_setup(diffopts) repo_diff_setup(the_repository, diffopts)
353#endif
354void repo_diff_setup(struct repository *, struct diff_options *);
f758a7f8
NTND
355int diff_opt_parse(struct diff_options *, const char **, int, const char *);
356void diff_setup_done(struct diff_options *);
357int git_config_rename(const char *var, const char *value);
86436c28 358
6b14d7fa
JH
359#define DIFF_DETECT_RENAME 1
360#define DIFF_DETECT_COPY 2
361
367cec1c 362#define DIFF_PICKAXE_ALL 1
d01d8c67 363#define DIFF_PICKAXE_REGEX 2
f345b0a0 364
f506b8e8
JH
365#define DIFF_PICKAXE_KIND_S 4 /* traditional plumbing counter */
366#define DIFF_PICKAXE_KIND_G 8 /* grep in the patch */
15af58c1 367#define DIFF_PICKAXE_KIND_OBJFIND 16 /* specific object IDs */
f506b8e8 368
15af58c1
SB
369#define DIFF_PICKAXE_KINDS_MASK (DIFF_PICKAXE_KIND_S | \
370 DIFF_PICKAXE_KIND_G | \
371 DIFF_PICKAXE_KIND_OBJFIND)
cf63051a 372
c1ddc461 373#define DIFF_PICKAXE_IGNORE_CASE 32
f506b8e8 374
f758a7f8 375void diffcore_std(struct diff_options *);
784c0dae 376void diffcore_fix_diff_index(void);
f2ce9fde 377
dda2d79a
JH
378#define COMMON_DIFF_OPTIONS_HELP \
379"\ncommon diff options:\n" \
8082d8d3
JH
380" -z output diff-raw with lines terminated with NUL.\n" \
381" -p output patch format.\n" \
382" -u synonym for -p.\n" \
5c91da25
PB
383" --patch-with-raw\n" \
384" output both a patch and the diff-raw format.\n" \
d75f7952 385" --stat show diffstat instead of patch.\n" \
74e2abe5 386" --numstat show numeric diffstat instead of patch.\n" \
29353273
JS
387" --patch-with-stat\n" \
388" output a patch and prepend its diffstat.\n" \
8082d8d3 389" --name-only show only names of changed files.\n" \
946f5f7c 390" --name-status show names and status of changed files.\n" \
47dd0d59 391" --full-index show full object name on index lines.\n" \
913419fc 392" --abbrev=<n> abbreviate object names in diff-tree header and diff-raw.\n" \
8082d8d3
JH
393" -R swap input file pairs.\n" \
394" -B detect complete rewrites.\n" \
395" -M detect renames.\n" \
396" -C detect copies.\n" \
dda2d79a 397" --find-copies-harder\n" \
8082d8d3
JH
398" try unchanged files as candidate for copy detection.\n" \
399" -l<n> limit rename attempts up to <n> paths.\n" \
400" -O<file> reorder diffs according to the <file>.\n" \
401" -S<string> find filepair whose only one side contains the string.\n" \
dda2d79a 402" --pickaxe-all\n" \
ca49920f
SF
403" show all files diff when -S is used and hit is found.\n" \
404" -a --text treat all files as text.\n"
dda2d79a 405
f758a7f8
NTND
406int diff_queue_is_empty(void);
407void diff_flush(struct diff_options*);
408void diff_warn_rename_limit(const char *varname, int needed, int degraded_cc);
86436c28 409
e7baa4f4 410/* diff-raw status letters */
ca8c9156 411#define DIFF_STATUS_ADDED 'A'
e7baa4f4
JH
412#define DIFF_STATUS_COPIED 'C'
413#define DIFF_STATUS_DELETED 'D'
414#define DIFF_STATUS_MODIFIED 'M'
415#define DIFF_STATUS_RENAMED 'R'
416#define DIFF_STATUS_TYPE_CHANGED 'T'
417#define DIFF_STATUS_UNKNOWN 'X'
418#define DIFF_STATUS_UNMERGED 'U'
419
420/* these are not diff-raw status letters proper, but used by
421 * diffcore-filter insn to specify additional restrictions.
422 */
0b34379a 423#define DIFF_STATUS_FILTER_AON '*'
e7baa4f4
JH
424#define DIFF_STATUS_FILTER_BROKEN 'B'
425
d5e3b01e
JK
426/*
427 * This is different from find_unique_abbrev() in that
428 * it stuffs the result with dots for alignment.
429 */
f758a7f8 430const char *diff_aligned_abbrev(const struct object_id *sha1, int);
47dd0d59 431
4bd5b7da
JH
432/* do not report anything on removed paths */
433#define DIFF_SILENT_ON_REMOVED 01
fb63d7f8
JH
434/* report racily-clean paths as modified */
435#define DIFF_RACY_IS_MODIFIED 02
f758a7f8
NTND
436int run_diff_files(struct rev_info *revs, unsigned int option);
437int run_diff_index(struct rev_info *revs, int cached);
e09ad6e1 438
f758a7f8 439int do_diff_cache(const struct object_id *, struct diff_options *);
a8f6855f
SB
440int diff_flush_patch_id(struct diff_options *, struct object_id *, int, int);
441void flush_one_hunk(struct object_id *, git_SHA_CTX *);
fcb3d0ad 442
f758a7f8 443int diff_result_code(struct diff_options *, int);
da31b358 444
dcd6a8c0 445int diff_no_index(struct rev_info *,
16bb3d71 446 int implicit_no_index, int, const char **);
0569e9b8 447
ffc00a48
NTND
448int index_differs_from(struct repository *r, const char *def,
449 const struct diff_flags *flags,
f758a7f8 450 int ita_invisible_in_index);
75f3ff2e 451
a64e6a44
JK
452/*
453 * Fill the contents of the filespec "df", respecting any textconv defined by
454 * its userdiff driver. The "driver" parameter must come from a
455 * previous call to get_textconv(), and therefore should either be NULL or have
456 * textconv enabled.
457 *
458 * Note that the memory ownership of the resulting buffer depends on whether
459 * the driver field is NULL. If it is, then the memory belongs to the filespec
460 * struct. If it is non-NULL, then "outbuf" points to a newly allocated buffer
461 * that should be freed by the caller.
462 */
6afaf807
NTND
463size_t fill_textconv(struct repository *r,
464 struct userdiff_driver *driver,
f758a7f8
NTND
465 struct diff_filespec *df,
466 char **outbuf);
a788d7d5 467
a64e6a44
JK
468/*
469 * Look up the userdiff driver for the given filespec, and return it if
470 * and only if it has textconv enabled (otherwise return NULL). The result
471 * can be passed to fill_textconv().
472 */
bd7ad45b 473struct userdiff_driver *get_textconv(struct repository *r,
acd00ea0 474 struct diff_filespec *one);
a788d7d5 475
3a35cb2e
JS
476/*
477 * Prepare diff_filespec and convert it using diff textconv API
478 * if the textconv driver exists.
479 * Return 1 if the conversion succeeds, 0 otherwise.
480 */
6afaf807
NTND
481int textconv_object(struct repository *repo,
482 const char *path,
483 unsigned mode,
484 const struct object_id *oid, int oid_valid,
485 char **buf, unsigned long *buf_size);
3a35cb2e 486
f758a7f8 487int parse_rename_score(const char **cp_p);
10ae7526 488
f758a7f8 489long parse_algorithm_value(const char *value);
07924d4d 490
f758a7f8
NTND
491void print_stat_summary(FILE *fp, int files,
492 int insertions, int deletions);
493void setup_diff_pager(struct diff_options *);
7f814632 494
86436c28 495#endif /* DIFF_H */