gitdiffcore doc: update pickaxe description
[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
JH
27struct diff_filespec {
28 unsigned char sha1[20];
29 char *path;
30 void *data;
c06c7966 31 void *cnt_data;
e0e324a4 32 const char *funcname_pattern_ident;
427dcb4b 33 unsigned long size;
9fb88419 34 int count; /* Reference count */
427dcb4b 35 int xfrm_flags; /* for use by the xfrm */
64479711 36 int rename_used; /* Count of rename users */
427dcb4b
JH
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 */
dc7090ef 42#define DIFF_FILE_VALID(spec) (((spec)->mode) != 0)
427dcb4b
JH
43 unsigned should_free : 1; /* data should be free()'ed */
44 unsigned should_munmap : 1; /* data should be munmap()'ed */
c7e1a736
JL
45 unsigned dirty_submodule : 2; /* For submodules: its work tree is dirty */
46#define DIRTY_SUBMODULE_UNTRACKED 1
47#define DIRTY_SUBMODULE_MODIFIED 2
122aa6f9
JK
48
49 struct userdiff_driver *driver;
50 /* data should be considered "binary"; -1 means "don't know yet" */
51 int is_binary;
427dcb4b
JH
52};
53
54extern struct diff_filespec *alloc_filespec(const char *);
9fb88419 55extern void free_filespec(struct diff_filespec *);
427dcb4b
JH
56extern void fill_filespec(struct diff_filespec *, const unsigned char *,
57 unsigned short);
58
f0c6b2a2 59extern int diff_populate_filespec(struct diff_filespec *, int);
19397b45 60extern void diff_free_filespec_data(struct diff_filespec *);
8ae92e63 61extern void diff_free_filespec_blob(struct diff_filespec *);
29a3eefd 62extern int diff_filespec_is_binary(struct diff_filespec *);
427dcb4b 63
52e95789 64struct diff_filepair {
427dcb4b
JH
65 struct diff_filespec *one;
66 struct diff_filespec *two;
01c4e70f 67 unsigned short int score;
a5a323f3 68 char status; /* M C R A D U etc. (see Documentation/diff-format.txt or DIFF_STATUS_* in diff.h) */
f345b0a0 69 unsigned broken_pair : 1;
ef677686 70 unsigned renamed_pair : 1;
e9c84099 71 unsigned is_unmerged : 1;
427dcb4b 72};
e9c84099 73#define DIFF_PAIR_UNMERGED(p) ((p)->is_unmerged)
427dcb4b 74
ef677686 75#define DIFF_PAIR_RENAME(p) ((p)->renamed_pair)
01c4e70f 76
f345b0a0
JH
77#define DIFF_PAIR_BROKEN(p) \
78 ( (!DIFF_FILE_VALID((p)->one) != !DIFF_FILE_VALID((p)->two)) && \
79 ((p)->broken_pair != 0) )
80
96716a19
JH
81#define DIFF_PAIR_TYPE_CHANGED(p) \
82 ((S_IFMT & (p)->one->mode) != (S_IFMT & (p)->two->mode))
83
4130b995
JH
84#define DIFF_PAIR_MODE_CHANGED(p) ((p)->one->mode != (p)->two->mode)
85
226406f6
JH
86extern void diff_free_filepair(struct diff_filepair *);
87
f7c1512a
JH
88extern int diff_unmodified_pair(struct diff_filepair *);
89
427dcb4b 90struct diff_queue_struct {
52e95789 91 struct diff_filepair **queue;
427dcb4b
JH
92 int alloc;
93 int nr;
94};
9ca5df90
BY
95#define DIFF_QUEUE_CLEAR(q) \
96 do { \
97 (q)->queue = NULL; \
98 (q)->nr = (q)->alloc = 0; \
98746061 99 } while (0)
427dcb4b 100
38c6f780 101extern struct diff_queue_struct diff_queued_diff;
52e95789
JH
102extern struct diff_filepair *diff_queue(struct diff_queue_struct *,
103 struct diff_filespec *,
104 struct diff_filespec *);
6b14d7fa 105extern void diff_q(struct diff_queue_struct *, struct diff_filepair *);
f7c1512a 106
ce240675 107extern void diffcore_break(int);
8082d8d3 108extern void diffcore_rename(struct diff_options *);
eeaa4603 109extern void diffcore_merge_broken(void);
ce240675
JH
110extern void diffcore_pickaxe(const char *needle, int opts);
111extern void diffcore_order(const char *orderfile);
112
25d5ea41
JH
113#define DIFF_DEBUG 0
114#if DIFF_DEBUG
115void diff_debug_filespec(struct diff_filespec *, int, const char *);
116void diff_debug_filepair(const struct diff_filepair *, int);
117void diff_debug_queue(const char *, struct diff_queue_struct *);
118#else
98746061
JN
119#define diff_debug_filespec(a,b,c) do { /* nothing */ } while (0)
120#define diff_debug_filepair(a,b) do { /* nothing */ } while (0)
121#define diff_debug_queue(a,b) do { /* nothing */ } while (0)
25d5ea41
JH
122#endif
123
d8c3d03a
JH
124extern int diffcore_count_changes(struct diff_filespec *src,
125 struct diff_filespec *dst,
c06c7966
JH
126 void **src_count_p,
127 void **dst_count_p,
65416758
JH
128 unsigned long delta_limit,
129 unsigned long *src_copied,
130 unsigned long *literal_added);
131
427dcb4b 132#endif