2 * Copyright (C) 2005 Junio C Hamano
14 struct diff_queue_struct
;
17 struct userdiff_driver
;
20 struct combine_diff_path
;
22 typedef int (*pathchange_fn_t
)(struct diff_options
*options
,
23 struct combine_diff_path
*path
);
25 typedef void (*change_fn_t
)(struct diff_options
*options
,
26 unsigned old_mode
, unsigned new_mode
,
27 const struct object_id
*old_oid
,
28 const struct object_id
*new_oid
,
29 int old_oid_valid
, int new_oid_valid
,
31 unsigned old_dirty_submodule
, unsigned new_dirty_submodule
);
33 typedef void (*add_remove_fn_t
)(struct diff_options
*options
,
34 int addremove
, unsigned mode
,
35 const struct object_id
*oid
,
37 const char *fullpath
, unsigned dirty_submodule
);
39 typedef void (*diff_format_fn_t
)(struct diff_queue_struct
*q
,
40 struct diff_options
*options
, void *data
);
42 typedef struct strbuf
*(*diff_prefix_fn_t
)(struct diff_options
*opt
, void *data
);
44 #define DIFF_FORMAT_RAW 0x0001
45 #define DIFF_FORMAT_DIFFSTAT 0x0002
46 #define DIFF_FORMAT_NUMSTAT 0x0004
47 #define DIFF_FORMAT_SUMMARY 0x0008
48 #define DIFF_FORMAT_PATCH 0x0010
49 #define DIFF_FORMAT_SHORTSTAT 0x0020
50 #define DIFF_FORMAT_DIRSTAT 0x0040
52 /* These override all above */
53 #define DIFF_FORMAT_NAME 0x0100
54 #define DIFF_FORMAT_NAME_STATUS 0x0200
55 #define DIFF_FORMAT_CHECKDIFF 0x0400
57 /* Same as output_format = 0 but we know that -s flag was given
58 * and we should not give default value to output_format.
60 #define DIFF_FORMAT_NO_OUTPUT 0x0800
62 #define DIFF_FORMAT_CALLBACK 0x1000
64 #define DIFF_FLAGS_INIT { 0 }
67 unsigned tree_in_recursive
:1;
70 unsigned full_index
:1;
71 unsigned silent_on_remove
:1;
72 unsigned find_copies_harder
:1;
73 unsigned follow_renames
:1;
74 unsigned rename_empty
:1;
75 unsigned has_changes
:1;
78 unsigned allow_external
:1;
79 unsigned exit_with_status
:1;
80 unsigned reverse_diff
:1;
81 unsigned check_failed
:1;
82 unsigned relative_name
:1;
83 unsigned ignore_submodules
:1;
84 unsigned dirstat_cumulative
:1;
85 unsigned dirstat_by_file
:1;
86 unsigned allow_textconv
:1;
87 unsigned textconv_set_via_cmdline
:1;
88 unsigned diff_from_contents
:1;
89 unsigned dirty_submodules
:1;
90 unsigned ignore_untracked_in_submodules
:1;
91 unsigned ignore_dirty_submodules
:1;
92 unsigned override_submodule_config
:1;
93 unsigned dirstat_by_line
:1;
94 unsigned funccontext
:1;
95 unsigned default_follow_renames
:1;
96 unsigned stat_with_summary
:1;
97 unsigned suppress_diff_headers
:1;
100 static inline void diff_flags_or(struct diff_flags
*a
,
101 const struct diff_flags
*b
)
103 char *tmp_a
= (char *)a
;
104 const char *tmp_b
= (const char *)b
;
107 for (i
= 0; i
< sizeof(struct diff_flags
); i
++)
108 tmp_a
[i
] |= tmp_b
[i
];
111 #define DIFF_XDL_TST(opts, flag) ((opts)->xdl_opts & XDF_##flag)
112 #define DIFF_XDL_SET(opts, flag) ((opts)->xdl_opts |= XDF_##flag)
113 #define DIFF_XDL_CLR(opts, flag) ((opts)->xdl_opts &= ~XDF_##flag)
115 #define DIFF_WITH_ALG(opts, flag) (((opts)->xdl_opts & ~XDF_DIFF_ALGORITHM_MASK) | XDF_##flag)
117 enum diff_words_type
{
119 DIFF_WORDS_PORCELAIN
,
124 enum diff_submodule_format
{
125 DIFF_SUBMODULE_SHORT
= 0,
127 DIFF_SUBMODULE_INLINE_DIFF
130 struct diff_options
{
131 const char *orderfile
;
133 const char *single_follow
;
134 const char *a_prefix
, *b_prefix
;
135 const char *line_prefix
;
136 size_t line_prefix_length
;
137 struct diff_flags flags
;
139 /* diff-filter bits */
144 int interhunkcontext
;
147 int irreversible_delete
;
148 int skip_stat_unmatch
;
149 int line_termination
;
151 unsigned pickaxe_opts
;
154 int needed_rename_limit
;
155 int degraded_cc_to_c
;
156 int show_rename_progress
;
157 int dirstat_permille
;
160 int ita_invisible_in_index
;
161 /* white-space error highlighting */
162 #define WSEH_NEW (1<<12)
163 #define WSEH_CONTEXT (1<<13)
164 #define WSEH_OLD (1<<14)
165 unsigned ws_error_highlight
;
168 const char *stat_sep
;
171 /* see Documentation/diff-options.txt */
173 size_t anchors_nr
, anchors_alloc
;
177 int stat_graph_width
;
179 const char *word_regex
;
180 enum diff_words_type word_diff
;
181 enum diff_submodule_format submodule_format
;
183 struct oidset
*objfind
;
185 /* this is set by diffcore for DIFF_FORMAT_PATCH */
188 /* to support internal diff recursion by --follow hack*/
191 void (*set_default
)(struct diff_options
*);
196 struct pathspec pathspec
;
197 pathchange_fn_t pathchange
;
199 add_remove_fn_t add_remove
;
200 void *change_fn_data
;
201 diff_format_fn_t format_callback
;
202 void *format_callback_data
;
203 diff_prefix_fn_t output_prefix
;
204 void *output_prefix_data
;
206 int diff_path_counter
;
208 struct emitted_diff_symbols
*emitted_symbols
;
211 COLOR_MOVED_PLAIN
= 1,
212 COLOR_MOVED_BLOCKS
= 2,
213 COLOR_MOVED_ZEBRA
= 3,
214 COLOR_MOVED_ZEBRA_DIM
= 4,
216 #define COLOR_MOVED_DEFAULT COLOR_MOVED_ZEBRA
217 #define COLOR_MOVED_MIN_ALNUM_COUNT 20
219 /* XDF_WHITESPACE_FLAGS regarding block detection are set at 2, 3, 4 */
220 #define COLOR_MOVED_WS_ALLOW_INDENTATION_CHANGE (1<<5)
221 int color_moved_ws_handling
;
224 void diff_emit_submodule_del(struct diff_options
*o
, const char *line
);
225 void diff_emit_submodule_add(struct diff_options
*o
, const char *line
);
226 void diff_emit_submodule_untracked(struct diff_options
*o
, const char *path
);
227 void diff_emit_submodule_modified(struct diff_options
*o
, const char *path
);
228 void diff_emit_submodule_header(struct diff_options
*o
, const char *header
);
229 void diff_emit_submodule_error(struct diff_options
*o
, const char *err
);
230 void diff_emit_submodule_pipethrough(struct diff_options
*o
,
231 const char *line
, int len
);
243 DIFF_FILE_OLD_MOVED
= 9,
244 DIFF_FILE_OLD_MOVED_ALT
= 10,
245 DIFF_FILE_OLD_MOVED_DIM
= 11,
246 DIFF_FILE_OLD_MOVED_ALT_DIM
= 12,
247 DIFF_FILE_NEW_MOVED
= 13,
248 DIFF_FILE_NEW_MOVED_ALT
= 14,
249 DIFF_FILE_NEW_MOVED_DIM
= 15,
250 DIFF_FILE_NEW_MOVED_ALT_DIM
= 16
252 const char *diff_get_color(int diff_use_color
, enum color_diff ix
);
253 #define diff_get_color_opt(o, ix) \
254 diff_get_color((o)->use_color, ix)
257 const char *diff_line_prefix(struct diff_options
*);
260 extern const char mime_boundary_leader
[];
262 extern struct combine_diff_path
*diff_tree_paths(
263 struct combine_diff_path
*p
, const struct object_id
*oid
,
264 const struct object_id
**parents_oid
, int nparent
,
265 struct strbuf
*base
, struct diff_options
*opt
);
266 extern int diff_tree_oid(const struct object_id
*old_oid
,
267 const struct object_id
*new_oid
,
268 const char *base
, struct diff_options
*opt
);
269 extern int diff_root_tree_oid(const struct object_id
*new_oid
, const char *base
,
270 struct diff_options
*opt
);
272 struct combine_diff_path
{
273 struct combine_diff_path
*next
;
276 struct object_id oid
;
277 struct combine_diff_parent
{
280 struct object_id oid
;
281 } parent
[FLEX_ARRAY
];
283 #define combine_diff_path_size(n, l) \
284 st_add4(sizeof(struct combine_diff_path), (l), 1, \
285 st_mult(sizeof(struct combine_diff_parent), (n)))
287 extern void show_combined_diff(struct combine_diff_path
*elem
, int num_parent
,
288 int dense
, struct rev_info
*);
290 extern void diff_tree_combined(const struct object_id
*oid
, const struct oid_array
*parents
, int dense
, struct rev_info
*rev
);
292 extern void diff_tree_combined_merge(const struct commit
*commit
, int dense
, struct rev_info
*rev
);
294 void diff_set_mnemonic_prefix(struct diff_options
*options
, const char *a
, const char *b
);
296 extern int diff_can_quit_early(struct diff_options
*);
298 extern void diff_addremove(struct diff_options
*,
301 const struct object_id
*oid
,
303 const char *fullpath
, unsigned dirty_submodule
);
305 extern void diff_change(struct diff_options
*,
306 unsigned mode1
, unsigned mode2
,
307 const struct object_id
*old_oid
,
308 const struct object_id
*new_oid
,
309 int old_oid_valid
, int new_oid_valid
,
310 const char *fullpath
,
311 unsigned dirty_submodule1
, unsigned dirty_submodule2
);
313 extern struct diff_filepair
*diff_unmerge(struct diff_options
*, const char *path
);
315 #define DIFF_SETUP_REVERSE 1
316 #define DIFF_SETUP_USE_CACHE 2
317 #define DIFF_SETUP_USE_SIZE_CACHE 4
320 * Poor man's alternative to parse-option, to allow both stuck form
321 * (--option=value) and separate form (--option value).
323 extern int parse_long_opt(const char *opt
, const char **argv
,
324 const char **optarg
);
326 extern int git_diff_basic_config(const char *var
, const char *value
, void *cb
);
327 extern int git_diff_heuristic_config(const char *var
, const char *value
, void *cb
);
328 extern void init_diff_ui_defaults(void);
329 extern int git_diff_ui_config(const char *var
, const char *value
, void *cb
);
330 extern void diff_setup(struct diff_options
*);
331 extern int diff_opt_parse(struct diff_options
*, const char **, int, const char *);
332 extern void diff_setup_done(struct diff_options
*);
333 extern int git_config_rename(const char *var
, const char *value
);
335 #define DIFF_DETECT_RENAME 1
336 #define DIFF_DETECT_COPY 2
338 #define DIFF_PICKAXE_ALL 1
339 #define DIFF_PICKAXE_REGEX 2
341 #define DIFF_PICKAXE_KIND_S 4 /* traditional plumbing counter */
342 #define DIFF_PICKAXE_KIND_G 8 /* grep in the patch */
343 #define DIFF_PICKAXE_KIND_OBJFIND 16 /* specific object IDs */
345 #define DIFF_PICKAXE_KINDS_MASK (DIFF_PICKAXE_KIND_S | \
346 DIFF_PICKAXE_KIND_G | \
347 DIFF_PICKAXE_KIND_OBJFIND)
349 #define DIFF_PICKAXE_IGNORE_CASE 32
351 extern void diffcore_std(struct diff_options
*);
352 extern void diffcore_fix_diff_index(struct diff_options
*);
354 #define COMMON_DIFF_OPTIONS_HELP \
355 "\ncommon diff options:\n" \
356 " -z output diff-raw with lines terminated with NUL.\n" \
357 " -p output patch format.\n" \
358 " -u synonym for -p.\n" \
359 " --patch-with-raw\n" \
360 " output both a patch and the diff-raw format.\n" \
361 " --stat show diffstat instead of patch.\n" \
362 " --numstat show numeric diffstat instead of patch.\n" \
363 " --patch-with-stat\n" \
364 " output a patch and prepend its diffstat.\n" \
365 " --name-only show only names of changed files.\n" \
366 " --name-status show names and status of changed files.\n" \
367 " --full-index show full object name on index lines.\n" \
368 " --abbrev=<n> abbreviate object names in diff-tree header and diff-raw.\n" \
369 " -R swap input file pairs.\n" \
370 " -B detect complete rewrites.\n" \
371 " -M detect renames.\n" \
372 " -C detect copies.\n" \
373 " --find-copies-harder\n" \
374 " try unchanged files as candidate for copy detection.\n" \
375 " -l<n> limit rename attempts up to <n> paths.\n" \
376 " -O<file> reorder diffs according to the <file>.\n" \
377 " -S<string> find filepair whose only one side contains the string.\n" \
379 " show all files diff when -S is used and hit is found.\n" \
380 " -a --text treat all files as text.\n"
382 extern int diff_queue_is_empty(void);
383 extern void diff_flush(struct diff_options
*);
384 extern void diff_warn_rename_limit(const char *varname
, int needed
, int degraded_cc
);
386 /* diff-raw status letters */
387 #define DIFF_STATUS_ADDED 'A'
388 #define DIFF_STATUS_COPIED 'C'
389 #define DIFF_STATUS_DELETED 'D'
390 #define DIFF_STATUS_MODIFIED 'M'
391 #define DIFF_STATUS_RENAMED 'R'
392 #define DIFF_STATUS_TYPE_CHANGED 'T'
393 #define DIFF_STATUS_UNKNOWN 'X'
394 #define DIFF_STATUS_UNMERGED 'U'
396 /* these are not diff-raw status letters proper, but used by
397 * diffcore-filter insn to specify additional restrictions.
399 #define DIFF_STATUS_FILTER_AON '*'
400 #define DIFF_STATUS_FILTER_BROKEN 'B'
403 * This is different from find_unique_abbrev() in that
404 * it stuffs the result with dots for alignment.
406 extern const char *diff_aligned_abbrev(const struct object_id
*sha1
, int);
408 /* do not report anything on removed paths */
409 #define DIFF_SILENT_ON_REMOVED 01
410 /* report racily-clean paths as modified */
411 #define DIFF_RACY_IS_MODIFIED 02
412 extern int run_diff_files(struct rev_info
*revs
, unsigned int option
);
413 extern int run_diff_index(struct rev_info
*revs
, int cached
);
415 extern int do_diff_cache(const struct object_id
*, struct diff_options
*);
416 extern int diff_flush_patch_id(struct diff_options
*, struct object_id
*, int);
418 extern int diff_result_code(struct diff_options
*, int);
420 extern void diff_no_index(struct rev_info
*, int, const char **);
422 extern int index_differs_from(const char *def
, const struct diff_flags
*flags
,
423 int ita_invisible_in_index
);
426 * Fill the contents of the filespec "df", respecting any textconv defined by
427 * its userdiff driver. The "driver" parameter must come from a
428 * previous call to get_textconv(), and therefore should either be NULL or have
431 * Note that the memory ownership of the resulting buffer depends on whether
432 * the driver field is NULL. If it is, then the memory belongs to the filespec
433 * struct. If it is non-NULL, then "outbuf" points to a newly allocated buffer
434 * that should be freed by the caller.
436 extern size_t fill_textconv(struct userdiff_driver
*driver
,
437 struct diff_filespec
*df
,
441 * Look up the userdiff driver for the given filespec, and return it if
442 * and only if it has textconv enabled (otherwise return NULL). The result
443 * can be passed to fill_textconv().
445 extern struct userdiff_driver
*get_textconv(struct diff_filespec
*one
);
448 * Prepare diff_filespec and convert it using diff textconv API
449 * if the textconv driver exists.
450 * Return 1 if the conversion succeeds, 0 otherwise.
452 extern int textconv_object(const char *path
, unsigned mode
, const struct object_id
*oid
, int oid_valid
, char **buf
, unsigned long *buf_size
);
454 extern int parse_rename_score(const char **cp_p
);
456 extern long parse_algorithm_value(const char *value
);
458 extern void print_stat_summary(FILE *fp
, int files
,
459 int insertions
, int deletions
);
460 extern void setup_diff_pager(struct diff_options
*);