debian: new upstream release candidate
[git/debian.git] / diff.h
blob78b4091dd5b59fe4442262cd79cf71f8a4a2b98f
1 /*
2 * Copyright (C) 2005 Junio C Hamano
3 */
4 #ifndef DIFF_H
5 #define DIFF_H
7 #include "tree-walk.h"
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;
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);
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);
32 typedef void (*diff_format_fn_t)(struct diff_queue_struct *q,
33 struct diff_options *options, void *data);
35 typedef struct strbuf *(*diff_prefix_fn_t)(struct diff_options *opt, void *data);
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
45 /* These override all above */
46 #define DIFF_FORMAT_NAME 0x0100
47 #define DIFF_FORMAT_NAME_STATUS 0x0200
48 #define DIFF_FORMAT_CHECKDIFF 0x0400
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.
53 #define DIFF_FORMAT_NO_OUTPUT 0x0800
55 #define DIFF_FORMAT_CALLBACK 0x1000
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 #define DIFF_OPT_RENAME_EMPTY (1 << 8)
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 #define DIFF_OPT_PICKAXE_IGNORE_CASE (1 << 30)
89 #define DIFF_OPT_TST(opts, flag) ((opts)->flags & DIFF_OPT_##flag)
90 #define DIFF_OPT_SET(opts, flag) ((opts)->flags |= DIFF_OPT_##flag)
91 #define DIFF_OPT_CLR(opts, flag) ((opts)->flags &= ~DIFF_OPT_##flag)
92 #define DIFF_XDL_TST(opts, flag) ((opts)->xdl_opts & XDF_##flag)
93 #define DIFF_XDL_SET(opts, flag) ((opts)->xdl_opts |= XDF_##flag)
94 #define DIFF_XDL_CLR(opts, flag) ((opts)->xdl_opts &= ~XDF_##flag)
96 #define DIFF_WITH_ALG(opts, flag) (((opts)->xdl_opts & ~XDF_DIFF_ALGORITHM_MASK) | XDF_##flag)
98 enum diff_words_type {
99 DIFF_WORDS_NONE = 0,
100 DIFF_WORDS_PORCELAIN,
101 DIFF_WORDS_PLAIN,
102 DIFF_WORDS_COLOR
105 struct diff_options {
106 const char *filter;
107 const char *orderfile;
108 const char *pickaxe;
109 const char *single_follow;
110 const char *a_prefix, *b_prefix;
111 unsigned flags;
112 int use_color;
113 int context;
114 int interhunkcontext;
115 int break_opt;
116 int detect_rename;
117 int irreversible_delete;
118 int skip_stat_unmatch;
119 int line_termination;
120 int output_format;
121 int pickaxe_opts;
122 int rename_score;
123 int rename_limit;
124 int needed_rename_limit;
125 int degraded_cc_to_c;
126 int show_rename_progress;
127 int dirstat_permille;
128 int setup;
129 int abbrev;
130 const char *prefix;
131 int prefix_length;
132 const char *stat_sep;
133 long xdl_opts;
135 int stat_width;
136 int stat_name_width;
137 int stat_graph_width;
138 int stat_count;
139 const char *word_regex;
140 enum diff_words_type word_diff;
142 /* this is set by diffcore for DIFF_FORMAT_PATCH */
143 int found_changes;
145 /* to support internal diff recursion by --follow hack*/
146 int found_follow;
148 FILE *file;
149 int close_file;
151 struct pathspec pathspec;
152 change_fn_t change;
153 add_remove_fn_t add_remove;
154 diff_format_fn_t format_callback;
155 void *format_callback_data;
156 diff_prefix_fn_t output_prefix;
157 int output_prefix_length;
158 void *output_prefix_data;
161 enum color_diff {
162 DIFF_RESET = 0,
163 DIFF_PLAIN = 1,
164 DIFF_METAINFO = 2,
165 DIFF_FRAGINFO = 3,
166 DIFF_FILE_OLD = 4,
167 DIFF_FILE_NEW = 5,
168 DIFF_COMMIT = 6,
169 DIFF_WHITESPACE = 7,
170 DIFF_FUNCINFO = 8
172 const char *diff_get_color(int diff_use_color, enum color_diff ix);
173 #define diff_get_color_opt(o, ix) \
174 diff_get_color((o)->use_color, ix)
177 const char *diff_line_prefix(struct diff_options *);
180 extern const char mime_boundary_leader[];
182 extern void diff_tree_setup_paths(const char **paths, struct diff_options *);
183 extern void diff_tree_release_paths(struct diff_options *);
184 extern int diff_tree(struct tree_desc *t1, struct tree_desc *t2,
185 const char *base, struct diff_options *opt);
186 extern int diff_tree_sha1(const unsigned char *old, const unsigned char *new,
187 const char *base, struct diff_options *opt);
188 extern int diff_root_tree_sha1(const unsigned char *new, const char *base,
189 struct diff_options *opt);
191 struct combine_diff_path {
192 struct combine_diff_path *next;
193 int len;
194 char *path;
195 unsigned int mode;
196 unsigned char sha1[20];
197 struct combine_diff_parent {
198 char status;
199 unsigned int mode;
200 unsigned char sha1[20];
201 } parent[FLEX_ARRAY];
203 #define combine_diff_path_size(n, l) \
204 (sizeof(struct combine_diff_path) + \
205 sizeof(struct combine_diff_parent) * (n) + (l) + 1)
207 extern void show_combined_diff(struct combine_diff_path *elem, int num_parent,
208 int dense, struct rev_info *);
210 extern void diff_tree_combined(const unsigned char *sha1, const struct sha1_array *parents, int dense, struct rev_info *rev);
212 extern void diff_tree_combined_merge(const struct commit *commit, int dense, struct rev_info *rev);
214 void diff_set_mnemonic_prefix(struct diff_options *options, const char *a, const char *b);
216 extern int diff_can_quit_early(struct diff_options *);
218 extern void diff_addremove(struct diff_options *,
219 int addremove,
220 unsigned mode,
221 const unsigned char *sha1,
222 int sha1_valid,
223 const char *fullpath, unsigned dirty_submodule);
225 extern void diff_change(struct diff_options *,
226 unsigned mode1, unsigned mode2,
227 const unsigned char *sha1,
228 const unsigned char *sha2,
229 int sha1_valid,
230 int sha2_valid,
231 const char *fullpath,
232 unsigned dirty_submodule1, unsigned dirty_submodule2);
234 extern struct diff_filepair *diff_unmerge(struct diff_options *, const char *path);
236 #define DIFF_SETUP_REVERSE 1
237 #define DIFF_SETUP_USE_CACHE 2
238 #define DIFF_SETUP_USE_SIZE_CACHE 4
241 * Poor man's alternative to parse-option, to allow both sticked form
242 * (--option=value) and separate form (--option value).
244 extern int parse_long_opt(const char *opt, const char **argv,
245 const char **optarg);
247 extern int git_diff_basic_config(const char *var, const char *value, void *cb);
248 extern int git_diff_ui_config(const char *var, const char *value, void *cb);
249 extern void diff_setup(struct diff_options *);
250 extern int diff_opt_parse(struct diff_options *, const char **, int);
251 extern void diff_setup_done(struct diff_options *);
253 #define DIFF_DETECT_RENAME 1
254 #define DIFF_DETECT_COPY 2
256 #define DIFF_PICKAXE_ALL 1
257 #define DIFF_PICKAXE_REGEX 2
259 #define DIFF_PICKAXE_KIND_S 4 /* traditional plumbing counter */
260 #define DIFF_PICKAXE_KIND_G 8 /* grep in the patch */
262 extern void diffcore_std(struct diff_options *);
263 extern void diffcore_fix_diff_index(struct diff_options *);
265 #define COMMON_DIFF_OPTIONS_HELP \
266 "\ncommon diff options:\n" \
267 " -z output diff-raw with lines terminated with NUL.\n" \
268 " -p output patch format.\n" \
269 " -u synonym for -p.\n" \
270 " --patch-with-raw\n" \
271 " output both a patch and the diff-raw format.\n" \
272 " --stat show diffstat instead of patch.\n" \
273 " --numstat show numeric diffstat instead of patch.\n" \
274 " --patch-with-stat\n" \
275 " output a patch and prepend its diffstat.\n" \
276 " --name-only show only names of changed files.\n" \
277 " --name-status show names and status of changed files.\n" \
278 " --full-index show full object name on index lines.\n" \
279 " --abbrev=<n> abbreviate object names in diff-tree header and diff-raw.\n" \
280 " -R swap input file pairs.\n" \
281 " -B detect complete rewrites.\n" \
282 " -M detect renames.\n" \
283 " -C detect copies.\n" \
284 " --find-copies-harder\n" \
285 " try unchanged files as candidate for copy detection.\n" \
286 " -l<n> limit rename attempts up to <n> paths.\n" \
287 " -O<file> reorder diffs according to the <file>.\n" \
288 " -S<string> find filepair whose only one side contains the string.\n" \
289 " --pickaxe-all\n" \
290 " show all files diff when -S is used and hit is found.\n" \
291 " -a --text treat all files as text.\n"
293 extern int diff_queue_is_empty(void);
294 extern void diff_flush(struct diff_options*);
295 extern void diff_warn_rename_limit(const char *varname, int needed, int degraded_cc);
297 /* diff-raw status letters */
298 #define DIFF_STATUS_ADDED 'A'
299 #define DIFF_STATUS_COPIED 'C'
300 #define DIFF_STATUS_DELETED 'D'
301 #define DIFF_STATUS_MODIFIED 'M'
302 #define DIFF_STATUS_RENAMED 'R'
303 #define DIFF_STATUS_TYPE_CHANGED 'T'
304 #define DIFF_STATUS_UNKNOWN 'X'
305 #define DIFF_STATUS_UNMERGED 'U'
307 /* these are not diff-raw status letters proper, but used by
308 * diffcore-filter insn to specify additional restrictions.
310 #define DIFF_STATUS_FILTER_AON '*'
311 #define DIFF_STATUS_FILTER_BROKEN 'B'
313 extern const char *diff_unique_abbrev(const unsigned char *, int);
315 /* do not report anything on removed paths */
316 #define DIFF_SILENT_ON_REMOVED 01
317 /* report racily-clean paths as modified */
318 #define DIFF_RACY_IS_MODIFIED 02
319 extern int run_diff_files(struct rev_info *revs, unsigned int option);
320 extern int run_diff_index(struct rev_info *revs, int cached);
322 extern int do_diff_cache(const unsigned char *, struct diff_options *);
323 extern int diff_flush_patch_id(struct diff_options *, unsigned char *);
325 extern int diff_result_code(struct diff_options *, int);
327 extern void diff_no_index(struct rev_info *, int, const char **, int, const char *);
329 extern int index_differs_from(const char *def, int diff_flags);
331 extern size_t fill_textconv(struct userdiff_driver *driver,
332 struct diff_filespec *df,
333 char **outbuf);
335 extern struct userdiff_driver *get_textconv(struct diff_filespec *one);
337 extern int parse_rename_score(const char **cp_p);
339 extern long parse_algorithm_value(const char *value);
341 extern int print_stat_summary(FILE *fp, int files,
342 int insertions, int deletions);
343 extern void setup_diff_pager(struct diff_options *);
345 #endif /* DIFF_H */