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