diff: clarify textconv interface
[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"
50f9a858 9
91539833 10struct rev_info;
ac1b3d12 11struct diff_options;
04245581 12struct diff_queue_struct;
a3c158d4 13struct strbuf;
a788d7d5
AB
14struct diff_filespec;
15struct userdiff_driver;
0041f09d 16struct sha1_array;
82889295 17struct commit;
72441af7
KS
18struct combine_diff_path;
19
20typedef int (*pathchange_fn_t)(struct diff_options *options,
21 struct combine_diff_path *path);
ac1b3d12
LT
22
23typedef void (*change_fn_t)(struct diff_options *options,
24 unsigned old_mode, unsigned new_mode,
25 const unsigned char *old_sha1,
26 const unsigned char *new_sha1,
e5450100 27 int old_sha1_valid, int new_sha1_valid,
e3d42c47
JL
28 const char *fullpath,
29 unsigned old_dirty_submodule, unsigned new_dirty_submodule);
ac1b3d12
LT
30
31typedef void (*add_remove_fn_t)(struct diff_options *options,
32 int addremove, unsigned mode,
33 const unsigned char *sha1,
e5450100 34 int sha1_valid,
e3d42c47 35 const char *fullpath, unsigned dirty_submodule);
ac1b3d12 36
04245581
JK
37typedef void (*diff_format_fn_t)(struct diff_queue_struct *q,
38 struct diff_options *options, void *data);
39
a3c158d4
BY
40typedef struct strbuf *(*diff_prefix_fn_t)(struct diff_options *opt, void *data);
41
c6744349
TH
42#define DIFF_FORMAT_RAW 0x0001
43#define DIFF_FORMAT_DIFFSTAT 0x0002
74e2abe5
JH
44#define DIFF_FORMAT_NUMSTAT 0x0004
45#define DIFF_FORMAT_SUMMARY 0x0008
46#define DIFF_FORMAT_PATCH 0x0010
ebd124c6 47#define DIFF_FORMAT_SHORTSTAT 0x0020
7df7c019 48#define DIFF_FORMAT_DIRSTAT 0x0040
c6744349
TH
49
50/* These override all above */
74e2abe5
JH
51#define DIFF_FORMAT_NAME 0x0100
52#define DIFF_FORMAT_NAME_STATUS 0x0200
53#define DIFF_FORMAT_CHECKDIFF 0x0400
c6744349
TH
54
55/* Same as output_format = 0 but we know that -s flag was given
56 * and we should not give default value to output_format.
57 */
74e2abe5 58#define DIFF_FORMAT_NO_OUTPUT 0x0800
c6744349 59
74e2abe5 60#define DIFF_FORMAT_CALLBACK 0x1000
04245581 61
8f67f8ae
PH
62#define DIFF_OPT_RECURSIVE (1 << 0)
63#define DIFF_OPT_TREE_IN_RECURSIVE (1 << 1)
64#define DIFF_OPT_BINARY (1 << 2)
65#define DIFF_OPT_TEXT (1 << 3)
66#define DIFF_OPT_FULL_INDEX (1 << 4)
67#define DIFF_OPT_SILENT_ON_REMOVE (1 << 5)
68#define DIFF_OPT_FIND_COPIES_HARDER (1 << 6)
69#define DIFF_OPT_FOLLOW_RENAMES (1 << 7)
90d43b07 70#define DIFF_OPT_RENAME_EMPTY (1 << 8)
882749a0 71/* (1 << 9) unused */
8f67f8ae 72#define DIFF_OPT_HAS_CHANGES (1 << 10)
90b19941 73#define DIFF_OPT_QUICK (1 << 11)
8f67f8ae
PH
74#define DIFF_OPT_NO_INDEX (1 << 12)
75#define DIFF_OPT_ALLOW_EXTERNAL (1 << 13)
76#define DIFF_OPT_EXIT_WITH_STATUS (1 << 14)
77#define DIFF_OPT_REVERSE_DIFF (1 << 15)
62c64895 78#define DIFF_OPT_CHECK_FAILED (1 << 16)
cd676a51 79#define DIFF_OPT_RELATIVE_NAME (1 << 17)
50fd9bd8 80#define DIFF_OPT_IGNORE_SUBMODULES (1 << 18)
f88d225f 81#define DIFF_OPT_DIRSTAT_CUMULATIVE (1 << 19)
fd33777b 82#define DIFF_OPT_DIRSTAT_BY_FILE (1 << 20)
c7534ef4 83#define DIFF_OPT_ALLOW_TEXTCONV (1 << 21)
f245194f 84#define DIFF_OPT_DIFF_FROM_CONTENTS (1 << 22)
752c0c24 85#define DIFF_OPT_SUBMODULE_LOG (1 << 23)
9297f77e 86#define DIFF_OPT_DIRTY_SUBMODULES (1 << 24)
3bfc4504 87#define DIFF_OPT_IGNORE_UNTRACKED_IN_SUBMODULES (1 << 25)
4af574db 88#define DIFF_OPT_IGNORE_DIRTY_SUBMODULES (1 << 26)
aee9c7d6 89#define DIFF_OPT_OVERRIDE_SUBMODULE_CONFIG (1 << 27)
1c57a627 90#define DIFF_OPT_DIRSTAT_BY_LINE (1 << 28)
14937c2c 91#define DIFF_OPT_FUNCCONTEXT (1 << 29)
accccde4 92#define DIFF_OPT_PICKAXE_IGNORE_CASE (1 << 30)
752c0c24 93
8f67f8ae 94#define DIFF_OPT_TST(opts, flag) ((opts)->flags & DIFF_OPT_##flag)
6c374008
JH
95#define DIFF_OPT_TOUCHED(opts, flag) ((opts)->touched_flags & DIFF_OPT_##flag)
96#define DIFF_OPT_SET(opts, flag) (((opts)->flags |= DIFF_OPT_##flag),((opts)->touched_flags |= DIFF_OPT_##flag))
97#define DIFF_OPT_CLR(opts, flag) (((opts)->flags &= ~DIFF_OPT_##flag),((opts)->touched_flags |= DIFF_OPT_##flag))
628d5c2b
KC
98#define DIFF_XDL_TST(opts, flag) ((opts)->xdl_opts & XDF_##flag)
99#define DIFF_XDL_SET(opts, flag) ((opts)->xdl_opts |= XDF_##flag)
100#define DIFF_XDL_CLR(opts, flag) ((opts)->xdl_opts &= ~XDF_##flag)
8f67f8ae 101
307ab20b
JH
102#define DIFF_WITH_ALG(opts, flag) (((opts)->xdl_opts & ~XDF_DIFF_ALGORITHM_MASK) | XDF_##flag)
103
882749a0
TR
104enum diff_words_type {
105 DIFF_WORDS_NONE = 0,
106 DIFF_WORDS_PORCELAIN,
107 DIFF_WORDS_PLAIN,
108 DIFF_WORDS_COLOR
109};
110
6b5ee137 111struct diff_options {
6b5ee137
JH
112 const char *orderfile;
113 const char *pickaxe;
2f3f8b21 114 const char *single_follow;
eab9a40b 115 const char *a_prefix, *b_prefix;
8f67f8ae 116 unsigned flags;
6c374008 117 unsigned touched_flags;
1ecc1cbd
JH
118
119 /* diff-filter bits */
120 unsigned int filter;
121
f1c96261 122 int use_color;
ee1e5412 123 int context;
6d0e674a 124 int interhunkcontext;
6b5ee137
JH
125 int break_opt;
126 int detect_rename;
467ddc14 127 int irreversible_delete;
fb13227e 128 int skip_stat_unmatch;
6b5ee137
JH
129 int line_termination;
130 int output_format;
131 int pickaxe_opts;
132 int rename_score;
8082d8d3 133 int rename_limit;
bf0ab10f 134 int needed_rename_limit;
f31027c9 135 int degraded_cc_to_c;
3ac942d4 136 int show_rename_progress;
712d2c7d 137 int dirstat_permille;
6b5ee137 138 int setup;
47dd0d59 139 int abbrev;
cd676a51
JH
140 const char *prefix;
141 int prefix_length;
698ce6f8 142 const char *stat_sep;
0d21efa5 143 long xdl_opts;
ac1b3d12 144
a2540023
JH
145 int stat_width;
146 int stat_name_width;
969fe57b 147 int stat_graph_width;
808e1db2 148 int stat_count;
2b6a5417 149 const char *word_regex;
882749a0 150 enum diff_words_type word_diff;
a2540023 151
34a5e1a2
JS
152 /* this is set by diffcore for DIFF_FORMAT_PATCH */
153 int found_changes;
154
44c48a90
JH
155 /* to support internal diff recursion by --follow hack*/
156 int found_follow;
157
6c374008
JH
158 void (*set_default)(struct diff_options *);
159
c0c77734
DB
160 FILE *file;
161 int close_file;
162
66f13625 163 struct pathspec pathspec;
72441af7 164 pathchange_fn_t pathchange;
ac1b3d12
LT
165 change_fn_t change;
166 add_remove_fn_t add_remove;
04245581
JK
167 diff_format_fn_t format_callback;
168 void *format_callback_data;
a3c158d4 169 diff_prefix_fn_t output_prefix;
5e71a84a 170 int output_prefix_length;
a3c158d4 171 void *output_prefix_data;
ee7fb0b1
ZK
172
173 int diff_path_counter;
6b5ee137
JH
174};
175
ce436973
JK
176enum color_diff {
177 DIFF_RESET = 0,
8dbf3eb6 178 DIFF_CONTEXT = 1,
ce436973
JK
179 DIFF_METAINFO = 2,
180 DIFF_FRAGINFO = 3,
181 DIFF_FILE_OLD = 4,
182 DIFF_FILE_NEW = 5,
183 DIFF_COMMIT = 6,
448c3ef1 184 DIFF_WHITESPACE = 7,
4b05548f 185 DIFF_FUNCINFO = 8
ce436973
JK
186};
187const char *diff_get_color(int diff_use_color, enum color_diff ix);
8f67f8ae 188#define diff_get_color_opt(o, ix) \
f1c96261 189 diff_get_color((o)->use_color, ix)
8f67f8ae 190
ce436973 191
f1922234
JK
192const char *diff_line_prefix(struct diff_options *);
193
194
698ce6f8
JS
195extern const char mime_boundary_leader[];
196
72441af7
KS
197extern struct combine_diff_path *diff_tree_paths(
198 struct combine_diff_path *p, const unsigned char *sha1,
199 const unsigned char **parent_sha1, int nparent,
200 struct strbuf *base, struct diff_options *opt);
ac1b3d12
LT
201extern int diff_tree_sha1(const unsigned char *old, const unsigned char *new,
202 const char *base, struct diff_options *opt);
2b60356d
RS
203extern int diff_root_tree_sha1(const unsigned char *new, const char *base,
204 struct diff_options *opt);
ac1b3d12 205
ea726d02
JH
206struct combine_diff_path {
207 struct combine_diff_path *next;
ea726d02 208 char *path;
2454c962 209 unsigned int mode;
ea726d02 210 unsigned char sha1[20];
2454c962 211 struct combine_diff_parent {
d416df88 212 char status;
2454c962
JH
213 unsigned int mode;
214 unsigned char sha1[20];
215 } parent[FLEX_ARRAY];
ea726d02 216};
2454c962
JH
217#define combine_diff_path_size(n, l) \
218 (sizeof(struct combine_diff_path) + \
219 sizeof(struct combine_diff_parent) * (n) + (l) + 1)
ea726d02 220
91539833
LT
221extern void show_combined_diff(struct combine_diff_path *elem, int num_parent,
222 int dense, struct rev_info *);
ea726d02 223
0041f09d 224extern void diff_tree_combined(const unsigned char *sha1, const struct sha1_array *parents, int dense, struct rev_info *rev);
0fe7c1de 225
82889295 226extern void diff_tree_combined_merge(const struct commit *commit, int dense, struct rev_info *rev);
af3feefa 227
a5a818ee
JH
228void diff_set_mnemonic_prefix(struct diff_options *options, const char *a, const char *b);
229
28b9264d
JH
230extern int diff_can_quit_early(struct diff_options *);
231
6b5ee137
JH
232extern void diff_addremove(struct diff_options *,
233 int addremove,
77eb2720
JH
234 unsigned mode,
235 const unsigned char *sha1,
e5450100 236 int sha1_valid,
e3d42c47 237 const char *fullpath, unsigned dirty_submodule);
77eb2720 238
6b5ee137
JH
239extern void diff_change(struct diff_options *,
240 unsigned mode1, unsigned mode2,
241 const unsigned char *sha1,
242 const unsigned char *sha2,
e5450100
JK
243 int sha1_valid,
244 int sha2_valid,
e3d42c47
JL
245 const char *fullpath,
246 unsigned dirty_submodule1, unsigned dirty_submodule2);
77eb2720 247
fa7b2908 248extern struct diff_filepair *diff_unmerge(struct diff_options *, const char *path);
77eb2720 249
19feebc8 250#define DIFF_SETUP_REVERSE 1
f0c6b2a2
JH
251#define DIFF_SETUP_USE_CACHE 2
252#define DIFF_SETUP_USE_SIZE_CACHE 4
ce240675 253
dea007fb 254/*
b0d12fc9 255 * Poor man's alternative to parse-option, to allow both stuck form
dea007fb
MM
256 * (--option=value) and separate form (--option value).
257 */
258extern int parse_long_opt(const char *opt, const char **argv,
259 const char **optarg);
260
ef90d6d4
JS
261extern int git_diff_basic_config(const char *var, const char *value, void *cb);
262extern int git_diff_ui_config(const char *var, const char *value, void *cb);
6b5ee137
JH
263extern void diff_setup(struct diff_options *);
264extern int diff_opt_parse(struct diff_options *, const char **, int);
28452655 265extern void diff_setup_done(struct diff_options *);
86436c28 266
6b14d7fa
JH
267#define DIFF_DETECT_RENAME 1
268#define DIFF_DETECT_COPY 2
269
367cec1c 270#define DIFF_PICKAXE_ALL 1
d01d8c67 271#define DIFF_PICKAXE_REGEX 2
f345b0a0 272
f506b8e8
JH
273#define DIFF_PICKAXE_KIND_S 4 /* traditional plumbing counter */
274#define DIFF_PICKAXE_KIND_G 8 /* grep in the patch */
275
6b5ee137 276extern void diffcore_std(struct diff_options *);
730f7284 277extern void diffcore_fix_diff_index(struct diff_options *);
f2ce9fde 278
dda2d79a
JH
279#define COMMON_DIFF_OPTIONS_HELP \
280"\ncommon diff options:\n" \
8082d8d3
JH
281" -z output diff-raw with lines terminated with NUL.\n" \
282" -p output patch format.\n" \
283" -u synonym for -p.\n" \
5c91da25
PB
284" --patch-with-raw\n" \
285" output both a patch and the diff-raw format.\n" \
d75f7952 286" --stat show diffstat instead of patch.\n" \
74e2abe5 287" --numstat show numeric diffstat instead of patch.\n" \
29353273
JS
288" --patch-with-stat\n" \
289" output a patch and prepend its diffstat.\n" \
8082d8d3 290" --name-only show only names of changed files.\n" \
946f5f7c 291" --name-status show names and status of changed files.\n" \
47dd0d59 292" --full-index show full object name on index lines.\n" \
913419fc 293" --abbrev=<n> abbreviate object names in diff-tree header and diff-raw.\n" \
8082d8d3
JH
294" -R swap input file pairs.\n" \
295" -B detect complete rewrites.\n" \
296" -M detect renames.\n" \
297" -C detect copies.\n" \
dda2d79a 298" --find-copies-harder\n" \
8082d8d3
JH
299" try unchanged files as candidate for copy detection.\n" \
300" -l<n> limit rename attempts up to <n> paths.\n" \
301" -O<file> reorder diffs according to the <file>.\n" \
302" -S<string> find filepair whose only one side contains the string.\n" \
dda2d79a 303" --pickaxe-all\n" \
ca49920f
SF
304" show all files diff when -S is used and hit is found.\n" \
305" -a --text treat all files as text.\n"
dda2d79a 306
38c6f780 307extern int diff_queue_is_empty(void);
6b5ee137 308extern void diff_flush(struct diff_options*);
f31027c9 309extern void diff_warn_rename_limit(const char *varname, int needed, int degraded_cc);
86436c28 310
e7baa4f4 311/* diff-raw status letters */
ca8c9156 312#define DIFF_STATUS_ADDED 'A'
e7baa4f4
JH
313#define DIFF_STATUS_COPIED 'C'
314#define DIFF_STATUS_DELETED 'D'
315#define DIFF_STATUS_MODIFIED 'M'
316#define DIFF_STATUS_RENAMED 'R'
317#define DIFF_STATUS_TYPE_CHANGED 'T'
318#define DIFF_STATUS_UNKNOWN 'X'
319#define DIFF_STATUS_UNMERGED 'U'
320
321/* these are not diff-raw status letters proper, but used by
322 * diffcore-filter insn to specify additional restrictions.
323 */
0b34379a 324#define DIFF_STATUS_FILTER_AON '*'
e7baa4f4
JH
325#define DIFF_STATUS_FILTER_BROKEN 'B'
326
47dd0d59
JH
327extern const char *diff_unique_abbrev(const unsigned char *, int);
328
4bd5b7da
JH
329/* do not report anything on removed paths */
330#define DIFF_SILENT_ON_REMOVED 01
fb63d7f8
JH
331/* report racily-clean paths as modified */
332#define DIFF_RACY_IS_MODIFIED 02
4bd5b7da 333extern int run_diff_files(struct rev_info *revs, unsigned int option);
5c21ac0e 334extern int run_diff_index(struct rev_info *revs, int cached);
e09ad6e1 335
1cfe7733 336extern int do_diff_cache(const unsigned char *, struct diff_options *);
fcb3d0ad
JS
337extern int diff_flush_patch_id(struct diff_options *, unsigned char *);
338
da31b358
JH
339extern int diff_result_code(struct diff_options *, int);
340
470faf96 341extern void diff_no_index(struct rev_info *, int, const char **, const char *);
0569e9b8 342
75f3ff2e
SB
343extern int index_differs_from(const char *def, int diff_flags);
344
a64e6a44
JK
345/*
346 * Fill the contents of the filespec "df", respecting any textconv defined by
347 * its userdiff driver. The "driver" parameter must come from a
348 * previous call to get_textconv(), and therefore should either be NULL or have
349 * textconv enabled.
350 *
351 * Note that the memory ownership of the resulting buffer depends on whether
352 * the driver field is NULL. If it is, then the memory belongs to the filespec
353 * struct. If it is non-NULL, then "outbuf" points to a newly allocated buffer
354 * that should be freed by the caller.
355 */
a788d7d5
AB
356extern size_t fill_textconv(struct userdiff_driver *driver,
357 struct diff_filespec *df,
358 char **outbuf);
359
a64e6a44
JK
360/*
361 * Look up the userdiff driver for the given filespec, and return it if
362 * and only if it has textconv enabled (otherwise return NULL). The result
363 * can be passed to fill_textconv().
364 */
a788d7d5
AB
365extern struct userdiff_driver *get_textconv(struct diff_filespec *one);
366
10ae7526
KB
367extern int parse_rename_score(const char **cp_p);
368
07924d4d
MP
369extern long parse_algorithm_value(const char *value);
370
7f814632
NTND
371extern int print_stat_summary(FILE *fp, int files,
372 int insertions, int deletions);
4914c962 373extern void setup_diff_pager(struct diff_options *);
7f814632 374
86436c28 375#endif /* DIFF_H */