diff-options.txt: describe --stat-{width,name-width,count}
[git/dscho.git] / diffcore.h
blobb8f1fdecf4d9e5e8f8e834eb55a374f1af8352fd
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.
10  */
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%) */
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         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         unsigned dirty_submodule : 2;  /* For submodules: its work tree is dirty */
46 #define DIRTY_SUBMODULE_UNTRACKED 1
47 #define DIRTY_SUBMODULE_MODIFIED  2
49         struct userdiff_driver *driver;
50         /* data should be considered "binary"; -1 means "don't know yet" */
51         int is_binary;
54 extern struct diff_filespec *alloc_filespec(const char *);
55 extern void free_filespec(struct diff_filespec *);
56 extern void fill_filespec(struct diff_filespec *, const unsigned char *,
57                           unsigned short);
59 extern int diff_populate_filespec(struct diff_filespec *, int);
60 extern void diff_free_filespec_data(struct diff_filespec *);
61 extern void diff_free_filespec_blob(struct diff_filespec *);
62 extern int diff_filespec_is_binary(struct diff_filespec *);
64 struct diff_filepair {
65         struct diff_filespec *one;
66         struct diff_filespec *two;
67         unsigned short int score;
68         char status; /* M C R A D U etc. (see Documentation/diff-format.txt or DIFF_STATUS_* in diff.h) */
69         unsigned broken_pair : 1;
70         unsigned renamed_pair : 1;
71         unsigned is_unmerged : 1;
73 #define DIFF_PAIR_UNMERGED(p) ((p)->is_unmerged)
75 #define DIFF_PAIR_RENAME(p) ((p)->renamed_pair)
77 #define DIFF_PAIR_BROKEN(p) \
78         ( (!DIFF_FILE_VALID((p)->one) != !DIFF_FILE_VALID((p)->two)) && \
79           ((p)->broken_pair != 0) )
81 #define DIFF_PAIR_TYPE_CHANGED(p) \
82         ((S_IFMT & (p)->one->mode) != (S_IFMT & (p)->two->mode))
84 #define DIFF_PAIR_MODE_CHANGED(p) ((p)->one->mode != (p)->two->mode)
86 extern void diff_free_filepair(struct diff_filepair *);
88 extern int diff_unmodified_pair(struct diff_filepair *);
90 struct diff_queue_struct {
91         struct diff_filepair **queue;
92         int alloc;
93         int nr;
95 #define DIFF_QUEUE_CLEAR(q) \
96         do { \
97                 (q)->queue = NULL; \
98                 (q)->nr = (q)->alloc = 0; \
99         } while (0)
101 extern struct diff_queue_struct diff_queued_diff;
102 extern struct diff_filepair *diff_queue(struct diff_queue_struct *,
103                                         struct diff_filespec *,
104                                         struct diff_filespec *);
105 extern void diff_q(struct diff_queue_struct *, struct diff_filepair *);
107 extern void diffcore_break(int);
108 extern void diffcore_rename(struct diff_options *);
109 extern void diffcore_merge_broken(void);
110 extern void diffcore_pickaxe(struct diff_options *);
111 extern void diffcore_order(const char *orderfile);
113 #define DIFF_DEBUG 0
114 #if DIFF_DEBUG
115 void diff_debug_filespec(struct diff_filespec *, int, const char *);
116 void diff_debug_filepair(const struct diff_filepair *, int);
117 void diff_debug_queue(const char *, struct diff_queue_struct *);
118 #else
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)
122 #endif
124 extern int diffcore_count_changes(struct diff_filespec *src,
125                                   struct diff_filespec *dst,
126                                   void **src_count_p,
127                                   void **dst_count_p,
128                                   unsigned long delta_limit,
129                                   unsigned long *src_copied,
130                                   unsigned long *literal_added);
132 #endif