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