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"
9#include "object.h"
10struct rev_info;
12struct diff_options;
13struct diff_queue_struct;
14struct strbuf;
15struct diff_filespec;
16struct userdiff_driver;
17struct sha1_array;
18struct commit;
19struct combine_diff_path;
20typedef int (*pathchange_fn_t)(struct diff_options *options,
22 struct combine_diff_path *path);
23typedef void (*change_fn_t)(struct diff_options *options,
25 unsigned old_mode, unsigned new_mode,
26 const unsigned char *old_sha1,
27 const unsigned char *new_sha1,
28 int old_sha1_valid, int new_sha1_valid,
29 const char *fullpath,
30 unsigned old_dirty_submodule, unsigned new_dirty_submodule);
31typedef void (*add_remove_fn_t)(struct diff_options *options,
33 int addremove, unsigned mode,
34 const unsigned char *sha1,
35 int sha1_valid,
36 const char *fullpath, unsigned dirty_submodule);
37typedef void (*diff_format_fn_t)(struct diff_queue_struct *q,
39 struct diff_options *options, void *data);
40typedef struct strbuf *(*diff_prefix_fn_t)(struct diff_options *opt, void *data);
42#define DIFF_FORMAT_RAW 0x0001
44#define DIFF_FORMAT_DIFFSTAT 0x0002
45#define DIFF_FORMAT_NUMSTAT 0x0004
46#define DIFF_FORMAT_SUMMARY 0x0008
47#define DIFF_FORMAT_PATCH 0x0010
48#define DIFF_FORMAT_SHORTSTAT 0x0020
49#define DIFF_FORMAT_DIRSTAT 0x0040
50/* These override all above */
52#define DIFF_FORMAT_NAME 0x0100
53#define DIFF_FORMAT_NAME_STATUS 0x0200
54#define DIFF_FORMAT_CHECKDIFF 0x0400
55/* Same as output_format = 0 but we know that -s flag was given
57 * and we should not give default value to output_format.
58 */
59#define DIFF_FORMAT_NO_OUTPUT 0x0800
60#define DIFF_FORMAT_CALLBACK 0x1000
62#define DIFF_OPT_RECURSIVE (1 << 0)
64#define DIFF_OPT_TREE_IN_RECURSIVE (1 << 1)
65#define DIFF_OPT_BINARY (1 << 2)
66#define DIFF_OPT_TEXT (1 << 3)
67#define DIFF_OPT_FULL_INDEX (1 << 4)
68#define DIFF_OPT_SILENT_ON_REMOVE (1 << 5)
69#define DIFF_OPT_FIND_COPIES_HARDER (1 << 6)
70#define DIFF_OPT_FOLLOW_RENAMES (1 << 7)
71#define DIFF_OPT_RENAME_EMPTY (1 << 8)
72/* (1 << 9) unused */
73#define DIFF_OPT_HAS_CHANGES (1 << 10)
74#define DIFF_OPT_QUICK (1 << 11)
75#define DIFF_OPT_NO_INDEX (1 << 12)
76#define DIFF_OPT_ALLOW_EXTERNAL (1 << 13)
77#define DIFF_OPT_EXIT_WITH_STATUS (1 << 14)
78#define DIFF_OPT_REVERSE_DIFF (1 << 15)
79#define DIFF_OPT_CHECK_FAILED (1 << 16)
80#define DIFF_OPT_RELATIVE_NAME (1 << 17)
81#define DIFF_OPT_IGNORE_SUBMODULES (1 << 18)
82#define DIFF_OPT_DIRSTAT_CUMULATIVE (1 << 19)
83#define DIFF_OPT_DIRSTAT_BY_FILE (1 << 20)
84#define DIFF_OPT_ALLOW_TEXTCONV (1 << 21)
85#define DIFF_OPT_DIFF_FROM_CONTENTS (1 << 22)
86#define DIFF_OPT_SUBMODULE_LOG (1 << 23)
87#define DIFF_OPT_DIRTY_SUBMODULES (1 << 24)
88#define DIFF_OPT_IGNORE_UNTRACKED_IN_SUBMODULES (1 << 25)
89#define DIFF_OPT_IGNORE_DIRTY_SUBMODULES (1 << 26)
90#define DIFF_OPT_OVERRIDE_SUBMODULE_CONFIG (1 << 27)
91#define DIFF_OPT_DIRSTAT_BY_LINE (1 << 28)
92#define DIFF_OPT_FUNCCONTEXT (1 << 29)
93#define DIFF_OPT_PICKAXE_IGNORE_CASE (1 << 30)
94#define DIFF_OPT_DEFAULT_FOLLOW_RENAMES (1U << 31)
95#define DIFF_OPT_TST(opts, flag) ((opts)->flags & DIFF_OPT_##flag)
97#define DIFF_OPT_TOUCHED(opts, flag) ((opts)->touched_flags & DIFF_OPT_##flag)
98#define DIFF_OPT_SET(opts, flag) (((opts)->flags |= DIFF_OPT_##flag),((opts)->touched_flags |= DIFF_OPT_##flag))
99#define DIFF_OPT_CLR(opts, flag) (((opts)->flags &= ~DIFF_OPT_##flag),((opts)->touched_flags |= DIFF_OPT_##flag))
100#define DIFF_XDL_TST(opts, flag) ((opts)->xdl_opts & XDF_##flag)
101#define DIFF_XDL_SET(opts, flag) ((opts)->xdl_opts |= XDF_##flag)
102#define DIFF_XDL_CLR(opts, flag) ((opts)->xdl_opts &= ~XDF_##flag)
103#define DIFF_WITH_ALG(opts, flag) (((opts)->xdl_opts & ~XDF_DIFF_ALGORITHM_MASK) | XDF_##flag)
105enum diff_words_type {
107 DIFF_WORDS_NONE = 0,
108 DIFF_WORDS_PORCELAIN,
109 DIFF_WORDS_PLAIN,
110 DIFF_WORDS_COLOR
111};
112struct diff_options {
114 const char *orderfile;
115 const char *pickaxe;
116 const char *single_follow;
117 const char *a_prefix, *b_prefix;
118 unsigned flags;
119 unsigned touched_flags;
120 /* diff-filter bits */
122 unsigned int filter;
123 int use_color;
125 int context;
126 int interhunkcontext;
127 int break_opt;
128 int detect_rename;
129 int irreversible_delete;
130 int skip_stat_unmatch;
131 int line_termination;
132 int output_format;
133 int pickaxe_opts;
134 int rename_score;
135 int rename_limit;
136 int needed_rename_limit;
137 int degraded_cc_to_c;
138 int show_rename_progress;
139 int dirstat_permille;
140 int setup;
141 int abbrev;
142/* white-space error highlighting */
143#define WSEH_NEW 1
144#define WSEH_CONTEXT 2
145#define WSEH_OLD 4
146 unsigned ws_error_highlight;
147 const char *prefix;
148 int prefix_length;
149 const char *stat_sep;
150 long xdl_opts;
151 int stat_width;
153 int stat_name_width;
154 int stat_graph_width;
155 int stat_count;
156 const char *word_regex;
157 enum diff_words_type word_diff;
158 /* this is set by diffcore for DIFF_FORMAT_PATCH */
160 int found_changes;
161 /* to support internal diff recursion by --follow hack*/
163 int found_follow;
164 void (*set_default)(struct diff_options *);
166 FILE *file;
168 int close_file;
169 struct pathspec pathspec;
171 pathchange_fn_t pathchange;
172 change_fn_t change;
173 add_remove_fn_t add_remove;
174 diff_format_fn_t format_callback;
175 void *format_callback_data;
176 diff_prefix_fn_t output_prefix;
177 int output_prefix_length;
178 void *output_prefix_data;
179 int diff_path_counter;
181};
182enum color_diff {
184 DIFF_RESET = 0,
185 DIFF_CONTEXT = 1,
186 DIFF_METAINFO = 2,
187 DIFF_FRAGINFO = 3,
188 DIFF_FILE_OLD = 4,
189 DIFF_FILE_NEW = 5,
190 DIFF_COMMIT = 6,
191 DIFF_WHITESPACE = 7,
192 DIFF_FUNCINFO = 8
193};
194const char *diff_get_color(int diff_use_color, enum color_diff ix);
195#define diff_get_color_opt(o, ix) \
196 diff_get_color((o)->use_color, ix)
197const char *diff_line_prefix(struct diff_options *);
200extern const char mime_boundary_leader[];
203extern struct combine_diff_path *diff_tree_paths(
205 struct combine_diff_path *p, const unsigned char *sha1,
206 const unsigned char **parent_sha1, int nparent,
207 struct strbuf *base, struct diff_options *opt);
208extern int diff_tree_sha1(const unsigned char *old, const unsigned char *new,
209 const char *base, struct diff_options *opt);
210extern int diff_root_tree_sha1(const unsigned char *new, const char *base,
211 struct diff_options *opt);
212struct combine_diff_path {
214 struct combine_diff_path *next;
215 char *path;
216 unsigned int mode;
217 struct object_id oid;
218 struct combine_diff_parent {
219 char status;
220 unsigned int mode;
221 struct object_id oid;
222 } parent[FLEX_ARRAY];
223};
224#define combine_diff_path_size(n, l) \
225 st_add4(sizeof(struct combine_diff_path), (l), 1, \
226 st_mult(sizeof(struct combine_diff_parent), (n)))
227extern void show_combined_diff(struct combine_diff_path *elem, int num_parent,
229 int dense, struct rev_info *);
230extern void diff_tree_combined(const unsigned char *sha1, const struct sha1_array *parents, int dense, struct rev_info *rev);
232extern void diff_tree_combined_merge(const struct commit *commit, int dense, struct rev_info *rev);
234void diff_set_mnemonic_prefix(struct diff_options *options, const char *a, const char *b);
236extern int diff_can_quit_early(struct diff_options *);
238extern void diff_addremove(struct diff_options *,
240 int addremove,
241 unsigned mode,
242 const unsigned char *sha1,
243 int sha1_valid,
244 const char *fullpath, unsigned dirty_submodule);
245extern void diff_change(struct diff_options *,
247 unsigned mode1, unsigned mode2,
248 const unsigned char *sha1,
249 const unsigned char *sha2,
250 int sha1_valid,
251 int sha2_valid,
252 const char *fullpath,
253 unsigned dirty_submodule1, unsigned dirty_submodule2);
254extern struct diff_filepair *diff_unmerge(struct diff_options *, const char *path);
256#define DIFF_SETUP_REVERSE 1
258#define DIFF_SETUP_USE_CACHE 2
259#define DIFF_SETUP_USE_SIZE_CACHE 4
260/*
262 * Poor man's alternative to parse-option, to allow both stuck form
263 * (--option=value) and separate form (--option value).
264 */
265extern int parse_long_opt(const char *opt, const char **argv,
266 const char **optarg);
267extern int git_diff_basic_config(const char *var, const char *value, void *cb);
269extern int git_diff_ui_config(const char *var, const char *value, void *cb);
270extern void diff_setup(struct diff_options *);
271extern int diff_opt_parse(struct diff_options *, const char **, int, const char *);
272extern void diff_setup_done(struct diff_options *);
273#define DIFF_DETECT_RENAME 1
275#define DIFF_DETECT_COPY 2
276#define DIFF_PICKAXE_ALL 1
278#define DIFF_PICKAXE_REGEX 2
279#define DIFF_PICKAXE_KIND_S 4 /* traditional plumbing counter */
281#define DIFF_PICKAXE_KIND_G 8 /* grep in the patch */
282extern void diffcore_std(struct diff_options *);
284extern void diffcore_fix_diff_index(struct diff_options *);
285#define COMMON_DIFF_OPTIONS_HELP \
287"\ncommon diff options:\n" \
288" -z output diff-raw with lines terminated with NUL.\n" \
289" -p output patch format.\n" \
290" -u synonym for -p.\n" \
291" --patch-with-raw\n" \
292" output both a patch and the diff-raw format.\n" \
293" --stat show diffstat instead of patch.\n" \
294" --numstat show numeric diffstat instead of patch.\n" \
295" --patch-with-stat\n" \
296" output a patch and prepend its diffstat.\n" \
297" --name-only show only names of changed files.\n" \
298" --name-status show names and status of changed files.\n" \
299" --full-index show full object name on index lines.\n" \
300" --abbrev=<n> abbreviate object names in diff-tree header and diff-raw.\n" \
301" -R swap input file pairs.\n" \
302" -B detect complete rewrites.\n" \
303" -M detect renames.\n" \
304" -C detect copies.\n" \
305" --find-copies-harder\n" \
306" try unchanged files as candidate for copy detection.\n" \
307" -l<n> limit rename attempts up to <n> paths.\n" \
308" -O<file> reorder diffs according to the <file>.\n" \
309" -S<string> find filepair whose only one side contains the string.\n" \
310" --pickaxe-all\n" \
311" show all files diff when -S is used and hit is found.\n" \
312" -a --text treat all files as text.\n"
313extern int diff_queue_is_empty(void);
315extern void diff_flush(struct diff_options*);
316extern void diff_warn_rename_limit(const char *varname, int needed, int degraded_cc);
317/* diff-raw status letters */
319#define DIFF_STATUS_ADDED 'A'
320#define DIFF_STATUS_COPIED 'C'
321#define DIFF_STATUS_DELETED 'D'
322#define DIFF_STATUS_MODIFIED 'M'
323#define DIFF_STATUS_RENAMED 'R'
324#define DIFF_STATUS_TYPE_CHANGED 'T'
325#define DIFF_STATUS_UNKNOWN 'X'
326#define DIFF_STATUS_UNMERGED 'U'
327/* these are not diff-raw status letters proper, but used by
329 * diffcore-filter insn to specify additional restrictions.
330 */
331#define DIFF_STATUS_FILTER_AON '*'
332#define DIFF_STATUS_FILTER_BROKEN 'B'
333extern const char *diff_unique_abbrev(const unsigned char *, int);
335/* do not report anything on removed paths */
337#define DIFF_SILENT_ON_REMOVED 01
338/* report racily-clean paths as modified */
339#define DIFF_RACY_IS_MODIFIED 02
340extern int run_diff_files(struct rev_info *revs, unsigned int option);
341extern int run_diff_index(struct rev_info *revs, int cached);
342extern int do_diff_cache(const unsigned char *, struct diff_options *);
344extern int diff_flush_patch_id(struct diff_options *, unsigned char *);
345extern int diff_result_code(struct diff_options *, int);
347extern void diff_no_index(struct rev_info *, int, const char **);
349extern int index_differs_from(const char *def, int diff_flags);
351/*
353 * Fill the contents of the filespec "df", respecting any textconv defined by
354 * its userdiff driver. The "driver" parameter must come from a
355 * previous call to get_textconv(), and therefore should either be NULL or have
356 * textconv enabled.
357 *
358 * Note that the memory ownership of the resulting buffer depends on whether
359 * the driver field is NULL. If it is, then the memory belongs to the filespec
360 * struct. If it is non-NULL, then "outbuf" points to a newly allocated buffer
361 * that should be freed by the caller.
362 */
363extern size_t fill_textconv(struct userdiff_driver *driver,
364 struct diff_filespec *df,
365 char **outbuf);
366/*
368 * Look up the userdiff driver for the given filespec, and return it if
369 * and only if it has textconv enabled (otherwise return NULL). The result
370 * can be passed to fill_textconv().
371 */
372extern struct userdiff_driver *get_textconv(struct diff_filespec *one);
373extern int parse_rename_score(const char **cp_p);
375extern long parse_algorithm_value(const char *value);
377extern int print_stat_summary(FILE *fp, int files,
379 int insertions, int deletions);
380extern void setup_diff_pager(struct diff_options *);
381#endif /* DIFF_H */