]> git.ipfire.org Git - thirdparty/git.git/blame - diff.h
Merge branch 'lm/squelch-bg-progress'
[thirdparty/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;
0041f09d 17struct sha1_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,
26 const unsigned char *old_sha1,
27 const unsigned char *new_sha1,
e5450100 28 int old_sha1_valid, int new_sha1_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,
34 const unsigned char *sha1,
e5450100 35 int sha1_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)
752c0c24 86#define DIFF_OPT_SUBMODULE_LOG (1 << 23)
9297f77e 87#define DIFF_OPT_DIRTY_SUBMODULES (1 << 24)
3bfc4504 88#define DIFF_OPT_IGNORE_UNTRACKED_IN_SUBMODULES (1 << 25)
4af574db 89#define DIFF_OPT_IGNORE_DIRTY_SUBMODULES (1 << 26)
aee9c7d6 90#define DIFF_OPT_OVERRIDE_SUBMODULE_CONFIG (1 << 27)
1c57a627 91#define DIFF_OPT_DIRSTAT_BY_LINE (1 << 28)
14937c2c 92#define DIFF_OPT_FUNCCONTEXT (1 << 29)
accccde4 93#define DIFF_OPT_PICKAXE_IGNORE_CASE (1 << 30)
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
6b5ee137 112struct diff_options {
6b5ee137
JH
113 const char *orderfile;
114 const char *pickaxe;
2f3f8b21 115 const char *single_follow;
eab9a40b 116 const char *a_prefix, *b_prefix;
8f67f8ae 117 unsigned flags;
6c374008 118 unsigned touched_flags;
1ecc1cbd
JH
119
120 /* diff-filter bits */
121 unsigned int filter;
122
f1c96261 123 int use_color;
ee1e5412 124 int context;
6d0e674a 125 int interhunkcontext;
6b5ee137
JH
126 int break_opt;
127 int detect_rename;
467ddc14 128 int irreversible_delete;
fb13227e 129 int skip_stat_unmatch;
6b5ee137
JH
130 int line_termination;
131 int output_format;
132 int pickaxe_opts;
133 int rename_score;
8082d8d3 134 int rename_limit;
bf0ab10f 135 int needed_rename_limit;
f31027c9 136 int degraded_cc_to_c;
3ac942d4 137 int show_rename_progress;
712d2c7d 138 int dirstat_permille;
6b5ee137 139 int setup;
47dd0d59 140 int abbrev;
cd676a51
JH
141 const char *prefix;
142 int prefix_length;
698ce6f8 143 const char *stat_sep;
0d21efa5 144 long xdl_opts;
ac1b3d12 145
a2540023
JH
146 int stat_width;
147 int stat_name_width;
969fe57b 148 int stat_graph_width;
808e1db2 149 int stat_count;
2b6a5417 150 const char *word_regex;
882749a0 151 enum diff_words_type word_diff;
a2540023 152
34a5e1a2
JS
153 /* this is set by diffcore for DIFF_FORMAT_PATCH */
154 int found_changes;
155
44c48a90
JH
156 /* to support internal diff recursion by --follow hack*/
157 int found_follow;
158
6c374008
JH
159 void (*set_default)(struct diff_options *);
160
c0c77734
DB
161 FILE *file;
162 int close_file;
163
66f13625 164 struct pathspec pathspec;
72441af7 165 pathchange_fn_t pathchange;
ac1b3d12
LT
166 change_fn_t change;
167 add_remove_fn_t add_remove;
04245581
JK
168 diff_format_fn_t format_callback;
169 void *format_callback_data;
a3c158d4 170 diff_prefix_fn_t output_prefix;
5e71a84a 171 int output_prefix_length;
a3c158d4 172 void *output_prefix_data;
ee7fb0b1
ZK
173
174 int diff_path_counter;
6b5ee137
JH
175};
176
ce436973
JK
177enum color_diff {
178 DIFF_RESET = 0,
179 DIFF_PLAIN = 1,
180 DIFF_METAINFO = 2,
181 DIFF_FRAGINFO = 3,
182 DIFF_FILE_OLD = 4,
183 DIFF_FILE_NEW = 5,
184 DIFF_COMMIT = 6,
448c3ef1 185 DIFF_WHITESPACE = 7,
4b05548f 186 DIFF_FUNCINFO = 8
ce436973
JK
187};
188const char *diff_get_color(int diff_use_color, enum color_diff ix);
8f67f8ae 189#define diff_get_color_opt(o, ix) \
f1c96261 190 diff_get_color((o)->use_color, ix)
8f67f8ae 191
ce436973 192
f1922234
JK
193const char *diff_line_prefix(struct diff_options *);
194
195
698ce6f8
JS
196extern const char mime_boundary_leader[];
197
72441af7
KS
198extern struct combine_diff_path *diff_tree_paths(
199 struct combine_diff_path *p, const unsigned char *sha1,
200 const unsigned char **parent_sha1, int nparent,
201 struct strbuf *base, struct diff_options *opt);
ac1b3d12
LT
202extern int diff_tree_sha1(const unsigned char *old, const unsigned char *new,
203 const char *base, struct diff_options *opt);
2b60356d
RS
204extern int diff_root_tree_sha1(const unsigned char *new, const char *base,
205 struct diff_options *opt);
ac1b3d12 206
ea726d02
JH
207struct combine_diff_path {
208 struct combine_diff_path *next;
ea726d02 209 char *path;
2454c962 210 unsigned int mode;
1ff57c13 211 struct object_id oid;
2454c962 212 struct combine_diff_parent {
d416df88 213 char status;
2454c962 214 unsigned int mode;
1ff57c13 215 struct object_id oid;
2454c962 216 } parent[FLEX_ARRAY];
ea726d02 217};
2454c962
JH
218#define combine_diff_path_size(n, l) \
219 (sizeof(struct combine_diff_path) + \
220 sizeof(struct combine_diff_parent) * (n) + (l) + 1)
ea726d02 221
91539833
LT
222extern void show_combined_diff(struct combine_diff_path *elem, int num_parent,
223 int dense, struct rev_info *);
ea726d02 224
0041f09d 225extern void diff_tree_combined(const unsigned char *sha1, const struct sha1_array *parents, int dense, struct rev_info *rev);
0fe7c1de 226
82889295 227extern void diff_tree_combined_merge(const struct commit *commit, int dense, struct rev_info *rev);
af3feefa 228
a5a818ee
JH
229void diff_set_mnemonic_prefix(struct diff_options *options, const char *a, const char *b);
230
28b9264d
JH
231extern int diff_can_quit_early(struct diff_options *);
232
6b5ee137
JH
233extern void diff_addremove(struct diff_options *,
234 int addremove,
77eb2720
JH
235 unsigned mode,
236 const unsigned char *sha1,
e5450100 237 int sha1_valid,
e3d42c47 238 const char *fullpath, unsigned dirty_submodule);
77eb2720 239
6b5ee137
JH
240extern void diff_change(struct diff_options *,
241 unsigned mode1, unsigned mode2,
242 const unsigned char *sha1,
243 const unsigned char *sha2,
e5450100
JK
244 int sha1_valid,
245 int sha2_valid,
e3d42c47
JL
246 const char *fullpath,
247 unsigned dirty_submodule1, unsigned dirty_submodule2);
77eb2720 248
fa7b2908 249extern struct diff_filepair *diff_unmerge(struct diff_options *, const char *path);
77eb2720 250
19feebc8 251#define DIFF_SETUP_REVERSE 1
f0c6b2a2
JH
252#define DIFF_SETUP_USE_CACHE 2
253#define DIFF_SETUP_USE_SIZE_CACHE 4
ce240675 254
dea007fb 255/*
b0d12fc9 256 * Poor man's alternative to parse-option, to allow both stuck form
dea007fb
MM
257 * (--option=value) and separate form (--option value).
258 */
259extern int parse_long_opt(const char *opt, const char **argv,
260 const char **optarg);
261
ef90d6d4
JS
262extern int git_diff_basic_config(const char *var, const char *value, void *cb);
263extern int git_diff_ui_config(const char *var, const char *value, void *cb);
6b5ee137
JH
264extern void diff_setup(struct diff_options *);
265extern int diff_opt_parse(struct diff_options *, const char **, int);
28452655 266extern void diff_setup_done(struct diff_options *);
86436c28 267
6b14d7fa
JH
268#define DIFF_DETECT_RENAME 1
269#define DIFF_DETECT_COPY 2
270
367cec1c 271#define DIFF_PICKAXE_ALL 1
d01d8c67 272#define DIFF_PICKAXE_REGEX 2
f345b0a0 273
f506b8e8
JH
274#define DIFF_PICKAXE_KIND_S 4 /* traditional plumbing counter */
275#define DIFF_PICKAXE_KIND_G 8 /* grep in the patch */
276
6b5ee137 277extern void diffcore_std(struct diff_options *);
730f7284 278extern void diffcore_fix_diff_index(struct diff_options *);
f2ce9fde 279
dda2d79a
JH
280#define COMMON_DIFF_OPTIONS_HELP \
281"\ncommon diff options:\n" \
8082d8d3
JH
282" -z output diff-raw with lines terminated with NUL.\n" \
283" -p output patch format.\n" \
284" -u synonym for -p.\n" \
5c91da25
PB
285" --patch-with-raw\n" \
286" output both a patch and the diff-raw format.\n" \
d75f7952 287" --stat show diffstat instead of patch.\n" \
74e2abe5 288" --numstat show numeric diffstat instead of patch.\n" \
29353273
JS
289" --patch-with-stat\n" \
290" output a patch and prepend its diffstat.\n" \
8082d8d3 291" --name-only show only names of changed files.\n" \
946f5f7c 292" --name-status show names and status of changed files.\n" \
47dd0d59 293" --full-index show full object name on index lines.\n" \
913419fc 294" --abbrev=<n> abbreviate object names in diff-tree header and diff-raw.\n" \
8082d8d3
JH
295" -R swap input file pairs.\n" \
296" -B detect complete rewrites.\n" \
297" -M detect renames.\n" \
298" -C detect copies.\n" \
dda2d79a 299" --find-copies-harder\n" \
8082d8d3
JH
300" try unchanged files as candidate for copy detection.\n" \
301" -l<n> limit rename attempts up to <n> paths.\n" \
302" -O<file> reorder diffs according to the <file>.\n" \
303" -S<string> find filepair whose only one side contains the string.\n" \
dda2d79a 304" --pickaxe-all\n" \
ca49920f
SF
305" show all files diff when -S is used and hit is found.\n" \
306" -a --text treat all files as text.\n"
dda2d79a 307
38c6f780 308extern int diff_queue_is_empty(void);
6b5ee137 309extern void diff_flush(struct diff_options*);
f31027c9 310extern void diff_warn_rename_limit(const char *varname, int needed, int degraded_cc);
86436c28 311
e7baa4f4 312/* diff-raw status letters */
ca8c9156 313#define DIFF_STATUS_ADDED 'A'
e7baa4f4
JH
314#define DIFF_STATUS_COPIED 'C'
315#define DIFF_STATUS_DELETED 'D'
316#define DIFF_STATUS_MODIFIED 'M'
317#define DIFF_STATUS_RENAMED 'R'
318#define DIFF_STATUS_TYPE_CHANGED 'T'
319#define DIFF_STATUS_UNKNOWN 'X'
320#define DIFF_STATUS_UNMERGED 'U'
321
322/* these are not diff-raw status letters proper, but used by
323 * diffcore-filter insn to specify additional restrictions.
324 */
0b34379a 325#define DIFF_STATUS_FILTER_AON '*'
e7baa4f4
JH
326#define DIFF_STATUS_FILTER_BROKEN 'B'
327
47dd0d59
JH
328extern const char *diff_unique_abbrev(const unsigned char *, int);
329
4bd5b7da
JH
330/* do not report anything on removed paths */
331#define DIFF_SILENT_ON_REMOVED 01
fb63d7f8
JH
332/* report racily-clean paths as modified */
333#define DIFF_RACY_IS_MODIFIED 02
4bd5b7da 334extern int run_diff_files(struct rev_info *revs, unsigned int option);
5c21ac0e 335extern int run_diff_index(struct rev_info *revs, int cached);
e09ad6e1 336
1cfe7733 337extern int do_diff_cache(const unsigned char *, struct diff_options *);
fcb3d0ad
JS
338extern int diff_flush_patch_id(struct diff_options *, unsigned char *);
339
da31b358
JH
340extern int diff_result_code(struct diff_options *, int);
341
470faf96 342extern void diff_no_index(struct rev_info *, int, const char **, const char *);
0569e9b8 343
75f3ff2e
SB
344extern int index_differs_from(const char *def, int diff_flags);
345
a788d7d5
AB
346extern size_t fill_textconv(struct userdiff_driver *driver,
347 struct diff_filespec *df,
348 char **outbuf);
349
350extern struct userdiff_driver *get_textconv(struct diff_filespec *one);
351
10ae7526
KB
352extern int parse_rename_score(const char **cp_p);
353
07924d4d
MP
354extern long parse_algorithm_value(const char *value);
355
7f814632
NTND
356extern int print_stat_summary(FILE *fp, int files,
357 int insertions, int deletions);
4914c962 358extern void setup_diff_pager(struct diff_options *);
7f814632 359
86436c28 360#endif /* DIFF_H */