1
# Copyright (C) 2005, 2006, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
branch as _mod_branch,
20
conflicts as _mod_conflicts,
29
revision as _mod_revision,
38
from bzrlib.symbol_versioning import (
42
# TODO: Report back as changes are merged in
45
def transform_tree(from_tree, to_tree, interesting_ids=None):
46
from_tree.lock_tree_write()
48
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
49
interesting_ids=interesting_ids, this_tree=from_tree)
55
def __init__(self, this_branch, other_tree=None, base_tree=None,
56
this_tree=None, pb=None, change_reporter=None,
57
recurse='down', revision_graph=None):
59
self.this_branch = this_branch
60
self.this_basis = _mod_revision.ensure_null(
61
this_branch.last_revision())
62
self.this_rev_id = None
63
self.this_tree = this_tree
64
self.this_revision_tree = None
65
self.this_basis_tree = None
66
self.other_tree = other_tree
67
self.other_branch = None
68
self.base_tree = base_tree
69
self.ignore_zero = False
70
self.backup_files = False
71
self.interesting_ids = None
72
self.interesting_files = None
73
self.show_base = False
74
self.reprocess = False
76
pb = progress.DummyProgress()
79
self.recurse = recurse
80
self.change_reporter = change_reporter
81
self._cached_trees = {}
82
self._revision_graph = revision_graph
83
self._base_is_ancestor = None
84
self._base_is_other_ancestor = None
85
self._is_criss_cross = None
86
self._lca_trees = None
88
def cache_trees_with_revision_ids(self, trees):
89
"""Cache any tree in trees if it has a revision_id."""
90
for maybe_tree in trees:
91
if maybe_tree is None:
94
rev_id = maybe_tree.get_revision_id()
95
except AttributeError:
97
self._cached_trees[rev_id] = maybe_tree
100
def revision_graph(self):
101
if self._revision_graph is None:
102
self._revision_graph = self.this_branch.repository.get_graph()
103
return self._revision_graph
105
def _set_base_is_ancestor(self, value):
106
self._base_is_ancestor = value
108
def _get_base_is_ancestor(self):
109
if self._base_is_ancestor is None:
110
self._base_is_ancestor = self.revision_graph.is_ancestor(
111
self.base_rev_id, self.this_basis)
112
return self._base_is_ancestor
114
base_is_ancestor = property(_get_base_is_ancestor, _set_base_is_ancestor)
116
def _set_base_is_other_ancestor(self, value):
117
self._base_is_other_ancestor = value
119
def _get_base_is_other_ancestor(self):
120
if self._base_is_other_ancestor is None:
121
if self.other_basis is None:
123
self._base_is_other_ancestor = self.revision_graph.is_ancestor(
124
self.base_rev_id, self.other_basis)
125
return self._base_is_other_ancestor
127
base_is_other_ancestor = property(_get_base_is_other_ancestor,
128
_set_base_is_other_ancestor)
131
def from_uncommitted(tree, other_tree, pb=None, base_tree=None):
132
"""Return a Merger for uncommitted changes in other_tree.
134
:param tree: The tree to merge into
135
:param other_tree: The tree to get uncommitted changes from
136
:param pb: A progress indicator
137
:param base_tree: The basis to use for the merge. If unspecified,
138
other_tree.basis_tree() will be used.
140
if base_tree is None:
141
base_tree = other_tree.basis_tree()
142
merger = Merger(tree.branch, other_tree, base_tree, tree, pb)
143
merger.base_rev_id = merger.base_tree.get_revision_id()
144
merger.other_rev_id = None
145
merger.other_basis = merger.base_rev_id
149
def from_mergeable(klass, tree, mergeable, pb):
150
"""Return a Merger for a bundle or merge directive.
152
:param tree: The tree to merge changes into
153
:param mergeable: A merge directive or bundle
154
:param pb: A progress indicator
156
mergeable.install_revisions(tree.branch.repository)
157
base_revision_id, other_revision_id, verified =\
158
mergeable.get_merge_request(tree.branch.repository)
159
revision_graph = tree.branch.repository.get_graph()
160
if base_revision_id is not None:
161
if (base_revision_id != _mod_revision.NULL_REVISION and
162
revision_graph.is_ancestor(
163
base_revision_id, tree.branch.last_revision())):
164
base_revision_id = None
166
trace.warning('Performing cherrypick')
167
merger = klass.from_revision_ids(pb, tree, other_revision_id,
168
base_revision_id, revision_graph=
170
return merger, verified
173
def from_revision_ids(pb, tree, other, base=None, other_branch=None,
174
base_branch=None, revision_graph=None,
176
"""Return a Merger for revision-ids.
178
:param pb: A progress indicator
179
:param tree: The tree to merge changes into
180
:param other: The revision-id to use as OTHER
181
:param base: The revision-id to use as BASE. If not specified, will
183
:param other_branch: A branch containing the other revision-id. If
184
not supplied, tree.branch is used.
185
:param base_branch: A branch containing the base revision-id. If
186
not supplied, other_branch or tree.branch will be used.
187
:param revision_graph: If you have a revision_graph precomputed, pass
188
it in, otherwise it will be created for you.
189
:param tree_branch: The branch associated with tree. If not supplied,
190
tree.branch will be used.
192
if tree_branch is None:
193
tree_branch = tree.branch
194
merger = Merger(tree_branch, this_tree=tree, pb=pb,
195
revision_graph=revision_graph)
196
if other_branch is None:
197
other_branch = tree.branch
198
merger.set_other_revision(other, other_branch)
202
if base_branch is None:
203
base_branch = other_branch
204
merger.set_base_revision(base, base_branch)
207
def revision_tree(self, revision_id, branch=None):
208
if revision_id not in self._cached_trees:
210
branch = self.this_branch
212
tree = self.this_tree.revision_tree(revision_id)
213
except errors.NoSuchRevisionInTree:
214
tree = branch.repository.revision_tree(revision_id)
215
self._cached_trees[revision_id] = tree
216
return self._cached_trees[revision_id]
218
def _get_tree(self, treespec, possible_transports=None):
219
from bzrlib import workingtree
220
location, revno = treespec
222
tree = workingtree.WorkingTree.open_containing(location)[0]
223
return tree.branch, tree
224
branch = _mod_branch.Branch.open_containing(
225
location, possible_transports)[0]
227
revision_id = branch.last_revision()
229
revision_id = branch.get_rev_id(revno)
230
revision_id = _mod_revision.ensure_null(revision_id)
231
return branch, self.revision_tree(revision_id, branch)
233
@deprecated_method(deprecated_in((2, 1, 0)))
234
def ensure_revision_trees(self):
235
if self.this_revision_tree is None:
236
self.this_basis_tree = self.revision_tree(self.this_basis)
237
if self.this_basis == self.this_rev_id:
238
self.this_revision_tree = self.this_basis_tree
240
if self.other_rev_id is None:
241
other_basis_tree = self.revision_tree(self.other_basis)
242
if other_basis_tree.has_changes(self.other_tree):
243
raise WorkingTreeNotRevision(self.this_tree)
244
other_rev_id = self.other_basis
245
self.other_tree = other_basis_tree
247
@deprecated_method(deprecated_in((2, 1, 0)))
248
def file_revisions(self, file_id):
249
self.ensure_revision_trees()
250
def get_id(tree, file_id):
251
revision_id = tree.inventory[file_id].revision
253
if self.this_rev_id is None:
254
if self.this_basis_tree.get_file_sha1(file_id) != \
255
self.this_tree.get_file_sha1(file_id):
256
raise errors.WorkingTreeNotRevision(self.this_tree)
258
trees = (self.this_basis_tree, self.other_tree)
259
return [get_id(tree, file_id) for tree in trees]
261
@deprecated_method(deprecated_in((2, 1, 0)))
262
def check_basis(self, check_clean, require_commits=True):
263
if self.this_basis is None and require_commits is True:
264
raise errors.BzrCommandError(
265
"This branch has no commits."
266
" (perhaps you would prefer 'bzr pull')")
269
if self.this_basis != self.this_rev_id:
270
raise errors.UncommittedChanges(self.this_tree)
272
@deprecated_method(deprecated_in((2, 1, 0)))
273
def compare_basis(self):
275
basis_tree = self.revision_tree(self.this_tree.last_revision())
276
except errors.NoSuchRevision:
277
basis_tree = self.this_tree.basis_tree()
278
if not self.this_tree.has_changes(basis_tree):
279
self.this_rev_id = self.this_basis
281
def set_interesting_files(self, file_list):
282
self.interesting_files = file_list
284
def set_pending(self):
285
if (not self.base_is_ancestor or not self.base_is_other_ancestor
286
or self.other_rev_id is None):
290
def _add_parent(self):
291
new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
292
new_parent_trees = []
293
for revision_id in new_parents:
295
tree = self.revision_tree(revision_id)
296
except errors.NoSuchRevision:
300
new_parent_trees.append((revision_id, tree))
302
self.this_tree.set_parent_trees(new_parent_trees,
303
allow_leftmost_as_ghost=True)
305
for _revision_id, tree in new_parent_trees:
309
def set_other(self, other_revision, possible_transports=None):
310
"""Set the revision and tree to merge from.
312
This sets the other_tree, other_rev_id, other_basis attributes.
314
:param other_revision: The [path, revision] list to merge from.
316
self.other_branch, self.other_tree = self._get_tree(other_revision,
318
if other_revision[1] == -1:
319
self.other_rev_id = _mod_revision.ensure_null(
320
self.other_branch.last_revision())
321
if _mod_revision.is_null(self.other_rev_id):
322
raise errors.NoCommits(self.other_branch)
323
self.other_basis = self.other_rev_id
324
elif other_revision[1] is not None:
325
self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
326
self.other_basis = self.other_rev_id
328
self.other_rev_id = None
329
self.other_basis = self.other_branch.last_revision()
330
if self.other_basis is None:
331
raise errors.NoCommits(self.other_branch)
332
if self.other_rev_id is not None:
333
self._cached_trees[self.other_rev_id] = self.other_tree
334
self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
336
def set_other_revision(self, revision_id, other_branch):
337
"""Set 'other' based on a branch and revision id
339
:param revision_id: The revision to use for a tree
340
:param other_branch: The branch containing this tree
342
self.other_rev_id = revision_id
343
self.other_branch = other_branch
344
self._maybe_fetch(other_branch, self.this_branch, self.other_rev_id)
345
self.other_tree = self.revision_tree(revision_id)
346
self.other_basis = revision_id
348
def set_base_revision(self, revision_id, branch):
349
"""Set 'base' based on a branch and revision id
351
:param revision_id: The revision to use for a tree
352
:param branch: The branch containing this tree
354
self.base_rev_id = revision_id
355
self.base_branch = branch
356
self._maybe_fetch(branch, self.this_branch, revision_id)
357
self.base_tree = self.revision_tree(revision_id)
359
def _maybe_fetch(self, source, target, revision_id):
360
if not source.repository.has_same_location(target.repository):
361
target.fetch(source, revision_id)
364
revisions = [_mod_revision.ensure_null(self.this_basis),
365
_mod_revision.ensure_null(self.other_basis)]
366
if _mod_revision.NULL_REVISION in revisions:
367
self.base_rev_id = _mod_revision.NULL_REVISION
368
self.base_tree = self.revision_tree(self.base_rev_id)
369
self._is_criss_cross = False
371
lcas = self.revision_graph.find_lca(revisions[0], revisions[1])
372
self._is_criss_cross = False
374
self.base_rev_id = _mod_revision.NULL_REVISION
376
self.base_rev_id = list(lcas)[0]
377
else: # len(lcas) > 1
379
# find_unique_lca can only handle 2 nodes, so we have to
380
# start back at the beginning. It is a shame to traverse
381
# the graph again, but better than re-implementing
383
self.base_rev_id = self.revision_graph.find_unique_lca(
384
revisions[0], revisions[1])
386
self.base_rev_id = self.revision_graph.find_unique_lca(
388
self._is_criss_cross = True
389
if self.base_rev_id == _mod_revision.NULL_REVISION:
390
raise errors.UnrelatedBranches()
391
if self._is_criss_cross:
392
trace.warning('Warning: criss-cross merge encountered. See bzr'
393
' help criss-cross.')
394
trace.mutter('Criss-cross lcas: %r' % lcas)
395
interesting_revision_ids = [self.base_rev_id]
396
interesting_revision_ids.extend(lcas)
397
interesting_trees = dict((t.get_revision_id(), t)
398
for t in self.this_branch.repository.revision_trees(
399
interesting_revision_ids))
400
self._cached_trees.update(interesting_trees)
401
self.base_tree = interesting_trees.pop(self.base_rev_id)
402
sorted_lca_keys = self.revision_graph.find_merge_order(
404
self._lca_trees = [interesting_trees[key]
405
for key in sorted_lca_keys]
407
self.base_tree = self.revision_tree(self.base_rev_id)
408
self.base_is_ancestor = True
409
self.base_is_other_ancestor = True
410
trace.mutter('Base revid: %r' % self.base_rev_id)
412
def set_base(self, base_revision):
413
"""Set the base revision to use for the merge.
415
:param base_revision: A 2-list containing a path and revision number.
417
trace.mutter("doing merge() with no base_revision specified")
418
if base_revision == [None, None]:
421
base_branch, self.base_tree = self._get_tree(base_revision)
422
if base_revision[1] == -1:
423
self.base_rev_id = base_branch.last_revision()
424
elif base_revision[1] is None:
425
self.base_rev_id = _mod_revision.NULL_REVISION
427
self.base_rev_id = _mod_revision.ensure_null(
428
base_branch.get_rev_id(base_revision[1]))
429
self._maybe_fetch(base_branch, self.this_branch, self.base_rev_id)
431
def make_merger(self):
432
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
433
'other_tree': self.other_tree,
434
'interesting_ids': self.interesting_ids,
435
'interesting_files': self.interesting_files,
438
if self.merge_type.requires_base:
439
kwargs['base_tree'] = self.base_tree
440
if self.merge_type.supports_reprocess:
441
kwargs['reprocess'] = self.reprocess
443
raise errors.BzrError(
444
"Conflict reduction is not supported for merge"
445
" type %s." % self.merge_type)
446
if self.merge_type.supports_show_base:
447
kwargs['show_base'] = self.show_base
449
raise errors.BzrError("Showing base is not supported for this"
450
" merge type. %s" % self.merge_type)
451
if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
452
and not self.base_is_other_ancestor):
453
raise errors.CannotReverseCherrypick()
454
if self.merge_type.supports_cherrypick:
455
kwargs['cherrypick'] = (not self.base_is_ancestor or
456
not self.base_is_other_ancestor)
457
if self._is_criss_cross and getattr(self.merge_type,
458
'supports_lca_trees', False):
459
kwargs['lca_trees'] = self._lca_trees
460
return self.merge_type(pb=self._pb,
461
change_reporter=self.change_reporter,
464
def _do_merge_to(self, merge):
465
if self.other_branch is not None:
466
self.other_branch.update_references(self.this_branch)
468
if self.recurse == 'down':
469
for relpath, file_id in self.this_tree.iter_references():
470
sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
471
other_revision = self.other_tree.get_reference_revision(
473
if other_revision == sub_tree.last_revision():
475
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
476
sub_merge.merge_type = self.merge_type
477
other_branch = self.other_branch.reference_parent(file_id, relpath)
478
sub_merge.set_other_revision(other_revision, other_branch)
479
base_revision = self.base_tree.get_reference_revision(file_id)
480
sub_merge.base_tree = \
481
sub_tree.branch.repository.revision_tree(base_revision)
482
sub_merge.base_rev_id = base_revision
486
self.this_tree.lock_tree_write()
488
if self.base_tree is not None:
489
self.base_tree.lock_read()
491
if self.other_tree is not None:
492
self.other_tree.lock_read()
494
merge = self.make_merger()
495
self._do_merge_to(merge)
497
if self.other_tree is not None:
498
self.other_tree.unlock()
500
if self.base_tree is not None:
501
self.base_tree.unlock()
503
self.this_tree.unlock()
504
if len(merge.cooked_conflicts) == 0:
505
if not self.ignore_zero and not trace.is_quiet():
506
trace.note("All changes applied successfully.")
508
trace.note("%d conflicts encountered."
509
% len(merge.cooked_conflicts))
511
return len(merge.cooked_conflicts)
514
class _InventoryNoneEntry(object):
515
"""This represents an inventory entry which *isn't there*.
517
It simplifies the merging logic if we always have an InventoryEntry, even
518
if it isn't actually present
525
symlink_target = None
528
_none_entry = _InventoryNoneEntry()
531
class Merge3Merger(object):
532
"""Three-way merger that uses the merge3 text merger"""
534
supports_reprocess = True
535
supports_show_base = True
536
history_based = False
537
supports_cherrypick = True
538
supports_reverse_cherrypick = True
539
winner_idx = {"this": 2, "other": 1, "conflict": 1}
540
supports_lca_trees = True
542
def __init__(self, working_tree, this_tree, base_tree, other_tree,
543
interesting_ids=None, reprocess=False, show_base=False,
544
pb=progress.DummyProgress(), pp=None, change_reporter=None,
545
interesting_files=None, do_merge=True,
546
cherrypick=False, lca_trees=None):
547
"""Initialize the merger object and perform the merge.
549
:param working_tree: The working tree to apply the merge to
550
:param this_tree: The local tree in the merge operation
551
:param base_tree: The common tree in the merge operation
552
:param other_tree: The other tree to merge changes from
553
:param interesting_ids: The file_ids of files that should be
554
participate in the merge. May not be combined with
556
:param: reprocess If True, perform conflict-reduction processing.
557
:param show_base: If True, show the base revision in text conflicts.
558
(incompatible with reprocess)
559
:param pb: A Progress bar
560
:param pp: A ProgressPhase object
561
:param change_reporter: An object that should report changes made
562
:param interesting_files: The tree-relative paths of files that should
563
participate in the merge. If these paths refer to directories,
564
the contents of those directories will also be included. May not
565
be combined with interesting_ids. If neither interesting_files nor
566
interesting_ids is specified, all files may participate in the
568
:param lca_trees: Can be set to a dictionary of {revision_id:rev_tree}
569
if the ancestry was found to include a criss-cross merge.
570
Otherwise should be None.
572
object.__init__(self)
573
if interesting_files is not None and interesting_ids is not None:
575
'specify either interesting_ids or interesting_files')
576
self.interesting_ids = interesting_ids
577
self.interesting_files = interesting_files
578
self.this_tree = working_tree
579
self.base_tree = base_tree
580
self.other_tree = other_tree
581
self._raw_conflicts = []
582
self.cooked_conflicts = []
583
self.reprocess = reprocess
584
self.show_base = show_base
585
self._lca_trees = lca_trees
586
# Uncommenting this will change the default algorithm to always use
587
# _entries_lca. This can be useful for running the test suite and
588
# making sure we haven't missed any corner cases.
589
# if lca_trees is None:
590
# self._lca_trees = [self.base_tree]
593
self.change_reporter = change_reporter
594
self.cherrypick = cherrypick
596
self.pp = progress.ProgressPhase("Merge phase", 3, self.pb)
601
self.this_tree.lock_tree_write()
602
self.base_tree.lock_read()
603
self.other_tree.lock_read()
605
self.tt = transform.TreeTransform(self.this_tree, self.pb)
608
self._compute_transform()
610
results = self.tt.apply(no_conflicts=True)
611
self.write_modified(results)
613
self.this_tree.add_conflicts(self.cooked_conflicts)
614
except errors.UnsupportedOperation:
619
self.other_tree.unlock()
620
self.base_tree.unlock()
621
self.this_tree.unlock()
624
def make_preview_transform(self):
625
self.base_tree.lock_read()
626
self.other_tree.lock_read()
627
self.tt = transform.TransformPreview(self.this_tree)
630
self._compute_transform()
633
self.other_tree.unlock()
634
self.base_tree.unlock()
638
def _compute_transform(self):
639
if self._lca_trees is None:
640
entries = self._entries3()
641
resolver = self._three_way
643
entries = self._entries_lca()
644
resolver = self._lca_multi_way
645
child_pb = ui.ui_factory.nested_progress_bar()
647
for num, (file_id, changed, parents3, names3,
648
executable3) in enumerate(entries):
649
child_pb.update('Preparing file merge', num, len(entries))
650
self._merge_names(file_id, parents3, names3, resolver=resolver)
652
file_status = self.merge_contents(file_id)
654
file_status = 'unmodified'
655
self._merge_executable(file_id,
656
executable3, file_status, resolver=resolver)
661
child_pb = ui.ui_factory.nested_progress_bar()
663
fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
664
lambda t, c: transform.conflict_pass(t, c, self.other_tree))
667
if self.change_reporter is not None:
668
from bzrlib import delta
669
delta.report_changes(
670
self.tt.iter_changes(), self.change_reporter)
671
self.cook_conflicts(fs_conflicts)
672
for conflict in self.cooked_conflicts:
673
trace.warning(conflict)
676
"""Gather data about files modified between three trees.
678
Return a list of tuples of file_id, changed, parents3, names3,
679
executable3. changed is a boolean indicating whether the file contents
680
or kind were changed. parents3 is a tuple of parent ids for base,
681
other and this. names3 is a tuple of names for base, other and this.
682
executable3 is a tuple of execute-bit values for base, other and this.
685
iterator = self.other_tree.iter_changes(self.base_tree,
686
include_unchanged=True, specific_files=self.interesting_files,
687
extra_trees=[self.this_tree])
688
this_entries = dict((e.file_id, e) for p, e in
689
self.this_tree.iter_entries_by_dir(
690
self.interesting_ids))
691
for (file_id, paths, changed, versioned, parents, names, kind,
692
executable) in iterator:
693
if (self.interesting_ids is not None and
694
file_id not in self.interesting_ids):
696
entry = this_entries.get(file_id)
697
if entry is not None:
698
this_name = entry.name
699
this_parent = entry.parent_id
700
this_executable = entry.executable
704
this_executable = None
705
parents3 = parents + (this_parent,)
706
names3 = names + (this_name,)
707
executable3 = executable + (this_executable,)
708
result.append((file_id, changed, parents3, names3, executable3))
711
def _entries_lca(self):
712
"""Gather data about files modified between multiple trees.
714
This compares OTHER versus all LCA trees, and for interesting entries,
715
it then compares with THIS and BASE.
717
For the multi-valued entries, the format will be (BASE, [lca1, lca2])
718
:return: [(file_id, changed, parents, names, executable)]
719
file_id Simple file_id of the entry
720
changed Boolean, True if the kind or contents changed
722
parents ((base, [parent_id, in, lcas]), parent_id_other,
724
names ((base, [name, in, lcas]), name_in_other, name_in_this)
725
executable ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
727
if self.interesting_files is not None:
728
lookup_trees = [self.this_tree, self.base_tree]
729
lookup_trees.extend(self._lca_trees)
730
# I think we should include the lca trees as well
731
interesting_ids = self.other_tree.paths2ids(self.interesting_files,
734
interesting_ids = self.interesting_ids
736
walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
738
base_inventory = self.base_tree.inventory
739
this_inventory = self.this_tree.inventory
740
for path, file_id, other_ie, lca_values in walker.iter_all():
741
# Is this modified at all from any of the other trees?
743
other_ie = _none_entry
744
if interesting_ids is not None and file_id not in interesting_ids:
747
# If other_revision is found in any of the lcas, that means this
748
# node is uninteresting. This is because when merging, if there are
749
# multiple heads(), we have to create a new node. So if we didn't,
750
# we know that the ancestry is linear, and that OTHER did not
752
# See doc/developers/lca_merge_resolution.txt for details
753
other_revision = other_ie.revision
754
if other_revision is not None:
755
# We can't use this shortcut when other_revision is None,
756
# because it may be None because things are WorkingTrees, and
757
# not because it is *actually* None.
758
is_unmodified = False
759
for lca_path, ie in lca_values:
760
if ie is not None and ie.revision == other_revision:
767
for lca_path, lca_ie in lca_values:
769
lca_entries.append(_none_entry)
771
lca_entries.append(lca_ie)
773
if file_id in base_inventory:
774
base_ie = base_inventory[file_id]
776
base_ie = _none_entry
778
if file_id in this_inventory:
779
this_ie = this_inventory[file_id]
781
this_ie = _none_entry
787
for lca_ie in lca_entries:
788
lca_kinds.append(lca_ie.kind)
789
lca_parent_ids.append(lca_ie.parent_id)
790
lca_names.append(lca_ie.name)
791
lca_executable.append(lca_ie.executable)
793
kind_winner = self._lca_multi_way(
794
(base_ie.kind, lca_kinds),
795
other_ie.kind, this_ie.kind)
796
parent_id_winner = self._lca_multi_way(
797
(base_ie.parent_id, lca_parent_ids),
798
other_ie.parent_id, this_ie.parent_id)
799
name_winner = self._lca_multi_way(
800
(base_ie.name, lca_names),
801
other_ie.name, this_ie.name)
803
content_changed = True
804
if kind_winner == 'this':
805
# No kind change in OTHER, see if there are *any* changes
806
if other_ie.kind == 'directory':
807
if parent_id_winner == 'this' and name_winner == 'this':
808
# No change for this directory in OTHER, skip
810
content_changed = False
811
elif other_ie.kind is None or other_ie.kind == 'file':
812
def get_sha1(ie, tree):
813
if ie.kind != 'file':
815
return tree.get_file_sha1(file_id)
816
base_sha1 = get_sha1(base_ie, self.base_tree)
817
lca_sha1s = [get_sha1(ie, tree) for ie, tree
818
in zip(lca_entries, self._lca_trees)]
819
this_sha1 = get_sha1(this_ie, self.this_tree)
820
other_sha1 = get_sha1(other_ie, self.other_tree)
821
sha1_winner = self._lca_multi_way(
822
(base_sha1, lca_sha1s), other_sha1, this_sha1,
823
allow_overriding_lca=False)
824
exec_winner = self._lca_multi_way(
825
(base_ie.executable, lca_executable),
826
other_ie.executable, this_ie.executable)
827
if (parent_id_winner == 'this' and name_winner == 'this'
828
and sha1_winner == 'this' and exec_winner == 'this'):
829
# No kind, parent, name, exec, or content change for
830
# OTHER, so this node is not considered interesting
832
if sha1_winner == 'this':
833
content_changed = False
834
elif other_ie.kind == 'symlink':
835
def get_target(ie, tree):
836
if ie.kind != 'symlink':
838
return tree.get_symlink_target(file_id)
839
base_target = get_target(base_ie, self.base_tree)
840
lca_targets = [get_target(ie, tree) for ie, tree
841
in zip(lca_entries, self._lca_trees)]
842
this_target = get_target(this_ie, self.this_tree)
843
other_target = get_target(other_ie, self.other_tree)
844
target_winner = self._lca_multi_way(
845
(base_target, lca_targets),
846
other_target, this_target)
847
if (parent_id_winner == 'this' and name_winner == 'this'
848
and target_winner == 'this'):
849
# No kind, parent, name, or symlink target change
852
if target_winner == 'this':
853
content_changed = False
854
elif other_ie.kind == 'tree-reference':
855
# The 'changed' information seems to be handled at a higher
856
# level. At least, _entries3 returns False for content
857
# changed, even when at a new revision_id.
858
content_changed = False
859
if (parent_id_winner == 'this' and name_winner == 'this'):
860
# Nothing interesting
863
raise AssertionError('unhandled kind: %s' % other_ie.kind)
864
# XXX: We need to handle kind == 'symlink'
866
# If we have gotten this far, that means something has changed
867
result.append((file_id, content_changed,
868
((base_ie.parent_id, lca_parent_ids),
869
other_ie.parent_id, this_ie.parent_id),
870
((base_ie.name, lca_names),
871
other_ie.name, this_ie.name),
872
((base_ie.executable, lca_executable),
873
other_ie.executable, this_ie.executable)
880
self.tt.final_kind(self.tt.root)
881
except errors.NoSuchFile:
882
self.tt.cancel_deletion(self.tt.root)
883
if self.tt.final_file_id(self.tt.root) is None:
884
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
886
other_root_file_id = self.other_tree.get_root_id()
887
if other_root_file_id is None:
889
other_root = self.tt.trans_id_file_id(other_root_file_id)
890
if other_root == self.tt.root:
893
self.tt.final_kind(other_root)
894
except errors.NoSuchFile:
896
if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
897
# the other tree's root is a non-root in the current tree
899
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
900
self.tt.cancel_creation(other_root)
901
self.tt.cancel_versioning(other_root)
903
def reparent_children(self, ie, target):
904
for thing, child in ie.children.iteritems():
905
trans_id = self.tt.trans_id_file_id(child.file_id)
906
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
908
def write_modified(self, results):
910
for path in results.modified_paths:
911
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
914
hash = self.this_tree.get_file_sha1(file_id)
917
modified_hashes[file_id] = hash
918
self.this_tree.set_merge_modified(modified_hashes)
921
def parent(entry, file_id):
922
"""Determine the parent for a file_id (used as a key method)"""
925
return entry.parent_id
928
def name(entry, file_id):
929
"""Determine the name for a file_id (used as a key method)"""
935
def contents_sha1(tree, file_id):
936
"""Determine the sha1 of the file contents (used as a key method)."""
937
if file_id not in tree:
939
return tree.get_file_sha1(file_id)
942
def executable(tree, file_id):
943
"""Determine the executability of a file-id (used as a key method)."""
944
if file_id not in tree:
946
if tree.kind(file_id) != "file":
948
return tree.is_executable(file_id)
951
def kind(tree, file_id):
952
"""Determine the kind of a file-id (used as a key method)."""
953
if file_id not in tree:
955
return tree.kind(file_id)
958
def _three_way(base, other, this):
959
#if base == other, either they all agree, or only THIS has changed.
962
elif this not in (base, other):
964
# "Ambiguous clean merge" -- both sides have made the same change.
967
# this == base: only other has changed.
972
def _lca_multi_way(bases, other, this, allow_overriding_lca=True):
973
"""Consider LCAs when determining whether a change has occurred.
975
If LCAS are all identical, this is the same as a _three_way comparison.
977
:param bases: value in (BASE, [LCAS])
978
:param other: value in OTHER
979
:param this: value in THIS
980
:param allow_overriding_lca: If there is more than one unique lca
981
value, allow OTHER to override THIS if it has a new value, and
982
THIS only has an lca value, or vice versa. This is appropriate for
983
truly scalar values, not as much for non-scalars.
984
:return: 'this', 'other', or 'conflict' depending on whether an entry
987
# See doc/developers/lca_tree_merging.txt for details about this
990
# Either Ambiguously clean, or nothing was actually changed. We
993
base_val, lca_vals = bases
994
# Remove 'base_val' from the lca_vals, because it is not interesting
995
filtered_lca_vals = [lca_val for lca_val in lca_vals
996
if lca_val != base_val]
997
if len(filtered_lca_vals) == 0:
998
return Merge3Merger._three_way(base_val, other, this)
1000
unique_lca_vals = set(filtered_lca_vals)
1001
if len(unique_lca_vals) == 1:
1002
return Merge3Merger._three_way(unique_lca_vals.pop(), other, this)
1004
if allow_overriding_lca:
1005
if other in unique_lca_vals:
1006
if this in unique_lca_vals:
1007
# Each side picked a different lca, conflict
1010
# This has a value which supersedes both lca values, and
1011
# other only has an lca value
1013
elif this in unique_lca_vals:
1014
# OTHER has a value which supersedes both lca values, and this
1015
# only has an lca value
1018
# At this point, the lcas disagree, and the tips disagree
1022
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
1023
"""Do a three-way test on a scalar.
1024
Return "this", "other" or "conflict", depending whether a value wins.
1026
key_base = key(base_tree, file_id)
1027
key_other = key(other_tree, file_id)
1028
#if base == other, either they all agree, or only THIS has changed.
1029
if key_base == key_other:
1031
key_this = key(this_tree, file_id)
1032
# "Ambiguous clean merge"
1033
if key_this == key_other:
1035
elif key_this == key_base:
1040
def merge_names(self, file_id):
1041
def get_entry(tree):
1042
if file_id in tree.inventory:
1043
return tree.inventory[file_id]
1046
this_entry = get_entry(self.this_tree)
1047
other_entry = get_entry(self.other_tree)
1048
base_entry = get_entry(self.base_tree)
1049
entries = (base_entry, other_entry, this_entry)
1052
for entry in entries:
1055
parents.append(None)
1057
names.append(entry.name)
1058
parents.append(entry.parent_id)
1059
return self._merge_names(file_id, parents, names,
1060
resolver=self._three_way)
1062
def _merge_names(self, file_id, parents, names, resolver):
1063
"""Perform a merge on file_id names and parents"""
1064
base_name, other_name, this_name = names
1065
base_parent, other_parent, this_parent = parents
1067
name_winner = resolver(*names)
1069
parent_id_winner = resolver(*parents)
1070
if this_name is None:
1071
if name_winner == "this":
1072
name_winner = "other"
1073
if parent_id_winner == "this":
1074
parent_id_winner = "other"
1075
if name_winner == "this" and parent_id_winner == "this":
1077
if name_winner == "conflict":
1078
trans_id = self.tt.trans_id_file_id(file_id)
1079
self._raw_conflicts.append(('name conflict', trans_id,
1080
this_name, other_name))
1081
if parent_id_winner == "conflict":
1082
trans_id = self.tt.trans_id_file_id(file_id)
1083
self._raw_conflicts.append(('parent conflict', trans_id,
1084
this_parent, other_parent))
1085
if other_name is None:
1086
# it doesn't matter whether the result was 'other' or
1087
# 'conflict'-- if there's no 'other', we leave it alone.
1089
# if we get here, name_winner and parent_winner are set to safe values.
1090
trans_id = self.tt.trans_id_file_id(file_id)
1091
parent_id = parents[self.winner_idx[parent_id_winner]]
1092
if parent_id is not None:
1093
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1094
self.tt.adjust_path(names[self.winner_idx[name_winner]],
1095
parent_trans_id, trans_id)
1097
def merge_contents(self, file_id):
1098
"""Performs a merge on file_id contents."""
1099
def contents_pair(tree):
1100
if file_id not in tree:
1102
kind = tree.kind(file_id)
1104
contents = tree.get_file_sha1(file_id)
1105
elif kind == "symlink":
1106
contents = tree.get_symlink_target(file_id)
1109
return kind, contents
1111
def contents_conflict():
1112
trans_id = self.tt.trans_id_file_id(file_id)
1113
name = self.tt.final_name(trans_id)
1114
parent_id = self.tt.final_parent(trans_id)
1115
if file_id in self.this_tree.inventory:
1116
self.tt.unversion_file(trans_id)
1117
if file_id in self.this_tree:
1118
self.tt.delete_contents(trans_id)
1119
file_group = self._dump_conflicts(name, parent_id, file_id,
1121
self._raw_conflicts.append(('contents conflict', file_group))
1123
# See SPOT run. run, SPOT, run.
1124
# So we're not QUITE repeating ourselves; we do tricky things with
1126
base_pair = contents_pair(self.base_tree)
1127
other_pair = contents_pair(self.other_tree)
1129
this_pair = contents_pair(self.this_tree)
1130
lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1131
winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1132
this_pair, allow_overriding_lca=False)
1134
if base_pair == other_pair:
1137
# We delayed evaluating this_pair as long as we can to avoid
1138
# unnecessary sha1 calculation
1139
this_pair = contents_pair(self.this_tree)
1140
winner = self._three_way(base_pair, other_pair, this_pair)
1141
if winner == 'this':
1142
# No interesting changes introduced by OTHER
1144
trans_id = self.tt.trans_id_file_id(file_id)
1145
if winner == 'other':
1146
# OTHER is a straight winner, so replace this contents with other
1147
file_in_this = file_id in self.this_tree
1149
# Remove any existing contents
1150
self.tt.delete_contents(trans_id)
1151
if file_id in self.other_tree:
1152
# OTHER changed the file
1154
if wt.supports_content_filtering():
1155
# We get the path from the working tree if it exists.
1156
# That fails though when OTHER is adding a file, so
1157
# we fall back to the other tree to find the path if
1158
# it doesn't exist locally.
1160
filter_tree_path = wt.id2path(file_id)
1161
except errors.NoSuchId:
1162
filter_tree_path = self.other_tree.id2path(file_id)
1164
# Skip the id2path lookup for older formats
1165
filter_tree_path = None
1166
transform.create_from_tree(self.tt, trans_id,
1167
self.other_tree, file_id,
1168
filter_tree_path=filter_tree_path)
1169
if not file_in_this:
1170
self.tt.version_file(file_id, trans_id)
1173
# OTHER deleted the file
1174
self.tt.unversion_file(trans_id)
1177
# We have a hypothetical conflict, but if we have files, then we
1178
# can try to merge the content
1179
if this_pair[0] == 'file' and other_pair[0] == 'file':
1180
# THIS and OTHER are both files, so text merge. Either
1181
# BASE is a file, or both converted to files, so at least we
1182
# have agreement that output should be a file.
1184
self.text_merge(file_id, trans_id)
1185
except errors.BinaryFile:
1186
return contents_conflict()
1187
if file_id not in self.this_tree:
1188
self.tt.version_file(file_id, trans_id)
1190
self.tt.tree_kind(trans_id)
1191
self.tt.delete_contents(trans_id)
1192
except errors.NoSuchFile:
1196
return contents_conflict()
1198
def get_lines(self, tree, file_id):
1199
"""Return the lines in a file, or an empty list."""
1201
return tree.get_file(file_id).readlines()
1205
def text_merge(self, file_id, trans_id):
1206
"""Perform a three-way text merge on a file_id"""
1207
# it's possible that we got here with base as a different type.
1208
# if so, we just want two-way text conflicts.
1209
if file_id in self.base_tree and \
1210
self.base_tree.kind(file_id) == "file":
1211
base_lines = self.get_lines(self.base_tree, file_id)
1214
other_lines = self.get_lines(self.other_tree, file_id)
1215
this_lines = self.get_lines(self.this_tree, file_id)
1216
m3 = merge3.Merge3(base_lines, this_lines, other_lines,
1217
is_cherrypick=self.cherrypick)
1218
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
1219
if self.show_base is True:
1220
base_marker = '|' * 7
1224
def iter_merge3(retval):
1225
retval["text_conflicts"] = False
1226
for line in m3.merge_lines(name_a = "TREE",
1227
name_b = "MERGE-SOURCE",
1228
name_base = "BASE-REVISION",
1229
start_marker=start_marker,
1230
base_marker=base_marker,
1231
reprocess=self.reprocess):
1232
if line.startswith(start_marker):
1233
retval["text_conflicts"] = True
1234
yield line.replace(start_marker, '<' * 7)
1238
merge3_iterator = iter_merge3(retval)
1239
self.tt.create_file(merge3_iterator, trans_id)
1240
if retval["text_conflicts"] is True:
1241
self._raw_conflicts.append(('text conflict', trans_id))
1242
name = self.tt.final_name(trans_id)
1243
parent_id = self.tt.final_parent(trans_id)
1244
file_group = self._dump_conflicts(name, parent_id, file_id,
1245
this_lines, base_lines,
1247
file_group.append(trans_id)
1249
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
1250
base_lines=None, other_lines=None, set_version=False,
1252
"""Emit conflict files.
1253
If this_lines, base_lines, or other_lines are omitted, they will be
1254
determined automatically. If set_version is true, the .OTHER, .THIS
1255
or .BASE (in that order) will be created as versioned files.
1257
data = [('OTHER', self.other_tree, other_lines),
1258
('THIS', self.this_tree, this_lines)]
1260
data.append(('BASE', self.base_tree, base_lines))
1262
# We need to use the actual path in the working tree of the file here,
1263
# ignoring the conflict suffixes
1265
if wt.supports_content_filtering():
1267
filter_tree_path = wt.id2path(file_id)
1268
except errors.NoSuchId:
1269
# file has been deleted
1270
filter_tree_path = None
1272
# Skip the id2path lookup for older formats
1273
filter_tree_path = None
1277
for suffix, tree, lines in data:
1279
trans_id = self._conflict_file(name, parent_id, tree, file_id,
1280
suffix, lines, filter_tree_path)
1281
file_group.append(trans_id)
1282
if set_version and not versioned:
1283
self.tt.version_file(file_id, trans_id)
1287
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1288
lines=None, filter_tree_path=None):
1289
"""Emit a single conflict file."""
1290
name = name + '.' + suffix
1291
trans_id = self.tt.create_path(name, parent_id)
1292
transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
1296
def merge_executable(self, file_id, file_status):
1297
"""Perform a merge on the execute bit."""
1298
executable = [self.executable(t, file_id) for t in (self.base_tree,
1299
self.other_tree, self.this_tree)]
1300
self._merge_executable(file_id, executable, file_status,
1301
resolver=self._three_way)
1303
def _merge_executable(self, file_id, executable, file_status,
1305
"""Perform a merge on the execute bit."""
1306
base_executable, other_executable, this_executable = executable
1307
if file_status == "deleted":
1309
winner = resolver(*executable)
1310
if winner == "conflict":
1311
# There must be a None in here, if we have a conflict, but we
1312
# need executability since file status was not deleted.
1313
if self.executable(self.other_tree, file_id) is None:
1317
if winner == 'this' and file_status != "modified":
1319
trans_id = self.tt.trans_id_file_id(file_id)
1321
if self.tt.final_kind(trans_id) != "file":
1323
except errors.NoSuchFile:
1325
if winner == "this":
1326
executability = this_executable
1328
if file_id in self.other_tree:
1329
executability = other_executable
1330
elif file_id in self.this_tree:
1331
executability = this_executable
1332
elif file_id in self.base_tree:
1333
executability = base_executable
1334
if executability is not None:
1335
trans_id = self.tt.trans_id_file_id(file_id)
1336
self.tt.set_executability(executability, trans_id)
1338
def cook_conflicts(self, fs_conflicts):
1339
"""Convert all conflicts into a form that doesn't depend on trans_id"""
1341
self.cooked_conflicts.extend(transform.cook_conflicts(
1342
fs_conflicts, self.tt))
1343
fp = transform.FinalPaths(self.tt)
1344
for conflict in self._raw_conflicts:
1345
conflict_type = conflict[0]
1346
if conflict_type in ('name conflict', 'parent conflict'):
1347
trans_id = conflict[1]
1348
conflict_args = conflict[2:]
1349
if trans_id not in name_conflicts:
1350
name_conflicts[trans_id] = {}
1351
transform.unique_add(name_conflicts[trans_id], conflict_type,
1353
if conflict_type == 'contents conflict':
1354
for trans_id in conflict[1]:
1355
file_id = self.tt.final_file_id(trans_id)
1356
if file_id is not None:
1358
path = fp.get_path(trans_id)
1359
for suffix in ('.BASE', '.THIS', '.OTHER'):
1360
if path.endswith(suffix):
1361
path = path[:-len(suffix)]
1363
c = _mod_conflicts.Conflict.factory(conflict_type,
1364
path=path, file_id=file_id)
1365
self.cooked_conflicts.append(c)
1366
if conflict_type == 'text conflict':
1367
trans_id = conflict[1]
1368
path = fp.get_path(trans_id)
1369
file_id = self.tt.final_file_id(trans_id)
1370
c = _mod_conflicts.Conflict.factory(conflict_type,
1371
path=path, file_id=file_id)
1372
self.cooked_conflicts.append(c)
1374
for trans_id, conflicts in name_conflicts.iteritems():
1376
this_parent, other_parent = conflicts['parent conflict']
1377
if this_parent == other_parent:
1378
raise AssertionError()
1380
this_parent = other_parent = \
1381
self.tt.final_file_id(self.tt.final_parent(trans_id))
1383
this_name, other_name = conflicts['name conflict']
1384
if this_name == other_name:
1385
raise AssertionError()
1387
this_name = other_name = self.tt.final_name(trans_id)
1388
other_path = fp.get_path(trans_id)
1389
if this_parent is not None and this_name is not None:
1390
this_parent_path = \
1391
fp.get_path(self.tt.trans_id_file_id(this_parent))
1392
this_path = osutils.pathjoin(this_parent_path, this_name)
1394
this_path = "<deleted>"
1395
file_id = self.tt.final_file_id(trans_id)
1396
c = _mod_conflicts.Conflict.factory('path conflict', path=this_path,
1397
conflict_path=other_path,
1399
self.cooked_conflicts.append(c)
1400
self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1403
class WeaveMerger(Merge3Merger):
1404
"""Three-way tree merger, text weave merger."""
1405
supports_reprocess = True
1406
supports_show_base = False
1407
supports_reverse_cherrypick = False
1408
history_based = True
1410
def _merged_lines(self, file_id):
1411
"""Generate the merged lines.
1412
There is no distinction between lines that are meant to contain <<<<<<<
1416
base = self.base_tree
1419
plan = self.this_tree.plan_file_merge(file_id, self.other_tree,
1421
if 'merge' in debug.debug_flags:
1423
trans_id = self.tt.trans_id_file_id(file_id)
1424
name = self.tt.final_name(trans_id) + '.plan'
1425
contents = ('%10s|%s' % l for l in plan)
1426
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1427
textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1428
'>>>>>>> MERGE-SOURCE\n')
1429
return textmerge.merge_lines(self.reprocess)
1431
def text_merge(self, file_id, trans_id):
1432
"""Perform a (weave) text merge for a given file and file-id.
1433
If conflicts are encountered, .THIS and .OTHER files will be emitted,
1434
and a conflict will be noted.
1436
lines, conflicts = self._merged_lines(file_id)
1438
# Note we're checking whether the OUTPUT is binary in this case,
1439
# because we don't want to get into weave merge guts.
1440
textfile.check_text_lines(lines)
1441
self.tt.create_file(lines, trans_id)
1443
self._raw_conflicts.append(('text conflict', trans_id))
1444
name = self.tt.final_name(trans_id)
1445
parent_id = self.tt.final_parent(trans_id)
1446
file_group = self._dump_conflicts(name, parent_id, file_id,
1448
file_group.append(trans_id)
1451
class LCAMerger(WeaveMerger):
1453
def _merged_lines(self, file_id):
1454
"""Generate the merged lines.
1455
There is no distinction between lines that are meant to contain <<<<<<<
1459
base = self.base_tree
1462
plan = self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1464
if 'merge' in debug.debug_flags:
1466
trans_id = self.tt.trans_id_file_id(file_id)
1467
name = self.tt.final_name(trans_id) + '.plan'
1468
contents = ('%10s|%s' % l for l in plan)
1469
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1470
textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1471
'>>>>>>> MERGE-SOURCE\n')
1472
return textmerge.merge_lines(self.reprocess)
1475
class Diff3Merger(Merge3Merger):
1476
"""Three-way merger using external diff3 for text merging"""
1478
def dump_file(self, temp_dir, name, tree, file_id):
1479
out_path = osutils.pathjoin(temp_dir, name)
1480
out_file = open(out_path, "wb")
1482
in_file = tree.get_file(file_id)
1483
for line in in_file:
1484
out_file.write(line)
1489
def text_merge(self, file_id, trans_id):
1490
"""Perform a diff3 merge using a specified file-id and trans-id.
1491
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
1492
will be dumped, and a will be conflict noted.
1495
temp_dir = osutils.mkdtemp(prefix="bzr-")
1497
new_file = osutils.pathjoin(temp_dir, "new")
1498
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
1499
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
1500
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
1501
status = bzrlib.patch.diff3(new_file, this, base, other)
1502
if status not in (0, 1):
1503
raise errors.BzrError("Unhandled diff3 exit code")
1504
f = open(new_file, 'rb')
1506
self.tt.create_file(f, trans_id)
1510
name = self.tt.final_name(trans_id)
1511
parent_id = self.tt.final_parent(trans_id)
1512
self._dump_conflicts(name, parent_id, file_id)
1513
self._raw_conflicts.append(('text conflict', trans_id))
1515
osutils.rmtree(temp_dir)
1518
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1520
merge_type=Merge3Merger,
1521
interesting_ids=None,
1525
interesting_files=None,
1527
pb=progress.DummyProgress(),
1528
change_reporter=None):
1529
"""Primary interface for merging.
1531
typical use is probably
1532
'merge_inner(branch, branch.get_revision_tree(other_revision),
1533
branch.get_revision_tree(base_revision))'
1535
if this_tree is None:
1536
raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
1537
"parameter as of bzrlib version 0.8.")
1538
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1539
pb=pb, change_reporter=change_reporter)
1540
merger.backup_files = backup_files
1541
merger.merge_type = merge_type
1542
merger.interesting_ids = interesting_ids
1543
merger.ignore_zero = ignore_zero
1544
if interesting_files:
1546
raise ValueError('Only supply interesting_ids'
1547
' or interesting_files')
1548
merger.interesting_files = interesting_files
1549
merger.show_base = show_base
1550
merger.reprocess = reprocess
1551
merger.other_rev_id = other_rev_id
1552
merger.other_basis = other_rev_id
1553
get_revision_id = getattr(base_tree, 'get_revision_id', None)
1554
if get_revision_id is None:
1555
get_revision_id = base_tree.last_revision
1556
merger.cache_trees_with_revision_ids([other_tree, base_tree, this_tree])
1557
merger.set_base_revision(get_revision_id(), this_branch)
1558
return merger.do_merge()
1560
def get_merge_type_registry():
1561
"""Merge type registry is in bzrlib.option to avoid circular imports.
1563
This method provides a sanctioned way to retrieve it.
1565
from bzrlib import option
1566
return option._merge_type_registry
1569
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
1570
def status_a(revision, text):
1571
if revision in ancestors_b:
1572
return 'killed-b', text
1574
return 'new-a', text
1576
def status_b(revision, text):
1577
if revision in ancestors_a:
1578
return 'killed-a', text
1580
return 'new-b', text
1582
plain_a = [t for (a, t) in annotated_a]
1583
plain_b = [t for (a, t) in annotated_b]
1584
matcher = patiencediff.PatienceSequenceMatcher(None, plain_a, plain_b)
1585
blocks = matcher.get_matching_blocks()
1588
for ai, bi, l in blocks:
1589
# process all mismatched sections
1590
# (last mismatched section is handled because blocks always
1591
# includes a 0-length last block)
1592
for revision, text in annotated_a[a_cur:ai]:
1593
yield status_a(revision, text)
1594
for revision, text in annotated_b[b_cur:bi]:
1595
yield status_b(revision, text)
1596
# and now the matched section
1599
for text_a in plain_a[ai:a_cur]:
1600
yield "unchanged", text_a
1603
class _PlanMergeBase(object):
1605
def __init__(self, a_rev, b_rev, vf, key_prefix):
1608
:param a_rev: Revision-id of one revision to merge
1609
:param b_rev: Revision-id of the other revision to merge
1610
:param vf: A VersionedFiles containing both revisions
1611
:param key_prefix: A prefix for accessing keys in vf, typically
1617
self._last_lines = None
1618
self._last_lines_revision_id = None
1619
self._cached_matching_blocks = {}
1620
self._key_prefix = key_prefix
1621
self._precache_tip_lines()
1623
def _precache_tip_lines(self):
1624
lines = self.get_lines([self.a_rev, self.b_rev])
1625
self.lines_a = lines[self.a_rev]
1626
self.lines_b = lines[self.b_rev]
1628
def get_lines(self, revisions):
1629
"""Get lines for revisions from the backing VersionedFiles.
1631
:raises RevisionNotPresent: on absent texts.
1633
keys = [(self._key_prefix + (rev,)) for rev in revisions]
1635
for record in self.vf.get_record_stream(keys, 'unordered', True):
1636
if record.storage_kind == 'absent':
1637
raise errors.RevisionNotPresent(record.key, self.vf)
1638
result[record.key[-1]] = osutils.chunks_to_lines(
1639
record.get_bytes_as('chunked'))
1642
def plan_merge(self):
1643
"""Generate a 'plan' for merging the two revisions.
1645
This involves comparing their texts and determining the cause of
1646
differences. If text A has a line and text B does not, then either the
1647
line was added to text A, or it was deleted from B. Once the causes
1648
are combined, they are written out in the format described in
1649
VersionedFile.plan_merge
1651
blocks = self._get_matching_blocks(self.a_rev, self.b_rev)
1652
unique_a, unique_b = self._unique_lines(blocks)
1653
new_a, killed_b = self._determine_status(self.a_rev, unique_a)
1654
new_b, killed_a = self._determine_status(self.b_rev, unique_b)
1655
return self._iter_plan(blocks, new_a, killed_b, new_b, killed_a)
1657
def _iter_plan(self, blocks, new_a, killed_b, new_b, killed_a):
1660
for i, j, n in blocks:
1661
for a_index in range(last_i, i):
1662
if a_index in new_a:
1663
if a_index in killed_b:
1664
yield 'conflicted-a', self.lines_a[a_index]
1666
yield 'new-a', self.lines_a[a_index]
1668
yield 'killed-b', self.lines_a[a_index]
1669
for b_index in range(last_j, j):
1670
if b_index in new_b:
1671
if b_index in killed_a:
1672
yield 'conflicted-b', self.lines_b[b_index]
1674
yield 'new-b', self.lines_b[b_index]
1676
yield 'killed-a', self.lines_b[b_index]
1677
# handle common lines
1678
for a_index in range(i, i+n):
1679
yield 'unchanged', self.lines_a[a_index]
1683
def _get_matching_blocks(self, left_revision, right_revision):
1684
"""Return a description of which sections of two revisions match.
1686
See SequenceMatcher.get_matching_blocks
1688
cached = self._cached_matching_blocks.get((left_revision,
1690
if cached is not None:
1692
if self._last_lines_revision_id == left_revision:
1693
left_lines = self._last_lines
1694
right_lines = self.get_lines([right_revision])[right_revision]
1696
lines = self.get_lines([left_revision, right_revision])
1697
left_lines = lines[left_revision]
1698
right_lines = lines[right_revision]
1699
self._last_lines = right_lines
1700
self._last_lines_revision_id = right_revision
1701
matcher = patiencediff.PatienceSequenceMatcher(None, left_lines,
1703
return matcher.get_matching_blocks()
1705
def _unique_lines(self, matching_blocks):
1706
"""Analyse matching_blocks to determine which lines are unique
1708
:return: a tuple of (unique_left, unique_right), where the values are
1709
sets of line numbers of unique lines.
1715
for i, j, n in matching_blocks:
1716
unique_left.extend(range(last_i, i))
1717
unique_right.extend(range(last_j, j))
1720
return unique_left, unique_right
1723
def _subtract_plans(old_plan, new_plan):
1724
"""Remove changes from new_plan that came from old_plan.
1726
It is assumed that the difference between the old_plan and new_plan
1727
is their choice of 'b' text.
1729
All lines from new_plan that differ from old_plan are emitted
1730
verbatim. All lines from new_plan that match old_plan but are
1731
not about the 'b' revision are emitted verbatim.
1733
Lines that match and are about the 'b' revision are the lines we
1734
don't want, so we convert 'killed-b' -> 'unchanged', and 'new-b'
1735
is skipped entirely.
1737
matcher = patiencediff.PatienceSequenceMatcher(None, old_plan,
1740
for i, j, n in matcher.get_matching_blocks():
1741
for jj in range(last_j, j):
1743
for jj in range(j, j+n):
1744
plan_line = new_plan[jj]
1745
if plan_line[0] == 'new-b':
1747
elif plan_line[0] == 'killed-b':
1748
yield 'unchanged', plan_line[1]
1754
class _PlanMerge(_PlanMergeBase):
1755
"""Plan an annotate merge using on-the-fly annotation"""
1757
def __init__(self, a_rev, b_rev, vf, key_prefix):
1758
super(_PlanMerge, self).__init__(a_rev, b_rev, vf, key_prefix)
1759
self.a_key = self._key_prefix + (self.a_rev,)
1760
self.b_key = self._key_prefix + (self.b_rev,)
1761
self.graph = _mod_graph.Graph(self.vf)
1762
heads = self.graph.heads((self.a_key, self.b_key))
1764
# one side dominates, so we can just return its values, yay for
1766
# Ideally we would know that before we get this far
1767
self._head_key = heads.pop()
1768
if self._head_key == self.a_key:
1772
trace.mutter('found dominating revision for %s\n%s > %s', self.vf,
1773
self._head_key[-1], other)
1776
self._head_key = None
1779
def _precache_tip_lines(self):
1780
# Turn this into a no-op, because we will do this later
1783
def _find_recursive_lcas(self):
1784
"""Find all the ancestors back to a unique lca"""
1785
cur_ancestors = (self.a_key, self.b_key)
1786
# graph.find_lca(uncommon, keys) now returns plain NULL_REVISION,
1787
# rather than a key tuple. We will just map that directly to no common
1791
next_lcas = self.graph.find_lca(*cur_ancestors)
1792
# Map a plain NULL_REVISION to a simple no-ancestors
1793
if next_lcas == set([_mod_revision.NULL_REVISION]):
1795
# Order the lca's based on when they were merged into the tip
1796
# While the actual merge portion of weave merge uses a set() of
1797
# active revisions, the order of insertion *does* effect the
1798
# implicit ordering of the texts.
1799
for rev_key in cur_ancestors:
1800
ordered_parents = tuple(self.graph.find_merge_order(rev_key,
1802
parent_map[rev_key] = ordered_parents
1803
if len(next_lcas) == 0:
1805
elif len(next_lcas) == 1:
1806
parent_map[list(next_lcas)[0]] = ()
1808
elif len(next_lcas) > 2:
1809
# More than 2 lca's, fall back to grabbing all nodes between
1810
# this and the unique lca.
1811
trace.mutter('More than 2 LCAs, falling back to all nodes for:'
1813
self.a_key, self.b_key, cur_ancestors)
1814
cur_lcas = next_lcas
1815
while len(cur_lcas) > 1:
1816
cur_lcas = self.graph.find_lca(*cur_lcas)
1817
if len(cur_lcas) == 0:
1818
# No common base to find, use the full ancestry
1821
unique_lca = list(cur_lcas)[0]
1822
if unique_lca == _mod_revision.NULL_REVISION:
1823
# find_lca will return a plain 'NULL_REVISION' rather
1824
# than a key tuple when there is no common ancestor, we
1825
# prefer to just use None, because it doesn't confuse
1826
# _get_interesting_texts()
1828
parent_map.update(self._find_unique_parents(next_lcas,
1831
cur_ancestors = next_lcas
1834
def _find_unique_parents(self, tip_keys, base_key):
1835
"""Find ancestors of tip that aren't ancestors of base.
1837
:param tip_keys: Nodes that are interesting
1838
:param base_key: Cull all ancestors of this node
1839
:return: The parent map for all revisions between tip_keys and
1840
base_key. base_key will be included. References to nodes outside of
1841
the ancestor set will also be removed.
1843
# TODO: this would be simpler if find_unique_ancestors took a list
1844
# instead of a single tip, internally it supports it, but it
1845
# isn't a "backwards compatible" api change.
1846
if base_key is None:
1847
parent_map = dict(self.graph.iter_ancestry(tip_keys))
1848
# We remove NULL_REVISION because it isn't a proper tuple key, and
1849
# thus confuses things like _get_interesting_texts, and our logic
1850
# to add the texts into the memory weave.
1851
if _mod_revision.NULL_REVISION in parent_map:
1852
parent_map.pop(_mod_revision.NULL_REVISION)
1855
for tip in tip_keys:
1857
self.graph.find_unique_ancestors(tip, [base_key]))
1858
parent_map = self.graph.get_parent_map(interesting)
1859
parent_map[base_key] = ()
1860
culled_parent_map, child_map, tails = self._remove_external_references(
1862
# Remove all the tails but base_key
1863
if base_key is not None:
1864
tails.remove(base_key)
1865
self._prune_tails(culled_parent_map, child_map, tails)
1866
# Now remove all the uninteresting 'linear' regions
1867
simple_map = _mod_graph.collapse_linear_regions(culled_parent_map)
1871
def _remove_external_references(parent_map):
1872
"""Remove references that go outside of the parent map.
1874
:param parent_map: Something returned from Graph.get_parent_map(keys)
1875
:return: (filtered_parent_map, child_map, tails)
1876
filtered_parent_map is parent_map without external references
1877
child_map is the {parent_key: [child_keys]} mapping
1878
tails is a list of nodes that do not have any parents in the map
1880
# TODO: The basic effect of this function seems more generic than
1881
# _PlanMerge. But the specific details of building a child_map,
1882
# and computing tails seems very specific to _PlanMerge.
1883
# Still, should this be in Graph land?
1884
filtered_parent_map = {}
1887
for key, parent_keys in parent_map.iteritems():
1888
culled_parent_keys = [p for p in parent_keys if p in parent_map]
1889
if not culled_parent_keys:
1891
for parent_key in culled_parent_keys:
1892
child_map.setdefault(parent_key, []).append(key)
1893
# TODO: Do we want to do this, it adds overhead for every node,
1894
# just to say that the node has no children
1895
child_map.setdefault(key, [])
1896
filtered_parent_map[key] = culled_parent_keys
1897
return filtered_parent_map, child_map, tails
1900
def _prune_tails(parent_map, child_map, tails_to_remove):
1901
"""Remove tails from the parent map.
1903
This will remove the supplied revisions until no more children have 0
1906
:param parent_map: A dict of {child: [parents]}, this dictionary will
1907
be modified in place.
1908
:param tails_to_remove: A list of tips that should be removed,
1909
this list will be consumed
1910
:param child_map: The reverse dict of parent_map ({parent: [children]})
1911
this dict will be modified
1912
:return: None, parent_map will be modified in place.
1914
while tails_to_remove:
1915
next = tails_to_remove.pop()
1916
parent_map.pop(next)
1917
children = child_map.pop(next)
1918
for child in children:
1919
child_parents = parent_map[child]
1920
child_parents.remove(next)
1921
if len(child_parents) == 0:
1922
tails_to_remove.append(child)
1924
def _get_interesting_texts(self, parent_map):
1925
"""Return a dict of texts we are interested in.
1927
Note that the input is in key tuples, but the output is in plain
1930
:param parent_map: The output from _find_recursive_lcas
1931
:return: A dict of {'revision_id':lines} as returned by
1932
_PlanMergeBase.get_lines()
1934
all_revision_keys = set(parent_map)
1935
all_revision_keys.add(self.a_key)
1936
all_revision_keys.add(self.b_key)
1938
# Everything else is in 'keys' but get_lines is in 'revision_ids'
1939
all_texts = self.get_lines([k[-1] for k in all_revision_keys])
1942
def _build_weave(self):
1943
from bzrlib import weave
1944
self._weave = weave.Weave(weave_name='in_memory_weave',
1945
allow_reserved=True)
1946
parent_map = self._find_recursive_lcas()
1948
all_texts = self._get_interesting_texts(parent_map)
1950
# Note: Unfortunately, the order given by topo_sort will effect the
1951
# ordering resolution in the output. Specifically, if you add A then B,
1952
# then in the output text A lines will show up before B lines. And, of
1953
# course, topo_sort doesn't guarantee any real ordering.
1954
# So we use merge_sort, and add a fake node on the tip.
1955
# This ensures that left-hand parents will always be inserted into the
1956
# weave before right-hand parents.
1957
tip_key = self._key_prefix + (_mod_revision.CURRENT_REVISION,)
1958
parent_map[tip_key] = (self.a_key, self.b_key)
1960
for seq_num, key, depth, eom in reversed(tsort.merge_sort(parent_map,
1964
# for key in tsort.topo_sort(parent_map):
1965
parent_keys = parent_map[key]
1966
revision_id = key[-1]
1967
parent_ids = [k[-1] for k in parent_keys]
1968
self._weave.add_lines(revision_id, parent_ids,
1969
all_texts[revision_id])
1971
def plan_merge(self):
1972
"""Generate a 'plan' for merging the two revisions.
1974
This involves comparing their texts and determining the cause of
1975
differences. If text A has a line and text B does not, then either the
1976
line was added to text A, or it was deleted from B. Once the causes
1977
are combined, they are written out in the format described in
1978
VersionedFile.plan_merge
1980
if self._head_key is not None: # There was a single head
1981
if self._head_key == self.a_key:
1984
if self._head_key != self.b_key:
1985
raise AssertionError('There was an invalid head: %s != %s'
1986
% (self.b_key, self._head_key))
1988
head_rev = self._head_key[-1]
1989
lines = self.get_lines([head_rev])[head_rev]
1990
return ((plan, line) for line in lines)
1991
return self._weave.plan_merge(self.a_rev, self.b_rev)
1994
class _PlanLCAMerge(_PlanMergeBase):
1996
This merge algorithm differs from _PlanMerge in that:
1997
1. comparisons are done against LCAs only
1998
2. cases where a contested line is new versus one LCA but old versus
1999
another are marked as conflicts, by emitting the line as conflicted-a
2002
This is faster, and hopefully produces more useful output.
2005
def __init__(self, a_rev, b_rev, vf, key_prefix, graph):
2006
_PlanMergeBase.__init__(self, a_rev, b_rev, vf, key_prefix)
2007
lcas = graph.find_lca(key_prefix + (a_rev,), key_prefix + (b_rev,))
2010
if lca == _mod_revision.NULL_REVISION:
2013
self.lcas.add(lca[-1])
2014
for lca in self.lcas:
2015
if _mod_revision.is_null(lca):
2018
lca_lines = self.get_lines([lca])[lca]
2019
matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_a,
2021
blocks = list(matcher.get_matching_blocks())
2022
self._cached_matching_blocks[(a_rev, lca)] = blocks
2023
matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_b,
2025
blocks = list(matcher.get_matching_blocks())
2026
self._cached_matching_blocks[(b_rev, lca)] = blocks
2028
def _determine_status(self, revision_id, unique_line_numbers):
2029
"""Determines the status unique lines versus all lcas.
2031
Basically, determines why the line is unique to this revision.
2033
A line may be determined new, killed, or both.
2035
If a line is determined new, that means it was not present in at least
2036
one LCA, and is not present in the other merge revision.
2038
If a line is determined killed, that means the line was present in
2041
If a line is killed and new, this indicates that the two merge
2042
revisions contain differing conflict resolutions.
2043
:param revision_id: The id of the revision in which the lines are
2045
:param unique_line_numbers: The line numbers of unique lines.
2046
:return a tuple of (new_this, killed_other):
2050
unique_line_numbers = set(unique_line_numbers)
2051
for lca in self.lcas:
2052
blocks = self._get_matching_blocks(revision_id, lca)
2053
unique_vs_lca, _ignored = self._unique_lines(blocks)
2054
new.update(unique_line_numbers.intersection(unique_vs_lca))
2055
killed.update(unique_line_numbers.difference(unique_vs_lca))
added
removed
bzrlib/merge.py
