Merge branch 'rs/ring-buffer-wraparound'
[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 #include "pathspec.h"
9 #include "object.h"
10
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 sha1_array;
18 struct commit;
19 struct combine_diff_path;
20
21 typedef int (*pathchange_fn_t)(struct diff_options *options,
22                  struct combine_diff_path *path);
23
24 typedef void (*change_fn_t)(struct diff_options *options,
25                  unsigned old_mode, unsigned new_mode,
26                  const unsigned char *old_sha1,
27                  const unsigned char *new_sha1,
28                  int old_sha1_valid, int new_sha1_valid,
29                  const char *fullpath,
30                  unsigned old_dirty_submodule, unsigned new_dirty_submodule);
31
32 typedef void (*add_remove_fn_t)(struct diff_options *options,
33                     int addremove, unsigned mode,
34                     const unsigned char *sha1,
35                     int sha1_valid,
36                     const char *fullpath, unsigned dirty_submodule);
37
38 typedef void (*diff_format_fn_t)(struct diff_queue_struct *q,
39                 struct diff_options *options, void *data);
40
41 typedef struct strbuf *(*diff_prefix_fn_t)(struct diff_options *opt, void *data);
42
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
50
51 /* These override all above */
52 #define DIFF_FORMAT_NAME        0x0100
53 #define DIFF_FORMAT_NAME_STATUS 0x0200
54 #define DIFF_FORMAT_CHECKDIFF   0x0400
55
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.
58  */
59 #define DIFF_FORMAT_NO_OUTPUT   0x0800
60
61 #define DIFF_FORMAT_CALLBACK    0x1000
62
63 #define DIFF_OPT_RECURSIVE           (1 <<  0)
64 #define DIFF_OPT_TREE_IN_RECURSIVE   (1 <<  1)
65 #define DIFF_OPT_BINARY              (1 <<  2)
66 #define DIFF_OPT_TEXT                (1 <<  3)
67 #define DIFF_OPT_FULL_INDEX          (1 <<  4)
68 #define DIFF_OPT_SILENT_ON_REMOVE    (1 <<  5)
69 #define DIFF_OPT_FIND_COPIES_HARDER  (1 <<  6)
70 #define DIFF_OPT_FOLLOW_RENAMES      (1 <<  7)
71 #define DIFF_OPT_RENAME_EMPTY        (1 <<  8)
72 /* (1 <<  9) unused */
73 #define DIFF_OPT_HAS_CHANGES         (1 << 10)
74 #define DIFF_OPT_QUICK               (1 << 11)
75 #define DIFF_OPT_NO_INDEX            (1 << 12)
76 #define DIFF_OPT_ALLOW_EXTERNAL      (1 << 13)
77 #define DIFF_OPT_EXIT_WITH_STATUS    (1 << 14)
78 #define DIFF_OPT_REVERSE_DIFF        (1 << 15)
79 #define DIFF_OPT_CHECK_FAILED        (1 << 16)
80 #define DIFF_OPT_RELATIVE_NAME       (1 << 17)
81 #define DIFF_OPT_IGNORE_SUBMODULES   (1 << 18)
82 #define DIFF_OPT_DIRSTAT_CUMULATIVE  (1 << 19)
83 #define DIFF_OPT_DIRSTAT_BY_FILE     (1 << 20)
84 #define DIFF_OPT_ALLOW_TEXTCONV      (1 << 21)
85 #define DIFF_OPT_DIFF_FROM_CONTENTS  (1 << 22)
86 #define DIFF_OPT_DIRTY_SUBMODULES    (1 << 24)
87 #define DIFF_OPT_IGNORE_UNTRACKED_IN_SUBMODULES (1 << 25)
88 #define DIFF_OPT_IGNORE_DIRTY_SUBMODULES (1 << 26)
89 #define DIFF_OPT_OVERRIDE_SUBMODULE_CONFIG (1 << 27)
90 #define DIFF_OPT_DIRSTAT_BY_LINE     (1 << 28)
91 #define DIFF_OPT_FUNCCONTEXT         (1 << 29)
92 #define DIFF_OPT_PICKAXE_IGNORE_CASE (1 << 30)
93 #define DIFF_OPT_DEFAULT_FOLLOW_RENAMES (1U << 31)
94
95 #define DIFF_OPT_TST(opts, flag)    ((opts)->flags & DIFF_OPT_##flag)
96 #define DIFF_OPT_TOUCHED(opts, flag)    ((opts)->touched_flags & DIFF_OPT_##flag)
97 #define DIFF_OPT_SET(opts, flag)    (((opts)->flags |= DIFF_OPT_##flag),((opts)->touched_flags |= DIFF_OPT_##flag))
98 #define DIFF_OPT_CLR(opts, flag)    (((opts)->flags &= ~DIFF_OPT_##flag),((opts)->touched_flags |= DIFF_OPT_##flag))
99 #define DIFF_XDL_TST(opts, flag)    ((opts)->xdl_opts & XDF_##flag)
100 #define DIFF_XDL_SET(opts, flag)    ((opts)->xdl_opts |= XDF_##flag)
101 #define DIFF_XDL_CLR(opts, flag)    ((opts)->xdl_opts &= ~XDF_##flag)
102
103 #define DIFF_WITH_ALG(opts, flag)   (((opts)->xdl_opts & ~XDF_DIFF_ALGORITHM_MASK) | XDF_##flag)
104
105 enum diff_words_type {
106         DIFF_WORDS_NONE = 0,
107         DIFF_WORDS_PORCELAIN,
108         DIFF_WORDS_PLAIN,
109         DIFF_WORDS_COLOR
110 };
111
112 enum diff_submodule_format {
113         DIFF_SUBMODULE_SHORT = 0,
114         DIFF_SUBMODULE_LOG,
115         DIFF_SUBMODULE_INLINE_DIFF
116 };
117
118 struct diff_options {
119         const char *orderfile;
120         const char *pickaxe;
121         const char *single_follow;
122         const char *a_prefix, *b_prefix;
123         const char *line_prefix;
124         size_t line_prefix_length;
125         unsigned flags;
126         unsigned touched_flags;
127
128         /* diff-filter bits */
129         unsigned int filter;
130
131         int use_color;
132         int context;
133         int interhunkcontext;
134         int break_opt;
135         int detect_rename;
136         int irreversible_delete;
137         int skip_stat_unmatch;
138         int line_termination;
139         int output_format;
140         int pickaxe_opts;
141         int rename_score;
142         int rename_limit;
143         int needed_rename_limit;
144         int degraded_cc_to_c;
145         int show_rename_progress;
146         int dirstat_permille;
147         int setup;
148         int abbrev;
149 /* white-space error highlighting */
150 #define WSEH_NEW 1
151 #define WSEH_CONTEXT 2
152 #define WSEH_OLD 4
153         unsigned ws_error_highlight;
154         const char *prefix;
155         int prefix_length;
156         const char *stat_sep;
157         long xdl_opts;
158
159         int stat_width;
160         int stat_name_width;
161         int stat_graph_width;
162         int stat_count;
163         const char *word_regex;
164         enum diff_words_type word_diff;
165         enum diff_submodule_format submodule_format;
166
167         /* this is set by diffcore for DIFF_FORMAT_PATCH */
168         int found_changes;
169
170         /* to support internal diff recursion by --follow hack*/
171         int found_follow;
172
173         void (*set_default)(struct diff_options *);
174
175         FILE *file;
176         int close_file;
177
178         struct pathspec pathspec;
179         pathchange_fn_t pathchange;
180         change_fn_t change;
181         add_remove_fn_t add_remove;
182         diff_format_fn_t format_callback;
183         void *format_callback_data;
184         diff_prefix_fn_t output_prefix;
185         void *output_prefix_data;
186
187         int diff_path_counter;
188 };
189
190 enum color_diff {
191         DIFF_RESET = 0,
192         DIFF_CONTEXT = 1,
193         DIFF_METAINFO = 2,
194         DIFF_FRAGINFO = 3,
195         DIFF_FILE_OLD = 4,
196         DIFF_FILE_NEW = 5,
197         DIFF_COMMIT = 6,
198         DIFF_WHITESPACE = 7,
199         DIFF_FUNCINFO = 8
200 };
201 const char *diff_get_color(int diff_use_color, enum color_diff ix);
202 #define diff_get_color_opt(o, ix) \
203         diff_get_color((o)->use_color, ix)
204
205
206 const char *diff_line_prefix(struct diff_options *);
207
208
209 extern const char mime_boundary_leader[];
210
211 extern struct combine_diff_path *diff_tree_paths(
212         struct combine_diff_path *p, const unsigned char *sha1,
213         const unsigned char **parent_sha1, int nparent,
214         struct strbuf *base, struct diff_options *opt);
215 extern int diff_tree_sha1(const unsigned char *old, const unsigned char *new,
216                           const char *base, struct diff_options *opt);
217 extern int diff_root_tree_sha1(const unsigned char *new, const char *base,
218                                struct diff_options *opt);
219
220 struct combine_diff_path {
221         struct combine_diff_path *next;
222         char *path;
223         unsigned int mode;
224         struct object_id oid;
225         struct combine_diff_parent {
226                 char status;
227                 unsigned int mode;
228                 struct object_id oid;
229         } parent[FLEX_ARRAY];
230 };
231 #define combine_diff_path_size(n, l) \
232         st_add4(sizeof(struct combine_diff_path), (l), 1, \
233                 st_mult(sizeof(struct combine_diff_parent), (n)))
234
235 extern void show_combined_diff(struct combine_diff_path *elem, int num_parent,
236                               int dense, struct rev_info *);
237
238 extern void diff_tree_combined(const unsigned char *sha1, const struct sha1_array *parents, int dense, struct rev_info *rev);
239
240 extern void diff_tree_combined_merge(const struct commit *commit, int dense, struct rev_info *rev);
241
242 void diff_set_mnemonic_prefix(struct diff_options *options, const char *a, const char *b);
243
244 extern int diff_can_quit_early(struct diff_options *);
245
246 extern void diff_addremove(struct diff_options *,
247                            int addremove,
248                            unsigned mode,
249                            const unsigned char *sha1,
250                            int sha1_valid,
251                            const char *fullpath, unsigned dirty_submodule);
252
253 extern void diff_change(struct diff_options *,
254                         unsigned mode1, unsigned mode2,
255                         const unsigned char *sha1,
256                         const unsigned char *sha2,
257                         int sha1_valid,
258                         int sha2_valid,
259                         const char *fullpath,
260                         unsigned dirty_submodule1, unsigned dirty_submodule2);
261
262 extern struct diff_filepair *diff_unmerge(struct diff_options *, const char *path);
263
264 #define DIFF_SETUP_REVERSE              1
265 #define DIFF_SETUP_USE_CACHE            2
266 #define DIFF_SETUP_USE_SIZE_CACHE       4
267
268 /*
269  * Poor man's alternative to parse-option, to allow both stuck form
270  * (--option=value) and separate form (--option value).
271  */
272 extern int parse_long_opt(const char *opt, const char **argv,
273                          const char **optarg);
274
275 extern int git_diff_basic_config(const char *var, const char *value, void *cb);
276 extern int git_diff_heuristic_config(const char *var, const char *value, void *cb);
277 extern void init_diff_ui_defaults(void);
278 extern int git_diff_ui_config(const char *var, const char *value, void *cb);
279 extern void diff_setup(struct diff_options *);
280 extern int diff_opt_parse(struct diff_options *, const char **, int, const char *);
281 extern void diff_setup_done(struct diff_options *);
282
283 #define DIFF_DETECT_RENAME      1
284 #define DIFF_DETECT_COPY        2
285
286 #define DIFF_PICKAXE_ALL        1
287 #define DIFF_PICKAXE_REGEX      2
288
289 #define DIFF_PICKAXE_KIND_S     4 /* traditional plumbing counter */
290 #define DIFF_PICKAXE_KIND_G     8 /* grep in the patch */
291
292 extern void diffcore_std(struct diff_options *);
293 extern void diffcore_fix_diff_index(struct diff_options *);
294
295 #define COMMON_DIFF_OPTIONS_HELP \
296 "\ncommon diff options:\n" \
297 "  -z            output diff-raw with lines terminated with NUL.\n" \
298 "  -p            output patch format.\n" \
299 "  -u            synonym for -p.\n" \
300 "  --patch-with-raw\n" \
301 "                output both a patch and the diff-raw format.\n" \
302 "  --stat        show diffstat instead of patch.\n" \
303 "  --numstat     show numeric diffstat instead of patch.\n" \
304 "  --patch-with-stat\n" \
305 "                output a patch and prepend its diffstat.\n" \
306 "  --name-only   show only names of changed files.\n" \
307 "  --name-status show names and status of changed files.\n" \
308 "  --full-index  show full object name on index lines.\n" \
309 "  --abbrev=<n>  abbreviate object names in diff-tree header and diff-raw.\n" \
310 "  -R            swap input file pairs.\n" \
311 "  -B            detect complete rewrites.\n" \
312 "  -M            detect renames.\n" \
313 "  -C            detect copies.\n" \
314 "  --find-copies-harder\n" \
315 "                try unchanged files as candidate for copy detection.\n" \
316 "  -l<n>         limit rename attempts up to <n> paths.\n" \
317 "  -O<file>      reorder diffs according to the <file>.\n" \
318 "  -S<string>    find filepair whose only one side contains the string.\n" \
319 "  --pickaxe-all\n" \
320 "                show all files diff when -S is used and hit is found.\n" \
321 "  -a  --text    treat all files as text.\n"
322
323 extern int diff_queue_is_empty(void);
324 extern void diff_flush(struct diff_options*);
325 extern void diff_warn_rename_limit(const char *varname, int needed, int degraded_cc);
326
327 /* diff-raw status letters */
328 #define DIFF_STATUS_ADDED               'A'
329 #define DIFF_STATUS_COPIED              'C'
330 #define DIFF_STATUS_DELETED             'D'
331 #define DIFF_STATUS_MODIFIED            'M'
332 #define DIFF_STATUS_RENAMED             'R'
333 #define DIFF_STATUS_TYPE_CHANGED        'T'
334 #define DIFF_STATUS_UNKNOWN             'X'
335 #define DIFF_STATUS_UNMERGED            'U'
336
337 /* these are not diff-raw status letters proper, but used by
338  * diffcore-filter insn to specify additional restrictions.
339  */
340 #define DIFF_STATUS_FILTER_AON          '*'
341 #define DIFF_STATUS_FILTER_BROKEN       'B'
342
343 /*
344  * This is different from find_unique_abbrev() in that
345  * it stuffs the result with dots for alignment.
346  */
347 extern const char *diff_aligned_abbrev(const struct object_id *sha1, int);
348
349 /* do not report anything on removed paths */
350 #define DIFF_SILENT_ON_REMOVED 01
351 /* report racily-clean paths as modified */
352 #define DIFF_RACY_IS_MODIFIED 02
353 extern int run_diff_files(struct rev_info *revs, unsigned int option);
354 extern int run_diff_index(struct rev_info *revs, int cached);
355
356 extern int do_diff_cache(const unsigned char *, struct diff_options *);
357 extern int diff_flush_patch_id(struct diff_options *, unsigned char *, int);
358
359 extern int diff_result_code(struct diff_options *, int);
360
361 extern void diff_no_index(struct rev_info *, int, const char **);
362
363 extern int index_differs_from(const char *def, int diff_flags);
364
365 /*
366  * Fill the contents of the filespec "df", respecting any textconv defined by
367  * its userdiff driver.  The "driver" parameter must come from a
368  * previous call to get_textconv(), and therefore should either be NULL or have
369  * textconv enabled.
370  *
371  * Note that the memory ownership of the resulting buffer depends on whether
372  * the driver field is NULL. If it is, then the memory belongs to the filespec
373  * struct. If it is non-NULL, then "outbuf" points to a newly allocated buffer
374  * that should be freed by the caller.
375  */
376 extern size_t fill_textconv(struct userdiff_driver *driver,
377                             struct diff_filespec *df,
378                             char **outbuf);
379
380 /*
381  * Look up the userdiff driver for the given filespec, and return it if
382  * and only if it has textconv enabled (otherwise return NULL). The result
383  * can be passed to fill_textconv().
384  */
385 extern struct userdiff_driver *get_textconv(struct diff_filespec *one);
386
387 extern int parse_rename_score(const char **cp_p);
388
389 extern long parse_algorithm_value(const char *value);
390
391 extern int print_stat_summary(FILE *fp, int files,
392                               int insertions, int deletions);
393 extern void setup_diff_pager(struct diff_options *);
394
395 #endif /* DIFF_H */