13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22
19
from bzrlib import (
20
branch as _mod_branch,
21
conflicts as _mod_conflicts,
28
30
revision as _mod_revision,
30
from bzrlib.branch import Branch
31
from bzrlib.conflicts import ConflictList, Conflict
32
from bzrlib.errors import (BzrCommandError,
42
WorkingTreeNotRevision,
45
from bzrlib.merge3 import Merge3
46
from bzrlib.osutils import rename, pathjoin
47
from progress import DummyProgress, ProgressPhase
48
from bzrlib.revision import (NULL_REVISION, ensure_null)
49
from bzrlib.textfile import check_text_lines
50
from bzrlib.trace import mutter, warning, note, is_quiet
51
from bzrlib.transform import (TransformPreview, TreeTransform,
52
resolve_conflicts, cook_conflicts,
53
conflict_pass, FinalPaths, create_by_entry,
54
unique_add, ROOT_PARENT)
55
from bzrlib.versionedfile import PlanWeaveMerge
39
from bzrlib.cleanup import OperationWithCleanups
40
from bzrlib.symbol_versioning import (
58
44
# TODO: Report back as changes are merged in
61
47
def transform_tree(from_tree, to_tree, interesting_ids=None):
62
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
63
interesting_ids=interesting_ids, this_tree=from_tree)
48
from_tree.lock_tree_write()
49
operation = OperationWithCleanups(merge_inner)
50
operation.add_cleanup(from_tree.unlock)
51
operation.run_simple(from_tree.branch, to_tree, from_tree,
52
ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
55
class MergeHooks(hooks.Hooks):
58
hooks.Hooks.__init__(self)
59
self.create_hook(hooks.HookPoint('merge_file_content',
60
"Called with a bzrlib.merge.Merger object to create a per file "
61
"merge object when starting a merge. "
62
"Should return either None or a subclass of "
63
"``bzrlib.merge.AbstractPerFileMerger``. "
64
"Such objects will then be called per file "
65
"that needs to be merged (including when one "
66
"side has deleted the file and the other has changed it). "
67
"See the AbstractPerFileMerger API docs for details on how it is "
72
class AbstractPerFileMerger(object):
73
"""PerFileMerger objects are used by plugins extending merge for bzrlib.
75
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
77
:ivar merger: The Merge3Merger performing the merge.
80
def __init__(self, merger):
81
"""Create a PerFileMerger for use with merger."""
84
def merge_contents(self, merge_params):
85
"""Attempt to merge the contents of a single file.
87
:param merge_params: A bzrlib.merge.MergeHookParams
88
:return : A tuple of (status, chunks), where status is one of
89
'not_applicable', 'success', 'conflicted', or 'delete'. If status
90
is 'success' or 'conflicted', then chunks should be an iterable of
91
strings for the new file contents.
93
return ('not applicable', None)
96
class ConfigurableFileMerger(AbstractPerFileMerger):
97
"""Merge individual files when configured via a .conf file.
99
This is a base class for concrete custom file merging logic. Concrete
100
classes should implement ``merge_text``.
102
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
104
:ivar affected_files: The configured file paths to merge.
106
:cvar name_prefix: The prefix to use when looking up configuration
107
details. <name_prefix>_merge_files describes the files targeted by the
110
:cvar default_files: The default file paths to merge when no configuration
117
def __init__(self, merger):
118
super(ConfigurableFileMerger, self).__init__(merger)
119
self.affected_files = None
120
self.default_files = self.__class__.default_files or []
121
self.name_prefix = self.__class__.name_prefix
122
if self.name_prefix is None:
123
raise ValueError("name_prefix must be set.")
125
def filename_matches_config(self, params):
126
"""Check whether the file should call the merge hook.
128
<name_prefix>_merge_files configuration variable is a list of files
129
that should use the hook.
131
affected_files = self.affected_files
132
if affected_files is None:
133
config = self.merger.this_branch.get_config()
134
# Until bzr provides a better policy for caching the config, we
135
# just add the part we're interested in to the params to avoid
136
# reading the config files repeatedly (bazaar.conf, location.conf,
138
config_key = self.name_prefix + '_merge_files'
139
affected_files = config.get_user_option_as_list(config_key)
140
if affected_files is None:
141
# If nothing was specified in the config, use the default.
142
affected_files = self.default_files
143
self.affected_files = affected_files
145
filename = self.merger.this_tree.id2path(params.file_id)
146
if filename in affected_files:
150
def merge_contents(self, params):
151
"""Merge the contents of a single file."""
152
# First, check whether this custom merge logic should be used. We
153
# expect most files should not be merged by this handler.
155
# OTHER is a straight winner, rely on default merge.
156
params.winner == 'other' or
157
# THIS and OTHER aren't both files.
158
not params.is_file_merge() or
159
# The filename isn't listed in the 'NAME_merge_files' config
161
not self.filename_matches_config(params)):
162
return 'not_applicable', None
163
return self.merge_text(params)
165
def merge_text(self, params):
166
"""Merge the byte contents of a single file.
168
This is called after checking that the merge should be performed in
169
merge_contents, and it should behave as per
170
``bzrlib.merge.AbstractPerFileMerger.merge_contents``.
172
raise NotImplementedError(self.merge_text)
175
class MergeHookParams(object):
176
"""Object holding parameters passed to merge_file_content hooks.
178
There are some fields hooks can access:
180
:ivar file_id: the file ID of the file being merged
181
:ivar trans_id: the transform ID for the merge of this file
182
:ivar this_kind: kind of file_id in 'this' tree
183
:ivar other_kind: kind of file_id in 'other' tree
184
:ivar winner: one of 'this', 'other', 'conflict'
187
def __init__(self, merger, file_id, trans_id, this_kind, other_kind,
189
self._merger = merger
190
self.file_id = file_id
191
self.trans_id = trans_id
192
self.this_kind = this_kind
193
self.other_kind = other_kind
196
def is_file_merge(self):
197
"""True if this_kind and other_kind are both 'file'."""
198
return self.this_kind == 'file' and self.other_kind == 'file'
200
@decorators.cachedproperty
201
def base_lines(self):
202
"""The lines of the 'base' version of the file."""
203
return self._merger.get_lines(self._merger.base_tree, self.file_id)
205
@decorators.cachedproperty
206
def this_lines(self):
207
"""The lines of the 'this' version of the file."""
208
return self._merger.get_lines(self._merger.this_tree, self.file_id)
210
@decorators.cachedproperty
211
def other_lines(self):
212
"""The lines of the 'other' version of the file."""
213
return self._merger.get_lines(self._merger.other_tree, self.file_id)
66
216
class Merger(object):
67
220
def __init__(self, this_branch, other_tree=None, base_tree=None,
68
this_tree=None, pb=DummyProgress(), change_reporter=None,
221
this_tree=None, pb=None, change_reporter=None,
69
222
recurse='down', revision_graph=None):
70
223
object.__init__(self)
71
224
self.this_branch = this_branch
239
417
if self.this_rev_id is None:
240
418
if self.this_basis_tree.get_file_sha1(file_id) != \
241
419
self.this_tree.get_file_sha1(file_id):
242
raise WorkingTreeNotRevision(self.this_tree)
420
raise errors.WorkingTreeNotRevision(self.this_tree)
244
422
trees = (self.this_basis_tree, self.other_tree)
245
423
return [get_id(tree, file_id) for tree in trees]
425
@deprecated_method(deprecated_in((2, 1, 0)))
247
426
def check_basis(self, check_clean, require_commits=True):
248
427
if self.this_basis is None and require_commits is True:
249
raise BzrCommandError("This branch has no commits."
250
" (perhaps you would prefer 'bzr pull')")
428
raise errors.BzrCommandError(
429
"This branch has no commits."
430
" (perhaps you would prefer 'bzr pull')")
252
432
self.compare_basis()
253
433
if self.this_basis != self.this_rev_id:
254
434
raise errors.UncommittedChanges(self.this_tree)
436
@deprecated_method(deprecated_in((2, 1, 0)))
256
437
def compare_basis(self):
258
439
basis_tree = self.revision_tree(self.this_tree.last_revision())
259
except errors.RevisionNotPresent:
440
except errors.NoSuchRevision:
260
441
basis_tree = self.this_tree.basis_tree()
261
changes = self.this_tree.changes_from(basis_tree)
262
if not changes.has_changed():
442
if not self.this_tree.has_changes(basis_tree):
263
443
self.this_rev_id = self.this_basis
265
445
def set_interesting_files(self, file_list):
266
446
self.interesting_files = file_list
268
448
def set_pending(self):
269
if not self.base_is_ancestor or not self.base_is_other_ancestor or self.other_rev_id is None:
449
if (not self.base_is_ancestor or not self.base_is_other_ancestor
450
or self.other_rev_id is None):
271
452
self._add_parent()
273
454
def _add_parent(self):
274
455
new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
275
456
new_parent_trees = []
457
operation = OperationWithCleanups(self.this_tree.set_parent_trees)
276
458
for revision_id in new_parents:
278
460
tree = self.revision_tree(revision_id)
279
except errors.RevisionNotPresent:
461
except errors.NoSuchRevision:
465
operation.add_cleanup(tree.unlock)
283
466
new_parent_trees.append((revision_id, tree))
285
self.this_tree.set_parent_trees(new_parent_trees,
286
allow_leftmost_as_ghost=True)
288
for _revision_id, tree in new_parent_trees:
467
operation.run_simple(new_parent_trees, allow_leftmost_as_ghost=True)
292
469
def set_other(self, other_revision, possible_transports=None):
293
470
"""Set the revision and tree to merge from.
344
521
target.fetch(source, revision_id)
346
523
def find_base(self):
347
revisions = [ensure_null(self.this_basis),
348
ensure_null(self.other_basis)]
349
if NULL_REVISION in revisions:
350
self.base_rev_id = NULL_REVISION
524
revisions = [_mod_revision.ensure_null(self.this_basis),
525
_mod_revision.ensure_null(self.other_basis)]
526
if _mod_revision.NULL_REVISION in revisions:
527
self.base_rev_id = _mod_revision.NULL_REVISION
528
self.base_tree = self.revision_tree(self.base_rev_id)
529
self._is_criss_cross = False
352
self.base_rev_id, steps = self.revision_graph.find_unique_lca(
353
revisions[0], revisions[1], count_steps=True)
354
if self.base_rev_id == NULL_REVISION:
355
raise UnrelatedBranches()
357
warning('Warning: criss-cross merge encountered. See bzr'
358
' help criss-cross.')
359
self.base_tree = self.revision_tree(self.base_rev_id)
531
lcas = self.revision_graph.find_lca(revisions[0], revisions[1])
532
self._is_criss_cross = False
534
self.base_rev_id = _mod_revision.NULL_REVISION
536
self.base_rev_id = list(lcas)[0]
537
else: # len(lcas) > 1
539
# find_unique_lca can only handle 2 nodes, so we have to
540
# start back at the beginning. It is a shame to traverse
541
# the graph again, but better than re-implementing
543
self.base_rev_id = self.revision_graph.find_unique_lca(
544
revisions[0], revisions[1])
546
self.base_rev_id = self.revision_graph.find_unique_lca(
548
self._is_criss_cross = True
549
if self.base_rev_id == _mod_revision.NULL_REVISION:
550
raise errors.UnrelatedBranches()
551
if self._is_criss_cross:
552
trace.warning('Warning: criss-cross merge encountered. See bzr'
553
' help criss-cross.')
554
trace.mutter('Criss-cross lcas: %r' % lcas)
555
interesting_revision_ids = [self.base_rev_id]
556
interesting_revision_ids.extend(lcas)
557
interesting_trees = dict((t.get_revision_id(), t)
558
for t in self.this_branch.repository.revision_trees(
559
interesting_revision_ids))
560
self._cached_trees.update(interesting_trees)
561
self.base_tree = interesting_trees.pop(self.base_rev_id)
562
sorted_lca_keys = self.revision_graph.find_merge_order(
564
self._lca_trees = [interesting_trees[key]
565
for key in sorted_lca_keys]
567
self.base_tree = self.revision_tree(self.base_rev_id)
360
568
self.base_is_ancestor = True
361
569
self.base_is_other_ancestor = True
570
trace.mutter('Base revid: %r' % self.base_rev_id)
363
572
def set_base(self, base_revision):
364
573
"""Set the base revision to use for the merge.
366
575
:param base_revision: A 2-list containing a path and revision number.
368
mutter("doing merge() with no base_revision specified")
577
trace.mutter("doing merge() with no base_revision specified")
369
578
if base_revision == [None, None]:
384
593
'other_tree': self.other_tree,
385
594
'interesting_ids': self.interesting_ids,
386
595
'interesting_files': self.interesting_files,
596
'this_branch': self.this_branch,
388
597
'do_merge': False}
389
598
if self.merge_type.requires_base:
390
599
kwargs['base_tree'] = self.base_tree
391
600
if self.merge_type.supports_reprocess:
392
601
kwargs['reprocess'] = self.reprocess
393
602
elif self.reprocess:
394
raise BzrError("Conflict reduction is not supported for merge"
395
" type %s." % self.merge_type)
603
raise errors.BzrError(
604
"Conflict reduction is not supported for merge"
605
" type %s." % self.merge_type)
396
606
if self.merge_type.supports_show_base:
397
607
kwargs['show_base'] = self.show_base
398
608
elif self.show_base:
399
raise BzrError("Showing base is not supported for this"
400
" merge type. %s" % self.merge_type)
609
raise errors.BzrError("Showing base is not supported for this"
610
" merge type. %s" % self.merge_type)
401
611
if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
402
612
and not self.base_is_other_ancestor):
403
613
raise errors.CannotReverseCherrypick()
404
614
if self.merge_type.supports_cherrypick:
405
615
kwargs['cherrypick'] = (not self.base_is_ancestor or
406
616
not self.base_is_other_ancestor)
407
return self.merge_type(pb=self._pb,
617
if self._is_criss_cross and getattr(self.merge_type,
618
'supports_lca_trees', False):
619
kwargs['lca_trees'] = self._lca_trees
620
return self.merge_type(pb=None,
408
621
change_reporter=self.change_reporter,
624
def _do_merge_to(self):
625
merge = self.make_merger()
626
if self.other_branch is not None:
627
self.other_branch.update_references(self.this_branch)
629
if self.recurse == 'down':
630
for relpath, file_id in self.this_tree.iter_references():
631
sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
632
other_revision = self.other_tree.get_reference_revision(
634
if other_revision == sub_tree.last_revision():
636
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
637
sub_merge.merge_type = self.merge_type
638
other_branch = self.other_branch.reference_parent(file_id, relpath)
639
sub_merge.set_other_revision(other_revision, other_branch)
640
base_revision = self.base_tree.get_reference_revision(file_id)
641
sub_merge.base_tree = \
642
sub_tree.branch.repository.revision_tree(base_revision)
643
sub_merge.base_rev_id = base_revision
411
647
def do_merge(self):
648
operation = OperationWithCleanups(self._do_merge_to)
412
649
self.this_tree.lock_tree_write()
650
operation.add_cleanup(self.this_tree.unlock)
413
651
if self.base_tree is not None:
414
652
self.base_tree.lock_read()
653
operation.add_cleanup(self.base_tree.unlock)
415
654
if self.other_tree is not None:
416
655
self.other_tree.lock_read()
418
merge = self.make_merger()
420
if self.recurse == 'down':
421
for path, file_id in self.this_tree.iter_references():
422
sub_tree = self.this_tree.get_nested_tree(file_id, path)
423
other_revision = self.other_tree.get_reference_revision(
425
if other_revision == sub_tree.last_revision():
427
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
428
sub_merge.merge_type = self.merge_type
429
relpath = self.this_tree.relpath(path)
430
other_branch = self.other_branch.reference_parent(file_id, relpath)
431
sub_merge.set_other_revision(other_revision, other_branch)
432
base_revision = self.base_tree.get_reference_revision(file_id)
433
sub_merge.base_tree = \
434
sub_tree.branch.repository.revision_tree(base_revision)
435
sub_merge.base_rev_id = base_revision
439
if self.other_tree is not None:
440
self.other_tree.unlock()
441
if self.base_tree is not None:
442
self.base_tree.unlock()
443
self.this_tree.unlock()
656
operation.add_cleanup(self.other_tree.unlock)
657
merge = operation.run_simple()
444
658
if len(merge.cooked_conflicts) == 0:
445
if not self.ignore_zero and not is_quiet():
446
note("All changes applied successfully.")
659
if not self.ignore_zero and not trace.is_quiet():
660
trace.note("All changes applied successfully.")
448
note("%d conflicts encountered." % len(merge.cooked_conflicts))
662
trace.note("%d conflicts encountered."
663
% len(merge.cooked_conflicts))
450
665
return len(merge.cooked_conflicts)
668
class _InventoryNoneEntry(object):
669
"""This represents an inventory entry which *isn't there*.
671
It simplifies the merging logic if we always have an InventoryEntry, even
672
if it isn't actually present
679
symlink_target = None
682
_none_entry = _InventoryNoneEntry()
453
685
class Merge3Merger(object):
454
686
"""Three-way merger that uses the merge3 text merger"""
455
687
requires_base = True
496
733
self.this_tree = working_tree
497
734
self.base_tree = base_tree
498
735
self.other_tree = other_tree
736
self.this_branch = this_branch
499
737
self._raw_conflicts = []
500
738
self.cooked_conflicts = []
501
739
self.reprocess = reprocess
502
740
self.show_base = show_base
741
self._lca_trees = lca_trees
742
# Uncommenting this will change the default algorithm to always use
743
# _entries_lca. This can be useful for running the test suite and
744
# making sure we haven't missed any corner cases.
745
# if lca_trees is None:
746
# self._lca_trees = [self.base_tree]
505
747
self.change_reporter = change_reporter
506
748
self.cherrypick = cherrypick
508
self.pp = ProgressPhase("Merge phase", 3, self.pb)
752
warnings.warn("pp argument to Merge3Merger is deprecated")
754
warnings.warn("pb argument to Merge3Merger is deprecated")
512
756
def do_merge(self):
757
operation = OperationWithCleanups(self._do_merge)
513
758
self.this_tree.lock_tree_write()
759
operation.add_cleanup(self.this_tree.unlock)
514
760
self.base_tree.lock_read()
761
operation.add_cleanup(self.base_tree.unlock)
515
762
self.other_tree.lock_read()
516
self.tt = TreeTransform(self.this_tree, self.pb)
763
operation.add_cleanup(self.other_tree.unlock)
766
def _do_merge(self, operation):
767
self.tt = transform.TreeTransform(self.this_tree, None)
768
operation.add_cleanup(self.tt.finalize)
769
self._compute_transform()
770
results = self.tt.apply(no_conflicts=True)
771
self.write_modified(results)
519
self._compute_transform()
521
results = self.tt.apply(no_conflicts=True)
522
self.write_modified(results)
524
self.this_tree.add_conflicts(self.cooked_conflicts)
525
except UnsupportedOperation:
529
self.other_tree.unlock()
530
self.base_tree.unlock()
531
self.this_tree.unlock()
773
self.this_tree.add_conflicts(self.cooked_conflicts)
774
except errors.UnsupportedOperation:
534
777
def make_preview_transform(self):
778
operation = OperationWithCleanups(self._make_preview_transform)
535
779
self.base_tree.lock_read()
780
operation.add_cleanup(self.base_tree.unlock)
536
781
self.other_tree.lock_read()
537
self.tt = TransformPreview(self.this_tree)
540
self._compute_transform()
543
self.other_tree.unlock()
544
self.base_tree.unlock()
782
operation.add_cleanup(self.other_tree.unlock)
783
return operation.run_simple()
785
def _make_preview_transform(self):
786
self.tt = transform.TransformPreview(self.this_tree)
787
self._compute_transform()
548
790
def _compute_transform(self):
549
entries = self._entries3()
791
if self._lca_trees is None:
792
entries = self._entries3()
793
resolver = self._three_way
795
entries = self._entries_lca()
796
resolver = self._lca_multi_way
550
797
child_pb = ui.ui_factory.nested_progress_bar()
799
factories = Merger.hooks['merge_file_content']
800
hooks = [factory(self) for factory in factories] + [self]
801
self.active_hooks = [hook for hook in hooks if hook is not None]
552
802
for num, (file_id, changed, parents3, names3,
553
803
executable3) in enumerate(entries):
554
804
child_pb.update('Preparing file merge', num, len(entries))
555
self._merge_names(file_id, parents3, names3)
805
self._merge_names(file_id, parents3, names3, resolver=resolver)
557
file_status = self.merge_contents(file_id)
807
file_status = self._do_merge_contents(file_id)
559
809
file_status = 'unmodified'
560
810
self._merge_executable(file_id,
561
executable3, file_status)
811
executable3, file_status, resolver=resolver)
563
813
child_pb.finished()
566
815
child_pb = ui.ui_factory.nested_progress_bar()
568
fs_conflicts = resolve_conflicts(self.tt, child_pb,
569
lambda t, c: conflict_pass(t, c, self.other_tree))
817
fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
818
lambda t, c: transform.conflict_pass(t, c, self.other_tree))
571
820
child_pb.finished()
572
821
if self.change_reporter is not None:
610
862
result.append((file_id, changed, parents3, names3, executable3))
865
def _entries_lca(self):
866
"""Gather data about files modified between multiple trees.
868
This compares OTHER versus all LCA trees, and for interesting entries,
869
it then compares with THIS and BASE.
871
For the multi-valued entries, the format will be (BASE, [lca1, lca2])
872
:return: [(file_id, changed, parents, names, executable)]
873
file_id Simple file_id of the entry
874
changed Boolean, True if the kind or contents changed
876
parents ((base, [parent_id, in, lcas]), parent_id_other,
878
names ((base, [name, in, lcas]), name_in_other, name_in_this)
879
executable ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
881
if self.interesting_files is not None:
882
lookup_trees = [self.this_tree, self.base_tree]
883
lookup_trees.extend(self._lca_trees)
884
# I think we should include the lca trees as well
885
interesting_ids = self.other_tree.paths2ids(self.interesting_files,
888
interesting_ids = self.interesting_ids
890
walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
892
base_inventory = self.base_tree.inventory
893
this_inventory = self.this_tree.inventory
894
for path, file_id, other_ie, lca_values in walker.iter_all():
895
# Is this modified at all from any of the other trees?
897
other_ie = _none_entry
898
if interesting_ids is not None and file_id not in interesting_ids:
901
# If other_revision is found in any of the lcas, that means this
902
# node is uninteresting. This is because when merging, if there are
903
# multiple heads(), we have to create a new node. So if we didn't,
904
# we know that the ancestry is linear, and that OTHER did not
906
# See doc/developers/lca_merge_resolution.txt for details
907
other_revision = other_ie.revision
908
if other_revision is not None:
909
# We can't use this shortcut when other_revision is None,
910
# because it may be None because things are WorkingTrees, and
911
# not because it is *actually* None.
912
is_unmodified = False
913
for lca_path, ie in lca_values:
914
if ie is not None and ie.revision == other_revision:
921
for lca_path, lca_ie in lca_values:
923
lca_entries.append(_none_entry)
925
lca_entries.append(lca_ie)
927
if file_id in base_inventory:
928
base_ie = base_inventory[file_id]
930
base_ie = _none_entry
932
if file_id in this_inventory:
933
this_ie = this_inventory[file_id]
935
this_ie = _none_entry
941
for lca_ie in lca_entries:
942
lca_kinds.append(lca_ie.kind)
943
lca_parent_ids.append(lca_ie.parent_id)
944
lca_names.append(lca_ie.name)
945
lca_executable.append(lca_ie.executable)
947
kind_winner = self._lca_multi_way(
948
(base_ie.kind, lca_kinds),
949
other_ie.kind, this_ie.kind)
950
parent_id_winner = self._lca_multi_way(
951
(base_ie.parent_id, lca_parent_ids),
952
other_ie.parent_id, this_ie.parent_id)
953
name_winner = self._lca_multi_way(
954
(base_ie.name, lca_names),
955
other_ie.name, this_ie.name)
957
content_changed = True
958
if kind_winner == 'this':
959
# No kind change in OTHER, see if there are *any* changes
960
if other_ie.kind == 'directory':
961
if parent_id_winner == 'this' and name_winner == 'this':
962
# No change for this directory in OTHER, skip
964
content_changed = False
965
elif other_ie.kind is None or other_ie.kind == 'file':
966
def get_sha1(ie, tree):
967
if ie.kind != 'file':
969
return tree.get_file_sha1(file_id)
970
base_sha1 = get_sha1(base_ie, self.base_tree)
971
lca_sha1s = [get_sha1(ie, tree) for ie, tree
972
in zip(lca_entries, self._lca_trees)]
973
this_sha1 = get_sha1(this_ie, self.this_tree)
974
other_sha1 = get_sha1(other_ie, self.other_tree)
975
sha1_winner = self._lca_multi_way(
976
(base_sha1, lca_sha1s), other_sha1, this_sha1,
977
allow_overriding_lca=False)
978
exec_winner = self._lca_multi_way(
979
(base_ie.executable, lca_executable),
980
other_ie.executable, this_ie.executable)
981
if (parent_id_winner == 'this' and name_winner == 'this'
982
and sha1_winner == 'this' and exec_winner == 'this'):
983
# No kind, parent, name, exec, or content change for
984
# OTHER, so this node is not considered interesting
986
if sha1_winner == 'this':
987
content_changed = False
988
elif other_ie.kind == 'symlink':
989
def get_target(ie, tree):
990
if ie.kind != 'symlink':
992
return tree.get_symlink_target(file_id)
993
base_target = get_target(base_ie, self.base_tree)
994
lca_targets = [get_target(ie, tree) for ie, tree
995
in zip(lca_entries, self._lca_trees)]
996
this_target = get_target(this_ie, self.this_tree)
997
other_target = get_target(other_ie, self.other_tree)
998
target_winner = self._lca_multi_way(
999
(base_target, lca_targets),
1000
other_target, this_target)
1001
if (parent_id_winner == 'this' and name_winner == 'this'
1002
and target_winner == 'this'):
1003
# No kind, parent, name, or symlink target change
1006
if target_winner == 'this':
1007
content_changed = False
1008
elif other_ie.kind == 'tree-reference':
1009
# The 'changed' information seems to be handled at a higher
1010
# level. At least, _entries3 returns False for content
1011
# changed, even when at a new revision_id.
1012
content_changed = False
1013
if (parent_id_winner == 'this' and name_winner == 'this'):
1014
# Nothing interesting
1017
raise AssertionError('unhandled kind: %s' % other_ie.kind)
1019
# If we have gotten this far, that means something has changed
1020
result.append((file_id, content_changed,
1021
((base_ie.parent_id, lca_parent_ids),
1022
other_ie.parent_id, this_ie.parent_id),
1023
((base_ie.name, lca_names),
1024
other_ie.name, this_ie.name),
1025
((base_ie.executable, lca_executable),
1026
other_ie.executable, this_ie.executable)
613
1031
def fix_root(self):
615
1033
self.tt.final_kind(self.tt.root)
1034
except errors.NoSuchFile:
617
1035
self.tt.cancel_deletion(self.tt.root)
618
1036
if self.tt.final_file_id(self.tt.root) is None:
619
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
1037
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
621
if self.other_tree.inventory.root is None:
623
1039
other_root_file_id = self.other_tree.get_root_id()
1040
if other_root_file_id is None:
624
1042
other_root = self.tt.trans_id_file_id(other_root_file_id)
625
1043
if other_root == self.tt.root:
628
1046
self.tt.final_kind(other_root)
1047
except errors.NoSuchFile:
1049
if self.this_tree.has_id(self.other_tree.inventory.root.file_id):
1050
# the other tree's root is a non-root in the current tree
631
1052
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
632
1053
self.tt.cancel_creation(other_root)
683
1104
def kind(tree, file_id):
684
1105
"""Determine the kind of a file-id (used as a key method)."""
685
if file_id not in tree:
1106
if not tree.has_id(file_id):
687
1108
return tree.kind(file_id)
690
1111
def _three_way(base, other, this):
691
#if base == other, either they all agree, or only THIS has changed.
692
1112
if base == other:
1113
# if 'base == other', either they all agree, or only 'this' has
694
1116
elif this not in (base, other):
1117
# 'this' is neither 'base' nor 'other', so both sides changed
695
1118
return 'conflict'
696
# "Ambiguous clean merge" -- both sides have made the same change.
697
1119
elif this == other:
1120
# "Ambiguous clean merge" -- both sides have made the same change.
699
# this == base: only other has changed.
1123
# this == base: only other has changed.
1127
def _lca_multi_way(bases, other, this, allow_overriding_lca=True):
1128
"""Consider LCAs when determining whether a change has occurred.
1130
If LCAS are all identical, this is the same as a _three_way comparison.
1132
:param bases: value in (BASE, [LCAS])
1133
:param other: value in OTHER
1134
:param this: value in THIS
1135
:param allow_overriding_lca: If there is more than one unique lca
1136
value, allow OTHER to override THIS if it has a new value, and
1137
THIS only has an lca value, or vice versa. This is appropriate for
1138
truly scalar values, not as much for non-scalars.
1139
:return: 'this', 'other', or 'conflict' depending on whether an entry
1142
# See doc/developers/lca_tree_merging.txt for details about this
1145
# Either Ambiguously clean, or nothing was actually changed. We
1148
base_val, lca_vals = bases
1149
# Remove 'base_val' from the lca_vals, because it is not interesting
1150
filtered_lca_vals = [lca_val for lca_val in lca_vals
1151
if lca_val != base_val]
1152
if len(filtered_lca_vals) == 0:
1153
return Merge3Merger._three_way(base_val, other, this)
1155
unique_lca_vals = set(filtered_lca_vals)
1156
if len(unique_lca_vals) == 1:
1157
return Merge3Merger._three_way(unique_lca_vals.pop(), other, this)
1159
if allow_overriding_lca:
1160
if other in unique_lca_vals:
1161
if this in unique_lca_vals:
1162
# Each side picked a different lca, conflict
1165
# This has a value which supersedes both lca values, and
1166
# other only has an lca value
1168
elif this in unique_lca_vals:
1169
# OTHER has a value which supersedes both lca values, and this
1170
# only has an lca value
1173
# At this point, the lcas disagree, and the tip disagree
1177
@deprecated_method(deprecated_in((2, 2, 0)))
704
1178
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
705
1179
"""Do a three-way test on a scalar.
706
1180
Return "this", "other" or "conflict", depending whether a value wins.
790
1265
return kind, contents
792
def contents_conflict():
793
trans_id = self.tt.trans_id_file_id(file_id)
794
name = self.tt.final_name(trans_id)
795
parent_id = self.tt.final_parent(trans_id)
796
if file_id in self.this_tree.inventory:
797
self.tt.unversion_file(trans_id)
798
if file_id in self.this_tree:
799
self.tt.delete_contents(trans_id)
800
file_group = self._dump_conflicts(name, parent_id, file_id,
802
self._raw_conflicts.append(('contents conflict', file_group))
804
1267
# See SPOT run. run, SPOT, run.
805
1268
# So we're not QUITE repeating ourselves; we do tricky things with
807
1270
base_pair = contents_pair(self.base_tree)
808
1271
other_pair = contents_pair(self.other_tree)
809
if base_pair == other_pair:
810
# OTHER introduced no changes
812
this_pair = contents_pair(self.this_tree)
813
if this_pair == other_pair:
814
# THIS and OTHER introduced the same changes
817
trans_id = self.tt.trans_id_file_id(file_id)
818
if this_pair == base_pair:
819
# only OTHER introduced changes
820
if file_id in self.this_tree:
821
# Remove any existing contents
822
self.tt.delete_contents(trans_id)
823
if file_id in self.other_tree:
824
# OTHER changed the file
825
create_by_entry(self.tt,
826
self.other_tree.inventory[file_id],
827
self.other_tree, trans_id)
828
if file_id not in self.this_tree.inventory:
829
self.tt.version_file(file_id, trans_id)
831
elif file_id in self.this_tree.inventory:
832
# OTHER deleted the file
833
self.tt.unversion_file(trans_id)
835
#BOTH THIS and OTHER introduced changes; scalar conflict
836
elif this_pair[0] == "file" and other_pair[0] == "file":
837
# THIS and OTHER are both files, so text merge. Either
838
# BASE is a file, or both converted to files, so at least we
839
# have agreement that output should be a file.
841
self.text_merge(file_id, trans_id)
843
return contents_conflict()
844
if file_id not in self.this_tree.inventory:
845
self.tt.version_file(file_id, trans_id)
847
self.tt.tree_kind(trans_id)
848
self.tt.delete_contents(trans_id)
853
# Scalar conflict, can't text merge. Dump conflicts
854
return contents_conflict()
1273
this_pair = contents_pair(self.this_tree)
1274
lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1275
winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1276
this_pair, allow_overriding_lca=False)
1278
if base_pair == other_pair:
1281
# We delayed evaluating this_pair as long as we can to avoid
1282
# unnecessary sha1 calculation
1283
this_pair = contents_pair(self.this_tree)
1284
winner = self._three_way(base_pair, other_pair, this_pair)
1285
if winner == 'this':
1286
# No interesting changes introduced by OTHER
1288
# We have a hypothetical conflict, but if we have files, then we
1289
# can try to merge the content
1290
trans_id = self.tt.trans_id_file_id(file_id)
1291
params = MergeHookParams(self, file_id, trans_id, this_pair[0],
1292
other_pair[0], winner)
1293
hooks = self.active_hooks
1294
hook_status = 'not_applicable'
1296
hook_status, lines = hook.merge_contents(params)
1297
if hook_status != 'not_applicable':
1298
# Don't try any more hooks, this one applies.
1301
if hook_status == 'not_applicable':
1302
# This is a contents conflict, because none of the available
1303
# functions could merge it.
1305
name = self.tt.final_name(trans_id)
1306
parent_id = self.tt.final_parent(trans_id)
1307
if self.this_tree.has_id(file_id):
1308
self.tt.unversion_file(trans_id)
1309
file_group = self._dump_conflicts(name, parent_id, file_id,
1311
self._raw_conflicts.append(('contents conflict', file_group))
1312
elif hook_status == 'success':
1313
self.tt.create_file(lines, trans_id)
1314
elif hook_status == 'conflicted':
1315
# XXX: perhaps the hook should be able to provide
1316
# the BASE/THIS/OTHER files?
1317
self.tt.create_file(lines, trans_id)
1318
self._raw_conflicts.append(('text conflict', trans_id))
1319
name = self.tt.final_name(trans_id)
1320
parent_id = self.tt.final_parent(trans_id)
1321
self._dump_conflicts(name, parent_id, file_id)
1322
elif hook_status == 'delete':
1323
self.tt.unversion_file(trans_id)
1325
elif hook_status == 'done':
1326
# The hook function did whatever it needs to do directly, no
1327
# further action needed here.
1330
raise AssertionError('unknown hook_status: %r' % (hook_status,))
1331
if not self.this_tree.has_id(file_id) and result == "modified":
1332
self.tt.version_file(file_id, trans_id)
1333
# The merge has been performed, so the old contents should not be
1336
self.tt.delete_contents(trans_id)
1337
except errors.NoSuchFile:
1341
def _default_other_winner_merge(self, merge_hook_params):
1342
"""Replace this contents with other."""
1343
file_id = merge_hook_params.file_id
1344
trans_id = merge_hook_params.trans_id
1345
file_in_this = self.this_tree.has_id(file_id)
1346
if self.other_tree.has_id(file_id):
1347
# OTHER changed the file
1349
if wt.supports_content_filtering():
1350
# We get the path from the working tree if it exists.
1351
# That fails though when OTHER is adding a file, so
1352
# we fall back to the other tree to find the path if
1353
# it doesn't exist locally.
1355
filter_tree_path = wt.id2path(file_id)
1356
except errors.NoSuchId:
1357
filter_tree_path = self.other_tree.id2path(file_id)
1359
# Skip the id2path lookup for older formats
1360
filter_tree_path = None
1361
transform.create_from_tree(self.tt, trans_id,
1362
self.other_tree, file_id,
1363
filter_tree_path=filter_tree_path)
1366
# OTHER deleted the file
1367
return 'delete', None
1369
raise AssertionError(
1370
'winner is OTHER, but file_id %r not in THIS or OTHER tree'
1373
def merge_contents(self, merge_hook_params):
1374
"""Fallback merge logic after user installed hooks."""
1375
# This function is used in merge hooks as the fallback instance.
1376
# Perhaps making this function and the functions it calls be a
1377
# a separate class would be better.
1378
if merge_hook_params.winner == 'other':
1379
# OTHER is a straight winner, so replace this contents with other
1380
return self._default_other_winner_merge(merge_hook_params)
1381
elif merge_hook_params.is_file_merge():
1382
# THIS and OTHER are both files, so text merge. Either
1383
# BASE is a file, or both converted to files, so at least we
1384
# have agreement that output should be a file.
1386
self.text_merge(merge_hook_params.file_id,
1387
merge_hook_params.trans_id)
1388
except errors.BinaryFile:
1389
return 'not_applicable', None
1392
return 'not_applicable', None
856
1394
def get_lines(self, tree, file_id):
857
1395
"""Return the lines in a file, or an empty list."""
1396
if tree.has_id(file_id):
859
1397
return tree.get_file(file_id).readlines()
912
1450
determined automatically. If set_version is true, the .OTHER, .THIS
913
1451
or .BASE (in that order) will be created as versioned files.
915
data = [('OTHER', self.other_tree, other_lines),
1453
data = [('OTHER', self.other_tree, other_lines),
916
1454
('THIS', self.this_tree, this_lines)]
918
1456
data.append(('BASE', self.base_tree, base_lines))
1458
# We need to use the actual path in the working tree of the file here,
1459
# ignoring the conflict suffixes
1461
if wt.supports_content_filtering():
1463
filter_tree_path = wt.id2path(file_id)
1464
except errors.NoSuchId:
1465
# file has been deleted
1466
filter_tree_path = None
1468
# Skip the id2path lookup for older formats
1469
filter_tree_path = None
919
1471
versioned = False
921
1473
for suffix, tree, lines in data:
1474
if tree.has_id(file_id):
923
1475
trans_id = self._conflict_file(name, parent_id, tree, file_id,
1476
suffix, lines, filter_tree_path)
925
1477
file_group.append(trans_id)
926
1478
if set_version and not versioned:
927
1479
self.tt.version_file(file_id, trans_id)
928
1480
versioned = True
929
1481
return file_group
931
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1483
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1484
lines=None, filter_tree_path=None):
933
1485
"""Emit a single conflict file."""
934
1486
name = name + '.' + suffix
935
1487
trans_id = self.tt.create_path(name, parent_id)
936
entry = tree.inventory[file_id]
937
create_by_entry(self.tt, entry, tree, trans_id, lines)
1488
transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
940
1492
def merge_executable(self, file_id, file_status):
941
1493
"""Perform a merge on the execute bit."""
942
1494
executable = [self.executable(t, file_id) for t in (self.base_tree,
943
1495
self.other_tree, self.this_tree)]
944
self._merge_executable(file_id, executable, file_status)
1496
self._merge_executable(file_id, executable, file_status,
1497
resolver=self._three_way)
946
def _merge_executable(self, file_id, executable, file_status):
1499
def _merge_executable(self, file_id, executable, file_status,
947
1501
"""Perform a merge on the execute bit."""
948
1502
base_executable, other_executable, this_executable = executable
949
1503
if file_status == "deleted":
951
winner = self._three_way(*executable)
1505
winner = resolver(*executable)
952
1506
if winner == "conflict":
953
1507
# There must be a None in here, if we have a conflict, but we
954
1508
# need executability since file status was not deleted.
1046
1589
supports_reverse_cherrypick = False
1047
1590
history_based = True
1049
def _merged_lines(self, file_id):
1050
"""Generate the merged lines.
1051
There is no distinction between lines that are meant to contain <<<<<<<
1055
base = self.base_tree
1058
plan = self.this_tree.plan_file_merge(file_id, self.other_tree,
1592
def _generate_merge_plan(self, file_id, base):
1593
return self.this_tree.plan_file_merge(file_id, self.other_tree,
1596
def _merged_lines(self, file_id):
1597
"""Generate the merged lines.
1598
There is no distinction between lines that are meant to contain <<<<<<<
1602
base = self.base_tree
1605
plan = self._generate_merge_plan(file_id, base)
1060
1606
if 'merge' in debug.debug_flags:
1061
1607
plan = list(plan)
1062
1608
trans_id = self.tt.trans_id_file_id(file_id)
1063
1609
name = self.tt.final_name(trans_id) + '.plan'
1064
contents = ('%10s|%s' % l for l in plan)
1610
contents = ('%11s|%s' % l for l in plan)
1065
1611
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1066
textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1067
'>>>>>>> MERGE-SOURCE\n')
1068
return textmerge.merge_lines(self.reprocess)
1612
textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1613
'>>>>>>> MERGE-SOURCE\n')
1614
lines, conflicts = textmerge.merge_lines(self.reprocess)
1616
base_lines = textmerge.base_from_plan()
1619
return lines, base_lines
1070
1621
def text_merge(self, file_id, trans_id):
1071
1622
"""Perform a (weave) text merge for a given file and file-id.
1072
1623
If conflicts are encountered, .THIS and .OTHER files will be emitted,
1073
1624
and a conflict will be noted.
1075
lines, conflicts = self._merged_lines(file_id)
1626
lines, base_lines = self._merged_lines(file_id)
1076
1627
lines = list(lines)
1077
# Note we're checking whether the OUTPUT is binary in this case,
1628
# Note we're checking whether the OUTPUT is binary in this case,
1078
1629
# because we don't want to get into weave merge guts.
1079
check_text_lines(lines)
1630
textfile.check_text_lines(lines)
1080
1631
self.tt.create_file(lines, trans_id)
1632
if base_lines is not None:
1082
1634
self._raw_conflicts.append(('text conflict', trans_id))
1083
1635
name = self.tt.final_name(trans_id)
1084
1636
parent_id = self.tt.final_parent(trans_id)
1085
file_group = self._dump_conflicts(name, parent_id, file_id,
1637
file_group = self._dump_conflicts(name, parent_id, file_id,
1639
base_lines=base_lines)
1087
1640
file_group.append(trans_id)
1090
1643
class LCAMerger(WeaveMerger):
1092
def _merged_lines(self, file_id):
1093
"""Generate the merged lines.
1094
There is no distinction between lines that are meant to contain <<<<<<<
1098
base = self.base_tree
1101
plan = self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1645
def _generate_merge_plan(self, file_id, base):
1646
return self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1103
if 'merge' in debug.debug_flags:
1105
trans_id = self.tt.trans_id_file_id(file_id)
1106
name = self.tt.final_name(trans_id) + '.plan'
1107
contents = ('%10s|%s' % l for l in plan)
1108
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1109
textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1110
'>>>>>>> MERGE-SOURCE\n')
1111
return textmerge.merge_lines(self.reprocess)
1114
1649
class Diff3Merger(Merge3Merger):
1115
1650
"""Three-way merger using external diff3 for text merging"""
1117
1652
def dump_file(self, temp_dir, name, tree, file_id):
1118
out_path = pathjoin(temp_dir, name)
1653
out_path = osutils.pathjoin(temp_dir, name)
1119
1654
out_file = open(out_path, "wb")
1121
1656
in_file = tree.get_file(file_id)
1369
1928
class _PlanMerge(_PlanMergeBase):
1370
1929
"""Plan an annotate merge using on-the-fly annotation"""
1372
def __init__(self, a_rev, b_rev, vf):
1373
_PlanMergeBase.__init__(self, a_rev, b_rev, vf)
1374
a_ancestry = set(vf.get_ancestry(a_rev, topo_sorted=False))
1375
b_ancestry = set(vf.get_ancestry(b_rev, topo_sorted=False))
1376
self.uncommon = a_ancestry.symmetric_difference(b_ancestry)
1378
def _determine_status(self, revision_id, unique_line_numbers):
1379
"""Determines the status unique lines versus all lcas.
1381
Basically, determines why the line is unique to this revision.
1383
A line may be determined new or killed, but not both.
1385
:param revision_id: The id of the revision in which the lines are
1387
:param unique_line_numbers: The line numbers of unique lines.
1388
:return a tuple of (new_this, killed_other):
1390
new = self._find_new(revision_id)
1391
killed = set(unique_line_numbers).difference(new)
1394
def _find_new(self, version_id):
1395
"""Determine which lines are new in the ancestry of this version.
1397
If a lines is present in this version, and not present in any
1398
common ancestor, it is considered new.
1400
if version_id not in self.uncommon:
1402
parents = self.vf.get_parent_map([version_id])[version_id]
1403
if len(parents) == 0:
1404
return set(range(len(self.vf.get_lines(version_id))))
1406
for parent in parents:
1407
blocks = self._get_matching_blocks(version_id, parent)
1408
result, unused = self._unique_lines(blocks)
1409
parent_new = self._find_new(parent)
1410
for i, j, n in blocks:
1411
for ii, jj in [(i+r, j+r) for r in range(n)]:
1412
if jj in parent_new:
1417
new.intersection_update(result)
1931
def __init__(self, a_rev, b_rev, vf, key_prefix):
1932
super(_PlanMerge, self).__init__(a_rev, b_rev, vf, key_prefix)
1933
self.a_key = self._key_prefix + (self.a_rev,)
1934
self.b_key = self._key_prefix + (self.b_rev,)
1935
self.graph = _mod_graph.Graph(self.vf)
1936
heads = self.graph.heads((self.a_key, self.b_key))
1938
# one side dominates, so we can just return its values, yay for
1940
# Ideally we would know that before we get this far
1941
self._head_key = heads.pop()
1942
if self._head_key == self.a_key:
1946
trace.mutter('found dominating revision for %s\n%s > %s', self.vf,
1947
self._head_key[-1], other)
1950
self._head_key = None
1953
def _precache_tip_lines(self):
1954
# Turn this into a no-op, because we will do this later
1957
def _find_recursive_lcas(self):
1958
"""Find all the ancestors back to a unique lca"""
1959
cur_ancestors = (self.a_key, self.b_key)
1960
# graph.find_lca(uncommon, keys) now returns plain NULL_REVISION,
1961
# rather than a key tuple. We will just map that directly to no common
1965
next_lcas = self.graph.find_lca(*cur_ancestors)
1966
# Map a plain NULL_REVISION to a simple no-ancestors
1967
if next_lcas == set([_mod_revision.NULL_REVISION]):
1969
# Order the lca's based on when they were merged into the tip
1970
# While the actual merge portion of weave merge uses a set() of
1971
# active revisions, the order of insertion *does* effect the
1972
# implicit ordering of the texts.
1973
for rev_key in cur_ancestors:
1974
ordered_parents = tuple(self.graph.find_merge_order(rev_key,
1976
parent_map[rev_key] = ordered_parents
1977
if len(next_lcas) == 0:
1979
elif len(next_lcas) == 1:
1980
parent_map[list(next_lcas)[0]] = ()
1982
elif len(next_lcas) > 2:
1983
# More than 2 lca's, fall back to grabbing all nodes between
1984
# this and the unique lca.
1985
trace.mutter('More than 2 LCAs, falling back to all nodes for:'
1987
self.a_key, self.b_key, cur_ancestors)
1988
cur_lcas = next_lcas
1989
while len(cur_lcas) > 1:
1990
cur_lcas = self.graph.find_lca(*cur_lcas)
1991
if len(cur_lcas) == 0:
1992
# No common base to find, use the full ancestry
1995
unique_lca = list(cur_lcas)[0]
1996
if unique_lca == _mod_revision.NULL_REVISION:
1997
# find_lca will return a plain 'NULL_REVISION' rather
1998
# than a key tuple when there is no common ancestor, we
1999
# prefer to just use None, because it doesn't confuse
2000
# _get_interesting_texts()
2002
parent_map.update(self._find_unique_parents(next_lcas,
2005
cur_ancestors = next_lcas
2008
def _find_unique_parents(self, tip_keys, base_key):
2009
"""Find ancestors of tip that aren't ancestors of base.
2011
:param tip_keys: Nodes that are interesting
2012
:param base_key: Cull all ancestors of this node
2013
:return: The parent map for all revisions between tip_keys and
2014
base_key. base_key will be included. References to nodes outside of
2015
the ancestor set will also be removed.
2017
# TODO: this would be simpler if find_unique_ancestors took a list
2018
# instead of a single tip, internally it supports it, but it
2019
# isn't a "backwards compatible" api change.
2020
if base_key is None:
2021
parent_map = dict(self.graph.iter_ancestry(tip_keys))
2022
# We remove NULL_REVISION because it isn't a proper tuple key, and
2023
# thus confuses things like _get_interesting_texts, and our logic
2024
# to add the texts into the memory weave.
2025
if _mod_revision.NULL_REVISION in parent_map:
2026
parent_map.pop(_mod_revision.NULL_REVISION)
2029
for tip in tip_keys:
2031
self.graph.find_unique_ancestors(tip, [base_key]))
2032
parent_map = self.graph.get_parent_map(interesting)
2033
parent_map[base_key] = ()
2034
culled_parent_map, child_map, tails = self._remove_external_references(
2036
# Remove all the tails but base_key
2037
if base_key is not None:
2038
tails.remove(base_key)
2039
self._prune_tails(culled_parent_map, child_map, tails)
2040
# Now remove all the uninteresting 'linear' regions
2041
simple_map = _mod_graph.collapse_linear_regions(culled_parent_map)
2045
def _remove_external_references(parent_map):
2046
"""Remove references that go outside of the parent map.
2048
:param parent_map: Something returned from Graph.get_parent_map(keys)
2049
:return: (filtered_parent_map, child_map, tails)
2050
filtered_parent_map is parent_map without external references
2051
child_map is the {parent_key: [child_keys]} mapping
2052
tails is a list of nodes that do not have any parents in the map
2054
# TODO: The basic effect of this function seems more generic than
2055
# _PlanMerge. But the specific details of building a child_map,
2056
# and computing tails seems very specific to _PlanMerge.
2057
# Still, should this be in Graph land?
2058
filtered_parent_map = {}
2061
for key, parent_keys in parent_map.iteritems():
2062
culled_parent_keys = [p for p in parent_keys if p in parent_map]
2063
if not culled_parent_keys:
2065
for parent_key in culled_parent_keys:
2066
child_map.setdefault(parent_key, []).append(key)
2067
# TODO: Do we want to do this, it adds overhead for every node,
2068
# just to say that the node has no children
2069
child_map.setdefault(key, [])
2070
filtered_parent_map[key] = culled_parent_keys
2071
return filtered_parent_map, child_map, tails
2074
def _prune_tails(parent_map, child_map, tails_to_remove):
2075
"""Remove tails from the parent map.
2077
This will remove the supplied revisions until no more children have 0
2080
:param parent_map: A dict of {child: [parents]}, this dictionary will
2081
be modified in place.
2082
:param tails_to_remove: A list of tips that should be removed,
2083
this list will be consumed
2084
:param child_map: The reverse dict of parent_map ({parent: [children]})
2085
this dict will be modified
2086
:return: None, parent_map will be modified in place.
2088
while tails_to_remove:
2089
next = tails_to_remove.pop()
2090
parent_map.pop(next)
2091
children = child_map.pop(next)
2092
for child in children:
2093
child_parents = parent_map[child]
2094
child_parents.remove(next)
2095
if len(child_parents) == 0:
2096
tails_to_remove.append(child)
2098
def _get_interesting_texts(self, parent_map):
2099
"""Return a dict of texts we are interested in.
2101
Note that the input is in key tuples, but the output is in plain
2104
:param parent_map: The output from _find_recursive_lcas
2105
:return: A dict of {'revision_id':lines} as returned by
2106
_PlanMergeBase.get_lines()
2108
all_revision_keys = set(parent_map)
2109
all_revision_keys.add(self.a_key)
2110
all_revision_keys.add(self.b_key)
2112
# Everything else is in 'keys' but get_lines is in 'revision_ids'
2113
all_texts = self.get_lines([k[-1] for k in all_revision_keys])
2116
def _build_weave(self):
2117
from bzrlib import weave
2118
self._weave = weave.Weave(weave_name='in_memory_weave',
2119
allow_reserved=True)
2120
parent_map = self._find_recursive_lcas()
2122
all_texts = self._get_interesting_texts(parent_map)
2124
# Note: Unfortunately, the order given by topo_sort will effect the
2125
# ordering resolution in the output. Specifically, if you add A then B,
2126
# then in the output text A lines will show up before B lines. And, of
2127
# course, topo_sort doesn't guarantee any real ordering.
2128
# So we use merge_sort, and add a fake node on the tip.
2129
# This ensures that left-hand parents will always be inserted into the
2130
# weave before right-hand parents.
2131
tip_key = self._key_prefix + (_mod_revision.CURRENT_REVISION,)
2132
parent_map[tip_key] = (self.a_key, self.b_key)
2134
for seq_num, key, depth, eom in reversed(tsort.merge_sort(parent_map,
2138
# for key in tsort.topo_sort(parent_map):
2139
parent_keys = parent_map[key]
2140
revision_id = key[-1]
2141
parent_ids = [k[-1] for k in parent_keys]
2142
self._weave.add_lines(revision_id, parent_ids,
2143
all_texts[revision_id])
2145
def plan_merge(self):
2146
"""Generate a 'plan' for merging the two revisions.
2148
This involves comparing their texts and determining the cause of
2149
differences. If text A has a line and text B does not, then either the
2150
line was added to text A, or it was deleted from B. Once the causes
2151
are combined, they are written out in the format described in
2152
VersionedFile.plan_merge
2154
if self._head_key is not None: # There was a single head
2155
if self._head_key == self.a_key:
2158
if self._head_key != self.b_key:
2159
raise AssertionError('There was an invalid head: %s != %s'
2160
% (self.b_key, self._head_key))
2162
head_rev = self._head_key[-1]
2163
lines = self.get_lines([head_rev])[head_rev]
2164
return ((plan, line) for line in lines)
2165
return self._weave.plan_merge(self.a_rev, self.b_rev)
1421
2168
class _PlanLCAMerge(_PlanMergeBase):
added
removed
bzrlib/merge.py
