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