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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
from bzrlib.lazy_import import lazy_import
20
lazy_import(globals(), """
21
22
from bzrlib import (
22
branch as _mod_branch,
23
conflicts as _mod_conflicts,
30
28
revision as _mod_revision,
40
from bzrlib.cleanup import OperationWithCleanups
47
from bzrlib.symbol_versioning import (
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
51
58
# TODO: Report back as changes are merged in
54
61
def transform_tree(from_tree, to_tree, interesting_ids=None):
55
from_tree.lock_tree_write()
56
operation = OperationWithCleanups(merge_inner)
57
operation.add_cleanup(from_tree.unlock)
58
operation.run_simple(from_tree.branch, to_tree, from_tree,
59
ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
62
class MergeHooks(hooks.Hooks):
65
hooks.Hooks.__init__(self)
66
self.create_hook(hooks.HookPoint('merge_file_content',
67
"Called with a bzrlib.merge.Merger object to create a per file "
68
"merge object when starting a merge. "
69
"Should return either None or a subclass of "
70
"``bzrlib.merge.AbstractPerFileMerger``. "
71
"Such objects will then be called per file "
72
"that needs to be merged (including when one "
73
"side has deleted the file and the other has changed it). "
74
"See the AbstractPerFileMerger API docs for details on how it is "
79
class AbstractPerFileMerger(object):
80
"""PerFileMerger objects are used by plugins extending merge for bzrlib.
82
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
84
:ivar merger: The Merge3Merger performing the merge.
87
def __init__(self, merger):
88
"""Create a PerFileMerger for use with merger."""
91
def merge_contents(self, merge_params):
92
"""Attempt to merge the contents of a single file.
94
:param merge_params: A bzrlib.merge.MergeHookParams
95
:return : A tuple of (status, chunks), where status is one of
96
'not_applicable', 'success', 'conflicted', or 'delete'. If status
97
is 'success' or 'conflicted', then chunks should be an iterable of
98
strings for the new file contents.
100
return ('not applicable', None)
103
class PerFileMerger(AbstractPerFileMerger):
104
"""Merge individual files when self.file_matches returns True.
106
This class is intended to be subclassed. The file_matches and
107
merge_matching methods should be overridden with concrete implementations.
110
def file_matches(self, params):
111
"""Return True if merge_matching should be called on this file.
113
Only called with merges of plain files with no clear winner.
115
Subclasses must override this.
117
raise NotImplementedError(self.file_matches)
119
def get_filename(self, params, tree):
120
"""Lookup the filename (i.e. basename, not path), given a Tree (e.g.
121
self.merger.this_tree) and a MergeHookParams.
123
return osutils.basename(tree.id2path(params.file_id))
125
def get_filepath(self, params, tree):
126
"""Calculate the path to the file in a tree.
128
:param params: A MergeHookParams describing the file to merge
129
:param tree: a Tree, e.g. self.merger.this_tree.
131
return tree.id2path(params.file_id)
133
def merge_contents(self, params):
134
"""Merge the contents of a single file."""
135
# Check whether this custom merge logic should be used.
137
# OTHER is a straight winner, rely on default merge.
138
params.winner == 'other' or
139
# THIS and OTHER aren't both files.
140
not params.is_file_merge() or
141
# The filename doesn't match *.xml
142
not self.file_matches(params)):
143
return 'not_applicable', None
144
return self.merge_matching(params)
146
def merge_matching(self, params):
147
"""Merge the contents of a single file that has matched the criteria
148
in PerFileMerger.merge_contents (is a conflict, is a file,
149
self.file_matches is True).
151
Subclasses must override this.
153
raise NotImplementedError(self.merge_matching)
156
class ConfigurableFileMerger(PerFileMerger):
157
"""Merge individual files when configured via a .conf file.
159
This is a base class for concrete custom file merging logic. Concrete
160
classes should implement ``merge_text``.
162
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
164
:ivar affected_files: The configured file paths to merge.
166
:cvar name_prefix: The prefix to use when looking up configuration
167
details. <name_prefix>_merge_files describes the files targeted by the
170
:cvar default_files: The default file paths to merge when no configuration
177
def __init__(self, merger):
178
super(ConfigurableFileMerger, self).__init__(merger)
179
self.affected_files = None
180
self.default_files = self.__class__.default_files or []
181
self.name_prefix = self.__class__.name_prefix
182
if self.name_prefix is None:
183
raise ValueError("name_prefix must be set.")
185
def file_matches(self, params):
186
"""Check whether the file should call the merge hook.
188
<name_prefix>_merge_files configuration variable is a list of files
189
that should use the hook.
191
affected_files = self.affected_files
192
if affected_files is None:
193
config = self.merger.this_branch.get_config()
194
# Until bzr provides a better policy for caching the config, we
195
# just add the part we're interested in to the params to avoid
196
# reading the config files repeatedly (bazaar.conf, location.conf,
198
config_key = self.name_prefix + '_merge_files'
199
affected_files = config.get_user_option_as_list(config_key)
200
if affected_files is None:
201
# If nothing was specified in the config, use the default.
202
affected_files = self.default_files
203
self.affected_files = affected_files
205
filepath = self.get_filepath(params, self.merger.this_tree)
206
if filepath in affected_files:
210
def merge_matching(self, params):
211
return self.merge_text(params)
213
def merge_text(self, params):
214
"""Merge the byte contents of a single file.
216
This is called after checking that the merge should be performed in
217
merge_contents, and it should behave as per
218
``bzrlib.merge.AbstractPerFileMerger.merge_contents``.
220
raise NotImplementedError(self.merge_text)
223
class MergeHookParams(object):
224
"""Object holding parameters passed to merge_file_content hooks.
226
There are some fields hooks can access:
228
:ivar file_id: the file ID of the file being merged
229
:ivar trans_id: the transform ID for the merge of this file
230
:ivar this_kind: kind of file_id in 'this' tree
231
:ivar other_kind: kind of file_id in 'other' tree
232
:ivar winner: one of 'this', 'other', 'conflict'
235
def __init__(self, merger, file_id, trans_id, this_kind, other_kind,
237
self._merger = merger
238
self.file_id = file_id
239
self.trans_id = trans_id
240
self.this_kind = this_kind
241
self.other_kind = other_kind
244
def is_file_merge(self):
245
"""True if this_kind and other_kind are both 'file'."""
246
return self.this_kind == 'file' and self.other_kind == 'file'
248
@decorators.cachedproperty
249
def base_lines(self):
250
"""The lines of the 'base' version of the file."""
251
return self._merger.get_lines(self._merger.base_tree, self.file_id)
253
@decorators.cachedproperty
254
def this_lines(self):
255
"""The lines of the 'this' version of the file."""
256
return self._merger.get_lines(self._merger.this_tree, self.file_id)
258
@decorators.cachedproperty
259
def other_lines(self):
260
"""The lines of the 'other' version of the file."""
261
return self._merger.get_lines(self._merger.other_tree, self.file_id)
62
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
63
interesting_ids=interesting_ids, this_tree=from_tree)
264
66
class Merger(object):
268
67
def __init__(self, this_branch, other_tree=None, base_tree=None,
269
this_tree=None, pb=None, change_reporter=None,
68
this_tree=None, pb=DummyProgress(), change_reporter=None,
270
69
recurse='down', revision_graph=None):
271
70
object.__init__(self)
272
71
self.this_branch = this_branch
464
239
if self.this_rev_id is None:
465
240
if self.this_basis_tree.get_file_sha1(file_id) != \
466
241
self.this_tree.get_file_sha1(file_id):
467
raise errors.WorkingTreeNotRevision(self.this_tree)
242
raise WorkingTreeNotRevision(self.this_tree)
469
244
trees = (self.this_basis_tree, self.other_tree)
470
245
return [get_id(tree, file_id) for tree in trees]
472
@deprecated_method(deprecated_in((2, 1, 0)))
473
247
def check_basis(self, check_clean, require_commits=True):
474
248
if self.this_basis is None and require_commits is True:
475
raise errors.BzrCommandError(
476
"This branch has no commits."
477
" (perhaps you would prefer 'bzr pull')")
249
raise BzrCommandError("This branch has no commits."
250
" (perhaps you would prefer 'bzr pull')")
479
252
self.compare_basis()
480
253
if self.this_basis != self.this_rev_id:
481
254
raise errors.UncommittedChanges(self.this_tree)
483
@deprecated_method(deprecated_in((2, 1, 0)))
484
256
def compare_basis(self):
486
258
basis_tree = self.revision_tree(self.this_tree.last_revision())
487
except errors.NoSuchRevision:
259
except errors.RevisionNotPresent:
488
260
basis_tree = self.this_tree.basis_tree()
489
if not self.this_tree.has_changes(basis_tree):
261
changes = self.this_tree.changes_from(basis_tree)
262
if not changes.has_changed():
490
263
self.this_rev_id = self.this_basis
492
265
def set_interesting_files(self, file_list):
493
266
self.interesting_files = file_list
495
268
def set_pending(self):
496
if (not self.base_is_ancestor or not self.base_is_other_ancestor
497
or self.other_rev_id is None):
269
if not self.base_is_ancestor or not self.base_is_other_ancestor or self.other_rev_id is None:
499
271
self._add_parent()
501
273
def _add_parent(self):
502
274
new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
503
275
new_parent_trees = []
504
operation = OperationWithCleanups(self.this_tree.set_parent_trees)
505
276
for revision_id in new_parents:
507
278
tree = self.revision_tree(revision_id)
508
except errors.NoSuchRevision:
279
except errors.RevisionNotPresent:
512
operation.add_cleanup(tree.unlock)
513
283
new_parent_trees.append((revision_id, tree))
514
operation.run_simple(new_parent_trees, allow_leftmost_as_ghost=True)
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:
516
292
def set_other(self, other_revision, possible_transports=None):
517
293
"""Set the revision and tree to merge from.
568
344
target.fetch(source, revision_id)
570
346
def find_base(self):
571
revisions = [_mod_revision.ensure_null(self.this_basis),
572
_mod_revision.ensure_null(self.other_basis)]
573
if _mod_revision.NULL_REVISION in revisions:
574
self.base_rev_id = _mod_revision.NULL_REVISION
575
self.base_tree = self.revision_tree(self.base_rev_id)
576
self._is_criss_cross = False
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
578
lcas = self.revision_graph.find_lca(revisions[0], revisions[1])
579
self._is_criss_cross = False
581
self.base_rev_id = _mod_revision.NULL_REVISION
583
self.base_rev_id = list(lcas)[0]
584
else: # len(lcas) > 1
586
# find_unique_lca can only handle 2 nodes, so we have to
587
# start back at the beginning. It is a shame to traverse
588
# the graph again, but better than re-implementing
590
self.base_rev_id = self.revision_graph.find_unique_lca(
591
revisions[0], revisions[1])
593
self.base_rev_id = self.revision_graph.find_unique_lca(
595
self._is_criss_cross = True
596
if self.base_rev_id == _mod_revision.NULL_REVISION:
597
raise errors.UnrelatedBranches()
598
if self._is_criss_cross:
599
trace.warning('Warning: criss-cross merge encountered. See bzr'
600
' help criss-cross.')
601
trace.mutter('Criss-cross lcas: %r' % lcas)
602
interesting_revision_ids = [self.base_rev_id]
603
interesting_revision_ids.extend(lcas)
604
interesting_trees = dict((t.get_revision_id(), t)
605
for t in self.this_branch.repository.revision_trees(
606
interesting_revision_ids))
607
self._cached_trees.update(interesting_trees)
608
self.base_tree = interesting_trees.pop(self.base_rev_id)
609
sorted_lca_keys = self.revision_graph.find_merge_order(
611
self._lca_trees = [interesting_trees[key]
612
for key in sorted_lca_keys]
614
self.base_tree = self.revision_tree(self.base_rev_id)
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)
615
360
self.base_is_ancestor = True
616
361
self.base_is_other_ancestor = True
617
trace.mutter('Base revid: %r' % self.base_rev_id)
619
363
def set_base(self, base_revision):
620
364
"""Set the base revision to use for the merge.
622
366
:param base_revision: A 2-list containing a path and revision number.
624
trace.mutter("doing merge() with no base_revision specified")
368
mutter("doing merge() with no base_revision specified")
625
369
if base_revision == [None, None]:
640
384
'other_tree': self.other_tree,
641
385
'interesting_ids': self.interesting_ids,
642
386
'interesting_files': self.interesting_files,
643
'this_branch': self.this_branch,
644
388
'do_merge': False}
645
389
if self.merge_type.requires_base:
646
390
kwargs['base_tree'] = self.base_tree
647
391
if self.merge_type.supports_reprocess:
648
392
kwargs['reprocess'] = self.reprocess
649
393
elif self.reprocess:
650
raise errors.BzrError(
651
"Conflict reduction is not supported for merge"
652
" type %s." % self.merge_type)
394
raise BzrError("Conflict reduction is not supported for merge"
395
" type %s." % self.merge_type)
653
396
if self.merge_type.supports_show_base:
654
397
kwargs['show_base'] = self.show_base
655
398
elif self.show_base:
656
raise errors.BzrError("Showing base is not supported for this"
657
" merge type. %s" % self.merge_type)
399
raise BzrError("Showing base is not supported for this"
400
" merge type. %s" % self.merge_type)
658
401
if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
659
402
and not self.base_is_other_ancestor):
660
403
raise errors.CannotReverseCherrypick()
661
404
if self.merge_type.supports_cherrypick:
662
405
kwargs['cherrypick'] = (not self.base_is_ancestor or
663
406
not self.base_is_other_ancestor)
664
if self._is_criss_cross and getattr(self.merge_type,
665
'supports_lca_trees', False):
666
kwargs['lca_trees'] = self._lca_trees
667
return self.merge_type(pb=None,
407
return self.merge_type(pb=self._pb,
668
408
change_reporter=self.change_reporter,
671
def _do_merge_to(self):
672
merge = self.make_merger()
673
if self.other_branch is not None:
674
self.other_branch.update_references(self.this_branch)
676
if self.recurse == 'down':
677
for relpath, file_id in self.this_tree.iter_references():
678
sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
679
other_revision = self.other_tree.get_reference_revision(
681
if other_revision == sub_tree.last_revision():
683
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
684
sub_merge.merge_type = self.merge_type
685
other_branch = self.other_branch.reference_parent(file_id, relpath)
686
sub_merge.set_other_revision(other_revision, other_branch)
687
base_revision = self.base_tree.get_reference_revision(file_id)
688
sub_merge.base_tree = \
689
sub_tree.branch.repository.revision_tree(base_revision)
690
sub_merge.base_rev_id = base_revision
694
411
def do_merge(self):
695
operation = OperationWithCleanups(self._do_merge_to)
696
412
self.this_tree.lock_tree_write()
697
operation.add_cleanup(self.this_tree.unlock)
698
413
if self.base_tree is not None:
699
414
self.base_tree.lock_read()
700
operation.add_cleanup(self.base_tree.unlock)
701
415
if self.other_tree is not None:
702
416
self.other_tree.lock_read()
703
operation.add_cleanup(self.other_tree.unlock)
704
merge = operation.run_simple()
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()
705
444
if len(merge.cooked_conflicts) == 0:
706
if not self.ignore_zero and not trace.is_quiet():
707
trace.note("All changes applied successfully.")
445
if not self.ignore_zero and not is_quiet():
446
note("All changes applied successfully.")
709
trace.note("%d conflicts encountered."
710
% len(merge.cooked_conflicts))
448
note("%d conflicts encountered." % len(merge.cooked_conflicts))
712
450
return len(merge.cooked_conflicts)
715
class _InventoryNoneEntry(object):
716
"""This represents an inventory entry which *isn't there*.
718
It simplifies the merging logic if we always have an InventoryEntry, even
719
if it isn't actually present
726
symlink_target = None
729
_none_entry = _InventoryNoneEntry()
732
453
class Merge3Merger(object):
733
454
"""Three-way merger that uses the merge3 text merger"""
734
455
requires_base = True
768
486
be combined with interesting_ids. If neither interesting_files nor
769
487
interesting_ids is specified, all files may participate in the
771
:param lca_trees: Can be set to a dictionary of {revision_id:rev_tree}
772
if the ancestry was found to include a criss-cross merge.
773
Otherwise should be None.
775
490
object.__init__(self)
776
491
if interesting_files is not None and interesting_ids is not None:
777
492
raise ValueError(
778
493
'specify either interesting_ids or interesting_files')
779
if this_branch is None:
780
this_branch = this_tree.branch
781
494
self.interesting_ids = interesting_ids
782
495
self.interesting_files = interesting_files
783
496
self.this_tree = working_tree
784
497
self.base_tree = base_tree
785
498
self.other_tree = other_tree
786
self.this_branch = this_branch
787
499
self._raw_conflicts = []
788
500
self.cooked_conflicts = []
789
501
self.reprocess = reprocess
790
502
self.show_base = show_base
791
self._lca_trees = lca_trees
792
# Uncommenting this will change the default algorithm to always use
793
# _entries_lca. This can be useful for running the test suite and
794
# making sure we haven't missed any corner cases.
795
# if lca_trees is None:
796
# self._lca_trees = [self.base_tree]
797
505
self.change_reporter = change_reporter
798
506
self.cherrypick = cherrypick
508
self.pp = ProgressPhase("Merge phase", 3, self.pb)
802
warnings.warn("pp argument to Merge3Merger is deprecated")
804
warnings.warn("pb argument to Merge3Merger is deprecated")
806
512
def do_merge(self):
807
operation = OperationWithCleanups(self._do_merge)
808
513
self.this_tree.lock_tree_write()
809
operation.add_cleanup(self.this_tree.unlock)
810
514
self.base_tree.lock_read()
811
operation.add_cleanup(self.base_tree.unlock)
812
515
self.other_tree.lock_read()
813
operation.add_cleanup(self.other_tree.unlock)
816
def _do_merge(self, operation):
817
self.tt = transform.TreeTransform(self.this_tree, None)
818
operation.add_cleanup(self.tt.finalize)
819
self._compute_transform()
820
results = self.tt.apply(no_conflicts=True)
821
self.write_modified(results)
516
self.tt = TreeTransform(self.this_tree, self.pb)
823
self.this_tree.add_conflicts(self.cooked_conflicts)
824
except errors.UnsupportedOperation:
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()
827
534
def make_preview_transform(self):
828
operation = OperationWithCleanups(self._make_preview_transform)
829
535
self.base_tree.lock_read()
830
operation.add_cleanup(self.base_tree.unlock)
831
536
self.other_tree.lock_read()
832
operation.add_cleanup(self.other_tree.unlock)
833
return operation.run_simple()
835
def _make_preview_transform(self):
836
self.tt = transform.TransformPreview(self.this_tree)
837
self._compute_transform()
537
self.tt = TransformPreview(self.this_tree)
540
self._compute_transform()
543
self.other_tree.unlock()
544
self.base_tree.unlock()
840
548
def _compute_transform(self):
841
if self._lca_trees is None:
842
entries = self._entries3()
843
resolver = self._three_way
845
entries = self._entries_lca()
846
resolver = self._lca_multi_way
549
entries = self._entries3()
847
550
child_pb = ui.ui_factory.nested_progress_bar()
849
factories = Merger.hooks['merge_file_content']
850
hooks = [factory(self) for factory in factories] + [self]
851
self.active_hooks = [hook for hook in hooks if hook is not None]
852
552
for num, (file_id, changed, parents3, names3,
853
553
executable3) in enumerate(entries):
854
554
child_pb.update('Preparing file merge', num, len(entries))
855
self._merge_names(file_id, parents3, names3, resolver=resolver)
555
self._merge_names(file_id, parents3, names3)
857
file_status = self._do_merge_contents(file_id)
557
file_status = self.merge_contents(file_id)
859
559
file_status = 'unmodified'
860
560
self._merge_executable(file_id,
861
executable3, file_status, resolver=resolver)
561
executable3, file_status)
863
563
child_pb.finished()
865
self._finish_computing_transform()
867
def _finish_computing_transform(self):
868
"""Finalize the transform and report the changes.
870
This is the second half of _compute_transform.
872
566
child_pb = ui.ui_factory.nested_progress_bar()
874
fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
875
lambda t, c: transform.conflict_pass(t, c, self.other_tree))
568
fs_conflicts = resolve_conflicts(self.tt, child_pb,
569
lambda t, c: conflict_pass(t, c, self.other_tree))
877
571
child_pb.finished()
878
572
if self.change_reporter is not None:
919
610
result.append((file_id, changed, parents3, names3, executable3))
922
def _entries_lca(self):
923
"""Gather data about files modified between multiple trees.
925
This compares OTHER versus all LCA trees, and for interesting entries,
926
it then compares with THIS and BASE.
928
For the multi-valued entries, the format will be (BASE, [lca1, lca2])
929
:return: [(file_id, changed, parents, names, executable)]
930
file_id Simple file_id of the entry
931
changed Boolean, True if the kind or contents changed
933
parents ((base, [parent_id, in, lcas]), parent_id_other,
935
names ((base, [name, in, lcas]), name_in_other, name_in_this)
936
executable ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
938
if self.interesting_files is not None:
939
lookup_trees = [self.this_tree, self.base_tree]
940
lookup_trees.extend(self._lca_trees)
941
# I think we should include the lca trees as well
942
interesting_ids = self.other_tree.paths2ids(self.interesting_files,
945
interesting_ids = self.interesting_ids
947
walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
949
base_inventory = self.base_tree.inventory
950
this_inventory = self.this_tree.inventory
951
for path, file_id, other_ie, lca_values in walker.iter_all():
952
# Is this modified at all from any of the other trees?
954
other_ie = _none_entry
955
if interesting_ids is not None and file_id not in interesting_ids:
958
# If other_revision is found in any of the lcas, that means this
959
# node is uninteresting. This is because when merging, if there are
960
# multiple heads(), we have to create a new node. So if we didn't,
961
# we know that the ancestry is linear, and that OTHER did not
963
# See doc/developers/lca_merge_resolution.txt for details
964
other_revision = other_ie.revision
965
if other_revision is not None:
966
# We can't use this shortcut when other_revision is None,
967
# because it may be None because things are WorkingTrees, and
968
# not because it is *actually* None.
969
is_unmodified = False
970
for lca_path, ie in lca_values:
971
if ie is not None and ie.revision == other_revision:
978
for lca_path, lca_ie in lca_values:
980
lca_entries.append(_none_entry)
982
lca_entries.append(lca_ie)
984
if file_id in base_inventory:
985
base_ie = base_inventory[file_id]
987
base_ie = _none_entry
989
if file_id in this_inventory:
990
this_ie = this_inventory[file_id]
992
this_ie = _none_entry
998
for lca_ie in lca_entries:
999
lca_kinds.append(lca_ie.kind)
1000
lca_parent_ids.append(lca_ie.parent_id)
1001
lca_names.append(lca_ie.name)
1002
lca_executable.append(lca_ie.executable)
1004
kind_winner = self._lca_multi_way(
1005
(base_ie.kind, lca_kinds),
1006
other_ie.kind, this_ie.kind)
1007
parent_id_winner = self._lca_multi_way(
1008
(base_ie.parent_id, lca_parent_ids),
1009
other_ie.parent_id, this_ie.parent_id)
1010
name_winner = self._lca_multi_way(
1011
(base_ie.name, lca_names),
1012
other_ie.name, this_ie.name)
1014
content_changed = True
1015
if kind_winner == 'this':
1016
# No kind change in OTHER, see if there are *any* changes
1017
if other_ie.kind == 'directory':
1018
if parent_id_winner == 'this' and name_winner == 'this':
1019
# No change for this directory in OTHER, skip
1021
content_changed = False
1022
elif other_ie.kind is None or other_ie.kind == 'file':
1023
def get_sha1(ie, tree):
1024
if ie.kind != 'file':
1026
return tree.get_file_sha1(file_id)
1027
base_sha1 = get_sha1(base_ie, self.base_tree)
1028
lca_sha1s = [get_sha1(ie, tree) for ie, tree
1029
in zip(lca_entries, self._lca_trees)]
1030
this_sha1 = get_sha1(this_ie, self.this_tree)
1031
other_sha1 = get_sha1(other_ie, self.other_tree)
1032
sha1_winner = self._lca_multi_way(
1033
(base_sha1, lca_sha1s), other_sha1, this_sha1,
1034
allow_overriding_lca=False)
1035
exec_winner = self._lca_multi_way(
1036
(base_ie.executable, lca_executable),
1037
other_ie.executable, this_ie.executable)
1038
if (parent_id_winner == 'this' and name_winner == 'this'
1039
and sha1_winner == 'this' and exec_winner == 'this'):
1040
# No kind, parent, name, exec, or content change for
1041
# OTHER, so this node is not considered interesting
1043
if sha1_winner == 'this':
1044
content_changed = False
1045
elif other_ie.kind == 'symlink':
1046
def get_target(ie, tree):
1047
if ie.kind != 'symlink':
1049
return tree.get_symlink_target(file_id)
1050
base_target = get_target(base_ie, self.base_tree)
1051
lca_targets = [get_target(ie, tree) for ie, tree
1052
in zip(lca_entries, self._lca_trees)]
1053
this_target = get_target(this_ie, self.this_tree)
1054
other_target = get_target(other_ie, self.other_tree)
1055
target_winner = self._lca_multi_way(
1056
(base_target, lca_targets),
1057
other_target, this_target)
1058
if (parent_id_winner == 'this' and name_winner == 'this'
1059
and target_winner == 'this'):
1060
# No kind, parent, name, or symlink target change
1063
if target_winner == 'this':
1064
content_changed = False
1065
elif other_ie.kind == 'tree-reference':
1066
# The 'changed' information seems to be handled at a higher
1067
# level. At least, _entries3 returns False for content
1068
# changed, even when at a new revision_id.
1069
content_changed = False
1070
if (parent_id_winner == 'this' and name_winner == 'this'):
1071
# Nothing interesting
1074
raise AssertionError('unhandled kind: %s' % other_ie.kind)
1076
# If we have gotten this far, that means something has changed
1077
result.append((file_id, content_changed,
1078
((base_ie.parent_id, lca_parent_ids),
1079
other_ie.parent_id, this_ie.parent_id),
1080
((base_ie.name, lca_names),
1081
other_ie.name, this_ie.name),
1082
((base_ie.executable, lca_executable),
1083
other_ie.executable, this_ie.executable)
1087
613
def fix_root(self):
1089
615
self.tt.final_kind(self.tt.root)
1090
except errors.NoSuchFile:
1091
617
self.tt.cancel_deletion(self.tt.root)
1092
618
if self.tt.final_file_id(self.tt.root) is None:
1093
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
619
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
621
if self.other_tree.inventory.root is None:
1095
623
other_root_file_id = self.other_tree.get_root_id()
1096
if other_root_file_id is None:
1098
624
other_root = self.tt.trans_id_file_id(other_root_file_id)
1099
625
if other_root == self.tt.root:
1101
if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
1102
# the other tree's root is a non-root in the current tree (as when
1103
# a previously unrelated branch is merged into another)
1106
628
self.tt.final_kind(other_root)
1107
other_root_is_present = True
1108
except errors.NoSuchFile:
1109
# other_root doesn't have a physical representation. We still need
1110
# to move any references to the actual root of the tree.
1111
other_root_is_present = False
1112
# 'other_tree.inventory.root' is not present in this tree. We are
1113
# calling adjust_path for children which *want* to be present with a
1114
# correct place to go.
1115
for thing, child in self.other_tree.inventory.root.children.iteritems():
631
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
632
self.tt.cancel_creation(other_root)
633
self.tt.cancel_versioning(other_root)
635
def reparent_children(self, ie, target):
636
for thing, child in ie.children.iteritems():
1116
637
trans_id = self.tt.trans_id_file_id(child.file_id)
1117
if not other_root_is_present:
1118
# FIXME: Make final_kind returns None instead of raising
1119
# NoSuchFile to avoid the ugly construct below -- vila 20100402
1121
self.tt.final_kind(trans_id)
1122
# The item exist in the final tree and has a defined place
1125
except errors.NoSuchFile, e:
1127
# Move the item into the root
1128
self.tt.adjust_path(self.tt.final_name(trans_id),
1129
self.tt.root, trans_id)
1130
if other_root_is_present:
1131
self.tt.cancel_creation(other_root)
1132
self.tt.cancel_versioning(other_root)
638
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
1134
640
def write_modified(self, results):
1135
641
modified_hashes = {}
1177
683
def kind(tree, file_id):
1178
684
"""Determine the kind of a file-id (used as a key method)."""
1179
if not tree.has_id(file_id):
685
if file_id not in tree:
1181
687
return tree.kind(file_id)
1184
690
def _three_way(base, other, this):
691
#if base == other, either they all agree, or only THIS has changed.
1185
692
if base == other:
1186
# if 'base == other', either they all agree, or only 'this' has
1189
694
elif this not in (base, other):
1190
# 'this' is neither 'base' nor 'other', so both sides changed
1191
695
return 'conflict'
696
# "Ambiguous clean merge" -- both sides have made the same change.
1192
697
elif this == other:
1193
# "Ambiguous clean merge" -- both sides have made the same change.
699
# this == base: only other has changed.
1196
# this == base: only other has changed.
1200
def _lca_multi_way(bases, other, this, allow_overriding_lca=True):
1201
"""Consider LCAs when determining whether a change has occurred.
1203
If LCAS are all identical, this is the same as a _three_way comparison.
1205
:param bases: value in (BASE, [LCAS])
1206
:param other: value in OTHER
1207
:param this: value in THIS
1208
:param allow_overriding_lca: If there is more than one unique lca
1209
value, allow OTHER to override THIS if it has a new value, and
1210
THIS only has an lca value, or vice versa. This is appropriate for
1211
truly scalar values, not as much for non-scalars.
1212
:return: 'this', 'other', or 'conflict' depending on whether an entry
1215
# See doc/developers/lca_tree_merging.txt for details about this
1218
# Either Ambiguously clean, or nothing was actually changed. We
1221
base_val, lca_vals = bases
1222
# Remove 'base_val' from the lca_vals, because it is not interesting
1223
filtered_lca_vals = [lca_val for lca_val in lca_vals
1224
if lca_val != base_val]
1225
if len(filtered_lca_vals) == 0:
1226
return Merge3Merger._three_way(base_val, other, this)
1228
unique_lca_vals = set(filtered_lca_vals)
1229
if len(unique_lca_vals) == 1:
1230
return Merge3Merger._three_way(unique_lca_vals.pop(), other, this)
1232
if allow_overriding_lca:
1233
if other in unique_lca_vals:
1234
if this in unique_lca_vals:
1235
# Each side picked a different lca, conflict
1238
# This has a value which supersedes both lca values, and
1239
# other only has an lca value
1241
elif this in unique_lca_vals:
1242
# OTHER has a value which supersedes both lca values, and this
1243
# only has an lca value
1246
# At this point, the lcas disagree, and the tip disagree
1250
@deprecated_method(deprecated_in((2, 2, 0)))
1251
704
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
1252
705
"""Do a three-way test on a scalar.
1253
706
Return "this", "other" or "conflict", depending whether a value wins.
1338
790
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))
1340
804
# See SPOT run. run, SPOT, run.
1341
805
# So we're not QUITE repeating ourselves; we do tricky things with
1343
807
base_pair = contents_pair(self.base_tree)
1344
808
other_pair = contents_pair(self.other_tree)
1346
this_pair = contents_pair(self.this_tree)
1347
lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1348
winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1349
this_pair, allow_overriding_lca=False)
1351
if base_pair == other_pair:
1354
# We delayed evaluating this_pair as long as we can to avoid
1355
# unnecessary sha1 calculation
1356
this_pair = contents_pair(self.this_tree)
1357
winner = self._three_way(base_pair, other_pair, this_pair)
1358
if winner == 'this':
1359
# No interesting changes introduced by OTHER
1361
# We have a hypothetical conflict, but if we have files, then we
1362
# can try to merge the content
1363
trans_id = self.tt.trans_id_file_id(file_id)
1364
params = MergeHookParams(self, file_id, trans_id, this_pair[0],
1365
other_pair[0], winner)
1366
hooks = self.active_hooks
1367
hook_status = 'not_applicable'
1369
hook_status, lines = hook.merge_contents(params)
1370
if hook_status != 'not_applicable':
1371
# Don't try any more hooks, this one applies.
1374
if hook_status == 'not_applicable':
1375
# This is a contents conflict, because none of the available
1376
# functions could merge it.
1378
name = self.tt.final_name(trans_id)
1379
parent_id = self.tt.final_parent(trans_id)
1380
if self.this_tree.has_id(file_id):
1381
self.tt.unversion_file(trans_id)
1382
file_group = self._dump_conflicts(name, parent_id, file_id,
1384
self._raw_conflicts.append(('contents conflict', file_group))
1385
elif hook_status == 'success':
1386
self.tt.create_file(lines, trans_id)
1387
elif hook_status == 'conflicted':
1388
# XXX: perhaps the hook should be able to provide
1389
# the BASE/THIS/OTHER files?
1390
self.tt.create_file(lines, trans_id)
1391
self._raw_conflicts.append(('text conflict', trans_id))
1392
name = self.tt.final_name(trans_id)
1393
parent_id = self.tt.final_parent(trans_id)
1394
self._dump_conflicts(name, parent_id, file_id)
1395
elif hook_status == 'delete':
1396
self.tt.unversion_file(trans_id)
1398
elif hook_status == 'done':
1399
# The hook function did whatever it needs to do directly, no
1400
# further action needed here.
1403
raise AssertionError('unknown hook_status: %r' % (hook_status,))
1404
if not self.this_tree.has_id(file_id) and result == "modified":
1405
self.tt.version_file(file_id, trans_id)
1406
# The merge has been performed, so the old contents should not be
1409
self.tt.delete_contents(trans_id)
1410
except errors.NoSuchFile:
1414
def _default_other_winner_merge(self, merge_hook_params):
1415
"""Replace this contents with other."""
1416
file_id = merge_hook_params.file_id
1417
trans_id = merge_hook_params.trans_id
1418
file_in_this = self.this_tree.has_id(file_id)
1419
if self.other_tree.has_id(file_id):
1420
# OTHER changed the file
1422
if wt.supports_content_filtering():
1423
# We get the path from the working tree if it exists.
1424
# That fails though when OTHER is adding a file, so
1425
# we fall back to the other tree to find the path if
1426
# it doesn't exist locally.
1428
filter_tree_path = wt.id2path(file_id)
1429
except errors.NoSuchId:
1430
filter_tree_path = self.other_tree.id2path(file_id)
1432
# Skip the id2path lookup for older formats
1433
filter_tree_path = None
1434
transform.create_from_tree(self.tt, trans_id,
1435
self.other_tree, file_id,
1436
filter_tree_path=filter_tree_path)
1439
# OTHER deleted the file
1440
return 'delete', None
1442
raise AssertionError(
1443
'winner is OTHER, but file_id %r not in THIS or OTHER tree'
1446
def merge_contents(self, merge_hook_params):
1447
"""Fallback merge logic after user installed hooks."""
1448
# This function is used in merge hooks as the fallback instance.
1449
# Perhaps making this function and the functions it calls be a
1450
# a separate class would be better.
1451
if merge_hook_params.winner == 'other':
1452
# OTHER is a straight winner, so replace this contents with other
1453
return self._default_other_winner_merge(merge_hook_params)
1454
elif merge_hook_params.is_file_merge():
1455
# THIS and OTHER are both files, so text merge. Either
1456
# BASE is a file, or both converted to files, so at least we
1457
# have agreement that output should be a file.
1459
self.text_merge(merge_hook_params.file_id,
1460
merge_hook_params.trans_id)
1461
except errors.BinaryFile:
1462
return 'not_applicable', None
1465
return 'not_applicable', None
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()
1467
856
def get_lines(self, tree, file_id):
1468
857
"""Return the lines in a file, or an empty list."""
1469
if tree.has_id(file_id):
1470
return tree.get_file_lines(file_id)
859
return tree.get_file(file_id).readlines()
1523
912
determined automatically. If set_version is true, the .OTHER, .THIS
1524
913
or .BASE (in that order) will be created as versioned files.
1526
data = [('OTHER', self.other_tree, other_lines),
915
data = [('OTHER', self.other_tree, other_lines),
1527
916
('THIS', self.this_tree, this_lines)]
1529
918
data.append(('BASE', self.base_tree, base_lines))
1531
# We need to use the actual path in the working tree of the file here,
1532
# ignoring the conflict suffixes
1534
if wt.supports_content_filtering():
1536
filter_tree_path = wt.id2path(file_id)
1537
except errors.NoSuchId:
1538
# file has been deleted
1539
filter_tree_path = None
1541
# Skip the id2path lookup for older formats
1542
filter_tree_path = None
1544
919
versioned = False
1546
921
for suffix, tree, lines in data:
1547
if tree.has_id(file_id):
1548
923
trans_id = self._conflict_file(name, parent_id, tree, file_id,
1549
suffix, lines, filter_tree_path)
1550
925
file_group.append(trans_id)
1551
926
if set_version and not versioned:
1552
927
self.tt.version_file(file_id, trans_id)
1553
928
versioned = True
1554
929
return file_group
1556
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1557
lines=None, filter_tree_path=None):
931
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1558
933
"""Emit a single conflict file."""
1559
934
name = name + '.' + suffix
1560
935
trans_id = self.tt.create_path(name, parent_id)
1561
transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
936
entry = tree.inventory[file_id]
937
create_by_entry(self.tt, entry, tree, trans_id, lines)
1565
940
def merge_executable(self, file_id, file_status):
1566
941
"""Perform a merge on the execute bit."""
1567
942
executable = [self.executable(t, file_id) for t in (self.base_tree,
1568
943
self.other_tree, self.this_tree)]
1569
self._merge_executable(file_id, executable, file_status,
1570
resolver=self._three_way)
944
self._merge_executable(file_id, executable, file_status)
1572
def _merge_executable(self, file_id, executable, file_status,
946
def _merge_executable(self, file_id, executable, file_status):
1574
947
"""Perform a merge on the execute bit."""
1575
948
base_executable, other_executable, this_executable = executable
1576
949
if file_status == "deleted":
1578
winner = resolver(*executable)
951
winner = self._three_way(*executable)
1579
952
if winner == "conflict":
1580
953
# There must be a None in here, if we have a conflict, but we
1581
954
# need executability since file status was not deleted.
1662
1046
supports_reverse_cherrypick = False
1663
1047
history_based = True
1665
def _generate_merge_plan(self, file_id, base):
1666
return self.this_tree.plan_file_merge(file_id, self.other_tree,
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,
1669
def _merged_lines(self, file_id):
1670
"""Generate the merged lines.
1671
There is no distinction between lines that are meant to contain <<<<<<<
1675
base = self.base_tree
1678
plan = self._generate_merge_plan(file_id, base)
1679
1060
if 'merge' in debug.debug_flags:
1680
1061
plan = list(plan)
1681
1062
trans_id = self.tt.trans_id_file_id(file_id)
1682
1063
name = self.tt.final_name(trans_id) + '.plan'
1683
contents = ('%11s|%s' % l for l in plan)
1064
contents = ('%10s|%s' % l for l in plan)
1684
1065
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1685
textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1686
'>>>>>>> MERGE-SOURCE\n')
1687
lines, conflicts = textmerge.merge_lines(self.reprocess)
1689
base_lines = textmerge.base_from_plan()
1692
return lines, base_lines
1066
textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1067
'>>>>>>> MERGE-SOURCE\n')
1068
return textmerge.merge_lines(self.reprocess)
1694
1070
def text_merge(self, file_id, trans_id):
1695
1071
"""Perform a (weave) text merge for a given file and file-id.
1696
1072
If conflicts are encountered, .THIS and .OTHER files will be emitted,
1697
1073
and a conflict will be noted.
1699
lines, base_lines = self._merged_lines(file_id)
1075
lines, conflicts = self._merged_lines(file_id)
1700
1076
lines = list(lines)
1701
# Note we're checking whether the OUTPUT is binary in this case,
1077
# Note we're checking whether the OUTPUT is binary in this case,
1702
1078
# because we don't want to get into weave merge guts.
1703
textfile.check_text_lines(lines)
1079
check_text_lines(lines)
1704
1080
self.tt.create_file(lines, trans_id)
1705
if base_lines is not None:
1707
1082
self._raw_conflicts.append(('text conflict', trans_id))
1708
1083
name = self.tt.final_name(trans_id)
1709
1084
parent_id = self.tt.final_parent(trans_id)
1710
file_group = self._dump_conflicts(name, parent_id, file_id,
1712
base_lines=base_lines)
1085
file_group = self._dump_conflicts(name, parent_id, file_id,
1713
1087
file_group.append(trans_id)
1716
1090
class LCAMerger(WeaveMerger):
1718
def _generate_merge_plan(self, file_id, base):
1719
return self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
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,
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)
1722
1114
class Diff3Merger(Merge3Merger):
1723
1115
"""Three-way merger using external diff3 for text merging"""
1725
1117
def dump_file(self, temp_dir, name, tree, file_id):
1726
out_path = osutils.pathjoin(temp_dir, name)
1118
out_path = pathjoin(temp_dir, name)
1727
1119
out_file = open(out_path, "wb")
1729
1121
in_file = tree.get_file(file_id)
1762
1154
osutils.rmtree(temp_dir)
1765
class PathNotInTree(errors.BzrError):
1767
_fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
1769
def __init__(self, path, tree):
1770
errors.BzrError.__init__(self, path=path, tree=tree)
1773
class MergeIntoMerger(Merger):
1774
"""Merger that understands other_tree will be merged into a subdir.
1776
This also changes the Merger api so that it uses real Branch, revision_id,
1777
and RevisonTree objects, rather than using revision specs.
1780
def __init__(self, this_tree, other_branch, other_tree, target_subdir,
1781
source_subpath, other_rev_id=None):
1782
"""Create a new MergeIntoMerger object.
1784
source_subpath in other_tree will be effectively copied to
1785
target_subdir in this_tree.
1787
:param this_tree: The tree that we will be merging into.
1788
:param other_branch: The Branch we will be merging from.
1789
:param other_tree: The RevisionTree object we want to merge.
1790
:param target_subdir: The relative path where we want to merge
1791
other_tree into this_tree
1792
:param source_subpath: The relative path specifying the subtree of
1793
other_tree to merge into this_tree.
1795
# It is assumed that we are merging a tree that is not in our current
1796
# ancestry, which means we are using the "EmptyTree" as our basis.
1797
null_ancestor_tree = this_tree.branch.repository.revision_tree(
1798
_mod_revision.NULL_REVISION)
1799
super(MergeIntoMerger, self).__init__(
1800
this_branch=this_tree.branch,
1801
this_tree=this_tree,
1802
other_tree=other_tree,
1803
base_tree=null_ancestor_tree,
1805
self._target_subdir = target_subdir
1806
self._source_subpath = source_subpath
1807
self.other_branch = other_branch
1808
if other_rev_id is None:
1809
other_rev_id = other_tree.get_revision_id()
1810
self.other_rev_id = self.other_basis = other_rev_id
1811
self.base_is_ancestor = True
1812
self.backup_files = True
1813
self.merge_type = Merge3Merger
1814
self.show_base = False
1815
self.reprocess = False
1816
self.interesting_ids = None
1817
self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
1818
target_subdir=self._target_subdir,
1819
source_subpath=self._source_subpath)
1820
if self._source_subpath != '':
1821
# If this isn't a partial merge make sure the revisions will be
1823
self._maybe_fetch(self.other_branch, self.this_branch,
1826
def set_pending(self):
1827
if self._source_subpath != '':
1829
Merger.set_pending(self)
1832
class _MergeTypeParameterizer(object):
1833
"""Wrap a merge-type class to provide extra parameters.
1835
This is hack used by MergeIntoMerger to pass some extra parameters to its
1836
merge_type. Merger.do_merge() sets up its own set of parameters to pass to
1837
the 'merge_type' member. It is difficult override do_merge without
1838
re-writing the whole thing, so instead we create a wrapper which will pass
1839
the extra parameters.
1842
def __init__(self, merge_type, **kwargs):
1843
self._extra_kwargs = kwargs
1844
self._merge_type = merge_type
1846
def __call__(self, *args, **kwargs):
1847
kwargs.update(self._extra_kwargs)
1848
return self._merge_type(*args, **kwargs)
1850
def __getattr__(self, name):
1851
return getattr(self._merge_type, name)
1854
class MergeIntoMergeType(Merge3Merger):
1855
"""Merger that incorporates a tree (or part of a tree) into another."""
1857
def __init__(self, *args, **kwargs):
1858
"""Initialize the merger object.
1860
:param args: See Merge3Merger.__init__'s args.
1861
:param kwargs: See Merge3Merger.__init__'s keyword args, except for
1862
source_subpath and target_subdir.
1863
:keyword source_subpath: The relative path specifying the subtree of
1864
other_tree to merge into this_tree.
1865
:keyword target_subdir: The relative path where we want to merge
1866
other_tree into this_tree
1868
# All of the interesting work happens during Merge3Merger.__init__(),
1869
# so we have have to hack in to get our extra parameters set.
1870
self._source_subpath = kwargs.pop('source_subpath')
1871
self._target_subdir = kwargs.pop('target_subdir')
1872
super(MergeIntoMergeType, self).__init__(*args, **kwargs)
1874
def _compute_transform(self):
1875
child_pb = ui.ui_factory.nested_progress_bar()
1877
entries = self._entries_to_incorporate()
1878
entries = list(entries)
1879
for num, (entry, parent_id) in enumerate(entries):
1880
child_pb.update('Preparing file merge', num, len(entries))
1881
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1882
trans_id = transform.new_by_entry(self.tt, entry,
1883
parent_trans_id, self.other_tree)
1886
self._finish_computing_transform()
1888
def _entries_to_incorporate(self):
1889
"""Yields pairs of (inventory_entry, new_parent)."""
1890
other_inv = self.other_tree.inventory
1891
subdir_id = other_inv.path2id(self._source_subpath)
1892
if subdir_id is None:
1893
# XXX: The error would be clearer if it gave the URL of the source
1894
# branch, but we don't have a reference to that here.
1895
raise PathNotInTree(self._source_subpath, "Source tree")
1896
subdir = other_inv[subdir_id]
1897
parent_in_target = osutils.dirname(self._target_subdir)
1898
target_id = self.this_tree.inventory.path2id(parent_in_target)
1899
if target_id is None:
1900
raise PathNotInTree(self._target_subdir, "Target tree")
1901
name_in_target = osutils.basename(self._target_subdir)
1902
merge_into_root = subdir.copy()
1903
merge_into_root.name = name_in_target
1904
if merge_into_root.file_id in self.this_tree.inventory:
1905
# Give the root a new file-id.
1906
# This can happen fairly easily if the directory we are
1907
# incorporating is the root, and both trees have 'TREE_ROOT' as
1908
# their root_id. Users will expect this to Just Work, so we
1909
# change the file-id here.
1910
# Non-root file-ids could potentially conflict too. That's really
1911
# an edge case, so we don't do anything special for those. We let
1912
# them cause conflicts.
1913
merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
1914
yield (merge_into_root, target_id)
1915
if subdir.kind != 'directory':
1916
# No children, so we are done.
1918
for ignored_path, entry in other_inv.iter_entries_by_dir(subdir_id):
1919
parent_id = entry.parent_id
1920
if parent_id == subdir.file_id:
1921
# The root's parent ID has changed, so make sure children of
1922
# the root refer to the new ID.
1923
parent_id = merge_into_root.file_id
1924
yield (entry, parent_id)
1927
1157
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1928
1158
backup_files=False,
1929
1159
merge_type=Merge3Merger,
2164
1369
class _PlanMerge(_PlanMergeBase):
2165
1370
"""Plan an annotate merge using on-the-fly annotation"""
2167
def __init__(self, a_rev, b_rev, vf, key_prefix):
2168
super(_PlanMerge, self).__init__(a_rev, b_rev, vf, key_prefix)
2169
self.a_key = self._key_prefix + (self.a_rev,)
2170
self.b_key = self._key_prefix + (self.b_rev,)
2171
self.graph = _mod_graph.Graph(self.vf)
2172
heads = self.graph.heads((self.a_key, self.b_key))
2174
# one side dominates, so we can just return its values, yay for
2176
# Ideally we would know that before we get this far
2177
self._head_key = heads.pop()
2178
if self._head_key == self.a_key:
2182
trace.mutter('found dominating revision for %s\n%s > %s', self.vf,
2183
self._head_key[-1], other)
2186
self._head_key = None
2189
def _precache_tip_lines(self):
2190
# Turn this into a no-op, because we will do this later
2193
def _find_recursive_lcas(self):
2194
"""Find all the ancestors back to a unique lca"""
2195
cur_ancestors = (self.a_key, self.b_key)
2196
# graph.find_lca(uncommon, keys) now returns plain NULL_REVISION,
2197
# rather than a key tuple. We will just map that directly to no common
2201
next_lcas = self.graph.find_lca(*cur_ancestors)
2202
# Map a plain NULL_REVISION to a simple no-ancestors
2203
if next_lcas == set([_mod_revision.NULL_REVISION]):
2205
# Order the lca's based on when they were merged into the tip
2206
# While the actual merge portion of weave merge uses a set() of
2207
# active revisions, the order of insertion *does* effect the
2208
# implicit ordering of the texts.
2209
for rev_key in cur_ancestors:
2210
ordered_parents = tuple(self.graph.find_merge_order(rev_key,
2212
parent_map[rev_key] = ordered_parents
2213
if len(next_lcas) == 0:
2215
elif len(next_lcas) == 1:
2216
parent_map[list(next_lcas)[0]] = ()
2218
elif len(next_lcas) > 2:
2219
# More than 2 lca's, fall back to grabbing all nodes between
2220
# this and the unique lca.
2221
trace.mutter('More than 2 LCAs, falling back to all nodes for:'
2223
self.a_key, self.b_key, cur_ancestors)
2224
cur_lcas = next_lcas
2225
while len(cur_lcas) > 1:
2226
cur_lcas = self.graph.find_lca(*cur_lcas)
2227
if len(cur_lcas) == 0:
2228
# No common base to find, use the full ancestry
2231
unique_lca = list(cur_lcas)[0]
2232
if unique_lca == _mod_revision.NULL_REVISION:
2233
# find_lca will return a plain 'NULL_REVISION' rather
2234
# than a key tuple when there is no common ancestor, we
2235
# prefer to just use None, because it doesn't confuse
2236
# _get_interesting_texts()
2238
parent_map.update(self._find_unique_parents(next_lcas,
2241
cur_ancestors = next_lcas
2244
def _find_unique_parents(self, tip_keys, base_key):
2245
"""Find ancestors of tip that aren't ancestors of base.
2247
:param tip_keys: Nodes that are interesting
2248
:param base_key: Cull all ancestors of this node
2249
:return: The parent map for all revisions between tip_keys and
2250
base_key. base_key will be included. References to nodes outside of
2251
the ancestor set will also be removed.
2253
# TODO: this would be simpler if find_unique_ancestors took a list
2254
# instead of a single tip, internally it supports it, but it
2255
# isn't a "backwards compatible" api change.
2256
if base_key is None:
2257
parent_map = dict(self.graph.iter_ancestry(tip_keys))
2258
# We remove NULL_REVISION because it isn't a proper tuple key, and
2259
# thus confuses things like _get_interesting_texts, and our logic
2260
# to add the texts into the memory weave.
2261
if _mod_revision.NULL_REVISION in parent_map:
2262
parent_map.pop(_mod_revision.NULL_REVISION)
2265
for tip in tip_keys:
2267
self.graph.find_unique_ancestors(tip, [base_key]))
2268
parent_map = self.graph.get_parent_map(interesting)
2269
parent_map[base_key] = ()
2270
culled_parent_map, child_map, tails = self._remove_external_references(
2272
# Remove all the tails but base_key
2273
if base_key is not None:
2274
tails.remove(base_key)
2275
self._prune_tails(culled_parent_map, child_map, tails)
2276
# Now remove all the uninteresting 'linear' regions
2277
simple_map = _mod_graph.collapse_linear_regions(culled_parent_map)
2281
def _remove_external_references(parent_map):
2282
"""Remove references that go outside of the parent map.
2284
:param parent_map: Something returned from Graph.get_parent_map(keys)
2285
:return: (filtered_parent_map, child_map, tails)
2286
filtered_parent_map is parent_map without external references
2287
child_map is the {parent_key: [child_keys]} mapping
2288
tails is a list of nodes that do not have any parents in the map
2290
# TODO: The basic effect of this function seems more generic than
2291
# _PlanMerge. But the specific details of building a child_map,
2292
# and computing tails seems very specific to _PlanMerge.
2293
# Still, should this be in Graph land?
2294
filtered_parent_map = {}
2297
for key, parent_keys in parent_map.iteritems():
2298
culled_parent_keys = [p for p in parent_keys if p in parent_map]
2299
if not culled_parent_keys:
2301
for parent_key in culled_parent_keys:
2302
child_map.setdefault(parent_key, []).append(key)
2303
# TODO: Do we want to do this, it adds overhead for every node,
2304
# just to say that the node has no children
2305
child_map.setdefault(key, [])
2306
filtered_parent_map[key] = culled_parent_keys
2307
return filtered_parent_map, child_map, tails
2310
def _prune_tails(parent_map, child_map, tails_to_remove):
2311
"""Remove tails from the parent map.
2313
This will remove the supplied revisions until no more children have 0
2316
:param parent_map: A dict of {child: [parents]}, this dictionary will
2317
be modified in place.
2318
:param tails_to_remove: A list of tips that should be removed,
2319
this list will be consumed
2320
:param child_map: The reverse dict of parent_map ({parent: [children]})
2321
this dict will be modified
2322
:return: None, parent_map will be modified in place.
2324
while tails_to_remove:
2325
next = tails_to_remove.pop()
2326
parent_map.pop(next)
2327
children = child_map.pop(next)
2328
for child in children:
2329
child_parents = parent_map[child]
2330
child_parents.remove(next)
2331
if len(child_parents) == 0:
2332
tails_to_remove.append(child)
2334
def _get_interesting_texts(self, parent_map):
2335
"""Return a dict of texts we are interested in.
2337
Note that the input is in key tuples, but the output is in plain
2340
:param parent_map: The output from _find_recursive_lcas
2341
:return: A dict of {'revision_id':lines} as returned by
2342
_PlanMergeBase.get_lines()
2344
all_revision_keys = set(parent_map)
2345
all_revision_keys.add(self.a_key)
2346
all_revision_keys.add(self.b_key)
2348
# Everything else is in 'keys' but get_lines is in 'revision_ids'
2349
all_texts = self.get_lines([k[-1] for k in all_revision_keys])
2352
def _build_weave(self):
2353
from bzrlib import weave
2354
self._weave = weave.Weave(weave_name='in_memory_weave',
2355
allow_reserved=True)
2356
parent_map = self._find_recursive_lcas()
2358
all_texts = self._get_interesting_texts(parent_map)
2360
# Note: Unfortunately, the order given by topo_sort will effect the
2361
# ordering resolution in the output. Specifically, if you add A then B,
2362
# then in the output text A lines will show up before B lines. And, of
2363
# course, topo_sort doesn't guarantee any real ordering.
2364
# So we use merge_sort, and add a fake node on the tip.
2365
# This ensures that left-hand parents will always be inserted into the
2366
# weave before right-hand parents.
2367
tip_key = self._key_prefix + (_mod_revision.CURRENT_REVISION,)
2368
parent_map[tip_key] = (self.a_key, self.b_key)
2370
for seq_num, key, depth, eom in reversed(tsort.merge_sort(parent_map,
2374
# for key in tsort.topo_sort(parent_map):
2375
parent_keys = parent_map[key]
2376
revision_id = key[-1]
2377
parent_ids = [k[-1] for k in parent_keys]
2378
self._weave.add_lines(revision_id, parent_ids,
2379
all_texts[revision_id])
2381
def plan_merge(self):
2382
"""Generate a 'plan' for merging the two revisions.
2384
This involves comparing their texts and determining the cause of
2385
differences. If text A has a line and text B does not, then either the
2386
line was added to text A, or it was deleted from B. Once the causes
2387
are combined, they are written out in the format described in
2388
VersionedFile.plan_merge
2390
if self._head_key is not None: # There was a single head
2391
if self._head_key == self.a_key:
2394
if self._head_key != self.b_key:
2395
raise AssertionError('There was an invalid head: %s != %s'
2396
% (self.b_key, self._head_key))
2398
head_rev = self._head_key[-1]
2399
lines = self.get_lines([head_rev])[head_rev]
2400
return ((plan, line) for line in lines)
2401
return self._weave.plan_merge(self.a_rev, self.b_rev)
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)
2404
1421
class _PlanLCAMerge(_PlanMergeBase):
added
removed
bzrlib/merge.py
