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