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
# TODO: Report back as changes are merged in
41
def transform_tree(from_tree, to_tree, interesting_ids=None):
42
from_tree.lock_tree_write()
44
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
45
interesting_ids=interesting_ids, this_tree=from_tree)
51
def __init__(self, this_branch, other_tree=None, base_tree=None,
52
this_tree=None, pb=None, change_reporter=None,
53
recurse='down', revision_graph=None):
55
self.this_branch = this_branch
56
self.this_basis = _mod_revision.ensure_null(
57
this_branch.last_revision())
58
self.this_rev_id = None
59
self.this_tree = this_tree
60
self.this_revision_tree = None
61
self.this_basis_tree = None
62
self.other_tree = other_tree
63
self.other_branch = None
64
self.base_tree = base_tree
65
self.ignore_zero = False
66
self.backup_files = False
67
self.interesting_ids = None
68
self.interesting_files = None
69
self.show_base = False
70
self.reprocess = False
72
pb = progress.DummyProgress()
75
self.recurse = recurse
76
self.change_reporter = change_reporter
77
self._cached_trees = {}
78
self._revision_graph = revision_graph
79
self._base_is_ancestor = None
80
self._base_is_other_ancestor = None
81
self._is_criss_cross = None
82
self._lca_trees = None
84
def cache_trees_with_revision_ids(self, trees):
85
"""Cache any tree in trees if it has a revision_id."""
86
for maybe_tree in trees:
87
if maybe_tree is None:
90
rev_id = maybe_tree.get_revision_id()
91
except AttributeError:
93
self._cached_trees[rev_id] = maybe_tree
96
def revision_graph(self):
97
if self._revision_graph is None:
98
self._revision_graph = self.this_branch.repository.get_graph()
99
return self._revision_graph
101
def _set_base_is_ancestor(self, value):
102
self._base_is_ancestor = value
104
def _get_base_is_ancestor(self):
105
if self._base_is_ancestor is None:
106
self._base_is_ancestor = self.revision_graph.is_ancestor(
107
self.base_rev_id, self.this_basis)
108
return self._base_is_ancestor
110
base_is_ancestor = property(_get_base_is_ancestor, _set_base_is_ancestor)
112
def _set_base_is_other_ancestor(self, value):
113
self._base_is_other_ancestor = value
115
def _get_base_is_other_ancestor(self):
116
if self._base_is_other_ancestor is None:
117
if self.other_basis is None:
119
self._base_is_other_ancestor = self.revision_graph.is_ancestor(
120
self.base_rev_id, self.other_basis)
121
return self._base_is_other_ancestor
123
base_is_other_ancestor = property(_get_base_is_other_ancestor,
124
_set_base_is_other_ancestor)
127
def from_uncommitted(tree, other_tree, pb=None, base_tree=None):
128
"""Return a Merger for uncommitted changes in other_tree.
130
:param tree: The tree to merge into
131
:param other_tree: The tree to get uncommitted changes from
132
:param pb: A progress indicator
133
:param base_tree: The basis to use for the merge. If unspecified,
134
other_tree.basis_tree() will be used.
136
if base_tree is None:
137
base_tree = other_tree.basis_tree()
138
merger = Merger(tree.branch, other_tree, base_tree, tree, pb)
139
merger.base_rev_id = merger.base_tree.get_revision_id()
140
merger.other_rev_id = None
141
merger.other_basis = merger.base_rev_id
145
def from_mergeable(klass, tree, mergeable, pb):
146
"""Return a Merger for a bundle or merge directive.
148
:param tree: The tree to merge changes into
149
:param mergeable: A merge directive or bundle
150
:param pb: A progress indicator
152
mergeable.install_revisions(tree.branch.repository)
153
base_revision_id, other_revision_id, verified =\
154
mergeable.get_merge_request(tree.branch.repository)
155
revision_graph = tree.branch.repository.get_graph()
156
if base_revision_id is not None:
157
if (base_revision_id != _mod_revision.NULL_REVISION and
158
revision_graph.is_ancestor(
159
base_revision_id, tree.branch.last_revision())):
160
base_revision_id = None
162
trace.warning('Performing cherrypick')
163
merger = klass.from_revision_ids(pb, tree, other_revision_id,
164
base_revision_id, revision_graph=
166
return merger, verified
169
def from_revision_ids(pb, tree, other, base=None, other_branch=None,
170
base_branch=None, revision_graph=None,
172
"""Return a Merger for revision-ids.
174
:param pb: A progress indicator
175
:param tree: The tree to merge changes into
176
:param other: The revision-id to use as OTHER
177
:param base: The revision-id to use as BASE. If not specified, will
179
:param other_branch: A branch containing the other revision-id. If
180
not supplied, tree.branch is used.
181
:param base_branch: A branch containing the base revision-id. If
182
not supplied, other_branch or tree.branch will be used.
183
:param revision_graph: If you have a revision_graph precomputed, pass
184
it in, otherwise it will be created for you.
185
:param tree_branch: The branch associated with tree. If not supplied,
186
tree.branch will be used.
188
if tree_branch is None:
189
tree_branch = tree.branch
190
merger = Merger(tree_branch, this_tree=tree, pb=pb,
191
revision_graph=revision_graph)
192
if other_branch is None:
193
other_branch = tree.branch
194
merger.set_other_revision(other, other_branch)
198
if base_branch is None:
199
base_branch = other_branch
200
merger.set_base_revision(base, base_branch)
203
def revision_tree(self, revision_id, branch=None):
204
if revision_id not in self._cached_trees:
206
branch = self.this_branch
208
tree = self.this_tree.revision_tree(revision_id)
209
except errors.NoSuchRevisionInTree:
210
tree = branch.repository.revision_tree(revision_id)
211
self._cached_trees[revision_id] = tree
212
return self._cached_trees[revision_id]
214
def _get_tree(self, treespec, possible_transports=None):
215
from bzrlib import workingtree
216
location, revno = treespec
218
tree = workingtree.WorkingTree.open_containing(location)[0]
219
return tree.branch, tree
220
branch = _mod_branch.Branch.open_containing(
221
location, possible_transports)[0]
223
revision_id = branch.last_revision()
225
revision_id = branch.get_rev_id(revno)
226
revision_id = _mod_revision.ensure_null(revision_id)
227
return branch, self.revision_tree(revision_id, branch)
229
def ensure_revision_trees(self):
230
if self.this_revision_tree is None:
231
self.this_basis_tree = self.revision_tree(self.this_basis)
232
if self.this_basis == self.this_rev_id:
233
self.this_revision_tree = self.this_basis_tree
235
if self.other_rev_id is None:
236
other_basis_tree = self.revision_tree(self.other_basis)
237
if other_basis_tree.has_changes(self.other_tree):
238
raise WorkingTreeNotRevision(self.this_tree)
239
other_rev_id = self.other_basis
240
self.other_tree = other_basis_tree
242
def file_revisions(self, file_id):
243
self.ensure_revision_trees()
244
def get_id(tree, file_id):
245
revision_id = tree.inventory[file_id].revision
247
if self.this_rev_id is None:
248
if self.this_basis_tree.get_file_sha1(file_id) != \
249
self.this_tree.get_file_sha1(file_id):
250
raise errors.WorkingTreeNotRevision(self.this_tree)
252
trees = (self.this_basis_tree, self.other_tree)
253
return [get_id(tree, file_id) for tree in trees]
255
def check_basis(self, check_clean, require_commits=True):
256
if self.this_basis is None and require_commits is True:
257
raise errors.BzrCommandError(
258
"This branch has no commits."
259
" (perhaps you would prefer 'bzr pull')")
262
if self.this_basis != self.this_rev_id:
263
raise errors.UncommittedChanges(self.this_tree)
265
def compare_basis(self):
267
basis_tree = self.revision_tree(self.this_tree.last_revision())
268
except errors.NoSuchRevision:
269
basis_tree = self.this_tree.basis_tree()
270
if not self.this_tree.has_changes(basis_tree):
271
self.this_rev_id = self.this_basis
273
def set_interesting_files(self, file_list):
274
self.interesting_files = file_list
276
def set_pending(self):
277
if not self.base_is_ancestor or not self.base_is_other_ancestor or self.other_rev_id is None:
281
def _add_parent(self):
282
new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
283
new_parent_trees = []
284
for revision_id in new_parents:
286
tree = self.revision_tree(revision_id)
287
except errors.NoSuchRevision:
291
new_parent_trees.append((revision_id, tree))
293
self.this_tree.set_parent_trees(new_parent_trees,
294
allow_leftmost_as_ghost=True)
296
for _revision_id, tree in new_parent_trees:
300
def set_other(self, other_revision, possible_transports=None):
301
"""Set the revision and tree to merge from.
303
This sets the other_tree, other_rev_id, other_basis attributes.
305
:param other_revision: The [path, revision] list to merge from.
307
self.other_branch, self.other_tree = self._get_tree(other_revision,
309
if other_revision[1] == -1:
310
self.other_rev_id = _mod_revision.ensure_null(
311
self.other_branch.last_revision())
312
if _mod_revision.is_null(self.other_rev_id):
313
raise errors.NoCommits(self.other_branch)
314
self.other_basis = self.other_rev_id
315
elif other_revision[1] is not None:
316
self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
317
self.other_basis = self.other_rev_id
319
self.other_rev_id = None
320
self.other_basis = self.other_branch.last_revision()
321
if self.other_basis is None:
322
raise errors.NoCommits(self.other_branch)
323
if self.other_rev_id is not None:
324
self._cached_trees[self.other_rev_id] = self.other_tree
325
self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
327
def set_other_revision(self, revision_id, other_branch):
328
"""Set 'other' based on a branch and revision id
330
:param revision_id: The revision to use for a tree
331
:param other_branch: The branch containing this tree
333
self.other_rev_id = revision_id
334
self.other_branch = other_branch
335
self._maybe_fetch(other_branch, self.this_branch, self.other_rev_id)
336
self.other_tree = self.revision_tree(revision_id)
337
self.other_basis = revision_id
339
def set_base_revision(self, revision_id, branch):
340
"""Set 'base' based on a branch and revision id
342
:param revision_id: The revision to use for a tree
343
:param branch: The branch containing this tree
345
self.base_rev_id = revision_id
346
self.base_branch = branch
347
self._maybe_fetch(branch, self.this_branch, revision_id)
348
self.base_tree = self.revision_tree(revision_id)
350
def _maybe_fetch(self, source, target, revision_id):
351
if not source.repository.has_same_location(target.repository):
352
target.fetch(source, revision_id)
355
revisions = [_mod_revision.ensure_null(self.this_basis),
356
_mod_revision.ensure_null(self.other_basis)]
357
if _mod_revision.NULL_REVISION in revisions:
358
self.base_rev_id = _mod_revision.NULL_REVISION
359
self.base_tree = self.revision_tree(self.base_rev_id)
360
self._is_criss_cross = False
362
lcas = self.revision_graph.find_lca(revisions[0], revisions[1])
363
self._is_criss_cross = False
365
self.base_rev_id = _mod_revision.NULL_REVISION
367
self.base_rev_id = list(lcas)[0]
368
else: # len(lcas) > 1
370
# find_unique_lca can only handle 2 nodes, so we have to
371
# start back at the beginning. It is a shame to traverse
372
# the graph again, but better than re-implementing
374
self.base_rev_id = self.revision_graph.find_unique_lca(
375
revisions[0], revisions[1])
377
self.base_rev_id = self.revision_graph.find_unique_lca(
379
self._is_criss_cross = True
380
if self.base_rev_id == _mod_revision.NULL_REVISION:
381
raise errors.UnrelatedBranches()
382
if self._is_criss_cross:
383
trace.warning('Warning: criss-cross merge encountered. See bzr'
384
' help criss-cross.')
385
trace.mutter('Criss-cross lcas: %r' % lcas)
386
interesting_revision_ids = [self.base_rev_id]
387
interesting_revision_ids.extend(lcas)
388
interesting_trees = dict((t.get_revision_id(), t)
389
for t in self.this_branch.repository.revision_trees(
390
interesting_revision_ids))
391
self._cached_trees.update(interesting_trees)
392
self.base_tree = interesting_trees.pop(self.base_rev_id)
393
sorted_lca_keys = self.revision_graph.find_merge_order(
395
self._lca_trees = [interesting_trees[key]
396
for key in sorted_lca_keys]
398
self.base_tree = self.revision_tree(self.base_rev_id)
399
self.base_is_ancestor = True
400
self.base_is_other_ancestor = True
401
trace.mutter('Base revid: %r' % self.base_rev_id)
403
def set_base(self, base_revision):
404
"""Set the base revision to use for the merge.
406
:param base_revision: A 2-list containing a path and revision number.
408
trace.mutter("doing merge() with no base_revision specified")
409
if base_revision == [None, None]:
412
base_branch, self.base_tree = self._get_tree(base_revision)
413
if base_revision[1] == -1:
414
self.base_rev_id = base_branch.last_revision()
415
elif base_revision[1] is None:
416
self.base_rev_id = _mod_revision.NULL_REVISION
418
self.base_rev_id = _mod_revision.ensure_null(
419
base_branch.get_rev_id(base_revision[1]))
420
self._maybe_fetch(base_branch, self.this_branch, self.base_rev_id)
422
def make_merger(self):
423
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
424
'other_tree': self.other_tree,
425
'interesting_ids': self.interesting_ids,
426
'interesting_files': self.interesting_files,
429
if self.merge_type.requires_base:
430
kwargs['base_tree'] = self.base_tree
431
if self.merge_type.supports_reprocess:
432
kwargs['reprocess'] = self.reprocess
434
raise errors.BzrError(
435
"Conflict reduction is not supported for merge"
436
" type %s." % self.merge_type)
437
if self.merge_type.supports_show_base:
438
kwargs['show_base'] = self.show_base
440
raise errors.BzrError("Showing base is not supported for this"
441
" merge type. %s" % self.merge_type)
442
if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
443
and not self.base_is_other_ancestor):
444
raise errors.CannotReverseCherrypick()
445
if self.merge_type.supports_cherrypick:
446
kwargs['cherrypick'] = (not self.base_is_ancestor or
447
not self.base_is_other_ancestor)
448
if self._is_criss_cross and getattr(self.merge_type,
449
'supports_lca_trees', False):
450
kwargs['lca_trees'] = self._lca_trees
451
return self.merge_type(pb=self._pb,
452
change_reporter=self.change_reporter,
455
def _do_merge_to(self, merge):
456
if self.other_branch is not None:
457
self.other_branch.update_references(self.this_branch)
459
if self.recurse == 'down':
460
for relpath, file_id in self.this_tree.iter_references():
461
sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
462
other_revision = self.other_tree.get_reference_revision(
464
if other_revision == sub_tree.last_revision():
466
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
467
sub_merge.merge_type = self.merge_type
468
other_branch = self.other_branch.reference_parent(file_id, relpath)
469
sub_merge.set_other_revision(other_revision, other_branch)
470
base_revision = self.base_tree.get_reference_revision(file_id)
471
sub_merge.base_tree = \
472
sub_tree.branch.repository.revision_tree(base_revision)
473
sub_merge.base_rev_id = base_revision
477
self.this_tree.lock_tree_write()
479
if self.base_tree is not None:
480
self.base_tree.lock_read()
482
if self.other_tree is not None:
483
self.other_tree.lock_read()
485
merge = self.make_merger()
486
self._do_merge_to(merge)
488
if self.other_tree is not None:
489
self.other_tree.unlock()
491
if self.base_tree is not None:
492
self.base_tree.unlock()
494
self.this_tree.unlock()
495
if len(merge.cooked_conflicts) == 0:
496
if not self.ignore_zero and not trace.is_quiet():
497
trace.note("All changes applied successfully.")
499
trace.note("%d conflicts encountered."
500
% len(merge.cooked_conflicts))
502
return len(merge.cooked_conflicts)
505
class _InventoryNoneEntry(object):
506
"""This represents an inventory entry which *isn't there*.
508
It simplifies the merging logic if we always have an InventoryEntry, even
509
if it isn't actually present
516
symlink_target = None
519
_none_entry = _InventoryNoneEntry()
522
class Merge3Merger(object):
523
"""Three-way merger that uses the merge3 text merger"""
525
supports_reprocess = True
526
supports_show_base = True
527
history_based = False
528
supports_cherrypick = True
529
supports_reverse_cherrypick = True
530
winner_idx = {"this": 2, "other": 1, "conflict": 1}
531
supports_lca_trees = True
533
def __init__(self, working_tree, this_tree, base_tree, other_tree,
534
interesting_ids=None, reprocess=False, show_base=False,
535
pb=progress.DummyProgress(), pp=None, change_reporter=None,
536
interesting_files=None, do_merge=True,
537
cherrypick=False, lca_trees=None):
538
"""Initialize the merger object and perform the merge.
540
:param working_tree: The working tree to apply the merge to
541
:param this_tree: The local tree in the merge operation
542
:param base_tree: The common tree in the merge operation
543
:param other_tree: The other tree to merge changes from
544
:param interesting_ids: The file_ids of files that should be
545
participate in the merge. May not be combined with
547
:param: reprocess If True, perform conflict-reduction processing.
548
:param show_base: If True, show the base revision in text conflicts.
549
(incompatible with reprocess)
550
:param pb: A Progress bar
551
:param pp: A ProgressPhase object
552
:param change_reporter: An object that should report changes made
553
:param interesting_files: The tree-relative paths of files that should
554
participate in the merge. If these paths refer to directories,
555
the contents of those directories will also be included. May not
556
be combined with interesting_ids. If neither interesting_files nor
557
interesting_ids is specified, all files may participate in the
559
:param lca_trees: Can be set to a dictionary of {revision_id:rev_tree}
560
if the ancestry was found to include a criss-cross merge.
561
Otherwise should be None.
563
object.__init__(self)
564
if interesting_files is not None and interesting_ids is not None:
566
'specify either interesting_ids or interesting_files')
567
self.interesting_ids = interesting_ids
568
self.interesting_files = interesting_files
569
self.this_tree = working_tree
570
self.base_tree = base_tree
571
self.other_tree = other_tree
572
self._raw_conflicts = []
573
self.cooked_conflicts = []
574
self.reprocess = reprocess
575
self.show_base = show_base
576
self._lca_trees = lca_trees
577
# Uncommenting this will change the default algorithm to always use
578
# _entries_lca. This can be useful for running the test suite and
579
# making sure we haven't missed any corner cases.
580
# if lca_trees is None:
581
# self._lca_trees = [self.base_tree]
584
self.change_reporter = change_reporter
585
self.cherrypick = cherrypick
587
self.pp = progress.ProgressPhase("Merge phase", 3, self.pb)
592
self.this_tree.lock_tree_write()
593
self.base_tree.lock_read()
594
self.other_tree.lock_read()
596
self.tt = transform.TreeTransform(self.this_tree, self.pb)
599
self._compute_transform()
601
results = self.tt.apply(no_conflicts=True)
602
self.write_modified(results)
604
self.this_tree.add_conflicts(self.cooked_conflicts)
605
except errors.UnsupportedOperation:
610
self.other_tree.unlock()
611
self.base_tree.unlock()
612
self.this_tree.unlock()
615
def make_preview_transform(self):
616
self.base_tree.lock_read()
617
self.other_tree.lock_read()
618
self.tt = transform.TransformPreview(self.this_tree)
621
self._compute_transform()
624
self.other_tree.unlock()
625
self.base_tree.unlock()
629
def _compute_transform(self):
630
if self._lca_trees is None:
631
entries = self._entries3()
632
resolver = self._three_way
634
entries = self._entries_lca()
635
resolver = self._lca_multi_way
636
child_pb = ui.ui_factory.nested_progress_bar()
638
for num, (file_id, changed, parents3, names3,
639
executable3) in enumerate(entries):
640
child_pb.update('Preparing file merge', num, len(entries))
641
self._merge_names(file_id, parents3, names3, resolver=resolver)
643
file_status = self.merge_contents(file_id)
645
file_status = 'unmodified'
646
self._merge_executable(file_id,
647
executable3, file_status, resolver=resolver)
652
child_pb = ui.ui_factory.nested_progress_bar()
654
fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
655
lambda t, c: transform.conflict_pass(t, c, self.other_tree))
658
if self.change_reporter is not None:
659
from bzrlib import delta
660
delta.report_changes(
661
self.tt.iter_changes(), self.change_reporter)
662
self.cook_conflicts(fs_conflicts)
663
for conflict in self.cooked_conflicts:
664
trace.warning(conflict)
667
"""Gather data about files modified between three trees.
669
Return a list of tuples of file_id, changed, parents3, names3,
670
executable3. changed is a boolean indicating whether the file contents
671
or kind were changed. parents3 is a tuple of parent ids for base,
672
other and this. names3 is a tuple of names for base, other and this.
673
executable3 is a tuple of execute-bit values for base, other and this.
676
iterator = self.other_tree.iter_changes(self.base_tree,
677
include_unchanged=True, specific_files=self.interesting_files,
678
extra_trees=[self.this_tree])
679
this_entries = dict((e.file_id, e) for p, e in
680
self.this_tree.iter_entries_by_dir(
681
self.interesting_ids))
682
for (file_id, paths, changed, versioned, parents, names, kind,
683
executable) in iterator:
684
if (self.interesting_ids is not None and
685
file_id not in self.interesting_ids):
687
entry = this_entries.get(file_id)
688
if entry is not None:
689
this_name = entry.name
690
this_parent = entry.parent_id
691
this_executable = entry.executable
695
this_executable = None
696
parents3 = parents + (this_parent,)
697
names3 = names + (this_name,)
698
executable3 = executable + (this_executable,)
699
result.append((file_id, changed, parents3, names3, executable3))
702
def _entries_lca(self):
703
"""Gather data about files modified between multiple trees.
705
This compares OTHER versus all LCA trees, and for interesting entries,
706
it then compares with THIS and BASE.
708
For the multi-valued entries, the format will be (BASE, [lca1, lca2])
709
:return: [(file_id, changed, parents, names, executable)]
710
file_id Simple file_id of the entry
711
changed Boolean, True if the kind or contents changed
713
parents ((base, [parent_id, in, lcas]), parent_id_other,
715
names ((base, [name, in, lcas]), name_in_other, name_in_this)
716
executable ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
718
if self.interesting_files is not None:
719
lookup_trees = [self.this_tree, self.base_tree]
720
lookup_trees.extend(self._lca_trees)
721
# I think we should include the lca trees as well
722
interesting_ids = self.other_tree.paths2ids(self.interesting_files,
725
interesting_ids = self.interesting_ids
727
walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
729
base_inventory = self.base_tree.inventory
730
this_inventory = self.this_tree.inventory
731
for path, file_id, other_ie, lca_values in walker.iter_all():
732
# Is this modified at all from any of the other trees?
734
other_ie = _none_entry
735
if interesting_ids is not None and file_id not in interesting_ids:
738
# If other_revision is found in any of the lcas, that means this
739
# node is uninteresting. This is because when merging, if there are
740
# multiple heads(), we have to create a new node. So if we didn't,
741
# we know that the ancestry is linear, and that OTHER did not
743
# See doc/developers/lca_merge_resolution.txt for details
744
other_revision = other_ie.revision
745
if other_revision is not None:
746
# We can't use this shortcut when other_revision is None,
747
# because it may be None because things are WorkingTrees, and
748
# not because it is *actually* None.
749
is_unmodified = False
750
for lca_path, ie in lca_values:
751
if ie is not None and ie.revision == other_revision:
758
for lca_path, lca_ie in lca_values:
760
lca_entries.append(_none_entry)
762
lca_entries.append(lca_ie)
764
if file_id in base_inventory:
765
base_ie = base_inventory[file_id]
767
base_ie = _none_entry
769
if file_id in this_inventory:
770
this_ie = this_inventory[file_id]
772
this_ie = _none_entry
778
for lca_ie in lca_entries:
779
lca_kinds.append(lca_ie.kind)
780
lca_parent_ids.append(lca_ie.parent_id)
781
lca_names.append(lca_ie.name)
782
lca_executable.append(lca_ie.executable)
784
kind_winner = self._lca_multi_way(
785
(base_ie.kind, lca_kinds),
786
other_ie.kind, this_ie.kind)
787
parent_id_winner = self._lca_multi_way(
788
(base_ie.parent_id, lca_parent_ids),
789
other_ie.parent_id, this_ie.parent_id)
790
name_winner = self._lca_multi_way(
791
(base_ie.name, lca_names),
792
other_ie.name, this_ie.name)
794
content_changed = True
795
if kind_winner == 'this':
796
# No kind change in OTHER, see if there are *any* changes
797
if other_ie.kind == 'directory':
798
if parent_id_winner == 'this' and name_winner == 'this':
799
# No change for this directory in OTHER, skip
801
content_changed = False
802
elif other_ie.kind is None or other_ie.kind == 'file':
803
def get_sha1(ie, tree):
804
if ie.kind != 'file':
806
return tree.get_file_sha1(file_id)
807
base_sha1 = get_sha1(base_ie, self.base_tree)
808
lca_sha1s = [get_sha1(ie, tree) for ie, tree
809
in zip(lca_entries, self._lca_trees)]
810
this_sha1 = get_sha1(this_ie, self.this_tree)
811
other_sha1 = get_sha1(other_ie, self.other_tree)
812
sha1_winner = self._lca_multi_way(
813
(base_sha1, lca_sha1s), other_sha1, this_sha1,
814
allow_overriding_lca=False)
815
exec_winner = self._lca_multi_way(
816
(base_ie.executable, lca_executable),
817
other_ie.executable, this_ie.executable)
818
if (parent_id_winner == 'this' and name_winner == 'this'
819
and sha1_winner == 'this' and exec_winner == 'this'):
820
# No kind, parent, name, exec, or content change for
821
# OTHER, so this node is not considered interesting
823
if sha1_winner == 'this':
824
content_changed = False
825
elif other_ie.kind == 'symlink':
826
def get_target(ie, tree):
827
if ie.kind != 'symlink':
829
return tree.get_symlink_target(file_id)
830
base_target = get_target(base_ie, self.base_tree)
831
lca_targets = [get_target(ie, tree) for ie, tree
832
in zip(lca_entries, self._lca_trees)]
833
this_target = get_target(this_ie, self.this_tree)
834
other_target = get_target(other_ie, self.other_tree)
835
target_winner = self._lca_multi_way(
836
(base_target, lca_targets),
837
other_target, this_target)
838
if (parent_id_winner == 'this' and name_winner == 'this'
839
and target_winner == 'this'):
840
# No kind, parent, name, or symlink target change
843
if target_winner == 'this':
844
content_changed = False
845
elif other_ie.kind == 'tree-reference':
846
# The 'changed' information seems to be handled at a higher
847
# level. At least, _entries3 returns False for content
848
# changed, even when at a new revision_id.
849
content_changed = False
850
if (parent_id_winner == 'this' and name_winner == 'this'):
851
# Nothing interesting
854
raise AssertionError('unhandled kind: %s' % other_ie.kind)
855
# XXX: We need to handle kind == 'symlink'
857
# If we have gotten this far, that means something has changed
858
result.append((file_id, content_changed,
859
((base_ie.parent_id, lca_parent_ids),
860
other_ie.parent_id, this_ie.parent_id),
861
((base_ie.name, lca_names),
862
other_ie.name, this_ie.name),
863
((base_ie.executable, lca_executable),
864
other_ie.executable, this_ie.executable)
871
self.tt.final_kind(self.tt.root)
872
except errors.NoSuchFile:
873
self.tt.cancel_deletion(self.tt.root)
874
if self.tt.final_file_id(self.tt.root) is None:
875
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
877
other_root_file_id = self.other_tree.get_root_id()
878
if other_root_file_id is None:
880
other_root = self.tt.trans_id_file_id(other_root_file_id)
881
if other_root == self.tt.root:
884
self.tt.final_kind(other_root)
885
except errors.NoSuchFile:
887
if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
888
# the other tree's root is a non-root in the current tree
890
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
891
self.tt.cancel_creation(other_root)
892
self.tt.cancel_versioning(other_root)
894
def reparent_children(self, ie, target):
895
for thing, child in ie.children.iteritems():
896
trans_id = self.tt.trans_id_file_id(child.file_id)
897
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
899
def write_modified(self, results):
901
for path in results.modified_paths:
902
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
905
hash = self.this_tree.get_file_sha1(file_id)
908
modified_hashes[file_id] = hash
909
self.this_tree.set_merge_modified(modified_hashes)
912
def parent(entry, file_id):
913
"""Determine the parent for a file_id (used as a key method)"""
916
return entry.parent_id
919
def name(entry, file_id):
920
"""Determine the name for a file_id (used as a key method)"""
926
def contents_sha1(tree, file_id):
927
"""Determine the sha1 of the file contents (used as a key method)."""
928
if file_id not in tree:
930
return tree.get_file_sha1(file_id)
933
def executable(tree, file_id):
934
"""Determine the executability of a file-id (used as a key method)."""
935
if file_id not in tree:
937
if tree.kind(file_id) != "file":
939
return tree.is_executable(file_id)
942
def kind(tree, file_id):
943
"""Determine the kind of a file-id (used as a key method)."""
944
if file_id not in tree:
946
return tree.kind(file_id)
949
def _three_way(base, other, this):
950
#if base == other, either they all agree, or only THIS has changed.
953
elif this not in (base, other):
955
# "Ambiguous clean merge" -- both sides have made the same change.
958
# this == base: only other has changed.
963
def _lca_multi_way(bases, other, this, allow_overriding_lca=True):
964
"""Consider LCAs when determining whether a change has occurred.
966
If LCAS are all identical, this is the same as a _three_way comparison.
968
:param bases: value in (BASE, [LCAS])
969
:param other: value in OTHER
970
:param this: value in THIS
971
:param allow_overriding_lca: If there is more than one unique lca
972
value, allow OTHER to override THIS if it has a new value, and
973
THIS only has an lca value, or vice versa. This is appropriate for
974
truly scalar values, not as much for non-scalars.
975
:return: 'this', 'other', or 'conflict' depending on whether an entry
978
# See doc/developers/lca_tree_merging.txt for details about this
981
# Either Ambiguously clean, or nothing was actually changed. We
984
base_val, lca_vals = bases
985
# Remove 'base_val' from the lca_vals, because it is not interesting
986
filtered_lca_vals = [lca_val for lca_val in lca_vals
987
if lca_val != base_val]
988
if len(filtered_lca_vals) == 0:
989
return Merge3Merger._three_way(base_val, other, this)
991
unique_lca_vals = set(filtered_lca_vals)
992
if len(unique_lca_vals) == 1:
993
return Merge3Merger._three_way(unique_lca_vals.pop(), other, this)
995
if allow_overriding_lca:
996
if other in unique_lca_vals:
997
if this in unique_lca_vals:
998
# Each side picked a different lca, conflict
1001
# This has a value which supersedes both lca values, and
1002
# other only has an lca value
1004
elif this in unique_lca_vals:
1005
# OTHER has a value which supersedes both lca values, and this
1006
# only has an lca value
1009
# At this point, the lcas disagree, and the tips disagree
1013
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
1014
"""Do a three-way test on a scalar.
1015
Return "this", "other" or "conflict", depending whether a value wins.
1017
key_base = key(base_tree, file_id)
1018
key_other = key(other_tree, file_id)
1019
#if base == other, either they all agree, or only THIS has changed.
1020
if key_base == key_other:
1022
key_this = key(this_tree, file_id)
1023
# "Ambiguous clean merge"
1024
if key_this == key_other:
1026
elif key_this == key_base:
1031
def merge_names(self, file_id):
1032
def get_entry(tree):
1033
if file_id in tree.inventory:
1034
return tree.inventory[file_id]
1037
this_entry = get_entry(self.this_tree)
1038
other_entry = get_entry(self.other_tree)
1039
base_entry = get_entry(self.base_tree)
1040
entries = (base_entry, other_entry, this_entry)
1043
for entry in entries:
1046
parents.append(None)
1048
names.append(entry.name)
1049
parents.append(entry.parent_id)
1050
return self._merge_names(file_id, parents, names,
1051
resolver=self._three_way)
1053
def _merge_names(self, file_id, parents, names, resolver):
1054
"""Perform a merge on file_id names and parents"""
1055
base_name, other_name, this_name = names
1056
base_parent, other_parent, this_parent = parents
1058
name_winner = resolver(*names)
1060
parent_id_winner = resolver(*parents)
1061
if this_name is None:
1062
if name_winner == "this":
1063
name_winner = "other"
1064
if parent_id_winner == "this":
1065
parent_id_winner = "other"
1066
if name_winner == "this" and parent_id_winner == "this":
1068
if name_winner == "conflict":
1069
trans_id = self.tt.trans_id_file_id(file_id)
1070
self._raw_conflicts.append(('name conflict', trans_id,
1071
this_name, other_name))
1072
if parent_id_winner == "conflict":
1073
trans_id = self.tt.trans_id_file_id(file_id)
1074
self._raw_conflicts.append(('parent conflict', trans_id,
1075
this_parent, other_parent))
1076
if other_name is None:
1077
# it doesn't matter whether the result was 'other' or
1078
# 'conflict'-- if there's no 'other', we leave it alone.
1080
# if we get here, name_winner and parent_winner are set to safe values.
1081
trans_id = self.tt.trans_id_file_id(file_id)
1082
parent_id = parents[self.winner_idx[parent_id_winner]]
1083
if parent_id is not None:
1084
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1085
self.tt.adjust_path(names[self.winner_idx[name_winner]],
1086
parent_trans_id, trans_id)
1088
def merge_contents(self, file_id):
1089
"""Performs a merge on file_id contents."""
1090
def contents_pair(tree):
1091
if file_id not in tree:
1093
kind = tree.kind(file_id)
1095
contents = tree.get_file_sha1(file_id)
1096
elif kind == "symlink":
1097
contents = tree.get_symlink_target(file_id)
1100
return kind, contents
1102
def contents_conflict():
1103
trans_id = self.tt.trans_id_file_id(file_id)
1104
name = self.tt.final_name(trans_id)
1105
parent_id = self.tt.final_parent(trans_id)
1106
if file_id in self.this_tree.inventory:
1107
self.tt.unversion_file(trans_id)
1108
if file_id in self.this_tree:
1109
self.tt.delete_contents(trans_id)
1110
file_group = self._dump_conflicts(name, parent_id, file_id,
1112
self._raw_conflicts.append(('contents conflict', file_group))
1114
# See SPOT run. run, SPOT, run.
1115
# So we're not QUITE repeating ourselves; we do tricky things with
1117
base_pair = contents_pair(self.base_tree)
1118
other_pair = contents_pair(self.other_tree)
1120
this_pair = contents_pair(self.this_tree)
1121
lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1122
winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1123
this_pair, allow_overriding_lca=False)
1125
if base_pair == other_pair:
1128
# We delayed evaluating this_pair as long as we can to avoid
1129
# unnecessary sha1 calculation
1130
this_pair = contents_pair(self.this_tree)
1131
winner = self._three_way(base_pair, other_pair, this_pair)
1132
if winner == 'this':
1133
# No interesting changes introduced by OTHER
1135
trans_id = self.tt.trans_id_file_id(file_id)
1136
if winner == 'other':
1137
# OTHER is a straight winner, so replace this contents with other
1138
file_in_this = file_id in self.this_tree
1140
# Remove any existing contents
1141
self.tt.delete_contents(trans_id)
1142
if file_id in self.other_tree:
1143
# OTHER changed the file
1144
transform.create_from_tree(self.tt, trans_id,
1145
self.other_tree, file_id)
1146
if not file_in_this:
1147
self.tt.version_file(file_id, trans_id)
1150
# OTHER deleted the file
1151
self.tt.unversion_file(trans_id)
1154
# We have a hypothetical conflict, but if we have files, then we
1155
# can try to merge the content
1156
if this_pair[0] == 'file' and other_pair[0] == 'file':
1157
# THIS and OTHER are both files, so text merge. Either
1158
# BASE is a file, or both converted to files, so at least we
1159
# have agreement that output should be a file.
1161
self.text_merge(file_id, trans_id)
1162
except errors.BinaryFile:
1163
return contents_conflict()
1164
if file_id not in self.this_tree:
1165
self.tt.version_file(file_id, trans_id)
1167
self.tt.tree_kind(trans_id)
1168
self.tt.delete_contents(trans_id)
1169
except errors.NoSuchFile:
1173
return contents_conflict()
1175
def get_lines(self, tree, file_id):
1176
"""Return the lines in a file, or an empty list."""
1178
return tree.get_file(file_id).readlines()
1182
def text_merge(self, file_id, trans_id):
1183
"""Perform a three-way text merge on a file_id"""
1184
# it's possible that we got here with base as a different type.
1185
# if so, we just want two-way text conflicts.
1186
if file_id in self.base_tree and \
1187
self.base_tree.kind(file_id) == "file":
1188
base_lines = self.get_lines(self.base_tree, file_id)
1191
other_lines = self.get_lines(self.other_tree, file_id)
1192
this_lines = self.get_lines(self.this_tree, file_id)
1193
m3 = merge3.Merge3(base_lines, this_lines, other_lines,
1194
is_cherrypick=self.cherrypick)
1195
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
1196
if self.show_base is True:
1197
base_marker = '|' * 7
1201
def iter_merge3(retval):
1202
retval["text_conflicts"] = False
1203
for line in m3.merge_lines(name_a = "TREE",
1204
name_b = "MERGE-SOURCE",
1205
name_base = "BASE-REVISION",
1206
start_marker=start_marker,
1207
base_marker=base_marker,
1208
reprocess=self.reprocess):
1209
if line.startswith(start_marker):
1210
retval["text_conflicts"] = True
1211
yield line.replace(start_marker, '<' * 7)
1215
merge3_iterator = iter_merge3(retval)
1216
self.tt.create_file(merge3_iterator, trans_id)
1217
if retval["text_conflicts"] is True:
1218
self._raw_conflicts.append(('text conflict', trans_id))
1219
name = self.tt.final_name(trans_id)
1220
parent_id = self.tt.final_parent(trans_id)
1221
file_group = self._dump_conflicts(name, parent_id, file_id,
1222
this_lines, base_lines,
1224
file_group.append(trans_id)
1226
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
1227
base_lines=None, other_lines=None, set_version=False,
1229
"""Emit conflict files.
1230
If this_lines, base_lines, or other_lines are omitted, they will be
1231
determined automatically. If set_version is true, the .OTHER, .THIS
1232
or .BASE (in that order) will be created as versioned files.
1234
data = [('OTHER', self.other_tree, other_lines),
1235
('THIS', self.this_tree, this_lines)]
1237
data.append(('BASE', self.base_tree, base_lines))
1240
for suffix, tree, lines in data:
1242
trans_id = self._conflict_file(name, parent_id, tree, file_id,
1244
file_group.append(trans_id)
1245
if set_version and not versioned:
1246
self.tt.version_file(file_id, trans_id)
1250
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1252
"""Emit a single conflict file."""
1253
name = name + '.' + suffix
1254
trans_id = self.tt.create_path(name, parent_id)
1255
transform.create_from_tree(self.tt, trans_id, tree, file_id, lines)
1258
def merge_executable(self, file_id, file_status):
1259
"""Perform a merge on the execute bit."""
1260
executable = [self.executable(t, file_id) for t in (self.base_tree,
1261
self.other_tree, self.this_tree)]
1262
self._merge_executable(file_id, executable, file_status,
1263
resolver=self._three_way)
1265
def _merge_executable(self, file_id, executable, file_status,
1267
"""Perform a merge on the execute bit."""
1268
base_executable, other_executable, this_executable = executable
1269
if file_status == "deleted":
1271
winner = resolver(*executable)
1272
if winner == "conflict":
1273
# There must be a None in here, if we have a conflict, but we
1274
# need executability since file status was not deleted.
1275
if self.executable(self.other_tree, file_id) is None:
1279
if winner == 'this' and file_status != "modified":
1281
trans_id = self.tt.trans_id_file_id(file_id)
1283
if self.tt.final_kind(trans_id) != "file":
1285
except errors.NoSuchFile:
1287
if winner == "this":
1288
executability = this_executable
1290
if file_id in self.other_tree:
1291
executability = other_executable
1292
elif file_id in self.this_tree:
1293
executability = this_executable
1294
elif file_id in self.base_tree:
1295
executability = base_executable
1296
if executability is not None:
1297
trans_id = self.tt.trans_id_file_id(file_id)
1298
self.tt.set_executability(executability, trans_id)
1300
def cook_conflicts(self, fs_conflicts):
1301
"""Convert all conflicts into a form that doesn't depend on trans_id"""
1303
self.cooked_conflicts.extend(transform.cook_conflicts(
1304
fs_conflicts, self.tt))
1305
fp = transform.FinalPaths(self.tt)
1306
for conflict in self._raw_conflicts:
1307
conflict_type = conflict[0]
1308
if conflict_type in ('name conflict', 'parent conflict'):
1309
trans_id = conflict[1]
1310
conflict_args = conflict[2:]
1311
if trans_id not in name_conflicts:
1312
name_conflicts[trans_id] = {}
1313
transform.unique_add(name_conflicts[trans_id], conflict_type,
1315
if conflict_type == 'contents conflict':
1316
for trans_id in conflict[1]:
1317
file_id = self.tt.final_file_id(trans_id)
1318
if file_id is not None:
1320
path = fp.get_path(trans_id)
1321
for suffix in ('.BASE', '.THIS', '.OTHER'):
1322
if path.endswith(suffix):
1323
path = path[:-len(suffix)]
1325
c = _mod_conflicts.Conflict.factory(conflict_type,
1326
path=path, file_id=file_id)
1327
self.cooked_conflicts.append(c)
1328
if conflict_type == 'text conflict':
1329
trans_id = conflict[1]
1330
path = fp.get_path(trans_id)
1331
file_id = self.tt.final_file_id(trans_id)
1332
c = _mod_conflicts.Conflict.factory(conflict_type,
1333
path=path, file_id=file_id)
1334
self.cooked_conflicts.append(c)
1336
for trans_id, conflicts in name_conflicts.iteritems():
1338
this_parent, other_parent = conflicts['parent conflict']
1339
if this_parent == other_parent:
1340
raise AssertionError()
1342
this_parent = other_parent = \
1343
self.tt.final_file_id(self.tt.final_parent(trans_id))
1345
this_name, other_name = conflicts['name conflict']
1346
if this_name == other_name:
1347
raise AssertionError()
1349
this_name = other_name = self.tt.final_name(trans_id)
1350
other_path = fp.get_path(trans_id)
1351
if this_parent is not None and this_name is not None:
1352
this_parent_path = \
1353
fp.get_path(self.tt.trans_id_file_id(this_parent))
1354
this_path = osutils.pathjoin(this_parent_path, this_name)
1356
this_path = "<deleted>"
1357
file_id = self.tt.final_file_id(trans_id)
1358
c = _mod_conflicts.Conflict.factory('path conflict', path=this_path,
1359
conflict_path=other_path,
1361
self.cooked_conflicts.append(c)
1362
self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1365
class WeaveMerger(Merge3Merger):
1366
"""Three-way tree merger, text weave merger."""
1367
supports_reprocess = True
1368
supports_show_base = False
1369
supports_reverse_cherrypick = False
1370
history_based = True
1372
def _merged_lines(self, file_id):
1373
"""Generate the merged lines.
1374
There is no distinction between lines that are meant to contain <<<<<<<
1378
base = self.base_tree
1381
plan = self.this_tree.plan_file_merge(file_id, self.other_tree,
1383
if 'merge' in debug.debug_flags:
1385
trans_id = self.tt.trans_id_file_id(file_id)
1386
name = self.tt.final_name(trans_id) + '.plan'
1387
contents = ('%10s|%s' % l for l in plan)
1388
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1389
textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1390
'>>>>>>> MERGE-SOURCE\n')
1391
return textmerge.merge_lines(self.reprocess)
1393
def text_merge(self, file_id, trans_id):
1394
"""Perform a (weave) text merge for a given file and file-id.
1395
If conflicts are encountered, .THIS and .OTHER files will be emitted,
1396
and a conflict will be noted.
1398
lines, conflicts = self._merged_lines(file_id)
1400
# Note we're checking whether the OUTPUT is binary in this case,
1401
# because we don't want to get into weave merge guts.
1402
textfile.check_text_lines(lines)
1403
self.tt.create_file(lines, trans_id)
1405
self._raw_conflicts.append(('text conflict', trans_id))
1406
name = self.tt.final_name(trans_id)
1407
parent_id = self.tt.final_parent(trans_id)
1408
file_group = self._dump_conflicts(name, parent_id, file_id,
1410
file_group.append(trans_id)
1413
class LCAMerger(WeaveMerger):
1415
def _merged_lines(self, file_id):
1416
"""Generate the merged lines.
1417
There is no distinction between lines that are meant to contain <<<<<<<
1421
base = self.base_tree
1424
plan = self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1426
if 'merge' in debug.debug_flags:
1428
trans_id = self.tt.trans_id_file_id(file_id)
1429
name = self.tt.final_name(trans_id) + '.plan'
1430
contents = ('%10s|%s' % l for l in plan)
1431
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1432
textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1433
'>>>>>>> MERGE-SOURCE\n')
1434
return textmerge.merge_lines(self.reprocess)
1437
class Diff3Merger(Merge3Merger):
1438
"""Three-way merger using external diff3 for text merging"""
1440
def dump_file(self, temp_dir, name, tree, file_id):
1441
out_path = osutils.pathjoin(temp_dir, name)
1442
out_file = open(out_path, "wb")
1444
in_file = tree.get_file(file_id)
1445
for line in in_file:
1446
out_file.write(line)
1451
def text_merge(self, file_id, trans_id):
1452
"""Perform a diff3 merge using a specified file-id and trans-id.
1453
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
1454
will be dumped, and a will be conflict noted.
1457
temp_dir = osutils.mkdtemp(prefix="bzr-")
1459
new_file = osutils.pathjoin(temp_dir, "new")
1460
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
1461
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
1462
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
1463
status = bzrlib.patch.diff3(new_file, this, base, other)
1464
if status not in (0, 1):
1465
raise errors.BzrError("Unhandled diff3 exit code")
1466
f = open(new_file, 'rb')
1468
self.tt.create_file(f, trans_id)
1472
name = self.tt.final_name(trans_id)
1473
parent_id = self.tt.final_parent(trans_id)
1474
self._dump_conflicts(name, parent_id, file_id)
1475
self._raw_conflicts.append(('text conflict', trans_id))
1477
osutils.rmtree(temp_dir)
1480
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1482
merge_type=Merge3Merger,
1483
interesting_ids=None,
1487
interesting_files=None,
1489
pb=progress.DummyProgress(),
1490
change_reporter=None):
1491
"""Primary interface for merging.
1493
typical use is probably
1494
'merge_inner(branch, branch.get_revision_tree(other_revision),
1495
branch.get_revision_tree(base_revision))'
1497
if this_tree is None:
1498
raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
1499
"parameter as of bzrlib version 0.8.")
1500
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1501
pb=pb, change_reporter=change_reporter)
1502
merger.backup_files = backup_files
1503
merger.merge_type = merge_type
1504
merger.interesting_ids = interesting_ids
1505
merger.ignore_zero = ignore_zero
1506
if interesting_files:
1508
raise ValueError('Only supply interesting_ids'
1509
' or interesting_files')
1510
merger.interesting_files = interesting_files
1511
merger.show_base = show_base
1512
merger.reprocess = reprocess
1513
merger.other_rev_id = other_rev_id
1514
merger.other_basis = other_rev_id
1515
get_revision_id = getattr(base_tree, 'get_revision_id', None)
1516
if get_revision_id is None:
1517
get_revision_id = base_tree.last_revision
1518
merger.cache_trees_with_revision_ids([other_tree, base_tree, this_tree])
1519
merger.set_base_revision(get_revision_id(), this_branch)
1520
return merger.do_merge()
1522
def get_merge_type_registry():
1523
"""Merge type registry is in bzrlib.option to avoid circular imports.
1525
This method provides a sanctioned way to retrieve it.
1527
from bzrlib import option
1528
return option._merge_type_registry
1531
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
1532
def status_a(revision, text):
1533
if revision in ancestors_b:
1534
return 'killed-b', text
1536
return 'new-a', text
1538
def status_b(revision, text):
1539
if revision in ancestors_a:
1540
return 'killed-a', text
1542
return 'new-b', text
1544
plain_a = [t for (a, t) in annotated_a]
1545
plain_b = [t for (a, t) in annotated_b]
1546
matcher = patiencediff.PatienceSequenceMatcher(None, plain_a, plain_b)
1547
blocks = matcher.get_matching_blocks()
1550
for ai, bi, l in blocks:
1551
# process all mismatched sections
1552
# (last mismatched section is handled because blocks always
1553
# includes a 0-length last block)
1554
for revision, text in annotated_a[a_cur:ai]:
1555
yield status_a(revision, text)
1556
for revision, text in annotated_b[b_cur:bi]:
1557
yield status_b(revision, text)
1558
# and now the matched section
1561
for text_a in plain_a[ai:a_cur]:
1562
yield "unchanged", text_a
1565
class _PlanMergeBase(object):
1567
def __init__(self, a_rev, b_rev, vf, key_prefix):
1570
:param a_rev: Revision-id of one revision to merge
1571
:param b_rev: Revision-id of the other revision to merge
1572
:param vf: A VersionedFiles containing both revisions
1573
:param key_prefix: A prefix for accessing keys in vf, typically
1579
self._last_lines = None
1580
self._last_lines_revision_id = None
1581
self._cached_matching_blocks = {}
1582
self._key_prefix = key_prefix
1583
self._precache_tip_lines()
1585
def _precache_tip_lines(self):
1586
lines = self.get_lines([self.a_rev, self.b_rev])
1587
self.lines_a = lines[self.a_rev]
1588
self.lines_b = lines[self.b_rev]
1590
def get_lines(self, revisions):
1591
"""Get lines for revisions from the backing VersionedFiles.
1593
:raises RevisionNotPresent: on absent texts.
1595
keys = [(self._key_prefix + (rev,)) for rev in revisions]
1597
for record in self.vf.get_record_stream(keys, 'unordered', True):
1598
if record.storage_kind == 'absent':
1599
raise errors.RevisionNotPresent(record.key, self.vf)
1600
result[record.key[-1]] = osutils.chunks_to_lines(
1601
record.get_bytes_as('chunked'))
1604
def plan_merge(self):
1605
"""Generate a 'plan' for merging the two revisions.
1607
This involves comparing their texts and determining the cause of
1608
differences. If text A has a line and text B does not, then either the
1609
line was added to text A, or it was deleted from B. Once the causes
1610
are combined, they are written out in the format described in
1611
VersionedFile.plan_merge
1613
blocks = self._get_matching_blocks(self.a_rev, self.b_rev)
1614
unique_a, unique_b = self._unique_lines(blocks)
1615
new_a, killed_b = self._determine_status(self.a_rev, unique_a)
1616
new_b, killed_a = self._determine_status(self.b_rev, unique_b)
1617
return self._iter_plan(blocks, new_a, killed_b, new_b, killed_a)
1619
def _iter_plan(self, blocks, new_a, killed_b, new_b, killed_a):
1622
for i, j, n in blocks:
1623
for a_index in range(last_i, i):
1624
if a_index in new_a:
1625
if a_index in killed_b:
1626
yield 'conflicted-a', self.lines_a[a_index]
1628
yield 'new-a', self.lines_a[a_index]
1630
yield 'killed-b', self.lines_a[a_index]
1631
for b_index in range(last_j, j):
1632
if b_index in new_b:
1633
if b_index in killed_a:
1634
yield 'conflicted-b', self.lines_b[b_index]
1636
yield 'new-b', self.lines_b[b_index]
1638
yield 'killed-a', self.lines_b[b_index]
1639
# handle common lines
1640
for a_index in range(i, i+n):
1641
yield 'unchanged', self.lines_a[a_index]
1645
def _get_matching_blocks(self, left_revision, right_revision):
1646
"""Return a description of which sections of two revisions match.
1648
See SequenceMatcher.get_matching_blocks
1650
cached = self._cached_matching_blocks.get((left_revision,
1652
if cached is not None:
1654
if self._last_lines_revision_id == left_revision:
1655
left_lines = self._last_lines
1656
right_lines = self.get_lines([right_revision])[right_revision]
1658
lines = self.get_lines([left_revision, right_revision])
1659
left_lines = lines[left_revision]
1660
right_lines = lines[right_revision]
1661
self._last_lines = right_lines
1662
self._last_lines_revision_id = right_revision
1663
matcher = patiencediff.PatienceSequenceMatcher(None, left_lines,
1665
return matcher.get_matching_blocks()
1667
def _unique_lines(self, matching_blocks):
1668
"""Analyse matching_blocks to determine which lines are unique
1670
:return: a tuple of (unique_left, unique_right), where the values are
1671
sets of line numbers of unique lines.
1677
for i, j, n in matching_blocks:
1678
unique_left.extend(range(last_i, i))
1679
unique_right.extend(range(last_j, j))
1682
return unique_left, unique_right
1685
def _subtract_plans(old_plan, new_plan):
1686
"""Remove changes from new_plan that came from old_plan.
1688
It is assumed that the difference between the old_plan and new_plan
1689
is their choice of 'b' text.
1691
All lines from new_plan that differ from old_plan are emitted
1692
verbatim. All lines from new_plan that match old_plan but are
1693
not about the 'b' revision are emitted verbatim.
1695
Lines that match and are about the 'b' revision are the lines we
1696
don't want, so we convert 'killed-b' -> 'unchanged', and 'new-b'
1697
is skipped entirely.
1699
matcher = patiencediff.PatienceSequenceMatcher(None, old_plan,
1702
for i, j, n in matcher.get_matching_blocks():
1703
for jj in range(last_j, j):
1705
for jj in range(j, j+n):
1706
plan_line = new_plan[jj]
1707
if plan_line[0] == 'new-b':
1709
elif plan_line[0] == 'killed-b':
1710
yield 'unchanged', plan_line[1]
1716
class _PlanMerge(_PlanMergeBase):
1717
"""Plan an annotate merge using on-the-fly annotation"""
1719
def __init__(self, a_rev, b_rev, vf, key_prefix):
1720
super(_PlanMerge, self).__init__(a_rev, b_rev, vf, key_prefix)
1721
self.a_key = self._key_prefix + (self.a_rev,)
1722
self.b_key = self._key_prefix + (self.b_rev,)
1723
self.graph = _mod_graph.Graph(self.vf)
1724
heads = self.graph.heads((self.a_key, self.b_key))
1726
# one side dominates, so we can just return its values, yay for
1728
# Ideally we would know that before we get this far
1729
self._head_key = heads.pop()
1730
if self._head_key == self.a_key:
1734
trace.mutter('found dominating revision for %s\n%s > %s', self.vf,
1735
self._head_key[-1], other)
1738
self._head_key = None
1741
def _precache_tip_lines(self):
1742
# Turn this into a no-op, because we will do this later
1745
def _find_recursive_lcas(self):
1746
"""Find all the ancestors back to a unique lca"""
1747
cur_ancestors = (self.a_key, self.b_key)
1748
# graph.find_lca(uncommon, keys) now returns plain NULL_REVISION,
1749
# rather than a key tuple. We will just map that directly to no common
1753
next_lcas = self.graph.find_lca(*cur_ancestors)
1754
# Map a plain NULL_REVISION to a simple no-ancestors
1755
if next_lcas == set([_mod_revision.NULL_REVISION]):
1757
# Order the lca's based on when they were merged into the tip
1758
# While the actual merge portion of weave merge uses a set() of
1759
# active revisions, the order of insertion *does* effect the
1760
# implicit ordering of the texts.
1761
for rev_key in cur_ancestors:
1762
ordered_parents = tuple(self.graph.find_merge_order(rev_key,
1764
parent_map[rev_key] = ordered_parents
1765
if len(next_lcas) == 0:
1767
elif len(next_lcas) == 1:
1768
parent_map[list(next_lcas)[0]] = ()
1770
elif len(next_lcas) > 2:
1771
# More than 2 lca's, fall back to grabbing all nodes between
1772
# this and the unique lca.
1773
trace.mutter('More than 2 LCAs, falling back to all nodes for:'
1775
self.a_key, self.b_key, cur_ancestors)
1776
cur_lcas = next_lcas
1777
while len(cur_lcas) > 1:
1778
cur_lcas = self.graph.find_lca(*cur_lcas)
1779
if len(cur_lcas) == 0:
1780
# No common base to find, use the full ancestry
1783
unique_lca = list(cur_lcas)[0]
1784
if unique_lca == _mod_revision.NULL_REVISION:
1785
# find_lca will return a plain 'NULL_REVISION' rather
1786
# than a key tuple when there is no common ancestor, we
1787
# prefer to just use None, because it doesn't confuse
1788
# _get_interesting_texts()
1790
parent_map.update(self._find_unique_parents(next_lcas,
1793
cur_ancestors = next_lcas
1796
def _find_unique_parents(self, tip_keys, base_key):
1797
"""Find ancestors of tip that aren't ancestors of base.
1799
:param tip_keys: Nodes that are interesting
1800
:param base_key: Cull all ancestors of this node
1801
:return: The parent map for all revisions between tip_keys and
1802
base_key. base_key will be included. References to nodes outside of
1803
the ancestor set will also be removed.
1805
# TODO: this would be simpler if find_unique_ancestors took a list
1806
# instead of a single tip, internally it supports it, but it
1807
# isn't a "backwards compatible" api change.
1808
if base_key is None:
1809
parent_map = dict(self.graph.iter_ancestry(tip_keys))
1810
# We remove NULL_REVISION because it isn't a proper tuple key, and
1811
# thus confuses things like _get_interesting_texts, and our logic
1812
# to add the texts into the memory weave.
1813
if _mod_revision.NULL_REVISION in parent_map:
1814
parent_map.pop(_mod_revision.NULL_REVISION)
1817
for tip in tip_keys:
1819
self.graph.find_unique_ancestors(tip, [base_key]))
1820
parent_map = self.graph.get_parent_map(interesting)
1821
parent_map[base_key] = ()
1822
culled_parent_map, child_map, tails = self._remove_external_references(
1824
# Remove all the tails but base_key
1825
if base_key is not None:
1826
tails.remove(base_key)
1827
self._prune_tails(culled_parent_map, child_map, tails)
1828
# Now remove all the uninteresting 'linear' regions
1829
simple_map = _mod_graph.collapse_linear_regions(culled_parent_map)
1833
def _remove_external_references(parent_map):
1834
"""Remove references that go outside of the parent map.
1836
:param parent_map: Something returned from Graph.get_parent_map(keys)
1837
:return: (filtered_parent_map, child_map, tails)
1838
filtered_parent_map is parent_map without external references
1839
child_map is the {parent_key: [child_keys]} mapping
1840
tails is a list of nodes that do not have any parents in the map
1842
# TODO: The basic effect of this function seems more generic than
1843
# _PlanMerge. But the specific details of building a child_map,
1844
# and computing tails seems very specific to _PlanMerge.
1845
# Still, should this be in Graph land?
1846
filtered_parent_map = {}
1849
for key, parent_keys in parent_map.iteritems():
1850
culled_parent_keys = [p for p in parent_keys if p in parent_map]
1851
if not culled_parent_keys:
1853
for parent_key in culled_parent_keys:
1854
child_map.setdefault(parent_key, []).append(key)
1855
# TODO: Do we want to do this, it adds overhead for every node,
1856
# just to say that the node has no children
1857
child_map.setdefault(key, [])
1858
filtered_parent_map[key] = culled_parent_keys
1859
return filtered_parent_map, child_map, tails
1862
def _prune_tails(parent_map, child_map, tails_to_remove):
1863
"""Remove tails from the parent map.
1865
This will remove the supplied revisions until no more children have 0
1868
:param parent_map: A dict of {child: [parents]}, this dictionary will
1869
be modified in place.
1870
:param tails_to_remove: A list of tips that should be removed,
1871
this list will be consumed
1872
:param child_map: The reverse dict of parent_map ({parent: [children]})
1873
this dict will be modified
1874
:return: None, parent_map will be modified in place.
1876
while tails_to_remove:
1877
next = tails_to_remove.pop()
1878
parent_map.pop(next)
1879
children = child_map.pop(next)
1880
for child in children:
1881
child_parents = parent_map[child]
1882
child_parents.remove(next)
1883
if len(child_parents) == 0:
1884
tails_to_remove.append(child)
1886
def _get_interesting_texts(self, parent_map):
1887
"""Return a dict of texts we are interested in.
1889
Note that the input is in key tuples, but the output is in plain
1892
:param parent_map: The output from _find_recursive_lcas
1893
:return: A dict of {'revision_id':lines} as returned by
1894
_PlanMergeBase.get_lines()
1896
all_revision_keys = set(parent_map)
1897
all_revision_keys.add(self.a_key)
1898
all_revision_keys.add(self.b_key)
1900
# Everything else is in 'keys' but get_lines is in 'revision_ids'
1901
all_texts = self.get_lines([k[-1] for k in all_revision_keys])
1904
def _build_weave(self):
1905
from bzrlib import weave
1906
self._weave = weave.Weave(weave_name='in_memory_weave',
1907
allow_reserved=True)
1908
parent_map = self._find_recursive_lcas()
1910
all_texts = self._get_interesting_texts(parent_map)
1912
# Note: Unfortunately, the order given by topo_sort will effect the
1913
# ordering resolution in the output. Specifically, if you add A then B,
1914
# then in the output text A lines will show up before B lines. And, of
1915
# course, topo_sort doesn't guarantee any real ordering.
1916
# So we use merge_sort, and add a fake node on the tip.
1917
# This ensures that left-hand parents will always be inserted into the
1918
# weave before right-hand parents.
1919
tip_key = self._key_prefix + (_mod_revision.CURRENT_REVISION,)
1920
parent_map[tip_key] = (self.a_key, self.b_key)
1922
for seq_num, key, depth, eom in reversed(tsort.merge_sort(parent_map,
1926
# for key in tsort.topo_sort(parent_map):
1927
parent_keys = parent_map[key]
1928
revision_id = key[-1]
1929
parent_ids = [k[-1] for k in parent_keys]
1930
self._weave.add_lines(revision_id, parent_ids,
1931
all_texts[revision_id])
1933
def plan_merge(self):
1934
"""Generate a 'plan' for merging the two revisions.
1936
This involves comparing their texts and determining the cause of
1937
differences. If text A has a line and text B does not, then either the
1938
line was added to text A, or it was deleted from B. Once the causes
1939
are combined, they are written out in the format described in
1940
VersionedFile.plan_merge
1942
if self._head_key is not None: # There was a single head
1943
if self._head_key == self.a_key:
1946
if self._head_key != self.b_key:
1947
raise AssertionError('There was an invalid head: %s != %s'
1948
% (self.b_key, self._head_key))
1950
head_rev = self._head_key[-1]
1951
lines = self.get_lines([head_rev])[head_rev]
1952
return ((plan, line) for line in lines)
1953
return self._weave.plan_merge(self.a_rev, self.b_rev)
1956
class _PlanLCAMerge(_PlanMergeBase):
1958
This merge algorithm differs from _PlanMerge in that:
1959
1. comparisons are done against LCAs only
1960
2. cases where a contested line is new versus one LCA but old versus
1961
another are marked as conflicts, by emitting the line as conflicted-a
1964
This is faster, and hopefully produces more useful output.
1967
def __init__(self, a_rev, b_rev, vf, key_prefix, graph):
1968
_PlanMergeBase.__init__(self, a_rev, b_rev, vf, key_prefix)
1969
lcas = graph.find_lca(key_prefix + (a_rev,), key_prefix + (b_rev,))
1972
if lca == _mod_revision.NULL_REVISION:
1975
self.lcas.add(lca[-1])
1976
for lca in self.lcas:
1977
if _mod_revision.is_null(lca):
1980
lca_lines = self.get_lines([lca])[lca]
1981
matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_a,
1983
blocks = list(matcher.get_matching_blocks())
1984
self._cached_matching_blocks[(a_rev, lca)] = blocks
1985
matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_b,
1987
blocks = list(matcher.get_matching_blocks())
1988
self._cached_matching_blocks[(b_rev, lca)] = blocks
1990
def _determine_status(self, revision_id, unique_line_numbers):
1991
"""Determines the status unique lines versus all lcas.
1993
Basically, determines why the line is unique to this revision.
1995
A line may be determined new, killed, or both.
1997
If a line is determined new, that means it was not present in at least
1998
one LCA, and is not present in the other merge revision.
2000
If a line is determined killed, that means the line was present in
2003
If a line is killed and new, this indicates that the two merge
2004
revisions contain differing conflict resolutions.
2005
:param revision_id: The id of the revision in which the lines are
2007
:param unique_line_numbers: The line numbers of unique lines.
2008
:return a tuple of (new_this, killed_other):
2012
unique_line_numbers = set(unique_line_numbers)
2013
for lca in self.lcas:
2014
blocks = self._get_matching_blocks(revision_id, lca)
2015
unique_vs_lca, _ignored = self._unique_lines(blocks)
2016
new.update(unique_line_numbers.intersection(unique_vs_lca))
2017
killed.update(unique_line_numbers.difference(unique_vs_lca))
added
removed
bzrlib/merge.py
