d88ceb3570fda33edc626aa3e2e738870af3346b
1/*
2 * Copyright (C) 2005 Junio C Hamano
3 */
4#ifndef DIFF_H
5#define DIFF_H
6
7#include "tree-walk.h"
8#include "pathspec.h"
9#include "object.h"
10#include "oidset.h"
11
12struct rev_info;
13struct diff_options;
14struct diff_queue_struct;
15struct strbuf;
16struct diff_filespec;
17struct userdiff_driver;
18struct oid_array;
19struct commit;
20struct combine_diff_path;
21
22typedef int (*pathchange_fn_t)(struct diff_options *options,
23 struct combine_diff_path *path);
24
25typedef 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,
30 const char *fullpath,
31 unsigned old_dirty_submodule, unsigned new_dirty_submodule);
32
33typedef void (*add_remove_fn_t)(struct diff_options *options,
34 int addremove, unsigned mode,
35 const struct object_id *oid,
36 int oid_valid,
37 const char *fullpath, unsigned dirty_submodule);
38
39typedef void (*diff_format_fn_t)(struct diff_queue_struct *q,
40 struct diff_options *options, void *data);
41
42typedef struct strbuf *(*diff_prefix_fn_t)(struct diff_options *opt, void *data);
43
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
51
52/* These override all above */
53#define DIFF_FORMAT_NAME 0x0100
54#define DIFF_FORMAT_NAME_STATUS 0x0200
55#define DIFF_FORMAT_CHECKDIFF 0x0400
56
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.
59 */
60#define DIFF_FORMAT_NO_OUTPUT 0x0800
61
62#define DIFF_FORMAT_CALLBACK 0x1000
63
64#define DIFF_FLAGS_INIT { 0 }
65struct diff_flags {
66 unsigned recursive:1;
67 unsigned tree_in_recursive:1;
68 unsigned binary:1;
69 unsigned text: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;
76 unsigned quick:1;
77 unsigned no_index: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;
98};
99
100static inline void diff_flags_or(struct diff_flags *a,
101 const struct diff_flags *b)
102{
103 char *tmp_a = (char *)a;
104 const char *tmp_b = (const char *)b;
105 int i;
106
107 for (i = 0; i < sizeof(struct diff_flags); i++)
108 tmp_a[i] |= tmp_b[i];
109}
110
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)
114
115#define DIFF_WITH_ALG(opts, flag) (((opts)->xdl_opts & ~XDF_DIFF_ALGORITHM_MASK) | XDF_##flag)
116
117enum diff_words_type {
118 DIFF_WORDS_NONE = 0,
119 DIFF_WORDS_PORCELAIN,
120 DIFF_WORDS_PLAIN,
121 DIFF_WORDS_COLOR
122};
123
124enum diff_submodule_format {
125 DIFF_SUBMODULE_SHORT = 0,
126 DIFF_SUBMODULE_LOG,
127 DIFF_SUBMODULE_INLINE_DIFF
128};
129
130struct diff_options {
131 const char *orderfile;
132 const char *pickaxe;
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;
138
139 /* diff-filter bits */
140 unsigned int filter;
141
142 int use_color;
143 int context;
144 int interhunkcontext;
145 int break_opt;
146 int detect_rename;
147 int irreversible_delete;
148 int skip_stat_unmatch;
149 int line_termination;
150 int output_format;
151 unsigned pickaxe_opts;
152 int rename_score;
153 int rename_limit;
154 int needed_rename_limit;
155 int degraded_cc_to_c;
156 int show_rename_progress;
157 int dirstat_permille;
158 int setup;
159 int abbrev;
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;
166 const char *prefix;
167 int prefix_length;
168 const char *stat_sep;
169 long xdl_opts;
170
171 /* see Documentation/diff-options.txt */
172 char **anchors;
173 size_t anchors_nr, anchors_alloc;
174
175 int stat_width;
176 int stat_name_width;
177 int stat_graph_width;
178 int stat_count;
179 const char *word_regex;
180 enum diff_words_type word_diff;
181 enum diff_submodule_format submodule_format;
182
183 struct oidset *objfind;
184
185 /* this is set by diffcore for DIFF_FORMAT_PATCH */
186 int found_changes;
187
188 /* to support internal diff recursion by --follow hack*/
189 int found_follow;
190
191 void (*set_default)(struct diff_options *);
192
193 FILE *file;
194 int close_file;
195
196 struct pathspec pathspec;
197 pathchange_fn_t pathchange;
198 change_fn_t change;
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;
205
206 int diff_path_counter;
207
208 struct emitted_diff_symbols *emitted_symbols;
209 enum {
210 COLOR_MOVED_NO = 0,
211 COLOR_MOVED_PLAIN = 1,
212 COLOR_MOVED_BLOCKS = 2,
213 COLOR_MOVED_ZEBRA = 3,
214 COLOR_MOVED_ZEBRA_DIM = 4,
215 } color_moved;
216 #define COLOR_MOVED_DEFAULT COLOR_MOVED_ZEBRA
217 #define COLOR_MOVED_MIN_ALNUM_COUNT 20
218
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;
222};
223
224void diff_emit_submodule_del(struct diff_options *o, const char *line);
225void diff_emit_submodule_add(struct diff_options *o, const char *line);
226void diff_emit_submodule_untracked(struct diff_options *o, const char *path);
227void diff_emit_submodule_modified(struct diff_options *o, const char *path);
228void diff_emit_submodule_header(struct diff_options *o, const char *header);
229void diff_emit_submodule_error(struct diff_options *o, const char *err);
230void diff_emit_submodule_pipethrough(struct diff_options *o,
231 const char *line, int len);
232
233enum color_diff {
234 DIFF_RESET = 0,
235 DIFF_CONTEXT = 1,
236 DIFF_METAINFO = 2,
237 DIFF_FRAGINFO = 3,
238 DIFF_FILE_OLD = 4,
239 DIFF_FILE_NEW = 5,
240 DIFF_COMMIT = 6,
241 DIFF_WHITESPACE = 7,
242 DIFF_FUNCINFO = 8,
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
251};
252const 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)
255
256
257const char *diff_line_prefix(struct diff_options *);
258
259
260extern const char mime_boundary_leader[];
261
262extern 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);
266extern 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);
269extern int diff_root_tree_oid(const struct object_id *new_oid, const char *base,
270 struct diff_options *opt);
271
272struct combine_diff_path {
273 struct combine_diff_path *next;
274 char *path;
275 unsigned int mode;
276 struct object_id oid;
277 struct combine_diff_parent {
278 char status;
279 unsigned int mode;
280 struct object_id oid;
281 } parent[FLEX_ARRAY];
282};
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)))
286
287extern void show_combined_diff(struct combine_diff_path *elem, int num_parent,
288 int dense, struct rev_info *);
289
290extern void diff_tree_combined(const struct object_id *oid, const struct oid_array *parents, int dense, struct rev_info *rev);
291
292extern void diff_tree_combined_merge(const struct commit *commit, int dense, struct rev_info *rev);
293
294void diff_set_mnemonic_prefix(struct diff_options *options, const char *a, const char *b);
295
296extern int diff_can_quit_early(struct diff_options *);
297
298extern void diff_addremove(struct diff_options *,
299 int addremove,
300 unsigned mode,
301 const struct object_id *oid,
302 int oid_valid,
303 const char *fullpath, unsigned dirty_submodule);
304
305extern 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);
312
313extern struct diff_filepair *diff_unmerge(struct diff_options *, const char *path);
314
315#define DIFF_SETUP_REVERSE 1
316#define DIFF_SETUP_USE_CACHE 2
317#define DIFF_SETUP_USE_SIZE_CACHE 4
318
319/*
320 * Poor man's alternative to parse-option, to allow both stuck form
321 * (--option=value) and separate form (--option value).
322 */
323extern int parse_long_opt(const char *opt, const char **argv,
324 const char **optarg);
325
326extern int git_diff_basic_config(const char *var, const char *value, void *cb);
327extern int git_diff_heuristic_config(const char *var, const char *value, void *cb);
328extern void init_diff_ui_defaults(void);
329extern int git_diff_ui_config(const char *var, const char *value, void *cb);
330extern void diff_setup(struct diff_options *);
331extern int diff_opt_parse(struct diff_options *, const char **, int, const char *);
332extern void diff_setup_done(struct diff_options *);
333extern int git_config_rename(const char *var, const char *value);
334
335#define DIFF_DETECT_RENAME 1
336#define DIFF_DETECT_COPY 2
337
338#define DIFF_PICKAXE_ALL 1
339#define DIFF_PICKAXE_REGEX 2
340
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 */
344
345#define DIFF_PICKAXE_KINDS_MASK (DIFF_PICKAXE_KIND_S | \
346 DIFF_PICKAXE_KIND_G | \
347 DIFF_PICKAXE_KIND_OBJFIND)
348
349#define DIFF_PICKAXE_IGNORE_CASE 32
350
351extern void diffcore_std(struct diff_options *);
352extern void diffcore_fix_diff_index(struct diff_options *);
353
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" \
378" --pickaxe-all\n" \
379" show all files diff when -S is used and hit is found.\n" \
380" -a --text treat all files as text.\n"
381
382extern int diff_queue_is_empty(void);
383extern void diff_flush(struct diff_options*);
384extern void diff_warn_rename_limit(const char *varname, int needed, int degraded_cc);
385
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'
395
396/* these are not diff-raw status letters proper, but used by
397 * diffcore-filter insn to specify additional restrictions.
398 */
399#define DIFF_STATUS_FILTER_AON '*'
400#define DIFF_STATUS_FILTER_BROKEN 'B'
401
402/*
403 * This is different from find_unique_abbrev() in that
404 * it stuffs the result with dots for alignment.
405 */
406extern const char *diff_aligned_abbrev(const struct object_id *sha1, int);
407
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
412extern int run_diff_files(struct rev_info *revs, unsigned int option);
413extern int run_diff_index(struct rev_info *revs, int cached);
414
415extern int do_diff_cache(const struct object_id *, struct diff_options *);
416extern int diff_flush_patch_id(struct diff_options *, struct object_id *, int);
417
418extern int diff_result_code(struct diff_options *, int);
419
420extern void diff_no_index(struct rev_info *, int, const char **);
421
422extern int index_differs_from(const char *def, const struct diff_flags *flags,
423 int ita_invisible_in_index);
424
425/*
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
429 * textconv enabled.
430 *
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.
435 */
436extern size_t fill_textconv(struct userdiff_driver *driver,
437 struct diff_filespec *df,
438 char **outbuf);
439
440/*
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().
444 */
445extern struct userdiff_driver *get_textconv(struct diff_filespec *one);
446
447/*
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.
451 */
452extern int textconv_object(const char *path, unsigned mode, const struct object_id *oid, int oid_valid, char **buf, unsigned long *buf_size);
453
454extern int parse_rename_score(const char **cp_p);
455
456extern long parse_algorithm_value(const char *value);
457
458extern void print_stat_summary(FILE *fp, int files,
459 int insertions, int deletions);
460extern void setup_diff_pager(struct diff_options *);
461
462#endif /* DIFF_H */