Fifth batch for 2.19 cycle
[git/git.git] / diffcore.h
CommitLineData
427dcb4b
JH
1/*
2 * Copyright (C) 2005 Junio C Hamano
3 */
e0173ad9
JH
4#ifndef DIFFCORE_H
5#define DIFFCORE_H
427dcb4b
JH
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 */
eeaa4603
JH
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 */
ee3d299e 18#define MAX_SCORE 60000.0
f345b0a0 19#define DEFAULT_RENAME_SCORE 30000 /* rename/copy similarity minimum (50%) */
4d0f39ce 20#define DEFAULT_BREAK_SCORE 30000 /* minimum for break to happen (50%) */
cf958afd 21#define DEFAULT_MERGE_SCORE 36000 /* maximum for break-merge to happen (60%) */
eeaa4603
JH
22
23#define MINIMUM_BREAK_SIZE 400 /* do not break a file smaller than this */
427dcb4b 24
122aa6f9
JK
25struct userdiff_driver;
26
427dcb4b 27struct diff_filespec {
a0d12c44 28 struct object_id oid;
427dcb4b
JH
29 char *path;
30 void *data;
c06c7966 31 void *cnt_data;
427dcb4b 32 unsigned long size;
9fb88419 33 int count; /* Reference count */
64479711 34 int rename_used; /* Count of rename users */
427dcb4b 35 unsigned short mode; /* file mode */
41c9560e 36 unsigned oid_valid : 1; /* if true, use oid and trust mode;
427dcb4b
JH
37 * if false, use the name and read from
38 * the filesystem.
39 */
dc7090ef 40#define DIFF_FILE_VALID(spec) (((spec)->mode) != 0)
427dcb4b
JH
41 unsigned should_free : 1; /* data should be free()'ed */
42 unsigned should_munmap : 1; /* data should be munmap()'ed */
c7e1a736
JL
43 unsigned dirty_submodule : 2; /* For submodules: its work tree is dirty */
44#define DIRTY_SUBMODULE_UNTRACKED 1
45#define DIRTY_SUBMODULE_MODIFIED 2
b837f5d6 46 unsigned is_stdin : 1;
25e5e2bf 47 unsigned has_more_entries : 1; /* only appear in combined diff */
122aa6f9 48 /* data should be considered "binary"; -1 means "don't know yet" */
7d0a9a75 49 signed int is_binary : 2;
b38f70a8 50 struct userdiff_driver *driver;
427dcb4b
JH
51};
52
53extern struct diff_filespec *alloc_filespec(const char *);
9fb88419 54extern void free_filespec(struct diff_filespec *);
f9704c2d 55extern void fill_filespec(struct diff_filespec *, const struct object_id *,
e5450100 56 int, unsigned short);
427dcb4b 57
8e5dd3d6 58#define CHECK_SIZE_ONLY 1
6bf3b813 59#define CHECK_BINARY 2
8e5dd3d6 60extern int diff_populate_filespec(struct diff_filespec *, unsigned int);
19397b45 61extern void diff_free_filespec_data(struct diff_filespec *);
8ae92e63 62extern void diff_free_filespec_blob(struct diff_filespec *);
29a3eefd 63extern int diff_filespec_is_binary(struct diff_filespec *);
427dcb4b 64
52e95789 65struct diff_filepair {
427dcb4b
JH
66 struct diff_filespec *one;
67 struct diff_filespec *two;
01c4e70f 68 unsigned short int score;
a5a323f3 69 char status; /* M C R A D U etc. (see Documentation/diff-format.txt or DIFF_STATUS_* in diff.h) */
f345b0a0 70 unsigned broken_pair : 1;
ef677686 71 unsigned renamed_pair : 1;
e9c84099 72 unsigned is_unmerged : 1;
f34b205f
NTND
73 unsigned done_skip_stat_unmatch : 1;
74 unsigned skip_stat_unmatch_result : 1;
427dcb4b 75};
e9c84099 76#define DIFF_PAIR_UNMERGED(p) ((p)->is_unmerged)
427dcb4b 77
ef677686 78#define DIFF_PAIR_RENAME(p) ((p)->renamed_pair)
01c4e70f 79
f345b0a0
JH
80#define DIFF_PAIR_BROKEN(p) \
81 ( (!DIFF_FILE_VALID((p)->one) != !DIFF_FILE_VALID((p)->two)) && \
82 ((p)->broken_pair != 0) )
83
96716a19
JH
84#define DIFF_PAIR_TYPE_CHANGED(p) \
85 ((S_IFMT & (p)->one->mode) != (S_IFMT & (p)->two->mode))
86
4130b995
JH
87#define DIFF_PAIR_MODE_CHANGED(p) ((p)->one->mode != (p)->two->mode)
88
226406f6
JH
89extern void diff_free_filepair(struct diff_filepair *);
90
f7c1512a
JH
91extern int diff_unmodified_pair(struct diff_filepair *);
92
427dcb4b 93struct diff_queue_struct {
52e95789 94 struct diff_filepair **queue;
427dcb4b
JH
95 int alloc;
96 int nr;
97};
9ca5df90
BY
98#define DIFF_QUEUE_CLEAR(q) \
99 do { \
100 (q)->queue = NULL; \
101 (q)->nr = (q)->alloc = 0; \
98746061 102 } while (0)
427dcb4b 103
38c6f780 104extern struct diff_queue_struct diff_queued_diff;
52e95789
JH
105extern struct diff_filepair *diff_queue(struct diff_queue_struct *,
106 struct diff_filespec *,
107 struct diff_filespec *);
6b14d7fa 108extern void diff_q(struct diff_queue_struct *, struct diff_filepair *);
f7c1512a 109
ce240675 110extern void diffcore_break(int);
8082d8d3 111extern void diffcore_rename(struct diff_options *);
eeaa4603 112extern void diffcore_merge_broken(void);
382f013b 113extern void diffcore_pickaxe(struct diff_options *);
ce240675
JH
114extern void diffcore_order(const char *orderfile);
115
1df4320f
KS
116/* low-level interface to diffcore_order */
117struct obj_order {
118 void *obj; /* setup by caller */
119
120 /* setup/used by order_objects() */
121 int orig_order;
122 int order;
123};
124
125typedef const char *(*obj_path_fn_t)(void *obj);
126
127void order_objects(const char *orderfile, obj_path_fn_t obj_path,
128 struct obj_order *objs, int nr);
129
25d5ea41
JH
130#define DIFF_DEBUG 0
131#if DIFF_DEBUG
132void diff_debug_filespec(struct diff_filespec *, int, const char *);
133void diff_debug_filepair(const struct diff_filepair *, int);
134void diff_debug_queue(const char *, struct diff_queue_struct *);
135#else
98746061
JN
136#define diff_debug_filespec(a,b,c) do { /* nothing */ } while (0)
137#define diff_debug_filepair(a,b) do { /* nothing */ } while (0)
138#define diff_debug_queue(a,b) do { /* nothing */ } while (0)
25d5ea41
JH
139#endif
140
d8c3d03a
JH
141extern int diffcore_count_changes(struct diff_filespec *src,
142 struct diff_filespec *dst,
c06c7966
JH
143 void **src_count_p,
144 void **dst_count_p,
65416758
JH
145 unsigned long *src_copied,
146 unsigned long *literal_added);
147
427dcb4b 148#endif