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