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
11struct rev_info;
12struct diff_options;
13struct diff_queue_struct;
14struct strbuf;
15struct diff_filespec;
16struct userdiff_driver;
17struct oid_array;
18struct commit;
19struct combine_diff_path;
20
21typedef int (*pathchange_fn_t)(struct diff_options *options,
22 struct combine_diff_path *path);
23
24typedef void (*change_fn_t)(struct diff_options *options,
25 unsigned old_mode, unsigned new_mode,
26 const struct object_id *old_oid,
27 const struct object_id *new_oid,
28 int old_oid_valid, int new_oid_valid,
29 const char *fullpath,
30 unsigned old_dirty_submodule, unsigned new_dirty_submodule);
31
32typedef void (*add_remove_fn_t)(struct diff_options *options,
33 int addremove, unsigned mode,
34 const struct object_id *oid,
35 int oid_valid,
36 const char *fullpath, unsigned dirty_submodule);
37
38typedef void (*diff_format_fn_t)(struct diff_queue_struct *q,
39 struct diff_options *options, void *data);
40
41typedef struct strbuf *(*diff_prefix_fn_t)(struct diff_options *opt, void *data);
42
43#define DIFF_FORMAT_RAW 0x0001
44#define DIFF_FORMAT_DIFFSTAT 0x0002
45#define DIFF_FORMAT_NUMSTAT 0x0004
46#define DIFF_FORMAT_SUMMARY 0x0008
47#define DIFF_FORMAT_PATCH 0x0010
48#define DIFF_FORMAT_SHORTSTAT 0x0020
49#define DIFF_FORMAT_DIRSTAT 0x0040
50
51/* These override all above */
52#define DIFF_FORMAT_NAME 0x0100
53#define DIFF_FORMAT_NAME_STATUS 0x0200
54#define DIFF_FORMAT_CHECKDIFF 0x0400
55
56/* Same as output_format = 0 but we know that -s flag was given
57 * and we should not give default value to output_format.
58 */
59#define DIFF_FORMAT_NO_OUTPUT 0x0800
60
61#define DIFF_FORMAT_CALLBACK 0x1000
62
63#define DIFF_FLAGS_INIT { 0 }
64struct diff_flags {
65 unsigned RECURSIVE:1;
66 unsigned TREE_IN_RECURSIVE:1;
67 unsigned BINARY:1;
68 unsigned TEXT:1;
69 unsigned FULL_INDEX:1;
70 unsigned SILENT_ON_REMOVE:1;
71 unsigned FIND_COPIES_HARDER:1;
72 unsigned FOLLOW_RENAMES:1;
73 unsigned RENAME_EMPTY:1;
74 unsigned HAS_CHANGES:1;
75 unsigned QUICK:1;
76 unsigned NO_INDEX:1;
77 unsigned ALLOW_EXTERNAL:1;
78 unsigned EXIT_WITH_STATUS:1;
79 unsigned REVERSE_DIFF:1;
80 unsigned CHECK_FAILED:1;
81 unsigned RELATIVE_NAME:1;
82 unsigned IGNORE_SUBMODULES:1;
83 unsigned DIRSTAT_CUMULATIVE:1;
84 unsigned DIRSTAT_BY_FILE:1;
85 unsigned ALLOW_TEXTCONV:1;
86 unsigned TEXTCONV_SET_VIA_CMDLINE:1;
87 unsigned DIFF_FROM_CONTENTS:1;
88 unsigned DIRTY_SUBMODULES:1;
89 unsigned IGNORE_UNTRACKED_IN_SUBMODULES:1;
90 unsigned IGNORE_DIRTY_SUBMODULES:1;
91 unsigned OVERRIDE_SUBMODULE_CONFIG:1;
92 unsigned DIRSTAT_BY_LINE:1;
93 unsigned FUNCCONTEXT:1;
94 unsigned PICKAXE_IGNORE_CASE:1;
95 unsigned DEFAULT_FOLLOW_RENAMES:1;
96};
97
98static inline void diff_flags_or(struct diff_flags *a,
99 const struct diff_flags *b)
100{
101 char *tmp_a = (char *)a;
102 const char *tmp_b = (const char *)b;
103 int i;
104
105 for (i = 0; i < sizeof(struct diff_flags); i++)
106 tmp_a[i] |= tmp_b[i];
107}
108
109#define DIFF_OPT_CLR(opts, flag) ((opts)->flags.flag = 0)
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 int 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 int stat_width;
172 int stat_name_width;
173 int stat_graph_width;
174 int stat_count;
175 const char *word_regex;
176 enum diff_words_type word_diff;
177 enum diff_submodule_format submodule_format;
178
179 /* this is set by diffcore for DIFF_FORMAT_PATCH */
180 int found_changes;
181
182 /* to support internal diff recursion by --follow hack*/
183 int found_follow;
184
185 void (*set_default)(struct diff_options *);
186
187 FILE *file;
188 int close_file;
189
190 struct pathspec pathspec;
191 pathchange_fn_t pathchange;
192 change_fn_t change;
193 add_remove_fn_t add_remove;
194 diff_format_fn_t format_callback;
195 void *format_callback_data;
196 diff_prefix_fn_t output_prefix;
197 void *output_prefix_data;
198
199 int diff_path_counter;
200
201 struct emitted_diff_symbols *emitted_symbols;
202 enum {
203 COLOR_MOVED_NO = 0,
204 COLOR_MOVED_PLAIN = 1,
205 COLOR_MOVED_ZEBRA = 2,
206 COLOR_MOVED_ZEBRA_DIM = 3,
207 } color_moved;
208 #define COLOR_MOVED_DEFAULT COLOR_MOVED_ZEBRA
209 #define COLOR_MOVED_MIN_ALNUM_COUNT 20
210};
211
212void diff_emit_submodule_del(struct diff_options *o, const char *line);
213void diff_emit_submodule_add(struct diff_options *o, const char *line);
214void diff_emit_submodule_untracked(struct diff_options *o, const char *path);
215void diff_emit_submodule_modified(struct diff_options *o, const char *path);
216void diff_emit_submodule_header(struct diff_options *o, const char *header);
217void diff_emit_submodule_error(struct diff_options *o, const char *err);
218void diff_emit_submodule_pipethrough(struct diff_options *o,
219 const char *line, int len);
220
221enum color_diff {
222 DIFF_RESET = 0,
223 DIFF_CONTEXT = 1,
224 DIFF_METAINFO = 2,
225 DIFF_FRAGINFO = 3,
226 DIFF_FILE_OLD = 4,
227 DIFF_FILE_NEW = 5,
228 DIFF_COMMIT = 6,
229 DIFF_WHITESPACE = 7,
230 DIFF_FUNCINFO = 8,
231 DIFF_FILE_OLD_MOVED = 9,
232 DIFF_FILE_OLD_MOVED_ALT = 10,
233 DIFF_FILE_OLD_MOVED_DIM = 11,
234 DIFF_FILE_OLD_MOVED_ALT_DIM = 12,
235 DIFF_FILE_NEW_MOVED = 13,
236 DIFF_FILE_NEW_MOVED_ALT = 14,
237 DIFF_FILE_NEW_MOVED_DIM = 15,
238 DIFF_FILE_NEW_MOVED_ALT_DIM = 16
239};
240const char *diff_get_color(int diff_use_color, enum color_diff ix);
241#define diff_get_color_opt(o, ix) \
242 diff_get_color((o)->use_color, ix)
243
244
245const char *diff_line_prefix(struct diff_options *);
246
247
248extern const char mime_boundary_leader[];
249
250extern struct combine_diff_path *diff_tree_paths(
251 struct combine_diff_path *p, const struct object_id *oid,
252 const struct object_id **parents_oid, int nparent,
253 struct strbuf *base, struct diff_options *opt);
254extern int diff_tree_oid(const struct object_id *old_oid,
255 const struct object_id *new_oid,
256 const char *base, struct diff_options *opt);
257extern int diff_root_tree_oid(const struct object_id *new_oid, const char *base,
258 struct diff_options *opt);
259
260struct combine_diff_path {
261 struct combine_diff_path *next;
262 char *path;
263 unsigned int mode;
264 struct object_id oid;
265 struct combine_diff_parent {
266 char status;
267 unsigned int mode;
268 struct object_id oid;
269 } parent[FLEX_ARRAY];
270};
271#define combine_diff_path_size(n, l) \
272 st_add4(sizeof(struct combine_diff_path), (l), 1, \
273 st_mult(sizeof(struct combine_diff_parent), (n)))
274
275extern void show_combined_diff(struct combine_diff_path *elem, int num_parent,
276 int dense, struct rev_info *);
277
278extern void diff_tree_combined(const struct object_id *oid, const struct oid_array *parents, int dense, struct rev_info *rev);
279
280extern void diff_tree_combined_merge(const struct commit *commit, int dense, struct rev_info *rev);
281
282void diff_set_mnemonic_prefix(struct diff_options *options, const char *a, const char *b);
283
284extern int diff_can_quit_early(struct diff_options *);
285
286extern void diff_addremove(struct diff_options *,
287 int addremove,
288 unsigned mode,
289 const struct object_id *oid,
290 int oid_valid,
291 const char *fullpath, unsigned dirty_submodule);
292
293extern void diff_change(struct diff_options *,
294 unsigned mode1, unsigned mode2,
295 const struct object_id *old_oid,
296 const struct object_id *new_oid,
297 int old_oid_valid, int new_oid_valid,
298 const char *fullpath,
299 unsigned dirty_submodule1, unsigned dirty_submodule2);
300
301extern struct diff_filepair *diff_unmerge(struct diff_options *, const char *path);
302
303#define DIFF_SETUP_REVERSE 1
304#define DIFF_SETUP_USE_CACHE 2
305#define DIFF_SETUP_USE_SIZE_CACHE 4
306
307/*
308 * Poor man's alternative to parse-option, to allow both stuck form
309 * (--option=value) and separate form (--option value).
310 */
311extern int parse_long_opt(const char *opt, const char **argv,
312 const char **optarg);
313
314extern int git_diff_basic_config(const char *var, const char *value, void *cb);
315extern int git_diff_heuristic_config(const char *var, const char *value, void *cb);
316extern void init_diff_ui_defaults(void);
317extern int git_diff_ui_config(const char *var, const char *value, void *cb);
318extern void diff_setup(struct diff_options *);
319extern int diff_opt_parse(struct diff_options *, const char **, int, const char *);
320extern void diff_setup_done(struct diff_options *);
321
322#define DIFF_DETECT_RENAME 1
323#define DIFF_DETECT_COPY 2
324
325#define DIFF_PICKAXE_ALL 1
326#define DIFF_PICKAXE_REGEX 2
327
328#define DIFF_PICKAXE_KIND_S 4 /* traditional plumbing counter */
329#define DIFF_PICKAXE_KIND_G 8 /* grep in the patch */
330
331extern void diffcore_std(struct diff_options *);
332extern void diffcore_fix_diff_index(struct diff_options *);
333
334#define COMMON_DIFF_OPTIONS_HELP \
335"\ncommon diff options:\n" \
336" -z output diff-raw with lines terminated with NUL.\n" \
337" -p output patch format.\n" \
338" -u synonym for -p.\n" \
339" --patch-with-raw\n" \
340" output both a patch and the diff-raw format.\n" \
341" --stat show diffstat instead of patch.\n" \
342" --numstat show numeric diffstat instead of patch.\n" \
343" --patch-with-stat\n" \
344" output a patch and prepend its diffstat.\n" \
345" --name-only show only names of changed files.\n" \
346" --name-status show names and status of changed files.\n" \
347" --full-index show full object name on index lines.\n" \
348" --abbrev=<n> abbreviate object names in diff-tree header and diff-raw.\n" \
349" -R swap input file pairs.\n" \
350" -B detect complete rewrites.\n" \
351" -M detect renames.\n" \
352" -C detect copies.\n" \
353" --find-copies-harder\n" \
354" try unchanged files as candidate for copy detection.\n" \
355" -l<n> limit rename attempts up to <n> paths.\n" \
356" -O<file> reorder diffs according to the <file>.\n" \
357" -S<string> find filepair whose only one side contains the string.\n" \
358" --pickaxe-all\n" \
359" show all files diff when -S is used and hit is found.\n" \
360" -a --text treat all files as text.\n"
361
362extern int diff_queue_is_empty(void);
363extern void diff_flush(struct diff_options*);
364extern void diff_warn_rename_limit(const char *varname, int needed, int degraded_cc);
365
366/* diff-raw status letters */
367#define DIFF_STATUS_ADDED 'A'
368#define DIFF_STATUS_COPIED 'C'
369#define DIFF_STATUS_DELETED 'D'
370#define DIFF_STATUS_MODIFIED 'M'
371#define DIFF_STATUS_RENAMED 'R'
372#define DIFF_STATUS_TYPE_CHANGED 'T'
373#define DIFF_STATUS_UNKNOWN 'X'
374#define DIFF_STATUS_UNMERGED 'U'
375
376/* these are not diff-raw status letters proper, but used by
377 * diffcore-filter insn to specify additional restrictions.
378 */
379#define DIFF_STATUS_FILTER_AON '*'
380#define DIFF_STATUS_FILTER_BROKEN 'B'
381
382/*
383 * This is different from find_unique_abbrev() in that
384 * it stuffs the result with dots for alignment.
385 */
386extern const char *diff_aligned_abbrev(const struct object_id *sha1, int);
387
388/* do not report anything on removed paths */
389#define DIFF_SILENT_ON_REMOVED 01
390/* report racily-clean paths as modified */
391#define DIFF_RACY_IS_MODIFIED 02
392extern int run_diff_files(struct rev_info *revs, unsigned int option);
393extern int run_diff_index(struct rev_info *revs, int cached);
394
395extern int do_diff_cache(const struct object_id *, struct diff_options *);
396extern int diff_flush_patch_id(struct diff_options *, struct object_id *, int);
397
398extern int diff_result_code(struct diff_options *, int);
399
400extern void diff_no_index(struct rev_info *, int, const char **);
401
402extern int index_differs_from(const char *def, const struct diff_flags *flags,
403 int ita_invisible_in_index);
404
405/*
406 * Fill the contents of the filespec "df", respecting any textconv defined by
407 * its userdiff driver. The "driver" parameter must come from a
408 * previous call to get_textconv(), and therefore should either be NULL or have
409 * textconv enabled.
410 *
411 * Note that the memory ownership of the resulting buffer depends on whether
412 * the driver field is NULL. If it is, then the memory belongs to the filespec
413 * struct. If it is non-NULL, then "outbuf" points to a newly allocated buffer
414 * that should be freed by the caller.
415 */
416extern size_t fill_textconv(struct userdiff_driver *driver,
417 struct diff_filespec *df,
418 char **outbuf);
419
420/*
421 * Look up the userdiff driver for the given filespec, and return it if
422 * and only if it has textconv enabled (otherwise return NULL). The result
423 * can be passed to fill_textconv().
424 */
425extern struct userdiff_driver *get_textconv(struct diff_filespec *one);
426
427/*
428 * Prepare diff_filespec and convert it using diff textconv API
429 * if the textconv driver exists.
430 * Return 1 if the conversion succeeds, 0 otherwise.
431 */
432extern int textconv_object(const char *path, unsigned mode, const struct object_id *oid, int oid_valid, char **buf, unsigned long *buf_size);
433
434extern int parse_rename_score(const char **cp_p);
435
436extern long parse_algorithm_value(const char *value);
437
438extern void print_stat_summary(FILE *fp, int files,
439 int insertions, int deletions);
440extern void setup_diff_pager(struct diff_options *);
441
442#endif /* DIFF_H */