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