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