diff.h: avoid bit fields in struct diff_flags
[git/git.git] / diff.h
CommitLineData
be3cfa85
JH
1/*
2 * Copyright (C) 2005 Junio C Hamano
3 */
86436c28
JH
4#ifndef DIFF_H
5#define DIFF_H
6
1b0c7174 7#include "tree-walk.h"
64acde94 8#include "pathspec.h"
1ff57c13 9#include "object.h"
15af58c1 10#include "oidset.h"
50f9a858 11
4a1b13a3
NTND
12struct combine_diff_path;
13struct commit;
14struct diff_filespec;
ac1b3d12 15struct diff_options;
04245581 16struct diff_queue_struct;
910650d2 17struct oid_array;
b78ea5fc 18struct repository;
4a1b13a3
NTND
19struct rev_info;
20struct strbuf;
21struct userdiff_driver;
72441af7
KS
22
23typedef int (*pathchange_fn_t)(struct diff_options *options,
24 struct combine_diff_path *path);
ac1b3d12
LT
25
26typedef void (*change_fn_t)(struct diff_options *options,
27 unsigned old_mode, unsigned new_mode,
94a0097a
BW
28 const struct object_id *old_oid,
29 const struct object_id *new_oid,
30 int old_oid_valid, int new_oid_valid,
e3d42c47
JL
31 const char *fullpath,
32 unsigned old_dirty_submodule, unsigned new_dirty_submodule);
ac1b3d12
LT
33
34typedef void (*add_remove_fn_t)(struct diff_options *options,
35 int addremove, unsigned mode,
c26022ea
BW
36 const struct object_id *oid,
37 int oid_valid,
e3d42c47 38 const char *fullpath, unsigned dirty_submodule);
ac1b3d12 39
04245581
JK
40typedef void (*diff_format_fn_t)(struct diff_queue_struct *q,
41 struct diff_options *options, void *data);
42
a3c158d4
BY
43typedef struct strbuf *(*diff_prefix_fn_t)(struct diff_options *opt, void *data);
44
c6744349
TH
45#define DIFF_FORMAT_RAW 0x0001
46#define DIFF_FORMAT_DIFFSTAT 0x0002
74e2abe5
JH
47#define DIFF_FORMAT_NUMSTAT 0x0004
48#define DIFF_FORMAT_SUMMARY 0x0008
49#define DIFF_FORMAT_PATCH 0x0010
ebd124c6 50#define DIFF_FORMAT_SHORTSTAT 0x0020
7df7c019 51#define DIFF_FORMAT_DIRSTAT 0x0040
c6744349
TH
52
53/* These override all above */
74e2abe5
JH
54#define DIFF_FORMAT_NAME 0x0100
55#define DIFF_FORMAT_NAME_STATUS 0x0200
56#define DIFF_FORMAT_CHECKDIFF 0x0400
c6744349
TH
57
58/* Same as output_format = 0 but we know that -s flag was given
59 * and we should not give default value to output_format.
60 */
74e2abe5 61#define DIFF_FORMAT_NO_OUTPUT 0x0800
c6744349 62
74e2abe5 63#define DIFF_FORMAT_CALLBACK 0x1000
04245581 64
02f2f56b
BW
65#define DIFF_FLAGS_INIT { 0 }
66struct diff_flags {
2b393ef3
NTND
67 unsigned recursive;
68 unsigned tree_in_recursive;
69 unsigned binary;
70 unsigned text;
71 unsigned full_index;
72 unsigned silent_on_remove;
73 unsigned find_copies_harder;
74 unsigned follow_renames;
75 unsigned rename_empty;
76 unsigned has_changes;
77 unsigned quick;
78 unsigned no_index;
79 unsigned allow_external;
80 unsigned exit_with_status;
81 unsigned reverse_diff;
82 unsigned check_failed;
83 unsigned relative_name;
84 unsigned ignore_submodules;
85 unsigned dirstat_cumulative;
86 unsigned dirstat_by_file;
87 unsigned allow_textconv;
88 unsigned textconv_set_via_cmdline;
89 unsigned diff_from_contents;
90 unsigned dirty_submodules;
91 unsigned ignore_untracked_in_submodules;
92 unsigned ignore_dirty_submodules;
93 unsigned override_submodule_config;
94 unsigned dirstat_by_line;
95 unsigned funccontext;
96 unsigned default_follow_renames;
97 unsigned stat_with_summary;
98 unsigned suppress_diff_headers;
99 unsigned dual_color_diffed_diffs;
02f2f56b
BW
100};
101
102static inline void diff_flags_or(struct diff_flags *a,
103 const struct diff_flags *b)
104{
105 char *tmp_a = (char *)a;
106 const char *tmp_b = (const char *)b;
107 int i;
108
109 for (i = 0; i < sizeof(struct diff_flags); i++)
110 tmp_a[i] |= tmp_b[i];
111}
112
628d5c2b
KC
113#define DIFF_XDL_TST(opts, flag) ((opts)->xdl_opts & XDF_##flag)
114#define DIFF_XDL_SET(opts, flag) ((opts)->xdl_opts |= XDF_##flag)
115#define DIFF_XDL_CLR(opts, flag) ((opts)->xdl_opts &= ~XDF_##flag)
8f67f8ae 116
307ab20b
JH
117#define DIFF_WITH_ALG(opts, flag) (((opts)->xdl_opts & ~XDF_DIFF_ALGORITHM_MASK) | XDF_##flag)
118
882749a0
TR
119enum diff_words_type {
120 DIFF_WORDS_NONE = 0,
121 DIFF_WORDS_PORCELAIN,
122 DIFF_WORDS_PLAIN,
123 DIFF_WORDS_COLOR
124};
125
61cfbc05
JK
126enum diff_submodule_format {
127 DIFF_SUBMODULE_SHORT = 0,
fd47ae6a
JK
128 DIFF_SUBMODULE_LOG,
129 DIFF_SUBMODULE_INLINE_DIFF
61cfbc05
JK
130};
131
6b5ee137 132struct diff_options {
6b5ee137
JH
133 const char *orderfile;
134 const char *pickaxe;
2f3f8b21 135 const char *single_follow;
eab9a40b 136 const char *a_prefix, *b_prefix;
660e113c
JK
137 const char *line_prefix;
138 size_t line_prefix_length;
02f2f56b 139 struct diff_flags flags;
1ecc1cbd
JH
140
141 /* diff-filter bits */
142 unsigned int filter;
143
f1c96261 144 int use_color;
ee1e5412 145 int context;
6d0e674a 146 int interhunkcontext;
6b5ee137
JH
147 int break_opt;
148 int detect_rename;
467ddc14 149 int irreversible_delete;
fb13227e 150 int skip_stat_unmatch;
6b5ee137
JH
151 int line_termination;
152 int output_format;
929ed70a 153 unsigned pickaxe_opts;
6b5ee137 154 int rename_score;
8082d8d3 155 int rename_limit;
bf0ab10f 156 int needed_rename_limit;
f31027c9 157 int degraded_cc_to_c;
3ac942d4 158 int show_rename_progress;
712d2c7d 159 int dirstat_permille;
6b5ee137 160 int setup;
47dd0d59 161 int abbrev;
425a28e0 162 int ita_invisible_in_index;
b8767f79 163/* white-space error highlighting */
091f8e28
SB
164#define WSEH_NEW (1<<12)
165#define WSEH_CONTEXT (1<<13)
166#define WSEH_OLD (1<<14)
b8767f79 167 unsigned ws_error_highlight;
cd676a51
JH
168 const char *prefix;
169 int prefix_length;
698ce6f8 170 const char *stat_sep;
0d21efa5 171 long xdl_opts;
ac1b3d12 172
2477ab2e
JT
173 /* see Documentation/diff-options.txt */
174 char **anchors;
175 size_t anchors_nr, anchors_alloc;
176
a2540023
JH
177 int stat_width;
178 int stat_name_width;
969fe57b 179 int stat_graph_width;
808e1db2 180 int stat_count;
2b6a5417 181 const char *word_regex;
882749a0 182 enum diff_words_type word_diff;
61cfbc05 183 enum diff_submodule_format submodule_format;
a2540023 184
15af58c1
SB
185 struct oidset *objfind;
186
34a5e1a2
JS
187 /* this is set by diffcore for DIFF_FORMAT_PATCH */
188 int found_changes;
189
44c48a90
JH
190 /* to support internal diff recursion by --follow hack*/
191 int found_follow;
192
6c374008
JH
193 void (*set_default)(struct diff_options *);
194
c0c77734
DB
195 FILE *file;
196 int close_file;
197
7648b79e
SB
198#define OUTPUT_INDICATOR_NEW 0
199#define OUTPUT_INDICATOR_OLD 1
200#define OUTPUT_INDICATOR_CONTEXT 2
201 char output_indicators[3];
202
66f13625 203 struct pathspec pathspec;
72441af7 204 pathchange_fn_t pathchange;
ac1b3d12
LT
205 change_fn_t change;
206 add_remove_fn_t add_remove;
a937b37e 207 void *change_fn_data;
04245581
JK
208 diff_format_fn_t format_callback;
209 void *format_callback_data;
a3c158d4
BY
210 diff_prefix_fn_t output_prefix;
211 void *output_prefix_data;
ee7fb0b1
ZK
212
213 int diff_path_counter;
e6e045f8
SB
214
215 struct emitted_diff_symbols *emitted_symbols;
2e2d5ac1
SB
216 enum {
217 COLOR_MOVED_NO = 0,
176841f0 218 COLOR_MOVED_PLAIN = 1,
51da15eb
SB
219 COLOR_MOVED_BLOCKS = 2,
220 COLOR_MOVED_ZEBRA = 3,
221 COLOR_MOVED_ZEBRA_DIM = 4,
2e2d5ac1
SB
222 } color_moved;
223 #define COLOR_MOVED_DEFAULT COLOR_MOVED_ZEBRA
f0b8fb6e 224 #define COLOR_MOVED_MIN_ALNUM_COUNT 20
ca1f4ae4
SB
225
226 /* XDF_WHITESPACE_FLAGS regarding block detection are set at 2, 3, 4 */
227 #define COLOR_MOVED_WS_ALLOW_INDENTATION_CHANGE (1<<5)
d173e799
SB
228 #define COLOR_MOVED_WS_ERROR (1<<0)
229 unsigned color_moved_ws_handling;
b78ea5fc
NTND
230
231 struct repository *repo;
6b5ee137
JH
232};
233
f3597138
SB
234void diff_emit_submodule_del(struct diff_options *o, const char *line);
235void diff_emit_submodule_add(struct diff_options *o, const char *line);
236void diff_emit_submodule_untracked(struct diff_options *o, const char *path);
237void diff_emit_submodule_modified(struct diff_options *o, const char *path);
238void diff_emit_submodule_header(struct diff_options *o, const char *header);
239void diff_emit_submodule_error(struct diff_options *o, const char *err);
240void diff_emit_submodule_pipethrough(struct diff_options *o,
241 const char *line, int len);
242
ce436973
JK
243enum color_diff {
244 DIFF_RESET = 0,
8dbf3eb6 245 DIFF_CONTEXT = 1,
ce436973
JK
246 DIFF_METAINFO = 2,
247 DIFF_FRAGINFO = 3,
248 DIFF_FILE_OLD = 4,
249 DIFF_FILE_NEW = 5,
250 DIFF_COMMIT = 6,
448c3ef1 251 DIFF_WHITESPACE = 7,
2e2d5ac1
SB
252 DIFF_FUNCINFO = 8,
253 DIFF_FILE_OLD_MOVED = 9,
254 DIFF_FILE_OLD_MOVED_ALT = 10,
86b452e2
SB
255 DIFF_FILE_OLD_MOVED_DIM = 11,
256 DIFF_FILE_OLD_MOVED_ALT_DIM = 12,
257 DIFF_FILE_NEW_MOVED = 13,
258 DIFF_FILE_NEW_MOVED_ALT = 14,
259 DIFF_FILE_NEW_MOVED_DIM = 15,
a7be92ac
JS
260 DIFF_FILE_NEW_MOVED_ALT_DIM = 16,
261 DIFF_CONTEXT_DIM = 17,
262 DIFF_FILE_OLD_DIM = 18,
263 DIFF_FILE_NEW_DIM = 19,
264 DIFF_CONTEXT_BOLD = 20,
265 DIFF_FILE_OLD_BOLD = 21,
266 DIFF_FILE_NEW_BOLD = 22,
ce436973
JK
267};
268const char *diff_get_color(int diff_use_color, enum color_diff ix);
8f67f8ae 269#define diff_get_color_opt(o, ix) \
f1c96261 270 diff_get_color((o)->use_color, ix)
8f67f8ae 271
ce436973 272
f1922234
JK
273const char *diff_line_prefix(struct diff_options *);
274
275
698ce6f8
JS
276extern const char mime_boundary_leader[];
277
f758a7f8 278struct combine_diff_path *diff_tree_paths(
fda94b41
BW
279 struct combine_diff_path *p, const struct object_id *oid,
280 const struct object_id **parents_oid, int nparent,
72441af7 281 struct strbuf *base, struct diff_options *opt);
f758a7f8
NTND
282int diff_tree_oid(const struct object_id *old_oid,
283 const struct object_id *new_oid,
284 const char *base, struct diff_options *opt);
285int diff_root_tree_oid(const struct object_id *new_oid, const char *base,
286 struct diff_options *opt);
ac1b3d12 287
ea726d02
JH
288struct combine_diff_path {
289 struct combine_diff_path *next;
ea726d02 290 char *path;
2454c962 291 unsigned int mode;
1ff57c13 292 struct object_id oid;
2454c962 293 struct combine_diff_parent {
d416df88 294 char status;
2454c962 295 unsigned int mode;
1ff57c13 296 struct object_id oid;
2454c962 297 } parent[FLEX_ARRAY];
ea726d02 298};
2454c962 299#define combine_diff_path_size(n, l) \
5b442c4f
JK
300 st_add4(sizeof(struct combine_diff_path), (l), 1, \
301 st_mult(sizeof(struct combine_diff_parent), (n)))
ea726d02 302
f758a7f8
NTND
303void show_combined_diff(struct combine_diff_path *elem, int num_parent,
304 int dense, struct rev_info *);
ea726d02 305
f758a7f8 306void diff_tree_combined(const struct object_id *oid, const struct oid_array *parents, int dense, struct rev_info *rev);
0fe7c1de 307
f758a7f8 308void diff_tree_combined_merge(const struct commit *commit, int dense, struct rev_info *rev);
af3feefa 309
a5a818ee
JH
310void diff_set_mnemonic_prefix(struct diff_options *options, const char *a, const char *b);
311
f758a7f8 312int diff_can_quit_early(struct diff_options *);
28b9264d 313
f758a7f8
NTND
314void diff_addremove(struct diff_options *,
315 int addremove,
316 unsigned mode,
317 const struct object_id *oid,
318 int oid_valid,
319 const char *fullpath, unsigned dirty_submodule);
77eb2720 320
f758a7f8
NTND
321void diff_change(struct diff_options *,
322 unsigned mode1, unsigned mode2,
323 const struct object_id *old_oid,
324 const struct object_id *new_oid,
325 int old_oid_valid, int new_oid_valid,
326 const char *fullpath,
327 unsigned dirty_submodule1, unsigned dirty_submodule2);
77eb2720 328
f758a7f8 329struct diff_filepair *diff_unmerge(struct diff_options *, const char *path);
77eb2720 330
19feebc8 331#define DIFF_SETUP_REVERSE 1
f0c6b2a2 332#define DIFF_SETUP_USE_SIZE_CACHE 4
ce240675 333
dea007fb 334/*
b0d12fc9 335 * Poor man's alternative to parse-option, to allow both stuck form
dea007fb
MM
336 * (--option=value) and separate form (--option value).
337 */
f758a7f8
NTND
338int parse_long_opt(const char *opt, const char **argv,
339 const char **optarg);
340
341int git_diff_basic_config(const char *var, const char *value, void *cb);
342int git_diff_heuristic_config(const char *var, const char *value, void *cb);
343void init_diff_ui_defaults(void);
344int git_diff_ui_config(const char *var, const char *value, void *cb);
e6757652
NTND
345#ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
346#define diff_setup(diffopts) repo_diff_setup(the_repository, diffopts)
347#endif
348void repo_diff_setup(struct repository *, struct diff_options *);
f758a7f8
NTND
349int diff_opt_parse(struct diff_options *, const char **, int, const char *);
350void diff_setup_done(struct diff_options *);
351int git_config_rename(const char *var, const char *value);
86436c28 352
6b14d7fa
JH
353#define DIFF_DETECT_RENAME 1
354#define DIFF_DETECT_COPY 2
355
367cec1c 356#define DIFF_PICKAXE_ALL 1
d01d8c67 357#define DIFF_PICKAXE_REGEX 2
f345b0a0 358
f506b8e8
JH
359#define DIFF_PICKAXE_KIND_S 4 /* traditional plumbing counter */
360#define DIFF_PICKAXE_KIND_G 8 /* grep in the patch */
15af58c1 361#define DIFF_PICKAXE_KIND_OBJFIND 16 /* specific object IDs */
f506b8e8 362
15af58c1
SB
363#define DIFF_PICKAXE_KINDS_MASK (DIFF_PICKAXE_KIND_S | \
364 DIFF_PICKAXE_KIND_G | \
365 DIFF_PICKAXE_KIND_OBJFIND)
cf63051a 366
c1ddc461 367#define DIFF_PICKAXE_IGNORE_CASE 32
f506b8e8 368
f758a7f8
NTND
369void diffcore_std(struct diff_options *);
370void diffcore_fix_diff_index(struct diff_options *);
f2ce9fde 371
dda2d79a
JH
372#define COMMON_DIFF_OPTIONS_HELP \
373"\ncommon diff options:\n" \
8082d8d3
JH
374" -z output diff-raw with lines terminated with NUL.\n" \
375" -p output patch format.\n" \
376" -u synonym for -p.\n" \
5c91da25
PB
377" --patch-with-raw\n" \
378" output both a patch and the diff-raw format.\n" \
d75f7952 379" --stat show diffstat instead of patch.\n" \
74e2abe5 380" --numstat show numeric diffstat instead of patch.\n" \
29353273
JS
381" --patch-with-stat\n" \
382" output a patch and prepend its diffstat.\n" \
8082d8d3 383" --name-only show only names of changed files.\n" \
946f5f7c 384" --name-status show names and status of changed files.\n" \
47dd0d59 385" --full-index show full object name on index lines.\n" \
913419fc 386" --abbrev=<n> abbreviate object names in diff-tree header and diff-raw.\n" \
8082d8d3
JH
387" -R swap input file pairs.\n" \
388" -B detect complete rewrites.\n" \
389" -M detect renames.\n" \
390" -C detect copies.\n" \
dda2d79a 391" --find-copies-harder\n" \
8082d8d3
JH
392" try unchanged files as candidate for copy detection.\n" \
393" -l<n> limit rename attempts up to <n> paths.\n" \
394" -O<file> reorder diffs according to the <file>.\n" \
395" -S<string> find filepair whose only one side contains the string.\n" \
dda2d79a 396" --pickaxe-all\n" \
ca49920f
SF
397" show all files diff when -S is used and hit is found.\n" \
398" -a --text treat all files as text.\n"
dda2d79a 399
f758a7f8
NTND
400int diff_queue_is_empty(void);
401void diff_flush(struct diff_options*);
402void diff_warn_rename_limit(const char *varname, int needed, int degraded_cc);
86436c28 403
e7baa4f4 404/* diff-raw status letters */
ca8c9156 405#define DIFF_STATUS_ADDED 'A'
e7baa4f4
JH
406#define DIFF_STATUS_COPIED 'C'
407#define DIFF_STATUS_DELETED 'D'
408#define DIFF_STATUS_MODIFIED 'M'
409#define DIFF_STATUS_RENAMED 'R'
410#define DIFF_STATUS_TYPE_CHANGED 'T'
411#define DIFF_STATUS_UNKNOWN 'X'
412#define DIFF_STATUS_UNMERGED 'U'
413
414/* these are not diff-raw status letters proper, but used by
415 * diffcore-filter insn to specify additional restrictions.
416 */
0b34379a 417#define DIFF_STATUS_FILTER_AON '*'
e7baa4f4
JH
418#define DIFF_STATUS_FILTER_BROKEN 'B'
419
d5e3b01e
JK
420/*
421 * This is different from find_unique_abbrev() in that
422 * it stuffs the result with dots for alignment.
423 */
f758a7f8 424const char *diff_aligned_abbrev(const struct object_id *sha1, int);
47dd0d59 425
4bd5b7da
JH
426/* do not report anything on removed paths */
427#define DIFF_SILENT_ON_REMOVED 01
fb63d7f8
JH
428/* report racily-clean paths as modified */
429#define DIFF_RACY_IS_MODIFIED 02
f758a7f8
NTND
430int run_diff_files(struct rev_info *revs, unsigned int option);
431int run_diff_index(struct rev_info *revs, int cached);
e09ad6e1 432
f758a7f8
NTND
433int do_diff_cache(const struct object_id *, struct diff_options *);
434int diff_flush_patch_id(struct diff_options *, struct object_id *, int);
fcb3d0ad 435
f758a7f8 436int diff_result_code(struct diff_options *, int);
da31b358 437
e6757652 438void diff_no_index(struct repository *, struct rev_info *, int, const char **);
0569e9b8 439
ffc00a48
NTND
440int index_differs_from(struct repository *r, const char *def,
441 const struct diff_flags *flags,
f758a7f8 442 int ita_invisible_in_index);
75f3ff2e 443
a64e6a44
JK
444/*
445 * Fill the contents of the filespec "df", respecting any textconv defined by
446 * its userdiff driver. The "driver" parameter must come from a
447 * previous call to get_textconv(), and therefore should either be NULL or have
448 * textconv enabled.
449 *
450 * Note that the memory ownership of the resulting buffer depends on whether
451 * the driver field is NULL. If it is, then the memory belongs to the filespec
452 * struct. If it is non-NULL, then "outbuf" points to a newly allocated buffer
453 * that should be freed by the caller.
454 */
6afaf807
NTND
455size_t fill_textconv(struct repository *r,
456 struct userdiff_driver *driver,
f758a7f8
NTND
457 struct diff_filespec *df,
458 char **outbuf);
a788d7d5 459
a64e6a44
JK
460/*
461 * Look up the userdiff driver for the given filespec, and return it if
462 * and only if it has textconv enabled (otherwise return NULL). The result
463 * can be passed to fill_textconv().
464 */
bd7ad45b 465struct userdiff_driver *get_textconv(struct repository *r,
acd00ea0 466 struct diff_filespec *one);
a788d7d5 467
3a35cb2e
JS
468/*
469 * Prepare diff_filespec and convert it using diff textconv API
470 * if the textconv driver exists.
471 * Return 1 if the conversion succeeds, 0 otherwise.
472 */
6afaf807
NTND
473int textconv_object(struct repository *repo,
474 const char *path,
475 unsigned mode,
476 const struct object_id *oid, int oid_valid,
477 char **buf, unsigned long *buf_size);
3a35cb2e 478
f758a7f8 479int parse_rename_score(const char **cp_p);
10ae7526 480
f758a7f8 481long parse_algorithm_value(const char *value);
07924d4d 482
f758a7f8
NTND
483void print_stat_summary(FILE *fp, int files,
484 int insertions, int deletions);
485void setup_diff_pager(struct diff_options *);
7f814632 486
86436c28 487#endif /* DIFF_H */