Improve documentation for --dirstat diff option
[git/spearce.git] / diffcore.h
blobcc96c20734bf4184970f5381416637cf6e45ea13
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 diff_filespec {
26 unsigned char sha1[20];
27 char *path;
28 void *data;
29 void *cnt_data;
30 const char *funcname_pattern_ident;
31 unsigned long size;
32 int count; /* Reference count */
33 int xfrm_flags; /* for use by the xfrm */
34 int rename_used; /* Count of rename users */
35 unsigned short mode; /* file mode */
36 unsigned sha1_valid : 1; /* if true, use sha1 and trust mode;
37 * if false, use the name and read from
38 * the filesystem.
40 #define DIFF_FILE_VALID(spec) (((spec)->mode) != 0)
41 unsigned should_free : 1; /* data should be free()'ed */
42 unsigned should_munmap : 1; /* data should be munmap()'ed */
43 unsigned checked_attr : 1;
44 unsigned is_binary : 1; /* data should be considered "binary" */
47 extern struct diff_filespec *alloc_filespec(const char *);
48 extern void free_filespec(struct diff_filespec *);
49 extern void fill_filespec(struct diff_filespec *, const unsigned char *,
50 unsigned short);
52 extern int diff_populate_filespec(struct diff_filespec *, int);
53 extern void diff_free_filespec_data(struct diff_filespec *);
54 extern void diff_free_filespec_blob(struct diff_filespec *);
55 extern int diff_filespec_is_binary(struct diff_filespec *);
57 struct diff_filepair {
58 struct diff_filespec *one;
59 struct diff_filespec *two;
60 unsigned short int score;
61 char status; /* M C R N D U (see Documentation/diff-format.txt) */
62 unsigned broken_pair : 1;
63 unsigned renamed_pair : 1;
64 unsigned is_unmerged : 1;
66 #define DIFF_PAIR_UNMERGED(p) ((p)->is_unmerged)
68 #define DIFF_PAIR_RENAME(p) ((p)->renamed_pair)
70 #define DIFF_PAIR_BROKEN(p) \
71 ( (!DIFF_FILE_VALID((p)->one) != !DIFF_FILE_VALID((p)->two)) && \
72 ((p)->broken_pair != 0) )
74 #define DIFF_PAIR_TYPE_CHANGED(p) \
75 ((S_IFMT & (p)->one->mode) != (S_IFMT & (p)->two->mode))
77 #define DIFF_PAIR_MODE_CHANGED(p) ((p)->one->mode != (p)->two->mode)
79 extern void diff_free_filepair(struct diff_filepair *);
81 extern int diff_unmodified_pair(struct diff_filepair *);
83 struct diff_queue_struct {
84 struct diff_filepair **queue;
85 int alloc;
86 int nr;
89 extern struct diff_queue_struct diff_queued_diff;
90 extern struct diff_filepair *diff_queue(struct diff_queue_struct *,
91 struct diff_filespec *,
92 struct diff_filespec *);
93 extern void diff_q(struct diff_queue_struct *, struct diff_filepair *);
95 extern void diffcore_pathspec(const char **pathspec);
96 extern void diffcore_break(int);
97 extern void diffcore_rename(struct diff_options *);
98 extern void diffcore_merge_broken(void);
99 extern void diffcore_pickaxe(const char *needle, int opts);
100 extern void diffcore_order(const char *orderfile);
102 #define DIFF_DEBUG 0
103 #if DIFF_DEBUG
104 void diff_debug_filespec(struct diff_filespec *, int, const char *);
105 void diff_debug_filepair(const struct diff_filepair *, int);
106 void diff_debug_queue(const char *, struct diff_queue_struct *);
107 #else
108 #define diff_debug_filespec(a,b,c) do {} while(0)
109 #define diff_debug_filepair(a,b) do {} while(0)
110 #define diff_debug_queue(a,b) do {} while(0)
111 #endif
113 extern int diffcore_count_changes(struct diff_filespec *src,
114 struct diff_filespec *dst,
115 void **src_count_p,
116 void **dst_count_p,
117 unsigned long delta_limit,
118 unsigned long *src_copied,
119 unsigned long *literal_added);
121 #endif