user-manual: mention 'git remote add' for remote branch config
[git] / builtin / merge-tree.c
1 #include "builtin.h"
2 #include "tree-walk.h"
3 #include "xdiff-interface.h"
4 #include "blob.h"
5 #include "exec_cmd.h"
6 #include "merge-blobs.h"
7
8 static const char merge_tree_usage[] = "git merge-tree <base-tree> <branch1> <branch2>";
9
10 struct merge_list {
11         struct merge_list *next;
12         struct merge_list *link;        /* other stages for this object */
13
14         unsigned int stage : 2;
15         unsigned int mode;
16         const char *path;
17         struct blob *blob;
18 };
19
20 static struct merge_list *merge_result, **merge_result_end = &merge_result;
21
22 static void add_merge_entry(struct merge_list *entry)
23 {
24         *merge_result_end = entry;
25         merge_result_end = &entry->next;
26 }
27
28 static void merge_trees_recursive(struct tree_desc t[3], const char *base, int df_conflict);
29
30 static const char *explanation(struct merge_list *entry)
31 {
32         switch (entry->stage) {
33         case 0:
34                 return "merged";
35         case 3:
36                 return "added in remote";
37         case 2:
38                 if (entry->link)
39                         return "added in both";
40                 return "added in local";
41         }
42
43         /* Existed in base */
44         entry = entry->link;
45         if (!entry)
46                 return "removed in both";
47
48         if (entry->link)
49                 return "changed in both";
50
51         if (entry->stage == 3)
52                 return "removed in local";
53         return "removed in remote";
54 }
55
56 static void *result(struct merge_list *entry, unsigned long *size)
57 {
58         enum object_type type;
59         struct blob *base, *our, *their;
60         const char *path = entry->path;
61
62         if (!entry->stage)
63                 return read_sha1_file(entry->blob->object.sha1, &type, size);
64         base = NULL;
65         if (entry->stage == 1) {
66                 base = entry->blob;
67                 entry = entry->link;
68         }
69         our = NULL;
70         if (entry && entry->stage == 2) {
71                 our = entry->blob;
72                 entry = entry->link;
73         }
74         their = NULL;
75         if (entry)
76                 their = entry->blob;
77         return merge_blobs(path, base, our, their, size);
78 }
79
80 static void *origin(struct merge_list *entry, unsigned long *size)
81 {
82         enum object_type type;
83         while (entry) {
84                 if (entry->stage == 2)
85                         return read_sha1_file(entry->blob->object.sha1, &type, size);
86                 entry = entry->link;
87         }
88         return NULL;
89 }
90
91 static int show_outf(void *priv_, mmbuffer_t *mb, int nbuf)
92 {
93         int i;
94         for (i = 0; i < nbuf; i++)
95                 printf("%.*s", (int) mb[i].size, mb[i].ptr);
96         return 0;
97 }
98
99 static void show_diff(struct merge_list *entry)
100 {
101         unsigned long size;
102         mmfile_t src, dst;
103         xpparam_t xpp;
104         xdemitconf_t xecfg;
105         xdemitcb_t ecb;
106
107         xpp.flags = 0;
108         memset(&xecfg, 0, sizeof(xecfg));
109         xecfg.ctxlen = 3;
110         ecb.outf = show_outf;
111         ecb.priv = NULL;
112
113         src.ptr = origin(entry, &size);
114         if (!src.ptr)
115                 size = 0;
116         src.size = size;
117         dst.ptr = result(entry, &size);
118         if (!dst.ptr)
119                 size = 0;
120         dst.size = size;
121         xdi_diff(&src, &dst, &xpp, &xecfg, &ecb);
122         free(src.ptr);
123         free(dst.ptr);
124 }
125
126 static void show_result_list(struct merge_list *entry)
127 {
128         printf("%s\n", explanation(entry));
129         do {
130                 struct merge_list *link = entry->link;
131                 static const char *desc[4] = { "result", "base", "our", "their" };
132                 printf("  %-6s %o %s %s\n", desc[entry->stage], entry->mode, sha1_to_hex(entry->blob->object.sha1), entry->path);
133                 entry = link;
134         } while (entry);
135 }
136
137 static void show_result(void)
138 {
139         struct merge_list *walk;
140
141         walk = merge_result;
142         while (walk) {
143                 show_result_list(walk);
144                 show_diff(walk);
145                 walk = walk->next;
146         }
147 }
148
149 /* An empty entry never compares same, not even to another empty entry */
150 static int same_entry(struct name_entry *a, struct name_entry *b)
151 {
152         return  a->sha1 &&
153                 b->sha1 &&
154                 !hashcmp(a->sha1, b->sha1) &&
155                 a->mode == b->mode;
156 }
157
158 static struct merge_list *create_entry(unsigned stage, unsigned mode, const unsigned char *sha1, const char *path)
159 {
160         struct merge_list *res = xcalloc(1, sizeof(*res));
161
162         res->stage = stage;
163         res->path = path;
164         res->mode = mode;
165         res->blob = lookup_blob(sha1);
166         return res;
167 }
168
169 static char *traverse_path(const struct traverse_info *info, const struct name_entry *n)
170 {
171         char *path = xmalloc(traverse_path_len(info, n) + 1);
172         return make_traverse_path(path, info, n);
173 }
174
175 static void resolve(const struct traverse_info *info, struct name_entry *ours, struct name_entry *result)
176 {
177         struct merge_list *orig, *final;
178         const char *path;
179
180         /* If it's already ours, don't bother showing it */
181         if (!ours)
182                 return;
183
184         path = traverse_path(info, result);
185         orig = create_entry(2, ours->mode, ours->sha1, path);
186         final = create_entry(0, result->mode, result->sha1, path);
187
188         final->link = orig;
189
190         add_merge_entry(final);
191 }
192
193 static void unresolved_directory(const struct traverse_info *info, struct name_entry n[3],
194                                  int df_conflict)
195 {
196         char *newbase;
197         struct name_entry *p;
198         struct tree_desc t[3];
199         void *buf0, *buf1, *buf2;
200
201         for (p = n; p < n + 3; p++) {
202                 if (p->mode && S_ISDIR(p->mode))
203                         break;
204         }
205         if (n + 3 <= p)
206                 return; /* there is no tree here */
207
208         newbase = traverse_path(info, p);
209
210 #define ENTRY_SHA1(e) (((e)->mode && S_ISDIR((e)->mode)) ? (e)->sha1 : NULL)
211         buf0 = fill_tree_descriptor(t+0, ENTRY_SHA1(n + 0));
212         buf1 = fill_tree_descriptor(t+1, ENTRY_SHA1(n + 1));
213         buf2 = fill_tree_descriptor(t+2, ENTRY_SHA1(n + 2));
214 #undef ENTRY_SHA1
215
216         merge_trees_recursive(t, newbase, df_conflict);
217
218         free(buf0);
219         free(buf1);
220         free(buf2);
221         free(newbase);
222 }
223
224
225 static struct merge_list *link_entry(unsigned stage, const struct traverse_info *info, struct name_entry *n, struct merge_list *entry)
226 {
227         const char *path;
228         struct merge_list *link;
229
230         if (!n->mode)
231                 return entry;
232         if (entry)
233                 path = entry->path;
234         else
235                 path = traverse_path(info, n);
236         link = create_entry(stage, n->mode, n->sha1, path);
237         link->link = entry;
238         return link;
239 }
240
241 static void unresolved(const struct traverse_info *info, struct name_entry n[3])
242 {
243         struct merge_list *entry = NULL;
244         int i;
245         unsigned dirmask = 0, mask = 0;
246
247         for (i = 0; i < 3; i++) {
248                 mask |= (1 << 1);
249                 if (n[i].mode && S_ISDIR(n[i].mode))
250                         dirmask |= (1 << i);
251         }
252
253         unresolved_directory(info, n, dirmask && (dirmask != mask));
254
255         if (dirmask == mask)
256                 return;
257
258         if (n[2].mode && !S_ISDIR(n[2].mode))
259                 entry = link_entry(3, info, n + 2, entry);
260         if (n[1].mode && !S_ISDIR(n[1].mode))
261                 entry = link_entry(2, info, n + 1, entry);
262         if (n[0].mode && !S_ISDIR(n[0].mode))
263                 entry = link_entry(1, info, n + 0, entry);
264
265         add_merge_entry(entry);
266 }
267
268 /*
269  * Merge two trees together (t[1] and t[2]), using a common base (t[0])
270  * as the origin.
271  *
272  * This walks the (sorted) trees in lock-step, checking every possible
273  * name. Note that directories automatically sort differently from other
274  * files (see "base_name_compare"), so you'll never see file/directory
275  * conflicts, because they won't ever compare the same.
276  *
277  * IOW, if a directory changes to a filename, it will automatically be
278  * seen as the directory going away, and the filename being created.
279  *
280  * Think of this as a three-way diff.
281  *
282  * The output will be either:
283  *  - successful merge
284  *       "0 mode sha1 filename"
285  *    NOTE NOTE NOTE! FIXME! We really really need to walk the index
286  *    in parallel with this too!
287  *
288  *  - conflict:
289  *      "1 mode sha1 filename"
290  *      "2 mode sha1 filename"
291  *      "3 mode sha1 filename"
292  *    where not all of the 1/2/3 lines may exist, of course.
293  *
294  * The successful merge rules are the same as for the three-way merge
295  * in git-read-tree.
296  */
297 static int threeway_callback(int n, unsigned long mask, unsigned long dirmask, struct name_entry *entry, struct traverse_info *info)
298 {
299         /* Same in both? */
300         if (same_entry(entry+1, entry+2)) {
301                 if (entry[0].sha1) {
302                         /* Modified identically */
303                         resolve(info, NULL, entry+1);
304                         return mask;
305                 }
306                 /* "Both added the same" is left unresolved */
307         }
308
309         if (same_entry(entry+0, entry+1)) {
310                 if (entry[2].sha1 && !S_ISDIR(entry[2].mode)) {
311                         /* We did not touch, they modified -- take theirs */
312                         resolve(info, entry+1, entry+2);
313                         return mask;
314                 }
315                 /*
316                  * If we did not touch a directory but they made it
317                  * into a file, we fall through and unresolved()
318                  * recurses down.  Likewise for the opposite case.
319                  */
320         }
321
322         if (same_entry(entry+0, entry+2)) {
323                 if (entry[1].sha1 && !S_ISDIR(entry[1].mode)) {
324                         /* We modified, they did not touch -- take ours */
325                         resolve(info, NULL, entry+1);
326                         return mask;
327                 }
328         }
329
330         unresolved(info, entry);
331         return mask;
332 }
333
334 static void merge_trees_recursive(struct tree_desc t[3], const char *base, int df_conflict)
335 {
336         struct traverse_info info;
337
338         setup_traverse_info(&info, base);
339         info.data = &df_conflict;
340         info.fn = threeway_callback;
341         traverse_trees(3, t, &info);
342 }
343
344 static void merge_trees(struct tree_desc t[3], const char *base)
345 {
346         merge_trees_recursive(t, base, 0);
347 }
348
349 static void *get_tree_descriptor(struct tree_desc *desc, const char *rev)
350 {
351         unsigned char sha1[20];
352         void *buf;
353
354         if (get_sha1(rev, sha1))
355                 die("unknown rev %s", rev);
356         buf = fill_tree_descriptor(desc, sha1);
357         if (!buf)
358                 die("%s is not a tree", rev);
359         return buf;
360 }
361
362 int cmd_merge_tree(int argc, const char **argv, const char *prefix)
363 {
364         struct tree_desc t[3];
365         void *buf1, *buf2, *buf3;
366
367         if (argc != 4)
368                 usage(merge_tree_usage);
369
370         buf1 = get_tree_descriptor(t+0, argv[1]);
371         buf2 = get_tree_descriptor(t+1, argv[2]);
372         buf3 = get_tree_descriptor(t+2, argv[3]);
373         merge_trees(t, "");
374         free(buf1);
375         free(buf2);
376         free(buf3);
377
378         show_result();
379         return 0;
380 }