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