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