dir.h: move struct exclude declaration to top level
[git.git] / diffcore.h
blobc876dac71a585abb1e138444eb28258e3bf6d7e8
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 userdiff_driver;
27 struct diff_filespec {
28 unsigned char sha1[20];
29 char *path;
30 void *data;
31 void *cnt_data;
32 unsigned long size;
33 int count; /* Reference count */
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 dirty_submodule : 2; /* For submodules: its work tree is dirty */
44 #define DIRTY_SUBMODULE_UNTRACKED 1
45 #define DIRTY_SUBMODULE_MODIFIED 2
46 unsigned is_stdin : 1;
47 unsigned has_more_entries : 1; /* only appear in combined diff */
48 /* data should be considered "binary"; -1 means "don't know yet" */
49 signed int is_binary : 2;
50 struct userdiff_driver *driver;
53 extern struct diff_filespec *alloc_filespec(const char *);
54 extern void free_filespec(struct diff_filespec *);
55 extern void fill_filespec(struct diff_filespec *, const unsigned char *,
56 int, unsigned short);
58 extern int diff_populate_filespec(struct diff_filespec *, int);
59 extern void diff_free_filespec_data(struct diff_filespec *);
60 extern void diff_free_filespec_blob(struct diff_filespec *);
61 extern int diff_filespec_is_binary(struct diff_filespec *);
63 struct diff_filepair {
64 struct diff_filespec *one;
65 struct diff_filespec *two;
66 unsigned short int score;
67 char status; /* M C R A D U etc. (see Documentation/diff-format.txt or DIFF_STATUS_* in diff.h) */
68 unsigned broken_pair : 1;
69 unsigned renamed_pair : 1;
70 unsigned is_unmerged : 1;
71 unsigned done_skip_stat_unmatch : 1;
72 unsigned skip_stat_unmatch_result : 1;
74 #define DIFF_PAIR_UNMERGED(p) ((p)->is_unmerged)
76 #define DIFF_PAIR_RENAME(p) ((p)->renamed_pair)
78 #define DIFF_PAIR_BROKEN(p) \
79 ( (!DIFF_FILE_VALID((p)->one) != !DIFF_FILE_VALID((p)->two)) && \
80 ((p)->broken_pair != 0) )
82 #define DIFF_PAIR_TYPE_CHANGED(p) \
83 ((S_IFMT & (p)->one->mode) != (S_IFMT & (p)->two->mode))
85 #define DIFF_PAIR_MODE_CHANGED(p) ((p)->one->mode != (p)->two->mode)
87 extern void diff_free_filepair(struct diff_filepair *);
89 extern int diff_unmodified_pair(struct diff_filepair *);
91 struct diff_queue_struct {
92 struct diff_filepair **queue;
93 int alloc;
94 int nr;
96 #define DIFF_QUEUE_CLEAR(q) \
97 do { \
98 (q)->queue = NULL; \
99 (q)->nr = (q)->alloc = 0; \
100 } while (0)
102 extern struct diff_queue_struct diff_queued_diff;
103 extern struct diff_filepair *diff_queue(struct diff_queue_struct *,
104 struct diff_filespec *,
105 struct diff_filespec *);
106 extern void diff_q(struct diff_queue_struct *, struct diff_filepair *);
108 extern void diffcore_break(int);
109 extern void diffcore_rename(struct diff_options *);
110 extern void diffcore_merge_broken(void);
111 extern void diffcore_pickaxe(struct diff_options *);
112 extern void diffcore_order(const char *orderfile);
114 /* low-level interface to diffcore_order */
115 struct obj_order {
116 void *obj; /* setup by caller */
118 /* setup/used by order_objects() */
119 int orig_order;
120 int order;
123 typedef const char *(*obj_path_fn_t)(void *obj);
125 void order_objects(const char *orderfile, obj_path_fn_t obj_path,
126 struct obj_order *objs, int nr);
128 #define DIFF_DEBUG 0
129 #if DIFF_DEBUG
130 void diff_debug_filespec(struct diff_filespec *, int, const char *);
131 void diff_debug_filepair(const struct diff_filepair *, int);
132 void diff_debug_queue(const char *, struct diff_queue_struct *);
133 #else
134 #define diff_debug_filespec(a,b,c) do { /* nothing */ } while (0)
135 #define diff_debug_filepair(a,b) do { /* nothing */ } while (0)
136 #define diff_debug_queue(a,b) do { /* nothing */ } while (0)
137 #endif
139 extern int diffcore_count_changes(struct diff_filespec *src,
140 struct diff_filespec *dst,
141 void **src_count_p,
142 void **dst_count_p,
143 unsigned long delta_limit,
144 unsigned long *src_copied,
145 unsigned long *literal_added);
147 #endif