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