diff: do not use null sha1 as a sentinel value
[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"
50f9a858 8
91539833 9struct rev_info;
ac1b3d12 10struct diff_options;
04245581 11struct diff_queue_struct;
a3c158d4 12struct strbuf;
a788d7d5
AB
13struct diff_filespec;
14struct userdiff_driver;
0041f09d 15struct sha1_array;
82889295 16struct commit;
ac1b3d12
LT
17
18typedef void (*change_fn_t)(struct diff_options *options,
19 unsigned old_mode, unsigned new_mode,
20 const unsigned char *old_sha1,
21 const unsigned char *new_sha1,
e5450100 22 int old_sha1_valid, int new_sha1_valid,
e3d42c47
JL
23 const char *fullpath,
24 unsigned old_dirty_submodule, unsigned new_dirty_submodule);
ac1b3d12
LT
25
26typedef void (*add_remove_fn_t)(struct diff_options *options,
27 int addremove, unsigned mode,
28 const unsigned char *sha1,
e5450100 29 int sha1_valid,
e3d42c47 30 const char *fullpath, unsigned dirty_submodule);
ac1b3d12 31
04245581
JK
32typedef void (*diff_format_fn_t)(struct diff_queue_struct *q,
33 struct diff_options *options, void *data);
34
a3c158d4
BY
35typedef struct strbuf *(*diff_prefix_fn_t)(struct diff_options *opt, void *data);
36
c6744349
TH
37#define DIFF_FORMAT_RAW 0x0001
38#define DIFF_FORMAT_DIFFSTAT 0x0002
74e2abe5
JH
39#define DIFF_FORMAT_NUMSTAT 0x0004
40#define DIFF_FORMAT_SUMMARY 0x0008
41#define DIFF_FORMAT_PATCH 0x0010
ebd124c6 42#define DIFF_FORMAT_SHORTSTAT 0x0020
7df7c019 43#define DIFF_FORMAT_DIRSTAT 0x0040
c6744349
TH
44
45/* These override all above */
74e2abe5
JH
46#define DIFF_FORMAT_NAME 0x0100
47#define DIFF_FORMAT_NAME_STATUS 0x0200
48#define DIFF_FORMAT_CHECKDIFF 0x0400
c6744349
TH
49
50/* Same as output_format = 0 but we know that -s flag was given
51 * and we should not give default value to output_format.
52 */
74e2abe5 53#define DIFF_FORMAT_NO_OUTPUT 0x0800
c6744349 54
74e2abe5 55#define DIFF_FORMAT_CALLBACK 0x1000
04245581 56
8f67f8ae
PH
57#define DIFF_OPT_RECURSIVE (1 << 0)
58#define DIFF_OPT_TREE_IN_RECURSIVE (1 << 1)
59#define DIFF_OPT_BINARY (1 << 2)
60#define DIFF_OPT_TEXT (1 << 3)
61#define DIFF_OPT_FULL_INDEX (1 << 4)
62#define DIFF_OPT_SILENT_ON_REMOVE (1 << 5)
63#define DIFF_OPT_FIND_COPIES_HARDER (1 << 6)
64#define DIFF_OPT_FOLLOW_RENAMES (1 << 7)
f1c96261 65/* (1 << 8) unused */
882749a0 66/* (1 << 9) unused */
8f67f8ae 67#define DIFF_OPT_HAS_CHANGES (1 << 10)
90b19941 68#define DIFF_OPT_QUICK (1 << 11)
8f67f8ae
PH
69#define DIFF_OPT_NO_INDEX (1 << 12)
70#define DIFF_OPT_ALLOW_EXTERNAL (1 << 13)
71#define DIFF_OPT_EXIT_WITH_STATUS (1 << 14)
72#define DIFF_OPT_REVERSE_DIFF (1 << 15)
62c64895 73#define DIFF_OPT_CHECK_FAILED (1 << 16)
cd676a51 74#define DIFF_OPT_RELATIVE_NAME (1 << 17)
50fd9bd8 75#define DIFF_OPT_IGNORE_SUBMODULES (1 << 18)
f88d225f 76#define DIFF_OPT_DIRSTAT_CUMULATIVE (1 << 19)
fd33777b 77#define DIFF_OPT_DIRSTAT_BY_FILE (1 << 20)
c7534ef4 78#define DIFF_OPT_ALLOW_TEXTCONV (1 << 21)
f245194f 79#define DIFF_OPT_DIFF_FROM_CONTENTS (1 << 22)
752c0c24 80#define DIFF_OPT_SUBMODULE_LOG (1 << 23)
9297f77e 81#define DIFF_OPT_DIRTY_SUBMODULES (1 << 24)
3bfc4504 82#define DIFF_OPT_IGNORE_UNTRACKED_IN_SUBMODULES (1 << 25)
4af574db 83#define DIFF_OPT_IGNORE_DIRTY_SUBMODULES (1 << 26)
aee9c7d6 84#define DIFF_OPT_OVERRIDE_SUBMODULE_CONFIG (1 << 27)
1c57a627 85#define DIFF_OPT_DIRSTAT_BY_LINE (1 << 28)
14937c2c 86#define DIFF_OPT_FUNCCONTEXT (1 << 29)
752c0c24 87
8f67f8ae
PH
88#define DIFF_OPT_TST(opts, flag) ((opts)->flags & DIFF_OPT_##flag)
89#define DIFF_OPT_SET(opts, flag) ((opts)->flags |= DIFF_OPT_##flag)
90#define DIFF_OPT_CLR(opts, flag) ((opts)->flags &= ~DIFF_OPT_##flag)
628d5c2b
KC
91#define DIFF_XDL_TST(opts, flag) ((opts)->xdl_opts & XDF_##flag)
92#define DIFF_XDL_SET(opts, flag) ((opts)->xdl_opts |= XDF_##flag)
93#define DIFF_XDL_CLR(opts, flag) ((opts)->xdl_opts &= ~XDF_##flag)
8f67f8ae 94
882749a0
TR
95enum diff_words_type {
96 DIFF_WORDS_NONE = 0,
97 DIFF_WORDS_PORCELAIN,
98 DIFF_WORDS_PLAIN,
99 DIFF_WORDS_COLOR
100};
101
6b5ee137 102struct diff_options {
6b5ee137
JH
103 const char *filter;
104 const char *orderfile;
105 const char *pickaxe;
2f3f8b21 106 const char *single_follow;
eab9a40b 107 const char *a_prefix, *b_prefix;
8f67f8ae 108 unsigned flags;
f1c96261 109 int use_color;
ee1e5412 110 int context;
6d0e674a 111 int interhunkcontext;
6b5ee137
JH
112 int break_opt;
113 int detect_rename;
467ddc14 114 int irreversible_delete;
fb13227e 115 int skip_stat_unmatch;
6b5ee137
JH
116 int line_termination;
117 int output_format;
118 int pickaxe_opts;
119 int rename_score;
8082d8d3 120 int rename_limit;
bf0ab10f 121 int needed_rename_limit;
f31027c9 122 int degraded_cc_to_c;
3ac942d4 123 int show_rename_progress;
712d2c7d 124 int dirstat_permille;
6b5ee137 125 int setup;
47dd0d59 126 int abbrev;
cd676a51
JH
127 const char *prefix;
128 int prefix_length;
698ce6f8 129 const char *stat_sep;
0d21efa5 130 long xdl_opts;
ac1b3d12 131
a2540023
JH
132 int stat_width;
133 int stat_name_width;
808e1db2 134 int stat_count;
2b6a5417 135 const char *word_regex;
882749a0 136 enum diff_words_type word_diff;
a2540023 137
34a5e1a2
JS
138 /* this is set by diffcore for DIFF_FORMAT_PATCH */
139 int found_changes;
140
44c48a90
JH
141 /* to support internal diff recursion by --follow hack*/
142 int found_follow;
143
c0c77734
DB
144 FILE *file;
145 int close_file;
146
66f13625 147 struct pathspec pathspec;
ac1b3d12
LT
148 change_fn_t change;
149 add_remove_fn_t add_remove;
04245581
JK
150 diff_format_fn_t format_callback;
151 void *format_callback_data;
a3c158d4
BY
152 diff_prefix_fn_t output_prefix;
153 void *output_prefix_data;
6b5ee137
JH
154};
155
ce436973
JK
156enum color_diff {
157 DIFF_RESET = 0,
158 DIFF_PLAIN = 1,
159 DIFF_METAINFO = 2,
160 DIFF_FRAGINFO = 3,
161 DIFF_FILE_OLD = 4,
162 DIFF_FILE_NEW = 5,
163 DIFF_COMMIT = 6,
448c3ef1 164 DIFF_WHITESPACE = 7,
4b05548f 165 DIFF_FUNCINFO = 8
ce436973
JK
166};
167const char *diff_get_color(int diff_use_color, enum color_diff ix);
8f67f8ae 168#define diff_get_color_opt(o, ix) \
f1c96261 169 diff_get_color((o)->use_color, ix)
8f67f8ae 170
ce436973 171
698ce6f8
JS
172extern const char mime_boundary_leader[];
173
a8baa7b9
JH
174extern void diff_tree_setup_paths(const char **paths, struct diff_options *);
175extern void diff_tree_release_paths(struct diff_options *);
ac1b3d12
LT
176extern int diff_tree(struct tree_desc *t1, struct tree_desc *t2,
177 const char *base, struct diff_options *opt);
178extern int diff_tree_sha1(const unsigned char *old, const unsigned char *new,
179 const char *base, struct diff_options *opt);
2b60356d
RS
180extern int diff_root_tree_sha1(const unsigned char *new, const char *base,
181 struct diff_options *opt);
ac1b3d12 182
ea726d02
JH
183struct combine_diff_path {
184 struct combine_diff_path *next;
185 int len;
186 char *path;
2454c962 187 unsigned int mode;
ea726d02 188 unsigned char sha1[20];
2454c962 189 struct combine_diff_parent {
d416df88 190 char status;
2454c962
JH
191 unsigned int mode;
192 unsigned char sha1[20];
193 } parent[FLEX_ARRAY];
ea726d02 194};
2454c962
JH
195#define combine_diff_path_size(n, l) \
196 (sizeof(struct combine_diff_path) + \
197 sizeof(struct combine_diff_parent) * (n) + (l) + 1)
ea726d02 198
91539833
LT
199extern void show_combined_diff(struct combine_diff_path *elem, int num_parent,
200 int dense, struct rev_info *);
ea726d02 201
0041f09d 202extern void diff_tree_combined(const unsigned char *sha1, const struct sha1_array *parents, int dense, struct rev_info *rev);
0fe7c1de 203
82889295 204extern void diff_tree_combined_merge(const struct commit *commit, int dense, struct rev_info *rev);
af3feefa 205
a5a818ee
JH
206void diff_set_mnemonic_prefix(struct diff_options *options, const char *a, const char *b);
207
28b9264d
JH
208extern int diff_can_quit_early(struct diff_options *);
209
6b5ee137
JH
210extern void diff_addremove(struct diff_options *,
211 int addremove,
77eb2720
JH
212 unsigned mode,
213 const unsigned char *sha1,
e5450100 214 int sha1_valid,
e3d42c47 215 const char *fullpath, unsigned dirty_submodule);
77eb2720 216
6b5ee137
JH
217extern void diff_change(struct diff_options *,
218 unsigned mode1, unsigned mode2,
219 const unsigned char *sha1,
220 const unsigned char *sha2,
e5450100
JK
221 int sha1_valid,
222 int sha2_valid,
e3d42c47
JL
223 const char *fullpath,
224 unsigned dirty_submodule1, unsigned dirty_submodule2);
77eb2720 225
fa7b2908 226extern struct diff_filepair *diff_unmerge(struct diff_options *, const char *path);
77eb2720 227
19feebc8 228#define DIFF_SETUP_REVERSE 1
f0c6b2a2
JH
229#define DIFF_SETUP_USE_CACHE 2
230#define DIFF_SETUP_USE_SIZE_CACHE 4
ce240675 231
dea007fb
MM
232/*
233 * Poor man's alternative to parse-option, to allow both sticked form
234 * (--option=value) and separate form (--option value).
235 */
236extern int parse_long_opt(const char *opt, const char **argv,
237 const char **optarg);
238
ef90d6d4
JS
239extern int git_diff_basic_config(const char *var, const char *value, void *cb);
240extern int git_diff_ui_config(const char *var, const char *value, void *cb);
6b2f2d98 241extern int diff_use_color_default;
6b5ee137
JH
242extern void diff_setup(struct diff_options *);
243extern int diff_opt_parse(struct diff_options *, const char **, int);
244extern int diff_setup_done(struct diff_options *);
86436c28 245
6b14d7fa
JH
246#define DIFF_DETECT_RENAME 1
247#define DIFF_DETECT_COPY 2
248
367cec1c 249#define DIFF_PICKAXE_ALL 1
d01d8c67 250#define DIFF_PICKAXE_REGEX 2
f345b0a0 251
f506b8e8
JH
252#define DIFF_PICKAXE_KIND_S 4 /* traditional plumbing counter */
253#define DIFF_PICKAXE_KIND_G 8 /* grep in the patch */
254
6b5ee137 255extern void diffcore_std(struct diff_options *);
730f7284 256extern void diffcore_fix_diff_index(struct diff_options *);
f2ce9fde 257
dda2d79a
JH
258#define COMMON_DIFF_OPTIONS_HELP \
259"\ncommon diff options:\n" \
8082d8d3
JH
260" -z output diff-raw with lines terminated with NUL.\n" \
261" -p output patch format.\n" \
262" -u synonym for -p.\n" \
5c91da25
PB
263" --patch-with-raw\n" \
264" output both a patch and the diff-raw format.\n" \
d75f7952 265" --stat show diffstat instead of patch.\n" \
74e2abe5 266" --numstat show numeric diffstat instead of patch.\n" \
29353273
JS
267" --patch-with-stat\n" \
268" output a patch and prepend its diffstat.\n" \
8082d8d3 269" --name-only show only names of changed files.\n" \
946f5f7c 270" --name-status show names and status of changed files.\n" \
47dd0d59 271" --full-index show full object name on index lines.\n" \
913419fc 272" --abbrev=<n> abbreviate object names in diff-tree header and diff-raw.\n" \
8082d8d3
JH
273" -R swap input file pairs.\n" \
274" -B detect complete rewrites.\n" \
275" -M detect renames.\n" \
276" -C detect copies.\n" \
dda2d79a 277" --find-copies-harder\n" \
8082d8d3
JH
278" try unchanged files as candidate for copy detection.\n" \
279" -l<n> limit rename attempts up to <n> paths.\n" \
280" -O<file> reorder diffs according to the <file>.\n" \
281" -S<string> find filepair whose only one side contains the string.\n" \
dda2d79a 282" --pickaxe-all\n" \
ca49920f
SF
283" show all files diff when -S is used and hit is found.\n" \
284" -a --text treat all files as text.\n"
dda2d79a 285
38c6f780 286extern int diff_queue_is_empty(void);
6b5ee137 287extern void diff_flush(struct diff_options*);
f31027c9 288extern void diff_warn_rename_limit(const char *varname, int needed, int degraded_cc);
86436c28 289
e7baa4f4 290/* diff-raw status letters */
ca8c9156 291#define DIFF_STATUS_ADDED 'A'
e7baa4f4
JH
292#define DIFF_STATUS_COPIED 'C'
293#define DIFF_STATUS_DELETED 'D'
294#define DIFF_STATUS_MODIFIED 'M'
295#define DIFF_STATUS_RENAMED 'R'
296#define DIFF_STATUS_TYPE_CHANGED 'T'
297#define DIFF_STATUS_UNKNOWN 'X'
298#define DIFF_STATUS_UNMERGED 'U'
299
300/* these are not diff-raw status letters proper, but used by
301 * diffcore-filter insn to specify additional restrictions.
302 */
0b34379a 303#define DIFF_STATUS_FILTER_AON '*'
e7baa4f4
JH
304#define DIFF_STATUS_FILTER_BROKEN 'B'
305
47dd0d59
JH
306extern const char *diff_unique_abbrev(const unsigned char *, int);
307
4bd5b7da
JH
308/* do not report anything on removed paths */
309#define DIFF_SILENT_ON_REMOVED 01
fb63d7f8
JH
310/* report racily-clean paths as modified */
311#define DIFF_RACY_IS_MODIFIED 02
4bd5b7da 312extern int run_diff_files(struct rev_info *revs, unsigned int option);
5c21ac0e 313extern int run_diff_index(struct rev_info *revs, int cached);
e09ad6e1 314
1cfe7733 315extern int do_diff_cache(const unsigned char *, struct diff_options *);
fcb3d0ad
JS
316extern int diff_flush_patch_id(struct diff_options *, unsigned char *);
317
da31b358
JH
318extern int diff_result_code(struct diff_options *, int);
319
0569e9b8
JH
320extern void diff_no_index(struct rev_info *, int, const char **, int, const char *);
321
75f3ff2e
SB
322extern int index_differs_from(const char *def, int diff_flags);
323
a788d7d5
AB
324extern size_t fill_textconv(struct userdiff_driver *driver,
325 struct diff_filespec *df,
326 char **outbuf);
327
328extern struct userdiff_driver *get_textconv(struct diff_filespec *one);
329
10ae7526
KB
330extern int parse_rename_score(const char **cp_p);
331
7f814632
NTND
332extern int print_stat_summary(FILE *fp, int files,
333 int insertions, int deletions);
334
86436c28 335#endif /* DIFF_H */