core.whitespace: split trailing-space into blank-at-{eol,eof}
[git] / diff.h
1 /*
2  * Copyright (C) 2005 Junio C Hamano
3  */
4 #ifndef DIFF_H
5 #define DIFF_H
6
7 #include "tree-walk.h"
8
9 struct rev_info;
10 struct diff_options;
11 struct diff_queue_struct;
12
13 typedef void (*change_fn_t)(struct diff_options *options,
14                  unsigned old_mode, unsigned new_mode,
15                  const unsigned char *old_sha1,
16                  const unsigned char *new_sha1,
17                  const char *fullpath);
18
19 typedef void (*add_remove_fn_t)(struct diff_options *options,
20                     int addremove, unsigned mode,
21                     const unsigned char *sha1,
22                     const char *fullpath);
23
24 typedef void (*diff_format_fn_t)(struct diff_queue_struct *q,
25                 struct diff_options *options, void *data);
26
27 #define DIFF_FORMAT_RAW         0x0001
28 #define DIFF_FORMAT_DIFFSTAT    0x0002
29 #define DIFF_FORMAT_NUMSTAT     0x0004
30 #define DIFF_FORMAT_SUMMARY     0x0008
31 #define DIFF_FORMAT_PATCH       0x0010
32 #define DIFF_FORMAT_SHORTSTAT   0x0020
33 #define DIFF_FORMAT_DIRSTAT     0x0040
34
35 /* These override all above */
36 #define DIFF_FORMAT_NAME        0x0100
37 #define DIFF_FORMAT_NAME_STATUS 0x0200
38 #define DIFF_FORMAT_CHECKDIFF   0x0400
39
40 /* Same as output_format = 0 but we know that -s flag was given
41  * and we should not give default value to output_format.
42  */
43 #define DIFF_FORMAT_NO_OUTPUT   0x0800
44
45 #define DIFF_FORMAT_CALLBACK    0x1000
46
47 #define DIFF_OPT_RECURSIVE           (1 <<  0)
48 #define DIFF_OPT_TREE_IN_RECURSIVE   (1 <<  1)
49 #define DIFF_OPT_BINARY              (1 <<  2)
50 #define DIFF_OPT_TEXT                (1 <<  3)
51 #define DIFF_OPT_FULL_INDEX          (1 <<  4)
52 #define DIFF_OPT_SILENT_ON_REMOVE    (1 <<  5)
53 #define DIFF_OPT_FIND_COPIES_HARDER  (1 <<  6)
54 #define DIFF_OPT_FOLLOW_RENAMES      (1 <<  7)
55 #define DIFF_OPT_COLOR_DIFF          (1 <<  8)
56 #define DIFF_OPT_COLOR_DIFF_WORDS    (1 <<  9)
57 #define DIFF_OPT_HAS_CHANGES         (1 << 10)
58 #define DIFF_OPT_QUIET               (1 << 11)
59 #define DIFF_OPT_NO_INDEX            (1 << 12)
60 #define DIFF_OPT_ALLOW_EXTERNAL      (1 << 13)
61 #define DIFF_OPT_EXIT_WITH_STATUS    (1 << 14)
62 #define DIFF_OPT_REVERSE_DIFF        (1 << 15)
63 #define DIFF_OPT_CHECK_FAILED        (1 << 16)
64 #define DIFF_OPT_RELATIVE_NAME       (1 << 17)
65 #define DIFF_OPT_IGNORE_SUBMODULES   (1 << 18)
66 #define DIFF_OPT_DIRSTAT_CUMULATIVE  (1 << 19)
67 #define DIFF_OPT_TST(opts, flag)    ((opts)->flags & DIFF_OPT_##flag)
68 #define DIFF_OPT_SET(opts, flag)    ((opts)->flags |= DIFF_OPT_##flag)
69 #define DIFF_OPT_CLR(opts, flag)    ((opts)->flags &= ~DIFF_OPT_##flag)
70
71 struct diff_options {
72         const char *filter;
73         const char *orderfile;
74         const char *pickaxe;
75         const char *single_follow;
76         const char *a_prefix, *b_prefix;
77         unsigned flags;
78         int context;
79         int break_opt;
80         int detect_rename;
81         int skip_stat_unmatch;
82         int line_termination;
83         int output_format;
84         int pickaxe_opts;
85         int rename_score;
86         int rename_limit;
87         int warn_on_too_large_rename;
88         int dirstat_percent;
89         int setup;
90         int abbrev;
91         const char *prefix;
92         int prefix_length;
93         const char *stat_sep;
94         long xdl_opts;
95
96         int stat_width;
97         int stat_name_width;
98
99         /* this is set by diffcore for DIFF_FORMAT_PATCH */
100         int found_changes;
101
102         FILE *file;
103         int close_file;
104
105         int nr_paths;
106         const char **paths;
107         int *pathlens;
108         change_fn_t change;
109         add_remove_fn_t add_remove;
110         diff_format_fn_t format_callback;
111         void *format_callback_data;
112 };
113
114 enum color_diff {
115         DIFF_RESET = 0,
116         DIFF_PLAIN = 1,
117         DIFF_METAINFO = 2,
118         DIFF_FRAGINFO = 3,
119         DIFF_FILE_OLD = 4,
120         DIFF_FILE_NEW = 5,
121         DIFF_COMMIT = 6,
122         DIFF_WHITESPACE = 7,
123 };
124 const char *diff_get_color(int diff_use_color, enum color_diff ix);
125 #define diff_get_color_opt(o, ix) \
126         diff_get_color(DIFF_OPT_TST((o), COLOR_DIFF), ix)
127
128
129 extern const char mime_boundary_leader[];
130
131 extern void diff_tree_setup_paths(const char **paths, struct diff_options *);
132 extern void diff_tree_release_paths(struct diff_options *);
133 extern int diff_tree(struct tree_desc *t1, struct tree_desc *t2,
134                      const char *base, struct diff_options *opt);
135 extern int diff_tree_sha1(const unsigned char *old, const unsigned char *new,
136                           const char *base, struct diff_options *opt);
137 extern int diff_root_tree_sha1(const unsigned char *new, const char *base,
138                                struct diff_options *opt);
139
140 struct combine_diff_path {
141         struct combine_diff_path *next;
142         int len;
143         char *path;
144         unsigned int mode;
145         unsigned char sha1[20];
146         struct combine_diff_parent {
147                 char status;
148                 unsigned int mode;
149                 unsigned char sha1[20];
150         } parent[FLEX_ARRAY];
151 };
152 #define combine_diff_path_size(n, l) \
153         (sizeof(struct combine_diff_path) + \
154          sizeof(struct combine_diff_parent) * (n) + (l) + 1)
155
156 extern void show_combined_diff(struct combine_diff_path *elem, int num_parent,
157                               int dense, struct rev_info *);
158
159 extern void diff_tree_combined(const unsigned char *sha1, const unsigned char parent[][20], int num_parent, int dense, struct rev_info *rev);
160
161 extern void diff_tree_combined_merge(const unsigned char *sha1, int, struct rev_info *);
162
163 extern void diff_addremove(struct diff_options *,
164                            int addremove,
165                            unsigned mode,
166                            const unsigned char *sha1,
167                            const char *fullpath);
168
169 extern void diff_change(struct diff_options *,
170                         unsigned mode1, unsigned mode2,
171                         const unsigned char *sha1,
172                         const unsigned char *sha2,
173                         const char *fullpath);
174
175 extern void diff_unmerge(struct diff_options *,
176                          const char *path,
177                          unsigned mode,
178                          const unsigned char *sha1);
179
180 #define DIFF_SETUP_REVERSE              1
181 #define DIFF_SETUP_USE_CACHE            2
182 #define DIFF_SETUP_USE_SIZE_CACHE       4
183
184 extern int git_diff_basic_config(const char *var, const char *value, void *cb);
185 extern int git_diff_ui_config(const char *var, const char *value, void *cb);
186 extern int diff_use_color_default;
187 extern void diff_setup(struct diff_options *);
188 extern int diff_opt_parse(struct diff_options *, const char **, int);
189 extern int diff_setup_done(struct diff_options *);
190
191 #define DIFF_DETECT_RENAME      1
192 #define DIFF_DETECT_COPY        2
193
194 #define DIFF_PICKAXE_ALL        1
195 #define DIFF_PICKAXE_REGEX      2
196
197 extern void diffcore_std(struct diff_options *);
198
199 #define COMMON_DIFF_OPTIONS_HELP \
200 "\ncommon diff options:\n" \
201 "  -z            output diff-raw with lines terminated with NUL.\n" \
202 "  -p            output patch format.\n" \
203 "  -u            synonym for -p.\n" \
204 "  --patch-with-raw\n" \
205 "                output both a patch and the diff-raw format.\n" \
206 "  --stat        show diffstat instead of patch.\n" \
207 "  --numstat     show numeric diffstat instead of patch.\n" \
208 "  --patch-with-stat\n" \
209 "                output a patch and prepend its diffstat.\n" \
210 "  --name-only   show only names of changed files.\n" \
211 "  --name-status show names and status of changed files.\n" \
212 "  --full-index  show full object name on index lines.\n" \
213 "  --abbrev=<n>  abbreviate object names in diff-tree header and diff-raw.\n" \
214 "  -R            swap input file pairs.\n" \
215 "  -B            detect complete rewrites.\n" \
216 "  -M            detect renames.\n" \
217 "  -C            detect copies.\n" \
218 "  --find-copies-harder\n" \
219 "                try unchanged files as candidate for copy detection.\n" \
220 "  -l<n>         limit rename attempts up to <n> paths.\n" \
221 "  -O<file>      reorder diffs according to the <file>.\n" \
222 "  -S<string>    find filepair whose only one side contains the string.\n" \
223 "  --pickaxe-all\n" \
224 "                show all files diff when -S is used and hit is found.\n" \
225 "  -a  --text    treat all files as text.\n"
226
227 extern int diff_queue_is_empty(void);
228 extern void diff_flush(struct diff_options*);
229
230 /* diff-raw status letters */
231 #define DIFF_STATUS_ADDED               'A'
232 #define DIFF_STATUS_COPIED              'C'
233 #define DIFF_STATUS_DELETED             'D'
234 #define DIFF_STATUS_MODIFIED            'M'
235 #define DIFF_STATUS_RENAMED             'R'
236 #define DIFF_STATUS_TYPE_CHANGED        'T'
237 #define DIFF_STATUS_UNKNOWN             'X'
238 #define DIFF_STATUS_UNMERGED            'U'
239
240 /* these are not diff-raw status letters proper, but used by
241  * diffcore-filter insn to specify additional restrictions.
242  */
243 #define DIFF_STATUS_FILTER_AON          '*'
244 #define DIFF_STATUS_FILTER_BROKEN       'B'
245
246 extern const char *diff_unique_abbrev(const unsigned char *, int);
247
248 /* do not report anything on removed paths */
249 #define DIFF_SILENT_ON_REMOVED 01
250 /* report racily-clean paths as modified */
251 #define DIFF_RACY_IS_MODIFIED 02
252 extern int run_diff_files(struct rev_info *revs, unsigned int option);
253 extern int run_diff_index(struct rev_info *revs, int cached);
254
255 extern int do_diff_cache(const unsigned char *, struct diff_options *);
256 extern int diff_flush_patch_id(struct diff_options *, unsigned char *);
257
258 extern int diff_result_code(struct diff_options *, int);
259
260 extern void diff_no_index(struct rev_info *, int, const char **, int, const char *);
261
262 #endif /* DIFF_H */