2 * Copyright (C) 2005 Junio C Hamano
14 struct diff_queue_struct
;
17 struct userdiff_driver
;
20 struct combine_diff_path
;
23 typedef int (*pathchange_fn_t
)(struct diff_options
*options
,
24 struct combine_diff_path
*path
);
26 typedef void (*change_fn_t
)(struct diff_options
*options
,
27 unsigned old_mode
, unsigned new_mode
,
28 const struct object_id
*old_oid
,
29 const struct object_id
*new_oid
,
30 int old_oid_valid
, int new_oid_valid
,
32 unsigned old_dirty_submodule
, unsigned new_dirty_submodule
);
34 typedef void (*add_remove_fn_t
)(struct diff_options
*options
,
35 int addremove
, unsigned mode
,
36 const struct object_id
*oid
,
38 const char *fullpath
, unsigned dirty_submodule
);
40 typedef void (*diff_format_fn_t
)(struct diff_queue_struct
*q
,
41 struct diff_options
*options
, void *data
);
43 typedef struct strbuf
*(*diff_prefix_fn_t
)(struct diff_options
*opt
, void *data
);
45 #define DIFF_FORMAT_RAW 0x0001
46 #define DIFF_FORMAT_DIFFSTAT 0x0002
47 #define DIFF_FORMAT_NUMSTAT 0x0004
48 #define DIFF_FORMAT_SUMMARY 0x0008
49 #define DIFF_FORMAT_PATCH 0x0010
50 #define DIFF_FORMAT_SHORTSTAT 0x0020
51 #define DIFF_FORMAT_DIRSTAT 0x0040
53 /* These override all above */
54 #define DIFF_FORMAT_NAME 0x0100
55 #define DIFF_FORMAT_NAME_STATUS 0x0200
56 #define DIFF_FORMAT_CHECKDIFF 0x0400
58 /* Same as output_format = 0 but we know that -s flag was given
59 * and we should not give default value to output_format.
61 #define DIFF_FORMAT_NO_OUTPUT 0x0800
63 #define DIFF_FORMAT_CALLBACK 0x1000
65 #define DIFF_FLAGS_INIT { 0 }
68 unsigned tree_in_recursive
:1;
71 unsigned full_index
:1;
72 unsigned silent_on_remove
:1;
73 unsigned find_copies_harder
:1;
74 unsigned follow_renames
:1;
75 unsigned rename_empty
:1;
76 unsigned has_changes
:1;
79 unsigned allow_external
:1;
80 unsigned exit_with_status
:1;
81 unsigned reverse_diff
:1;
82 unsigned check_failed
:1;
83 unsigned relative_name
:1;
84 unsigned ignore_submodules
:1;
85 unsigned dirstat_cumulative
:1;
86 unsigned dirstat_by_file
:1;
87 unsigned allow_textconv
:1;
88 unsigned textconv_set_via_cmdline
:1;
89 unsigned diff_from_contents
:1;
90 unsigned dirty_submodules
:1;
91 unsigned ignore_untracked_in_submodules
:1;
92 unsigned ignore_dirty_submodules
:1;
93 unsigned override_submodule_config
:1;
94 unsigned dirstat_by_line
:1;
95 unsigned funccontext
:1;
96 unsigned default_follow_renames
:1;
97 unsigned stat_with_summary
:1;
98 unsigned suppress_diff_headers
:1;
99 unsigned dual_color_diffed_diffs
:1;
102 static inline void diff_flags_or(struct diff_flags
*a
,
103 const struct diff_flags
*b
)
105 char *tmp_a
= (char *)a
;
106 const char *tmp_b
= (const char *)b
;
109 for (i
= 0; i
< sizeof(struct diff_flags
); i
++)
110 tmp_a
[i
] |= tmp_b
[i
];
113 #define DIFF_XDL_TST(opts, flag) ((opts)->xdl_opts & XDF_##flag)
114 #define DIFF_XDL_SET(opts, flag) ((opts)->xdl_opts |= XDF_##flag)
115 #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)
119 enum diff_words_type
{
121 DIFF_WORDS_PORCELAIN
,
126 enum diff_submodule_format
{
127 DIFF_SUBMODULE_SHORT
= 0,
129 DIFF_SUBMODULE_INLINE_DIFF
132 struct diff_options
{
133 const char *orderfile
;
135 const char *single_follow
;
136 const char *a_prefix
, *b_prefix
;
137 const char *line_prefix
;
138 size_t line_prefix_length
;
139 struct diff_flags flags
;
141 /* diff-filter bits */
146 int interhunkcontext
;
149 int irreversible_delete
;
150 int skip_stat_unmatch
;
151 int line_termination
;
153 unsigned pickaxe_opts
;
156 int needed_rename_limit
;
157 int degraded_cc_to_c
;
158 int show_rename_progress
;
159 int dirstat_permille
;
162 int ita_invisible_in_index
;
163 /* white-space error highlighting */
164 #define WSEH_NEW (1<<12)
165 #define WSEH_CONTEXT (1<<13)
166 #define WSEH_OLD (1<<14)
167 unsigned ws_error_highlight
;
170 const char *stat_sep
;
173 /* see Documentation/diff-options.txt */
175 size_t anchors_nr
, anchors_alloc
;
179 int stat_graph_width
;
181 const char *word_regex
;
182 enum diff_words_type word_diff
;
183 enum diff_submodule_format submodule_format
;
185 struct oidset
*objfind
;
187 /* this is set by diffcore for DIFF_FORMAT_PATCH */
190 /* to support internal diff recursion by --follow hack*/
193 void (*set_default
)(struct diff_options
*);
198 struct pathspec pathspec
;
199 pathchange_fn_t pathchange
;
201 add_remove_fn_t add_remove
;
202 void *change_fn_data
;
203 diff_format_fn_t format_callback
;
204 void *format_callback_data
;
205 diff_prefix_fn_t output_prefix
;
206 void *output_prefix_data
;
208 int diff_path_counter
;
210 struct emitted_diff_symbols
*emitted_symbols
;
213 COLOR_MOVED_PLAIN
= 1,
214 COLOR_MOVED_BLOCKS
= 2,
215 COLOR_MOVED_ZEBRA
= 3,
216 COLOR_MOVED_ZEBRA_DIM
= 4,
218 #define COLOR_MOVED_DEFAULT COLOR_MOVED_ZEBRA
219 #define COLOR_MOVED_MIN_ALNUM_COUNT 20
221 /* XDF_WHITESPACE_FLAGS regarding block detection are set at 2, 3, 4 */
222 #define COLOR_MOVED_WS_ALLOW_INDENTATION_CHANGE (1<<5)
223 int color_moved_ws_handling
;
225 struct repository
*repo
;
228 void diff_emit_submodule_del(struct diff_options
*o
, const char *line
);
229 void diff_emit_submodule_add(struct diff_options
*o
, const char *line
);
230 void diff_emit_submodule_untracked(struct diff_options
*o
, const char *path
);
231 void diff_emit_submodule_modified(struct diff_options
*o
, const char *path
);
232 void diff_emit_submodule_header(struct diff_options
*o
, const char *header
);
233 void diff_emit_submodule_error(struct diff_options
*o
, const char *err
);
234 void diff_emit_submodule_pipethrough(struct diff_options
*o
,
235 const char *line
, int len
);
247 DIFF_FILE_OLD_MOVED
= 9,
248 DIFF_FILE_OLD_MOVED_ALT
= 10,
249 DIFF_FILE_OLD_MOVED_DIM
= 11,
250 DIFF_FILE_OLD_MOVED_ALT_DIM
= 12,
251 DIFF_FILE_NEW_MOVED
= 13,
252 DIFF_FILE_NEW_MOVED_ALT
= 14,
253 DIFF_FILE_NEW_MOVED_DIM
= 15,
254 DIFF_FILE_NEW_MOVED_ALT_DIM
= 16,
255 DIFF_CONTEXT_DIM
= 17,
256 DIFF_FILE_OLD_DIM
= 18,
257 DIFF_FILE_NEW_DIM
= 19,
258 DIFF_CONTEXT_BOLD
= 20,
259 DIFF_FILE_OLD_BOLD
= 21,
260 DIFF_FILE_NEW_BOLD
= 22,
262 const char *diff_get_color(int diff_use_color
, enum color_diff ix
);
263 #define diff_get_color_opt(o, ix) \
264 diff_get_color((o)->use_color, ix)
267 const char *diff_line_prefix(struct diff_options
*);
270 extern const char mime_boundary_leader
[];
272 struct combine_diff_path
*diff_tree_paths(
273 struct combine_diff_path
*p
, const struct object_id
*oid
,
274 const struct object_id
**parents_oid
, int nparent
,
275 struct strbuf
*base
, struct diff_options
*opt
);
276 int diff_tree_oid(const struct object_id
*old_oid
,
277 const struct object_id
*new_oid
,
278 const char *base
, struct diff_options
*opt
);
279 int diff_root_tree_oid(const struct object_id
*new_oid
, const char *base
,
280 struct diff_options
*opt
);
282 struct combine_diff_path
{
283 struct combine_diff_path
*next
;
286 struct object_id oid
;
287 struct combine_diff_parent
{
290 struct object_id oid
;
291 } parent
[FLEX_ARRAY
];
293 #define combine_diff_path_size(n, l) \
294 st_add4(sizeof(struct combine_diff_path), (l), 1, \
295 st_mult(sizeof(struct combine_diff_parent), (n)))
297 void show_combined_diff(struct combine_diff_path
*elem
, int num_parent
,
298 int dense
, struct rev_info
*);
300 void diff_tree_combined(const struct object_id
*oid
, const struct oid_array
*parents
, int dense
, struct rev_info
*rev
);
302 void diff_tree_combined_merge(const struct commit
*commit
, int dense
, struct rev_info
*rev
);
304 void diff_set_mnemonic_prefix(struct diff_options
*options
, const char *a
, const char *b
);
306 int diff_can_quit_early(struct diff_options
*);
308 void diff_addremove(struct diff_options
*,
311 const struct object_id
*oid
,
313 const char *fullpath
, unsigned dirty_submodule
);
315 void diff_change(struct diff_options
*,
316 unsigned mode1
, unsigned mode2
,
317 const struct object_id
*old_oid
,
318 const struct object_id
*new_oid
,
319 int old_oid_valid
, int new_oid_valid
,
320 const char *fullpath
,
321 unsigned dirty_submodule1
, unsigned dirty_submodule2
);
323 struct diff_filepair
*diff_unmerge(struct diff_options
*, const char *path
);
325 #define DIFF_SETUP_REVERSE 1
326 #define DIFF_SETUP_USE_SIZE_CACHE 4
329 * Poor man's alternative to parse-option, to allow both stuck form
330 * (--option=value) and separate form (--option value).
332 int parse_long_opt(const char *opt
, const char **argv
,
333 const char **optarg
);
335 int git_diff_basic_config(const char *var
, const char *value
, void *cb
);
336 int git_diff_heuristic_config(const char *var
, const char *value
, void *cb
);
337 void init_diff_ui_defaults(void);
338 int git_diff_ui_config(const char *var
, const char *value
, void *cb
);
339 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
340 #define diff_setup(diffopts) repo_diff_setup(the_repository, diffopts)
342 void repo_diff_setup(struct repository
*, struct diff_options
*);
343 int diff_opt_parse(struct diff_options
*, const char **, int, const char *);
344 void diff_setup_done(struct diff_options
*);
345 int git_config_rename(const char *var
, const char *value
);
347 #define DIFF_DETECT_RENAME 1
348 #define DIFF_DETECT_COPY 2
350 #define DIFF_PICKAXE_ALL 1
351 #define DIFF_PICKAXE_REGEX 2
353 #define DIFF_PICKAXE_KIND_S 4 /* traditional plumbing counter */
354 #define DIFF_PICKAXE_KIND_G 8 /* grep in the patch */
355 #define DIFF_PICKAXE_KIND_OBJFIND 16 /* specific object IDs */
357 #define DIFF_PICKAXE_KINDS_MASK (DIFF_PICKAXE_KIND_S | \
358 DIFF_PICKAXE_KIND_G | \
359 DIFF_PICKAXE_KIND_OBJFIND)
361 #define DIFF_PICKAXE_IGNORE_CASE 32
363 void diffcore_std(struct diff_options
*);
364 void diffcore_fix_diff_index(struct diff_options
*);
366 #define COMMON_DIFF_OPTIONS_HELP \
367 "\ncommon diff options:\n" \
368 " -z output diff-raw with lines terminated with NUL.\n" \
369 " -p output patch format.\n" \
370 " -u synonym for -p.\n" \
371 " --patch-with-raw\n" \
372 " output both a patch and the diff-raw format.\n" \
373 " --stat show diffstat instead of patch.\n" \
374 " --numstat show numeric diffstat instead of patch.\n" \
375 " --patch-with-stat\n" \
376 " output a patch and prepend its diffstat.\n" \
377 " --name-only show only names of changed files.\n" \
378 " --name-status show names and status of changed files.\n" \
379 " --full-index show full object name on index lines.\n" \
380 " --abbrev=<n> abbreviate object names in diff-tree header and diff-raw.\n" \
381 " -R swap input file pairs.\n" \
382 " -B detect complete rewrites.\n" \
383 " -M detect renames.\n" \
384 " -C detect copies.\n" \
385 " --find-copies-harder\n" \
386 " try unchanged files as candidate for copy detection.\n" \
387 " -l<n> limit rename attempts up to <n> paths.\n" \
388 " -O<file> reorder diffs according to the <file>.\n" \
389 " -S<string> find filepair whose only one side contains the string.\n" \
391 " show all files diff when -S is used and hit is found.\n" \
392 " -a --text treat all files as text.\n"
394 int diff_queue_is_empty(void);
395 void diff_flush(struct diff_options
*);
396 void diff_warn_rename_limit(const char *varname
, int needed
, int degraded_cc
);
398 /* diff-raw status letters */
399 #define DIFF_STATUS_ADDED 'A'
400 #define DIFF_STATUS_COPIED 'C'
401 #define DIFF_STATUS_DELETED 'D'
402 #define DIFF_STATUS_MODIFIED 'M'
403 #define DIFF_STATUS_RENAMED 'R'
404 #define DIFF_STATUS_TYPE_CHANGED 'T'
405 #define DIFF_STATUS_UNKNOWN 'X'
406 #define DIFF_STATUS_UNMERGED 'U'
408 /* these are not diff-raw status letters proper, but used by
409 * diffcore-filter insn to specify additional restrictions.
411 #define DIFF_STATUS_FILTER_AON '*'
412 #define DIFF_STATUS_FILTER_BROKEN 'B'
415 * This is different from find_unique_abbrev() in that
416 * it stuffs the result with dots for alignment.
418 const char *diff_aligned_abbrev(const struct object_id
*sha1
, int);
420 /* do not report anything on removed paths */
421 #define DIFF_SILENT_ON_REMOVED 01
422 /* report racily-clean paths as modified */
423 #define DIFF_RACY_IS_MODIFIED 02
424 int run_diff_files(struct rev_info
*revs
, unsigned int option
);
425 int run_diff_index(struct rev_info
*revs
, int cached
);
427 int do_diff_cache(const struct object_id
*, struct diff_options
*);
428 int diff_flush_patch_id(struct diff_options
*, struct object_id
*, int);
430 int diff_result_code(struct diff_options
*, int);
432 void diff_no_index(struct repository
*, struct rev_info
*, int, const char **);
434 int index_differs_from(const char *def
, const struct diff_flags
*flags
,
435 int ita_invisible_in_index
);
438 * Fill the contents of the filespec "df", respecting any textconv defined by
439 * its userdiff driver. The "driver" parameter must come from a
440 * previous call to get_textconv(), and therefore should either be NULL or have
443 * Note that the memory ownership of the resulting buffer depends on whether
444 * the driver field is NULL. If it is, then the memory belongs to the filespec
445 * struct. If it is non-NULL, then "outbuf" points to a newly allocated buffer
446 * that should be freed by the caller.
448 size_t fill_textconv(struct repository
*r
,
449 struct userdiff_driver
*driver
,
450 struct diff_filespec
*df
,
454 * Look up the userdiff driver for the given filespec, and return it if
455 * and only if it has textconv enabled (otherwise return NULL). The result
456 * can be passed to fill_textconv().
458 struct userdiff_driver
*get_textconv(struct diff_filespec
*one
);
461 * Prepare diff_filespec and convert it using diff textconv API
462 * if the textconv driver exists.
463 * Return 1 if the conversion succeeds, 0 otherwise.
465 int textconv_object(struct repository
*repo
,
468 const struct object_id
*oid
, int oid_valid
,
469 char **buf
, unsigned long *buf_size
);
471 int parse_rename_score(const char **cp_p
);
473 long parse_algorithm_value(const char *value
);
475 void print_stat_summary(FILE *fp
, int files
,
476 int insertions
, int deletions
);
477 void setup_diff_pager(struct diff_options
*);