Merge branch 'jc/tag'
[git.git] / diffcore.h
1 /*
2  * Copyright (C) 2005 Junio C Hamano
3  */
4 #ifndef _DIFFCORE_H_
5 #define _DIFFCORE_H_
6
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.
10  */
11
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).
17  */
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  48000 /* maximum for break-merge to happen (80%)*/
22
23 #define MINIMUM_BREAK_SIZE     400 /* do not break a file smaller than this */
24
25 struct diff_filespec {
26         unsigned char sha1[20];
27         char *path;
28         void *data;
29         unsigned long size;
30         int xfrm_flags;          /* for use by the xfrm */
31         unsigned short mode;     /* file mode */
32         unsigned sha1_valid : 1; /* if true, use sha1 and trust mode;
33                                   * if false, use the name and read from
34                                   * the filesystem.
35                                   */
36 #define DIFF_FILE_VALID(spec) (((spec)->mode) != 0)
37         unsigned should_free : 1; /* data should be free()'ed */
38         unsigned should_munmap : 1; /* data should be munmap()'ed */
39 };
40
41 extern struct diff_filespec *alloc_filespec(const char *);
42 extern void fill_filespec(struct diff_filespec *, const unsigned char *,
43                           unsigned short);
44
45 extern int diff_populate_filespec(struct diff_filespec *, int);
46 extern void diff_free_filespec_data(struct diff_filespec *);
47
48 struct diff_filepair {
49         struct diff_filespec *one;
50         struct diff_filespec *two;
51         unsigned short int score;
52         char status; /* M C R N D U (see Documentation/diff-format.txt) */
53         unsigned source_stays : 1; /* all of R/C are copies */
54         unsigned broken_pair : 1;
55 };
56 #define DIFF_PAIR_UNMERGED(p) \
57         (!DIFF_FILE_VALID((p)->one) && !DIFF_FILE_VALID((p)->two))
58
59 #define DIFF_PAIR_RENAME(p) (strcmp((p)->one->path, (p)->two->path))
60
61 #define DIFF_PAIR_BROKEN(p) \
62         ( (!DIFF_FILE_VALID((p)->one) != !DIFF_FILE_VALID((p)->two)) && \
63           ((p)->broken_pair != 0) )
64
65 #define DIFF_PAIR_TYPE_CHANGED(p) \
66         ((S_IFMT & (p)->one->mode) != (S_IFMT & (p)->two->mode))
67
68 #define DIFF_PAIR_MODE_CHANGED(p) ((p)->one->mode != (p)->two->mode)
69
70 extern void diff_free_filepair(struct diff_filepair *);
71
72 extern int diff_unmodified_pair(struct diff_filepair *);
73
74 struct diff_queue_struct {
75         struct diff_filepair **queue;
76         int alloc;
77         int nr;
78 };
79
80 extern struct diff_queue_struct diff_queued_diff;
81 extern struct diff_filepair *diff_queue(struct diff_queue_struct *,
82                                         struct diff_filespec *,
83                                         struct diff_filespec *);
84 extern void diff_q(struct diff_queue_struct *, struct diff_filepair *);
85
86 extern void diffcore_pathspec(const char **pathspec);
87 extern void diffcore_break(int);
88 extern void diffcore_rename(struct diff_options *);
89 extern void diffcore_merge_broken(void);
90 extern void diffcore_pickaxe(const char *needle, int opts);
91 extern void diffcore_order(const char *orderfile);
92
93 #define DIFF_DEBUG 0
94 #if DIFF_DEBUG
95 void diff_debug_filespec(struct diff_filespec *, int, const char *);
96 void diff_debug_filepair(const struct diff_filepair *, int);
97 void diff_debug_queue(const char *, struct diff_queue_struct *);
98 #else
99 #define diff_debug_filespec(a,b,c) do {} while(0)
100 #define diff_debug_filepair(a,b) do {} while(0)
101 #define diff_debug_queue(a,b) do {} while(0)
102 #endif
103
104 extern int diffcore_count_changes(void *src, unsigned long src_size,
105                                   void *dst, unsigned long dst_size,
106                                   unsigned long delta_limit,
107                                   unsigned long *src_copied,
108                                   unsigned long *literal_added);
109
110 #endif