Ninth batch
[git.git] / diff.h
blob7f8f024febc52e954aa06f2f2c52d954aa2d4eb2
1 /*
2 * Copyright (C) 2005 Junio C Hamano
3 */
4 #ifndef DIFF_H
5 #define DIFF_H
7 #include "tree-walk.h"
8 #include "pathspec.h"
9 #include "object.h"
10 #include "oidset.h"
12 struct combine_diff_path;
13 struct commit;
14 struct diff_filespec;
15 struct diff_options;
16 struct diff_queue_struct;
17 struct oid_array;
18 struct option;
19 struct repository;
20 struct rev_info;
21 struct strbuf;
22 struct userdiff_driver;
24 typedef int (*pathchange_fn_t)(struct diff_options *options,
25 struct combine_diff_path *path);
27 typedef void (*change_fn_t)(struct diff_options *options,
28 unsigned old_mode, unsigned new_mode,
29 const struct object_id *old_oid,
30 const struct object_id *new_oid,
31 int old_oid_valid, int new_oid_valid,
32 const char *fullpath,
33 unsigned old_dirty_submodule, unsigned new_dirty_submodule);
35 typedef void (*add_remove_fn_t)(struct diff_options *options,
36 int addremove, unsigned mode,
37 const struct object_id *oid,
38 int oid_valid,
39 const char *fullpath, unsigned dirty_submodule);
41 typedef void (*diff_format_fn_t)(struct diff_queue_struct *q,
42 struct diff_options *options, void *data);
44 typedef struct strbuf *(*diff_prefix_fn_t)(struct diff_options *opt, void *data);
46 #define DIFF_FORMAT_RAW 0x0001
47 #define DIFF_FORMAT_DIFFSTAT 0x0002
48 #define DIFF_FORMAT_NUMSTAT 0x0004
49 #define DIFF_FORMAT_SUMMARY 0x0008
50 #define DIFF_FORMAT_PATCH 0x0010
51 #define DIFF_FORMAT_SHORTSTAT 0x0020
52 #define DIFF_FORMAT_DIRSTAT 0x0040
54 /* These override all above */
55 #define DIFF_FORMAT_NAME 0x0100
56 #define DIFF_FORMAT_NAME_STATUS 0x0200
57 #define DIFF_FORMAT_CHECKDIFF 0x0400
59 /* Same as output_format = 0 but we know that -s flag was given
60 * and we should not give default value to output_format.
62 #define DIFF_FORMAT_NO_OUTPUT 0x0800
64 #define DIFF_FORMAT_CALLBACK 0x1000
66 #define DIFF_FLAGS_INIT { 0 }
67 struct diff_flags {
68 unsigned recursive;
69 unsigned tree_in_recursive;
70 unsigned binary;
71 unsigned text;
72 unsigned full_index;
73 unsigned silent_on_remove;
74 unsigned find_copies_harder;
75 unsigned follow_renames;
76 unsigned rename_empty;
77 unsigned has_changes;
78 unsigned quick;
79 unsigned no_index;
80 unsigned allow_external;
81 unsigned exit_with_status;
82 unsigned reverse_diff;
83 unsigned check_failed;
84 unsigned relative_name;
85 unsigned ignore_submodules;
86 unsigned dirstat_cumulative;
87 unsigned dirstat_by_file;
88 unsigned allow_textconv;
89 unsigned textconv_set_via_cmdline;
90 unsigned diff_from_contents;
91 unsigned dirty_submodules;
92 unsigned ignore_untracked_in_submodules;
93 unsigned ignore_dirty_submodules;
94 unsigned override_submodule_config;
95 unsigned dirstat_by_line;
96 unsigned funccontext;
97 unsigned default_follow_renames;
98 unsigned stat_with_summary;
99 unsigned suppress_diff_headers;
100 unsigned dual_color_diffed_diffs;
101 unsigned suppress_hunk_header_line_count;
104 static inline void diff_flags_or(struct diff_flags *a,
105 const struct diff_flags *b)
107 char *tmp_a = (char *)a;
108 const char *tmp_b = (const char *)b;
109 int i;
111 for (i = 0; i < sizeof(struct diff_flags); i++)
112 tmp_a[i] |= tmp_b[i];
115 #define DIFF_XDL_TST(opts, flag) ((opts)->xdl_opts & XDF_##flag)
116 #define DIFF_XDL_SET(opts, flag) ((opts)->xdl_opts |= XDF_##flag)
117 #define DIFF_XDL_CLR(opts, flag) ((opts)->xdl_opts &= ~XDF_##flag)
119 #define DIFF_WITH_ALG(opts, flag) (((opts)->xdl_opts & ~XDF_DIFF_ALGORITHM_MASK) | XDF_##flag)
121 enum diff_words_type {
122 DIFF_WORDS_NONE = 0,
123 DIFF_WORDS_PORCELAIN,
124 DIFF_WORDS_PLAIN,
125 DIFF_WORDS_COLOR
128 enum diff_submodule_format {
129 DIFF_SUBMODULE_SHORT = 0,
130 DIFF_SUBMODULE_LOG,
131 DIFF_SUBMODULE_INLINE_DIFF
134 struct diff_options {
135 const char *orderfile;
136 const char *pickaxe;
137 const char *single_follow;
138 const char *a_prefix, *b_prefix;
139 const char *line_prefix;
140 size_t line_prefix_length;
141 struct diff_flags flags;
143 /* diff-filter bits */
144 unsigned int filter;
146 int use_color;
147 int context;
148 int interhunkcontext;
149 int break_opt;
150 int detect_rename;
151 int irreversible_delete;
152 int skip_stat_unmatch;
153 int line_termination;
154 int output_format;
155 unsigned pickaxe_opts;
156 int rename_score;
157 int rename_limit;
158 int needed_rename_limit;
159 int degraded_cc_to_c;
160 int show_rename_progress;
161 int dirstat_permille;
162 int setup;
163 int abbrev;
164 int ita_invisible_in_index;
165 /* white-space error highlighting */
166 #define WSEH_NEW (1<<12)
167 #define WSEH_CONTEXT (1<<13)
168 #define WSEH_OLD (1<<14)
169 unsigned ws_error_highlight;
170 const char *prefix;
171 int prefix_length;
172 const char *stat_sep;
173 int xdl_opts;
175 /* see Documentation/diff-options.txt */
176 char **anchors;
177 size_t anchors_nr, anchors_alloc;
179 int stat_width;
180 int stat_name_width;
181 int stat_graph_width;
182 int stat_count;
183 const char *word_regex;
184 enum diff_words_type word_diff;
185 enum diff_submodule_format submodule_format;
187 struct oidset *objfind;
189 /* this is set by diffcore for DIFF_FORMAT_PATCH */
190 int found_changes;
192 /* to support internal diff recursion by --follow hack*/
193 int found_follow;
195 void (*set_default)(struct diff_options *);
197 FILE *file;
198 int close_file;
200 #define OUTPUT_INDICATOR_NEW 0
201 #define OUTPUT_INDICATOR_OLD 1
202 #define OUTPUT_INDICATOR_CONTEXT 2
203 char output_indicators[3];
205 struct pathspec pathspec;
206 pathchange_fn_t pathchange;
207 change_fn_t change;
208 add_remove_fn_t add_remove;
209 void *change_fn_data;
210 diff_format_fn_t format_callback;
211 void *format_callback_data;
212 diff_prefix_fn_t output_prefix;
213 void *output_prefix_data;
215 int diff_path_counter;
217 struct emitted_diff_symbols *emitted_symbols;
218 enum {
219 COLOR_MOVED_NO = 0,
220 COLOR_MOVED_PLAIN = 1,
221 COLOR_MOVED_BLOCKS = 2,
222 COLOR_MOVED_ZEBRA = 3,
223 COLOR_MOVED_ZEBRA_DIM = 4,
224 } color_moved;
225 #define COLOR_MOVED_DEFAULT COLOR_MOVED_ZEBRA
226 #define COLOR_MOVED_MIN_ALNUM_COUNT 20
228 /* XDF_WHITESPACE_FLAGS regarding block detection are set at 2, 3, 4 */
229 #define COLOR_MOVED_WS_ALLOW_INDENTATION_CHANGE (1<<5)
230 #define COLOR_MOVED_WS_ERROR (1<<0)
231 unsigned color_moved_ws_handling;
233 struct repository *repo;
234 struct option *parseopts;
237 unsigned diff_filter_bit(char status);
239 void diff_emit_submodule_del(struct diff_options *o, const char *line);
240 void diff_emit_submodule_add(struct diff_options *o, const char *line);
241 void diff_emit_submodule_untracked(struct diff_options *o, const char *path);
242 void diff_emit_submodule_modified(struct diff_options *o, const char *path);
243 void diff_emit_submodule_header(struct diff_options *o, const char *header);
244 void diff_emit_submodule_error(struct diff_options *o, const char *err);
245 void diff_emit_submodule_pipethrough(struct diff_options *o,
246 const char *line, int len);
248 enum color_diff {
249 DIFF_RESET = 0,
250 DIFF_CONTEXT = 1,
251 DIFF_METAINFO = 2,
252 DIFF_FRAGINFO = 3,
253 DIFF_FILE_OLD = 4,
254 DIFF_FILE_NEW = 5,
255 DIFF_COMMIT = 6,
256 DIFF_WHITESPACE = 7,
257 DIFF_FUNCINFO = 8,
258 DIFF_FILE_OLD_MOVED = 9,
259 DIFF_FILE_OLD_MOVED_ALT = 10,
260 DIFF_FILE_OLD_MOVED_DIM = 11,
261 DIFF_FILE_OLD_MOVED_ALT_DIM = 12,
262 DIFF_FILE_NEW_MOVED = 13,
263 DIFF_FILE_NEW_MOVED_ALT = 14,
264 DIFF_FILE_NEW_MOVED_DIM = 15,
265 DIFF_FILE_NEW_MOVED_ALT_DIM = 16,
266 DIFF_CONTEXT_DIM = 17,
267 DIFF_FILE_OLD_DIM = 18,
268 DIFF_FILE_NEW_DIM = 19,
269 DIFF_CONTEXT_BOLD = 20,
270 DIFF_FILE_OLD_BOLD = 21,
271 DIFF_FILE_NEW_BOLD = 22,
273 const char *diff_get_color(int diff_use_color, enum color_diff ix);
274 #define diff_get_color_opt(o, ix) \
275 diff_get_color((o)->use_color, ix)
278 const char *diff_line_prefix(struct diff_options *);
281 extern const char mime_boundary_leader[];
283 struct combine_diff_path *diff_tree_paths(
284 struct combine_diff_path *p, const struct object_id *oid,
285 const struct object_id **parents_oid, int nparent,
286 struct strbuf *base, struct diff_options *opt);
287 int diff_tree_oid(const struct object_id *old_oid,
288 const struct object_id *new_oid,
289 const char *base, struct diff_options *opt);
290 int diff_root_tree_oid(const struct object_id *new_oid, const char *base,
291 struct diff_options *opt);
293 struct combine_diff_path {
294 struct combine_diff_path *next;
295 char *path;
296 unsigned int mode;
297 struct object_id oid;
298 struct combine_diff_parent {
299 char status;
300 unsigned int mode;
301 struct object_id oid;
302 struct strbuf path;
303 } parent[FLEX_ARRAY];
305 #define combine_diff_path_size(n, l) \
306 st_add4(sizeof(struct combine_diff_path), (l), 1, \
307 st_mult(sizeof(struct combine_diff_parent), (n)))
309 void show_combined_diff(struct combine_diff_path *elem, int num_parent,
310 int dense, struct rev_info *);
312 void diff_tree_combined(const struct object_id *oid, const struct oid_array *parents, int dense, struct rev_info *rev);
314 void diff_tree_combined_merge(const struct commit *commit, int dense, struct rev_info *rev);
316 void diff_set_mnemonic_prefix(struct diff_options *options, const char *a, const char *b);
318 int diff_can_quit_early(struct diff_options *);
320 void diff_addremove(struct diff_options *,
321 int addremove,
322 unsigned mode,
323 const struct object_id *oid,
324 int oid_valid,
325 const char *fullpath, unsigned dirty_submodule);
327 void diff_change(struct diff_options *,
328 unsigned mode1, unsigned mode2,
329 const struct object_id *old_oid,
330 const struct object_id *new_oid,
331 int old_oid_valid, int new_oid_valid,
332 const char *fullpath,
333 unsigned dirty_submodule1, unsigned dirty_submodule2);
335 struct diff_filepair *diff_unmerge(struct diff_options *, const char *path);
337 #define DIFF_SETUP_REVERSE 1
338 #define DIFF_SETUP_USE_SIZE_CACHE 4
341 * Poor man's alternative to parse-option, to allow both stuck form
342 * (--option=value) and separate form (--option value).
344 int parse_long_opt(const char *opt, const char **argv,
345 const char **optarg);
347 int git_diff_basic_config(const char *var, const char *value, void *cb);
348 int git_diff_heuristic_config(const char *var, const char *value, void *cb);
349 void init_diff_ui_defaults(void);
350 int git_diff_ui_config(const char *var, const char *value, void *cb);
351 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
352 #define diff_setup(diffopts) repo_diff_setup(the_repository, diffopts)
353 #endif
354 void repo_diff_setup(struct repository *, struct diff_options *);
355 int diff_opt_parse(struct diff_options *, const char **, int, const char *);
356 void diff_setup_done(struct diff_options *);
357 int git_config_rename(const char *var, const char *value);
359 #define DIFF_DETECT_RENAME 1
360 #define DIFF_DETECT_COPY 2
362 #define DIFF_PICKAXE_ALL 1
363 #define DIFF_PICKAXE_REGEX 2
365 #define DIFF_PICKAXE_KIND_S 4 /* traditional plumbing counter */
366 #define DIFF_PICKAXE_KIND_G 8 /* grep in the patch */
367 #define DIFF_PICKAXE_KIND_OBJFIND 16 /* specific object IDs */
369 #define DIFF_PICKAXE_KINDS_MASK (DIFF_PICKAXE_KIND_S | \
370 DIFF_PICKAXE_KIND_G | \
371 DIFF_PICKAXE_KIND_OBJFIND)
373 #define DIFF_PICKAXE_IGNORE_CASE 32
375 void diffcore_std(struct diff_options *);
376 void diffcore_fix_diff_index(void);
378 #define COMMON_DIFF_OPTIONS_HELP \
379 "\ncommon diff options:\n" \
380 " -z output diff-raw with lines terminated with NUL.\n" \
381 " -p output patch format.\n" \
382 " -u synonym for -p.\n" \
383 " --patch-with-raw\n" \
384 " output both a patch and the diff-raw format.\n" \
385 " --stat show diffstat instead of patch.\n" \
386 " --numstat show numeric diffstat instead of patch.\n" \
387 " --patch-with-stat\n" \
388 " output a patch and prepend its diffstat.\n" \
389 " --name-only show only names of changed files.\n" \
390 " --name-status show names and status of changed files.\n" \
391 " --full-index show full object name on index lines.\n" \
392 " --abbrev=<n> abbreviate object names in diff-tree header and diff-raw.\n" \
393 " -R swap input file pairs.\n" \
394 " -B detect complete rewrites.\n" \
395 " -M detect renames.\n" \
396 " -C detect copies.\n" \
397 " --find-copies-harder\n" \
398 " try unchanged files as candidate for copy detection.\n" \
399 " -l<n> limit rename attempts up to <n> paths.\n" \
400 " -O<file> reorder diffs according to the <file>.\n" \
401 " -S<string> find filepair whose only one side contains the string.\n" \
402 " --pickaxe-all\n" \
403 " show all files diff when -S is used and hit is found.\n" \
404 " -a --text treat all files as text.\n"
406 int diff_queue_is_empty(void);
407 void diff_flush(struct diff_options*);
408 void diff_warn_rename_limit(const char *varname, int needed, int degraded_cc);
410 /* diff-raw status letters */
411 #define DIFF_STATUS_ADDED 'A'
412 #define DIFF_STATUS_COPIED 'C'
413 #define DIFF_STATUS_DELETED 'D'
414 #define DIFF_STATUS_MODIFIED 'M'
415 #define DIFF_STATUS_RENAMED 'R'
416 #define DIFF_STATUS_TYPE_CHANGED 'T'
417 #define DIFF_STATUS_UNKNOWN 'X'
418 #define DIFF_STATUS_UNMERGED 'U'
420 /* these are not diff-raw status letters proper, but used by
421 * diffcore-filter insn to specify additional restrictions.
423 #define DIFF_STATUS_FILTER_AON '*'
424 #define DIFF_STATUS_FILTER_BROKEN 'B'
427 * This is different from find_unique_abbrev() in that
428 * it stuffs the result with dots for alignment.
430 const char *diff_aligned_abbrev(const struct object_id *sha1, int);
432 /* do not report anything on removed paths */
433 #define DIFF_SILENT_ON_REMOVED 01
434 /* report racily-clean paths as modified */
435 #define DIFF_RACY_IS_MODIFIED 02
436 int run_diff_files(struct rev_info *revs, unsigned int option);
437 int run_diff_index(struct rev_info *revs, int cached);
439 int do_diff_cache(const struct object_id *, struct diff_options *);
440 int diff_flush_patch_id(struct diff_options *, struct object_id *, int, int);
441 void flush_one_hunk(struct object_id *result, git_hash_ctx *ctx);
443 int diff_result_code(struct diff_options *, int);
445 int diff_no_index(struct rev_info *,
446 int implicit_no_index, int, const char **);
448 int index_differs_from(struct repository *r, const char *def,
449 const struct diff_flags *flags,
450 int ita_invisible_in_index);
453 * Fill the contents of the filespec "df", respecting any textconv defined by
454 * its userdiff driver. The "driver" parameter must come from a
455 * previous call to get_textconv(), and therefore should either be NULL or have
456 * textconv enabled.
458 * Note that the memory ownership of the resulting buffer depends on whether
459 * the driver field is NULL. If it is, then the memory belongs to the filespec
460 * struct. If it is non-NULL, then "outbuf" points to a newly allocated buffer
461 * that should be freed by the caller.
463 size_t fill_textconv(struct repository *r,
464 struct userdiff_driver *driver,
465 struct diff_filespec *df,
466 char **outbuf);
469 * Look up the userdiff driver for the given filespec, and return it if
470 * and only if it has textconv enabled (otherwise return NULL). The result
471 * can be passed to fill_textconv().
473 struct userdiff_driver *get_textconv(struct repository *r,
474 struct diff_filespec *one);
477 * Prepare diff_filespec and convert it using diff textconv API
478 * if the textconv driver exists.
479 * Return 1 if the conversion succeeds, 0 otherwise.
481 int textconv_object(struct repository *repo,
482 const char *path,
483 unsigned mode,
484 const struct object_id *oid, int oid_valid,
485 char **buf, unsigned long *buf_size);
487 int parse_rename_score(const char **cp_p);
489 long parse_algorithm_value(const char *value);
491 void print_stat_summary(FILE *fp, int files,
492 int insertions, int deletions);
493 void setup_diff_pager(struct diff_options *);
495 #endif /* DIFF_H */