range-diff: use dim/bold cues to improve dual color mode
[git/git.git] / diff.h
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
12 struct rev_info;
13 struct diff_options;
14 struct diff_queue_struct;
15 struct strbuf;
16 struct diff_filespec;
17 struct userdiff_driver;
18 struct oid_array;
19 struct commit;
20 struct combine_diff_path;
21
22 typedef int (*pathchange_fn_t)(struct diff_options *options,
23 struct combine_diff_path *path);
24
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,
30 const char *fullpath,
31 unsigned old_dirty_submodule, unsigned new_dirty_submodule);
32
33 typedef 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
39 typedef void (*diff_format_fn_t)(struct diff_queue_struct *q,
40 struct diff_options *options, void *data);
41
42 typedef 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 }
65 struct 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 unsigned dual_color_diffed_diffs:1;
99 };
100
101 static inline void diff_flags_or(struct diff_flags *a,
102 const struct diff_flags *b)
103 {
104 char *tmp_a = (char *)a;
105 const char *tmp_b = (const char *)b;
106 int i;
107
108 for (i = 0; i < sizeof(struct diff_flags); i++)
109 tmp_a[i] |= tmp_b[i];
110 }
111
112 #define DIFF_XDL_TST(opts, flag) ((opts)->xdl_opts & XDF_##flag)
113 #define DIFF_XDL_SET(opts, flag) ((opts)->xdl_opts |= XDF_##flag)
114 #define DIFF_XDL_CLR(opts, flag) ((opts)->xdl_opts &= ~XDF_##flag)
115
116 #define DIFF_WITH_ALG(opts, flag) (((opts)->xdl_opts & ~XDF_DIFF_ALGORITHM_MASK) | XDF_##flag)
117
118 enum diff_words_type {
119 DIFF_WORDS_NONE = 0,
120 DIFF_WORDS_PORCELAIN,
121 DIFF_WORDS_PLAIN,
122 DIFF_WORDS_COLOR
123 };
124
125 enum diff_submodule_format {
126 DIFF_SUBMODULE_SHORT = 0,
127 DIFF_SUBMODULE_LOG,
128 DIFF_SUBMODULE_INLINE_DIFF
129 };
130
131 struct diff_options {
132 const char *orderfile;
133 const char *pickaxe;
134 const char *single_follow;
135 const char *a_prefix, *b_prefix;
136 const char *line_prefix;
137 size_t line_prefix_length;
138 struct diff_flags flags;
139
140 /* diff-filter bits */
141 unsigned int filter;
142
143 int use_color;
144 int context;
145 int interhunkcontext;
146 int break_opt;
147 int detect_rename;
148 int irreversible_delete;
149 int skip_stat_unmatch;
150 int line_termination;
151 int output_format;
152 unsigned pickaxe_opts;
153 int rename_score;
154 int rename_limit;
155 int needed_rename_limit;
156 int degraded_cc_to_c;
157 int show_rename_progress;
158 int dirstat_permille;
159 int setup;
160 int abbrev;
161 int ita_invisible_in_index;
162 /* white-space error highlighting */
163 #define WSEH_NEW (1<<12)
164 #define WSEH_CONTEXT (1<<13)
165 #define WSEH_OLD (1<<14)
166 unsigned ws_error_highlight;
167 const char *prefix;
168 int prefix_length;
169 const char *stat_sep;
170 long xdl_opts;
171
172 /* see Documentation/diff-options.txt */
173 char **anchors;
174 size_t anchors_nr, anchors_alloc;
175
176 int stat_width;
177 int stat_name_width;
178 int stat_graph_width;
179 int stat_count;
180 const char *word_regex;
181 enum diff_words_type word_diff;
182 enum diff_submodule_format submodule_format;
183
184 struct oidset *objfind;
185
186 /* this is set by diffcore for DIFF_FORMAT_PATCH */
187 int found_changes;
188
189 /* to support internal diff recursion by --follow hack*/
190 int found_follow;
191
192 void (*set_default)(struct diff_options *);
193
194 FILE *file;
195 int close_file;
196
197 struct pathspec pathspec;
198 pathchange_fn_t pathchange;
199 change_fn_t change;
200 add_remove_fn_t add_remove;
201 void *change_fn_data;
202 diff_format_fn_t format_callback;
203 void *format_callback_data;
204 diff_prefix_fn_t output_prefix;
205 void *output_prefix_data;
206
207 int diff_path_counter;
208
209 struct emitted_diff_symbols *emitted_symbols;
210 enum {
211 COLOR_MOVED_NO = 0,
212 COLOR_MOVED_PLAIN = 1,
213 COLOR_MOVED_BLOCKS = 2,
214 COLOR_MOVED_ZEBRA = 3,
215 COLOR_MOVED_ZEBRA_DIM = 4,
216 } color_moved;
217 #define COLOR_MOVED_DEFAULT COLOR_MOVED_ZEBRA
218 #define COLOR_MOVED_MIN_ALNUM_COUNT 20
219
220 /* XDF_WHITESPACE_FLAGS regarding block detection are set at 2, 3, 4 */
221 #define COLOR_MOVED_WS_ALLOW_INDENTATION_CHANGE (1<<5)
222 int color_moved_ws_handling;
223 };
224
225 void diff_emit_submodule_del(struct diff_options *o, const char *line);
226 void diff_emit_submodule_add(struct diff_options *o, const char *line);
227 void diff_emit_submodule_untracked(struct diff_options *o, const char *path);
228 void diff_emit_submodule_modified(struct diff_options *o, const char *path);
229 void diff_emit_submodule_header(struct diff_options *o, const char *header);
230 void diff_emit_submodule_error(struct diff_options *o, const char *err);
231 void diff_emit_submodule_pipethrough(struct diff_options *o,
232 const char *line, int len);
233
234 enum color_diff {
235 DIFF_RESET = 0,
236 DIFF_CONTEXT = 1,
237 DIFF_METAINFO = 2,
238 DIFF_FRAGINFO = 3,
239 DIFF_FILE_OLD = 4,
240 DIFF_FILE_NEW = 5,
241 DIFF_COMMIT = 6,
242 DIFF_WHITESPACE = 7,
243 DIFF_FUNCINFO = 8,
244 DIFF_FILE_OLD_MOVED = 9,
245 DIFF_FILE_OLD_MOVED_ALT = 10,
246 DIFF_FILE_OLD_MOVED_DIM = 11,
247 DIFF_FILE_OLD_MOVED_ALT_DIM = 12,
248 DIFF_FILE_NEW_MOVED = 13,
249 DIFF_FILE_NEW_MOVED_ALT = 14,
250 DIFF_FILE_NEW_MOVED_DIM = 15,
251 DIFF_FILE_NEW_MOVED_ALT_DIM = 16,
252 DIFF_CONTEXT_DIM = 17,
253 DIFF_FILE_OLD_DIM = 18,
254 DIFF_FILE_NEW_DIM = 19,
255 DIFF_CONTEXT_BOLD = 20,
256 DIFF_FILE_OLD_BOLD = 21,
257 DIFF_FILE_NEW_BOLD = 22,
258 };
259 const char *diff_get_color(int diff_use_color, enum color_diff ix);
260 #define diff_get_color_opt(o, ix) \
261 diff_get_color((o)->use_color, ix)
262
263
264 const char *diff_line_prefix(struct diff_options *);
265
266
267 extern const char mime_boundary_leader[];
268
269 extern struct combine_diff_path *diff_tree_paths(
270 struct combine_diff_path *p, const struct object_id *oid,
271 const struct object_id **parents_oid, int nparent,
272 struct strbuf *base, struct diff_options *opt);
273 extern int diff_tree_oid(const struct object_id *old_oid,
274 const struct object_id *new_oid,
275 const char *base, struct diff_options *opt);
276 extern int diff_root_tree_oid(const struct object_id *new_oid, const char *base,
277 struct diff_options *opt);
278
279 struct combine_diff_path {
280 struct combine_diff_path *next;
281 char *path;
282 unsigned int mode;
283 struct object_id oid;
284 struct combine_diff_parent {
285 char status;
286 unsigned int mode;
287 struct object_id oid;
288 } parent[FLEX_ARRAY];
289 };
290 #define combine_diff_path_size(n, l) \
291 st_add4(sizeof(struct combine_diff_path), (l), 1, \
292 st_mult(sizeof(struct combine_diff_parent), (n)))
293
294 extern void show_combined_diff(struct combine_diff_path *elem, int num_parent,
295 int dense, struct rev_info *);
296
297 extern void diff_tree_combined(const struct object_id *oid, const struct oid_array *parents, int dense, struct rev_info *rev);
298
299 extern void diff_tree_combined_merge(const struct commit *commit, int dense, struct rev_info *rev);
300
301 void diff_set_mnemonic_prefix(struct diff_options *options, const char *a, const char *b);
302
303 extern int diff_can_quit_early(struct diff_options *);
304
305 extern void diff_addremove(struct diff_options *,
306 int addremove,
307 unsigned mode,
308 const struct object_id *oid,
309 int oid_valid,
310 const char *fullpath, unsigned dirty_submodule);
311
312 extern void diff_change(struct diff_options *,
313 unsigned mode1, unsigned mode2,
314 const struct object_id *old_oid,
315 const struct object_id *new_oid,
316 int old_oid_valid, int new_oid_valid,
317 const char *fullpath,
318 unsigned dirty_submodule1, unsigned dirty_submodule2);
319
320 extern struct diff_filepair *diff_unmerge(struct diff_options *, const char *path);
321
322 #define DIFF_SETUP_REVERSE 1
323 #define DIFF_SETUP_USE_CACHE 2
324 #define DIFF_SETUP_USE_SIZE_CACHE 4
325
326 /*
327 * Poor man's alternative to parse-option, to allow both stuck form
328 * (--option=value) and separate form (--option value).
329 */
330 extern int parse_long_opt(const char *opt, const char **argv,
331 const char **optarg);
332
333 extern int git_diff_basic_config(const char *var, const char *value, void *cb);
334 extern int git_diff_heuristic_config(const char *var, const char *value, void *cb);
335 extern void init_diff_ui_defaults(void);
336 extern int git_diff_ui_config(const char *var, const char *value, void *cb);
337 extern void diff_setup(struct diff_options *);
338 extern int diff_opt_parse(struct diff_options *, const char **, int, const char *);
339 extern void diff_setup_done(struct diff_options *);
340 extern int git_config_rename(const char *var, const char *value);
341
342 #define DIFF_DETECT_RENAME 1
343 #define DIFF_DETECT_COPY 2
344
345 #define DIFF_PICKAXE_ALL 1
346 #define DIFF_PICKAXE_REGEX 2
347
348 #define DIFF_PICKAXE_KIND_S 4 /* traditional plumbing counter */
349 #define DIFF_PICKAXE_KIND_G 8 /* grep in the patch */
350 #define DIFF_PICKAXE_KIND_OBJFIND 16 /* specific object IDs */
351
352 #define DIFF_PICKAXE_KINDS_MASK (DIFF_PICKAXE_KIND_S | \
353 DIFF_PICKAXE_KIND_G | \
354 DIFF_PICKAXE_KIND_OBJFIND)
355
356 #define DIFF_PICKAXE_IGNORE_CASE 32
357
358 extern void diffcore_std(struct diff_options *);
359 extern void diffcore_fix_diff_index(struct diff_options *);
360
361 #define COMMON_DIFF_OPTIONS_HELP \
362 "\ncommon diff options:\n" \
363 " -z output diff-raw with lines terminated with NUL.\n" \
364 " -p output patch format.\n" \
365 " -u synonym for -p.\n" \
366 " --patch-with-raw\n" \
367 " output both a patch and the diff-raw format.\n" \
368 " --stat show diffstat instead of patch.\n" \
369 " --numstat show numeric diffstat instead of patch.\n" \
370 " --patch-with-stat\n" \
371 " output a patch and prepend its diffstat.\n" \
372 " --name-only show only names of changed files.\n" \
373 " --name-status show names and status of changed files.\n" \
374 " --full-index show full object name on index lines.\n" \
375 " --abbrev=<n> abbreviate object names in diff-tree header and diff-raw.\n" \
376 " -R swap input file pairs.\n" \
377 " -B detect complete rewrites.\n" \
378 " -M detect renames.\n" \
379 " -C detect copies.\n" \
380 " --find-copies-harder\n" \
381 " try unchanged files as candidate for copy detection.\n" \
382 " -l<n> limit rename attempts up to <n> paths.\n" \
383 " -O<file> reorder diffs according to the <file>.\n" \
384 " -S<string> find filepair whose only one side contains the string.\n" \
385 " --pickaxe-all\n" \
386 " show all files diff when -S is used and hit is found.\n" \
387 " -a --text treat all files as text.\n"
388
389 extern int diff_queue_is_empty(void);
390 extern void diff_flush(struct diff_options*);
391 extern void diff_warn_rename_limit(const char *varname, int needed, int degraded_cc);
392
393 /* diff-raw status letters */
394 #define DIFF_STATUS_ADDED 'A'
395 #define DIFF_STATUS_COPIED 'C'
396 #define DIFF_STATUS_DELETED 'D'
397 #define DIFF_STATUS_MODIFIED 'M'
398 #define DIFF_STATUS_RENAMED 'R'
399 #define DIFF_STATUS_TYPE_CHANGED 'T'
400 #define DIFF_STATUS_UNKNOWN 'X'
401 #define DIFF_STATUS_UNMERGED 'U'
402
403 /* these are not diff-raw status letters proper, but used by
404 * diffcore-filter insn to specify additional restrictions.
405 */
406 #define DIFF_STATUS_FILTER_AON '*'
407 #define DIFF_STATUS_FILTER_BROKEN 'B'
408
409 /*
410 * This is different from find_unique_abbrev() in that
411 * it stuffs the result with dots for alignment.
412 */
413 extern const char *diff_aligned_abbrev(const struct object_id *sha1, int);
414
415 /* do not report anything on removed paths */
416 #define DIFF_SILENT_ON_REMOVED 01
417 /* report racily-clean paths as modified */
418 #define DIFF_RACY_IS_MODIFIED 02
419 extern int run_diff_files(struct rev_info *revs, unsigned int option);
420 extern int run_diff_index(struct rev_info *revs, int cached);
421
422 extern int do_diff_cache(const struct object_id *, struct diff_options *);
423 extern int diff_flush_patch_id(struct diff_options *, struct object_id *, int);
424
425 extern int diff_result_code(struct diff_options *, int);
426
427 extern void diff_no_index(struct rev_info *, int, const char **);
428
429 extern int index_differs_from(const char *def, const struct diff_flags *flags,
430 int ita_invisible_in_index);
431
432 /*
433 * Fill the contents of the filespec "df", respecting any textconv defined by
434 * its userdiff driver. The "driver" parameter must come from a
435 * previous call to get_textconv(), and therefore should either be NULL or have
436 * textconv enabled.
437 *
438 * Note that the memory ownership of the resulting buffer depends on whether
439 * the driver field is NULL. If it is, then the memory belongs to the filespec
440 * struct. If it is non-NULL, then "outbuf" points to a newly allocated buffer
441 * that should be freed by the caller.
442 */
443 extern size_t fill_textconv(struct userdiff_driver *driver,
444 struct diff_filespec *df,
445 char **outbuf);
446
447 /*
448 * Look up the userdiff driver for the given filespec, and return it if
449 * and only if it has textconv enabled (otherwise return NULL). The result
450 * can be passed to fill_textconv().
451 */
452 extern struct userdiff_driver *get_textconv(struct diff_filespec *one);
453
454 /*
455 * Prepare diff_filespec and convert it using diff textconv API
456 * if the textconv driver exists.
457 * Return 1 if the conversion succeeds, 0 otherwise.
458 */
459 extern int textconv_object(const char *path, unsigned mode, const struct object_id *oid, int oid_valid, char **buf, unsigned long *buf_size);
460
461 extern int parse_rename_score(const char **cp_p);
462
463 extern long parse_algorithm_value(const char *value);
464
465 extern void print_stat_summary(FILE *fp, int files,
466 int insertions, int deletions);
467 extern void setup_diff_pager(struct diff_options *);
468
469 #endif /* DIFF_H */