Documentation: A few minor fixes to Git User's Manual
[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  36000 /* maximum for break-merge to happen 60%) */
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         void *cnt_data;
30         unsigned long size;
31         int xfrm_flags;          /* for use by the xfrm */
32         unsigned short mode;     /* file mode */
33         unsigned sha1_valid : 1; /* if true, use sha1 and trust mode;
34                                   * if false, use the name and read from
35                                   * the filesystem.
36                                   */
37 #define DIFF_FILE_VALID(spec) (((spec)->mode) != 0)
38         unsigned should_free : 1; /* data should be free()'ed */
39         unsigned should_munmap : 1; /* data should be munmap()'ed */
40 };
41
42 extern struct diff_filespec *alloc_filespec(const char *);
43 extern void fill_filespec(struct diff_filespec *, const unsigned char *,
44                           unsigned short);
45
46 extern int diff_populate_filespec(struct diff_filespec *, int);
47 extern void diff_free_filespec_data(struct diff_filespec *);
48
49 struct diff_filepair {
50         struct diff_filespec *one;
51         struct diff_filespec *two;
52         unsigned short int score;
53         char status; /* M C R N D U (see Documentation/diff-format.txt) */
54         unsigned source_stays : 1; /* all of R/C are copies */
55         unsigned broken_pair : 1;
56         unsigned renamed_pair : 1;
57         unsigned is_unmerged : 1;
58 };
59 #define DIFF_PAIR_UNMERGED(p) ((p)->is_unmerged)
60
61 #define DIFF_PAIR_RENAME(p) ((p)->renamed_pair)
62
63 #define DIFF_PAIR_BROKEN(p) \
64         ( (!DIFF_FILE_VALID((p)->one) != !DIFF_FILE_VALID((p)->two)) && \
65           ((p)->broken_pair != 0) )
66
67 #define DIFF_PAIR_TYPE_CHANGED(p) \
68         ((S_IFMT & (p)->one->mode) != (S_IFMT & (p)->two->mode))
69
70 #define DIFF_PAIR_MODE_CHANGED(p) ((p)->one->mode != (p)->two->mode)
71
72 extern void diff_free_filepair(struct diff_filepair *);
73
74 extern int diff_unmodified_pair(struct diff_filepair *);
75
76 struct diff_queue_struct {
77         struct diff_filepair **queue;
78         int alloc;
79         int nr;
80 };
81
82 extern struct diff_queue_struct diff_queued_diff;
83 extern struct diff_filepair *diff_queue(struct diff_queue_struct *,
84                                         struct diff_filespec *,
85                                         struct diff_filespec *);
86 extern void diff_q(struct diff_queue_struct *, struct diff_filepair *);
87
88 extern void diffcore_pathspec(const char **pathspec);
89 extern void diffcore_break(int);
90 extern void diffcore_rename(struct diff_options *);
91 extern void diffcore_merge_broken(void);
92 extern void diffcore_pickaxe(const char *needle, int opts);
93 extern void diffcore_order(const char *orderfile);
94
95 #define DIFF_DEBUG 0
96 #if DIFF_DEBUG
97 void diff_debug_filespec(struct diff_filespec *, int, const char *);
98 void diff_debug_filepair(const struct diff_filepair *, int);
99 void diff_debug_queue(const char *, struct diff_queue_struct *);
100 #else
101 #define diff_debug_filespec(a,b,c) do {} while(0)
102 #define diff_debug_filepair(a,b) do {} while(0)
103 #define diff_debug_queue(a,b) do {} while(0)
104 #endif
105
106 extern int diffcore_count_changes(void *src, unsigned long src_size,
107                                   void *dst, unsigned long dst_size,
108                                   void **src_count_p,
109                                   void **dst_count_p,
110                                   unsigned long delta_limit,
111                                   unsigned long *src_copied,
112                                   unsigned long *literal_added);
113
114 #endif