tree-diff: consolidate code for emitting diffs and recursion in one place
[git] / tree-diff.c
1 /*
2  * Helper functions for tree diff generation
3  */
4 #include "cache.h"
5 #include "diff.h"
6 #include "diffcore.h"
7 #include "tree.h"
8
9 static void show_path(struct strbuf *base, struct diff_options *opt,
10                       struct tree_desc *t1, struct tree_desc *t2);
11
12 static int compare_tree_entry(struct tree_desc *t1, struct tree_desc *t2,
13                               struct strbuf *base, struct diff_options *opt)
14 {
15         unsigned mode1, mode2;
16         const char *path1, *path2;
17         const unsigned char *sha1, *sha2;
18         int cmp, pathlen1, pathlen2;
19
20         sha1 = tree_entry_extract(t1, &path1, &mode1);
21         sha2 = tree_entry_extract(t2, &path2, &mode2);
22
23         pathlen1 = tree_entry_len(&t1->entry);
24         pathlen2 = tree_entry_len(&t2->entry);
25
26         /*
27          * NOTE files and directories *always* compare differently,
28          * even when having the same name.
29          */
30         cmp = base_name_compare(path1, pathlen1, mode1, path2, pathlen2, mode2);
31         if (cmp < 0) {
32                 show_path(base, opt, t1, /*t2=*/NULL);
33                 return -1;
34         }
35         if (cmp > 0) {
36                 show_path(base, opt, /*t1=*/NULL, t2);
37                 return 1;
38         }
39         if (!DIFF_OPT_TST(opt, FIND_COPIES_HARDER) && !hashcmp(sha1, sha2) && mode1 == mode2)
40                 return 0;
41
42         show_path(base, opt, t1, t2);
43         return 0;
44 }
45
46
47 /* convert path, t1/t2 -> opt->diff_*() callbacks */
48 static void emit_diff(struct diff_options *opt, struct strbuf *path,
49                       struct tree_desc *t1, struct tree_desc *t2)
50 {
51         unsigned int mode1 = t1 ? t1->entry.mode : 0;
52         unsigned int mode2 = t2 ? t2->entry.mode : 0;
53
54         if (mode1 && mode2) {
55                 opt->change(opt, mode1, mode2, t1->entry.sha1, t2->entry.sha1,
56                         1, 1, path->buf, 0, 0);
57         }
58         else {
59                 const unsigned char *sha1;
60                 unsigned int mode;
61                 int addremove;
62
63                 if (mode2) {
64                         addremove = '+';
65                         sha1 = t2->entry.sha1;
66                         mode = mode2;
67                 } else {
68                         addremove = '-';
69                         sha1 = t1->entry.sha1;
70                         mode = mode1;
71                 }
72
73                 opt->add_remove(opt, addremove, mode, sha1, 1, path->buf, 0);
74         }
75 }
76
77
78 /* new path should be added to diff
79  *
80  * 3 cases on how/when it should be called and behaves:
81  *
82  *      !t1,  t2        -> path added, parent lacks it
83  *       t1, !t2        -> path removed from parent
84  *       t1,  t2        -> path modified
85  */
86 static void show_path(struct strbuf *base, struct diff_options *opt,
87                       struct tree_desc *t1, struct tree_desc *t2)
88 {
89         unsigned mode;
90         const char *path;
91         int pathlen;
92         int old_baselen = base->len;
93         int isdir, recurse = 0, emitthis = 1;
94
95         /* at least something has to be valid */
96         assert(t1 || t2);
97
98         if (t2) {
99                 /* path present in resulting tree */
100                 tree_entry_extract(t2, &path, &mode);
101                 pathlen = tree_entry_len(&t2->entry);
102                 isdir = S_ISDIR(mode);
103         } else {
104                 /*
105                  * a path was removed - take path from parent. Also take
106                  * mode from parent, to decide on recursion.
107                  */
108                 tree_entry_extract(t1, &path, &mode);
109                 pathlen = tree_entry_len(&t1->entry);
110
111                 isdir = S_ISDIR(mode);
112                 mode = 0;
113         }
114
115         if (DIFF_OPT_TST(opt, RECURSIVE) && isdir) {
116                 recurse = 1;
117                 emitthis = DIFF_OPT_TST(opt, TREE_IN_RECURSIVE);
118         }
119
120         strbuf_add(base, path, pathlen);
121
122         if (emitthis)
123                 emit_diff(opt, base, t1, t2);
124
125         if (recurse) {
126                 strbuf_addch(base, '/');
127                 diff_tree_sha1(t1 ? t1->entry.sha1 : NULL,
128                                t2 ? t2->entry.sha1 : NULL, base->buf, opt);
129         }
130
131         strbuf_setlen(base, old_baselen);
132 }
133
134 static void skip_uninteresting(struct tree_desc *t, struct strbuf *base,
135                                struct diff_options *opt)
136 {
137         enum interesting match;
138
139         while (t->size) {
140                 match = tree_entry_interesting(&t->entry, base, 0, &opt->pathspec);
141                 if (match) {
142                         if (match == all_entries_not_interesting)
143                                 t->size = 0;
144                         break;
145                 }
146                 update_tree_entry(t);
147         }
148 }
149
150 int diff_tree(struct tree_desc *t1, struct tree_desc *t2,
151               const char *base_str, struct diff_options *opt)
152 {
153         struct strbuf base;
154         int baselen = strlen(base_str);
155
156         /* Enable recursion indefinitely */
157         opt->pathspec.recursive = DIFF_OPT_TST(opt, RECURSIVE);
158
159         strbuf_init(&base, PATH_MAX);
160         strbuf_add(&base, base_str, baselen);
161
162         for (;;) {
163                 if (diff_can_quit_early(opt))
164                         break;
165                 if (opt->pathspec.nr) {
166                         skip_uninteresting(t1, &base, opt);
167                         skip_uninteresting(t2, &base, opt);
168                 }
169                 if (!t1->size) {
170                         if (!t2->size)
171                                 break;
172                         show_path(&base, opt, /*t1=*/NULL, t2);
173                         update_tree_entry(t2);
174                         continue;
175                 }
176                 if (!t2->size) {
177                         show_path(&base, opt, t1, /*t2=*/NULL);
178                         update_tree_entry(t1);
179                         continue;
180                 }
181                 switch (compare_tree_entry(t1, t2, &base, opt)) {
182                 case -1:
183                         update_tree_entry(t1);
184                         continue;
185                 case 0:
186                         update_tree_entry(t1);
187                         /* Fallthrough */
188                 case 1:
189                         update_tree_entry(t2);
190                         continue;
191                 }
192                 die("git diff-tree: internal error");
193         }
194
195         strbuf_release(&base);
196         return 0;
197 }
198
199 /*
200  * Does it look like the resulting diff might be due to a rename?
201  *  - single entry
202  *  - not a valid previous file
203  */
204 static inline int diff_might_be_rename(void)
205 {
206         return diff_queued_diff.nr == 1 &&
207                 !DIFF_FILE_VALID(diff_queued_diff.queue[0]->one);
208 }
209
210 static void try_to_follow_renames(struct tree_desc *t1, struct tree_desc *t2, const char *base, struct diff_options *opt)
211 {
212         struct diff_options diff_opts;
213         struct diff_queue_struct *q = &diff_queued_diff;
214         struct diff_filepair *choice;
215         int i;
216
217         /*
218          * follow-rename code is very specific, we need exactly one
219          * path. Magic that matches more than one path is not
220          * supported.
221          */
222         GUARD_PATHSPEC(&opt->pathspec, PATHSPEC_FROMTOP | PATHSPEC_LITERAL);
223 #if 0
224         /*
225          * We should reject wildcards as well. Unfortunately we
226          * haven't got a reliable way to detect that 'foo\*bar' in
227          * fact has no wildcards. nowildcard_len is merely a hint for
228          * optimization. Let it slip for now until wildmatch is taught
229          * about dry-run mode and returns wildcard info.
230          */
231         if (opt->pathspec.has_wildcard)
232                 die("BUG:%s:%d: wildcards are not supported",
233                     __FILE__, __LINE__);
234 #endif
235
236         /* Remove the file creation entry from the diff queue, and remember it */
237         choice = q->queue[0];
238         q->nr = 0;
239
240         diff_setup(&diff_opts);
241         DIFF_OPT_SET(&diff_opts, RECURSIVE);
242         DIFF_OPT_SET(&diff_opts, FIND_COPIES_HARDER);
243         diff_opts.output_format = DIFF_FORMAT_NO_OUTPUT;
244         diff_opts.single_follow = opt->pathspec.items[0].match;
245         diff_opts.break_opt = opt->break_opt;
246         diff_opts.rename_score = opt->rename_score;
247         diff_setup_done(&diff_opts);
248         diff_tree(t1, t2, base, &diff_opts);
249         diffcore_std(&diff_opts);
250         free_pathspec(&diff_opts.pathspec);
251
252         /* Go through the new set of filepairing, and see if we find a more interesting one */
253         opt->found_follow = 0;
254         for (i = 0; i < q->nr; i++) {
255                 struct diff_filepair *p = q->queue[i];
256
257                 /*
258                  * Found a source? Not only do we use that for the new
259                  * diff_queued_diff, we will also use that as the path in
260                  * the future!
261                  */
262                 if ((p->status == 'R' || p->status == 'C') &&
263                     !strcmp(p->two->path, opt->pathspec.items[0].match)) {
264                         const char *path[2];
265
266                         /* Switch the file-pairs around */
267                         q->queue[i] = choice;
268                         choice = p;
269
270                         /* Update the path we use from now on.. */
271                         path[0] = p->one->path;
272                         path[1] = NULL;
273                         free_pathspec(&opt->pathspec);
274                         parse_pathspec(&opt->pathspec,
275                                        PATHSPEC_ALL_MAGIC & ~PATHSPEC_LITERAL,
276                                        PATHSPEC_LITERAL_PATH, "", path);
277
278                         /*
279                          * The caller expects us to return a set of vanilla
280                          * filepairs to let a later call to diffcore_std()
281                          * it makes to sort the renames out (among other
282                          * things), but we already have found renames
283                          * ourselves; signal diffcore_std() not to muck with
284                          * rename information.
285                          */
286                         opt->found_follow = 1;
287                         break;
288                 }
289         }
290
291         /*
292          * Then, discard all the non-relevant file pairs...
293          */
294         for (i = 0; i < q->nr; i++) {
295                 struct diff_filepair *p = q->queue[i];
296                 diff_free_filepair(p);
297         }
298
299         /*
300          * .. and re-instate the one we want (which might be either the
301          * original one, or the rename/copy we found)
302          */
303         q->queue[0] = choice;
304         q->nr = 1;
305 }
306
307 int diff_tree_sha1(const unsigned char *old, const unsigned char *new, const char *base, struct diff_options *opt)
308 {
309         void *tree1, *tree2;
310         struct tree_desc t1, t2;
311         unsigned long size1, size2;
312         int retval;
313
314         tree1 = fill_tree_descriptor(&t1, old);
315         tree2 = fill_tree_descriptor(&t2, new);
316         size1 = t1.size;
317         size2 = t2.size;
318         retval = diff_tree(&t1, &t2, base, opt);
319         if (!*base && DIFF_OPT_TST(opt, FOLLOW_RENAMES) && diff_might_be_rename()) {
320                 init_tree_desc(&t1, tree1, size1);
321                 init_tree_desc(&t2, tree2, size2);
322                 try_to_follow_renames(&t1, &t2, base, opt);
323         }
324         free(tree1);
325         free(tree2);
326         return retval;
327 }
328
329 int diff_root_tree_sha1(const unsigned char *new, const char *base, struct diff_options *opt)
330 {
331         return diff_tree_sha1(NULL, new, base, opt);
332 }