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;
98 static inline void diff_flags_or(struct diff_flags
*a
,
99 const struct diff_flags
*b
)
101 char *tmp_a
= (char *)a
;
102 const char *tmp_b
= (const char *)b
;
105 for (i
= 0; i
< sizeof(struct diff_flags
); i
++)
106 tmp_a
[i
] |= tmp_b
[i
];
109 #define DIFF_XDL_TST(opts, flag) ((opts)->xdl_opts & XDF_##flag)
110 #define DIFF_XDL_SET(opts, flag) ((opts)->xdl_opts |= XDF_##flag)
111 #define DIFF_XDL_CLR(opts, flag) ((opts)->xdl_opts &= ~XDF_##flag)
113 #define DIFF_WITH_ALG(opts, flag) (((opts)->xdl_opts & ~XDF_DIFF_ALGORITHM_MASK) | XDF_##flag)
115 enum diff_words_type
{
117 DIFF_WORDS_PORCELAIN
,
122 enum diff_submodule_format
{
123 DIFF_SUBMODULE_SHORT
= 0,
125 DIFF_SUBMODULE_INLINE_DIFF
128 struct diff_options
{
129 const char *orderfile
;
131 const char *single_follow
;
132 const char *a_prefix
, *b_prefix
;
133 const char *line_prefix
;
134 size_t line_prefix_length
;
135 struct diff_flags flags
;
137 /* diff-filter bits */
142 int interhunkcontext
;
145 int irreversible_delete
;
146 int skip_stat_unmatch
;
147 int line_termination
;
149 unsigned pickaxe_opts
;
152 int needed_rename_limit
;
153 int degraded_cc_to_c
;
154 int show_rename_progress
;
155 int dirstat_permille
;
158 int ita_invisible_in_index
;
159 /* white-space error highlighting */
160 #define WSEH_NEW (1<<12)
161 #define WSEH_CONTEXT (1<<13)
162 #define WSEH_OLD (1<<14)
163 unsigned ws_error_highlight
;
166 const char *stat_sep
;
171 int stat_graph_width
;
173 const char *word_regex
;
174 enum diff_words_type word_diff
;
175 enum diff_submodule_format submodule_format
;
177 struct oidset
*objfind
;
179 /* this is set by diffcore for DIFF_FORMAT_PATCH */
182 /* to support internal diff recursion by --follow hack*/
185 void (*set_default
)(struct diff_options
*);
190 struct pathspec pathspec
;
191 pathchange_fn_t pathchange
;
193 add_remove_fn_t add_remove
;
194 void *change_fn_data
;
195 diff_format_fn_t format_callback
;
196 void *format_callback_data
;
197 diff_prefix_fn_t output_prefix
;
198 void *output_prefix_data
;
200 int diff_path_counter
;
202 struct emitted_diff_symbols
*emitted_symbols
;
205 COLOR_MOVED_PLAIN
= 1,
206 COLOR_MOVED_ZEBRA
= 2,
207 COLOR_MOVED_ZEBRA_DIM
= 3,
209 #define COLOR_MOVED_DEFAULT COLOR_MOVED_ZEBRA
210 #define COLOR_MOVED_MIN_ALNUM_COUNT 20
213 void diff_emit_submodule_del(struct diff_options
*o
, const char *line
);
214 void diff_emit_submodule_add(struct diff_options
*o
, const char *line
);
215 void diff_emit_submodule_untracked(struct diff_options
*o
, const char *path
);
216 void diff_emit_submodule_modified(struct diff_options
*o
, const char *path
);
217 void diff_emit_submodule_header(struct diff_options
*o
, const char *header
);
218 void diff_emit_submodule_error(struct diff_options
*o
, const char *err
);
219 void diff_emit_submodule_pipethrough(struct diff_options
*o
,
220 const char *line
, int len
);
232 DIFF_FILE_OLD_MOVED
= 9,
233 DIFF_FILE_OLD_MOVED_ALT
= 10,
234 DIFF_FILE_OLD_MOVED_DIM
= 11,
235 DIFF_FILE_OLD_MOVED_ALT_DIM
= 12,
236 DIFF_FILE_NEW_MOVED
= 13,
237 DIFF_FILE_NEW_MOVED_ALT
= 14,
238 DIFF_FILE_NEW_MOVED_DIM
= 15,
239 DIFF_FILE_NEW_MOVED_ALT_DIM
= 16
241 const char *diff_get_color(int diff_use_color
, enum color_diff ix
);
242 #define diff_get_color_opt(o, ix) \
243 diff_get_color((o)->use_color, ix)
246 const char *diff_line_prefix(struct diff_options
*);
249 extern const char mime_boundary_leader
[];
251 extern struct combine_diff_path
*diff_tree_paths(
252 struct combine_diff_path
*p
, const struct object_id
*oid
,
253 const struct object_id
**parents_oid
, int nparent
,
254 struct strbuf
*base
, struct diff_options
*opt
);
255 extern int diff_tree_oid(const struct object_id
*old_oid
,
256 const struct object_id
*new_oid
,
257 const char *base
, struct diff_options
*opt
);
258 extern int diff_root_tree_oid(const struct object_id
*new_oid
, const char *base
,
259 struct diff_options
*opt
);
261 struct combine_diff_path
{
262 struct combine_diff_path
*next
;
265 struct object_id oid
;
266 struct combine_diff_parent
{
269 struct object_id oid
;
270 } parent
[FLEX_ARRAY
];
272 #define combine_diff_path_size(n, l) \
273 st_add4(sizeof(struct combine_diff_path), (l), 1, \
274 st_mult(sizeof(struct combine_diff_parent), (n)))
276 extern void show_combined_diff(struct combine_diff_path
*elem
, int num_parent
,
277 int dense
, struct rev_info
*);
279 extern void diff_tree_combined(const struct object_id
*oid
, const struct oid_array
*parents
, int dense
, struct rev_info
*rev
);
281 extern void diff_tree_combined_merge(const struct commit
*commit
, int dense
, struct rev_info
*rev
);
283 void diff_set_mnemonic_prefix(struct diff_options
*options
, const char *a
, const char *b
);
285 extern int diff_can_quit_early(struct diff_options
*);
287 extern void diff_addremove(struct diff_options
*,
290 const struct object_id
*oid
,
292 const char *fullpath
, unsigned dirty_submodule
);
294 extern void diff_change(struct diff_options
*,
295 unsigned mode1
, unsigned mode2
,
296 const struct object_id
*old_oid
,
297 const struct object_id
*new_oid
,
298 int old_oid_valid
, int new_oid_valid
,
299 const char *fullpath
,
300 unsigned dirty_submodule1
, unsigned dirty_submodule2
);
302 extern struct diff_filepair
*diff_unmerge(struct diff_options
*, const char *path
);
304 #define DIFF_SETUP_REVERSE 1
305 #define DIFF_SETUP_USE_CACHE 2
306 #define DIFF_SETUP_USE_SIZE_CACHE 4
309 * Poor man's alternative to parse-option, to allow both stuck form
310 * (--option=value) and separate form (--option value).
312 extern int parse_long_opt(const char *opt
, const char **argv
,
313 const char **optarg
);
315 extern int git_diff_basic_config(const char *var
, const char *value
, void *cb
);
316 extern int git_diff_heuristic_config(const char *var
, const char *value
, void *cb
);
317 extern void init_diff_ui_defaults(void);
318 extern int git_diff_ui_config(const char *var
, const char *value
, void *cb
);
319 extern void diff_setup(struct diff_options
*);
320 extern int diff_opt_parse(struct diff_options
*, const char **, int, const char *);
321 extern void diff_setup_done(struct diff_options
*);
323 #define DIFF_DETECT_RENAME 1
324 #define DIFF_DETECT_COPY 2
326 #define DIFF_PICKAXE_ALL 1
327 #define DIFF_PICKAXE_REGEX 2
329 #define DIFF_PICKAXE_KIND_S 4 /* traditional plumbing counter */
330 #define DIFF_PICKAXE_KIND_G 8 /* grep in the patch */
331 #define DIFF_PICKAXE_KIND_OBJFIND 16 /* specific object IDs */
333 #define DIFF_PICKAXE_KINDS_MASK (DIFF_PICKAXE_KIND_S | \
334 DIFF_PICKAXE_KIND_G | \
335 DIFF_PICKAXE_KIND_OBJFIND)
337 #define DIFF_PICKAXE_IGNORE_CASE 32
339 extern void diffcore_std(struct diff_options
*);
340 extern void diffcore_fix_diff_index(struct diff_options
*);
342 #define COMMON_DIFF_OPTIONS_HELP \
343 "\ncommon diff options:\n" \
344 " -z output diff-raw with lines terminated with NUL.\n" \
345 " -p output patch format.\n" \
346 " -u synonym for -p.\n" \
347 " --patch-with-raw\n" \
348 " output both a patch and the diff-raw format.\n" \
349 " --stat show diffstat instead of patch.\n" \
350 " --numstat show numeric diffstat instead of patch.\n" \
351 " --patch-with-stat\n" \
352 " output a patch and prepend its diffstat.\n" \
353 " --name-only show only names of changed files.\n" \
354 " --name-status show names and status of changed files.\n" \
355 " --full-index show full object name on index lines.\n" \
356 " --abbrev=<n> abbreviate object names in diff-tree header and diff-raw.\n" \
357 " -R swap input file pairs.\n" \
358 " -B detect complete rewrites.\n" \
359 " -M detect renames.\n" \
360 " -C detect copies.\n" \
361 " --find-copies-harder\n" \
362 " try unchanged files as candidate for copy detection.\n" \
363 " -l<n> limit rename attempts up to <n> paths.\n" \
364 " -O<file> reorder diffs according to the <file>.\n" \
365 " -S<string> find filepair whose only one side contains the string.\n" \
367 " show all files diff when -S is used and hit is found.\n" \
368 " -a --text treat all files as text.\n"
370 extern int diff_queue_is_empty(void);
371 extern void diff_flush(struct diff_options
*);
372 extern void diff_warn_rename_limit(const char *varname
, int needed
, int degraded_cc
);
374 /* diff-raw status letters */
375 #define DIFF_STATUS_ADDED 'A'
376 #define DIFF_STATUS_COPIED 'C'
377 #define DIFF_STATUS_DELETED 'D'
378 #define DIFF_STATUS_MODIFIED 'M'
379 #define DIFF_STATUS_RENAMED 'R'
380 #define DIFF_STATUS_TYPE_CHANGED 'T'
381 #define DIFF_STATUS_UNKNOWN 'X'
382 #define DIFF_STATUS_UNMERGED 'U'
384 /* these are not diff-raw status letters proper, but used by
385 * diffcore-filter insn to specify additional restrictions.
387 #define DIFF_STATUS_FILTER_AON '*'
388 #define DIFF_STATUS_FILTER_BROKEN 'B'
391 * This is different from find_unique_abbrev() in that
392 * it stuffs the result with dots for alignment.
394 extern const char *diff_aligned_abbrev(const struct object_id
*sha1
, int);
396 /* do not report anything on removed paths */
397 #define DIFF_SILENT_ON_REMOVED 01
398 /* report racily-clean paths as modified */
399 #define DIFF_RACY_IS_MODIFIED 02
400 extern int run_diff_files(struct rev_info
*revs
, unsigned int option
);
401 extern int run_diff_index(struct rev_info
*revs
, int cached
);
403 extern int do_diff_cache(const struct object_id
*, struct diff_options
*);
404 extern int diff_flush_patch_id(struct diff_options
*, struct object_id
*, int);
406 extern int diff_result_code(struct diff_options
*, int);
408 extern void diff_no_index(struct rev_info
*, int, const char **);
410 extern int index_differs_from(const char *def
, const struct diff_flags
*flags
,
411 int ita_invisible_in_index
);
414 * Fill the contents of the filespec "df", respecting any textconv defined by
415 * its userdiff driver. The "driver" parameter must come from a
416 * previous call to get_textconv(), and therefore should either be NULL or have
419 * Note that the memory ownership of the resulting buffer depends on whether
420 * the driver field is NULL. If it is, then the memory belongs to the filespec
421 * struct. If it is non-NULL, then "outbuf" points to a newly allocated buffer
422 * that should be freed by the caller.
424 extern size_t fill_textconv(struct userdiff_driver
*driver
,
425 struct diff_filespec
*df
,
429 * Look up the userdiff driver for the given filespec, and return it if
430 * and only if it has textconv enabled (otherwise return NULL). The result
431 * can be passed to fill_textconv().
433 extern struct userdiff_driver
*get_textconv(struct diff_filespec
*one
);
436 * Prepare diff_filespec and convert it using diff textconv API
437 * if the textconv driver exists.
438 * Return 1 if the conversion succeeds, 0 otherwise.
440 extern int textconv_object(const char *path
, unsigned mode
, const struct object_id
*oid
, int oid_valid
, char **buf
, unsigned long *buf_size
);
442 extern int parse_rename_score(const char **cp_p
);
444 extern long parse_algorithm_value(const char *value
);
446 extern void print_stat_summary(FILE *fp
, int files
,
447 int insertions
, int deletions
);
448 extern void setup_diff_pager(struct diff_options
*);