Submodules: Add the new "ignore" config option for diff and status
[git/git.git] / diff.h
1 /*
2 * Copyright (C) 2005 Junio C Hamano
3 */
4 #ifndef DIFF_H
5 #define DIFF_H
6
7 #include "tree-walk.h"
8
9 struct rev_info;
10 struct diff_options;
11 struct diff_queue_struct;
12 struct strbuf;
13 struct diff_filespec;
14 struct userdiff_driver;
15
16 typedef 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,
20 const char *fullpath,
21 unsigned old_dirty_submodule, unsigned new_dirty_submodule);
22
23 typedef void (*add_remove_fn_t)(struct diff_options *options,
24 int addremove, unsigned mode,
25 const unsigned char *sha1,
26 const char *fullpath, unsigned dirty_submodule);
27
28 typedef void (*diff_format_fn_t)(struct diff_queue_struct *q,
29 struct diff_options *options, void *data);
30
31 typedef struct strbuf *(*diff_prefix_fn_t)(struct diff_options *opt, void *data);
32
33 #define DIFF_FORMAT_RAW 0x0001
34 #define DIFF_FORMAT_DIFFSTAT 0x0002
35 #define DIFF_FORMAT_NUMSTAT 0x0004
36 #define DIFF_FORMAT_SUMMARY 0x0008
37 #define DIFF_FORMAT_PATCH 0x0010
38 #define DIFF_FORMAT_SHORTSTAT 0x0020
39 #define DIFF_FORMAT_DIRSTAT 0x0040
40
41 /* These override all above */
42 #define DIFF_FORMAT_NAME 0x0100
43 #define DIFF_FORMAT_NAME_STATUS 0x0200
44 #define DIFF_FORMAT_CHECKDIFF 0x0400
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 */
49 #define DIFF_FORMAT_NO_OUTPUT 0x0800
50
51 #define DIFF_FORMAT_CALLBACK 0x1000
52
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)
62 /* (1 << 9) unused */
63 #define DIFF_OPT_HAS_CHANGES (1 << 10)
64 #define DIFF_OPT_QUICK (1 << 11)
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)
69 #define DIFF_OPT_CHECK_FAILED (1 << 16)
70 #define DIFF_OPT_RELATIVE_NAME (1 << 17)
71 #define DIFF_OPT_IGNORE_SUBMODULES (1 << 18)
72 #define DIFF_OPT_DIRSTAT_CUMULATIVE (1 << 19)
73 #define DIFF_OPT_DIRSTAT_BY_FILE (1 << 20)
74 #define DIFF_OPT_ALLOW_TEXTCONV (1 << 21)
75 #define DIFF_OPT_DIFF_FROM_CONTENTS (1 << 22)
76 #define DIFF_OPT_SUBMODULE_LOG (1 << 23)
77 #define DIFF_OPT_DIRTY_SUBMODULES (1 << 24)
78 #define DIFF_OPT_IGNORE_UNTRACKED_IN_SUBMODULES (1 << 25)
79 #define DIFF_OPT_IGNORE_DIRTY_SUBMODULES (1 << 26)
80 #define DIFF_OPT_OVERRIDE_SUBMODULE_CONFIG (1 << 27)
81
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)
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)
88
89 enum diff_words_type {
90 DIFF_WORDS_NONE = 0,
91 DIFF_WORDS_PORCELAIN,
92 DIFF_WORDS_PLAIN,
93 DIFF_WORDS_COLOR
94 };
95
96 struct diff_options {
97 const char *filter;
98 const char *orderfile;
99 const char *pickaxe;
100 const char *single_follow;
101 const char *a_prefix, *b_prefix;
102 unsigned flags;
103 int context;
104 int interhunkcontext;
105 int break_opt;
106 int detect_rename;
107 int skip_stat_unmatch;
108 int line_termination;
109 int output_format;
110 int pickaxe_opts;
111 int rename_score;
112 int rename_limit;
113 int warn_on_too_large_rename;
114 int dirstat_percent;
115 int setup;
116 int abbrev;
117 const char *prefix;
118 int prefix_length;
119 const char *stat_sep;
120 long xdl_opts;
121
122 int stat_width;
123 int stat_name_width;
124 const char *word_regex;
125 enum diff_words_type word_diff;
126
127 /* this is set by diffcore for DIFF_FORMAT_PATCH */
128 int found_changes;
129
130 FILE *file;
131 int close_file;
132
133 int nr_paths;
134 const char **paths;
135 int *pathlens;
136 change_fn_t change;
137 add_remove_fn_t add_remove;
138 diff_format_fn_t format_callback;
139 void *format_callback_data;
140 diff_prefix_fn_t output_prefix;
141 void *output_prefix_data;
142 };
143
144 enum 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,
152 DIFF_WHITESPACE = 7,
153 DIFF_FUNCINFO = 8
154 };
155 const char *diff_get_color(int diff_use_color, enum color_diff ix);
156 #define diff_get_color_opt(o, ix) \
157 diff_get_color(DIFF_OPT_TST((o), COLOR_DIFF), ix)
158
159
160 extern const char mime_boundary_leader[];
161
162 extern void diff_tree_setup_paths(const char **paths, struct diff_options *);
163 extern void diff_tree_release_paths(struct diff_options *);
164 extern int diff_tree(struct tree_desc *t1, struct tree_desc *t2,
165 const char *base, struct diff_options *opt);
166 extern int diff_tree_sha1(const unsigned char *old, const unsigned char *new,
167 const char *base, struct diff_options *opt);
168 extern int diff_root_tree_sha1(const unsigned char *new, const char *base,
169 struct diff_options *opt);
170
171 struct combine_diff_path {
172 struct combine_diff_path *next;
173 int len;
174 char *path;
175 unsigned int mode;
176 unsigned char sha1[20];
177 struct combine_diff_parent {
178 char status;
179 unsigned int mode;
180 unsigned char sha1[20];
181 } parent[FLEX_ARRAY];
182 };
183 #define combine_diff_path_size(n, l) \
184 (sizeof(struct combine_diff_path) + \
185 sizeof(struct combine_diff_parent) * (n) + (l) + 1)
186
187 extern void show_combined_diff(struct combine_diff_path *elem, int num_parent,
188 int dense, struct rev_info *);
189
190 extern void diff_tree_combined(const unsigned char *sha1, const unsigned char parent[][20], int num_parent, int dense, struct rev_info *rev);
191
192 extern void diff_tree_combined_merge(const unsigned char *sha1, int, struct rev_info *);
193
194 void diff_set_mnemonic_prefix(struct diff_options *options, const char *a, const char *b);
195
196 extern void diff_addremove(struct diff_options *,
197 int addremove,
198 unsigned mode,
199 const unsigned char *sha1,
200 const char *fullpath, unsigned dirty_submodule);
201
202 extern void diff_change(struct diff_options *,
203 unsigned mode1, unsigned mode2,
204 const unsigned char *sha1,
205 const unsigned char *sha2,
206 const char *fullpath,
207 unsigned dirty_submodule1, unsigned dirty_submodule2);
208
209 extern void diff_unmerge(struct diff_options *,
210 const char *path,
211 unsigned mode,
212 const unsigned char *sha1);
213
214 #define DIFF_SETUP_REVERSE 1
215 #define DIFF_SETUP_USE_CACHE 2
216 #define DIFF_SETUP_USE_SIZE_CACHE 4
217
218 extern int git_diff_basic_config(const char *var, const char *value, void *cb);
219 extern int git_diff_ui_config(const char *var, const char *value, void *cb);
220 extern int diff_use_color_default;
221 extern void diff_setup(struct diff_options *);
222 extern int diff_opt_parse(struct diff_options *, const char **, int);
223 extern int diff_setup_done(struct diff_options *);
224
225 #define DIFF_DETECT_RENAME 1
226 #define DIFF_DETECT_COPY 2
227
228 #define DIFF_PICKAXE_ALL 1
229 #define DIFF_PICKAXE_REGEX 2
230
231 extern void diffcore_std(struct diff_options *);
232 extern void diffcore_fix_diff_index(struct diff_options *);
233
234 #define COMMON_DIFF_OPTIONS_HELP \
235 "\ncommon diff options:\n" \
236 " -z output diff-raw with lines terminated with NUL.\n" \
237 " -p output patch format.\n" \
238 " -u synonym for -p.\n" \
239 " --patch-with-raw\n" \
240 " output both a patch and the diff-raw format.\n" \
241 " --stat show diffstat instead of patch.\n" \
242 " --numstat show numeric diffstat instead of patch.\n" \
243 " --patch-with-stat\n" \
244 " output a patch and prepend its diffstat.\n" \
245 " --name-only show only names of changed files.\n" \
246 " --name-status show names and status of changed files.\n" \
247 " --full-index show full object name on index lines.\n" \
248 " --abbrev=<n> abbreviate object names in diff-tree header and diff-raw.\n" \
249 " -R swap input file pairs.\n" \
250 " -B detect complete rewrites.\n" \
251 " -M detect renames.\n" \
252 " -C detect copies.\n" \
253 " --find-copies-harder\n" \
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" \
258 " --pickaxe-all\n" \
259 " show all files diff when -S is used and hit is found.\n" \
260 " -a --text treat all files as text.\n"
261
262 extern int diff_queue_is_empty(void);
263 extern void diff_flush(struct diff_options*);
264
265 /* diff-raw status letters */
266 #define DIFF_STATUS_ADDED 'A'
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 */
278 #define DIFF_STATUS_FILTER_AON '*'
279 #define DIFF_STATUS_FILTER_BROKEN 'B'
280
281 extern const char *diff_unique_abbrev(const unsigned char *, int);
282
283 /* do not report anything on removed paths */
284 #define DIFF_SILENT_ON_REMOVED 01
285 /* report racily-clean paths as modified */
286 #define DIFF_RACY_IS_MODIFIED 02
287 extern int run_diff_files(struct rev_info *revs, unsigned int option);
288 extern int run_diff_index(struct rev_info *revs, int cached);
289
290 extern int do_diff_cache(const unsigned char *, struct diff_options *);
291 extern int diff_flush_patch_id(struct diff_options *, unsigned char *);
292
293 extern int diff_result_code(struct diff_options *, int);
294
295 extern void diff_no_index(struct rev_info *, int, const char **, int, const char *);
296
297 extern int index_differs_from(const char *def, int diff_flags);
298
299 extern size_t fill_textconv(struct userdiff_driver *driver,
300 struct diff_filespec *df,
301 char **outbuf);
302
303 extern struct userdiff_driver *get_textconv(struct diff_filespec *one);
304
305 #endif /* DIFF_H */