~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Vincent Ladeuil
  • Date: 2011-12-21 14:25:26 UTC
  • mto: This revision was merged to the branch mainline in revision 6397.
  • Revision ID: v.ladeuil+lp@free.fr-20111221142526-pnwau0xnalimujts
Provides MemoryStack to simplify configuration setup in tests

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from __future__ import absolute_import
 
18
 
17
19
import warnings
18
20
 
 
21
from bzrlib.lazy_import import lazy_import
 
22
lazy_import(globals(), """
19
23
from bzrlib import (
20
24
    branch as _mod_branch,
 
25
    cleanup,
21
26
    conflicts as _mod_conflicts,
22
27
    debug,
23
 
    decorators,
24
 
    errors,
 
28
    generate_ids,
25
29
    graph as _mod_graph,
26
 
    hooks,
27
30
    merge3,
28
31
    osutils,
29
32
    patiencediff,
34
37
    tree as _mod_tree,
35
38
    tsort,
36
39
    ui,
37
 
    versionedfile
38
 
    )
39
 
from bzrlib.cleanup import OperationWithCleanups
 
40
    versionedfile,
 
41
    workingtree,
 
42
    )
 
43
from bzrlib.i18n import gettext
 
44
""")
 
45
from bzrlib import (
 
46
    decorators,
 
47
    errors,
 
48
    hooks,
 
49
    registry,
 
50
    )
40
51
from bzrlib.symbol_versioning import (
41
52
    deprecated_in,
42
53
    deprecated_method,
46
57
 
47
58
def transform_tree(from_tree, to_tree, interesting_ids=None):
48
59
    from_tree.lock_tree_write()
49
 
    operation = OperationWithCleanups(merge_inner)
 
60
    operation = cleanup.OperationWithCleanups(merge_inner)
50
61
    operation.add_cleanup(from_tree.unlock)
51
62
    operation.run_simple(from_tree.branch, to_tree, from_tree,
52
63
        ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
55
66
class MergeHooks(hooks.Hooks):
56
67
 
57
68
    def __init__(self):
58
 
        hooks.Hooks.__init__(self)
59
 
        self.create_hook(hooks.HookPoint('merge_file_content',
 
69
        hooks.Hooks.__init__(self, "bzrlib.merge", "Merger.hooks")
 
70
        self.add_hook('merge_file_content',
60
71
            "Called with a bzrlib.merge.Merger object to create a per file "
61
72
            "merge object when starting a merge. "
62
73
            "Should return either None or a subclass of "
66
77
            "side has deleted the file and the other has changed it). "
67
78
            "See the AbstractPerFileMerger API docs for details on how it is "
68
79
            "used by merge.",
69
 
            (2, 1), None))
 
80
            (2, 1))
70
81
 
71
82
 
72
83
class AbstractPerFileMerger(object):
85
96
        """Attempt to merge the contents of a single file.
86
97
        
87
98
        :param merge_params: A bzrlib.merge.MergeHookParams
88
 
        :return : A tuple of (status, chunks), where status is one of
 
99
        :return: A tuple of (status, chunks), where status is one of
89
100
            'not_applicable', 'success', 'conflicted', or 'delete'.  If status
90
101
            is 'success' or 'conflicted', then chunks should be an iterable of
91
102
            strings for the new file contents.
93
104
        return ('not applicable', None)
94
105
 
95
106
 
96
 
class ConfigurableFileMerger(AbstractPerFileMerger):
 
107
class PerFileMerger(AbstractPerFileMerger):
 
108
    """Merge individual files when self.file_matches returns True.
 
109
 
 
110
    This class is intended to be subclassed.  The file_matches and
 
111
    merge_matching methods should be overridden with concrete implementations.
 
112
    """
 
113
 
 
114
    def file_matches(self, params):
 
115
        """Return True if merge_matching should be called on this file.
 
116
 
 
117
        Only called with merges of plain files with no clear winner.
 
118
 
 
119
        Subclasses must override this.
 
120
        """
 
121
        raise NotImplementedError(self.file_matches)
 
122
 
 
123
    def get_filename(self, params, tree):
 
124
        """Lookup the filename (i.e. basename, not path), given a Tree (e.g.
 
125
        self.merger.this_tree) and a MergeHookParams.
 
126
        """
 
127
        return osutils.basename(tree.id2path(params.file_id))
 
128
 
 
129
    def get_filepath(self, params, tree):
 
130
        """Calculate the path to the file in a tree.
 
131
 
 
132
        :param params: A MergeHookParams describing the file to merge
 
133
        :param tree: a Tree, e.g. self.merger.this_tree.
 
134
        """
 
135
        return tree.id2path(params.file_id)
 
136
 
 
137
    def merge_contents(self, params):
 
138
        """Merge the contents of a single file."""
 
139
        # Check whether this custom merge logic should be used.
 
140
        if (
 
141
            # OTHER is a straight winner, rely on default merge.
 
142
            params.winner == 'other' or
 
143
            # THIS and OTHER aren't both files.
 
144
            not params.is_file_merge() or
 
145
            # The filename doesn't match
 
146
            not self.file_matches(params)):
 
147
            return 'not_applicable', None
 
148
        return self.merge_matching(params)
 
149
 
 
150
    def merge_matching(self, params):
 
151
        """Merge the contents of a single file that has matched the criteria
 
152
        in PerFileMerger.merge_contents (is a conflict, is a file,
 
153
        self.file_matches is True).
 
154
 
 
155
        Subclasses must override this.
 
156
        """
 
157
        raise NotImplementedError(self.merge_matching)
 
158
 
 
159
 
 
160
class ConfigurableFileMerger(PerFileMerger):
97
161
    """Merge individual files when configured via a .conf file.
98
162
 
99
163
    This is a base class for concrete custom file merging logic. Concrete
122
186
        if self.name_prefix is None:
123
187
            raise ValueError("name_prefix must be set.")
124
188
 
125
 
    def filename_matches_config(self, params):
 
189
    def file_matches(self, params):
126
190
        """Check whether the file should call the merge hook.
127
191
 
128
192
        <name_prefix>_merge_files configuration variable is a list of files
130
194
        """
131
195
        affected_files = self.affected_files
132
196
        if affected_files is None:
133
 
            config = self.merger.this_tree.branch.get_config()
 
197
            config = self.merger.this_branch.get_config()
134
198
            # Until bzr provides a better policy for caching the config, we
135
199
            # just add the part we're interested in to the params to avoid
136
200
            # reading the config files repeatedly (bazaar.conf, location.conf,
142
206
                affected_files = self.default_files
143
207
            self.affected_files = affected_files
144
208
        if affected_files:
145
 
            filename = self.merger.this_tree.id2path(params.file_id)
146
 
            if filename in affected_files:
 
209
            filepath = self.get_filepath(params, self.merger.this_tree)
 
210
            if filepath in affected_files:
147
211
                return True
148
212
        return False
149
213
 
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.
154
 
        if (
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
160
 
            # option.
161
 
            not self.filename_matches_config(params)):
162
 
            return 'not_applicable', None
 
214
    def merge_matching(self, params):
163
215
        return self.merge_text(params)
164
216
 
165
217
    def merge_text(self, params):
380
432
        return self._cached_trees[revision_id]
381
433
 
382
434
    def _get_tree(self, treespec, possible_transports=None):
383
 
        from bzrlib import workingtree
384
435
        location, revno = treespec
385
436
        if revno is None:
386
437
            tree = workingtree.WorkingTree.open_containing(location)[0]
394
445
        revision_id = _mod_revision.ensure_null(revision_id)
395
446
        return branch, self.revision_tree(revision_id, branch)
396
447
 
397
 
    @deprecated_method(deprecated_in((2, 1, 0)))
398
 
    def ensure_revision_trees(self):
399
 
        if self.this_revision_tree is None:
400
 
            self.this_basis_tree = self.revision_tree(self.this_basis)
401
 
            if self.this_basis == self.this_rev_id:
402
 
                self.this_revision_tree = self.this_basis_tree
403
 
 
404
 
        if self.other_rev_id is None:
405
 
            other_basis_tree = self.revision_tree(self.other_basis)
406
 
            if other_basis_tree.has_changes(self.other_tree):
407
 
                raise errors.WorkingTreeNotRevision(self.this_tree)
408
 
            other_rev_id = self.other_basis
409
 
            self.other_tree = other_basis_tree
410
 
 
411
 
    @deprecated_method(deprecated_in((2, 1, 0)))
412
 
    def file_revisions(self, file_id):
413
 
        self.ensure_revision_trees()
414
 
        def get_id(tree, file_id):
415
 
            revision_id = tree.inventory[file_id].revision
416
 
            return revision_id
417
 
        if self.this_rev_id is None:
418
 
            if self.this_basis_tree.get_file_sha1(file_id) != \
419
 
                self.this_tree.get_file_sha1(file_id):
420
 
                raise errors.WorkingTreeNotRevision(self.this_tree)
421
 
 
422
 
        trees = (self.this_basis_tree, self.other_tree)
423
 
        return [get_id(tree, file_id) for tree in trees]
424
 
 
425
 
    @deprecated_method(deprecated_in((2, 1, 0)))
426
 
    def check_basis(self, check_clean, require_commits=True):
427
 
        if self.this_basis is None and require_commits is True:
428
 
            raise errors.BzrCommandError(
429
 
                "This branch has no commits."
430
 
                " (perhaps you would prefer 'bzr pull')")
431
 
        if check_clean:
432
 
            self.compare_basis()
433
 
            if self.this_basis != self.this_rev_id:
434
 
                raise errors.UncommittedChanges(self.this_tree)
435
 
 
436
 
    @deprecated_method(deprecated_in((2, 1, 0)))
437
 
    def compare_basis(self):
438
 
        try:
439
 
            basis_tree = self.revision_tree(self.this_tree.last_revision())
440
 
        except errors.NoSuchRevision:
441
 
            basis_tree = self.this_tree.basis_tree()
442
 
        if not self.this_tree.has_changes(basis_tree):
443
 
            self.this_rev_id = self.this_basis
444
 
 
445
448
    def set_interesting_files(self, file_list):
446
449
        self.interesting_files = file_list
447
450
 
454
457
    def _add_parent(self):
455
458
        new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
456
459
        new_parent_trees = []
457
 
        operation = OperationWithCleanups(self.this_tree.set_parent_trees)
 
460
        operation = cleanup.OperationWithCleanups(
 
461
            self.this_tree.set_parent_trees)
458
462
        for revision_id in new_parents:
459
463
            try:
460
464
                tree = self.revision_tree(revision_id)
491
495
                raise errors.NoCommits(self.other_branch)
492
496
        if self.other_rev_id is not None:
493
497
            self._cached_trees[self.other_rev_id] = self.other_tree
494
 
        self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
 
498
        self._maybe_fetch(self.other_branch, self.this_branch, self.other_basis)
495
499
 
496
500
    def set_other_revision(self, revision_id, other_branch):
497
501
        """Set 'other' based on a branch and revision id
535
539
            elif len(lcas) == 1:
536
540
                self.base_rev_id = list(lcas)[0]
537
541
            else: # len(lcas) > 1
 
542
                self._is_criss_cross = True
538
543
                if len(lcas) > 2:
539
544
                    # find_unique_lca can only handle 2 nodes, so we have to
540
545
                    # start back at the beginning. It is a shame to traverse
545
550
                else:
546
551
                    self.base_rev_id = self.revision_graph.find_unique_lca(
547
552
                                            *lcas)
548
 
                self._is_criss_cross = True
 
553
                sorted_lca_keys = self.revision_graph.find_merge_order(
 
554
                    revisions[0], lcas)
 
555
                if self.base_rev_id == _mod_revision.NULL_REVISION:
 
556
                    self.base_rev_id = sorted_lca_keys[0]
 
557
 
549
558
            if self.base_rev_id == _mod_revision.NULL_REVISION:
550
559
                raise errors.UnrelatedBranches()
551
560
            if self._is_criss_cross:
552
561
                trace.warning('Warning: criss-cross merge encountered.  See bzr'
553
562
                              ' help criss-cross.')
554
563
                trace.mutter('Criss-cross lcas: %r' % lcas)
555
 
                interesting_revision_ids = [self.base_rev_id]
556
 
                interesting_revision_ids.extend(lcas)
 
564
                if self.base_rev_id in lcas:
 
565
                    trace.mutter('Unable to find unique lca. '
 
566
                                 'Fallback %r as best option.'
 
567
                                 % self.base_rev_id)
 
568
                interesting_revision_ids = set(lcas)
 
569
                interesting_revision_ids.add(self.base_rev_id)
557
570
                interesting_trees = dict((t.get_revision_id(), t)
558
571
                    for t in self.this_branch.repository.revision_trees(
559
572
                        interesting_revision_ids))
560
573
                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(
563
 
                    revisions[0], lcas)
 
574
                if self.base_rev_id in lcas:
 
575
                    self.base_tree = interesting_trees[self.base_rev_id]
 
576
                else:
 
577
                    self.base_tree = interesting_trees.pop(self.base_rev_id)
564
578
                self._lca_trees = [interesting_trees[key]
565
579
                                   for key in sorted_lca_keys]
566
580
            else:
635
649
                    continue
636
650
                sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
637
651
                sub_merge.merge_type = self.merge_type
638
 
                other_branch = self.other_branch.reference_parent(file_id, relpath)
 
652
                other_branch = self.other_branch.reference_parent(file_id,
 
653
                                                                  relpath)
639
654
                sub_merge.set_other_revision(other_revision, other_branch)
640
655
                base_revision = self.base_tree.get_reference_revision(file_id)
641
656
                sub_merge.base_tree = \
645
660
        return merge
646
661
 
647
662
    def do_merge(self):
648
 
        operation = OperationWithCleanups(self._do_merge_to)
 
663
        operation = cleanup.OperationWithCleanups(self._do_merge_to)
649
664
        self.this_tree.lock_tree_write()
650
665
        operation.add_cleanup(self.this_tree.unlock)
651
666
        if self.base_tree is not None:
657
672
        merge = operation.run_simple()
658
673
        if len(merge.cooked_conflicts) == 0:
659
674
            if not self.ignore_zero and not trace.is_quiet():
660
 
                trace.note("All changes applied successfully.")
 
675
                trace.note(gettext("All changes applied successfully."))
661
676
        else:
662
 
            trace.note("%d conflicts encountered."
 
677
            trace.note(gettext("%d conflicts encountered.")
663
678
                       % len(merge.cooked_conflicts))
664
679
 
665
680
        return len(merge.cooked_conflicts)
704
719
        :param this_tree: The local tree in the merge operation
705
720
        :param base_tree: The common tree in the merge operation
706
721
        :param other_tree: The other tree to merge changes from
707
 
        :param this_branch: The branch associated with this_tree
 
722
        :param this_branch: The branch associated with this_tree.  Defaults to
 
723
            this_tree.branch if not supplied.
708
724
        :param interesting_ids: The file_ids of files that should be
709
725
            participate in the merge.  May not be combined with
710
726
            interesting_files.
728
744
        if interesting_files is not None and interesting_ids is not None:
729
745
            raise ValueError(
730
746
                'specify either interesting_ids or interesting_files')
 
747
        if this_branch is None:
 
748
            this_branch = this_tree.branch
731
749
        self.interesting_ids = interesting_ids
732
750
        self.interesting_files = interesting_files
733
751
        self.this_tree = working_tree
754
772
            warnings.warn("pb argument to Merge3Merger is deprecated")
755
773
 
756
774
    def do_merge(self):
757
 
        operation = OperationWithCleanups(self._do_merge)
 
775
        operation = cleanup.OperationWithCleanups(self._do_merge)
758
776
        self.this_tree.lock_tree_write()
759
777
        operation.add_cleanup(self.this_tree.unlock)
760
778
        self.base_tree.lock_read()
775
793
            pass
776
794
 
777
795
    def make_preview_transform(self):
778
 
        operation = OperationWithCleanups(self._make_preview_transform)
 
796
        operation = cleanup.OperationWithCleanups(self._make_preview_transform)
779
797
        self.base_tree.lock_read()
780
798
        operation.add_cleanup(self.base_tree.unlock)
781
799
        self.other_tree.lock_read()
794
812
        else:
795
813
            entries = self._entries_lca()
796
814
            resolver = self._lca_multi_way
 
815
        # Prepare merge hooks
 
816
        factories = Merger.hooks['merge_file_content']
 
817
        # One hook for each registered one plus our default merger
 
818
        hooks = [factory(self) for factory in factories] + [self]
 
819
        self.active_hooks = [hook for hook in hooks if hook is not None]
797
820
        child_pb = ui.ui_factory.nested_progress_bar()
798
821
        try:
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]
802
822
            for num, (file_id, changed, parents3, names3,
803
823
                      executable3) in enumerate(entries):
804
 
                child_pb.update('Preparing file merge', num, len(entries))
 
824
                # Try merging each entry
 
825
                child_pb.update(gettext('Preparing file merge'),
 
826
                                num, len(entries))
805
827
                self._merge_names(file_id, parents3, names3, resolver=resolver)
806
828
                if changed:
807
829
                    file_status = self._do_merge_contents(file_id)
811
833
                    executable3, file_status, resolver=resolver)
812
834
        finally:
813
835
            child_pb.finished()
814
 
        self.fix_root()
 
836
        self.tt.fixup_new_roots()
 
837
        self._finish_computing_transform()
 
838
 
 
839
    def _finish_computing_transform(self):
 
840
        """Finalize the transform and report the changes.
 
841
 
 
842
        This is the second half of _compute_transform.
 
843
        """
815
844
        child_pb = ui.ui_factory.nested_progress_bar()
816
845
        try:
817
846
            fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
824
853
                self.tt.iter_changes(), self.change_reporter)
825
854
        self.cook_conflicts(fs_conflicts)
826
855
        for conflict in self.cooked_conflicts:
827
 
            trace.warning(conflict)
 
856
            trace.warning(unicode(conflict))
828
857
 
829
858
    def _entries3(self):
830
859
        """Gather data about files modified between three trees.
837
866
        """
838
867
        result = []
839
868
        iterator = self.other_tree.iter_changes(self.base_tree,
840
 
                include_unchanged=True, specific_files=self.interesting_files,
 
869
                specific_files=self.interesting_files,
841
870
                extra_trees=[self.this_tree])
842
871
        this_entries = dict((e.file_id, e) for p, e in
843
872
                            self.this_tree.iter_entries_by_dir(
869
898
        it then compares with THIS and BASE.
870
899
 
871
900
        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
875
 
                        else False
876
 
            parents     ((base, [parent_id, in, lcas]), parent_id_other,
877
 
                         parent_id_this)
878
 
            names       ((base, [name, in, lcas]), name_in_other, name_in_this)
879
 
            executable  ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
 
901
 
 
902
        :return: [(file_id, changed, parents, names, executable)], where:
 
903
 
 
904
            * file_id: Simple file_id of the entry
 
905
            * changed: Boolean, True if the kind or contents changed else False
 
906
            * parents: ((base, [parent_id, in, lcas]), parent_id_other,
 
907
                        parent_id_this)
 
908
            * names:   ((base, [name, in, lcas]), name_in_other, name_in_this)
 
909
            * executable: ((base, [exec, in, lcas]), exec_in_other,
 
910
                        exec_in_this)
880
911
        """
881
912
        if self.interesting_files is not None:
882
913
            lookup_trees = [self.this_tree, self.base_tree]
924
955
                else:
925
956
                    lca_entries.append(lca_ie)
926
957
 
927
 
            if file_id in base_inventory:
 
958
            if base_inventory.has_id(file_id):
928
959
                base_ie = base_inventory[file_id]
929
960
            else:
930
961
                base_ie = _none_entry
931
962
 
932
 
            if file_id in this_inventory:
 
963
            if this_inventory.has_id(file_id):
933
964
                this_ie = this_inventory[file_id]
934
965
            else:
935
966
                this_ie = _none_entry
1015
1046
                        continue
1016
1047
                else:
1017
1048
                    raise AssertionError('unhandled kind: %s' % other_ie.kind)
1018
 
                # XXX: We need to handle kind == 'symlink'
1019
1049
 
1020
1050
            # If we have gotten this far, that means something has changed
1021
1051
            result.append((file_id, content_changed,
1028
1058
                          ))
1029
1059
        return result
1030
1060
 
1031
 
 
 
1061
    @deprecated_method(deprecated_in((2, 4, 0)))
1032
1062
    def fix_root(self):
1033
 
        try:
1034
 
            self.tt.final_kind(self.tt.root)
1035
 
        except errors.NoSuchFile:
 
1063
        if self.tt.final_kind(self.tt.root) is None:
1036
1064
            self.tt.cancel_deletion(self.tt.root)
1037
1065
        if self.tt.final_file_id(self.tt.root) is None:
1038
1066
            self.tt.version_file(self.tt.tree_file_id(self.tt.root),
1043
1071
        other_root = self.tt.trans_id_file_id(other_root_file_id)
1044
1072
        if other_root == self.tt.root:
1045
1073
            return
1046
 
        try:
1047
 
            self.tt.final_kind(other_root)
1048
 
        except errors.NoSuchFile:
1049
 
            return
1050
 
        if self.this_tree.has_id(self.other_tree.inventory.root.file_id):
1051
 
            # the other tree's root is a non-root in the current tree
1052
 
            return
1053
 
        self.reparent_children(self.other_tree.inventory.root, self.tt.root)
1054
 
        self.tt.cancel_creation(other_root)
1055
 
        self.tt.cancel_versioning(other_root)
1056
 
 
1057
 
    def reparent_children(self, ie, target):
1058
 
        for thing, child in ie.children.iteritems():
 
1074
        if self.this_tree.inventory.has_id(
 
1075
            self.other_tree.inventory.root.file_id):
 
1076
            # the other tree's root is a non-root in the current tree (as
 
1077
            # when a previously unrelated branch is merged into another)
 
1078
            return
 
1079
        if self.tt.final_kind(other_root) is not None:
 
1080
            other_root_is_present = True
 
1081
        else:
 
1082
            # other_root doesn't have a physical representation. We still need
 
1083
            # to move any references to the actual root of the tree.
 
1084
            other_root_is_present = False
 
1085
        # 'other_tree.inventory.root' is not present in this tree. We are
 
1086
        # calling adjust_path for children which *want* to be present with a
 
1087
        # correct place to go.
 
1088
        for _, child in self.other_tree.inventory.root.children.iteritems():
1059
1089
            trans_id = self.tt.trans_id_file_id(child.file_id)
1060
 
            self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
 
1090
            if not other_root_is_present:
 
1091
                if self.tt.final_kind(trans_id) is not None:
 
1092
                    # The item exist in the final tree and has a defined place
 
1093
                    # to go already.
 
1094
                    continue
 
1095
            # Move the item into the root
 
1096
            try:
 
1097
                final_name = self.tt.final_name(trans_id)
 
1098
            except errors.NoFinalPath:
 
1099
                # This file is not present anymore, ignore it.
 
1100
                continue
 
1101
            self.tt.adjust_path(final_name, self.tt.root, trans_id)
 
1102
        if other_root_is_present:
 
1103
            self.tt.cancel_creation(other_root)
 
1104
            self.tt.cancel_versioning(other_root)
1061
1105
 
1062
1106
    def write_modified(self, results):
1063
1107
        modified_hashes = {}
1088
1132
    @staticmethod
1089
1133
    def contents_sha1(tree, file_id):
1090
1134
        """Determine the sha1 of the file contents (used as a key method)."""
1091
 
        if file_id not in tree:
 
1135
        if not tree.has_id(file_id):
1092
1136
            return None
1093
1137
        return tree.get_file_sha1(file_id)
1094
1138
 
1110
1154
 
1111
1155
    @staticmethod
1112
1156
    def _three_way(base, other, this):
1113
 
        #if base == other, either they all agree, or only THIS has changed.
1114
1157
        if base == other:
 
1158
            # if 'base == other', either they all agree, or only 'this' has
 
1159
            # changed.
1115
1160
            return 'this'
1116
1161
        elif this not in (base, other):
 
1162
            # 'this' is neither 'base' nor 'other', so both sides changed
1117
1163
            return 'conflict'
1118
 
        # "Ambiguous clean merge" -- both sides have made the same change.
1119
1164
        elif this == other:
 
1165
            # "Ambiguous clean merge" -- both sides have made the same change.
1120
1166
            return "this"
1121
 
        # this == base: only other has changed.
1122
1167
        else:
 
1168
            # this == base: only other has changed.
1123
1169
            return "other"
1124
1170
 
1125
1171
    @staticmethod
1169
1215
                # only has an lca value
1170
1216
                return 'other'
1171
1217
 
1172
 
        # At this point, the lcas disagree, and the tips disagree
 
1218
        # At this point, the lcas disagree, and the tip disagree
1173
1219
        return 'conflict'
1174
1220
 
1175
1221
    @staticmethod
 
1222
    @deprecated_method(deprecated_in((2, 2, 0)))
1176
1223
    def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
1177
1224
        """Do a three-way test on a scalar.
1178
1225
        Return "this", "other" or "conflict", depending whether a value wins.
1228
1275
                parent_id_winner = "other"
1229
1276
        if name_winner == "this" and parent_id_winner == "this":
1230
1277
            return
1231
 
        if name_winner == "conflict":
1232
 
            trans_id = self.tt.trans_id_file_id(file_id)
1233
 
            self._raw_conflicts.append(('name conflict', trans_id,
1234
 
                                        this_name, other_name))
1235
 
        if parent_id_winner == "conflict":
1236
 
            trans_id = self.tt.trans_id_file_id(file_id)
1237
 
            self._raw_conflicts.append(('parent conflict', trans_id,
1238
 
                                        this_parent, other_parent))
1239
 
        if other_name is None:
 
1278
        if name_winner == 'conflict' or parent_id_winner == 'conflict':
 
1279
            # Creating helpers (.OTHER or .THIS) here cause problems down the
 
1280
            # road if a ContentConflict needs to be created so we should not do
 
1281
            # that
 
1282
            trans_id = self.tt.trans_id_file_id(file_id)
 
1283
            self._raw_conflicts.append(('path conflict', trans_id, file_id,
 
1284
                                        this_parent, this_name,
 
1285
                                        other_parent, other_name))
 
1286
        if not self.other_tree.has_id(file_id):
1240
1287
            # it doesn't matter whether the result was 'other' or
1241
 
            # 'conflict'-- if there's no 'other', we leave it alone.
 
1288
            # 'conflict'-- if it has no file id, we leave it alone.
1242
1289
            return
1243
 
        # if we get here, name_winner and parent_winner are set to safe values.
1244
 
        trans_id = self.tt.trans_id_file_id(file_id)
1245
1290
        parent_id = parents[self.winner_idx[parent_id_winner]]
1246
 
        if parent_id is not None:
1247
 
            parent_trans_id = self.tt.trans_id_file_id(parent_id)
1248
 
            self.tt.adjust_path(names[self.winner_idx[name_winner]],
1249
 
                                parent_trans_id, trans_id)
 
1291
        name = names[self.winner_idx[name_winner]]
 
1292
        if parent_id is not None or name is not None:
 
1293
            # if we get here, name_winner and parent_winner are set to safe
 
1294
            # values.
 
1295
            if parent_id is None and name is not None:
 
1296
                # if parent_id is None and name is non-None, current file is
 
1297
                # the tree root.
 
1298
                if names[self.winner_idx[parent_id_winner]] != '':
 
1299
                    raise AssertionError(
 
1300
                        'File looks like a root, but named %s' %
 
1301
                        names[self.winner_idx[parent_id_winner]])
 
1302
                parent_trans_id = transform.ROOT_PARENT
 
1303
            else:
 
1304
                parent_trans_id = self.tt.trans_id_file_id(parent_id)
 
1305
            self.tt.adjust_path(name, parent_trans_id,
 
1306
                                self.tt.trans_id_file_id(file_id))
1250
1307
 
1251
1308
    def _do_merge_contents(self, file_id):
1252
1309
        """Performs a merge on file_id contents."""
1253
1310
        def contents_pair(tree):
1254
 
            if file_id not in tree:
 
1311
            if not tree.has_id(file_id):
1255
1312
                return (None, None)
1256
1313
            kind = tree.kind(file_id)
1257
1314
            if kind == "file":
1295
1352
            if hook_status != 'not_applicable':
1296
1353
                # Don't try any more hooks, this one applies.
1297
1354
                break
 
1355
        # If the merge ends up replacing the content of the file, we get rid of
 
1356
        # it at the end of this method (this variable is used to track the
 
1357
        # exceptions to this rule).
 
1358
        keep_this = False
1298
1359
        result = "modified"
1299
1360
        if hook_status == 'not_applicable':
1300
 
            # This is a contents conflict, because none of the available
1301
 
            # functions could merge it.
 
1361
            # No merge hook was able to resolve the situation. Two cases exist:
 
1362
            # a content conflict or a duplicate one.
1302
1363
            result = None
1303
1364
            name = self.tt.final_name(trans_id)
1304
1365
            parent_id = self.tt.final_parent(trans_id)
1305
 
            if self.this_tree.has_id(file_id):
1306
 
                self.tt.unversion_file(trans_id)
1307
 
            file_group = self._dump_conflicts(name, parent_id, file_id,
1308
 
                                              set_version=True)
1309
 
            self._raw_conflicts.append(('contents conflict', file_group))
 
1366
            duplicate = False
 
1367
            inhibit_content_conflict = False
 
1368
            if params.this_kind is None: # file_id is not in THIS
 
1369
                # Is the name used for a different file_id ?
 
1370
                dupe_path = self.other_tree.id2path(file_id)
 
1371
                this_id = self.this_tree.path2id(dupe_path)
 
1372
                if this_id is not None:
 
1373
                    # Two entries for the same path
 
1374
                    keep_this = True
 
1375
                    # versioning the merged file will trigger a duplicate
 
1376
                    # conflict
 
1377
                    self.tt.version_file(file_id, trans_id)
 
1378
                    transform.create_from_tree(
 
1379
                        self.tt, trans_id, self.other_tree, file_id,
 
1380
                        filter_tree_path=self._get_filter_tree_path(file_id))
 
1381
                    inhibit_content_conflict = True
 
1382
            elif params.other_kind is None: # file_id is not in OTHER
 
1383
                # Is the name used for a different file_id ?
 
1384
                dupe_path = self.this_tree.id2path(file_id)
 
1385
                other_id = self.other_tree.path2id(dupe_path)
 
1386
                if other_id is not None:
 
1387
                    # Two entries for the same path again, but here, the other
 
1388
                    # entry will also be merged.  We simply inhibit the
 
1389
                    # 'content' conflict creation because we know OTHER will
 
1390
                    # create (or has already created depending on ordering) an
 
1391
                    # entry at the same path. This will trigger a 'duplicate'
 
1392
                    # conflict later.
 
1393
                    keep_this = True
 
1394
                    inhibit_content_conflict = True
 
1395
            if not inhibit_content_conflict:
 
1396
                if params.this_kind is not None:
 
1397
                    self.tt.unversion_file(trans_id)
 
1398
                # This is a contents conflict, because none of the available
 
1399
                # functions could merge it.
 
1400
                file_group = self._dump_conflicts(name, parent_id, file_id,
 
1401
                                                  set_version=True)
 
1402
                self._raw_conflicts.append(('contents conflict', file_group))
1310
1403
        elif hook_status == 'success':
1311
1404
            self.tt.create_file(lines, trans_id)
1312
1405
        elif hook_status == 'conflicted':
1328
1421
            raise AssertionError('unknown hook_status: %r' % (hook_status,))
1329
1422
        if not self.this_tree.has_id(file_id) and result == "modified":
1330
1423
            self.tt.version_file(file_id, trans_id)
1331
 
        # The merge has been performed, so the old contents should not be
1332
 
        # retained.
1333
 
        try:
 
1424
        if not keep_this:
 
1425
            # The merge has been performed and produced a new content, so the
 
1426
            # old contents should not be retained.
1334
1427
            self.tt.delete_contents(trans_id)
1335
 
        except errors.NoSuchFile:
1336
 
            pass
1337
1428
        return result
1338
1429
 
1339
1430
    def _default_other_winner_merge(self, merge_hook_params):
1340
1431
        """Replace this contents with other."""
1341
1432
        file_id = merge_hook_params.file_id
1342
1433
        trans_id = merge_hook_params.trans_id
1343
 
        file_in_this = self.this_tree.has_id(file_id)
1344
1434
        if self.other_tree.has_id(file_id):
1345
1435
            # OTHER changed the file
1346
 
            wt = self.this_tree
1347
 
            if wt.supports_content_filtering():
1348
 
                # We get the path from the working tree if it exists.
1349
 
                # That fails though when OTHER is adding a file, so
1350
 
                # we fall back to the other tree to find the path if
1351
 
                # it doesn't exist locally.
1352
 
                try:
1353
 
                    filter_tree_path = wt.id2path(file_id)
1354
 
                except errors.NoSuchId:
1355
 
                    filter_tree_path = self.other_tree.id2path(file_id)
1356
 
            else:
1357
 
                # Skip the id2path lookup for older formats
1358
 
                filter_tree_path = None
1359
 
            transform.create_from_tree(self.tt, trans_id,
1360
 
                             self.other_tree, file_id,
1361
 
                             filter_tree_path=filter_tree_path)
 
1436
            transform.create_from_tree(
 
1437
                self.tt, trans_id, self.other_tree, file_id,
 
1438
                filter_tree_path=self._get_filter_tree_path(file_id))
1362
1439
            return 'done', None
1363
 
        elif file_in_this:
 
1440
        elif self.this_tree.has_id(file_id):
1364
1441
            # OTHER deleted the file
1365
1442
            return 'delete', None
1366
1443
        else:
1392
1469
    def get_lines(self, tree, file_id):
1393
1470
        """Return the lines in a file, or an empty list."""
1394
1471
        if tree.has_id(file_id):
1395
 
            return tree.get_file(file_id).readlines()
 
1472
            return tree.get_file_lines(file_id)
1396
1473
        else:
1397
1474
            return []
1398
1475
 
1440
1517
                                              other_lines)
1441
1518
            file_group.append(trans_id)
1442
1519
 
 
1520
 
 
1521
    def _get_filter_tree_path(self, file_id):
 
1522
        if self.this_tree.supports_content_filtering():
 
1523
            # We get the path from the working tree if it exists.
 
1524
            # That fails though when OTHER is adding a file, so
 
1525
            # we fall back to the other tree to find the path if
 
1526
            # it doesn't exist locally.
 
1527
            try:
 
1528
                return self.this_tree.id2path(file_id)
 
1529
            except errors.NoSuchId:
 
1530
                return self.other_tree.id2path(file_id)
 
1531
        # Skip the id2path lookup for older formats
 
1532
        return None
 
1533
 
1443
1534
    def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
1444
1535
                        base_lines=None, other_lines=None, set_version=False,
1445
1536
                        no_base=False):
1511
1602
        if winner == 'this' and file_status != "modified":
1512
1603
            return
1513
1604
        trans_id = self.tt.trans_id_file_id(file_id)
1514
 
        try:
1515
 
            if self.tt.final_kind(trans_id) != "file":
1516
 
                return
1517
 
        except errors.NoSuchFile:
 
1605
        if self.tt.final_kind(trans_id) != "file":
1518
1606
            return
1519
1607
        if winner == "this":
1520
1608
            executability = this_executable
1531
1619
 
1532
1620
    def cook_conflicts(self, fs_conflicts):
1533
1621
        """Convert all conflicts into a form that doesn't depend on trans_id"""
1534
 
        name_conflicts = {}
1535
 
        self.cooked_conflicts.extend(transform.cook_conflicts(
1536
 
                fs_conflicts, self.tt))
 
1622
        content_conflict_file_ids = set()
 
1623
        cooked_conflicts = transform.cook_conflicts(fs_conflicts, self.tt)
1537
1624
        fp = transform.FinalPaths(self.tt)
1538
1625
        for conflict in self._raw_conflicts:
1539
1626
            conflict_type = conflict[0]
1540
 
            if conflict_type in ('name conflict', 'parent conflict'):
1541
 
                trans_id = conflict[1]
1542
 
                conflict_args = conflict[2:]
1543
 
                if trans_id not in name_conflicts:
1544
 
                    name_conflicts[trans_id] = {}
1545
 
                transform.unique_add(name_conflicts[trans_id], conflict_type,
1546
 
                                     conflict_args)
1547
 
            if conflict_type == 'contents conflict':
 
1627
            if conflict_type == 'path conflict':
 
1628
                (trans_id, file_id,
 
1629
                this_parent, this_name,
 
1630
                other_parent, other_name) = conflict[1:]
 
1631
                if this_parent is None or this_name is None:
 
1632
                    this_path = '<deleted>'
 
1633
                else:
 
1634
                    parent_path =  fp.get_path(
 
1635
                        self.tt.trans_id_file_id(this_parent))
 
1636
                    this_path = osutils.pathjoin(parent_path, this_name)
 
1637
                if other_parent is None or other_name is None:
 
1638
                    other_path = '<deleted>'
 
1639
                else:
 
1640
                    if other_parent == self.other_tree.get_root_id():
 
1641
                        # The tree transform doesn't know about the other root,
 
1642
                        # so we special case here to avoid a NoFinalPath
 
1643
                        # exception
 
1644
                        parent_path = ''
 
1645
                    else:
 
1646
                        parent_path =  fp.get_path(
 
1647
                            self.tt.trans_id_file_id(other_parent))
 
1648
                    other_path = osutils.pathjoin(parent_path, other_name)
 
1649
                c = _mod_conflicts.Conflict.factory(
 
1650
                    'path conflict', path=this_path,
 
1651
                    conflict_path=other_path,
 
1652
                    file_id=file_id)
 
1653
            elif conflict_type == 'contents conflict':
1548
1654
                for trans_id in conflict[1]:
1549
1655
                    file_id = self.tt.final_file_id(trans_id)
1550
1656
                    if file_id is not None:
 
1657
                        # Ok we found the relevant file-id
1551
1658
                        break
1552
1659
                path = fp.get_path(trans_id)
1553
1660
                for suffix in ('.BASE', '.THIS', '.OTHER'):
1554
1661
                    if path.endswith(suffix):
 
1662
                        # Here is the raw path
1555
1663
                        path = path[:-len(suffix)]
1556
1664
                        break
1557
1665
                c = _mod_conflicts.Conflict.factory(conflict_type,
1558
1666
                                                    path=path, file_id=file_id)
1559
 
                self.cooked_conflicts.append(c)
1560
 
            if conflict_type == 'text conflict':
 
1667
                content_conflict_file_ids.add(file_id)
 
1668
            elif conflict_type == 'text conflict':
1561
1669
                trans_id = conflict[1]
1562
1670
                path = fp.get_path(trans_id)
1563
1671
                file_id = self.tt.final_file_id(trans_id)
1564
1672
                c = _mod_conflicts.Conflict.factory(conflict_type,
1565
1673
                                                    path=path, file_id=file_id)
1566
 
                self.cooked_conflicts.append(c)
 
1674
            else:
 
1675
                raise AssertionError('bad conflict type: %r' % (conflict,))
 
1676
            cooked_conflicts.append(c)
1567
1677
 
1568
 
        for trans_id, conflicts in name_conflicts.iteritems():
1569
 
            try:
1570
 
                this_parent, other_parent = conflicts['parent conflict']
1571
 
                if this_parent == other_parent:
1572
 
                    raise AssertionError()
1573
 
            except KeyError:
1574
 
                this_parent = other_parent = \
1575
 
                    self.tt.final_file_id(self.tt.final_parent(trans_id))
1576
 
            try:
1577
 
                this_name, other_name = conflicts['name conflict']
1578
 
                if this_name == other_name:
1579
 
                    raise AssertionError()
1580
 
            except KeyError:
1581
 
                this_name = other_name = self.tt.final_name(trans_id)
1582
 
            other_path = fp.get_path(trans_id)
1583
 
            if this_parent is not None and this_name is not None:
1584
 
                this_parent_path = \
1585
 
                    fp.get_path(self.tt.trans_id_file_id(this_parent))
1586
 
                this_path = osutils.pathjoin(this_parent_path, this_name)
1587
 
            else:
1588
 
                this_path = "<deleted>"
1589
 
            file_id = self.tt.final_file_id(trans_id)
1590
 
            c = _mod_conflicts.Conflict.factory('path conflict', path=this_path,
1591
 
                                                conflict_path=other_path,
1592
 
                                                file_id=file_id)
 
1678
        self.cooked_conflicts = []
 
1679
        # We want to get rid of path conflicts when a corresponding contents
 
1680
        # conflict exists. This can occur when one branch deletes a file while
 
1681
        # the other renames *and* modifies it. In this case, the content
 
1682
        # conflict is enough.
 
1683
        for c in cooked_conflicts:
 
1684
            if (c.typestring == 'path conflict'
 
1685
                and c.file_id in content_conflict_file_ids):
 
1686
                continue
1593
1687
            self.cooked_conflicts.append(c)
1594
1688
        self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1595
1689
 
1701
1795
            osutils.rmtree(temp_dir)
1702
1796
 
1703
1797
 
 
1798
class PathNotInTree(errors.BzrError):
 
1799
 
 
1800
    _fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
 
1801
 
 
1802
    def __init__(self, path, tree):
 
1803
        errors.BzrError.__init__(self, path=path, tree=tree)
 
1804
 
 
1805
 
 
1806
class MergeIntoMerger(Merger):
 
1807
    """Merger that understands other_tree will be merged into a subdir.
 
1808
 
 
1809
    This also changes the Merger api so that it uses real Branch, revision_id,
 
1810
    and RevisonTree objects, rather than using revision specs.
 
1811
    """
 
1812
 
 
1813
    def __init__(self, this_tree, other_branch, other_tree, target_subdir,
 
1814
            source_subpath, other_rev_id=None):
 
1815
        """Create a new MergeIntoMerger object.
 
1816
 
 
1817
        source_subpath in other_tree will be effectively copied to
 
1818
        target_subdir in this_tree.
 
1819
 
 
1820
        :param this_tree: The tree that we will be merging into.
 
1821
        :param other_branch: The Branch we will be merging from.
 
1822
        :param other_tree: The RevisionTree object we want to merge.
 
1823
        :param target_subdir: The relative path where we want to merge
 
1824
            other_tree into this_tree
 
1825
        :param source_subpath: The relative path specifying the subtree of
 
1826
            other_tree to merge into this_tree.
 
1827
        """
 
1828
        # It is assumed that we are merging a tree that is not in our current
 
1829
        # ancestry, which means we are using the "EmptyTree" as our basis.
 
1830
        null_ancestor_tree = this_tree.branch.repository.revision_tree(
 
1831
                                _mod_revision.NULL_REVISION)
 
1832
        super(MergeIntoMerger, self).__init__(
 
1833
            this_branch=this_tree.branch,
 
1834
            this_tree=this_tree,
 
1835
            other_tree=other_tree,
 
1836
            base_tree=null_ancestor_tree,
 
1837
            )
 
1838
        self._target_subdir = target_subdir
 
1839
        self._source_subpath = source_subpath
 
1840
        self.other_branch = other_branch
 
1841
        if other_rev_id is None:
 
1842
            other_rev_id = other_tree.get_revision_id()
 
1843
        self.other_rev_id = self.other_basis = other_rev_id
 
1844
        self.base_is_ancestor = True
 
1845
        self.backup_files = True
 
1846
        self.merge_type = Merge3Merger
 
1847
        self.show_base = False
 
1848
        self.reprocess = False
 
1849
        self.interesting_ids = None
 
1850
        self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
 
1851
              target_subdir=self._target_subdir,
 
1852
              source_subpath=self._source_subpath)
 
1853
        if self._source_subpath != '':
 
1854
            # If this isn't a partial merge make sure the revisions will be
 
1855
            # present.
 
1856
            self._maybe_fetch(self.other_branch, self.this_branch,
 
1857
                self.other_basis)
 
1858
 
 
1859
    def set_pending(self):
 
1860
        if self._source_subpath != '':
 
1861
            return
 
1862
        Merger.set_pending(self)
 
1863
 
 
1864
 
 
1865
class _MergeTypeParameterizer(object):
 
1866
    """Wrap a merge-type class to provide extra parameters.
 
1867
    
 
1868
    This is hack used by MergeIntoMerger to pass some extra parameters to its
 
1869
    merge_type.  Merger.do_merge() sets up its own set of parameters to pass to
 
1870
    the 'merge_type' member.  It is difficult override do_merge without
 
1871
    re-writing the whole thing, so instead we create a wrapper which will pass
 
1872
    the extra parameters.
 
1873
    """
 
1874
 
 
1875
    def __init__(self, merge_type, **kwargs):
 
1876
        self._extra_kwargs = kwargs
 
1877
        self._merge_type = merge_type
 
1878
 
 
1879
    def __call__(self, *args, **kwargs):
 
1880
        kwargs.update(self._extra_kwargs)
 
1881
        return self._merge_type(*args, **kwargs)
 
1882
 
 
1883
    def __getattr__(self, name):
 
1884
        return getattr(self._merge_type, name)
 
1885
 
 
1886
 
 
1887
class MergeIntoMergeType(Merge3Merger):
 
1888
    """Merger that incorporates a tree (or part of a tree) into another."""
 
1889
 
 
1890
    def __init__(self, *args, **kwargs):
 
1891
        """Initialize the merger object.
 
1892
 
 
1893
        :param args: See Merge3Merger.__init__'s args.
 
1894
        :param kwargs: See Merge3Merger.__init__'s keyword args, except for
 
1895
            source_subpath and target_subdir.
 
1896
        :keyword source_subpath: The relative path specifying the subtree of
 
1897
            other_tree to merge into this_tree.
 
1898
        :keyword target_subdir: The relative path where we want to merge
 
1899
            other_tree into this_tree
 
1900
        """
 
1901
        # All of the interesting work happens during Merge3Merger.__init__(),
 
1902
        # so we have have to hack in to get our extra parameters set.
 
1903
        self._source_subpath = kwargs.pop('source_subpath')
 
1904
        self._target_subdir = kwargs.pop('target_subdir')
 
1905
        super(MergeIntoMergeType, self).__init__(*args, **kwargs)
 
1906
 
 
1907
    def _compute_transform(self):
 
1908
        child_pb = ui.ui_factory.nested_progress_bar()
 
1909
        try:
 
1910
            entries = self._entries_to_incorporate()
 
1911
            entries = list(entries)
 
1912
            for num, (entry, parent_id) in enumerate(entries):
 
1913
                child_pb.update(gettext('Preparing file merge'), num, len(entries))
 
1914
                parent_trans_id = self.tt.trans_id_file_id(parent_id)
 
1915
                trans_id = transform.new_by_entry(self.tt, entry,
 
1916
                    parent_trans_id, self.other_tree)
 
1917
        finally:
 
1918
            child_pb.finished()
 
1919
        self._finish_computing_transform()
 
1920
 
 
1921
    def _entries_to_incorporate(self):
 
1922
        """Yields pairs of (inventory_entry, new_parent)."""
 
1923
        other_inv = self.other_tree.inventory
 
1924
        subdir_id = other_inv.path2id(self._source_subpath)
 
1925
        if subdir_id is None:
 
1926
            # XXX: The error would be clearer if it gave the URL of the source
 
1927
            # branch, but we don't have a reference to that here.
 
1928
            raise PathNotInTree(self._source_subpath, "Source tree")
 
1929
        subdir = other_inv[subdir_id]
 
1930
        parent_in_target = osutils.dirname(self._target_subdir)
 
1931
        target_id = self.this_tree.inventory.path2id(parent_in_target)
 
1932
        if target_id is None:
 
1933
            raise PathNotInTree(self._target_subdir, "Target tree")
 
1934
        name_in_target = osutils.basename(self._target_subdir)
 
1935
        merge_into_root = subdir.copy()
 
1936
        merge_into_root.name = name_in_target
 
1937
        if self.this_tree.inventory.has_id(merge_into_root.file_id):
 
1938
            # Give the root a new file-id.
 
1939
            # This can happen fairly easily if the directory we are
 
1940
            # incorporating is the root, and both trees have 'TREE_ROOT' as
 
1941
            # their root_id.  Users will expect this to Just Work, so we
 
1942
            # change the file-id here.
 
1943
            # Non-root file-ids could potentially conflict too.  That's really
 
1944
            # an edge case, so we don't do anything special for those.  We let
 
1945
            # them cause conflicts.
 
1946
            merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
 
1947
        yield (merge_into_root, target_id)
 
1948
        if subdir.kind != 'directory':
 
1949
            # No children, so we are done.
 
1950
            return
 
1951
        for ignored_path, entry in other_inv.iter_entries_by_dir(subdir_id):
 
1952
            parent_id = entry.parent_id
 
1953
            if parent_id == subdir.file_id:
 
1954
                # The root's parent ID has changed, so make sure children of
 
1955
                # the root refer to the new ID.
 
1956
                parent_id = merge_into_root.file_id
 
1957
            yield (entry, parent_id)
 
1958
 
 
1959
 
1704
1960
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1705
1961
                backup_files=False,
1706
1962
                merge_type=Merge3Merger,
1714
1970
                change_reporter=None):
1715
1971
    """Primary interface for merging.
1716
1972
 
1717
 
        typical use is probably
1718
 
        'merge_inner(branch, branch.get_revision_tree(other_revision),
1719
 
                     branch.get_revision_tree(base_revision))'
1720
 
        """
 
1973
    Typical use is probably::
 
1974
 
 
1975
        merge_inner(branch, branch.get_revision_tree(other_revision),
 
1976
                    branch.get_revision_tree(base_revision))
 
1977
    """
1721
1978
    if this_tree is None:
1722
1979
        raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
1723
 
                              "parameter as of bzrlib version 0.8.")
 
1980
                              "parameter")
1724
1981
    merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1725
1982
                    pb=pb, change_reporter=change_reporter)
1726
1983
    merger.backup_files = backup_files
1743
2000
    merger.set_base_revision(get_revision_id(), this_branch)
1744
2001
    return merger.do_merge()
1745
2002
 
 
2003
 
 
2004
merge_type_registry = registry.Registry()
 
2005
merge_type_registry.register('diff3', Diff3Merger,
 
2006
                             "Merge using external diff3.")
 
2007
merge_type_registry.register('lca', LCAMerger,
 
2008
                             "LCA-newness merge.")
 
2009
merge_type_registry.register('merge3', Merge3Merger,
 
2010
                             "Native diff3-style merge.")
 
2011
merge_type_registry.register('weave', WeaveMerger,
 
2012
                             "Weave-based merge.")
 
2013
 
 
2014
 
1746
2015
def get_merge_type_registry():
1747
 
    """Merge type registry is in bzrlib.option to avoid circular imports.
 
2016
    """Merge type registry was previously in bzrlib.option
1748
2017
 
1749
 
    This method provides a sanctioned way to retrieve it.
 
2018
    This method provides a backwards compatible way to retrieve it.
1750
2019
    """
1751
 
    from bzrlib import option
1752
 
    return option._merge_type_registry
 
2020
    return merge_type_registry
1753
2021
 
1754
2022
 
1755
2023
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
2180
2448
class _PlanLCAMerge(_PlanMergeBase):
2181
2449
    """
2182
2450
    This merge algorithm differs from _PlanMerge in that:
 
2451
 
2183
2452
    1. comparisons are done against LCAs only
2184
2453
    2. cases where a contested line is new versus one LCA but old versus
2185
2454
       another are marked as conflicts, by emitting the line as conflicted-a
2226
2495
 
2227
2496
        If a line is killed and new, this indicates that the two merge
2228
2497
        revisions contain differing conflict resolutions.
 
2498
 
2229
2499
        :param revision_id: The id of the revision in which the lines are
2230
2500
            unique
2231
2501
        :param unique_line_numbers: The line numbers of unique lines.
2232
 
        :return a tuple of (new_this, killed_other):
 
2502
        :return: a tuple of (new_this, killed_other)
2233
2503
        """
2234
2504
        new = set()
2235
2505
        killed = set()