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