SubmittingPatches: improve the 'Patch:' section of the checklist
[git/git-svn.git] / diffcore.h
blobeb618b1ec00113dabcd5231f141f82e1cdfdca46
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 xfrm_flags; /* for use by the xfrm */
33 unsigned short mode; /* file mode */
34 unsigned sha1_valid : 1; /* if true, use sha1 and trust mode;
35 * if false, use the name and read from
36 * the filesystem.
38 #define DIFF_FILE_VALID(spec) (((spec)->mode) != 0)
39 unsigned should_free : 1; /* data should be free()'ed */
40 unsigned should_munmap : 1; /* data should be munmap()'ed */
41 unsigned checked_attr : 1;
42 unsigned is_binary : 1; /* data should be considered "binary" */
45 extern struct diff_filespec *alloc_filespec(const char *);
46 extern void fill_filespec(struct diff_filespec *, const unsigned char *,
47 unsigned short);
49 extern int diff_populate_filespec(struct diff_filespec *, int);
50 extern void diff_free_filespec_data(struct diff_filespec *);
51 extern void diff_free_filespec_blob(struct diff_filespec *);
52 extern int diff_filespec_is_binary(struct diff_filespec *);
54 struct diff_filepair {
55 struct diff_filespec *one;
56 struct diff_filespec *two;
57 unsigned short int score;
58 char status; /* M C R N D U (see Documentation/diff-format.txt) */
59 unsigned source_stays : 1; /* all of R/C are copies */
60 unsigned broken_pair : 1;
61 unsigned renamed_pair : 1;
62 unsigned is_unmerged : 1;
64 #define DIFF_PAIR_UNMERGED(p) ((p)->is_unmerged)
66 #define DIFF_PAIR_RENAME(p) ((p)->renamed_pair)
68 #define DIFF_PAIR_BROKEN(p) \
69 ( (!DIFF_FILE_VALID((p)->one) != !DIFF_FILE_VALID((p)->two)) && \
70 ((p)->broken_pair != 0) )
72 #define DIFF_PAIR_TYPE_CHANGED(p) \
73 ((S_IFMT & (p)->one->mode) != (S_IFMT & (p)->two->mode))
75 #define DIFF_PAIR_MODE_CHANGED(p) ((p)->one->mode != (p)->two->mode)
77 extern void diff_free_filepair(struct diff_filepair *);
79 extern int diff_unmodified_pair(struct diff_filepair *);
81 struct diff_queue_struct {
82 struct diff_filepair **queue;
83 int alloc;
84 int nr;
87 extern struct diff_queue_struct diff_queued_diff;
88 extern struct diff_filepair *diff_queue(struct diff_queue_struct *,
89 struct diff_filespec *,
90 struct diff_filespec *);
91 extern void diff_q(struct diff_queue_struct *, struct diff_filepair *);
93 extern void diffcore_pathspec(const char **pathspec);
94 extern void diffcore_break(int);
95 extern void diffcore_rename(struct diff_options *);
96 extern void diffcore_merge_broken(void);
97 extern void diffcore_pickaxe(const char *needle, int opts);
98 extern void diffcore_order(const char *orderfile);
100 #define DIFF_DEBUG 0
101 #if DIFF_DEBUG
102 void diff_debug_filespec(struct diff_filespec *, int, const char *);
103 void diff_debug_filepair(const struct diff_filepair *, int);
104 void diff_debug_queue(const char *, struct diff_queue_struct *);
105 #else
106 #define diff_debug_filespec(a,b,c) do {} while(0)
107 #define diff_debug_filepair(a,b) do {} while(0)
108 #define diff_debug_queue(a,b) do {} while(0)
109 #endif
111 extern int diffcore_count_changes(struct diff_filespec *src,
112 struct diff_filespec *dst,
113 void **src_count_p,
114 void **dst_count_p,
115 unsigned long delta_limit,
116 unsigned long *src_copied,
117 unsigned long *literal_added);
119 #endif