/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: John Arbash Meinel
  • Date: 2009-09-24 19:26:45 UTC
  • mto: (4634.52.3 2.0)
  • mto: This revision was merged to the branch mainline in revision 4716.
  • Revision ID: john@arbash-meinel.com-20090924192645-hyy1ycnnk6u3j5j6
Catch a corner case that we were missing.
The CHKInventory tests were passing, but failed for test_inv because
we were passing None to _getitems(). That only failed for InternalNodes,
but we were using a structure that didn't have internal nodes.
So now the test is parameterized on a small CHKInventory page size
to force those things out into the open.

Show diffs side-by-side

added added

removed removed

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