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"
10#include "oidset.h"
11struct combine_diff_path;
13struct commit;
14struct diff_filespec;
15struct diff_options;
16struct diff_queue_struct;
17struct oid_array;
18struct option;
19struct repository;
20struct rev_info;
21struct strbuf;
22struct userdiff_driver;
23typedef int (*pathchange_fn_t)(struct diff_options *options,
25 struct combine_diff_path *path);
26typedef void (*change_fn_t)(struct diff_options *options,
28 unsigned old_mode, unsigned new_mode,
29 const struct object_id *old_oid,
30 const struct object_id *new_oid,
31 int old_oid_valid, int new_oid_valid,
32 const char *fullpath,
33 unsigned old_dirty_submodule, unsigned new_dirty_submodule);
34typedef void (*add_remove_fn_t)(struct diff_options *options,
36 int addremove, unsigned mode,
37 const struct object_id *oid,
38 int oid_valid,
39 const char *fullpath, unsigned dirty_submodule);
40typedef void (*diff_format_fn_t)(struct diff_queue_struct *q,
42 struct diff_options *options, void *data);
43typedef struct strbuf *(*diff_prefix_fn_t)(struct diff_options *opt, void *data);
45#define DIFF_FORMAT_RAW 0x0001
47#define DIFF_FORMAT_DIFFSTAT 0x0002
48#define DIFF_FORMAT_NUMSTAT 0x0004
49#define DIFF_FORMAT_SUMMARY 0x0008
50#define DIFF_FORMAT_PATCH 0x0010
51#define DIFF_FORMAT_SHORTSTAT 0x0020
52#define DIFF_FORMAT_DIRSTAT 0x0040
53/* These override all above */
55#define DIFF_FORMAT_NAME 0x0100
56#define DIFF_FORMAT_NAME_STATUS 0x0200
57#define DIFF_FORMAT_CHECKDIFF 0x0400
58/* Same as output_format = 0 but we know that -s flag was given
60 * and we should not give default value to output_format.
61 */
62#define DIFF_FORMAT_NO_OUTPUT 0x0800
63#define DIFF_FORMAT_CALLBACK 0x1000
65#define DIFF_FLAGS_INIT { 0 }
67struct diff_flags {
68 unsigned recursive;
69 unsigned tree_in_recursive;
70 unsigned binary;
71 unsigned text;
72 unsigned full_index;
73 unsigned silent_on_remove;
74 unsigned find_copies_harder;
75 unsigned follow_renames;
76 unsigned rename_empty;
77 unsigned has_changes;
78 unsigned quick;
79 unsigned no_index;
80 unsigned allow_external;
81 unsigned exit_with_status;
82 unsigned reverse_diff;
83 unsigned check_failed;
84 unsigned relative_name;
85 unsigned ignore_submodules;
86 unsigned dirstat_cumulative;
87 unsigned dirstat_by_file;
88 unsigned allow_textconv;
89 unsigned textconv_set_via_cmdline;
90 unsigned diff_from_contents;
91 unsigned dirty_submodules;
92 unsigned ignore_untracked_in_submodules;
93 unsigned ignore_dirty_submodules;
94 unsigned override_submodule_config;
95 unsigned dirstat_by_line;
96 unsigned funccontext;
97 unsigned default_follow_renames;
98 unsigned stat_with_summary;
99 unsigned suppress_diff_headers;
100 unsigned dual_color_diffed_diffs;
101};
102static inline void diff_flags_or(struct diff_flags *a,
104 const struct diff_flags *b)
105{
106 char *tmp_a = (char *)a;
107 const char *tmp_b = (const char *)b;
108 int i;
109 for (i = 0; i < sizeof(struct diff_flags); i++)
111 tmp_a[i] |= tmp_b[i];
112}
113#define DIFF_XDL_TST(opts, flag) ((opts)->xdl_opts & XDF_##flag)
115#define DIFF_XDL_SET(opts, flag) ((opts)->xdl_opts |= XDF_##flag)
116#define DIFF_XDL_CLR(opts, flag) ((opts)->xdl_opts &= ~XDF_##flag)
117#define DIFF_WITH_ALG(opts, flag) (((opts)->xdl_opts & ~XDF_DIFF_ALGORITHM_MASK) | XDF_##flag)
119enum diff_words_type {
121 DIFF_WORDS_NONE = 0,
122 DIFF_WORDS_PORCELAIN,
123 DIFF_WORDS_PLAIN,
124 DIFF_WORDS_COLOR
125};
126enum diff_submodule_format {
128 DIFF_SUBMODULE_SHORT = 0,
129 DIFF_SUBMODULE_LOG,
130 DIFF_SUBMODULE_INLINE_DIFF
131};
132struct diff_options {
134 const char *orderfile;
135 const char *pickaxe;
136 const char *single_follow;
137 const char *a_prefix, *b_prefix;
138 const char *line_prefix;
139 size_t line_prefix_length;
140 struct diff_flags flags;
141 /* diff-filter bits */
143 unsigned int filter;
144 int use_color;
146 int context;
147 int interhunkcontext;
148 int break_opt;
149 int detect_rename;
150 int irreversible_delete;
151 int skip_stat_unmatch;
152 int line_termination;
153 int output_format;
154 unsigned pickaxe_opts;
155 int rename_score;
156 int rename_limit;
157 int needed_rename_limit;
158 int degraded_cc_to_c;
159 int show_rename_progress;
160 int dirstat_permille;
161 int setup;
162 int abbrev;
163 int ita_invisible_in_index;
164/* white-space error highlighting */
165#define WSEH_NEW (1<<12)
166#define WSEH_CONTEXT (1<<13)
167#define WSEH_OLD (1<<14)
168 unsigned ws_error_highlight;
169 const char *prefix;
170 int prefix_length;
171 const char *stat_sep;
172 long xdl_opts;
173 /* see Documentation/diff-options.txt */
175 char **anchors;
176 size_t anchors_nr, anchors_alloc;
177 int stat_width;
179 int stat_name_width;
180 int stat_graph_width;
181 int stat_count;
182 const char *word_regex;
183 enum diff_words_type word_diff;
184 enum diff_submodule_format submodule_format;
185 struct oidset *objfind;
187 /* this is set by diffcore for DIFF_FORMAT_PATCH */
189 int found_changes;
190 /* to support internal diff recursion by --follow hack*/
192 int found_follow;
193 void (*set_default)(struct diff_options *);
195 FILE *file;
197 int close_file;
198#define OUTPUT_INDICATOR_NEW 0
200#define OUTPUT_INDICATOR_OLD 1
201#define OUTPUT_INDICATOR_CONTEXT 2
202 char output_indicators[3];
203 struct pathspec pathspec;
205 pathchange_fn_t pathchange;
206 change_fn_t change;
207 add_remove_fn_t add_remove;
208 void *change_fn_data;
209 diff_format_fn_t format_callback;
210 void *format_callback_data;
211 diff_prefix_fn_t output_prefix;
212 void *output_prefix_data;
213 int diff_path_counter;
215 struct emitted_diff_symbols *emitted_symbols;
217 enum {
218 COLOR_MOVED_NO = 0,
219 COLOR_MOVED_PLAIN = 1,
220 COLOR_MOVED_BLOCKS = 2,
221 COLOR_MOVED_ZEBRA = 3,
222 COLOR_MOVED_ZEBRA_DIM = 4,
223 } color_moved;
224 #define COLOR_MOVED_DEFAULT COLOR_MOVED_ZEBRA
225 #define COLOR_MOVED_MIN_ALNUM_COUNT 20
226 /* XDF_WHITESPACE_FLAGS regarding block detection are set at 2, 3, 4 */
228 #define COLOR_MOVED_WS_ALLOW_INDENTATION_CHANGE (1<<5)
229 #define COLOR_MOVED_WS_ERROR (1<<0)
230 unsigned color_moved_ws_handling;
231 struct repository *repo;
233 struct option *parseopts;
234};
235void diff_emit_submodule_del(struct diff_options *o, const char *line);
237void diff_emit_submodule_add(struct diff_options *o, const char *line);
238void diff_emit_submodule_untracked(struct diff_options *o, const char *path);
239void diff_emit_submodule_modified(struct diff_options *o, const char *path);
240void diff_emit_submodule_header(struct diff_options *o, const char *header);
241void diff_emit_submodule_error(struct diff_options *o, const char *err);
242void diff_emit_submodule_pipethrough(struct diff_options *o,
243 const char *line, int len);
244enum color_diff {
246 DIFF_RESET = 0,
247 DIFF_CONTEXT = 1,
248 DIFF_METAINFO = 2,
249 DIFF_FRAGINFO = 3,
250 DIFF_FILE_OLD = 4,
251 DIFF_FILE_NEW = 5,
252 DIFF_COMMIT = 6,
253 DIFF_WHITESPACE = 7,
254 DIFF_FUNCINFO = 8,
255 DIFF_FILE_OLD_MOVED = 9,
256 DIFF_FILE_OLD_MOVED_ALT = 10,
257 DIFF_FILE_OLD_MOVED_DIM = 11,
258 DIFF_FILE_OLD_MOVED_ALT_DIM = 12,
259 DIFF_FILE_NEW_MOVED = 13,
260 DIFF_FILE_NEW_MOVED_ALT = 14,
261 DIFF_FILE_NEW_MOVED_DIM = 15,
262 DIFF_FILE_NEW_MOVED_ALT_DIM = 16,
263 DIFF_CONTEXT_DIM = 17,
264 DIFF_FILE_OLD_DIM = 18,
265 DIFF_FILE_NEW_DIM = 19,
266 DIFF_CONTEXT_BOLD = 20,
267 DIFF_FILE_OLD_BOLD = 21,
268 DIFF_FILE_NEW_BOLD = 22,
269};
270const char *diff_get_color(int diff_use_color, enum color_diff ix);
271#define diff_get_color_opt(o, ix) \
272 diff_get_color((o)->use_color, ix)
273const char *diff_line_prefix(struct diff_options *);
276extern const char mime_boundary_leader[];
279struct combine_diff_path *diff_tree_paths(
281 struct combine_diff_path *p, const struct object_id *oid,
282 const struct object_id **parents_oid, int nparent,
283 struct strbuf *base, struct diff_options *opt);
284int diff_tree_oid(const struct object_id *old_oid,
285 const struct object_id *new_oid,
286 const char *base, struct diff_options *opt);
287int diff_root_tree_oid(const struct object_id *new_oid, const char *base,
288 struct diff_options *opt);
289struct combine_diff_path {
291 struct combine_diff_path *next;
292 char *path;
293 unsigned int mode;
294 struct object_id oid;
295 struct combine_diff_parent {
296 char status;
297 unsigned int mode;
298 struct object_id oid;
299 struct strbuf path;
300 } parent[FLEX_ARRAY];
301};
302#define combine_diff_path_size(n, l) \
303 st_add4(sizeof(struct combine_diff_path), (l), 1, \
304 st_mult(sizeof(struct combine_diff_parent), (n)))
305void show_combined_diff(struct combine_diff_path *elem, int num_parent,
307 int dense, struct rev_info *);
308void diff_tree_combined(const struct object_id *oid, const struct oid_array *parents, int dense, struct rev_info *rev);
310void diff_tree_combined_merge(const struct commit *commit, int dense, struct rev_info *rev);
312void diff_set_mnemonic_prefix(struct diff_options *options, const char *a, const char *b);
314int diff_can_quit_early(struct diff_options *);
316void diff_addremove(struct diff_options *,
318 int addremove,
319 unsigned mode,
320 const struct object_id *oid,
321 int oid_valid,
322 const char *fullpath, unsigned dirty_submodule);
323void diff_change(struct diff_options *,
325 unsigned mode1, unsigned mode2,
326 const struct object_id *old_oid,
327 const struct object_id *new_oid,
328 int old_oid_valid, int new_oid_valid,
329 const char *fullpath,
330 unsigned dirty_submodule1, unsigned dirty_submodule2);
331struct diff_filepair *diff_unmerge(struct diff_options *, const char *path);
333#define DIFF_SETUP_REVERSE 1
335#define DIFF_SETUP_USE_SIZE_CACHE 4
336/*
338 * Poor man's alternative to parse-option, to allow both stuck form
339 * (--option=value) and separate form (--option value).
340 */
341int parse_long_opt(const char *opt, const char **argv,
342 const char **optarg);
343int git_diff_basic_config(const char *var, const char *value, void *cb);
345int git_diff_heuristic_config(const char *var, const char *value, void *cb);
346void init_diff_ui_defaults(void);
347int git_diff_ui_config(const char *var, const char *value, void *cb);
348#ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
349#define diff_setup(diffopts) repo_diff_setup(the_repository, diffopts)
350#endif
351void repo_diff_setup(struct repository *, struct diff_options *);
352int diff_opt_parse(struct diff_options *, const char **, int, const char *);
353void diff_setup_done(struct diff_options *);
354int git_config_rename(const char *var, const char *value);
355#define DIFF_DETECT_RENAME 1
357#define DIFF_DETECT_COPY 2
358#define DIFF_PICKAXE_ALL 1
360#define DIFF_PICKAXE_REGEX 2
361#define DIFF_PICKAXE_KIND_S 4 /* traditional plumbing counter */
363#define DIFF_PICKAXE_KIND_G 8 /* grep in the patch */
364#define DIFF_PICKAXE_KIND_OBJFIND 16 /* specific object IDs */
365#define DIFF_PICKAXE_KINDS_MASK (DIFF_PICKAXE_KIND_S | \
367 DIFF_PICKAXE_KIND_G | \
368 DIFF_PICKAXE_KIND_OBJFIND)
369#define DIFF_PICKAXE_IGNORE_CASE 32
371void diffcore_std(struct diff_options *);
373void diffcore_fix_diff_index(void);
374#define COMMON_DIFF_OPTIONS_HELP \
376"\ncommon diff options:\n" \
377" -z output diff-raw with lines terminated with NUL.\n" \
378" -p output patch format.\n" \
379" -u synonym for -p.\n" \
380" --patch-with-raw\n" \
381" output both a patch and the diff-raw format.\n" \
382" --stat show diffstat instead of patch.\n" \
383" --numstat show numeric diffstat instead of patch.\n" \
384" --patch-with-stat\n" \
385" output a patch and prepend its diffstat.\n" \
386" --name-only show only names of changed files.\n" \
387" --name-status show names and status of changed files.\n" \
388" --full-index show full object name on index lines.\n" \
389" --abbrev=<n> abbreviate object names in diff-tree header and diff-raw.\n" \
390" -R swap input file pairs.\n" \
391" -B detect complete rewrites.\n" \
392" -M detect renames.\n" \
393" -C detect copies.\n" \
394" --find-copies-harder\n" \
395" try unchanged files as candidate for copy detection.\n" \
396" -l<n> limit rename attempts up to <n> paths.\n" \
397" -O<file> reorder diffs according to the <file>.\n" \
398" -S<string> find filepair whose only one side contains the string.\n" \
399" --pickaxe-all\n" \
400" show all files diff when -S is used and hit is found.\n" \
401" -a --text treat all files as text.\n"
402int diff_queue_is_empty(void);
404void diff_flush(struct diff_options*);
405void diff_warn_rename_limit(const char *varname, int needed, int degraded_cc);
406/* diff-raw status letters */
408#define DIFF_STATUS_ADDED 'A'
409#define DIFF_STATUS_COPIED 'C'
410#define DIFF_STATUS_DELETED 'D'
411#define DIFF_STATUS_MODIFIED 'M'
412#define DIFF_STATUS_RENAMED 'R'
413#define DIFF_STATUS_TYPE_CHANGED 'T'
414#define DIFF_STATUS_UNKNOWN 'X'
415#define DIFF_STATUS_UNMERGED 'U'
416/* these are not diff-raw status letters proper, but used by
418 * diffcore-filter insn to specify additional restrictions.
419 */
420#define DIFF_STATUS_FILTER_AON '*'
421#define DIFF_STATUS_FILTER_BROKEN 'B'
422/*
424 * This is different from find_unique_abbrev() in that
425 * it stuffs the result with dots for alignment.
426 */
427const char *diff_aligned_abbrev(const struct object_id *sha1, int);
428/* do not report anything on removed paths */
430#define DIFF_SILENT_ON_REMOVED 01
431/* report racily-clean paths as modified */
432#define DIFF_RACY_IS_MODIFIED 02
433int run_diff_files(struct rev_info *revs, unsigned int option);
434int run_diff_index(struct rev_info *revs, int cached);
435int do_diff_cache(const struct object_id *, struct diff_options *);
437int diff_flush_patch_id(struct diff_options *, struct object_id *, int);
438int diff_result_code(struct diff_options *, int);
440void diff_no_index(struct rev_info *, int, const char **);
442int index_differs_from(struct repository *r, const char *def,
444 const struct diff_flags *flags,
445 int ita_invisible_in_index);
446/*
448 * Fill the contents of the filespec "df", respecting any textconv defined by
449 * its userdiff driver. The "driver" parameter must come from a
450 * previous call to get_textconv(), and therefore should either be NULL or have
451 * textconv enabled.
452 *
453 * Note that the memory ownership of the resulting buffer depends on whether
454 * the driver field is NULL. If it is, then the memory belongs to the filespec
455 * struct. If it is non-NULL, then "outbuf" points to a newly allocated buffer
456 * that should be freed by the caller.
457 */
458size_t fill_textconv(struct repository *r,
459 struct userdiff_driver *driver,
460 struct diff_filespec *df,
461 char **outbuf);
462/*
464 * Look up the userdiff driver for the given filespec, and return it if
465 * and only if it has textconv enabled (otherwise return NULL). The result
466 * can be passed to fill_textconv().
467 */
468struct userdiff_driver *get_textconv(struct repository *r,
469 struct diff_filespec *one);
470/*
472 * Prepare diff_filespec and convert it using diff textconv API
473 * if the textconv driver exists.
474 * Return 1 if the conversion succeeds, 0 otherwise.
475 */
476int textconv_object(struct repository *repo,
477 const char *path,
478 unsigned mode,
479 const struct object_id *oid, int oid_valid,
480 char **buf, unsigned long *buf_size);
481int parse_rename_score(const char **cp_p);
483long parse_algorithm_value(const char *value);
485void print_stat_summary(FILE *fp, int files,
487 int insertions, int deletions);
488void setup_diff_pager(struct diff_options *);
489#endif /* DIFF_H */