Merge branch 'wp/doc-filter-direction' into maint
[git/mingw/4msysgit/kblees.git] / diffcore.h
blob66687c3fe5ea4552cff2b864b73696460ca40b1e
1 /*
2 * Copyright (C) 2005 Junio C Hamano
3 */
4 #ifndef DIFFCORE_H
5 #define DIFFCORE_H
7 /* This header file is internal between diff.c and its diff transformers
8 * (e.g. diffcore-rename, diffcore-pickaxe). Never include this header
9 * in anything else.
12 /* We internally use unsigned short as the score value,
13 * and rely on an int capable to hold 32-bits. -B can take
14 * -Bmerge_score/break_score format and the two scores are
15 * passed around in one int (high 16-bit for merge and low 16-bit
16 * for break).
18 #define MAX_SCORE 60000.0
19 #define DEFAULT_RENAME_SCORE 30000 /* rename/copy similarity minimum (50%) */
20 #define DEFAULT_BREAK_SCORE 30000 /* minimum for break to happen (50%) */
21 #define DEFAULT_MERGE_SCORE 36000 /* maximum for break-merge to happen 60%) */
23 #define MINIMUM_BREAK_SIZE 400 /* do not break a file smaller than this */
25 struct userdiff_driver;
27 struct diff_filespec {
28 unsigned char sha1[20];
29 char *path;
30 void *data;
31 void *cnt_data;
32 const char *funcname_pattern_ident;
33 unsigned long size;
34 int count; /* Reference count */
35 int xfrm_flags; /* for use by the xfrm */
36 int rename_used; /* Count of rename users */
37 unsigned short mode; /* file mode */
38 unsigned sha1_valid : 1; /* if true, use sha1 and trust mode;
39 * if false, use the name and read from
40 * the filesystem.
42 #define DIFF_FILE_VALID(spec) (((spec)->mode) != 0)
43 unsigned should_free : 1; /* data should be free()'ed */
44 unsigned should_munmap : 1; /* data should be munmap()'ed */
45 unsigned dirty_submodule : 1; /* For submodules: its work tree is dirty */
47 struct userdiff_driver *driver;
48 /* data should be considered "binary"; -1 means "don't know yet" */
49 int is_binary;
52 extern struct diff_filespec *alloc_filespec(const char *);
53 extern void free_filespec(struct diff_filespec *);
54 extern void fill_filespec(struct diff_filespec *, const unsigned char *,
55 unsigned short);
57 extern int diff_populate_filespec(struct diff_filespec *, int);
58 extern void diff_free_filespec_data(struct diff_filespec *);
59 extern void diff_free_filespec_blob(struct diff_filespec *);
60 extern int diff_filespec_is_binary(struct diff_filespec *);
62 struct diff_filepair {
63 struct diff_filespec *one;
64 struct diff_filespec *two;
65 unsigned short int score;
66 char status; /* M C R A D U etc. (see Documentation/diff-format.txt or DIFF_STATUS_* in diff.h) */
67 unsigned broken_pair : 1;
68 unsigned renamed_pair : 1;
69 unsigned is_unmerged : 1;
71 #define DIFF_PAIR_UNMERGED(p) ((p)->is_unmerged)
73 #define DIFF_PAIR_RENAME(p) ((p)->renamed_pair)
75 #define DIFF_PAIR_BROKEN(p) \
76 ( (!DIFF_FILE_VALID((p)->one) != !DIFF_FILE_VALID((p)->two)) && \
77 ((p)->broken_pair != 0) )
79 #define DIFF_PAIR_TYPE_CHANGED(p) \
80 ((S_IFMT & (p)->one->mode) != (S_IFMT & (p)->two->mode))
82 #define DIFF_PAIR_MODE_CHANGED(p) ((p)->one->mode != (p)->two->mode)
84 extern void diff_free_filepair(struct diff_filepair *);
86 extern int diff_unmodified_pair(struct diff_filepair *);
88 struct diff_queue_struct {
89 struct diff_filepair **queue;
90 int alloc;
91 int nr;
94 extern struct diff_queue_struct diff_queued_diff;
95 extern struct diff_filepair *diff_queue(struct diff_queue_struct *,
96 struct diff_filespec *,
97 struct diff_filespec *);
98 extern void diff_q(struct diff_queue_struct *, struct diff_filepair *);
100 extern void diffcore_break(int);
101 extern void diffcore_rename(struct diff_options *);
102 extern void diffcore_merge_broken(void);
103 extern void diffcore_pickaxe(const char *needle, int opts);
104 extern void diffcore_order(const char *orderfile);
106 #define DIFF_DEBUG 0
107 #if DIFF_DEBUG
108 void diff_debug_filespec(struct diff_filespec *, int, const char *);
109 void diff_debug_filepair(const struct diff_filepair *, int);
110 void diff_debug_queue(const char *, struct diff_queue_struct *);
111 #else
112 #define diff_debug_filespec(a,b,c) do {} while(0)
113 #define diff_debug_filepair(a,b) do {} while(0)
114 #define diff_debug_queue(a,b) do {} while(0)
115 #endif
117 extern int diffcore_count_changes(struct diff_filespec *src,
118 struct diff_filespec *dst,
119 void **src_count_p,
120 void **dst_count_p,
121 unsigned long delta_limit,
122 unsigned long *src_copied,
123 unsigned long *literal_added);
125 #endif