1/*
2 * Copyright (C) 2005 Junio C Hamano
3 */
4#ifndef DIFF_H
5#define DIFF_H
6
7#include "tree-walk.h"
8
9struct rev_info;
10struct diff_options;
11struct diff_queue_struct;
12struct strbuf;
13struct diff_filespec;
14struct userdiff_driver;
15struct sha1_array;
16struct commit;
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,
22 int old_sha1_valid, int new_sha1_valid,
23 const char *fullpath,
24 unsigned old_dirty_submodule, unsigned new_dirty_submodule);
25
26typedef void (*add_remove_fn_t)(struct diff_options *options,
27 int addremove, unsigned mode,
28 const unsigned char *sha1,
29 int sha1_valid,
30 const char *fullpath, unsigned dirty_submodule);
31
32typedef void (*diff_format_fn_t)(struct diff_queue_struct *q,
33 struct diff_options *options, void *data);
34
35typedef struct strbuf *(*diff_prefix_fn_t)(struct diff_options *opt, void *data);
36
37#define DIFF_FORMAT_RAW 0x0001
38#define DIFF_FORMAT_DIFFSTAT 0x0002
39#define DIFF_FORMAT_NUMSTAT 0x0004
40#define DIFF_FORMAT_SUMMARY 0x0008
41#define DIFF_FORMAT_PATCH 0x0010
42#define DIFF_FORMAT_SHORTSTAT 0x0020
43#define DIFF_FORMAT_DIRSTAT 0x0040
44
45/* These override all above */
46#define DIFF_FORMAT_NAME 0x0100
47#define DIFF_FORMAT_NAME_STATUS 0x0200
48#define DIFF_FORMAT_CHECKDIFF 0x0400
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 */
53#define DIFF_FORMAT_NO_OUTPUT 0x0800
54
55#define DIFF_FORMAT_CALLBACK 0x1000
56
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)
65#define DIFF_OPT_RENAME_EMPTY (1 << 8)
66/* (1 << 9) unused */
67#define DIFF_OPT_HAS_CHANGES (1 << 10)
68#define DIFF_OPT_QUICK (1 << 11)
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)
73#define DIFF_OPT_CHECK_FAILED (1 << 16)
74#define DIFF_OPT_RELATIVE_NAME (1 << 17)
75#define DIFF_OPT_IGNORE_SUBMODULES (1 << 18)
76#define DIFF_OPT_DIRSTAT_CUMULATIVE (1 << 19)
77#define DIFF_OPT_DIRSTAT_BY_FILE (1 << 20)
78#define DIFF_OPT_ALLOW_TEXTCONV (1 << 21)
79#define DIFF_OPT_DIFF_FROM_CONTENTS (1 << 22)
80#define DIFF_OPT_SUBMODULE_LOG (1 << 23)
81#define DIFF_OPT_DIRTY_SUBMODULES (1 << 24)
82#define DIFF_OPT_IGNORE_UNTRACKED_IN_SUBMODULES (1 << 25)
83#define DIFF_OPT_IGNORE_DIRTY_SUBMODULES (1 << 26)
84#define DIFF_OPT_OVERRIDE_SUBMODULE_CONFIG (1 << 27)
85#define DIFF_OPT_DIRSTAT_BY_LINE (1 << 28)
86#define DIFF_OPT_FUNCCONTEXT (1 << 29)
87#define DIFF_OPT_PICKAXE_IGNORE_CASE (1 << 30)
88
89#define DIFF_OPT_TST(opts, flag) ((opts)->flags & DIFF_OPT_##flag)
90#define DIFF_OPT_TOUCHED(opts, flag) ((opts)->touched_flags & DIFF_OPT_##flag)
91#define DIFF_OPT_SET(opts, flag) (((opts)->flags |= DIFF_OPT_##flag),((opts)->touched_flags |= DIFF_OPT_##flag))
92#define DIFF_OPT_CLR(opts, flag) (((opts)->flags &= ~DIFF_OPT_##flag),((opts)->touched_flags |= DIFF_OPT_##flag))
93#define DIFF_XDL_TST(opts, flag) ((opts)->xdl_opts & XDF_##flag)
94#define DIFF_XDL_SET(opts, flag) ((opts)->xdl_opts |= XDF_##flag)
95#define DIFF_XDL_CLR(opts, flag) ((opts)->xdl_opts &= ~XDF_##flag)
96
97#define DIFF_WITH_ALG(opts, flag) (((opts)->xdl_opts & ~XDF_DIFF_ALGORITHM_MASK) | XDF_##flag)
98
99enum diff_words_type {
100 DIFF_WORDS_NONE = 0,
101 DIFF_WORDS_PORCELAIN,
102 DIFF_WORDS_PLAIN,
103 DIFF_WORDS_COLOR
104};
105
106struct diff_options {
107 const char *filter;
108 const char *orderfile;
109 const char *pickaxe;
110 const char *single_follow;
111 const char *a_prefix, *b_prefix;
112 unsigned flags;
113 unsigned touched_flags;
114 int use_color;
115 int context;
116 int interhunkcontext;
117 int break_opt;
118 int detect_rename;
119 int irreversible_delete;
120 int skip_stat_unmatch;
121 int line_termination;
122 int output_format;
123 int pickaxe_opts;
124 int rename_score;
125 int rename_limit;
126 int needed_rename_limit;
127 int degraded_cc_to_c;
128 int show_rename_progress;
129 int dirstat_permille;
130 int setup;
131 int abbrev;
132 const char *prefix;
133 int prefix_length;
134 const char *stat_sep;
135 long xdl_opts;
136
137 int stat_width;
138 int stat_name_width;
139 int stat_graph_width;
140 int stat_count;
141 const char *word_regex;
142 enum diff_words_type word_diff;
143
144 /* this is set by diffcore for DIFF_FORMAT_PATCH */
145 int found_changes;
146
147 /* to support internal diff recursion by --follow hack*/
148 int found_follow;
149
150 void (*set_default)(struct diff_options *);
151
152 FILE *file;
153 int close_file;
154
155 struct pathspec pathspec;
156 change_fn_t change;
157 add_remove_fn_t add_remove;
158 diff_format_fn_t format_callback;
159 void *format_callback_data;
160 diff_prefix_fn_t output_prefix;
161 int output_prefix_length;
162 void *output_prefix_data;
163};
164
165enum color_diff {
166 DIFF_RESET = 0,
167 DIFF_PLAIN = 1,
168 DIFF_METAINFO = 2,
169 DIFF_FRAGINFO = 3,
170 DIFF_FILE_OLD = 4,
171 DIFF_FILE_NEW = 5,
172 DIFF_COMMIT = 6,
173 DIFF_WHITESPACE = 7,
174 DIFF_FUNCINFO = 8
175};
176const char *diff_get_color(int diff_use_color, enum color_diff ix);
177#define diff_get_color_opt(o, ix) \
178 diff_get_color((o)->use_color, ix)
179
180
181const char *diff_line_prefix(struct diff_options *);
182
183
184extern const char mime_boundary_leader[];
185
186extern void diff_tree_setup_paths(const char **paths, struct diff_options *);
187extern void diff_tree_release_paths(struct diff_options *);
188extern int diff_tree(struct tree_desc *t1, struct tree_desc *t2,
189 const char *base, struct diff_options *opt);
190extern int diff_tree_sha1(const unsigned char *old, const unsigned char *new,
191 const char *base, struct diff_options *opt);
192extern int diff_root_tree_sha1(const unsigned char *new, const char *base,
193 struct diff_options *opt);
194
195struct combine_diff_path {
196 struct combine_diff_path *next;
197 int len;
198 char *path;
199 unsigned int mode;
200 unsigned char sha1[20];
201 struct combine_diff_parent {
202 char status;
203 unsigned int mode;
204 unsigned char sha1[20];
205 } parent[FLEX_ARRAY];
206};
207#define combine_diff_path_size(n, l) \
208 (sizeof(struct combine_diff_path) + \
209 sizeof(struct combine_diff_parent) * (n) + (l) + 1)
210
211extern void show_combined_diff(struct combine_diff_path *elem, int num_parent,
212 int dense, struct rev_info *);
213
214extern void diff_tree_combined(const unsigned char *sha1, const struct sha1_array *parents, int dense, struct rev_info *rev);
215
216extern void diff_tree_combined_merge(const struct commit *commit, int dense, struct rev_info *rev);
217
218void diff_set_mnemonic_prefix(struct diff_options *options, const char *a, const char *b);
219
220extern int diff_can_quit_early(struct diff_options *);
221
222extern void diff_addremove(struct diff_options *,
223 int addremove,
224 unsigned mode,
225 const unsigned char *sha1,
226 int sha1_valid,
227 const char *fullpath, unsigned dirty_submodule);
228
229extern void diff_change(struct diff_options *,
230 unsigned mode1, unsigned mode2,
231 const unsigned char *sha1,
232 const unsigned char *sha2,
233 int sha1_valid,
234 int sha2_valid,
235 const char *fullpath,
236 unsigned dirty_submodule1, unsigned dirty_submodule2);
237
238extern struct diff_filepair *diff_unmerge(struct diff_options *, const char *path);
239
240#define DIFF_SETUP_REVERSE 1
241#define DIFF_SETUP_USE_CACHE 2
242#define DIFF_SETUP_USE_SIZE_CACHE 4
243
244/*
245 * Poor man's alternative to parse-option, to allow both sticked form
246 * (--option=value) and separate form (--option value).
247 */
248extern int parse_long_opt(const char *opt, const char **argv,
249 const char **optarg);
250
251extern int git_diff_basic_config(const char *var, const char *value, void *cb);
252extern int git_diff_ui_config(const char *var, const char *value, void *cb);
253extern void diff_setup(struct diff_options *);
254extern int diff_opt_parse(struct diff_options *, const char **, int);
255extern void diff_setup_done(struct diff_options *);
256
257#define DIFF_DETECT_RENAME 1
258#define DIFF_DETECT_COPY 2
259
260#define DIFF_PICKAXE_ALL 1
261#define DIFF_PICKAXE_REGEX 2
262
263#define DIFF_PICKAXE_KIND_S 4 /* traditional plumbing counter */
264#define DIFF_PICKAXE_KIND_G 8 /* grep in the patch */
265
266extern void diffcore_std(struct diff_options *);
267extern void diffcore_fix_diff_index(struct diff_options *);
268
269#define COMMON_DIFF_OPTIONS_HELP \
270"\ncommon diff options:\n" \
271" -z output diff-raw with lines terminated with NUL.\n" \
272" -p output patch format.\n" \
273" -u synonym for -p.\n" \
274" --patch-with-raw\n" \
275" output both a patch and the diff-raw format.\n" \
276" --stat show diffstat instead of patch.\n" \
277" --numstat show numeric diffstat instead of patch.\n" \
278" --patch-with-stat\n" \
279" output a patch and prepend its diffstat.\n" \
280" --name-only show only names of changed files.\n" \
281" --name-status show names and status of changed files.\n" \
282" --full-index show full object name on index lines.\n" \
283" --abbrev=<n> abbreviate object names in diff-tree header and diff-raw.\n" \
284" -R swap input file pairs.\n" \
285" -B detect complete rewrites.\n" \
286" -M detect renames.\n" \
287" -C detect copies.\n" \
288" --find-copies-harder\n" \
289" try unchanged files as candidate for copy detection.\n" \
290" -l<n> limit rename attempts up to <n> paths.\n" \
291" -O<file> reorder diffs according to the <file>.\n" \
292" -S<string> find filepair whose only one side contains the string.\n" \
293" --pickaxe-all\n" \
294" show all files diff when -S is used and hit is found.\n" \
295" -a --text treat all files as text.\n"
296
297extern int diff_queue_is_empty(void);
298extern void diff_flush(struct diff_options*);
299extern void diff_warn_rename_limit(const char *varname, int needed, int degraded_cc);
300
301/* diff-raw status letters */
302#define DIFF_STATUS_ADDED 'A'
303#define DIFF_STATUS_COPIED 'C'
304#define DIFF_STATUS_DELETED 'D'
305#define DIFF_STATUS_MODIFIED 'M'
306#define DIFF_STATUS_RENAMED 'R'
307#define DIFF_STATUS_TYPE_CHANGED 'T'
308#define DIFF_STATUS_UNKNOWN 'X'
309#define DIFF_STATUS_UNMERGED 'U'
310
311/* these are not diff-raw status letters proper, but used by
312 * diffcore-filter insn to specify additional restrictions.
313 */
314#define DIFF_STATUS_FILTER_AON '*'
315#define DIFF_STATUS_FILTER_BROKEN 'B'
316
317extern const char *diff_unique_abbrev(const unsigned char *, int);
318
319/* do not report anything on removed paths */
320#define DIFF_SILENT_ON_REMOVED 01
321/* report racily-clean paths as modified */
322#define DIFF_RACY_IS_MODIFIED 02
323extern int run_diff_files(struct rev_info *revs, unsigned int option);
324extern int run_diff_index(struct rev_info *revs, int cached);
325
326extern int do_diff_cache(const unsigned char *, struct diff_options *);
327extern int diff_flush_patch_id(struct diff_options *, unsigned char *);
328
329extern int diff_result_code(struct diff_options *, int);
330
331extern void diff_no_index(struct rev_info *, int, const char **, int, const char *);
332
333extern int index_differs_from(const char *def, int diff_flags);
334
335extern size_t fill_textconv(struct userdiff_driver *driver,
336 struct diff_filespec *df,
337 char **outbuf);
338
339extern struct userdiff_driver *get_textconv(struct diff_filespec *one);
340
341extern int parse_rename_score(const char **cp_p);
342
343extern long parse_algorithm_value(const char *value);
344
345extern int print_stat_summary(FILE *fp, int files,
346 int insertions, int deletions);
347extern void setup_diff_pager(struct diff_options *);
348
349#endif /* DIFF_H */