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