Merge branch 'jt/http-redact-cookies' into maint
[git.git] / diff.h
blob7cf276f07733afdf14618a8c47fce33c89a41e24
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"
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;
21 typedef int (*pathchange_fn_t)(struct diff_options *options,
22 struct combine_diff_path *path);
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);
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);
38 typedef void (*diff_format_fn_t)(struct diff_queue_struct *q,
39 struct diff_options *options, void *data);
41 typedef struct strbuf *(*diff_prefix_fn_t)(struct diff_options *opt, void *data);
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
51 /* These override all above */
52 #define DIFF_FORMAT_NAME 0x0100
53 #define DIFF_FORMAT_NAME_STATUS 0x0200
54 #define DIFF_FORMAT_CHECKDIFF 0x0400
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.
59 #define DIFF_FORMAT_NO_OUTPUT 0x0800
61 #define DIFF_FORMAT_CALLBACK 0x1000
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;
98 static inline void diff_flags_or(struct diff_flags *a,
99 const struct diff_flags *b)
101 char *tmp_a = (char *)a;
102 const char *tmp_b = (const char *)b;
103 int i;
105 for (i = 0; i < sizeof(struct diff_flags); i++)
106 tmp_a[i] |= tmp_b[i];
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)
113 #define DIFF_WITH_ALG(opts, flag) (((opts)->xdl_opts & ~XDF_DIFF_ALGORITHM_MASK) | XDF_##flag)
115 enum diff_words_type {
116 DIFF_WORDS_NONE = 0,
117 DIFF_WORDS_PORCELAIN,
118 DIFF_WORDS_PLAIN,
119 DIFF_WORDS_COLOR
122 enum diff_submodule_format {
123 DIFF_SUBMODULE_SHORT = 0,
124 DIFF_SUBMODULE_LOG,
125 DIFF_SUBMODULE_INLINE_DIFF
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;
137 /* diff-filter bits */
138 unsigned int filter;
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;
169 /* see Documentation/diff-options.txt */
170 char **anchors;
171 size_t anchors_nr, anchors_alloc;
173 int stat_width;
174 int stat_name_width;
175 int stat_graph_width;
176 int stat_count;
177 const char *word_regex;
178 enum diff_words_type word_diff;
179 enum diff_submodule_format submodule_format;
181 /* this is set by diffcore for DIFF_FORMAT_PATCH */
182 int found_changes;
184 /* to support internal diff recursion by --follow hack*/
185 int found_follow;
187 void (*set_default)(struct diff_options *);
189 FILE *file;
190 int close_file;
192 struct pathspec pathspec;
193 pathchange_fn_t pathchange;
194 change_fn_t change;
195 add_remove_fn_t add_remove;
196 void *change_fn_data;
197 diff_format_fn_t format_callback;
198 void *format_callback_data;
199 diff_prefix_fn_t output_prefix;
200 void *output_prefix_data;
202 int diff_path_counter;
204 struct emitted_diff_symbols *emitted_symbols;
205 enum {
206 COLOR_MOVED_NO = 0,
207 COLOR_MOVED_PLAIN = 1,
208 COLOR_MOVED_ZEBRA = 2,
209 COLOR_MOVED_ZEBRA_DIM = 3,
210 } color_moved;
211 #define COLOR_MOVED_DEFAULT COLOR_MOVED_ZEBRA
212 #define COLOR_MOVED_MIN_ALNUM_COUNT 20
215 void diff_emit_submodule_del(struct diff_options *o, const char *line);
216 void diff_emit_submodule_add(struct diff_options *o, const char *line);
217 void diff_emit_submodule_untracked(struct diff_options *o, const char *path);
218 void diff_emit_submodule_modified(struct diff_options *o, const char *path);
219 void diff_emit_submodule_header(struct diff_options *o, const char *header);
220 void diff_emit_submodule_error(struct diff_options *o, const char *err);
221 void diff_emit_submodule_pipethrough(struct diff_options *o,
222 const char *line, int len);
224 enum color_diff {
225 DIFF_RESET = 0,
226 DIFF_CONTEXT = 1,
227 DIFF_METAINFO = 2,
228 DIFF_FRAGINFO = 3,
229 DIFF_FILE_OLD = 4,
230 DIFF_FILE_NEW = 5,
231 DIFF_COMMIT = 6,
232 DIFF_WHITESPACE = 7,
233 DIFF_FUNCINFO = 8,
234 DIFF_FILE_OLD_MOVED = 9,
235 DIFF_FILE_OLD_MOVED_ALT = 10,
236 DIFF_FILE_OLD_MOVED_DIM = 11,
237 DIFF_FILE_OLD_MOVED_ALT_DIM = 12,
238 DIFF_FILE_NEW_MOVED = 13,
239 DIFF_FILE_NEW_MOVED_ALT = 14,
240 DIFF_FILE_NEW_MOVED_DIM = 15,
241 DIFF_FILE_NEW_MOVED_ALT_DIM = 16
243 const char *diff_get_color(int diff_use_color, enum color_diff ix);
244 #define diff_get_color_opt(o, ix) \
245 diff_get_color((o)->use_color, ix)
248 const char *diff_line_prefix(struct diff_options *);
251 extern const char mime_boundary_leader[];
253 extern struct combine_diff_path *diff_tree_paths(
254 struct combine_diff_path *p, const struct object_id *oid,
255 const struct object_id **parents_oid, int nparent,
256 struct strbuf *base, struct diff_options *opt);
257 extern int diff_tree_oid(const struct object_id *old_oid,
258 const struct object_id *new_oid,
259 const char *base, struct diff_options *opt);
260 extern int diff_root_tree_oid(const struct object_id *new_oid, const char *base,
261 struct diff_options *opt);
263 struct combine_diff_path {
264 struct combine_diff_path *next;
265 char *path;
266 unsigned int mode;
267 struct object_id oid;
268 struct combine_diff_parent {
269 char status;
270 unsigned int mode;
271 struct object_id oid;
272 } parent[FLEX_ARRAY];
274 #define combine_diff_path_size(n, l) \
275 st_add4(sizeof(struct combine_diff_path), (l), 1, \
276 st_mult(sizeof(struct combine_diff_parent), (n)))
278 extern void show_combined_diff(struct combine_diff_path *elem, int num_parent,
279 int dense, struct rev_info *);
281 extern void diff_tree_combined(const struct object_id *oid, const struct oid_array *parents, int dense, struct rev_info *rev);
283 extern void diff_tree_combined_merge(const struct commit *commit, int dense, struct rev_info *rev);
285 void diff_set_mnemonic_prefix(struct diff_options *options, const char *a, const char *b);
287 extern int diff_can_quit_early(struct diff_options *);
289 extern void diff_addremove(struct diff_options *,
290 int addremove,
291 unsigned mode,
292 const struct object_id *oid,
293 int oid_valid,
294 const char *fullpath, unsigned dirty_submodule);
296 extern void diff_change(struct diff_options *,
297 unsigned mode1, unsigned mode2,
298 const struct object_id *old_oid,
299 const struct object_id *new_oid,
300 int old_oid_valid, int new_oid_valid,
301 const char *fullpath,
302 unsigned dirty_submodule1, unsigned dirty_submodule2);
304 extern struct diff_filepair *diff_unmerge(struct diff_options *, const char *path);
306 #define DIFF_SETUP_REVERSE 1
307 #define DIFF_SETUP_USE_CACHE 2
308 #define DIFF_SETUP_USE_SIZE_CACHE 4
311 * Poor man's alternative to parse-option, to allow both stuck form
312 * (--option=value) and separate form (--option value).
314 extern int parse_long_opt(const char *opt, const char **argv,
315 const char **optarg);
317 extern int git_diff_basic_config(const char *var, const char *value, void *cb);
318 extern int git_diff_heuristic_config(const char *var, const char *value, void *cb);
319 extern void init_diff_ui_defaults(void);
320 extern int git_diff_ui_config(const char *var, const char *value, void *cb);
321 extern void diff_setup(struct diff_options *);
322 extern int diff_opt_parse(struct diff_options *, const char **, int, const char *);
323 extern void diff_setup_done(struct diff_options *);
325 #define DIFF_DETECT_RENAME 1
326 #define DIFF_DETECT_COPY 2
328 #define DIFF_PICKAXE_ALL 1
329 #define DIFF_PICKAXE_REGEX 2
331 #define DIFF_PICKAXE_KIND_S 4 /* traditional plumbing counter */
332 #define DIFF_PICKAXE_KIND_G 8 /* grep in the patch */
334 extern void diffcore_std(struct diff_options *);
335 extern void diffcore_fix_diff_index(struct diff_options *);
337 #define COMMON_DIFF_OPTIONS_HELP \
338 "\ncommon diff options:\n" \
339 " -z output diff-raw with lines terminated with NUL.\n" \
340 " -p output patch format.\n" \
341 " -u synonym for -p.\n" \
342 " --patch-with-raw\n" \
343 " output both a patch and the diff-raw format.\n" \
344 " --stat show diffstat instead of patch.\n" \
345 " --numstat show numeric diffstat instead of patch.\n" \
346 " --patch-with-stat\n" \
347 " output a patch and prepend its diffstat.\n" \
348 " --name-only show only names of changed files.\n" \
349 " --name-status show names and status of changed files.\n" \
350 " --full-index show full object name on index lines.\n" \
351 " --abbrev=<n> abbreviate object names in diff-tree header and diff-raw.\n" \
352 " -R swap input file pairs.\n" \
353 " -B detect complete rewrites.\n" \
354 " -M detect renames.\n" \
355 " -C detect copies.\n" \
356 " --find-copies-harder\n" \
357 " try unchanged files as candidate for copy detection.\n" \
358 " -l<n> limit rename attempts up to <n> paths.\n" \
359 " -O<file> reorder diffs according to the <file>.\n" \
360 " -S<string> find filepair whose only one side contains the string.\n" \
361 " --pickaxe-all\n" \
362 " show all files diff when -S is used and hit is found.\n" \
363 " -a --text treat all files as text.\n"
365 extern int diff_queue_is_empty(void);
366 extern void diff_flush(struct diff_options*);
367 extern void diff_warn_rename_limit(const char *varname, int needed, int degraded_cc);
369 /* diff-raw status letters */
370 #define DIFF_STATUS_ADDED 'A'
371 #define DIFF_STATUS_COPIED 'C'
372 #define DIFF_STATUS_DELETED 'D'
373 #define DIFF_STATUS_MODIFIED 'M'
374 #define DIFF_STATUS_RENAMED 'R'
375 #define DIFF_STATUS_TYPE_CHANGED 'T'
376 #define DIFF_STATUS_UNKNOWN 'X'
377 #define DIFF_STATUS_UNMERGED 'U'
379 /* these are not diff-raw status letters proper, but used by
380 * diffcore-filter insn to specify additional restrictions.
382 #define DIFF_STATUS_FILTER_AON '*'
383 #define DIFF_STATUS_FILTER_BROKEN 'B'
386 * This is different from find_unique_abbrev() in that
387 * it stuffs the result with dots for alignment.
389 extern const char *diff_aligned_abbrev(const struct object_id *sha1, int);
391 /* do not report anything on removed paths */
392 #define DIFF_SILENT_ON_REMOVED 01
393 /* report racily-clean paths as modified */
394 #define DIFF_RACY_IS_MODIFIED 02
395 extern int run_diff_files(struct rev_info *revs, unsigned int option);
396 extern int run_diff_index(struct rev_info *revs, int cached);
398 extern int do_diff_cache(const struct object_id *, struct diff_options *);
399 extern int diff_flush_patch_id(struct diff_options *, struct object_id *, int);
401 extern int diff_result_code(struct diff_options *, int);
403 extern void diff_no_index(struct rev_info *, int, const char **);
405 extern int index_differs_from(const char *def, const struct diff_flags *flags,
406 int ita_invisible_in_index);
409 * Fill the contents of the filespec "df", respecting any textconv defined by
410 * its userdiff driver. The "driver" parameter must come from a
411 * previous call to get_textconv(), and therefore should either be NULL or have
412 * textconv enabled.
414 * Note that the memory ownership of the resulting buffer depends on whether
415 * the driver field is NULL. If it is, then the memory belongs to the filespec
416 * struct. If it is non-NULL, then "outbuf" points to a newly allocated buffer
417 * that should be freed by the caller.
419 extern size_t fill_textconv(struct userdiff_driver *driver,
420 struct diff_filespec *df,
421 char **outbuf);
424 * Look up the userdiff driver for the given filespec, and return it if
425 * and only if it has textconv enabled (otherwise return NULL). The result
426 * can be passed to fill_textconv().
428 extern struct userdiff_driver *get_textconv(struct diff_filespec *one);
431 * Prepare diff_filespec and convert it using diff textconv API
432 * if the textconv driver exists.
433 * Return 1 if the conversion succeeds, 0 otherwise.
435 extern int textconv_object(const char *path, unsigned mode, const struct object_id *oid, int oid_valid, char **buf, unsigned long *buf_size);
437 extern int parse_rename_score(const char **cp_p);
439 extern long parse_algorithm_value(const char *value);
441 extern void print_stat_summary(FILE *fp, int files,
442 int insertions, int deletions);
443 extern void setup_diff_pager(struct diff_options *);
445 #endif /* DIFF_H */