check_ref_format(): tighten refname rules
[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 userdiff_driver;
26
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.
41                                   */
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
46         struct userdiff_driver *driver;
47         /* data should be considered "binary"; -1 means "don't know yet" */
48         int is_binary;
49 };
50
51 extern struct diff_filespec *alloc_filespec(const char *);
52 extern void free_filespec(struct diff_filespec *);
53 extern void fill_filespec(struct diff_filespec *, const unsigned char *,
54                           unsigned short);
55
56 extern int diff_populate_filespec(struct diff_filespec *, int);
57 extern void diff_free_filespec_data(struct diff_filespec *);
58 extern void diff_free_filespec_blob(struct diff_filespec *);
59 extern int diff_filespec_is_binary(struct diff_filespec *);
60
61 struct diff_filepair {
62         struct diff_filespec *one;
63         struct diff_filespec *two;
64         unsigned short int score;
65         char status; /* M C R A D U etc. (see Documentation/diff-format.txt or DIFF_STATUS_* in diff.h) */
66         unsigned broken_pair : 1;
67         unsigned renamed_pair : 1;
68         unsigned is_unmerged : 1;
69 };
70 #define DIFF_PAIR_UNMERGED(p) ((p)->is_unmerged)
71
72 #define DIFF_PAIR_RENAME(p) ((p)->renamed_pair)
73
74 #define DIFF_PAIR_BROKEN(p) \
75         ( (!DIFF_FILE_VALID((p)->one) != !DIFF_FILE_VALID((p)->two)) && \
76           ((p)->broken_pair != 0) )
77
78 #define DIFF_PAIR_TYPE_CHANGED(p) \
79         ((S_IFMT & (p)->one->mode) != (S_IFMT & (p)->two->mode))
80
81 #define DIFF_PAIR_MODE_CHANGED(p) ((p)->one->mode != (p)->two->mode)
82
83 extern void diff_free_filepair(struct diff_filepair *);
84
85 extern int diff_unmodified_pair(struct diff_filepair *);
86
87 struct diff_queue_struct {
88         struct diff_filepair **queue;
89         int alloc;
90         int nr;
91 };
92
93 extern struct diff_queue_struct diff_queued_diff;
94 extern struct diff_filepair *diff_queue(struct diff_queue_struct *,
95                                         struct diff_filespec *,
96                                         struct diff_filespec *);
97 extern void diff_q(struct diff_queue_struct *, struct diff_filepair *);
98
99 extern void diffcore_break(int);
100 extern void diffcore_rename(struct diff_options *);
101 extern void diffcore_merge_broken(void);
102 extern void diffcore_pickaxe(const char *needle, int opts);
103 extern void diffcore_order(const char *orderfile);
104
105 #define DIFF_DEBUG 0
106 #if DIFF_DEBUG
107 void diff_debug_filespec(struct diff_filespec *, int, const char *);
108 void diff_debug_filepair(const struct diff_filepair *, int);
109 void diff_debug_queue(const char *, struct diff_queue_struct *);
110 #else
111 #define diff_debug_filespec(a,b,c) do {} while(0)
112 #define diff_debug_filepair(a,b) do {} while(0)
113 #define diff_debug_queue(a,b) do {} while(0)
114 #endif
115
116 extern int diffcore_count_changes(struct diff_filespec *src,
117                                   struct diff_filespec *dst,
118                                   void **src_count_p,
119                                   void **dst_count_p,
120                                   unsigned long delta_limit,
121                                   unsigned long *src_copied,
122                                   unsigned long *literal_added);
123
124 #endif