~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Martin Pool
  • Date: 2009-03-03 01:45:32 UTC
  • mto: (4070.4.5 gnu-changelog)
  • mto: This revision was merged to the branch mainline in revision 4081.
  • Revision ID: mbp@sourcefrog.net-20090303014532-d223fxy97cb1og8f
Recommend setting timestamp in BranchBuilder

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
from merge_core import merge_flex
2
 
from changeset import generate_changeset, ExceptionConflictHandler
3
 
from changeset import Inventory
4
 
from bzrlib import find_branch
5
 
import bzrlib.osutils
6
 
from bzrlib.errors import BzrCommandError
7
 
from bzrlib.diff import compare_trees
8
 
from trace import mutter, warning
9
 
import os.path
10
 
import tempfile
11
 
import shutil
 
1
# Copyright (C) 2005, 2006, 2008 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
12
18
import errno
13
 
 
14
 
class UnrelatedBranches(BzrCommandError):
15
 
    def __init__(self):
16
 
        msg = "Branches have no common ancestor, and no base revision"\
17
 
            " specified."
18
 
        BzrCommandError.__init__(self, msg)
19
 
 
20
 
 
21
 
class MergeConflictHandler(ExceptionConflictHandler):
22
 
    """Handle conflicts encountered while merging"""
23
 
    def __init__(self, dir, ignore_zero=False):
24
 
        ExceptionConflictHandler.__init__(self, dir)
25
 
        self.conflicts = 0
26
 
        self.ignore_zero = ignore_zero
27
 
 
28
 
    def copy(self, source, dest):
29
 
        """Copy the text and mode of a file
30
 
        :param source: The path of the file to copy
31
 
        :param dest: The distination file to create
32
 
        """
33
 
        s_file = file(source, "rb")
34
 
        d_file = file(dest, "wb")
35
 
        for line in s_file:
36
 
            d_file.write(line)
37
 
        os.chmod(dest, 0777 & os.stat(source).st_mode)
38
 
 
39
 
    def add_suffix(self, name, suffix, last_new_name=None):
40
 
        """Rename a file to append a suffix.  If the new name exists, the
41
 
        suffix is added repeatedly until a non-existant name is found
42
 
 
43
 
        :param name: The path of the file
44
 
        :param suffix: The suffix to append
45
 
        :param last_new_name: (used for recursive calls) the last name tried
46
 
        """
47
 
        if last_new_name is None:
48
 
            last_new_name = name
49
 
        new_name = last_new_name+suffix
50
 
        try:
51
 
            os.rename(name, new_name)
52
 
            return new_name
53
 
        except OSError, e:
54
 
            if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
55
 
                raise
56
 
            return self.add_suffix(name, suffix, last_new_name=new_name)
57
 
 
58
 
    def conflict(self, text):
59
 
        warning(text)
60
 
        self.conflicts += 1
61
 
        
62
 
 
63
 
    def merge_conflict(self, new_file, this_path, base_path, other_path):
64
 
        """
65
 
        Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER.  The
66
 
        main file will be a version with diff3 conflicts.
67
 
        :param new_file: Path to the output file with diff3 markers
68
 
        :param this_path: Path to the file text for the THIS tree
69
 
        :param base_path: Path to the file text for the BASE tree
70
 
        :param other_path: Path to the file text for the OTHER tree
71
 
        """
72
 
        self.add_suffix(this_path, ".THIS")
73
 
        self.copy(base_path, this_path+".BASE")
74
 
        self.copy(other_path, this_path+".OTHER")
75
 
        os.rename(new_file, this_path)
76
 
        self.conflict("Diff3 conflict encountered in %s" % this_path)
77
 
 
78
 
    def target_exists(self, entry, target, old_path):
79
 
        """Handle the case when the target file or dir exists"""
80
 
        moved_path = self.add_suffix(target, ".moved")
81
 
        self.conflict("Moved existing %s to %s" % (target, moved_path))
82
 
 
83
 
    def rmdir_non_empty(self, filename):
84
 
        """Handle the case where the dir to be removed still has contents"""
85
 
        self.conflict("Directory %s not removed because it is not empty"\
86
 
            % filename)
87
 
        return "skip"
88
 
 
89
 
    def finalize(self):
90
 
        if not self.ignore_zero:
91
 
            print "%d conflicts encountered.\n" % self.conflicts
92
 
            
93
 
class SourceFile(object):
94
 
    def __init__(self, path, id, present=None, isdir=None):
95
 
        self.path = path
96
 
        self.id = id
97
 
        self.present = present
98
 
        self.isdir = isdir
99
 
        self.interesting = True
100
 
 
101
 
    def __repr__(self):
102
 
        return "SourceFile(%s, %s)" % (self.path, self.id)
103
 
 
104
 
def get_tree(treespec, temp_root, label):
105
 
    location, revno = treespec
106
 
    branch = find_branch(location)
107
 
    if revno is None:
108
 
        base_tree = branch.working_tree()
109
 
    elif revno == -1:
110
 
        base_tree = branch.basis_tree()
111
 
    else:
112
 
        base_tree = branch.revision_tree(branch.lookup_revision(revno))
113
 
    temp_path = os.path.join(temp_root, label)
114
 
    os.mkdir(temp_path)
115
 
    return branch, MergeTree(base_tree, temp_path)
116
 
 
117
 
 
118
 
def abspath(tree, file_id):
119
 
    path = tree.inventory.id2path(file_id)
120
 
    if path == "":
121
 
        return "./."
122
 
    return "./" + path
123
 
 
124
 
def file_exists(tree, file_id):
125
 
    return tree.has_filename(tree.id2path(file_id))
126
 
    
127
 
def inventory_map(tree):
128
 
    inventory = {}
129
 
    for file_id in tree.inventory:
130
 
        path = abspath(tree, file_id)
131
 
        inventory[path] = SourceFile(path, file_id)
132
 
    return inventory
133
 
 
134
 
 
135
 
class MergeTree(object):
136
 
    def __init__(self, tree, tempdir):
 
19
from itertools import chain
 
20
import os
 
21
import warnings
 
22
 
 
23
from bzrlib import (
 
24
    debug,
 
25
    errors,
 
26
    graph as _mod_graph,
 
27
    osutils,
 
28
    patiencediff,
 
29
    registry,
 
30
    revision as _mod_revision,
 
31
    tree as _mod_tree,
 
32
    tsort,
 
33
    )
 
34
from bzrlib.branch import Branch
 
35
from bzrlib.conflicts import ConflictList, Conflict
 
36
from bzrlib.errors import (BzrCommandError,
 
37
                           BzrError,
 
38
                           NoCommonAncestor,
 
39
                           NoCommits,
 
40
                           NoSuchRevision,
 
41
                           NoSuchFile,
 
42
                           NotBranchError,
 
43
                           NotVersionedError,
 
44
                           UnrelatedBranches,
 
45
                           UnsupportedOperation,
 
46
                           WorkingTreeNotRevision,
 
47
                           BinaryFile,
 
48
                           )
 
49
from bzrlib.graph import Graph
 
50
from bzrlib.merge3 import Merge3
 
51
from bzrlib.osutils import rename, pathjoin
 
52
from progress import DummyProgress, ProgressPhase
 
53
from bzrlib.revision import (NULL_REVISION, ensure_null)
 
54
from bzrlib.textfile import check_text_lines
 
55
from bzrlib.trace import mutter, warning, note, is_quiet
 
56
from bzrlib.transform import (TransformPreview, TreeTransform,
 
57
                              resolve_conflicts, cook_conflicts,
 
58
                              conflict_pass, FinalPaths, create_from_tree,
 
59
                              unique_add, ROOT_PARENT)
 
60
from bzrlib.versionedfile import PlanWeaveMerge
 
61
from bzrlib import ui
 
62
 
 
63
# TODO: Report back as changes are merged in
 
64
 
 
65
 
 
66
def transform_tree(from_tree, to_tree, interesting_ids=None):
 
67
    merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
 
68
                interesting_ids=interesting_ids, this_tree=from_tree)
 
69
 
 
70
 
 
71
class Merger(object):
 
72
    def __init__(self, this_branch, other_tree=None, base_tree=None,
 
73
                 this_tree=None, pb=DummyProgress(), change_reporter=None,
 
74
                 recurse='down', revision_graph=None):
137
75
        object.__init__(self)
138
 
        if hasattr(tree, "basedir"):
139
 
            self.root = tree.basedir
140
 
        else:
141
 
            self.root = None
142
 
        self.inventory = inventory_map(tree)
143
 
        self.tree = tree
144
 
        self.tempdir = tempdir
145
 
        os.mkdir(os.path.join(self.tempdir, "texts"))
146
 
        self.cached = {}
147
 
 
148
 
    def readonly_path(self, id):
149
 
        if id not in self.tree:
150
 
            return None
151
 
        if self.root is not None:
152
 
            return self.tree.abspath(self.tree.id2path(id))
153
 
        else:
154
 
            if self.tree.inventory[id].kind in ("directory", "root_directory"):
155
 
                return self.tempdir
156
 
            if not self.cached.has_key(id):
157
 
                path = os.path.join(self.tempdir, "texts", id)
158
 
                outfile = file(path, "wb")
159
 
                outfile.write(self.tree.get_file(id).read())
160
 
                assert(os.path.exists(path))
161
 
                self.cached[id] = path
162
 
            return self.cached[id]
163
 
 
164
 
 
165
 
 
166
 
def merge(other_revision, base_revision,
167
 
          check_clean=True, ignore_zero=False,
168
 
          this_dir=None):
169
 
    """Merge changes into a tree.
170
 
 
171
 
    base_revision
172
 
        Base for three-way merge.
173
 
    other_revision
174
 
        Other revision for three-way merge.
175
 
    this_dir
176
 
        Directory to merge changes into; '.' by default.
177
 
    check_clean
178
 
        If true, this_dir must have no uncommitted changes before the
179
 
        merge begins.
180
 
    """
181
 
    tempdir = tempfile.mkdtemp(prefix="bzr-")
182
 
    try:
183
 
        if this_dir is None:
184
 
            this_dir = '.'
185
 
        this_branch = find_branch(this_dir)
 
76
        self.this_branch = this_branch
 
77
        self.this_basis = _mod_revision.ensure_null(
 
78
            this_branch.last_revision())
 
79
        self.this_rev_id = None
 
80
        self.this_tree = this_tree
 
81
        self.this_revision_tree = None
 
82
        self.this_basis_tree = None
 
83
        self.other_tree = other_tree
 
84
        self.other_branch = None
 
85
        self.base_tree = base_tree
 
86
        self.ignore_zero = False
 
87
        self.backup_files = False
 
88
        self.interesting_ids = None
 
89
        self.interesting_files = None
 
90
        self.show_base = False
 
91
        self.reprocess = False
 
92
        self._pb = pb
 
93
        self.pp = None
 
94
        self.recurse = recurse
 
95
        self.change_reporter = change_reporter
 
96
        self._cached_trees = {}
 
97
        self._revision_graph = revision_graph
 
98
        self._base_is_ancestor = None
 
99
        self._base_is_other_ancestor = None
 
100
        self._is_criss_cross = None
 
101
        self._lca_trees = None
 
102
 
 
103
    @property
 
104
    def revision_graph(self):
 
105
        if self._revision_graph is None:
 
106
            self._revision_graph = self.this_branch.repository.get_graph()
 
107
        return self._revision_graph
 
108
 
 
109
    def _set_base_is_ancestor(self, value):
 
110
        self._base_is_ancestor = value
 
111
 
 
112
    def _get_base_is_ancestor(self):
 
113
        if self._base_is_ancestor is None:
 
114
            self._base_is_ancestor = self.revision_graph.is_ancestor(
 
115
                self.base_rev_id, self.this_basis)
 
116
        return self._base_is_ancestor
 
117
 
 
118
    base_is_ancestor = property(_get_base_is_ancestor, _set_base_is_ancestor)
 
119
 
 
120
    def _set_base_is_other_ancestor(self, value):
 
121
        self._base_is_other_ancestor = value
 
122
 
 
123
    def _get_base_is_other_ancestor(self):
 
124
        if self._base_is_other_ancestor is None:
 
125
            if self.other_basis is None:
 
126
                return True
 
127
            self._base_is_other_ancestor = self.revision_graph.is_ancestor(
 
128
                self.base_rev_id, self.other_basis)
 
129
        return self._base_is_other_ancestor
 
130
 
 
131
    base_is_other_ancestor = property(_get_base_is_other_ancestor,
 
132
                                      _set_base_is_other_ancestor)
 
133
 
 
134
    @staticmethod
 
135
    def from_uncommitted(tree, other_tree, pb, base_tree=None):
 
136
        """Return a Merger for uncommitted changes in other_tree.
 
137
 
 
138
        :param tree: The tree to merge into
 
139
        :param other_tree: The tree to get uncommitted changes from
 
140
        :param pb: A progress indicator
 
141
        :param base_tree: The basis to use for the merge.  If unspecified,
 
142
            other_tree.basis_tree() will be used.
 
143
        """
 
144
        if base_tree is None:
 
145
            base_tree = other_tree.basis_tree()
 
146
        merger = Merger(tree.branch, other_tree, base_tree, tree, pb)
 
147
        merger.base_rev_id = merger.base_tree.get_revision_id()
 
148
        merger.other_rev_id = None
 
149
        merger.other_basis = merger.base_rev_id
 
150
        return merger
 
151
 
 
152
    @classmethod
 
153
    def from_mergeable(klass, tree, mergeable, pb):
 
154
        """Return a Merger for a bundle or merge directive.
 
155
 
 
156
        :param tree: The tree to merge changes into
 
157
        :param mergeable: A merge directive or bundle
 
158
        :param pb: A progress indicator
 
159
        """
 
160
        mergeable.install_revisions(tree.branch.repository)
 
161
        base_revision_id, other_revision_id, verified =\
 
162
            mergeable.get_merge_request(tree.branch.repository)
 
163
        revision_graph = tree.branch.repository.get_graph()
 
164
        if base_revision_id is not None:
 
165
            if (base_revision_id != _mod_revision.NULL_REVISION and
 
166
                revision_graph.is_ancestor(
 
167
                base_revision_id, tree.branch.last_revision())):
 
168
                base_revision_id = None
 
169
            else:
 
170
                warning('Performing cherrypick')
 
171
        merger = klass.from_revision_ids(pb, tree, other_revision_id,
 
172
                                         base_revision_id, revision_graph=
 
173
                                         revision_graph)
 
174
        return merger, verified
 
175
 
 
176
    @staticmethod
 
177
    def from_revision_ids(pb, tree, other, base=None, other_branch=None,
 
178
                          base_branch=None, revision_graph=None,
 
179
                          tree_branch=None):
 
180
        """Return a Merger for revision-ids.
 
181
 
 
182
        :param pb: A progress indicator
 
183
        :param tree: The tree to merge changes into
 
184
        :param other: The revision-id to use as OTHER
 
185
        :param base: The revision-id to use as BASE.  If not specified, will
 
186
            be auto-selected.
 
187
        :param other_branch: A branch containing the other revision-id.  If
 
188
            not supplied, tree.branch is used.
 
189
        :param base_branch: A branch containing the base revision-id.  If
 
190
            not supplied, other_branch or tree.branch will be used.
 
191
        :param revision_graph: If you have a revision_graph precomputed, pass
 
192
            it in, otherwise it will be created for you.
 
193
        :param tree_branch: The branch associated with tree.  If not supplied,
 
194
            tree.branch will be used.
 
195
        """
 
196
        if tree_branch is None:
 
197
            tree_branch = tree.branch
 
198
        merger = Merger(tree_branch, this_tree=tree, pb=pb,
 
199
                        revision_graph=revision_graph)
 
200
        if other_branch is None:
 
201
            other_branch = tree.branch
 
202
        merger.set_other_revision(other, other_branch)
 
203
        if base is None:
 
204
            merger.find_base()
 
205
        else:
 
206
            if base_branch is None:
 
207
                base_branch = other_branch
 
208
            merger.set_base_revision(base, base_branch)
 
209
        return merger
 
210
 
 
211
    def revision_tree(self, revision_id, branch=None):
 
212
        if revision_id not in self._cached_trees:
 
213
            if branch is None:
 
214
                branch = self.this_branch
 
215
            try:
 
216
                tree = self.this_tree.revision_tree(revision_id)
 
217
            except errors.NoSuchRevisionInTree:
 
218
                tree = branch.repository.revision_tree(revision_id)
 
219
            self._cached_trees[revision_id] = tree
 
220
        return self._cached_trees[revision_id]
 
221
 
 
222
    def _get_tree(self, treespec, possible_transports=None):
 
223
        from bzrlib import workingtree
 
224
        location, revno = treespec
 
225
        if revno is None:
 
226
            tree = workingtree.WorkingTree.open_containing(location)[0]
 
227
            return tree.branch, tree
 
228
        branch = Branch.open_containing(location, possible_transports)[0]
 
229
        if revno == -1:
 
230
            revision_id = branch.last_revision()
 
231
        else:
 
232
            revision_id = branch.get_rev_id(revno)
 
233
        revision_id = ensure_null(revision_id)
 
234
        return branch, self.revision_tree(revision_id, branch)
 
235
 
 
236
    def ensure_revision_trees(self):
 
237
        if self.this_revision_tree is None:
 
238
            self.this_basis_tree = self.revision_tree(self.this_basis)
 
239
            if self.this_basis == self.this_rev_id:
 
240
                self.this_revision_tree = self.this_basis_tree
 
241
 
 
242
        if self.other_rev_id is None:
 
243
            other_basis_tree = self.revision_tree(self.other_basis)
 
244
            changes = other_basis_tree.changes_from(self.other_tree)
 
245
            if changes.has_changed():
 
246
                raise WorkingTreeNotRevision(self.this_tree)
 
247
            other_rev_id = self.other_basis
 
248
            self.other_tree = other_basis_tree
 
249
 
 
250
    def file_revisions(self, file_id):
 
251
        self.ensure_revision_trees()
 
252
        def get_id(tree, file_id):
 
253
            revision_id = tree.inventory[file_id].revision
 
254
            return revision_id
 
255
        if self.this_rev_id is None:
 
256
            if self.this_basis_tree.get_file_sha1(file_id) != \
 
257
                self.this_tree.get_file_sha1(file_id):
 
258
                raise WorkingTreeNotRevision(self.this_tree)
 
259
 
 
260
        trees = (self.this_basis_tree, self.other_tree)
 
261
        return [get_id(tree, file_id) for tree in trees]
 
262
 
 
263
    def check_basis(self, check_clean, require_commits=True):
 
264
        if self.this_basis is None and require_commits is True:
 
265
            raise BzrCommandError("This branch has no commits."
 
266
                                  " (perhaps you would prefer 'bzr pull')")
186
267
        if check_clean:
187
 
            changes = compare_trees(this_branch.working_tree(), 
188
 
                                    this_branch.basis_tree(), False)
189
 
            if changes.has_changed():
190
 
                raise BzrCommandError("Working tree has uncommitted changes.")
191
 
        other_branch, other_tree = get_tree(other_revision, tempdir, "other")
 
268
            self.compare_basis()
 
269
            if self.this_basis != self.this_rev_id:
 
270
                raise errors.UncommittedChanges(self.this_tree)
 
271
 
 
272
    def compare_basis(self):
 
273
        try:
 
274
            basis_tree = self.revision_tree(self.this_tree.last_revision())
 
275
        except errors.NoSuchRevision:
 
276
            basis_tree = self.this_tree.basis_tree()
 
277
        changes = self.this_tree.changes_from(basis_tree)
 
278
        if not changes.has_changed():
 
279
            self.this_rev_id = self.this_basis
 
280
 
 
281
    def set_interesting_files(self, file_list):
 
282
        self.interesting_files = file_list
 
283
 
 
284
    def set_pending(self):
 
285
        if not self.base_is_ancestor or not self.base_is_other_ancestor or self.other_rev_id is None:
 
286
            return
 
287
        self._add_parent()
 
288
 
 
289
    def _add_parent(self):
 
290
        new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
 
291
        new_parent_trees = []
 
292
        for revision_id in new_parents:
 
293
            try:
 
294
                tree = self.revision_tree(revision_id)
 
295
            except errors.NoSuchRevision:
 
296
                tree = None
 
297
            else:
 
298
                tree.lock_read()
 
299
            new_parent_trees.append((revision_id, tree))
 
300
        try:
 
301
            self.this_tree.set_parent_trees(new_parent_trees,
 
302
                                            allow_leftmost_as_ghost=True)
 
303
        finally:
 
304
            for _revision_id, tree in new_parent_trees:
 
305
                if tree is not None:
 
306
                    tree.unlock()
 
307
 
 
308
    def set_other(self, other_revision, possible_transports=None):
 
309
        """Set the revision and tree to merge from.
 
310
 
 
311
        This sets the other_tree, other_rev_id, other_basis attributes.
 
312
 
 
313
        :param other_revision: The [path, revision] list to merge from.
 
314
        """
 
315
        self.other_branch, self.other_tree = self._get_tree(other_revision,
 
316
                                                            possible_transports)
 
317
        if other_revision[1] == -1:
 
318
            self.other_rev_id = _mod_revision.ensure_null(
 
319
                self.other_branch.last_revision())
 
320
            if _mod_revision.is_null(self.other_rev_id):
 
321
                raise NoCommits(self.other_branch)
 
322
            self.other_basis = self.other_rev_id
 
323
        elif other_revision[1] is not None:
 
324
            self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
 
325
            self.other_basis = self.other_rev_id
 
326
        else:
 
327
            self.other_rev_id = None
 
328
            self.other_basis = self.other_branch.last_revision()
 
329
            if self.other_basis is None:
 
330
                raise NoCommits(self.other_branch)
 
331
        if self.other_rev_id is not None:
 
332
            self._cached_trees[self.other_rev_id] = self.other_tree
 
333
        self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
 
334
 
 
335
    def set_other_revision(self, revision_id, other_branch):
 
336
        """Set 'other' based on a branch and revision id
 
337
 
 
338
        :param revision_id: The revision to use for a tree
 
339
        :param other_branch: The branch containing this tree
 
340
        """
 
341
        self.other_rev_id = revision_id
 
342
        self.other_branch = other_branch
 
343
        self._maybe_fetch(other_branch, self.this_branch, self.other_rev_id)
 
344
        self.other_tree = self.revision_tree(revision_id)
 
345
        self.other_basis = revision_id
 
346
 
 
347
    def set_base_revision(self, revision_id, branch):
 
348
        """Set 'base' based on a branch and revision id
 
349
 
 
350
        :param revision_id: The revision to use for a tree
 
351
        :param branch: The branch containing this tree
 
352
        """
 
353
        self.base_rev_id = revision_id
 
354
        self.base_branch = branch
 
355
        self._maybe_fetch(branch, self.this_branch, revision_id)
 
356
        self.base_tree = self.revision_tree(revision_id)
 
357
 
 
358
    def _maybe_fetch(self, source, target, revision_id):
 
359
        if not source.repository.has_same_location(target.repository):
 
360
            target.fetch(source, revision_id)
 
361
 
 
362
    def find_base(self):
 
363
        revisions = [ensure_null(self.this_basis),
 
364
                     ensure_null(self.other_basis)]
 
365
        if NULL_REVISION in revisions:
 
366
            self.base_rev_id = NULL_REVISION
 
367
            self.base_tree = self.revision_tree(self.base_rev_id)
 
368
            self._is_criss_cross = False
 
369
        else:
 
370
            lcas = self.revision_graph.find_lca(revisions[0], revisions[1])
 
371
            self._is_criss_cross = False
 
372
            if len(lcas) == 0:
 
373
                self.base_rev_id = NULL_REVISION
 
374
            elif len(lcas) == 1:
 
375
                self.base_rev_id = list(lcas)[0]
 
376
            else: # len(lcas) > 1
 
377
                if len(lcas) > 2:
 
378
                    # find_unique_lca can only handle 2 nodes, so we have to
 
379
                    # start back at the beginning. It is a shame to traverse
 
380
                    # the graph again, but better than re-implementing
 
381
                    # find_unique_lca.
 
382
                    self.base_rev_id = self.revision_graph.find_unique_lca(
 
383
                                            revisions[0], revisions[1])
 
384
                else:
 
385
                    self.base_rev_id = self.revision_graph.find_unique_lca(
 
386
                                            *lcas)
 
387
                self._is_criss_cross = True
 
388
            if self.base_rev_id == NULL_REVISION:
 
389
                raise UnrelatedBranches()
 
390
            if self._is_criss_cross:
 
391
                warning('Warning: criss-cross merge encountered.  See bzr'
 
392
                        ' help criss-cross.')
 
393
                mutter('Criss-cross lcas: %r' % lcas)
 
394
                interesting_revision_ids = [self.base_rev_id]
 
395
                interesting_revision_ids.extend(lcas)
 
396
                interesting_trees = dict((t.get_revision_id(), t)
 
397
                    for t in self.this_branch.repository.revision_trees(
 
398
                        interesting_revision_ids))
 
399
                self._cached_trees.update(interesting_trees)
 
400
                self.base_tree = interesting_trees.pop(self.base_rev_id)
 
401
                sorted_lca_keys = self.revision_graph.find_merge_order(
 
402
                    revisions[0], lcas)
 
403
                self._lca_trees = [interesting_trees[key]
 
404
                                   for key in sorted_lca_keys]
 
405
            else:
 
406
                self.base_tree = self.revision_tree(self.base_rev_id)
 
407
        self.base_is_ancestor = True
 
408
        self.base_is_other_ancestor = True
 
409
        mutter('Base revid: %r' % self.base_rev_id)
 
410
 
 
411
    def set_base(self, base_revision):
 
412
        """Set the base revision to use for the merge.
 
413
 
 
414
        :param base_revision: A 2-list containing a path and revision number.
 
415
        """
 
416
        mutter("doing merge() with no base_revision specified")
192
417
        if base_revision == [None, None]:
193
 
            if other_revision[1] == -1:
194
 
                o_revno = None
195
 
            else:
196
 
                o_revno = other_revision[1]
197
 
            base_revno = this_branch.common_ancestor(other_branch, 
198
 
                                                     other_revno=o_revno)[0]
199
 
            if base_revno is None:
200
 
                raise UnrelatedBranches()
201
 
            base_revision = ['.', base_revno]
202
 
        base_branch, base_tree = get_tree(base_revision, tempdir, "base")
203
 
        merge_inner(this_branch, other_tree, base_tree, tempdir, 
204
 
                    ignore_zero=ignore_zero)
205
 
    finally:
206
 
        shutil.rmtree(tempdir)
207
 
 
208
 
 
209
 
def generate_cset_optimized(tree_a, tree_b, inventory_a, inventory_b):
210
 
    """Generate a changeset, using the text_id to mark really-changed files.
211
 
    This permits blazing comparisons when text_ids are present.  It also
212
 
    disables metadata comparison for files with identical texts.
213
 
    """ 
214
 
    for file_id in tree_a.tree.inventory:
215
 
        if file_id not in tree_b.tree.inventory:
216
 
            continue
217
 
        entry_a = tree_a.tree.inventory[file_id]
218
 
        entry_b = tree_b.tree.inventory[file_id]
219
 
        if (entry_a.kind, entry_b.kind) != ("file", "file"):
220
 
            continue
221
 
        if None in (entry_a.text_id, entry_b.text_id):
222
 
            continue
223
 
        if entry_a.text_id != entry_b.text_id:
224
 
            continue
225
 
        inventory_a[abspath(tree_a.tree, file_id)].interesting = False
226
 
        inventory_b[abspath(tree_b.tree, file_id)].interesting = False
227
 
    cset =  generate_changeset(tree_a, tree_b, inventory_a, inventory_b)
228
 
    for entry in cset.entries.itervalues():
229
 
        entry.metadata_change = None
230
 
    return cset
231
 
 
232
 
 
233
 
def merge_inner(this_branch, other_tree, base_tree, tempdir, 
234
 
                ignore_zero=False):
235
 
    this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
236
 
 
237
 
    def get_inventory(tree):
238
 
        return tree.inventory
239
 
 
240
 
    inv_changes = merge_flex(this_tree, base_tree, other_tree,
241
 
                             generate_cset_optimized, get_inventory,
242
 
                             MergeConflictHandler(base_tree.root,
243
 
                                                  ignore_zero=ignore_zero))
244
 
 
245
 
    adjust_ids = []
246
 
    for id, path in inv_changes.iteritems():
247
 
        if path is not None:
248
 
            if path == '.':
249
 
                path = ''
250
 
            else:
251
 
                assert path.startswith('./')
252
 
            path = path[2:]
253
 
        adjust_ids.append((path, id))
254
 
    this_branch.set_inventory(regen_inventory(this_branch, this_tree.root, adjust_ids))
255
 
 
256
 
 
257
 
def regen_inventory(this_branch, root, new_entries):
258
 
    old_entries = this_branch.read_working_inventory()
259
 
    new_inventory = {}
260
 
    by_path = {}
261
 
    for file_id in old_entries:
262
 
        entry = old_entries[file_id]
263
 
        path = old_entries.id2path(file_id)
264
 
        new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
265
 
        by_path[path] = file_id
266
 
    
267
 
    deletions = 0
268
 
    insertions = 0
269
 
    new_path_list = []
270
 
    for path, file_id in new_entries:
271
 
        if path is None:
272
 
            del new_inventory[file_id]
273
 
            deletions += 1
274
 
        else:
275
 
            new_path_list.append((path, file_id))
276
 
            if file_id not in old_entries:
277
 
                insertions += 1
278
 
    # Ensure no file is added before its parent
279
 
    new_path_list.sort()
280
 
    for path, file_id in new_path_list:
281
 
        if path == '':
282
 
            parent = None
283
 
        else:
284
 
            parent = by_path[os.path.dirname(path)]
285
 
        kind = bzrlib.osutils.file_kind(os.path.join(root, path))
286
 
        new_inventory[file_id] = (path, file_id, parent, kind)
287
 
        by_path[path] = file_id 
288
 
 
289
 
    # Get a list in insertion order
290
 
    new_inventory_list = new_inventory.values()
291
 
    mutter ("""Inventory regeneration:
292
 
old length: %i insertions: %i deletions: %i new_length: %i"""\
293
 
        % (len(old_entries), insertions, deletions, len(new_inventory_list)))
294
 
    assert len(new_inventory_list) == len(old_entries) + insertions - deletions
295
 
    new_inventory_list.sort()
296
 
    return new_inventory_list
 
418
            self.find_base()
 
419
        else:
 
420
            base_branch, self.base_tree = self._get_tree(base_revision)
 
421
            if base_revision[1] == -1:
 
422
                self.base_rev_id = base_branch.last_revision()
 
423
            elif base_revision[1] is None:
 
424
                self.base_rev_id = _mod_revision.NULL_REVISION
 
425
            else:
 
426
                self.base_rev_id = _mod_revision.ensure_null(
 
427
                    base_branch.get_rev_id(base_revision[1]))
 
428
            self._maybe_fetch(base_branch, self.this_branch, self.base_rev_id)
 
429
 
 
430
    def make_merger(self):
 
431
        kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
 
432
                  'other_tree': self.other_tree,
 
433
                  'interesting_ids': self.interesting_ids,
 
434
                  'interesting_files': self.interesting_files,
 
435
                  'pp': self.pp,
 
436
                  'do_merge': False}
 
437
        if self.merge_type.requires_base:
 
438
            kwargs['base_tree'] = self.base_tree
 
439
        if self.merge_type.supports_reprocess:
 
440
            kwargs['reprocess'] = self.reprocess
 
441
        elif self.reprocess:
 
442
            raise BzrError("Conflict reduction is not supported for merge"
 
443
                                  " type %s." % self.merge_type)
 
444
        if self.merge_type.supports_show_base:
 
445
            kwargs['show_base'] = self.show_base
 
446
        elif self.show_base:
 
447
            raise BzrError("Showing base is not supported for this"
 
448
                           " merge type. %s" % self.merge_type)
 
449
        if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
 
450
            and not self.base_is_other_ancestor):
 
451
            raise errors.CannotReverseCherrypick()
 
452
        if self.merge_type.supports_cherrypick:
 
453
            kwargs['cherrypick'] = (not self.base_is_ancestor or
 
454
                                    not self.base_is_other_ancestor)
 
455
        if self._is_criss_cross and getattr(self.merge_type,
 
456
                                            'supports_lca_trees', False):
 
457
            kwargs['lca_trees'] = self._lca_trees
 
458
        return self.merge_type(pb=self._pb,
 
459
                               change_reporter=self.change_reporter,
 
460
                               **kwargs)
 
461
 
 
462
    def _do_merge_to(self, merge):
 
463
        merge.do_merge()
 
464
        if self.recurse == 'down':
 
465
            for relpath, file_id in self.this_tree.iter_references():
 
466
                sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
 
467
                other_revision = self.other_tree.get_reference_revision(
 
468
                    file_id, relpath)
 
469
                if  other_revision == sub_tree.last_revision():
 
470
                    continue
 
471
                sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
 
472
                sub_merge.merge_type = self.merge_type
 
473
                other_branch = self.other_branch.reference_parent(file_id, relpath)
 
474
                sub_merge.set_other_revision(other_revision, other_branch)
 
475
                base_revision = self.base_tree.get_reference_revision(file_id)
 
476
                sub_merge.base_tree = \
 
477
                    sub_tree.branch.repository.revision_tree(base_revision)
 
478
                sub_merge.base_rev_id = base_revision
 
479
                sub_merge.do_merge()
 
480
 
 
481
    def do_merge(self):
 
482
        self.this_tree.lock_tree_write()
 
483
        try:
 
484
            if self.base_tree is not None:
 
485
                self.base_tree.lock_read()
 
486
            try:
 
487
                if self.other_tree is not None:
 
488
                    self.other_tree.lock_read()
 
489
                try:
 
490
                    merge = self.make_merger()
 
491
                    self._do_merge_to(merge)
 
492
                finally:
 
493
                    if self.other_tree is not None:
 
494
                        self.other_tree.unlock()
 
495
            finally:
 
496
                if self.base_tree is not None:
 
497
                    self.base_tree.unlock()
 
498
        finally:
 
499
            self.this_tree.unlock()
 
500
        if len(merge.cooked_conflicts) == 0:
 
501
            if not self.ignore_zero and not is_quiet():
 
502
                note("All changes applied successfully.")
 
503
        else:
 
504
            note("%d conflicts encountered." % len(merge.cooked_conflicts))
 
505
 
 
506
        return len(merge.cooked_conflicts)
 
507
 
 
508
 
 
509
class _InventoryNoneEntry(object):
 
510
    """This represents an inventory entry which *isn't there*.
 
511
 
 
512
    It simplifies the merging logic if we always have an InventoryEntry, even
 
513
    if it isn't actually present
 
514
    """
 
515
    executable = None
 
516
    kind = None
 
517
    name = None
 
518
    parent_id = None
 
519
    revision = None
 
520
    symlink_target = None
 
521
    text_sha1 = None
 
522
 
 
523
_none_entry = _InventoryNoneEntry()
 
524
 
 
525
 
 
526
class Merge3Merger(object):
 
527
    """Three-way merger that uses the merge3 text merger"""
 
528
    requires_base = True
 
529
    supports_reprocess = True
 
530
    supports_show_base = True
 
531
    history_based = False
 
532
    supports_cherrypick = True
 
533
    supports_reverse_cherrypick = True
 
534
    winner_idx = {"this": 2, "other": 1, "conflict": 1}
 
535
    supports_lca_trees = True
 
536
 
 
537
    def __init__(self, working_tree, this_tree, base_tree, other_tree,
 
538
                 interesting_ids=None, reprocess=False, show_base=False,
 
539
                 pb=DummyProgress(), pp=None, change_reporter=None,
 
540
                 interesting_files=None, do_merge=True,
 
541
                 cherrypick=False, lca_trees=None):
 
542
        """Initialize the merger object and perform the merge.
 
543
 
 
544
        :param working_tree: The working tree to apply the merge to
 
545
        :param this_tree: The local tree in the merge operation
 
546
        :param base_tree: The common tree in the merge operation
 
547
        :param other_tree: The other other tree to merge changes from
 
548
        :param interesting_ids: The file_ids of files that should be
 
549
            participate in the merge.  May not be combined with
 
550
            interesting_files.
 
551
        :param: reprocess If True, perform conflict-reduction processing.
 
552
        :param show_base: If True, show the base revision in text conflicts.
 
553
            (incompatible with reprocess)
 
554
        :param pb: A Progress bar
 
555
        :param pp: A ProgressPhase object
 
556
        :param change_reporter: An object that should report changes made
 
557
        :param interesting_files: The tree-relative paths of files that should
 
558
            participate in the merge.  If these paths refer to directories,
 
559
            the contents of those directories will also be included.  May not
 
560
            be combined with interesting_ids.  If neither interesting_files nor
 
561
            interesting_ids is specified, all files may participate in the
 
562
            merge.
 
563
        :param lca_trees: Can be set to a dictionary of {revision_id:rev_tree}
 
564
            if the ancestry was found to include a criss-cross merge.
 
565
            Otherwise should be None.
 
566
        """
 
567
        object.__init__(self)
 
568
        if interesting_files is not None and interesting_ids is not None:
 
569
            raise ValueError(
 
570
                'specify either interesting_ids or interesting_files')
 
571
        self.interesting_ids = interesting_ids
 
572
        self.interesting_files = interesting_files
 
573
        self.this_tree = working_tree
 
574
        self.base_tree = base_tree
 
575
        self.other_tree = other_tree
 
576
        self._raw_conflicts = []
 
577
        self.cooked_conflicts = []
 
578
        self.reprocess = reprocess
 
579
        self.show_base = show_base
 
580
        self._lca_trees = lca_trees
 
581
        # Uncommenting this will change the default algorithm to always use
 
582
        # _entries_lca. This can be useful for running the test suite and
 
583
        # making sure we haven't missed any corner cases.
 
584
        # if lca_trees is None:
 
585
        #     self._lca_trees = [self.base_tree]
 
586
        self.pb = pb
 
587
        self.pp = pp
 
588
        self.change_reporter = change_reporter
 
589
        self.cherrypick = cherrypick
 
590
        if self.pp is None:
 
591
            self.pp = ProgressPhase("Merge phase", 3, self.pb)
 
592
        if do_merge:
 
593
            self.do_merge()
 
594
 
 
595
    def do_merge(self):
 
596
        self.this_tree.lock_tree_write()
 
597
        self.base_tree.lock_read()
 
598
        self.other_tree.lock_read()
 
599
        self.tt = TreeTransform(self.this_tree, self.pb)
 
600
        try:
 
601
            self.pp.next_phase()
 
602
            self._compute_transform()
 
603
            self.pp.next_phase()
 
604
            results = self.tt.apply(no_conflicts=True)
 
605
            self.write_modified(results)
 
606
            try:
 
607
                self.this_tree.add_conflicts(self.cooked_conflicts)
 
608
            except UnsupportedOperation:
 
609
                pass
 
610
        finally:
 
611
            self.tt.finalize()
 
612
            self.other_tree.unlock()
 
613
            self.base_tree.unlock()
 
614
            self.this_tree.unlock()
 
615
            self.pb.clear()
 
616
 
 
617
    def make_preview_transform(self):
 
618
        self.base_tree.lock_read()
 
619
        self.other_tree.lock_read()
 
620
        self.tt = TransformPreview(self.this_tree)
 
621
        try:
 
622
            self.pp.next_phase()
 
623
            self._compute_transform()
 
624
            self.pp.next_phase()
 
625
        finally:
 
626
            self.other_tree.unlock()
 
627
            self.base_tree.unlock()
 
628
            self.pb.clear()
 
629
        return self.tt
 
630
 
 
631
    def _compute_transform(self):
 
632
        if self._lca_trees is None:
 
633
            entries = self._entries3()
 
634
            resolver = self._three_way
 
635
        else:
 
636
            entries = self._entries_lca()
 
637
            resolver = self._lca_multi_way
 
638
        child_pb = ui.ui_factory.nested_progress_bar()
 
639
        try:
 
640
            for num, (file_id, changed, parents3, names3,
 
641
                      executable3) in enumerate(entries):
 
642
                child_pb.update('Preparing file merge', num, len(entries))
 
643
                self._merge_names(file_id, parents3, names3, resolver=resolver)
 
644
                if changed:
 
645
                    file_status = self.merge_contents(file_id)
 
646
                else:
 
647
                    file_status = 'unmodified'
 
648
                self._merge_executable(file_id,
 
649
                    executable3, file_status, resolver=resolver)
 
650
        finally:
 
651
            child_pb.finished()
 
652
        self.fix_root()
 
653
        self.pp.next_phase()
 
654
        child_pb = ui.ui_factory.nested_progress_bar()
 
655
        try:
 
656
            fs_conflicts = resolve_conflicts(self.tt, child_pb,
 
657
                lambda t, c: conflict_pass(t, c, self.other_tree))
 
658
        finally:
 
659
            child_pb.finished()
 
660
        if self.change_reporter is not None:
 
661
            from bzrlib import delta
 
662
            delta.report_changes(
 
663
                self.tt.iter_changes(), self.change_reporter)
 
664
        self.cook_conflicts(fs_conflicts)
 
665
        for conflict in self.cooked_conflicts:
 
666
            warning(conflict)
 
667
 
 
668
    def _entries3(self):
 
669
        """Gather data about files modified between three trees.
 
670
 
 
671
        Return a list of tuples of file_id, changed, parents3, names3,
 
672
        executable3.  changed is a boolean indicating whether the file contents
 
673
        or kind were changed.  parents3 is a tuple of parent ids for base,
 
674
        other and this.  names3 is a tuple of names for base, other and this.
 
675
        executable3 is a tuple of execute-bit values for base, other and this.
 
676
        """
 
677
        result = []
 
678
        iterator = self.other_tree.iter_changes(self.base_tree,
 
679
                include_unchanged=True, specific_files=self.interesting_files,
 
680
                extra_trees=[self.this_tree])
 
681
        this_entries = dict((e.file_id, e) for p, e in
 
682
                            self.this_tree.iter_entries_by_dir(
 
683
                            self.interesting_ids))
 
684
        for (file_id, paths, changed, versioned, parents, names, kind,
 
685
             executable) in iterator:
 
686
            if (self.interesting_ids is not None and
 
687
                file_id not in self.interesting_ids):
 
688
                continue
 
689
            entry = this_entries.get(file_id)
 
690
            if entry is not None:
 
691
                this_name = entry.name
 
692
                this_parent = entry.parent_id
 
693
                this_executable = entry.executable
 
694
            else:
 
695
                this_name = None
 
696
                this_parent = None
 
697
                this_executable = None
 
698
            parents3 = parents + (this_parent,)
 
699
            names3 = names + (this_name,)
 
700
            executable3 = executable + (this_executable,)
 
701
            result.append((file_id, changed, parents3, names3, executable3))
 
702
        return result
 
703
 
 
704
    def _entries_lca(self):
 
705
        """Gather data about files modified between multiple trees.
 
706
 
 
707
        This compares OTHER versus all LCA trees, and for interesting entries,
 
708
        it then compares with THIS and BASE.
 
709
 
 
710
        For the multi-valued entries, the format will be (BASE, [lca1, lca2])
 
711
        :return: [(file_id, changed, parents, names, executable)]
 
712
            file_id     Simple file_id of the entry
 
713
            changed     Boolean, True if the kind or contents changed
 
714
                        else False
 
715
            parents     ((base, [parent_id, in, lcas]), parent_id_other,
 
716
                         parent_id_this)
 
717
            names       ((base, [name, in, lcas]), name_in_other, name_in_this)
 
718
            executable  ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
 
719
        """
 
720
        if self.interesting_files is not None:
 
721
            lookup_trees = [self.this_tree, self.base_tree]
 
722
            lookup_trees.extend(self._lca_trees)
 
723
            # I think we should include the lca trees as well
 
724
            interesting_ids = self.other_tree.paths2ids(self.interesting_files,
 
725
                                                        lookup_trees)
 
726
        else:
 
727
            interesting_ids = self.interesting_ids
 
728
        result = []
 
729
        walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
 
730
 
 
731
        base_inventory = self.base_tree.inventory
 
732
        this_inventory = self.this_tree.inventory
 
733
        for path, file_id, other_ie, lca_values in walker.iter_all():
 
734
            # Is this modified at all from any of the other trees?
 
735
            if other_ie is None:
 
736
                other_ie = _none_entry
 
737
            if interesting_ids is not None and file_id not in interesting_ids:
 
738
                continue
 
739
 
 
740
            # If other_revision is found in any of the lcas, that means this
 
741
            # node is uninteresting. This is because when merging, if there are
 
742
            # multiple heads(), we have to create a new node. So if we didn't,
 
743
            # we know that the ancestry is linear, and that OTHER did not
 
744
            # modify anything
 
745
            # See doc/developers/lca_merge_resolution.txt for details
 
746
            other_revision = other_ie.revision
 
747
            if other_revision is not None:
 
748
                # We can't use this shortcut when other_revision is None,
 
749
                # because it may be None because things are WorkingTrees, and
 
750
                # not because it is *actually* None.
 
751
                is_unmodified = False
 
752
                for lca_path, ie in lca_values:
 
753
                    if ie is not None and ie.revision == other_revision:
 
754
                        is_unmodified = True
 
755
                        break
 
756
                if is_unmodified:
 
757
                    continue
 
758
 
 
759
            lca_entries = []
 
760
            for lca_path, lca_ie in lca_values:
 
761
                if lca_ie is None:
 
762
                    lca_entries.append(_none_entry)
 
763
                else:
 
764
                    lca_entries.append(lca_ie)
 
765
 
 
766
            if file_id in base_inventory:
 
767
                base_ie = base_inventory[file_id]
 
768
            else:
 
769
                base_ie = _none_entry
 
770
 
 
771
            if file_id in this_inventory:
 
772
                this_ie = this_inventory[file_id]
 
773
            else:
 
774
                this_ie = _none_entry
 
775
 
 
776
            lca_kinds = []
 
777
            lca_parent_ids = []
 
778
            lca_names = []
 
779
            lca_executable = []
 
780
            for lca_ie in lca_entries:
 
781
                lca_kinds.append(lca_ie.kind)
 
782
                lca_parent_ids.append(lca_ie.parent_id)
 
783
                lca_names.append(lca_ie.name)
 
784
                lca_executable.append(lca_ie.executable)
 
785
 
 
786
            kind_winner = self._lca_multi_way(
 
787
                (base_ie.kind, lca_kinds),
 
788
                other_ie.kind, this_ie.kind)
 
789
            parent_id_winner = self._lca_multi_way(
 
790
                (base_ie.parent_id, lca_parent_ids),
 
791
                other_ie.parent_id, this_ie.parent_id)
 
792
            name_winner = self._lca_multi_way(
 
793
                (base_ie.name, lca_names),
 
794
                other_ie.name, this_ie.name)
 
795
 
 
796
            content_changed = True
 
797
            if kind_winner == 'this':
 
798
                # No kind change in OTHER, see if there are *any* changes
 
799
                if other_ie.kind == 'directory':
 
800
                    if parent_id_winner == 'this' and name_winner == 'this':
 
801
                        # No change for this directory in OTHER, skip
 
802
                        continue
 
803
                    content_changed = False
 
804
                elif other_ie.kind is None or other_ie.kind == 'file':
 
805
                    def get_sha1(ie, tree):
 
806
                        if ie.kind != 'file':
 
807
                            return None
 
808
                        return tree.get_file_sha1(file_id)
 
809
                    base_sha1 = get_sha1(base_ie, self.base_tree)
 
810
                    lca_sha1s = [get_sha1(ie, tree) for ie, tree
 
811
                                 in zip(lca_entries, self._lca_trees)]
 
812
                    this_sha1 = get_sha1(this_ie, self.this_tree)
 
813
                    other_sha1 = get_sha1(other_ie, self.other_tree)
 
814
                    sha1_winner = self._lca_multi_way(
 
815
                        (base_sha1, lca_sha1s), other_sha1, this_sha1,
 
816
                        allow_overriding_lca=False)
 
817
                    exec_winner = self._lca_multi_way(
 
818
                        (base_ie.executable, lca_executable),
 
819
                        other_ie.executable, this_ie.executable)
 
820
                    if (parent_id_winner == 'this' and name_winner == 'this'
 
821
                        and sha1_winner == 'this' and exec_winner == 'this'):
 
822
                        # No kind, parent, name, exec, or content change for
 
823
                        # OTHER, so this node is not considered interesting
 
824
                        continue
 
825
                    if sha1_winner == 'this':
 
826
                        content_changed = False
 
827
                elif other_ie.kind == 'symlink':
 
828
                    def get_target(ie, tree):
 
829
                        if ie.kind != 'symlink':
 
830
                            return None
 
831
                        return tree.get_symlink_target(file_id)
 
832
                    base_target = get_target(base_ie, self.base_tree)
 
833
                    lca_targets = [get_target(ie, tree) for ie, tree
 
834
                                   in zip(lca_entries, self._lca_trees)]
 
835
                    this_target = get_target(this_ie, self.this_tree)
 
836
                    other_target = get_target(other_ie, self.other_tree)
 
837
                    target_winner = self._lca_multi_way(
 
838
                        (base_target, lca_targets),
 
839
                        other_target, this_target)
 
840
                    if (parent_id_winner == 'this' and name_winner == 'this'
 
841
                        and target_winner == 'this'):
 
842
                        # No kind, parent, name, or symlink target change
 
843
                        # not interesting
 
844
                        continue
 
845
                    if target_winner == 'this':
 
846
                        content_changed = False
 
847
                elif other_ie.kind == 'tree-reference':
 
848
                    # The 'changed' information seems to be handled at a higher
 
849
                    # level. At least, _entries3 returns False for content
 
850
                    # changed, even when at a new revision_id.
 
851
                    content_changed = False
 
852
                    if (parent_id_winner == 'this' and name_winner == 'this'):
 
853
                        # Nothing interesting
 
854
                        continue
 
855
                else:
 
856
                    raise AssertionError('unhandled kind: %s' % other_ie.kind)
 
857
                # XXX: We need to handle kind == 'symlink'
 
858
 
 
859
            # If we have gotten this far, that means something has changed
 
860
            result.append((file_id, content_changed,
 
861
                           ((base_ie.parent_id, lca_parent_ids),
 
862
                            other_ie.parent_id, this_ie.parent_id),
 
863
                           ((base_ie.name, lca_names),
 
864
                            other_ie.name, this_ie.name),
 
865
                           ((base_ie.executable, lca_executable),
 
866
                            other_ie.executable, this_ie.executable)
 
867
                          ))
 
868
        return result
 
869
 
 
870
 
 
871
    def fix_root(self):
 
872
        try:
 
873
            self.tt.final_kind(self.tt.root)
 
874
        except NoSuchFile:
 
875
            self.tt.cancel_deletion(self.tt.root)
 
876
        if self.tt.final_file_id(self.tt.root) is None:
 
877
            self.tt.version_file(self.tt.tree_file_id(self.tt.root),
 
878
                                 self.tt.root)
 
879
        other_root_file_id = self.other_tree.get_root_id()
 
880
        if other_root_file_id is None:
 
881
            return
 
882
        other_root = self.tt.trans_id_file_id(other_root_file_id)
 
883
        if other_root == self.tt.root:
 
884
            return
 
885
        try:
 
886
            self.tt.final_kind(other_root)
 
887
        except NoSuchFile:
 
888
            return
 
889
        if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
 
890
            # the other tree's root is a non-root in the current tree
 
891
            return
 
892
        self.reparent_children(self.other_tree.inventory.root, self.tt.root)
 
893
        self.tt.cancel_creation(other_root)
 
894
        self.tt.cancel_versioning(other_root)
 
895
 
 
896
    def reparent_children(self, ie, target):
 
897
        for thing, child in ie.children.iteritems():
 
898
            trans_id = self.tt.trans_id_file_id(child.file_id)
 
899
            self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
 
900
 
 
901
    def write_modified(self, results):
 
902
        modified_hashes = {}
 
903
        for path in results.modified_paths:
 
904
            file_id = self.this_tree.path2id(self.this_tree.relpath(path))
 
905
            if file_id is None:
 
906
                continue
 
907
            hash = self.this_tree.get_file_sha1(file_id)
 
908
            if hash is None:
 
909
                continue
 
910
            modified_hashes[file_id] = hash
 
911
        self.this_tree.set_merge_modified(modified_hashes)
 
912
 
 
913
    @staticmethod
 
914
    def parent(entry, file_id):
 
915
        """Determine the parent for a file_id (used as a key method)"""
 
916
        if entry is None:
 
917
            return None
 
918
        return entry.parent_id
 
919
 
 
920
    @staticmethod
 
921
    def name(entry, file_id):
 
922
        """Determine the name for a file_id (used as a key method)"""
 
923
        if entry is None:
 
924
            return None
 
925
        return entry.name
 
926
 
 
927
    @staticmethod
 
928
    def contents_sha1(tree, file_id):
 
929
        """Determine the sha1 of the file contents (used as a key method)."""
 
930
        if file_id not in tree:
 
931
            return None
 
932
        return tree.get_file_sha1(file_id)
 
933
 
 
934
    @staticmethod
 
935
    def executable(tree, file_id):
 
936
        """Determine the executability of a file-id (used as a key method)."""
 
937
        if file_id not in tree:
 
938
            return None
 
939
        if tree.kind(file_id) != "file":
 
940
            return False
 
941
        return tree.is_executable(file_id)
 
942
 
 
943
    @staticmethod
 
944
    def kind(tree, file_id):
 
945
        """Determine the kind of a file-id (used as a key method)."""
 
946
        if file_id not in tree:
 
947
            return None
 
948
        return tree.kind(file_id)
 
949
 
 
950
    @staticmethod
 
951
    def _three_way(base, other, this):
 
952
        #if base == other, either they all agree, or only THIS has changed.
 
953
        if base == other:
 
954
            return 'this'
 
955
        elif this not in (base, other):
 
956
            return 'conflict'
 
957
        # "Ambiguous clean merge" -- both sides have made the same change.
 
958
        elif this == other:
 
959
            return "this"
 
960
        # this == base: only other has changed.
 
961
        else:
 
962
            return "other"
 
963
 
 
964
    @staticmethod
 
965
    def _lca_multi_way(bases, other, this, allow_overriding_lca=True):
 
966
        """Consider LCAs when determining whether a change has occurred.
 
967
 
 
968
        If LCAS are all identical, this is the same as a _three_way comparison.
 
969
 
 
970
        :param bases: value in (BASE, [LCAS])
 
971
        :param other: value in OTHER
 
972
        :param this: value in THIS
 
973
        :param allow_overriding_lca: If there is more than one unique lca
 
974
            value, allow OTHER to override THIS if it has a new value, and
 
975
            THIS only has an lca value, or vice versa. This is appropriate for
 
976
            truly scalar values, not as much for non-scalars.
 
977
        :return: 'this', 'other', or 'conflict' depending on whether an entry
 
978
            changed or not.
 
979
        """
 
980
        # See doc/developers/lca_tree_merging.txt for details about this
 
981
        # algorithm.
 
982
        if other == this:
 
983
            # Either Ambiguously clean, or nothing was actually changed. We
 
984
            # don't really care
 
985
            return 'this'
 
986
        base_val, lca_vals = bases
 
987
        # Remove 'base_val' from the lca_vals, because it is not interesting
 
988
        filtered_lca_vals = [lca_val for lca_val in lca_vals
 
989
                                      if lca_val != base_val]
 
990
        if len(filtered_lca_vals) == 0:
 
991
            return Merge3Merger._three_way(base_val, other, this)
 
992
 
 
993
        unique_lca_vals = set(filtered_lca_vals)
 
994
        if len(unique_lca_vals) == 1:
 
995
            return Merge3Merger._three_way(unique_lca_vals.pop(), other, this)
 
996
 
 
997
        if allow_overriding_lca:
 
998
            if other in unique_lca_vals:
 
999
                if this in unique_lca_vals:
 
1000
                    # Each side picked a different lca, conflict
 
1001
                    return 'conflict'
 
1002
                else:
 
1003
                    # This has a value which supersedes both lca values, and
 
1004
                    # other only has an lca value
 
1005
                    return 'this'
 
1006
            elif this in unique_lca_vals:
 
1007
                # OTHER has a value which supersedes both lca values, and this
 
1008
                # only has an lca value
 
1009
                return 'other'
 
1010
 
 
1011
        # At this point, the lcas disagree, and the tips disagree
 
1012
        return 'conflict'
 
1013
 
 
1014
    @staticmethod
 
1015
    def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
 
1016
        """Do a three-way test on a scalar.
 
1017
        Return "this", "other" or "conflict", depending whether a value wins.
 
1018
        """
 
1019
        key_base = key(base_tree, file_id)
 
1020
        key_other = key(other_tree, file_id)
 
1021
        #if base == other, either they all agree, or only THIS has changed.
 
1022
        if key_base == key_other:
 
1023
            return "this"
 
1024
        key_this = key(this_tree, file_id)
 
1025
        # "Ambiguous clean merge"
 
1026
        if key_this == key_other:
 
1027
            return "this"
 
1028
        elif key_this == key_base:
 
1029
            return "other"
 
1030
        else:
 
1031
            return "conflict"
 
1032
 
 
1033
    def merge_names(self, file_id):
 
1034
        def get_entry(tree):
 
1035
            if file_id in tree.inventory:
 
1036
                return tree.inventory[file_id]
 
1037
            else:
 
1038
                return None
 
1039
        this_entry = get_entry(self.this_tree)
 
1040
        other_entry = get_entry(self.other_tree)
 
1041
        base_entry = get_entry(self.base_tree)
 
1042
        entries = (base_entry, other_entry, this_entry)
 
1043
        names = []
 
1044
        parents = []
 
1045
        for entry in entries:
 
1046
            if entry is None:
 
1047
                names.append(None)
 
1048
                parents.append(None)
 
1049
            else:
 
1050
                names.append(entry.name)
 
1051
                parents.append(entry.parent_id)
 
1052
        return self._merge_names(file_id, parents, names,
 
1053
                                 resolver=self._three_way)
 
1054
 
 
1055
    def _merge_names(self, file_id, parents, names, resolver):
 
1056
        """Perform a merge on file_id names and parents"""
 
1057
        base_name, other_name, this_name = names
 
1058
        base_parent, other_parent, this_parent = parents
 
1059
 
 
1060
        name_winner = resolver(*names)
 
1061
 
 
1062
        parent_id_winner = resolver(*parents)
 
1063
        if this_name is None:
 
1064
            if name_winner == "this":
 
1065
                name_winner = "other"
 
1066
            if parent_id_winner == "this":
 
1067
                parent_id_winner = "other"
 
1068
        if name_winner == "this" and parent_id_winner == "this":
 
1069
            return
 
1070
        if name_winner == "conflict":
 
1071
            trans_id = self.tt.trans_id_file_id(file_id)
 
1072
            self._raw_conflicts.append(('name conflict', trans_id,
 
1073
                                        this_name, other_name))
 
1074
        if parent_id_winner == "conflict":
 
1075
            trans_id = self.tt.trans_id_file_id(file_id)
 
1076
            self._raw_conflicts.append(('parent conflict', trans_id,
 
1077
                                        this_parent, other_parent))
 
1078
        if other_name is None:
 
1079
            # it doesn't matter whether the result was 'other' or
 
1080
            # 'conflict'-- if there's no 'other', we leave it alone.
 
1081
            return
 
1082
        # if we get here, name_winner and parent_winner are set to safe values.
 
1083
        trans_id = self.tt.trans_id_file_id(file_id)
 
1084
        parent_id = parents[self.winner_idx[parent_id_winner]]
 
1085
        if parent_id is not None:
 
1086
            parent_trans_id = self.tt.trans_id_file_id(parent_id)
 
1087
            self.tt.adjust_path(names[self.winner_idx[name_winner]],
 
1088
                                parent_trans_id, trans_id)
 
1089
 
 
1090
    def merge_contents(self, file_id):
 
1091
        """Performs a merge on file_id contents."""
 
1092
        def contents_pair(tree):
 
1093
            if file_id not in tree:
 
1094
                return (None, None)
 
1095
            kind = tree.kind(file_id)
 
1096
            if kind == "file":
 
1097
                contents = tree.get_file_sha1(file_id)
 
1098
            elif kind == "symlink":
 
1099
                contents = tree.get_symlink_target(file_id)
 
1100
            else:
 
1101
                contents = None
 
1102
            return kind, contents
 
1103
 
 
1104
        def contents_conflict():
 
1105
            trans_id = self.tt.trans_id_file_id(file_id)
 
1106
            name = self.tt.final_name(trans_id)
 
1107
            parent_id = self.tt.final_parent(trans_id)
 
1108
            if file_id in self.this_tree.inventory:
 
1109
                self.tt.unversion_file(trans_id)
 
1110
                if file_id in self.this_tree:
 
1111
                    self.tt.delete_contents(trans_id)
 
1112
            file_group = self._dump_conflicts(name, parent_id, file_id,
 
1113
                                              set_version=True)
 
1114
            self._raw_conflicts.append(('contents conflict', file_group))
 
1115
 
 
1116
        # See SPOT run.  run, SPOT, run.
 
1117
        # So we're not QUITE repeating ourselves; we do tricky things with
 
1118
        # file kind...
 
1119
        base_pair = contents_pair(self.base_tree)
 
1120
        other_pair = contents_pair(self.other_tree)
 
1121
        if self._lca_trees:
 
1122
            this_pair = contents_pair(self.this_tree)
 
1123
            lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
 
1124
            winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
 
1125
                                         this_pair, allow_overriding_lca=False)
 
1126
        else:
 
1127
            if base_pair == other_pair:
 
1128
                winner = 'this'
 
1129
            else:
 
1130
                # We delayed evaluating this_pair as long as we can to avoid
 
1131
                # unnecessary sha1 calculation
 
1132
                this_pair = contents_pair(self.this_tree)
 
1133
                winner = self._three_way(base_pair, other_pair, this_pair)
 
1134
        if winner == 'this':
 
1135
            # No interesting changes introduced by OTHER
 
1136
            return "unmodified"
 
1137
        trans_id = self.tt.trans_id_file_id(file_id)
 
1138
        if winner == 'other':
 
1139
            # OTHER is a straight winner, so replace this contents with other
 
1140
            file_in_this = file_id in self.this_tree
 
1141
            if file_in_this:
 
1142
                # Remove any existing contents
 
1143
                self.tt.delete_contents(trans_id)
 
1144
            if file_id in self.other_tree:
 
1145
                # OTHER changed the file
 
1146
                create_from_tree(self.tt, trans_id,
 
1147
                                 self.other_tree, file_id)
 
1148
                if not file_in_this:
 
1149
                    self.tt.version_file(file_id, trans_id)
 
1150
                return "modified"
 
1151
            elif file_in_this:
 
1152
                # OTHER deleted the file
 
1153
                self.tt.unversion_file(trans_id)
 
1154
                return "deleted"
 
1155
        else:
 
1156
            # We have a hypothetical conflict, but if we have files, then we
 
1157
            # can try to merge the content
 
1158
            if this_pair[0] == 'file' and other_pair[0] == 'file':
 
1159
                # THIS and OTHER are both files, so text merge.  Either
 
1160
                # BASE is a file, or both converted to files, so at least we
 
1161
                # have agreement that output should be a file.
 
1162
                try:
 
1163
                    self.text_merge(file_id, trans_id)
 
1164
                except BinaryFile:
 
1165
                    return contents_conflict()
 
1166
                if file_id not in self.this_tree:
 
1167
                    self.tt.version_file(file_id, trans_id)
 
1168
                try:
 
1169
                    self.tt.tree_kind(trans_id)
 
1170
                    self.tt.delete_contents(trans_id)
 
1171
                except NoSuchFile:
 
1172
                    pass
 
1173
                return "modified"
 
1174
            else:
 
1175
                return contents_conflict()
 
1176
 
 
1177
    def get_lines(self, tree, file_id):
 
1178
        """Return the lines in a file, or an empty list."""
 
1179
        if file_id in tree:
 
1180
            return tree.get_file(file_id).readlines()
 
1181
        else:
 
1182
            return []
 
1183
 
 
1184
    def text_merge(self, file_id, trans_id):
 
1185
        """Perform a three-way text merge on a file_id"""
 
1186
        # it's possible that we got here with base as a different type.
 
1187
        # if so, we just want two-way text conflicts.
 
1188
        if file_id in self.base_tree and \
 
1189
            self.base_tree.kind(file_id) == "file":
 
1190
            base_lines = self.get_lines(self.base_tree, file_id)
 
1191
        else:
 
1192
            base_lines = []
 
1193
        other_lines = self.get_lines(self.other_tree, file_id)
 
1194
        this_lines = self.get_lines(self.this_tree, file_id)
 
1195
        m3 = Merge3(base_lines, this_lines, other_lines,
 
1196
                    is_cherrypick=self.cherrypick)
 
1197
        start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
 
1198
        if self.show_base is True:
 
1199
            base_marker = '|' * 7
 
1200
        else:
 
1201
            base_marker = None
 
1202
 
 
1203
        def iter_merge3(retval):
 
1204
            retval["text_conflicts"] = False
 
1205
            for line in m3.merge_lines(name_a = "TREE",
 
1206
                                       name_b = "MERGE-SOURCE",
 
1207
                                       name_base = "BASE-REVISION",
 
1208
                                       start_marker=start_marker,
 
1209
                                       base_marker=base_marker,
 
1210
                                       reprocess=self.reprocess):
 
1211
                if line.startswith(start_marker):
 
1212
                    retval["text_conflicts"] = True
 
1213
                    yield line.replace(start_marker, '<' * 7)
 
1214
                else:
 
1215
                    yield line
 
1216
        retval = {}
 
1217
        merge3_iterator = iter_merge3(retval)
 
1218
        self.tt.create_file(merge3_iterator, trans_id)
 
1219
        if retval["text_conflicts"] is True:
 
1220
            self._raw_conflicts.append(('text conflict', trans_id))
 
1221
            name = self.tt.final_name(trans_id)
 
1222
            parent_id = self.tt.final_parent(trans_id)
 
1223
            file_group = self._dump_conflicts(name, parent_id, file_id,
 
1224
                                              this_lines, base_lines,
 
1225
                                              other_lines)
 
1226
            file_group.append(trans_id)
 
1227
 
 
1228
    def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
 
1229
                        base_lines=None, other_lines=None, set_version=False,
 
1230
                        no_base=False):
 
1231
        """Emit conflict files.
 
1232
        If this_lines, base_lines, or other_lines are omitted, they will be
 
1233
        determined automatically.  If set_version is true, the .OTHER, .THIS
 
1234
        or .BASE (in that order) will be created as versioned files.
 
1235
        """
 
1236
        data = [('OTHER', self.other_tree, other_lines),
 
1237
                ('THIS', self.this_tree, this_lines)]
 
1238
        if not no_base:
 
1239
            data.append(('BASE', self.base_tree, base_lines))
 
1240
        versioned = False
 
1241
        file_group = []
 
1242
        for suffix, tree, lines in data:
 
1243
            if file_id in tree:
 
1244
                trans_id = self._conflict_file(name, parent_id, tree, file_id,
 
1245
                                               suffix, lines)
 
1246
                file_group.append(trans_id)
 
1247
                if set_version and not versioned:
 
1248
                    self.tt.version_file(file_id, trans_id)
 
1249
                    versioned = True
 
1250
        return file_group
 
1251
 
 
1252
    def _conflict_file(self, name, parent_id, tree, file_id, suffix,
 
1253
                       lines=None):
 
1254
        """Emit a single conflict file."""
 
1255
        name = name + '.' + suffix
 
1256
        trans_id = self.tt.create_path(name, parent_id)
 
1257
        create_from_tree(self.tt, trans_id, tree, file_id, lines)
 
1258
        return trans_id
 
1259
 
 
1260
    def merge_executable(self, file_id, file_status):
 
1261
        """Perform a merge on the execute bit."""
 
1262
        executable = [self.executable(t, file_id) for t in (self.base_tree,
 
1263
                      self.other_tree, self.this_tree)]
 
1264
        self._merge_executable(file_id, executable, file_status,
 
1265
                               resolver=self._three_way)
 
1266
 
 
1267
    def _merge_executable(self, file_id, executable, file_status,
 
1268
                          resolver):
 
1269
        """Perform a merge on the execute bit."""
 
1270
        base_executable, other_executable, this_executable = executable
 
1271
        if file_status == "deleted":
 
1272
            return
 
1273
        winner = resolver(*executable)
 
1274
        if winner == "conflict":
 
1275
        # There must be a None in here, if we have a conflict, but we
 
1276
        # need executability since file status was not deleted.
 
1277
            if self.executable(self.other_tree, file_id) is None:
 
1278
                winner = "this"
 
1279
            else:
 
1280
                winner = "other"
 
1281
        if winner == 'this' and file_status != "modified":
 
1282
            return
 
1283
        trans_id = self.tt.trans_id_file_id(file_id)
 
1284
        try:
 
1285
            if self.tt.final_kind(trans_id) != "file":
 
1286
                return
 
1287
        except NoSuchFile:
 
1288
            return
 
1289
        if winner == "this":
 
1290
            executability = this_executable
 
1291
        else:
 
1292
            if file_id in self.other_tree:
 
1293
                executability = other_executable
 
1294
            elif file_id in self.this_tree:
 
1295
                executability = this_executable
 
1296
            elif file_id in self.base_tree:
 
1297
                executability = base_executable
 
1298
        if executability is not None:
 
1299
            trans_id = self.tt.trans_id_file_id(file_id)
 
1300
            self.tt.set_executability(executability, trans_id)
 
1301
 
 
1302
    def cook_conflicts(self, fs_conflicts):
 
1303
        """Convert all conflicts into a form that doesn't depend on trans_id"""
 
1304
        from conflicts import Conflict
 
1305
        name_conflicts = {}
 
1306
        self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
 
1307
        fp = FinalPaths(self.tt)
 
1308
        for conflict in self._raw_conflicts:
 
1309
            conflict_type = conflict[0]
 
1310
            if conflict_type in ('name conflict', 'parent conflict'):
 
1311
                trans_id = conflict[1]
 
1312
                conflict_args = conflict[2:]
 
1313
                if trans_id not in name_conflicts:
 
1314
                    name_conflicts[trans_id] = {}
 
1315
                unique_add(name_conflicts[trans_id], conflict_type,
 
1316
                           conflict_args)
 
1317
            if conflict_type == 'contents conflict':
 
1318
                for trans_id in conflict[1]:
 
1319
                    file_id = self.tt.final_file_id(trans_id)
 
1320
                    if file_id is not None:
 
1321
                        break
 
1322
                path = fp.get_path(trans_id)
 
1323
                for suffix in ('.BASE', '.THIS', '.OTHER'):
 
1324
                    if path.endswith(suffix):
 
1325
                        path = path[:-len(suffix)]
 
1326
                        break
 
1327
                c = Conflict.factory(conflict_type, path=path, file_id=file_id)
 
1328
                self.cooked_conflicts.append(c)
 
1329
            if conflict_type == 'text conflict':
 
1330
                trans_id = conflict[1]
 
1331
                path = fp.get_path(trans_id)
 
1332
                file_id = self.tt.final_file_id(trans_id)
 
1333
                c = Conflict.factory(conflict_type, path=path, file_id=file_id)
 
1334
                self.cooked_conflicts.append(c)
 
1335
 
 
1336
        for trans_id, conflicts in name_conflicts.iteritems():
 
1337
            try:
 
1338
                this_parent, other_parent = conflicts['parent conflict']
 
1339
                if this_parent == other_parent:
 
1340
                    raise AssertionError()
 
1341
            except KeyError:
 
1342
                this_parent = other_parent = \
 
1343
                    self.tt.final_file_id(self.tt.final_parent(trans_id))
 
1344
            try:
 
1345
                this_name, other_name = conflicts['name conflict']
 
1346
                if this_name == other_name:
 
1347
                    raise AssertionError()
 
1348
            except KeyError:
 
1349
                this_name = other_name = self.tt.final_name(trans_id)
 
1350
            other_path = fp.get_path(trans_id)
 
1351
            if this_parent is not None and this_name is not None:
 
1352
                this_parent_path = \
 
1353
                    fp.get_path(self.tt.trans_id_file_id(this_parent))
 
1354
                this_path = pathjoin(this_parent_path, this_name)
 
1355
            else:
 
1356
                this_path = "<deleted>"
 
1357
            file_id = self.tt.final_file_id(trans_id)
 
1358
            c = Conflict.factory('path conflict', path=this_path,
 
1359
                                 conflict_path=other_path, file_id=file_id)
 
1360
            self.cooked_conflicts.append(c)
 
1361
        self.cooked_conflicts.sort(key=Conflict.sort_key)
 
1362
 
 
1363
 
 
1364
class WeaveMerger(Merge3Merger):
 
1365
    """Three-way tree merger, text weave merger."""
 
1366
    supports_reprocess = True
 
1367
    supports_show_base = False
 
1368
    supports_reverse_cherrypick = False
 
1369
    history_based = True
 
1370
 
 
1371
    def _merged_lines(self, file_id):
 
1372
        """Generate the merged lines.
 
1373
        There is no distinction between lines that are meant to contain <<<<<<<
 
1374
        and conflicts.
 
1375
        """
 
1376
        if self.cherrypick:
 
1377
            base = self.base_tree
 
1378
        else:
 
1379
            base = None
 
1380
        plan = self.this_tree.plan_file_merge(file_id, self.other_tree,
 
1381
                                              base=base)
 
1382
        if 'merge' in debug.debug_flags:
 
1383
            plan = list(plan)
 
1384
            trans_id = self.tt.trans_id_file_id(file_id)
 
1385
            name = self.tt.final_name(trans_id) + '.plan'
 
1386
            contents = ('%10s|%s' % l for l in plan)
 
1387
            self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
 
1388
        textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
 
1389
            '>>>>>>> MERGE-SOURCE\n')
 
1390
        return textmerge.merge_lines(self.reprocess)
 
1391
 
 
1392
    def text_merge(self, file_id, trans_id):
 
1393
        """Perform a (weave) text merge for a given file and file-id.
 
1394
        If conflicts are encountered, .THIS and .OTHER files will be emitted,
 
1395
        and a conflict will be noted.
 
1396
        """
 
1397
        lines, conflicts = self._merged_lines(file_id)
 
1398
        lines = list(lines)
 
1399
        # Note we're checking whether the OUTPUT is binary in this case,
 
1400
        # because we don't want to get into weave merge guts.
 
1401
        check_text_lines(lines)
 
1402
        self.tt.create_file(lines, trans_id)
 
1403
        if conflicts:
 
1404
            self._raw_conflicts.append(('text conflict', trans_id))
 
1405
            name = self.tt.final_name(trans_id)
 
1406
            parent_id = self.tt.final_parent(trans_id)
 
1407
            file_group = self._dump_conflicts(name, parent_id, file_id,
 
1408
                                              no_base=True)
 
1409
            file_group.append(trans_id)
 
1410
 
 
1411
 
 
1412
class LCAMerger(WeaveMerger):
 
1413
 
 
1414
    def _merged_lines(self, file_id):
 
1415
        """Generate the merged lines.
 
1416
        There is no distinction between lines that are meant to contain <<<<<<<
 
1417
        and conflicts.
 
1418
        """
 
1419
        if self.cherrypick:
 
1420
            base = self.base_tree
 
1421
        else:
 
1422
            base = None
 
1423
        plan = self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
 
1424
                                                  base=base)
 
1425
        if 'merge' in debug.debug_flags:
 
1426
            plan = list(plan)
 
1427
            trans_id = self.tt.trans_id_file_id(file_id)
 
1428
            name = self.tt.final_name(trans_id) + '.plan'
 
1429
            contents = ('%10s|%s' % l for l in plan)
 
1430
            self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
 
1431
        textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
 
1432
            '>>>>>>> MERGE-SOURCE\n')
 
1433
        return textmerge.merge_lines(self.reprocess)
 
1434
 
 
1435
 
 
1436
class Diff3Merger(Merge3Merger):
 
1437
    """Three-way merger using external diff3 for text merging"""
 
1438
 
 
1439
    def dump_file(self, temp_dir, name, tree, file_id):
 
1440
        out_path = pathjoin(temp_dir, name)
 
1441
        out_file = open(out_path, "wb")
 
1442
        try:
 
1443
            in_file = tree.get_file(file_id)
 
1444
            for line in in_file:
 
1445
                out_file.write(line)
 
1446
        finally:
 
1447
            out_file.close()
 
1448
        return out_path
 
1449
 
 
1450
    def text_merge(self, file_id, trans_id):
 
1451
        """Perform a diff3 merge using a specified file-id and trans-id.
 
1452
        If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
 
1453
        will be dumped, and a will be conflict noted.
 
1454
        """
 
1455
        import bzrlib.patch
 
1456
        temp_dir = osutils.mkdtemp(prefix="bzr-")
 
1457
        try:
 
1458
            new_file = pathjoin(temp_dir, "new")
 
1459
            this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
 
1460
            base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
 
1461
            other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
 
1462
            status = bzrlib.patch.diff3(new_file, this, base, other)
 
1463
            if status not in (0, 1):
 
1464
                raise BzrError("Unhandled diff3 exit code")
 
1465
            f = open(new_file, 'rb')
 
1466
            try:
 
1467
                self.tt.create_file(f, trans_id)
 
1468
            finally:
 
1469
                f.close()
 
1470
            if status == 1:
 
1471
                name = self.tt.final_name(trans_id)
 
1472
                parent_id = self.tt.final_parent(trans_id)
 
1473
                self._dump_conflicts(name, parent_id, file_id)
 
1474
                self._raw_conflicts.append(('text conflict', trans_id))
 
1475
        finally:
 
1476
            osutils.rmtree(temp_dir)
 
1477
 
 
1478
 
 
1479
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
 
1480
                backup_files=False,
 
1481
                merge_type=Merge3Merger,
 
1482
                interesting_ids=None,
 
1483
                show_base=False,
 
1484
                reprocess=False,
 
1485
                other_rev_id=None,
 
1486
                interesting_files=None,
 
1487
                this_tree=None,
 
1488
                pb=DummyProgress(),
 
1489
                change_reporter=None):
 
1490
    """Primary interface for merging.
 
1491
 
 
1492
        typical use is probably
 
1493
        'merge_inner(branch, branch.get_revision_tree(other_revision),
 
1494
                     branch.get_revision_tree(base_revision))'
 
1495
        """
 
1496
    if this_tree is None:
 
1497
        raise BzrError("bzrlib.merge.merge_inner requires a this_tree "
 
1498
            "parameter as of bzrlib version 0.8.")
 
1499
    merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
 
1500
                    pb=pb, change_reporter=change_reporter)
 
1501
    merger.backup_files = backup_files
 
1502
    merger.merge_type = merge_type
 
1503
    merger.interesting_ids = interesting_ids
 
1504
    merger.ignore_zero = ignore_zero
 
1505
    if interesting_files:
 
1506
        if interesting_ids:
 
1507
            raise ValueError('Only supply interesting_ids'
 
1508
                             ' or interesting_files')
 
1509
        merger.interesting_files = interesting_files
 
1510
    merger.show_base = show_base
 
1511
    merger.reprocess = reprocess
 
1512
    merger.other_rev_id = other_rev_id
 
1513
    merger.other_basis = other_rev_id
 
1514
    get_revision_id = getattr(base_tree, 'get_revision_id', None)
 
1515
    if get_revision_id is None:
 
1516
        get_revision_id = base_tree.last_revision
 
1517
    merger.set_base_revision(get_revision_id(), this_branch)
 
1518
    return merger.do_merge()
 
1519
 
 
1520
def get_merge_type_registry():
 
1521
    """Merge type registry is in bzrlib.option to avoid circular imports.
 
1522
 
 
1523
    This method provides a sanctioned way to retrieve it.
 
1524
    """
 
1525
    from bzrlib import option
 
1526
    return option._merge_type_registry
 
1527
 
 
1528
 
 
1529
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
 
1530
    def status_a(revision, text):
 
1531
        if revision in ancestors_b:
 
1532
            return 'killed-b', text
 
1533
        else:
 
1534
            return 'new-a', text
 
1535
 
 
1536
    def status_b(revision, text):
 
1537
        if revision in ancestors_a:
 
1538
            return 'killed-a', text
 
1539
        else:
 
1540
            return 'new-b', text
 
1541
 
 
1542
    plain_a = [t for (a, t) in annotated_a]
 
1543
    plain_b = [t for (a, t) in annotated_b]
 
1544
    matcher = patiencediff.PatienceSequenceMatcher(None, plain_a, plain_b)
 
1545
    blocks = matcher.get_matching_blocks()
 
1546
    a_cur = 0
 
1547
    b_cur = 0
 
1548
    for ai, bi, l in blocks:
 
1549
        # process all mismatched sections
 
1550
        # (last mismatched section is handled because blocks always
 
1551
        # includes a 0-length last block)
 
1552
        for revision, text in annotated_a[a_cur:ai]:
 
1553
            yield status_a(revision, text)
 
1554
        for revision, text in annotated_b[b_cur:bi]:
 
1555
            yield status_b(revision, text)
 
1556
        # and now the matched section
 
1557
        a_cur = ai + l
 
1558
        b_cur = bi + l
 
1559
        for text_a in plain_a[ai:a_cur]:
 
1560
            yield "unchanged", text_a
 
1561
 
 
1562
 
 
1563
class _PlanMergeBase(object):
 
1564
 
 
1565
    def __init__(self, a_rev, b_rev, vf, key_prefix):
 
1566
        """Contructor.
 
1567
 
 
1568
        :param a_rev: Revision-id of one revision to merge
 
1569
        :param b_rev: Revision-id of the other revision to merge
 
1570
        :param vf: A VersionedFiles containing both revisions
 
1571
        :param key_prefix: A prefix for accessing keys in vf, typically
 
1572
            (file_id,).
 
1573
        """
 
1574
        self.a_rev = a_rev
 
1575
        self.b_rev = b_rev
 
1576
        self.vf = vf
 
1577
        self._last_lines = None
 
1578
        self._last_lines_revision_id = None
 
1579
        self._cached_matching_blocks = {}
 
1580
        self._key_prefix = key_prefix
 
1581
        self._precache_tip_lines()
 
1582
 
 
1583
    def _precache_tip_lines(self):
 
1584
        lines = self.get_lines([self.a_rev, self.b_rev])
 
1585
        self.lines_a = lines[self.a_rev]
 
1586
        self.lines_b = lines[self.b_rev]
 
1587
 
 
1588
    def get_lines(self, revisions):
 
1589
        """Get lines for revisions from the backing VersionedFiles.
 
1590
 
 
1591
        :raises RevisionNotPresent: on absent texts.
 
1592
        """
 
1593
        keys = [(self._key_prefix + (rev,)) for rev in revisions]
 
1594
        result = {}
 
1595
        for record in self.vf.get_record_stream(keys, 'unordered', True):
 
1596
            if record.storage_kind == 'absent':
 
1597
                raise errors.RevisionNotPresent(record.key, self.vf)
 
1598
            result[record.key[-1]] = osutils.chunks_to_lines(
 
1599
                record.get_bytes_as('chunked'))
 
1600
        return result
 
1601
 
 
1602
    def plan_merge(self):
 
1603
        """Generate a 'plan' for merging the two revisions.
 
1604
 
 
1605
        This involves comparing their texts and determining the cause of
 
1606
        differences.  If text A has a line and text B does not, then either the
 
1607
        line was added to text A, or it was deleted from B.  Once the causes
 
1608
        are combined, they are written out in the format described in
 
1609
        VersionedFile.plan_merge
 
1610
        """
 
1611
        blocks = self._get_matching_blocks(self.a_rev, self.b_rev)
 
1612
        unique_a, unique_b = self._unique_lines(blocks)
 
1613
        new_a, killed_b = self._determine_status(self.a_rev, unique_a)
 
1614
        new_b, killed_a = self._determine_status(self.b_rev, unique_b)
 
1615
        return self._iter_plan(blocks, new_a, killed_b, new_b, killed_a)
 
1616
 
 
1617
    def _iter_plan(self, blocks, new_a, killed_b, new_b, killed_a):
 
1618
        last_i = 0
 
1619
        last_j = 0
 
1620
        for i, j, n in blocks:
 
1621
            for a_index in range(last_i, i):
 
1622
                if a_index in new_a:
 
1623
                    if a_index in killed_b:
 
1624
                        yield 'conflicted-a', self.lines_a[a_index]
 
1625
                    else:
 
1626
                        yield 'new-a', self.lines_a[a_index]
 
1627
                else:
 
1628
                    yield 'killed-b', self.lines_a[a_index]
 
1629
            for b_index in range(last_j, j):
 
1630
                if b_index in new_b:
 
1631
                    if b_index in killed_a:
 
1632
                        yield 'conflicted-b', self.lines_b[b_index]
 
1633
                    else:
 
1634
                        yield 'new-b', self.lines_b[b_index]
 
1635
                else:
 
1636
                    yield 'killed-a', self.lines_b[b_index]
 
1637
            # handle common lines
 
1638
            for a_index in range(i, i+n):
 
1639
                yield 'unchanged', self.lines_a[a_index]
 
1640
            last_i = i+n
 
1641
            last_j = j+n
 
1642
 
 
1643
    def _get_matching_blocks(self, left_revision, right_revision):
 
1644
        """Return a description of which sections of two revisions match.
 
1645
 
 
1646
        See SequenceMatcher.get_matching_blocks
 
1647
        """
 
1648
        cached = self._cached_matching_blocks.get((left_revision,
 
1649
                                                   right_revision))
 
1650
        if cached is not None:
 
1651
            return cached
 
1652
        if self._last_lines_revision_id == left_revision:
 
1653
            left_lines = self._last_lines
 
1654
            right_lines = self.get_lines([right_revision])[right_revision]
 
1655
        else:
 
1656
            lines = self.get_lines([left_revision, right_revision])
 
1657
            left_lines = lines[left_revision]
 
1658
            right_lines = lines[right_revision]
 
1659
        self._last_lines = right_lines
 
1660
        self._last_lines_revision_id = right_revision
 
1661
        matcher = patiencediff.PatienceSequenceMatcher(None, left_lines,
 
1662
                                                       right_lines)
 
1663
        return matcher.get_matching_blocks()
 
1664
 
 
1665
    def _unique_lines(self, matching_blocks):
 
1666
        """Analyse matching_blocks to determine which lines are unique
 
1667
 
 
1668
        :return: a tuple of (unique_left, unique_right), where the values are
 
1669
            sets of line numbers of unique lines.
 
1670
        """
 
1671
        last_i = 0
 
1672
        last_j = 0
 
1673
        unique_left = []
 
1674
        unique_right = []
 
1675
        for i, j, n in matching_blocks:
 
1676
            unique_left.extend(range(last_i, i))
 
1677
            unique_right.extend(range(last_j, j))
 
1678
            last_i = i + n
 
1679
            last_j = j + n
 
1680
        return unique_left, unique_right
 
1681
 
 
1682
    @staticmethod
 
1683
    def _subtract_plans(old_plan, new_plan):
 
1684
        """Remove changes from new_plan that came from old_plan.
 
1685
 
 
1686
        It is assumed that the difference between the old_plan and new_plan
 
1687
        is their choice of 'b' text.
 
1688
 
 
1689
        All lines from new_plan that differ from old_plan are emitted
 
1690
        verbatim.  All lines from new_plan that match old_plan but are
 
1691
        not about the 'b' revision are emitted verbatim.
 
1692
 
 
1693
        Lines that match and are about the 'b' revision are the lines we
 
1694
        don't want, so we convert 'killed-b' -> 'unchanged', and 'new-b'
 
1695
        is skipped entirely.
 
1696
        """
 
1697
        matcher = patiencediff.PatienceSequenceMatcher(None, old_plan,
 
1698
                                                       new_plan)
 
1699
        last_j = 0
 
1700
        for i, j, n in matcher.get_matching_blocks():
 
1701
            for jj in range(last_j, j):
 
1702
                yield new_plan[jj]
 
1703
            for jj in range(j, j+n):
 
1704
                plan_line = new_plan[jj]
 
1705
                if plan_line[0] == 'new-b':
 
1706
                    pass
 
1707
                elif plan_line[0] == 'killed-b':
 
1708
                    yield 'unchanged', plan_line[1]
 
1709
                else:
 
1710
                    yield plan_line
 
1711
            last_j = j + n
 
1712
 
 
1713
 
 
1714
class _PlanMerge(_PlanMergeBase):
 
1715
    """Plan an annotate merge using on-the-fly annotation"""
 
1716
 
 
1717
    def __init__(self, a_rev, b_rev, vf, key_prefix):
 
1718
        super(_PlanMerge, self).__init__(a_rev, b_rev, vf, key_prefix)
 
1719
        self.a_key = self._key_prefix + (self.a_rev,)
 
1720
        self.b_key = self._key_prefix + (self.b_rev,)
 
1721
        self.graph = Graph(self.vf)
 
1722
        heads = self.graph.heads((self.a_key, self.b_key))
 
1723
        if len(heads) == 1:
 
1724
            # one side dominates, so we can just return its values, yay for
 
1725
            # per-file graphs
 
1726
            # Ideally we would know that before we get this far
 
1727
            self._head_key = heads.pop()
 
1728
            if self._head_key == self.a_key:
 
1729
                other = b_rev
 
1730
            else:
 
1731
                other = a_rev
 
1732
            mutter('found dominating revision for %s\n%s > %s', self.vf,
 
1733
                   self._head_key[-1], other)
 
1734
            self._weave = None
 
1735
        else:
 
1736
            self._head_key = None
 
1737
            self._build_weave()
 
1738
 
 
1739
    def _precache_tip_lines(self):
 
1740
        # Turn this into a no-op, because we will do this later
 
1741
        pass
 
1742
 
 
1743
    def _find_recursive_lcas(self):
 
1744
        """Find all the ancestors back to a unique lca"""
 
1745
        cur_ancestors = (self.a_key, self.b_key)
 
1746
        # graph.find_lca(uncommon, keys) now returns plain NULL_REVISION,
 
1747
        # rather than a key tuple. We will just map that directly to no common
 
1748
        # ancestors.
 
1749
        parent_map = {}
 
1750
        while True:
 
1751
            next_lcas = self.graph.find_lca(*cur_ancestors)
 
1752
            # Map a plain NULL_REVISION to a simple no-ancestors
 
1753
            if next_lcas == set([NULL_REVISION]):
 
1754
                next_lcas = ()
 
1755
            # Order the lca's based on when they were merged into the tip
 
1756
            # While the actual merge portion of weave merge uses a set() of
 
1757
            # active revisions, the order of insertion *does* effect the
 
1758
            # implicit ordering of the texts.
 
1759
            for rev_key in cur_ancestors:
 
1760
                ordered_parents = tuple(self.graph.find_merge_order(rev_key,
 
1761
                                                                    next_lcas))
 
1762
                parent_map[rev_key] = ordered_parents
 
1763
            if len(next_lcas) == 0:
 
1764
                break
 
1765
            elif len(next_lcas) == 1:
 
1766
                parent_map[list(next_lcas)[0]] = ()
 
1767
                break
 
1768
            elif len(next_lcas) > 2:
 
1769
                # More than 2 lca's, fall back to grabbing all nodes between
 
1770
                # this and the unique lca.
 
1771
                mutter('More than 2 LCAs, falling back to all nodes for:'
 
1772
                       ' %s, %s\n=> %s', self.a_key, self.b_key, cur_ancestors)
 
1773
                cur_lcas = next_lcas
 
1774
                while len(cur_lcas) > 1:
 
1775
                    cur_lcas = self.graph.find_lca(*cur_lcas)
 
1776
                if len(cur_lcas) == 0:
 
1777
                    # No common base to find, use the full ancestry
 
1778
                    unique_lca = None
 
1779
                else:
 
1780
                    unique_lca = list(cur_lcas)[0]
 
1781
                    if unique_lca == NULL_REVISION:
 
1782
                        # find_lca will return a plain 'NULL_REVISION' rather
 
1783
                        # than a key tuple when there is no common ancestor, we
 
1784
                        # prefer to just use None, because it doesn't confuse
 
1785
                        # _get_interesting_texts()
 
1786
                        unique_lca = None
 
1787
                parent_map.update(self._find_unique_parents(next_lcas,
 
1788
                                                            unique_lca))
 
1789
                break
 
1790
            cur_ancestors = next_lcas
 
1791
        return parent_map
 
1792
 
 
1793
    def _find_unique_parents(self, tip_keys, base_key):
 
1794
        """Find ancestors of tip that aren't ancestors of base.
 
1795
 
 
1796
        :param tip_keys: Nodes that are interesting
 
1797
        :param base_key: Cull all ancestors of this node
 
1798
        :return: The parent map for all revisions between tip_keys and
 
1799
            base_key. base_key will be included. References to nodes outside of
 
1800
            the ancestor set will also be removed.
 
1801
        """
 
1802
        # TODO: this would be simpler if find_unique_ancestors took a list
 
1803
        #       instead of a single tip, internally it supports it, but it
 
1804
        #       isn't a "backwards compatible" api change.
 
1805
        if base_key is None:
 
1806
            parent_map = dict(self.graph.iter_ancestry(tip_keys))
 
1807
            # We remove NULL_REVISION because it isn't a proper tuple key, and
 
1808
            # thus confuses things like _get_interesting_texts, and our logic
 
1809
            # to add the texts into the memory weave.
 
1810
            if NULL_REVISION in parent_map:
 
1811
                parent_map.pop(NULL_REVISION)
 
1812
        else:
 
1813
            interesting = set()
 
1814
            for tip in tip_keys:
 
1815
                interesting.update(
 
1816
                    self.graph.find_unique_ancestors(tip, [base_key]))
 
1817
            parent_map = self.graph.get_parent_map(interesting)
 
1818
            parent_map[base_key] = ()
 
1819
        culled_parent_map, child_map, tails = self._remove_external_references(
 
1820
            parent_map)
 
1821
        # Remove all the tails but base_key
 
1822
        if base_key is not None:
 
1823
            tails.remove(base_key)
 
1824
            self._prune_tails(culled_parent_map, child_map, tails)
 
1825
        # Now remove all the uninteresting 'linear' regions
 
1826
        simple_map = _mod_graph.collapse_linear_regions(culled_parent_map)
 
1827
        return simple_map
 
1828
 
 
1829
    @staticmethod
 
1830
    def _remove_external_references(parent_map):
 
1831
        """Remove references that go outside of the parent map.
 
1832
 
 
1833
        :param parent_map: Something returned from Graph.get_parent_map(keys)
 
1834
        :return: (filtered_parent_map, child_map, tails)
 
1835
            filtered_parent_map is parent_map without external references
 
1836
            child_map is the {parent_key: [child_keys]} mapping
 
1837
            tails is a list of nodes that do not have any parents in the map
 
1838
        """
 
1839
        # TODO: The basic effect of this function seems more generic than
 
1840
        #       _PlanMerge. But the specific details of building a child_map,
 
1841
        #       and computing tails seems very specific to _PlanMerge.
 
1842
        #       Still, should this be in Graph land?
 
1843
        filtered_parent_map = {}
 
1844
        child_map = {}
 
1845
        tails = []
 
1846
        for key, parent_keys in parent_map.iteritems():
 
1847
            culled_parent_keys = [p for p in parent_keys if p in parent_map]
 
1848
            if not culled_parent_keys:
 
1849
                tails.append(key)
 
1850
            for parent_key in culled_parent_keys:
 
1851
                child_map.setdefault(parent_key, []).append(key)
 
1852
            # TODO: Do we want to do this, it adds overhead for every node,
 
1853
            #       just to say that the node has no children
 
1854
            child_map.setdefault(key, [])
 
1855
            filtered_parent_map[key] = culled_parent_keys
 
1856
        return filtered_parent_map, child_map, tails
 
1857
 
 
1858
    @staticmethod
 
1859
    def _prune_tails(parent_map, child_map, tails_to_remove):
 
1860
        """Remove tails from the parent map.
 
1861
 
 
1862
        This will remove the supplied revisions until no more children have 0
 
1863
        parents.
 
1864
 
 
1865
        :param parent_map: A dict of {child: [parents]}, this dictionary will
 
1866
            be modified in place.
 
1867
        :param tails_to_remove: A list of tips that should be removed,
 
1868
            this list will be consumed
 
1869
        :param child_map: The reverse dict of parent_map ({parent: [children]})
 
1870
            this dict will be modified
 
1871
        :return: None, parent_map will be modified in place.
 
1872
        """
 
1873
        while tails_to_remove:
 
1874
            next = tails_to_remove.pop()
 
1875
            parent_map.pop(next)
 
1876
            children = child_map.pop(next)
 
1877
            for child in children:
 
1878
                child_parents = parent_map[child]
 
1879
                child_parents.remove(next)
 
1880
                if len(child_parents) == 0:
 
1881
                    tails_to_remove.append(child)
 
1882
 
 
1883
    def _get_interesting_texts(self, parent_map):
 
1884
        """Return a dict of texts we are interested in.
 
1885
 
 
1886
        Note that the input is in key tuples, but the output is in plain
 
1887
        revision ids.
 
1888
 
 
1889
        :param parent_map: The output from _find_recursive_lcas
 
1890
        :return: A dict of {'revision_id':lines} as returned by
 
1891
            _PlanMergeBase.get_lines()
 
1892
        """
 
1893
        all_revision_keys = set(parent_map)
 
1894
        all_revision_keys.add(self.a_key)
 
1895
        all_revision_keys.add(self.b_key)
 
1896
 
 
1897
        # Everything else is in 'keys' but get_lines is in 'revision_ids'
 
1898
        all_texts = self.get_lines([k[-1] for k in all_revision_keys])
 
1899
        return all_texts
 
1900
 
 
1901
    def _build_weave(self):
 
1902
        from bzrlib import weave
 
1903
        self._weave = weave.Weave(weave_name='in_memory_weave',
 
1904
                                  allow_reserved=True)
 
1905
        parent_map = self._find_recursive_lcas()
 
1906
 
 
1907
        all_texts = self._get_interesting_texts(parent_map)
 
1908
 
 
1909
        # Note: Unfortunately, the order given by topo_sort will effect the
 
1910
        # ordering resolution in the output. Specifically, if you add A then B,
 
1911
        # then in the output text A lines will show up before B lines. And, of
 
1912
        # course, topo_sort doesn't guarantee any real ordering.
 
1913
        # So we use merge_sort, and add a fake node on the tip.
 
1914
        # This ensures that left-hand parents will always be inserted into the
 
1915
        # weave before right-hand parents.
 
1916
        tip_key = self._key_prefix + (_mod_revision.CURRENT_REVISION,)
 
1917
        parent_map[tip_key] = (self.a_key, self.b_key)
 
1918
 
 
1919
        for seq_num, key, depth, eom in reversed(tsort.merge_sort(parent_map,
 
1920
                                                                  tip_key)):
 
1921
            if key == tip_key:
 
1922
                continue
 
1923
        # for key in tsort.topo_sort(parent_map):
 
1924
            parent_keys = parent_map[key]
 
1925
            revision_id = key[-1]
 
1926
            parent_ids = [k[-1] for k in parent_keys]
 
1927
            self._weave.add_lines(revision_id, parent_ids,
 
1928
                                  all_texts[revision_id])
 
1929
 
 
1930
    def plan_merge(self):
 
1931
        """Generate a 'plan' for merging the two revisions.
 
1932
 
 
1933
        This involves comparing their texts and determining the cause of
 
1934
        differences.  If text A has a line and text B does not, then either the
 
1935
        line was added to text A, or it was deleted from B.  Once the causes
 
1936
        are combined, they are written out in the format described in
 
1937
        VersionedFile.plan_merge
 
1938
        """
 
1939
        if self._head_key is not None: # There was a single head
 
1940
            if self._head_key == self.a_key:
 
1941
                plan = 'new-a'
 
1942
            else:
 
1943
                if self._head_key != self.b_key:
 
1944
                    raise AssertionError('There was an invalid head: %s != %s'
 
1945
                                         % (self.b_key, self._head_key))
 
1946
                plan = 'new-b'
 
1947
            head_rev = self._head_key[-1]
 
1948
            lines = self.get_lines([head_rev])[head_rev]
 
1949
            return ((plan, line) for line in lines)
 
1950
        return self._weave.plan_merge(self.a_rev, self.b_rev)
 
1951
 
 
1952
 
 
1953
class _PlanLCAMerge(_PlanMergeBase):
 
1954
    """
 
1955
    This merge algorithm differs from _PlanMerge in that:
 
1956
    1. comparisons are done against LCAs only
 
1957
    2. cases where a contested line is new versus one LCA but old versus
 
1958
       another are marked as conflicts, by emitting the line as conflicted-a
 
1959
       or conflicted-b.
 
1960
 
 
1961
    This is faster, and hopefully produces more useful output.
 
1962
    """
 
1963
 
 
1964
    def __init__(self, a_rev, b_rev, vf, key_prefix, graph):
 
1965
        _PlanMergeBase.__init__(self, a_rev, b_rev, vf, key_prefix)
 
1966
        lcas = graph.find_lca(key_prefix + (a_rev,), key_prefix + (b_rev,))
 
1967
        self.lcas = set()
 
1968
        for lca in lcas:
 
1969
            if lca == NULL_REVISION:
 
1970
                self.lcas.add(lca)
 
1971
            else:
 
1972
                self.lcas.add(lca[-1])
 
1973
        for lca in self.lcas:
 
1974
            if _mod_revision.is_null(lca):
 
1975
                lca_lines = []
 
1976
            else:
 
1977
                lca_lines = self.get_lines([lca])[lca]
 
1978
            matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_a,
 
1979
                                                           lca_lines)
 
1980
            blocks = list(matcher.get_matching_blocks())
 
1981
            self._cached_matching_blocks[(a_rev, lca)] = blocks
 
1982
            matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_b,
 
1983
                                                           lca_lines)
 
1984
            blocks = list(matcher.get_matching_blocks())
 
1985
            self._cached_matching_blocks[(b_rev, lca)] = blocks
 
1986
 
 
1987
    def _determine_status(self, revision_id, unique_line_numbers):
 
1988
        """Determines the status unique lines versus all lcas.
 
1989
 
 
1990
        Basically, determines why the line is unique to this revision.
 
1991
 
 
1992
        A line may be determined new, killed, or both.
 
1993
 
 
1994
        If a line is determined new, that means it was not present in at least
 
1995
        one LCA, and is not present in the other merge revision.
 
1996
 
 
1997
        If a line is determined killed, that means the line was present in
 
1998
        at least one LCA.
 
1999
 
 
2000
        If a line is killed and new, this indicates that the two merge
 
2001
        revisions contain differing conflict resolutions.
 
2002
        :param revision_id: The id of the revision in which the lines are
 
2003
            unique
 
2004
        :param unique_line_numbers: The line numbers of unique lines.
 
2005
        :return a tuple of (new_this, killed_other):
 
2006
        """
 
2007
        new = set()
 
2008
        killed = set()
 
2009
        unique_line_numbers = set(unique_line_numbers)
 
2010
        for lca in self.lcas:
 
2011
            blocks = self._get_matching_blocks(revision_id, lca)
 
2012
            unique_vs_lca, _ignored = self._unique_lines(blocks)
 
2013
            new.update(unique_line_numbers.intersection(unique_vs_lca))
 
2014
            killed.update(unique_line_numbers.difference(unique_vs_lca))
 
2015
        return new, killed