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