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