diff: do not use null sha1 as a sentinel value
[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
9 struct rev_info;
10 struct diff_options;
11 struct diff_queue_struct;
12 struct strbuf;
13 struct diff_filespec;
14 struct userdiff_driver;
15 struct sha1_array;
16 struct commit;
17
18 typedef 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,
22 int old_sha1_valid, int new_sha1_valid,
23 const char *fullpath,
24 unsigned old_dirty_submodule, unsigned new_dirty_submodule);
25
26 typedef void (*add_remove_fn_t)(struct diff_options *options,
27 int addremove, unsigned mode,
28 const unsigned char *sha1,
29 int sha1_valid,
30 const char *fullpath, unsigned dirty_submodule);
31
32 typedef void (*diff_format_fn_t)(struct diff_queue_struct *q,
33 struct diff_options *options, void *data);
34
35 typedef struct strbuf *(*diff_prefix_fn_t)(struct diff_options *opt, void *data);
36
37 #define DIFF_FORMAT_RAW 0x0001
38 #define DIFF_FORMAT_DIFFSTAT 0x0002
39 #define DIFF_FORMAT_NUMSTAT 0x0004
40 #define DIFF_FORMAT_SUMMARY 0x0008
41 #define DIFF_FORMAT_PATCH 0x0010
42 #define DIFF_FORMAT_SHORTSTAT 0x0020
43 #define DIFF_FORMAT_DIRSTAT 0x0040
44
45 /* These override all above */
46 #define DIFF_FORMAT_NAME 0x0100
47 #define DIFF_FORMAT_NAME_STATUS 0x0200
48 #define DIFF_FORMAT_CHECKDIFF 0x0400
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 */
53 #define DIFF_FORMAT_NO_OUTPUT 0x0800
54
55 #define DIFF_FORMAT_CALLBACK 0x1000
56
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)
65 /* (1 << 8) unused */
66 /* (1 << 9) unused */
67 #define DIFF_OPT_HAS_CHANGES (1 << 10)
68 #define DIFF_OPT_QUICK (1 << 11)
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)
73 #define DIFF_OPT_CHECK_FAILED (1 << 16)
74 #define DIFF_OPT_RELATIVE_NAME (1 << 17)
75 #define DIFF_OPT_IGNORE_SUBMODULES (1 << 18)
76 #define DIFF_OPT_DIRSTAT_CUMULATIVE (1 << 19)
77 #define DIFF_OPT_DIRSTAT_BY_FILE (1 << 20)
78 #define DIFF_OPT_ALLOW_TEXTCONV (1 << 21)
79 #define DIFF_OPT_DIFF_FROM_CONTENTS (1 << 22)
80 #define DIFF_OPT_SUBMODULE_LOG (1 << 23)
81 #define DIFF_OPT_DIRTY_SUBMODULES (1 << 24)
82 #define DIFF_OPT_IGNORE_UNTRACKED_IN_SUBMODULES (1 << 25)
83 #define DIFF_OPT_IGNORE_DIRTY_SUBMODULES (1 << 26)
84 #define DIFF_OPT_OVERRIDE_SUBMODULE_CONFIG (1 << 27)
85 #define DIFF_OPT_DIRSTAT_BY_LINE (1 << 28)
86 #define DIFF_OPT_FUNCCONTEXT (1 << 29)
87
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)
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)
94
95 enum diff_words_type {
96 DIFF_WORDS_NONE = 0,
97 DIFF_WORDS_PORCELAIN,
98 DIFF_WORDS_PLAIN,
99 DIFF_WORDS_COLOR
100 };
101
102 struct diff_options {
103 const char *filter;
104 const char *orderfile;
105 const char *pickaxe;
106 const char *single_follow;
107 const char *a_prefix, *b_prefix;
108 unsigned flags;
109 int use_color;
110 int context;
111 int interhunkcontext;
112 int break_opt;
113 int detect_rename;
114 int irreversible_delete;
115 int skip_stat_unmatch;
116 int line_termination;
117 int output_format;
118 int pickaxe_opts;
119 int rename_score;
120 int rename_limit;
121 int needed_rename_limit;
122 int degraded_cc_to_c;
123 int show_rename_progress;
124 int dirstat_permille;
125 int setup;
126 int abbrev;
127 const char *prefix;
128 int prefix_length;
129 const char *stat_sep;
130 long xdl_opts;
131
132 int stat_width;
133 int stat_name_width;
134 int stat_count;
135 const char *word_regex;
136 enum diff_words_type word_diff;
137
138 /* this is set by diffcore for DIFF_FORMAT_PATCH */
139 int found_changes;
140
141 /* to support internal diff recursion by --follow hack*/
142 int found_follow;
143
144 FILE *file;
145 int close_file;
146
147 struct pathspec pathspec;
148 change_fn_t change;
149 add_remove_fn_t add_remove;
150 diff_format_fn_t format_callback;
151 void *format_callback_data;
152 diff_prefix_fn_t output_prefix;
153 void *output_prefix_data;
154 };
155
156 enum 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,
164 DIFF_WHITESPACE = 7,
165 DIFF_FUNCINFO = 8
166 };
167 const char *diff_get_color(int diff_use_color, enum color_diff ix);
168 #define diff_get_color_opt(o, ix) \
169 diff_get_color((o)->use_color, ix)
170
171
172 extern const char mime_boundary_leader[];
173
174 extern void diff_tree_setup_paths(const char **paths, struct diff_options *);
175 extern void diff_tree_release_paths(struct diff_options *);
176 extern int diff_tree(struct tree_desc *t1, struct tree_desc *t2,
177 const char *base, struct diff_options *opt);
178 extern int diff_tree_sha1(const unsigned char *old, const unsigned char *new,
179 const char *base, struct diff_options *opt);
180 extern int diff_root_tree_sha1(const unsigned char *new, const char *base,
181 struct diff_options *opt);
182
183 struct combine_diff_path {
184 struct combine_diff_path *next;
185 int len;
186 char *path;
187 unsigned int mode;
188 unsigned char sha1[20];
189 struct combine_diff_parent {
190 char status;
191 unsigned int mode;
192 unsigned char sha1[20];
193 } parent[FLEX_ARRAY];
194 };
195 #define combine_diff_path_size(n, l) \
196 (sizeof(struct combine_diff_path) + \
197 sizeof(struct combine_diff_parent) * (n) + (l) + 1)
198
199 extern void show_combined_diff(struct combine_diff_path *elem, int num_parent,
200 int dense, struct rev_info *);
201
202 extern void diff_tree_combined(const unsigned char *sha1, const struct sha1_array *parents, int dense, struct rev_info *rev);
203
204 extern void diff_tree_combined_merge(const struct commit *commit, int dense, struct rev_info *rev);
205
206 void diff_set_mnemonic_prefix(struct diff_options *options, const char *a, const char *b);
207
208 extern int diff_can_quit_early(struct diff_options *);
209
210 extern void diff_addremove(struct diff_options *,
211 int addremove,
212 unsigned mode,
213 const unsigned char *sha1,
214 int sha1_valid,
215 const char *fullpath, unsigned dirty_submodule);
216
217 extern void diff_change(struct diff_options *,
218 unsigned mode1, unsigned mode2,
219 const unsigned char *sha1,
220 const unsigned char *sha2,
221 int sha1_valid,
222 int sha2_valid,
223 const char *fullpath,
224 unsigned dirty_submodule1, unsigned dirty_submodule2);
225
226 extern struct diff_filepair *diff_unmerge(struct diff_options *, const char *path);
227
228 #define DIFF_SETUP_REVERSE 1
229 #define DIFF_SETUP_USE_CACHE 2
230 #define DIFF_SETUP_USE_SIZE_CACHE 4
231
232 /*
233 * Poor man's alternative to parse-option, to allow both sticked form
234 * (--option=value) and separate form (--option value).
235 */
236 extern int parse_long_opt(const char *opt, const char **argv,
237 const char **optarg);
238
239 extern int git_diff_basic_config(const char *var, const char *value, void *cb);
240 extern int git_diff_ui_config(const char *var, const char *value, void *cb);
241 extern int diff_use_color_default;
242 extern void diff_setup(struct diff_options *);
243 extern int diff_opt_parse(struct diff_options *, const char **, int);
244 extern int diff_setup_done(struct diff_options *);
245
246 #define DIFF_DETECT_RENAME 1
247 #define DIFF_DETECT_COPY 2
248
249 #define DIFF_PICKAXE_ALL 1
250 #define DIFF_PICKAXE_REGEX 2
251
252 #define DIFF_PICKAXE_KIND_S 4 /* traditional plumbing counter */
253 #define DIFF_PICKAXE_KIND_G 8 /* grep in the patch */
254
255 extern void diffcore_std(struct diff_options *);
256 extern void diffcore_fix_diff_index(struct diff_options *);
257
258 #define COMMON_DIFF_OPTIONS_HELP \
259 "\ncommon diff options:\n" \
260 " -z output diff-raw with lines terminated with NUL.\n" \
261 " -p output patch format.\n" \
262 " -u synonym for -p.\n" \
263 " --patch-with-raw\n" \
264 " output both a patch and the diff-raw format.\n" \
265 " --stat show diffstat instead of patch.\n" \
266 " --numstat show numeric diffstat instead of patch.\n" \
267 " --patch-with-stat\n" \
268 " output a patch and prepend its diffstat.\n" \
269 " --name-only show only names of changed files.\n" \
270 " --name-status show names and status of changed files.\n" \
271 " --full-index show full object name on index lines.\n" \
272 " --abbrev=<n> abbreviate object names in diff-tree header and diff-raw.\n" \
273 " -R swap input file pairs.\n" \
274 " -B detect complete rewrites.\n" \
275 " -M detect renames.\n" \
276 " -C detect copies.\n" \
277 " --find-copies-harder\n" \
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" \
282 " --pickaxe-all\n" \
283 " show all files diff when -S is used and hit is found.\n" \
284 " -a --text treat all files as text.\n"
285
286 extern int diff_queue_is_empty(void);
287 extern void diff_flush(struct diff_options*);
288 extern void diff_warn_rename_limit(const char *varname, int needed, int degraded_cc);
289
290 /* diff-raw status letters */
291 #define DIFF_STATUS_ADDED 'A'
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 */
303 #define DIFF_STATUS_FILTER_AON '*'
304 #define DIFF_STATUS_FILTER_BROKEN 'B'
305
306 extern const char *diff_unique_abbrev(const unsigned char *, int);
307
308 /* do not report anything on removed paths */
309 #define DIFF_SILENT_ON_REMOVED 01
310 /* report racily-clean paths as modified */
311 #define DIFF_RACY_IS_MODIFIED 02
312 extern int run_diff_files(struct rev_info *revs, unsigned int option);
313 extern int run_diff_index(struct rev_info *revs, int cached);
314
315 extern int do_diff_cache(const unsigned char *, struct diff_options *);
316 extern int diff_flush_patch_id(struct diff_options *, unsigned char *);
317
318 extern int diff_result_code(struct diff_options *, int);
319
320 extern void diff_no_index(struct rev_info *, int, const char **, int, const char *);
321
322 extern int index_differs_from(const char *def, int diff_flags);
323
324 extern size_t fill_textconv(struct userdiff_driver *driver,
325 struct diff_filespec *df,
326 char **outbuf);
327
328 extern struct userdiff_driver *get_textconv(struct diff_filespec *one);
329
330 extern int parse_rename_score(const char **cp_p);
331
332 extern int print_stat_summary(FILE *fp, int files,
333 int insertions, int deletions);
334
335 #endif /* DIFF_H */