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