Merge branch 'jk/filter-branch-require-clean-work-tree' into maint
[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 struct strbuf;
13 struct diff_filespec;
14 struct userdiff_driver;
15
16 typedef void (*change_fn_t)(struct diff_options *options,
17                  unsigned old_mode, unsigned new_mode,
18                  const unsigned char *old_sha1,
19                  const unsigned char *new_sha1,
20                  const char *fullpath,
21                  unsigned old_dirty_submodule, unsigned new_dirty_submodule);
22
23 typedef void (*add_remove_fn_t)(struct diff_options *options,
24                     int addremove, unsigned mode,
25                     const unsigned char *sha1,
26                     const char *fullpath, unsigned dirty_submodule);
27
28 typedef void (*diff_format_fn_t)(struct diff_queue_struct *q,
29                 struct diff_options *options, void *data);
30
31 typedef struct strbuf *(*diff_prefix_fn_t)(struct diff_options *opt, void *data);
32
33 #define DIFF_FORMAT_RAW         0x0001
34 #define DIFF_FORMAT_DIFFSTAT    0x0002
35 #define DIFF_FORMAT_NUMSTAT     0x0004
36 #define DIFF_FORMAT_SUMMARY     0x0008
37 #define DIFF_FORMAT_PATCH       0x0010
38 #define DIFF_FORMAT_SHORTSTAT   0x0020
39 #define DIFF_FORMAT_DIRSTAT     0x0040
40
41 /* These override all above */
42 #define DIFF_FORMAT_NAME        0x0100
43 #define DIFF_FORMAT_NAME_STATUS 0x0200
44 #define DIFF_FORMAT_CHECKDIFF   0x0400
45
46 /* Same as output_format = 0 but we know that -s flag was given
47  * and we should not give default value to output_format.
48  */
49 #define DIFF_FORMAT_NO_OUTPUT   0x0800
50
51 #define DIFF_FORMAT_CALLBACK    0x1000
52
53 #define DIFF_OPT_RECURSIVE           (1 <<  0)
54 #define DIFF_OPT_TREE_IN_RECURSIVE   (1 <<  1)
55 #define DIFF_OPT_BINARY              (1 <<  2)
56 #define DIFF_OPT_TEXT                (1 <<  3)
57 #define DIFF_OPT_FULL_INDEX          (1 <<  4)
58 #define DIFF_OPT_SILENT_ON_REMOVE    (1 <<  5)
59 #define DIFF_OPT_FIND_COPIES_HARDER  (1 <<  6)
60 #define DIFF_OPT_FOLLOW_RENAMES      (1 <<  7)
61 /* (1 <<  8) unused */
62 /* (1 <<  9) unused */
63 #define DIFF_OPT_HAS_CHANGES         (1 << 10)
64 #define DIFF_OPT_QUICK               (1 << 11)
65 #define DIFF_OPT_NO_INDEX            (1 << 12)
66 #define DIFF_OPT_ALLOW_EXTERNAL      (1 << 13)
67 #define DIFF_OPT_EXIT_WITH_STATUS    (1 << 14)
68 #define DIFF_OPT_REVERSE_DIFF        (1 << 15)
69 #define DIFF_OPT_CHECK_FAILED        (1 << 16)
70 #define DIFF_OPT_RELATIVE_NAME       (1 << 17)
71 #define DIFF_OPT_IGNORE_SUBMODULES   (1 << 18)
72 #define DIFF_OPT_DIRSTAT_CUMULATIVE  (1 << 19)
73 #define DIFF_OPT_DIRSTAT_BY_FILE     (1 << 20)
74 #define DIFF_OPT_ALLOW_TEXTCONV      (1 << 21)
75 #define DIFF_OPT_DIFF_FROM_CONTENTS  (1 << 22)
76 #define DIFF_OPT_SUBMODULE_LOG       (1 << 23)
77 #define DIFF_OPT_DIRTY_SUBMODULES    (1 << 24)
78 #define DIFF_OPT_IGNORE_UNTRACKED_IN_SUBMODULES (1 << 25)
79 #define DIFF_OPT_IGNORE_DIRTY_SUBMODULES (1 << 26)
80 #define DIFF_OPT_OVERRIDE_SUBMODULE_CONFIG (1 << 27)
81 #define DIFF_OPT_DIRSTAT_BY_LINE     (1 << 28)
82
83 #define DIFF_OPT_TST(opts, flag)    ((opts)->flags & DIFF_OPT_##flag)
84 #define DIFF_OPT_SET(opts, flag)    ((opts)->flags |= DIFF_OPT_##flag)
85 #define DIFF_OPT_CLR(opts, flag)    ((opts)->flags &= ~DIFF_OPT_##flag)
86 #define DIFF_XDL_TST(opts, flag)    ((opts)->xdl_opts & XDF_##flag)
87 #define DIFF_XDL_SET(opts, flag)    ((opts)->xdl_opts |= XDF_##flag)
88 #define DIFF_XDL_CLR(opts, flag)    ((opts)->xdl_opts &= ~XDF_##flag)
89
90 enum diff_words_type {
91         DIFF_WORDS_NONE = 0,
92         DIFF_WORDS_PORCELAIN,
93         DIFF_WORDS_PLAIN,
94         DIFF_WORDS_COLOR
95 };
96
97 struct diff_options {
98         const char *filter;
99         const char *orderfile;
100         const char *pickaxe;
101         const char *single_follow;
102         const char *a_prefix, *b_prefix;
103         unsigned flags;
104         int use_color;
105         int context;
106         int interhunkcontext;
107         int break_opt;
108         int detect_rename;
109         int irreversible_delete;
110         int skip_stat_unmatch;
111         int line_termination;
112         int output_format;
113         int pickaxe_opts;
114         int rename_score;
115         int rename_limit;
116         int needed_rename_limit;
117         int degraded_cc_to_c;
118         int show_rename_progress;
119         int dirstat_permille;
120         int setup;
121         int abbrev;
122         const char *prefix;
123         int prefix_length;
124         const char *stat_sep;
125         long xdl_opts;
126
127         int stat_width;
128         int stat_name_width;
129         int stat_count;
130         const char *word_regex;
131         enum diff_words_type word_diff;
132
133         /* this is set by diffcore for DIFF_FORMAT_PATCH */
134         int found_changes;
135
136         /* to support internal diff recursion by --follow hack*/
137         int found_follow;
138
139         FILE *file;
140         int close_file;
141
142         struct pathspec pathspec;
143         change_fn_t change;
144         add_remove_fn_t add_remove;
145         diff_format_fn_t format_callback;
146         void *format_callback_data;
147         diff_prefix_fn_t output_prefix;
148         void *output_prefix_data;
149 };
150
151 enum color_diff {
152         DIFF_RESET = 0,
153         DIFF_PLAIN = 1,
154         DIFF_METAINFO = 2,
155         DIFF_FRAGINFO = 3,
156         DIFF_FILE_OLD = 4,
157         DIFF_FILE_NEW = 5,
158         DIFF_COMMIT = 6,
159         DIFF_WHITESPACE = 7,
160         DIFF_FUNCINFO = 8
161 };
162 const char *diff_get_color(int diff_use_color, enum color_diff ix);
163 #define diff_get_color_opt(o, ix) \
164         diff_get_color((o)->use_color, ix)
165
166
167 extern const char mime_boundary_leader[];
168
169 extern void diff_tree_setup_paths(const char **paths, struct diff_options *);
170 extern void diff_tree_release_paths(struct diff_options *);
171 extern int diff_tree(struct tree_desc *t1, struct tree_desc *t2,
172                      const char *base, struct diff_options *opt);
173 extern int diff_tree_sha1(const unsigned char *old, const unsigned char *new,
174                           const char *base, struct diff_options *opt);
175 extern int diff_root_tree_sha1(const unsigned char *new, const char *base,
176                                struct diff_options *opt);
177
178 struct combine_diff_path {
179         struct combine_diff_path *next;
180         int len;
181         char *path;
182         unsigned int mode;
183         unsigned char sha1[20];
184         struct combine_diff_parent {
185                 char status;
186                 unsigned int mode;
187                 unsigned char sha1[20];
188         } parent[FLEX_ARRAY];
189 };
190 #define combine_diff_path_size(n, l) \
191         (sizeof(struct combine_diff_path) + \
192          sizeof(struct combine_diff_parent) * (n) + (l) + 1)
193
194 extern void show_combined_diff(struct combine_diff_path *elem, int num_parent,
195                               int dense, struct rev_info *);
196
197 extern void diff_tree_combined(const unsigned char *sha1, const unsigned char parent[][20], int num_parent, int dense, struct rev_info *rev);
198
199 extern void diff_tree_combined_merge(const unsigned char *sha1, int, struct rev_info *);
200
201 void diff_set_mnemonic_prefix(struct diff_options *options, const char *a, const char *b);
202
203 extern int diff_can_quit_early(struct diff_options *);
204
205 extern void diff_addremove(struct diff_options *,
206                            int addremove,
207                            unsigned mode,
208                            const unsigned char *sha1,
209                            const char *fullpath, unsigned dirty_submodule);
210
211 extern void diff_change(struct diff_options *,
212                         unsigned mode1, unsigned mode2,
213                         const unsigned char *sha1,
214                         const unsigned char *sha2,
215                         const char *fullpath,
216                         unsigned dirty_submodule1, unsigned dirty_submodule2);
217
218 extern struct diff_filepair *diff_unmerge(struct diff_options *, const char *path);
219
220 #define DIFF_SETUP_REVERSE              1
221 #define DIFF_SETUP_USE_CACHE            2
222 #define DIFF_SETUP_USE_SIZE_CACHE       4
223
224 /*
225  * Poor man's alternative to parse-option, to allow both sticked form
226  * (--option=value) and separate form (--option value).
227  */
228 extern int parse_long_opt(const char *opt, const char **argv,
229                          const char **optarg);
230
231 extern int git_diff_basic_config(const char *var, const char *value, void *cb);
232 extern int git_diff_ui_config(const char *var, const char *value, void *cb);
233 extern int diff_use_color_default;
234 extern void diff_setup(struct diff_options *);
235 extern int diff_opt_parse(struct diff_options *, const char **, int);
236 extern int diff_setup_done(struct diff_options *);
237
238 #define DIFF_DETECT_RENAME      1
239 #define DIFF_DETECT_COPY        2
240
241 #define DIFF_PICKAXE_ALL        1
242 #define DIFF_PICKAXE_REGEX      2
243
244 #define DIFF_PICKAXE_KIND_S     4 /* traditional plumbing counter */
245 #define DIFF_PICKAXE_KIND_G     8 /* grep in the patch */
246
247 extern void diffcore_std(struct diff_options *);
248 extern void diffcore_fix_diff_index(struct diff_options *);
249
250 #define COMMON_DIFF_OPTIONS_HELP \
251 "\ncommon diff options:\n" \
252 "  -z            output diff-raw with lines terminated with NUL.\n" \
253 "  -p            output patch format.\n" \
254 "  -u            synonym for -p.\n" \
255 "  --patch-with-raw\n" \
256 "                output both a patch and the diff-raw format.\n" \
257 "  --stat        show diffstat instead of patch.\n" \
258 "  --numstat     show numeric diffstat instead of patch.\n" \
259 "  --patch-with-stat\n" \
260 "                output a patch and prepend its diffstat.\n" \
261 "  --name-only   show only names of changed files.\n" \
262 "  --name-status show names and status of changed files.\n" \
263 "  --full-index  show full object name on index lines.\n" \
264 "  --abbrev=<n>  abbreviate object names in diff-tree header and diff-raw.\n" \
265 "  -R            swap input file pairs.\n" \
266 "  -B            detect complete rewrites.\n" \
267 "  -M            detect renames.\n" \
268 "  -C            detect copies.\n" \
269 "  --find-copies-harder\n" \
270 "                try unchanged files as candidate for copy detection.\n" \
271 "  -l<n>         limit rename attempts up to <n> paths.\n" \
272 "  -O<file>      reorder diffs according to the <file>.\n" \
273 "  -S<string>    find filepair whose only one side contains the string.\n" \
274 "  --pickaxe-all\n" \
275 "                show all files diff when -S is used and hit is found.\n" \
276 "  -a  --text    treat all files as text.\n"
277
278 extern int diff_queue_is_empty(void);
279 extern void diff_flush(struct diff_options*);
280 extern void diff_warn_rename_limit(const char *varname, int needed, int degraded_cc);
281
282 /* diff-raw status letters */
283 #define DIFF_STATUS_ADDED               'A'
284 #define DIFF_STATUS_COPIED              'C'
285 #define DIFF_STATUS_DELETED             'D'
286 #define DIFF_STATUS_MODIFIED            'M'
287 #define DIFF_STATUS_RENAMED             'R'
288 #define DIFF_STATUS_TYPE_CHANGED        'T'
289 #define DIFF_STATUS_UNKNOWN             'X'
290 #define DIFF_STATUS_UNMERGED            'U'
291
292 /* these are not diff-raw status letters proper, but used by
293  * diffcore-filter insn to specify additional restrictions.
294  */
295 #define DIFF_STATUS_FILTER_AON          '*'
296 #define DIFF_STATUS_FILTER_BROKEN       'B'
297
298 extern const char *diff_unique_abbrev(const unsigned char *, int);
299
300 /* do not report anything on removed paths */
301 #define DIFF_SILENT_ON_REMOVED 01
302 /* report racily-clean paths as modified */
303 #define DIFF_RACY_IS_MODIFIED 02
304 extern int run_diff_files(struct rev_info *revs, unsigned int option);
305 extern int run_diff_index(struct rev_info *revs, int cached);
306
307 extern int do_diff_cache(const unsigned char *, struct diff_options *);
308 extern int diff_flush_patch_id(struct diff_options *, unsigned char *);
309
310 extern int diff_result_code(struct diff_options *, int);
311
312 extern void diff_no_index(struct rev_info *, int, const char **, int, const char *);
313
314 extern int index_differs_from(const char *def, int diff_flags);
315
316 extern size_t fill_textconv(struct userdiff_driver *driver,
317                             struct diff_filespec *df,
318                             char **outbuf);
319
320 extern struct userdiff_driver *get_textconv(struct diff_filespec *one);
321
322 extern int parse_rename_score(const char **cp_p);
323
324 #endif /* DIFF_H */