~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Guillermo Gonzalez
  • Date: 2008-08-16 18:43:33 UTC
  • mto: (3668.1.1 trunk) (3703.1.1 trunk)
  • mto: This revision was merged to the branch mainline in revision 3669.
  • Revision ID: guillo.gonzo@gmail.com-20080816184333-51of2k7wqi6nwtjo
 added _mac_mkdtemp, that chown tmp dir.

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
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
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
    tsort,
 
32
    )
23
33
from bzrlib.branch import Branch
24
34
from bzrlib.conflicts import ConflictList, Conflict
25
 
from bzrlib.delta import compare_trees
26
35
from bzrlib.errors import (BzrCommandError,
27
36
                           BzrError,
28
37
                           NoCommonAncestor,
36
45
                           WorkingTreeNotRevision,
37
46
                           BinaryFile,
38
47
                           )
 
48
from bzrlib.graph import Graph
39
49
from bzrlib.merge3 import Merge3
40
 
import bzrlib.osutils
41
 
from bzrlib.osutils import rename, pathjoin, rmtree
 
50
from bzrlib.osutils import rename, pathjoin
42
51
from progress import DummyProgress, ProgressPhase
43
 
from bzrlib.revision import common_ancestor, is_ancestor, NULL_REVISION
 
52
from bzrlib.revision import (NULL_REVISION, ensure_null)
44
53
from bzrlib.textfile import check_text_lines
45
 
from bzrlib.trace import mutter, warning, note
46
 
from bzrlib.transform import (TreeTransform, resolve_conflicts, cook_conflicts,
47
 
                              FinalPaths, create_by_entry, unique_add)
48
 
from bzrlib.versionedfile import WeaveMerge
 
54
from bzrlib.trace import mutter, warning, note, is_quiet
 
55
from bzrlib.transform import (TransformPreview, TreeTransform,
 
56
                              resolve_conflicts, cook_conflicts,
 
57
                              conflict_pass, FinalPaths, create_by_entry,
 
58
                              unique_add, ROOT_PARENT)
 
59
from bzrlib.versionedfile import PlanWeaveMerge
49
60
from bzrlib import ui
50
61
 
51
62
# TODO: Report back as changes are merged in
52
63
 
53
 
def _get_tree(treespec, local_branch=None):
54
 
    location, revno = treespec
55
 
    branch = Branch.open_containing(location)[0]
56
 
    if revno is None:
57
 
        revision = None
58
 
    elif revno == -1:
59
 
        revision = branch.last_revision()
60
 
    else:
61
 
        revision = branch.get_rev_id(revno)
62
 
        if revision is None:
63
 
            revision = NULL_REVISION
64
 
    return branch, _get_revid_tree(branch, revision, local_branch)
65
 
 
66
 
 
67
 
def _get_revid_tree(branch, revision, local_branch):
68
 
    if revision is None:
69
 
        base_tree = branch.bzrdir.open_workingtree()
70
 
    else:
71
 
        if local_branch is not None:
72
 
            if local_branch.base != branch.base:
73
 
                local_branch.fetch(branch, revision)
74
 
            base_tree = local_branch.repository.revision_tree(revision)
75
 
        else:
76
 
            base_tree = branch.repository.revision_tree(revision)
77
 
    return base_tree
78
 
 
79
64
 
80
65
def transform_tree(from_tree, to_tree, interesting_ids=None):
81
66
    merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
83
68
 
84
69
 
85
70
class Merger(object):
86
 
    def __init__(self, this_branch, other_tree=None, base_tree=None, 
87
 
                 this_tree=None, pb=DummyProgress()):
 
71
    def __init__(self, this_branch, other_tree=None, base_tree=None,
 
72
                 this_tree=None, pb=DummyProgress(), change_reporter=None,
 
73
                 recurse='down', revision_graph=None):
88
74
        object.__init__(self)
89
 
        assert this_tree is not None, "this_tree is required"
90
75
        self.this_branch = this_branch
91
 
        self.this_basis = this_branch.last_revision()
 
76
        self.this_basis = _mod_revision.ensure_null(
 
77
            this_branch.last_revision())
92
78
        self.this_rev_id = None
93
79
        self.this_tree = this_tree
94
80
        self.this_revision_tree = None
95
81
        self.this_basis_tree = None
96
82
        self.other_tree = other_tree
 
83
        self.other_branch = None
97
84
        self.base_tree = base_tree
98
85
        self.ignore_zero = False
99
86
        self.backup_files = False
100
87
        self.interesting_ids = None
 
88
        self.interesting_files = None
101
89
        self.show_base = False
102
90
        self.reprocess = False
103
 
        self._pb = pb 
 
91
        self._pb = pb
104
92
        self.pp = None
105
 
 
106
 
 
107
 
    def revision_tree(self, revision_id):
108
 
        return self.this_branch.repository.revision_tree(revision_id)
 
93
        self.recurse = recurse
 
94
        self.change_reporter = change_reporter
 
95
        self._cached_trees = {}
 
96
        self._revision_graph = revision_graph
 
97
        self._base_is_ancestor = None
 
98
        self._base_is_other_ancestor = None
 
99
 
 
100
    @property
 
101
    def revision_graph(self):
 
102
        if self._revision_graph is None:
 
103
            self._revision_graph = self.this_branch.repository.get_graph()
 
104
        return self._revision_graph
 
105
 
 
106
    def _set_base_is_ancestor(self, value):
 
107
        self._base_is_ancestor = value
 
108
 
 
109
    def _get_base_is_ancestor(self):
 
110
        if self._base_is_ancestor is None:
 
111
            self._base_is_ancestor = self.revision_graph.is_ancestor(
 
112
                self.base_rev_id, self.this_basis)
 
113
        return self._base_is_ancestor
 
114
 
 
115
    base_is_ancestor = property(_get_base_is_ancestor, _set_base_is_ancestor)
 
116
 
 
117
    def _set_base_is_other_ancestor(self, value):
 
118
        self._base_is_other_ancestor = value
 
119
 
 
120
    def _get_base_is_other_ancestor(self):
 
121
        if self._base_is_other_ancestor is None:
 
122
            if self.other_basis is None:
 
123
                return True
 
124
            self._base_is_other_ancestor = self.revision_graph.is_ancestor(
 
125
                self.base_rev_id, self.other_basis)
 
126
        return self._base_is_other_ancestor
 
127
 
 
128
    base_is_other_ancestor = property(_get_base_is_other_ancestor,
 
129
                                      _set_base_is_other_ancestor)
 
130
 
 
131
    @staticmethod
 
132
    def from_uncommitted(tree, other_tree, pb):
 
133
        """Return a Merger for uncommitted changes in other_tree.
 
134
 
 
135
        :param tree: The tree to merge into
 
136
        :param other_tree: The tree to get uncommitted changes from
 
137
        :param pb: A progress indicator
 
138
        """
 
139
        merger = Merger(tree.branch, other_tree, other_tree.basis_tree(), tree,
 
140
                        pb)
 
141
        merger.base_rev_id = merger.base_tree.get_revision_id()
 
142
        merger.other_rev_id = None
 
143
        merger.other_basis = merger.base_rev_id
 
144
        return merger
 
145
 
 
146
    @classmethod
 
147
    def from_mergeable(klass, tree, mergeable, pb):
 
148
        """Return a Merger for a bundle or merge directive.
 
149
 
 
150
        :param tree: The tree to merge changes into
 
151
        :param mergeable: A merge directive or bundle
 
152
        :param pb: A progress indicator
 
153
        """
 
154
        mergeable.install_revisions(tree.branch.repository)
 
155
        base_revision_id, other_revision_id, verified =\
 
156
            mergeable.get_merge_request(tree.branch.repository)
 
157
        revision_graph = tree.branch.repository.get_graph()
 
158
        if base_revision_id is not None:
 
159
            if (base_revision_id != _mod_revision.NULL_REVISION and
 
160
                revision_graph.is_ancestor(
 
161
                base_revision_id, tree.branch.last_revision())):
 
162
                base_revision_id = None
 
163
            else:
 
164
                warning('Performing cherrypick')
 
165
        merger = klass.from_revision_ids(pb, tree, other_revision_id,
 
166
                                         base_revision_id, revision_graph=
 
167
                                         revision_graph)
 
168
        return merger, verified
 
169
 
 
170
    @staticmethod
 
171
    def from_revision_ids(pb, tree, other, base=None, other_branch=None,
 
172
                          base_branch=None, revision_graph=None):
 
173
        """Return a Merger for revision-ids.
 
174
 
 
175
        :param tree: The tree to merge changes into
 
176
        :param other: The revision-id to use as OTHER
 
177
        :param base: The revision-id to use as BASE.  If not specified, will
 
178
            be auto-selected.
 
179
        :param other_branch: A branch containing the other revision-id.  If
 
180
            not supplied, tree.branch is used.
 
181
        :param base_branch: A branch containing the base revision-id.  If
 
182
            not supplied, other_branch or tree.branch will be used.
 
183
        :param revision_graph: If you have a revision_graph precomputed, pass
 
184
            it in, otherwise it will be created for you.
 
185
        :param pb: A progress indicator
 
186
        """
 
187
        merger = Merger(tree.branch, this_tree=tree, pb=pb,
 
188
                        revision_graph=revision_graph)
 
189
        if other_branch is None:
 
190
            other_branch = tree.branch
 
191
        merger.set_other_revision(other, other_branch)
 
192
        if base is None:
 
193
            merger.find_base()
 
194
        else:
 
195
            if base_branch is None:
 
196
                base_branch = other_branch
 
197
            merger.set_base_revision(base, base_branch)
 
198
        return merger
 
199
 
 
200
    def revision_tree(self, revision_id, branch=None):
 
201
        if revision_id not in self._cached_trees:
 
202
            if branch is None:
 
203
                branch = self.this_branch
 
204
            try:
 
205
                tree = self.this_tree.revision_tree(revision_id)
 
206
            except errors.NoSuchRevisionInTree:
 
207
                tree = branch.repository.revision_tree(revision_id)
 
208
            self._cached_trees[revision_id] = tree
 
209
        return self._cached_trees[revision_id]
 
210
 
 
211
    def _get_tree(self, treespec, possible_transports=None):
 
212
        from bzrlib import workingtree
 
213
        location, revno = treespec
 
214
        if revno is None:
 
215
            tree = workingtree.WorkingTree.open_containing(location)[0]
 
216
            return tree.branch, tree
 
217
        branch = Branch.open_containing(location, possible_transports)[0]
 
218
        if revno == -1:
 
219
            revision_id = branch.last_revision()
 
220
        else:
 
221
            revision_id = branch.get_rev_id(revno)
 
222
        revision_id = ensure_null(revision_id)
 
223
        return branch, self.revision_tree(revision_id, branch)
109
224
 
110
225
    def ensure_revision_trees(self):
111
226
        if self.this_revision_tree is None:
112
 
            self.this_basis_tree = self.this_branch.repository.revision_tree(
113
 
                self.this_basis)
 
227
            self.this_basis_tree = self.revision_tree(self.this_basis)
114
228
            if self.this_basis == self.this_rev_id:
115
229
                self.this_revision_tree = self.this_basis_tree
116
230
 
117
231
        if self.other_rev_id is None:
118
232
            other_basis_tree = self.revision_tree(self.other_basis)
119
 
            changes = compare_trees(self.other_tree, other_basis_tree)
 
233
            changes = other_basis_tree.changes_from(self.other_tree)
120
234
            if changes.has_changed():
121
235
                raise WorkingTreeNotRevision(self.this_tree)
122
236
            other_rev_id = self.other_basis
126
240
        self.ensure_revision_trees()
127
241
        def get_id(tree, file_id):
128
242
            revision_id = tree.inventory[file_id].revision
129
 
            assert revision_id is not None
130
243
            return revision_id
131
244
        if self.this_rev_id is None:
132
245
            if self.this_basis_tree.get_file_sha1(file_id) != \
138
251
 
139
252
    def check_basis(self, check_clean, require_commits=True):
140
253
        if self.this_basis is None and require_commits is True:
141
 
            raise BzrCommandError("This branch has no commits")
 
254
            raise BzrCommandError("This branch has no commits."
 
255
                                  " (perhaps you would prefer 'bzr pull')")
142
256
        if check_clean:
143
257
            self.compare_basis()
144
258
            if self.this_basis != self.this_rev_id:
145
 
                raise BzrCommandError("Working tree has uncommitted changes.")
 
259
                raise errors.UncommittedChanges(self.this_tree)
146
260
 
147
261
    def compare_basis(self):
148
 
        changes = compare_trees(self.this_tree, 
149
 
                                self.this_tree.basis_tree(), False)
 
262
        try:
 
263
            basis_tree = self.revision_tree(self.this_tree.last_revision())
 
264
        except errors.NoSuchRevision:
 
265
            basis_tree = self.this_tree.basis_tree()
 
266
        changes = self.this_tree.changes_from(basis_tree)
150
267
        if not changes.has_changed():
151
268
            self.this_rev_id = self.this_basis
152
269
 
153
270
    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
 
271
        self.interesting_files = file_list
177
272
 
178
273
    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_pending_merge(self.other_rev_id)
187
 
 
188
 
    def set_other(self, other_revision):
189
 
        other_branch, self.other_tree = _get_tree(other_revision, 
190
 
                                                  self.this_branch)
 
274
        if not self.base_is_ancestor or not self.base_is_other_ancestor or self.other_rev_id is None:
 
275
            return
 
276
        self._add_parent()
 
277
 
 
278
    def _add_parent(self):
 
279
        new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
 
280
        new_parent_trees = []
 
281
        for revision_id in new_parents:
 
282
            try:
 
283
                tree = self.revision_tree(revision_id)
 
284
            except errors.NoSuchRevision:
 
285
                tree = None
 
286
            else:
 
287
                tree.lock_read()
 
288
            new_parent_trees.append((revision_id, tree))
 
289
        try:
 
290
            self.this_tree.set_parent_trees(new_parent_trees,
 
291
                                            allow_leftmost_as_ghost=True)
 
292
        finally:
 
293
            for _revision_id, tree in new_parent_trees:
 
294
                if tree is not None:
 
295
                    tree.unlock()
 
296
 
 
297
    def set_other(self, other_revision, possible_transports=None):
 
298
        """Set the revision and tree to merge from.
 
299
 
 
300
        This sets the other_tree, other_rev_id, other_basis attributes.
 
301
 
 
302
        :param other_revision: The [path, revision] list to merge from.
 
303
        """
 
304
        self.other_branch, self.other_tree = self._get_tree(other_revision,
 
305
                                                            possible_transports)
191
306
        if other_revision[1] == -1:
192
 
            self.other_rev_id = other_branch.last_revision()
193
 
            if self.other_rev_id is None:
194
 
                raise NoCommits(other_branch)
 
307
            self.other_rev_id = _mod_revision.ensure_null(
 
308
                self.other_branch.last_revision())
 
309
            if _mod_revision.is_null(self.other_rev_id):
 
310
                raise NoCommits(self.other_branch)
195
311
            self.other_basis = self.other_rev_id
196
312
        elif other_revision[1] is not None:
197
 
            self.other_rev_id = other_branch.get_rev_id(other_revision[1])
 
313
            self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
198
314
            self.other_basis = self.other_rev_id
199
315
        else:
200
316
            self.other_rev_id = None
201
 
            self.other_basis = other_branch.last_revision()
 
317
            self.other_basis = self.other_branch.last_revision()
202
318
            if self.other_basis is None:
203
 
                raise NoCommits(other_branch)
204
 
        if other_branch.base != self.this_branch.base:
205
 
            self.this_branch.fetch(other_branch, last_revision=self.other_basis)
 
319
                raise NoCommits(self.other_branch)
 
320
        if self.other_rev_id is not None:
 
321
            self._cached_trees[self.other_rev_id] = self.other_tree
 
322
        self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
 
323
 
 
324
    def set_other_revision(self, revision_id, other_branch):
 
325
        """Set 'other' based on a branch and revision id
 
326
 
 
327
        :param revision_id: The revision to use for a tree
 
328
        :param other_branch: The branch containing this tree
 
329
        """
 
330
        self.other_rev_id = revision_id
 
331
        self.other_branch = other_branch
 
332
        self._maybe_fetch(other_branch, self.this_branch, self.other_rev_id)
 
333
        self.other_tree = self.revision_tree(revision_id)
 
334
        self.other_basis = revision_id
 
335
 
 
336
    def set_base_revision(self, revision_id, branch):
 
337
        """Set 'base' based on a branch and revision id
 
338
 
 
339
        :param revision_id: The revision to use for a tree
 
340
        :param branch: The branch containing this tree
 
341
        """
 
342
        self.base_rev_id = revision_id
 
343
        self.base_branch = branch
 
344
        self._maybe_fetch(branch, self.this_branch, revision_id)
 
345
        self.base_tree = self.revision_tree(revision_id)
 
346
 
 
347
    def _maybe_fetch(self, source, target, revision_id):
 
348
        if not source.repository.has_same_location(target.repository):
 
349
            target.fetch(source, revision_id)
206
350
 
207
351
    def find_base(self):
208
 
        self.set_base([None, None])
 
352
        revisions = [ensure_null(self.this_basis),
 
353
                     ensure_null(self.other_basis)]
 
354
        if NULL_REVISION in revisions:
 
355
            self.base_rev_id = NULL_REVISION
 
356
        else:
 
357
            self.base_rev_id, steps = self.revision_graph.find_unique_lca(
 
358
                revisions[0], revisions[1], count_steps=True)
 
359
            if self.base_rev_id == NULL_REVISION:
 
360
                raise UnrelatedBranches()
 
361
            if steps > 1:
 
362
                warning('Warning: criss-cross merge encountered.  See bzr'
 
363
                        ' help criss-cross.')
 
364
        self.base_tree = self.revision_tree(self.base_rev_id)
 
365
        self.base_is_ancestor = True
 
366
        self.base_is_other_ancestor = True
209
367
 
210
368
    def set_base(self, base_revision):
 
369
        """Set the base revision to use for the merge.
 
370
 
 
371
        :param base_revision: A 2-list containing a path and revision number.
 
372
        """
211
373
        mutter("doing merge() with no base_revision specified")
212
374
        if base_revision == [None, None]:
213
 
            try:
214
 
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
215
 
                try:
216
 
                    this_repo = self.this_branch.repository
217
 
                    self.base_rev_id = common_ancestor(self.this_basis, 
218
 
                                                       self.other_basis, 
219
 
                                                       this_repo, pb)
220
 
                finally:
221
 
                    pb.finished()
222
 
            except NoCommonAncestor:
223
 
                raise UnrelatedBranches()
224
 
            self.base_tree = _get_revid_tree(self.this_branch, self.base_rev_id,
225
 
                                            None)
226
 
            self.base_is_ancestor = True
 
375
            self.find_base()
227
376
        else:
228
 
            base_branch, self.base_tree = _get_tree(base_revision)
 
377
            base_branch, self.base_tree = self._get_tree(base_revision)
229
378
            if base_revision[1] == -1:
230
379
                self.base_rev_id = base_branch.last_revision()
231
380
            elif base_revision[1] is None:
232
 
                self.base_rev_id = None
 
381
                self.base_rev_id = _mod_revision.NULL_REVISION
233
382
            else:
234
 
                self.base_rev_id = base_branch.get_rev_id(base_revision[1])
235
 
            if self.this_branch.base != base_branch.base:
236
 
                self.this_branch.fetch(base_branch)
237
 
            self.base_is_ancestor = is_ancestor(self.this_basis, 
238
 
                                                self.base_rev_id,
239
 
                                                self.this_branch)
 
383
                self.base_rev_id = _mod_revision.ensure_null(
 
384
                    base_branch.get_rev_id(base_revision[1]))
 
385
            self._maybe_fetch(base_branch, self.this_branch, self.base_rev_id)
240
386
 
241
 
    def do_merge(self):
242
 
        kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree, 
243
 
                  'other_tree': self.other_tree, 
 
387
    def make_merger(self):
 
388
        kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
 
389
                  'other_tree': self.other_tree,
244
390
                  'interesting_ids': self.interesting_ids,
245
 
                  'pp': self.pp}
 
391
                  'interesting_files': self.interesting_files,
 
392
                  'pp': self.pp,
 
393
                  'do_merge': False}
246
394
        if self.merge_type.requires_base:
247
395
            kwargs['base_tree'] = self.base_tree
248
396
        if self.merge_type.supports_reprocess:
254
402
            kwargs['show_base'] = self.show_base
255
403
        elif self.show_base:
256
404
            raise BzrError("Showing base is not supported for this"
257
 
                                  " merge type. %s" % self.merge_type)
258
 
        merge = self.merge_type(pb=self._pb, **kwargs)
 
405
                           " merge type. %s" % self.merge_type)
 
406
        if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
 
407
            and not self.base_is_other_ancestor):
 
408
            raise errors.CannotReverseCherrypick()
 
409
        if self.merge_type.supports_cherrypick:
 
410
            kwargs['cherrypick'] = (not self.base_is_ancestor or
 
411
                                    not self.base_is_other_ancestor)
 
412
        return self.merge_type(pb=self._pb,
 
413
                               change_reporter=self.change_reporter,
 
414
                               **kwargs)
 
415
 
 
416
    def do_merge(self):
 
417
        self.this_tree.lock_tree_write()
 
418
        if self.base_tree is not None:
 
419
            self.base_tree.lock_read()
 
420
        if self.other_tree is not None:
 
421
            self.other_tree.lock_read()
 
422
        try:
 
423
            merge = self.make_merger()
 
424
            merge.do_merge()
 
425
            if self.recurse == 'down':
 
426
                for relpath, file_id in self.this_tree.iter_references():
 
427
                    sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
 
428
                    other_revision = self.other_tree.get_reference_revision(
 
429
                        file_id, relpath)
 
430
                    if  other_revision == sub_tree.last_revision():
 
431
                        continue
 
432
                    sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
 
433
                    sub_merge.merge_type = self.merge_type
 
434
                    other_branch = self.other_branch.reference_parent(file_id, relpath)
 
435
                    sub_merge.set_other_revision(other_revision, other_branch)
 
436
                    base_revision = self.base_tree.get_reference_revision(file_id)
 
437
                    sub_merge.base_tree = \
 
438
                        sub_tree.branch.repository.revision_tree(base_revision)
 
439
                    sub_merge.base_rev_id = base_revision
 
440
                    sub_merge.do_merge()
 
441
 
 
442
        finally:
 
443
            if self.other_tree is not None:
 
444
                self.other_tree.unlock()
 
445
            if self.base_tree is not None:
 
446
                self.base_tree.unlock()
 
447
            self.this_tree.unlock()
259
448
        if len(merge.cooked_conflicts) == 0:
260
 
            if not self.ignore_zero:
 
449
            if not self.ignore_zero and not is_quiet():
261
450
                note("All changes applied successfully.")
262
451
        else:
263
452
            note("%d conflicts encountered." % len(merge.cooked_conflicts))
264
453
 
265
454
        return len(merge.cooked_conflicts)
266
455
 
267
 
    def regen_inventory(self, new_entries):
268
 
        old_entries = self.this_tree.read_working_inventory()
269
 
        new_inventory = {}
270
 
        by_path = {}
271
 
        new_entries_map = {} 
272
 
        for path, file_id in new_entries:
273
 
            if path is None:
274
 
                continue
275
 
            new_entries_map[file_id] = path
276
 
 
277
 
        def id2path(file_id):
278
 
            path = new_entries_map.get(file_id)
279
 
            if path is not None:
280
 
                return path
281
 
            entry = old_entries[file_id]
282
 
            if entry.parent_id is None:
283
 
                return entry.name
284
 
            return pathjoin(id2path(entry.parent_id), entry.name)
285
 
            
286
 
        for file_id in old_entries:
287
 
            entry = old_entries[file_id]
288
 
            path = id2path(file_id)
289
 
            if file_id in self.base_tree.inventory:
290
 
                executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
291
 
            else:
292
 
                executable = getattr(entry, 'executable', False)
293
 
            new_inventory[file_id] = (path, file_id, entry.parent_id, 
294
 
                                      entry.kind, executable)
295
 
                                      
296
 
            by_path[path] = file_id
297
 
        
298
 
        deletions = 0
299
 
        insertions = 0
300
 
        new_path_list = []
301
 
        for path, file_id in new_entries:
302
 
            if path is None:
303
 
                del new_inventory[file_id]
304
 
                deletions += 1
305
 
            else:
306
 
                new_path_list.append((path, file_id))
307
 
                if file_id not in old_entries:
308
 
                    insertions += 1
309
 
        # Ensure no file is added before its parent
310
 
        new_path_list.sort()
311
 
        for path, file_id in new_path_list:
312
 
            if path == '':
313
 
                parent = None
314
 
            else:
315
 
                parent = by_path[os.path.dirname(path)]
316
 
            abspath = pathjoin(self.this_tree.basedir, path)
317
 
            kind = bzrlib.osutils.file_kind(abspath)
318
 
            if file_id in self.base_tree.inventory:
319
 
                executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
320
 
            else:
321
 
                executable = False
322
 
            new_inventory[file_id] = (path, file_id, parent, kind, executable)
323
 
            by_path[path] = file_id 
324
 
 
325
 
        # Get a list in insertion order
326
 
        new_inventory_list = new_inventory.values()
327
 
        mutter ("""Inventory regeneration:
328
 
    old length: %i insertions: %i deletions: %i new_length: %i"""\
329
 
            % (len(old_entries), insertions, deletions, 
330
 
               len(new_inventory_list)))
331
 
        assert len(new_inventory_list) == len(old_entries) + insertions\
332
 
            - deletions
333
 
        new_inventory_list.sort()
334
 
        return new_inventory_list
335
 
 
336
456
 
337
457
class Merge3Merger(object):
338
458
    """Three-way merger that uses the merge3 text merger"""
340
460
    supports_reprocess = True
341
461
    supports_show_base = True
342
462
    history_based = False
 
463
    supports_cherrypick = True
 
464
    supports_reverse_cherrypick = True
 
465
    winner_idx = {"this": 2, "other": 1, "conflict": 1}
343
466
 
344
467
    def __init__(self, working_tree, this_tree, base_tree, other_tree, 
345
468
                 interesting_ids=None, reprocess=False, show_base=False,
346
 
                 pb=DummyProgress(), pp=None):
347
 
        """Initialize the merger object and perform the merge."""
 
469
                 pb=DummyProgress(), pp=None, change_reporter=None,
 
470
                 interesting_files=None, do_merge=True,
 
471
                 cherrypick=False):
 
472
        """Initialize the merger object and perform the merge.
 
473
 
 
474
        :param working_tree: The working tree to apply the merge to
 
475
        :param this_tree: The local tree in the merge operation
 
476
        :param base_tree: The common tree in the merge operation
 
477
        :param other_tree: The other other tree to merge changes from
 
478
        :param interesting_ids: The file_ids of files that should be
 
479
            participate in the merge.  May not be combined with
 
480
            interesting_files.
 
481
        :param: reprocess If True, perform conflict-reduction processing.
 
482
        :param show_base: If True, show the base revision in text conflicts.
 
483
            (incompatible with reprocess)
 
484
        :param pb: A Progress bar
 
485
        :param pp: A ProgressPhase object
 
486
        :param change_reporter: An object that should report changes made
 
487
        :param interesting_files: The tree-relative paths of files that should
 
488
            participate in the merge.  If these paths refer to directories,
 
489
            the contents of those directories will also be included.  May not
 
490
            be combined with interesting_ids.  If neither interesting_files nor
 
491
            interesting_ids is specified, all files may participate in the
 
492
            merge.
 
493
        """
348
494
        object.__init__(self)
 
495
        if interesting_files is not None and interesting_ids is not None:
 
496
            raise ValueError(
 
497
                'specify either interesting_ids or interesting_files')
 
498
        self.interesting_ids = interesting_ids
 
499
        self.interesting_files = interesting_files
349
500
        self.this_tree = working_tree
350
501
        self.base_tree = base_tree
351
502
        self.other_tree = other_tree
355
506
        self.show_base = show_base
356
507
        self.pb = pb
357
508
        self.pp = pp
 
509
        self.change_reporter = change_reporter
 
510
        self.cherrypick = cherrypick
358
511
        if self.pp is None:
359
512
            self.pp = ProgressPhase("Merge phase", 3, self.pb)
 
513
        if do_merge:
 
514
            self.do_merge()
360
515
 
361
 
        if interesting_ids is not None:
362
 
            all_ids = interesting_ids
363
 
        else:
364
 
            all_ids = set(base_tree)
365
 
            all_ids.update(other_tree)
366
 
        working_tree.lock_write()
367
 
        self.tt = TreeTransform(working_tree, self.pb)
 
516
    def do_merge(self):
 
517
        self.this_tree.lock_tree_write()
 
518
        self.base_tree.lock_read()
 
519
        self.other_tree.lock_read()
 
520
        self.tt = TreeTransform(self.this_tree, self.pb)
368
521
        try:
369
522
            self.pp.next_phase()
370
 
            child_pb = ui.ui_factory.nested_progress_bar()
371
 
            try:
372
 
                for num, file_id in enumerate(all_ids):
373
 
                    child_pb.update('Preparing file merge', num, len(all_ids))
374
 
                    self.merge_names(file_id)
375
 
                    file_status = self.merge_contents(file_id)
376
 
                    self.merge_executable(file_id, file_status)
377
 
            finally:
378
 
                child_pb.finished()
379
 
                
380
 
            self.pp.next_phase()
381
 
            child_pb = ui.ui_factory.nested_progress_bar()
382
 
            try:
383
 
                fs_conflicts = resolve_conflicts(self.tt, child_pb)
384
 
            finally:
385
 
                child_pb.finished()
386
 
            self.cook_conflicts(fs_conflicts)
387
 
            for conflict in self.cooked_conflicts:
388
 
                warning(conflict)
389
 
            self.pp.next_phase()
390
 
            results = self.tt.apply()
 
523
            self._compute_transform()
 
524
            self.pp.next_phase()
 
525
            results = self.tt.apply(no_conflicts=True)
391
526
            self.write_modified(results)
392
527
            try:
393
 
                working_tree.add_conflicts(self.cooked_conflicts)
 
528
                self.this_tree.add_conflicts(self.cooked_conflicts)
394
529
            except UnsupportedOperation:
395
530
                pass
396
531
        finally:
397
532
            self.tt.finalize()
398
 
            working_tree.unlock()
399
 
            self.pb.clear()
 
533
            self.other_tree.unlock()
 
534
            self.base_tree.unlock()
 
535
            self.this_tree.unlock()
 
536
            self.pb.clear()
 
537
 
 
538
    def make_preview_transform(self):
 
539
        self.base_tree.lock_read()
 
540
        self.other_tree.lock_read()
 
541
        self.tt = TransformPreview(self.this_tree)
 
542
        try:
 
543
            self.pp.next_phase()
 
544
            self._compute_transform()
 
545
            self.pp.next_phase()
 
546
        finally:
 
547
            self.other_tree.unlock()
 
548
            self.base_tree.unlock()
 
549
            self.pb.clear()
 
550
        return self.tt
 
551
 
 
552
    def _compute_transform(self):
 
553
        entries = self._entries3()
 
554
        child_pb = ui.ui_factory.nested_progress_bar()
 
555
        try:
 
556
            for num, (file_id, changed, parents3, names3,
 
557
                      executable3) in enumerate(entries):
 
558
                child_pb.update('Preparing file merge', num, len(entries))
 
559
                self._merge_names(file_id, parents3, names3)
 
560
                if changed:
 
561
                    file_status = self.merge_contents(file_id)
 
562
                else:
 
563
                    file_status = 'unmodified'
 
564
                self._merge_executable(file_id,
 
565
                    executable3, file_status)
 
566
        finally:
 
567
            child_pb.finished()
 
568
        self.fix_root()
 
569
        self.pp.next_phase()
 
570
        child_pb = ui.ui_factory.nested_progress_bar()
 
571
        try:
 
572
            fs_conflicts = resolve_conflicts(self.tt, child_pb,
 
573
                lambda t, c: conflict_pass(t, c, self.other_tree))
 
574
        finally:
 
575
            child_pb.finished()
 
576
        if self.change_reporter is not None:
 
577
            from bzrlib import delta
 
578
            delta.report_changes(
 
579
                self.tt.iter_changes(), self.change_reporter)
 
580
        self.cook_conflicts(fs_conflicts)
 
581
        for conflict in self.cooked_conflicts:
 
582
            warning(conflict)
 
583
 
 
584
    def _entries3(self):
 
585
        """Gather data about files modified between three trees.
 
586
 
 
587
        Return a list of tuples of file_id, changed, parents3, names3,
 
588
        executable3.  changed is a boolean indicating whether the file contents
 
589
        or kind were changed.  parents3 is a tuple of parent ids for base,
 
590
        other and this.  names3 is a tuple of names for base, other and this.
 
591
        executable3 is a tuple of execute-bit values for base, other and this.
 
592
        """
 
593
        result = []
 
594
        iterator = self.other_tree.iter_changes(self.base_tree,
 
595
                include_unchanged=True, specific_files=self.interesting_files,
 
596
                extra_trees=[self.this_tree])
 
597
        for (file_id, paths, changed, versioned, parents, names, kind,
 
598
             executable) in iterator:
 
599
            if (self.interesting_ids is not None and
 
600
                file_id not in self.interesting_ids):
 
601
                continue
 
602
            if file_id in self.this_tree.inventory:
 
603
                entry = self.this_tree.inventory[file_id]
 
604
                this_name = entry.name
 
605
                this_parent = entry.parent_id
 
606
                this_executable = entry.executable
 
607
            else:
 
608
                this_name = None
 
609
                this_parent = None
 
610
                this_executable = None
 
611
            parents3 = parents + (this_parent,)
 
612
            names3 = names + (this_name,)
 
613
            executable3 = executable + (this_executable,)
 
614
            result.append((file_id, changed, parents3, names3, executable3))
 
615
        return result
 
616
 
 
617
    def fix_root(self):
 
618
        try:
 
619
            self.tt.final_kind(self.tt.root)
 
620
        except NoSuchFile:
 
621
            self.tt.cancel_deletion(self.tt.root)
 
622
        if self.tt.final_file_id(self.tt.root) is None:
 
623
            self.tt.version_file(self.tt.tree_file_id(self.tt.root), 
 
624
                                 self.tt.root)
 
625
        if self.other_tree.inventory.root is None:
 
626
            return
 
627
        other_root_file_id = self.other_tree.get_root_id()
 
628
        other_root = self.tt.trans_id_file_id(other_root_file_id)
 
629
        if other_root == self.tt.root:
 
630
            return
 
631
        try:
 
632
            self.tt.final_kind(other_root)
 
633
        except NoSuchFile:
 
634
            return
 
635
        self.reparent_children(self.other_tree.inventory.root, self.tt.root)
 
636
        self.tt.cancel_creation(other_root)
 
637
        self.tt.cancel_versioning(other_root)
 
638
 
 
639
    def reparent_children(self, ie, target):
 
640
        for thing, child in ie.children.iteritems():
 
641
            trans_id = self.tt.trans_id_file_id(child.file_id)
 
642
            self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
400
643
 
401
644
    def write_modified(self, results):
402
645
        modified_hashes = {}
448
691
        return tree.kind(file_id)
449
692
 
450
693
    @staticmethod
 
694
    def _three_way(base, other, this):
 
695
        #if base == other, either they all agree, or only THIS has changed.
 
696
        if base == other:
 
697
            return 'this'
 
698
        elif this not in (base, other):
 
699
            return 'conflict'
 
700
        # "Ambiguous clean merge" -- both sides have made the same change.
 
701
        elif this == other:
 
702
            return "this"
 
703
        # this == base: only other has changed.
 
704
        else:
 
705
            return "other"
 
706
 
 
707
    @staticmethod
451
708
    def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
452
709
        """Do a three-way test on a scalar.
453
710
        Return "this", "other" or "conflict", depending whether a value wins.
458
715
        if key_base == key_other:
459
716
            return "this"
460
717
        key_this = key(this_tree, file_id)
461
 
        if key_this not in (key_base, key_other):
 
718
        # "Ambiguous clean merge"
 
719
        if key_this == key_other:
 
720
            return "this"
 
721
        elif key_this == key_base:
 
722
            return "other"
 
723
        else:
462
724
            return "conflict"
463
 
        # "Ambiguous clean merge"
464
 
        elif key_this == key_other:
465
 
            return "this"
466
 
        else:
467
 
            assert key_this == key_base
468
 
            return "other"
469
725
 
470
726
    def merge_names(self, file_id):
471
 
        """Perform a merge on file_id names and parents"""
472
727
        def get_entry(tree):
473
728
            if file_id in tree.inventory:
474
729
                return tree.inventory[file_id]
477
732
        this_entry = get_entry(self.this_tree)
478
733
        other_entry = get_entry(self.other_tree)
479
734
        base_entry = get_entry(self.base_tree)
480
 
        name_winner = self.scalar_three_way(this_entry, base_entry, 
481
 
                                            other_entry, file_id, self.name)
482
 
        parent_id_winner = self.scalar_three_way(this_entry, base_entry, 
483
 
                                                 other_entry, file_id, 
484
 
                                                 self.parent)
485
 
        if this_entry is None:
 
735
        entries = (base_entry, other_entry, this_entry)
 
736
        names = []
 
737
        parents = []
 
738
        for entry in entries:
 
739
            if entry is None:
 
740
                names.append(None)
 
741
                parents.append(None)
 
742
            else:
 
743
                names.append(entry.name)
 
744
                parents.append(entry.parent_id)
 
745
        return self._merge_names(file_id, parents, names)
 
746
 
 
747
    def _merge_names(self, file_id, parents, names):
 
748
        """Perform a merge on file_id names and parents"""
 
749
        base_name, other_name, this_name = names
 
750
        base_parent, other_parent, this_parent = parents
 
751
 
 
752
        name_winner = self._three_way(*names)
 
753
 
 
754
        parent_id_winner = self._three_way(*parents)
 
755
        if this_name is None:
486
756
            if name_winner == "this":
487
757
                name_winner = "other"
488
758
            if parent_id_winner == "this":
492
762
        if name_winner == "conflict":
493
763
            trans_id = self.tt.trans_id_file_id(file_id)
494
764
            self._raw_conflicts.append(('name conflict', trans_id, 
495
 
                                        self.name(this_entry, file_id), 
496
 
                                        self.name(other_entry, file_id)))
 
765
                                        this_name, other_name))
497
766
        if parent_id_winner == "conflict":
498
767
            trans_id = self.tt.trans_id_file_id(file_id)
499
768
            self._raw_conflicts.append(('parent conflict', trans_id, 
500
 
                                        self.parent(this_entry, file_id), 
501
 
                                        self.parent(other_entry, file_id)))
502
 
        if other_entry is None:
 
769
                                        this_parent, other_parent))
 
770
        if other_name is None:
503
771
            # it doesn't matter whether the result was 'other' or 
504
772
            # 'conflict'-- if there's no 'other', we leave it alone.
505
773
            return
506
774
        # if we get here, name_winner and parent_winner are set to safe values.
507
 
        winner_entry = {"this": this_entry, "other": other_entry, 
508
 
                        "conflict": other_entry}
509
775
        trans_id = self.tt.trans_id_file_id(file_id)
510
 
        parent_id = winner_entry[parent_id_winner].parent_id
511
 
        parent_trans_id = self.tt.trans_id_file_id(parent_id)
512
 
        self.tt.adjust_path(winner_entry[name_winner].name, parent_trans_id,
513
 
                            trans_id)
 
776
        parent_id = parents[self.winner_idx[parent_id_winner]]
 
777
        if parent_id is not None:
 
778
            parent_trans_id = self.tt.trans_id_file_id(parent_id)
 
779
            self.tt.adjust_path(names[self.winner_idx[name_winner]],
 
780
                                parent_trans_id, trans_id)
514
781
 
515
782
    def merge_contents(self, file_id):
516
783
        """Performa a merge on file_id contents."""
518
785
            if file_id not in tree:
519
786
                return (None, None)
520
787
            kind = tree.kind(file_id)
521
 
            if kind == "root_directory":
522
 
                kind = "directory"
523
788
            if kind == "file":
524
789
                contents = tree.get_file_sha1(file_id)
525
790
            elif kind == "symlink":
534
799
            parent_id = self.tt.final_parent(trans_id)
535
800
            if file_id in self.this_tree.inventory:
536
801
                self.tt.unversion_file(trans_id)
537
 
                self.tt.delete_contents(trans_id)
 
802
                if file_id in self.this_tree:
 
803
                    self.tt.delete_contents(trans_id)
538
804
            file_group = self._dump_conflicts(name, parent_id, file_id, 
539
805
                                              set_version=True)
540
806
            self._raw_conflicts.append(('contents conflict', file_group))
609
875
            base_lines = []
610
876
        other_lines = self.get_lines(self.other_tree, file_id)
611
877
        this_lines = self.get_lines(self.this_tree, file_id)
612
 
        m3 = Merge3(base_lines, this_lines, other_lines)
 
878
        m3 = Merge3(base_lines, this_lines, other_lines,
 
879
                    is_cherrypick=self.cherrypick)
613
880
        start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
614
881
        if self.show_base is True:
615
882
            base_marker = '|' * 7
676
943
 
677
944
    def merge_executable(self, file_id, file_status):
678
945
        """Perform a merge on the execute bit."""
 
946
        executable = [self.executable(t, file_id) for t in (self.base_tree,
 
947
                      self.other_tree, self.this_tree)]
 
948
        self._merge_executable(file_id, executable, file_status)
 
949
 
 
950
    def _merge_executable(self, file_id, executable, file_status):
 
951
        """Perform a merge on the execute bit."""
 
952
        base_executable, other_executable, this_executable = executable
679
953
        if file_status == "deleted":
680
954
            return
681
 
        trans_id = self.tt.trans_id_file_id(file_id)
682
 
        try:
683
 
            if self.tt.final_kind(trans_id) != "file":
684
 
                return
685
 
        except NoSuchFile:
686
 
            return
687
 
        winner = self.scalar_three_way(self.this_tree, self.base_tree, 
688
 
                                       self.other_tree, file_id, 
689
 
                                       self.executable)
 
955
        winner = self._three_way(*executable)
690
956
        if winner == "conflict":
691
957
        # There must be a None in here, if we have a conflict, but we
692
958
        # need executability since file status was not deleted.
694
960
                winner = "this"
695
961
            else:
696
962
                winner = "other"
 
963
        if winner == 'this' and file_status != "modified":
 
964
            return
 
965
        trans_id = self.tt.trans_id_file_id(file_id)
 
966
        try:
 
967
            if self.tt.final_kind(trans_id) != "file":
 
968
                return
 
969
        except NoSuchFile:
 
970
            return
697
971
        if winner == "this":
698
 
            if file_status == "modified":
699
 
                executability = self.this_tree.is_executable(file_id)
700
 
                if executability is not None:
701
 
                    trans_id = self.tt.trans_id_file_id(file_id)
702
 
                    self.tt.set_executability(executability, trans_id)
 
972
            executability = this_executable
703
973
        else:
704
 
            assert winner == "other"
705
974
            if file_id in self.other_tree:
706
 
                executability = self.other_tree.is_executable(file_id)
 
975
                executability = other_executable
707
976
            elif file_id in self.this_tree:
708
 
                executability = self.this_tree.is_executable(file_id)
 
977
                executability = this_executable
709
978
            elif file_id in self.base_tree:
710
 
                executability = self.base_tree.is_executable(file_id)
711
 
            if executability is not None:
712
 
                trans_id = self.tt.trans_id_file_id(file_id)
713
 
                self.tt.set_executability(executability, trans_id)
 
979
                executability = base_executable
 
980
        if executability is not None:
 
981
            trans_id = self.tt.trans_id_file_id(file_id)
 
982
            self.tt.set_executability(executability, trans_id)
714
983
 
715
984
    def cook_conflicts(self, fs_conflicts):
716
985
        """Convert all conflicts into a form that doesn't depend on trans_id"""
749
1018
        for trans_id, conflicts in name_conflicts.iteritems():
750
1019
            try:
751
1020
                this_parent, other_parent = conflicts['parent conflict']
752
 
                assert this_parent != other_parent
 
1021
                if this_parent == other_parent:
 
1022
                    raise AssertionError()
753
1023
            except KeyError:
754
1024
                this_parent = other_parent = \
755
1025
                    self.tt.final_file_id(self.tt.final_parent(trans_id))
756
1026
            try:
757
1027
                this_name, other_name = conflicts['name conflict']
758
 
                assert this_name != other_name
 
1028
                if this_name == other_name:
 
1029
                    raise AssertionError()
759
1030
            except KeyError:
760
1031
                this_name = other_name = self.tt.final_name(trans_id)
761
1032
            other_path = fp.get_path(trans_id)
762
 
            if this_parent is not None:
 
1033
            if this_parent is not None and this_name is not None:
763
1034
                this_parent_path = \
764
1035
                    fp.get_path(self.tt.trans_id_file_id(this_parent))
765
1036
                this_path = pathjoin(this_parent_path, this_name)
776
1047
    """Three-way tree merger, text weave merger."""
777
1048
    supports_reprocess = True
778
1049
    supports_show_base = False
779
 
 
780
 
    def __init__(self, working_tree, this_tree, base_tree, other_tree, 
781
 
                 interesting_ids=None, pb=DummyProgress(), pp=None,
782
 
                 reprocess=False):
783
 
        self.this_revision_tree = self._get_revision_tree(this_tree)
784
 
        self.other_revision_tree = self._get_revision_tree(other_tree)
785
 
        super(WeaveMerger, self).__init__(working_tree, this_tree, 
786
 
                                          base_tree, other_tree, 
787
 
                                          interesting_ids=interesting_ids, 
788
 
                                          pb=pb, pp=pp, reprocess=reprocess)
789
 
 
790
 
    def _get_revision_tree(self, tree):
791
 
        """Return a revision tree related to this tree.
792
 
        If the tree is a WorkingTree, the basis will be returned.
793
 
        """
794
 
        if getattr(tree, 'get_weave', False) is False:
795
 
            # If we have a WorkingTree, try using the basis
796
 
            return tree.branch.basis_tree()
797
 
        else:
798
 
            return tree
799
 
 
800
 
    def _check_file(self, file_id):
801
 
        """Check that the revision tree's version of the file matches."""
802
 
        for tree, rt in ((self.this_tree, self.this_revision_tree), 
803
 
                         (self.other_tree, self.other_revision_tree)):
804
 
            if rt is tree:
805
 
                continue
806
 
            if tree.get_file_sha1(file_id) != rt.get_file_sha1(file_id):
807
 
                raise WorkingTreeNotRevision(self.this_tree)
 
1050
    supports_reverse_cherrypick = False
 
1051
    history_based = True
808
1052
 
809
1053
    def _merged_lines(self, file_id):
810
1054
        """Generate the merged lines.
811
1055
        There is no distinction between lines that are meant to contain <<<<<<<
812
1056
        and conflicts.
813
1057
        """
814
 
        weave = self.this_revision_tree.get_weave(file_id)
815
 
        this_revision_id = self.this_revision_tree.inventory[file_id].revision
816
 
        other_revision_id = \
817
 
            self.other_revision_tree.inventory[file_id].revision
818
 
        wm = WeaveMerge(weave, this_revision_id, other_revision_id, 
819
 
                        '<<<<<<< TREE\n', '>>>>>>> MERGE-SOURCE\n')
820
 
        return wm.merge_lines(self.reprocess)
 
1058
        if self.cherrypick:
 
1059
            base = self.base_tree
 
1060
        else:
 
1061
            base = None
 
1062
        plan = self.this_tree.plan_file_merge(file_id, self.other_tree,
 
1063
                                              base=base)
 
1064
        if 'merge' in debug.debug_flags:
 
1065
            plan = list(plan)
 
1066
            trans_id = self.tt.trans_id_file_id(file_id)
 
1067
            name = self.tt.final_name(trans_id) + '.plan'
 
1068
            contents = ('%10s|%s' % l for l in plan)
 
1069
            self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
 
1070
        textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
 
1071
            '>>>>>>> MERGE-SOURCE\n')
 
1072
        return textmerge.merge_lines(self.reprocess)
821
1073
 
822
1074
    def text_merge(self, file_id, trans_id):
823
1075
        """Perform a (weave) text merge for a given file and file-id.
824
1076
        If conflicts are encountered, .THIS and .OTHER files will be emitted,
825
1077
        and a conflict will be noted.
826
1078
        """
827
 
        self._check_file(file_id)
828
1079
        lines, conflicts = self._merged_lines(file_id)
829
1080
        lines = list(lines)
830
1081
        # Note we're checking whether the OUTPUT is binary in this case, 
840
1091
            file_group.append(trans_id)
841
1092
 
842
1093
 
 
1094
class LCAMerger(WeaveMerger):
 
1095
 
 
1096
    def _merged_lines(self, file_id):
 
1097
        """Generate the merged lines.
 
1098
        There is no distinction between lines that are meant to contain <<<<<<<
 
1099
        and conflicts.
 
1100
        """
 
1101
        if self.cherrypick:
 
1102
            base = self.base_tree
 
1103
        else:
 
1104
            base = None
 
1105
        plan = self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
 
1106
                                                  base=base)
 
1107
        if 'merge' in debug.debug_flags:
 
1108
            plan = list(plan)
 
1109
            trans_id = self.tt.trans_id_file_id(file_id)
 
1110
            name = self.tt.final_name(trans_id) + '.plan'
 
1111
            contents = ('%10s|%s' % l for l in plan)
 
1112
            self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
 
1113
        textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
 
1114
            '>>>>>>> MERGE-SOURCE\n')
 
1115
        return textmerge.merge_lines(self.reprocess)
 
1116
 
 
1117
 
843
1118
class Diff3Merger(Merge3Merger):
844
1119
    """Three-way merger using external diff3 for text merging"""
845
1120
 
860
1135
        will be dumped, and a will be conflict noted.
861
1136
        """
862
1137
        import bzrlib.patch
863
 
        temp_dir = mkdtemp(prefix="bzr-")
 
1138
        temp_dir = osutils.mkdtemp(prefix="bzr-")
864
1139
        try:
865
1140
            new_file = pathjoin(temp_dir, "new")
866
1141
            this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
878
1153
                name = self.tt.final_name(trans_id)
879
1154
                parent_id = self.tt.final_parent(trans_id)
880
1155
                self._dump_conflicts(name, parent_id, file_id)
881
 
            self._raw_conflicts.append(('text conflict', trans_id))
 
1156
                self._raw_conflicts.append(('text conflict', trans_id))
882
1157
        finally:
883
 
            rmtree(temp_dir)
 
1158
            osutils.rmtree(temp_dir)
884
1159
 
885
1160
 
886
1161
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
887
 
                backup_files=False, 
888
 
                merge_type=Merge3Merger, 
889
 
                interesting_ids=None, 
890
 
                show_base=False, 
891
 
                reprocess=False, 
 
1162
                backup_files=False,
 
1163
                merge_type=Merge3Merger,
 
1164
                interesting_ids=None,
 
1165
                show_base=False,
 
1166
                reprocess=False,
892
1167
                other_rev_id=None,
893
1168
                interesting_files=None,
894
1169
                this_tree=None,
895
 
                pb=DummyProgress()):
 
1170
                pb=DummyProgress(),
 
1171
                change_reporter=None):
896
1172
    """Primary interface for merging. 
897
1173
 
898
1174
        typical use is probably 
900
1176
                     branch.get_revision_tree(base_revision))'
901
1177
        """
902
1178
    if this_tree is None:
903
 
        warnings.warn("bzrlib.merge.merge_inner requires a this_tree parameter as of "
904
 
             "bzrlib version 0.8.",
905
 
             DeprecationWarning,
906
 
             stacklevel=2)
907
 
        this_tree = this_branch.bzrdir.open_workingtree()
908
 
    merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree, 
909
 
                    pb=pb)
 
1179
        raise BzrError("bzrlib.merge.merge_inner requires a this_tree "
 
1180
            "parameter as of bzrlib version 0.8.")
 
1181
    merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
 
1182
                    pb=pb, change_reporter=change_reporter)
910
1183
    merger.backup_files = backup_files
911
1184
    merger.merge_type = merge_type
912
1185
    merger.interesting_ids = interesting_ids
913
1186
    merger.ignore_zero = ignore_zero
914
1187
    if interesting_files:
915
 
        assert not interesting_ids, ('Only supply interesting_ids'
916
 
                                     ' or interesting_files')
917
 
        merger._set_interesting_files(interesting_files)
918
 
    merger.show_base = show_base 
 
1188
        if interesting_ids:
 
1189
            raise ValueError('Only supply interesting_ids'
 
1190
                             ' or interesting_files')
 
1191
        merger.interesting_files = interesting_files
 
1192
    merger.show_base = show_base
919
1193
    merger.reprocess = reprocess
920
1194
    merger.other_rev_id = other_rev_id
921
1195
    merger.other_basis = other_rev_id
 
1196
    get_revision_id = getattr(base_tree, 'get_revision_id', None)
 
1197
    if get_revision_id is None:
 
1198
        get_revision_id = base_tree.last_revision
 
1199
    merger.set_base_revision(get_revision_id(), this_branch)
922
1200
    return merger.do_merge()
923
1201
 
924
 
 
925
 
merge_types = {     "merge3": (Merge3Merger, "Native diff3-style merge"), 
926
 
                     "diff3": (Diff3Merger,  "Merge using external diff3"),
927
 
                     'weave': (WeaveMerger, "Weave-based merge")
928
 
              }
929
 
 
930
 
 
931
 
def merge_type_help():
932
 
    templ = '%s%%7s: %%s' % (' '*12)
933
 
    lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
934
 
    return '\n'.join(lines)
 
1202
def get_merge_type_registry():
 
1203
    """Merge type registry is in bzrlib.option to avoid circular imports.
 
1204
 
 
1205
    This method provides a sanctioned way to retrieve it.
 
1206
    """
 
1207
    from bzrlib import option
 
1208
    return option._merge_type_registry
 
1209
 
 
1210
 
 
1211
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
 
1212
    def status_a(revision, text):
 
1213
        if revision in ancestors_b:
 
1214
            return 'killed-b', text
 
1215
        else:
 
1216
            return 'new-a', text
 
1217
 
 
1218
    def status_b(revision, text):
 
1219
        if revision in ancestors_a:
 
1220
            return 'killed-a', text
 
1221
        else:
 
1222
            return 'new-b', text
 
1223
 
 
1224
    plain_a = [t for (a, t) in annotated_a]
 
1225
    plain_b = [t for (a, t) in annotated_b]
 
1226
    matcher = patiencediff.PatienceSequenceMatcher(None, plain_a, plain_b)
 
1227
    blocks = matcher.get_matching_blocks()
 
1228
    a_cur = 0
 
1229
    b_cur = 0
 
1230
    for ai, bi, l in blocks:
 
1231
        # process all mismatched sections
 
1232
        # (last mismatched section is handled because blocks always
 
1233
        # includes a 0-length last block)
 
1234
        for revision, text in annotated_a[a_cur:ai]:
 
1235
            yield status_a(revision, text)
 
1236
        for revision, text in annotated_b[b_cur:bi]:
 
1237
            yield status_b(revision, text)
 
1238
        # and now the matched section
 
1239
        a_cur = ai + l
 
1240
        b_cur = bi + l
 
1241
        for text_a in plain_a[ai:a_cur]:
 
1242
            yield "unchanged", text_a
 
1243
 
 
1244
 
 
1245
class _PlanMergeBase(object):
 
1246
 
 
1247
    def __init__(self, a_rev, b_rev, vf, key_prefix):
 
1248
        """Contructor.
 
1249
 
 
1250
        :param a_rev: Revision-id of one revision to merge
 
1251
        :param b_rev: Revision-id of the other revision to merge
 
1252
        :param vf: A VersionedFiles containing both revisions
 
1253
        :param key_prefix: A prefix for accessing keys in vf, typically
 
1254
            (file_id,).
 
1255
        """
 
1256
        self.a_rev = a_rev
 
1257
        self.b_rev = b_rev
 
1258
        self.vf = vf
 
1259
        self._last_lines = None
 
1260
        self._last_lines_revision_id = None
 
1261
        self._cached_matching_blocks = {}
 
1262
        self._key_prefix = key_prefix
 
1263
        self._precache_tip_lines()
 
1264
 
 
1265
    def _precache_tip_lines(self):
 
1266
        lines = self.get_lines([self.a_rev, self.b_rev])
 
1267
        self.lines_a = lines[self.a_rev]
 
1268
        self.lines_b = lines[self.b_rev]
 
1269
 
 
1270
    def get_lines(self, revisions):
 
1271
        """Get lines for revisions from the backing VersionedFiles.
 
1272
        
 
1273
        :raises RevisionNotPresent: on absent texts.
 
1274
        """
 
1275
        keys = [(self._key_prefix + (rev,)) for rev in revisions]
 
1276
        result = {}
 
1277
        for record in self.vf.get_record_stream(keys, 'unordered', True):
 
1278
            if record.storage_kind == 'absent':
 
1279
                raise errors.RevisionNotPresent(record.key, self.vf)
 
1280
            result[record.key[-1]] = osutils.split_lines(
 
1281
                record.get_bytes_as('fulltext'))
 
1282
        return result
 
1283
 
 
1284
    def plan_merge(self):
 
1285
        """Generate a 'plan' for merging the two revisions.
 
1286
 
 
1287
        This involves comparing their texts and determining the cause of
 
1288
        differences.  If text A has a line and text B does not, then either the
 
1289
        line was added to text A, or it was deleted from B.  Once the causes
 
1290
        are combined, they are written out in the format described in
 
1291
        VersionedFile.plan_merge
 
1292
        """
 
1293
        blocks = self._get_matching_blocks(self.a_rev, self.b_rev)
 
1294
        unique_a, unique_b = self._unique_lines(blocks)
 
1295
        new_a, killed_b = self._determine_status(self.a_rev, unique_a)
 
1296
        new_b, killed_a = self._determine_status(self.b_rev, unique_b)
 
1297
        return self._iter_plan(blocks, new_a, killed_b, new_b, killed_a)
 
1298
 
 
1299
    def _iter_plan(self, blocks, new_a, killed_b, new_b, killed_a):
 
1300
        last_i = 0
 
1301
        last_j = 0
 
1302
        for i, j, n in blocks:
 
1303
            for a_index in range(last_i, i):
 
1304
                if a_index in new_a:
 
1305
                    if a_index in killed_b:
 
1306
                        yield 'conflicted-a', self.lines_a[a_index]
 
1307
                    else:
 
1308
                        yield 'new-a', self.lines_a[a_index]
 
1309
                else:
 
1310
                    yield 'killed-b', self.lines_a[a_index]
 
1311
            for b_index in range(last_j, j):
 
1312
                if b_index in new_b:
 
1313
                    if b_index in killed_a:
 
1314
                        yield 'conflicted-b', self.lines_b[b_index]
 
1315
                    else:
 
1316
                        yield 'new-b', self.lines_b[b_index]
 
1317
                else:
 
1318
                    yield 'killed-a', self.lines_b[b_index]
 
1319
            # handle common lines
 
1320
            for a_index in range(i, i+n):
 
1321
                yield 'unchanged', self.lines_a[a_index]
 
1322
            last_i = i+n
 
1323
            last_j = j+n
 
1324
 
 
1325
    def _get_matching_blocks(self, left_revision, right_revision):
 
1326
        """Return a description of which sections of two revisions match.
 
1327
 
 
1328
        See SequenceMatcher.get_matching_blocks
 
1329
        """
 
1330
        cached = self._cached_matching_blocks.get((left_revision,
 
1331
                                                   right_revision))
 
1332
        if cached is not None:
 
1333
            return cached
 
1334
        if self._last_lines_revision_id == left_revision:
 
1335
            left_lines = self._last_lines
 
1336
            right_lines = self.get_lines([right_revision])[right_revision]
 
1337
        else:
 
1338
            lines = self.get_lines([left_revision, right_revision])
 
1339
            left_lines = lines[left_revision]
 
1340
            right_lines = lines[right_revision]
 
1341
        self._last_lines = right_lines
 
1342
        self._last_lines_revision_id = right_revision
 
1343
        matcher = patiencediff.PatienceSequenceMatcher(None, left_lines,
 
1344
                                                       right_lines)
 
1345
        return matcher.get_matching_blocks()
 
1346
 
 
1347
    def _unique_lines(self, matching_blocks):
 
1348
        """Analyse matching_blocks to determine which lines are unique
 
1349
 
 
1350
        :return: a tuple of (unique_left, unique_right), where the values are
 
1351
            sets of line numbers of unique lines.
 
1352
        """
 
1353
        last_i = 0
 
1354
        last_j = 0
 
1355
        unique_left = []
 
1356
        unique_right = []
 
1357
        for i, j, n in matching_blocks:
 
1358
            unique_left.extend(range(last_i, i))
 
1359
            unique_right.extend(range(last_j, j))
 
1360
            last_i = i + n
 
1361
            last_j = j + n
 
1362
        return unique_left, unique_right
 
1363
 
 
1364
    @staticmethod
 
1365
    def _subtract_plans(old_plan, new_plan):
 
1366
        """Remove changes from new_plan that came from old_plan.
 
1367
 
 
1368
        It is assumed that the difference between the old_plan and new_plan
 
1369
        is their choice of 'b' text.
 
1370
 
 
1371
        All lines from new_plan that differ from old_plan are emitted
 
1372
        verbatim.  All lines from new_plan that match old_plan but are
 
1373
        not about the 'b' revision are emitted verbatim.
 
1374
 
 
1375
        Lines that match and are about the 'b' revision are the lines we
 
1376
        don't want, so we convert 'killed-b' -> 'unchanged', and 'new-b'
 
1377
        is skipped entirely.
 
1378
        """
 
1379
        matcher = patiencediff.PatienceSequenceMatcher(None, old_plan,
 
1380
                                                       new_plan)
 
1381
        last_j = 0
 
1382
        for i, j, n in matcher.get_matching_blocks():
 
1383
            for jj in range(last_j, j):
 
1384
                yield new_plan[jj]
 
1385
            for jj in range(j, j+n):
 
1386
                plan_line = new_plan[jj]
 
1387
                if plan_line[0] == 'new-b':
 
1388
                    pass
 
1389
                elif plan_line[0] == 'killed-b':
 
1390
                    yield 'unchanged', plan_line[1]
 
1391
                else:
 
1392
                    yield plan_line
 
1393
            last_j = j + n
 
1394
 
 
1395
 
 
1396
class _PlanMerge(_PlanMergeBase):
 
1397
    """Plan an annotate merge using on-the-fly annotation"""
 
1398
 
 
1399
    def __init__(self, a_rev, b_rev, vf, key_prefix):
 
1400
        super(_PlanMerge, self).__init__(a_rev, b_rev, vf, key_prefix)
 
1401
        self.a_key = self._key_prefix + (self.a_rev,)
 
1402
        self.b_key = self._key_prefix + (self.b_rev,)
 
1403
        self.graph = Graph(self.vf)
 
1404
        heads = self.graph.heads((self.a_key, self.b_key))
 
1405
        if len(heads) == 1:
 
1406
            # one side dominates, so we can just return its values, yay for
 
1407
            # per-file graphs
 
1408
            # Ideally we would know that before we get this far
 
1409
            self._head_key = heads.pop()
 
1410
            if self._head_key == self.a_key:
 
1411
                other = b_rev
 
1412
            else:
 
1413
                other = a_rev
 
1414
            mutter('found dominating revision for %s\n%s > %s', self.vf,
 
1415
                   self._head_key[-1], other)
 
1416
            self._weave = None
 
1417
        else:
 
1418
            self._head_key = None
 
1419
            self._build_weave()
 
1420
 
 
1421
    def _precache_tip_lines(self):
 
1422
        # Turn this into a no-op, because we will do this later
 
1423
        pass
 
1424
 
 
1425
    def _find_recursive_lcas(self):
 
1426
        """Find all the ancestors back to a unique lca"""
 
1427
        cur_ancestors = (self.a_key, self.b_key)
 
1428
        # graph.find_lca(uncommon, keys) now returns plain NULL_REVISION,
 
1429
        # rather than a key tuple. We will just map that directly to no common
 
1430
        # ancestors.
 
1431
        parent_map = {}
 
1432
        while True:
 
1433
            next_lcas = self.graph.find_lca(*cur_ancestors)
 
1434
            # Map a plain NULL_REVISION to a simple no-ancestors
 
1435
            if next_lcas == set([NULL_REVISION]):
 
1436
                next_lcas = ()
 
1437
            # Order the lca's based on when they were merged into the tip
 
1438
            # While the actual merge portion of weave merge uses a set() of
 
1439
            # active revisions, the order of insertion *does* effect the
 
1440
            # implicit ordering of the texts.
 
1441
            for rev_key in cur_ancestors:
 
1442
                ordered_parents = tuple(self.graph.find_merge_order(rev_key,
 
1443
                                                                    next_lcas))
 
1444
                parent_map[rev_key] = ordered_parents
 
1445
            if len(next_lcas) == 0:
 
1446
                break
 
1447
            elif len(next_lcas) == 1:
 
1448
                parent_map[list(next_lcas)[0]] = ()
 
1449
                break
 
1450
            elif len(next_lcas) > 2:
 
1451
                # More than 2 lca's, fall back to grabbing all nodes between
 
1452
                # this and the unique lca.
 
1453
                mutter('More than 2 LCAs, falling back to all nodes for:'
 
1454
                       ' %s, %s\n=> %s', self.a_key, self.b_key, cur_ancestors)
 
1455
                cur_lcas = next_lcas
 
1456
                while len(cur_lcas) > 1:
 
1457
                    cur_lcas = self.graph.find_lca(*cur_lcas)
 
1458
                if len(cur_lcas) == 0:
 
1459
                    # No common base to find, use the full ancestry
 
1460
                    unique_lca = None
 
1461
                else:
 
1462
                    unique_lca = list(cur_lcas)[0]
 
1463
                    if unique_lca == NULL_REVISION:
 
1464
                        # find_lca will return a plain 'NULL_REVISION' rather
 
1465
                        # than a key tuple when there is no common ancestor, we
 
1466
                        # prefer to just use None, because it doesn't confuse
 
1467
                        # _get_interesting_texts()
 
1468
                        unique_lca = None
 
1469
                parent_map.update(self._find_unique_parents(next_lcas,
 
1470
                                                            unique_lca))
 
1471
                break
 
1472
            cur_ancestors = next_lcas
 
1473
        return parent_map
 
1474
 
 
1475
    def _find_unique_parents(self, tip_keys, base_key):
 
1476
        """Find ancestors of tip that aren't ancestors of base.
 
1477
        
 
1478
        :param tip_keys: Nodes that are interesting
 
1479
        :param base_key: Cull all ancestors of this node
 
1480
        :return: The parent map for all revisions between tip_keys and
 
1481
            base_key. base_key will be included. References to nodes outside of
 
1482
            the ancestor set will also be removed.
 
1483
        """
 
1484
        # TODO: this would be simpler if find_unique_ancestors took a list
 
1485
        #       instead of a single tip, internally it supports it, but it
 
1486
        #       isn't a "backwards compatible" api change.
 
1487
        if base_key is None:
 
1488
            parent_map = dict(self.graph.iter_ancestry(tip_keys))
 
1489
            # We remove NULL_REVISION because it isn't a proper tuple key, and
 
1490
            # thus confuses things like _get_interesting_texts, and our logic
 
1491
            # to add the texts into the memory weave.
 
1492
            if NULL_REVISION in parent_map:
 
1493
                parent_map.pop(NULL_REVISION)
 
1494
        else:
 
1495
            interesting = set()
 
1496
            for tip in tip_keys:
 
1497
                interesting.update(
 
1498
                    self.graph.find_unique_ancestors(tip, [base_key]))
 
1499
            parent_map = self.graph.get_parent_map(interesting)
 
1500
            parent_map[base_key] = ()
 
1501
        culled_parent_map, child_map, tails = self._remove_external_references(
 
1502
            parent_map)
 
1503
        # Remove all the tails but base_key
 
1504
        if base_key is not None:
 
1505
            tails.remove(base_key)
 
1506
            self._prune_tails(culled_parent_map, child_map, tails)
 
1507
        # Now remove all the uninteresting 'linear' regions
 
1508
        simple_map = _mod_graph.collapse_linear_regions(culled_parent_map)
 
1509
        return simple_map
 
1510
 
 
1511
    @staticmethod
 
1512
    def _remove_external_references(parent_map):
 
1513
        """Remove references that go outside of the parent map.
 
1514
 
 
1515
        :param parent_map: Something returned from Graph.get_parent_map(keys)
 
1516
        :return: (filtered_parent_map, child_map, tails)
 
1517
            filtered_parent_map is parent_map without external references
 
1518
            child_map is the {parent_key: [child_keys]} mapping
 
1519
            tails is a list of nodes that do not have any parents in the map
 
1520
        """
 
1521
        # TODO: The basic effect of this function seems more generic than
 
1522
        #       _PlanMerge. But the specific details of building a child_map,
 
1523
        #       and computing tails seems very specific to _PlanMerge.
 
1524
        #       Still, should this be in Graph land?
 
1525
        filtered_parent_map = {}
 
1526
        child_map = {}
 
1527
        tails = []
 
1528
        for key, parent_keys in parent_map.iteritems():
 
1529
            culled_parent_keys = [p for p in parent_keys if p in parent_map]
 
1530
            if not culled_parent_keys:
 
1531
                tails.append(key)
 
1532
            for parent_key in culled_parent_keys:
 
1533
                child_map.setdefault(parent_key, []).append(key)
 
1534
            # TODO: Do we want to do this, it adds overhead for every node,
 
1535
            #       just to say that the node has no children
 
1536
            child_map.setdefault(key, [])
 
1537
            filtered_parent_map[key] = culled_parent_keys
 
1538
        return filtered_parent_map, child_map, tails
 
1539
 
 
1540
    @staticmethod
 
1541
    def _prune_tails(parent_map, child_map, tails_to_remove):
 
1542
        """Remove tails from the parent map.
 
1543
        
 
1544
        This will remove the supplied revisions until no more children have 0
 
1545
        parents.
 
1546
 
 
1547
        :param parent_map: A dict of {child: [parents]}, this dictionary will
 
1548
            be modified in place.
 
1549
        :param tails_to_remove: A list of tips that should be removed,
 
1550
            this list will be consumed
 
1551
        :param child_map: The reverse dict of parent_map ({parent: [children]})
 
1552
            this dict will be modified
 
1553
        :return: None, parent_map will be modified in place.
 
1554
        """
 
1555
        while tails_to_remove:
 
1556
            next = tails_to_remove.pop()
 
1557
            parent_map.pop(next)
 
1558
            children = child_map.pop(next)
 
1559
            for child in children:
 
1560
                child_parents = parent_map[child]
 
1561
                child_parents.remove(next)
 
1562
                if len(child_parents) == 0:
 
1563
                    tails_to_remove.append(child)
 
1564
 
 
1565
    def _get_interesting_texts(self, parent_map):
 
1566
        """Return a dict of texts we are interested in.
 
1567
 
 
1568
        Note that the input is in key tuples, but the output is in plain
 
1569
        revision ids.
 
1570
 
 
1571
        :param parent_map: The output from _find_recursive_lcas
 
1572
        :return: A dict of {'revision_id':lines} as returned by
 
1573
            _PlanMergeBase.get_lines()
 
1574
        """
 
1575
        all_revision_keys = set(parent_map)
 
1576
        all_revision_keys.add(self.a_key)
 
1577
        all_revision_keys.add(self.b_key)
 
1578
 
 
1579
        # Everything else is in 'keys' but get_lines is in 'revision_ids'
 
1580
        all_texts = self.get_lines([k[-1] for k in all_revision_keys])
 
1581
        return all_texts
 
1582
 
 
1583
    def _build_weave(self):
 
1584
        from bzrlib import weave
 
1585
        self._weave = weave.Weave(weave_name='in_memory_weave',
 
1586
                                  allow_reserved=True)
 
1587
        parent_map = self._find_recursive_lcas()
 
1588
 
 
1589
        all_texts = self._get_interesting_texts(parent_map)
 
1590
 
 
1591
        # Note: Unfortunately, the order given by topo_sort will effect the
 
1592
        # ordering resolution in the output. Specifically, if you add A then B,
 
1593
        # then in the output text A lines will show up before B lines. And, of
 
1594
        # course, topo_sort doesn't guarantee any real ordering.
 
1595
        # So we use merge_sort, and add a fake node on the tip.
 
1596
        # This ensures that left-hand parents will always be inserted into the
 
1597
        # weave before right-hand parents.
 
1598
        tip_key = self._key_prefix + (_mod_revision.CURRENT_REVISION,)
 
1599
        parent_map[tip_key] = (self.a_key, self.b_key)
 
1600
 
 
1601
        for seq_num, key, depth, eom in reversed(tsort.merge_sort(parent_map,
 
1602
                                                                  tip_key)):
 
1603
            if key == tip_key:
 
1604
                continue
 
1605
        # for key in tsort.topo_sort(parent_map):
 
1606
            parent_keys = parent_map[key]
 
1607
            revision_id = key[-1]
 
1608
            parent_ids = [k[-1] for k in parent_keys]
 
1609
            self._weave.add_lines(revision_id, parent_ids,
 
1610
                                  all_texts[revision_id])
 
1611
 
 
1612
    def plan_merge(self):
 
1613
        """Generate a 'plan' for merging the two revisions.
 
1614
 
 
1615
        This involves comparing their texts and determining the cause of
 
1616
        differences.  If text A has a line and text B does not, then either the
 
1617
        line was added to text A, or it was deleted from B.  Once the causes
 
1618
        are combined, they are written out in the format described in
 
1619
        VersionedFile.plan_merge
 
1620
        """
 
1621
        if self._head_key is not None: # There was a single head
 
1622
            if self._head_key == self.a_key:
 
1623
                plan = 'new-a'
 
1624
            else:
 
1625
                if self._head_key != self.b_key:
 
1626
                    raise AssertionError('There was an invalid head: %s != %s'
 
1627
                                         % (self.b_key, self._head_key))
 
1628
                plan = 'new-b'
 
1629
            head_rev = self._head_key[-1]
 
1630
            lines = self.get_lines([head_rev])[head_rev]
 
1631
            return ((plan, line) for line in lines)
 
1632
        return self._weave.plan_merge(self.a_rev, self.b_rev)
 
1633
 
 
1634
 
 
1635
class _PlanLCAMerge(_PlanMergeBase):
 
1636
    """
 
1637
    This merge algorithm differs from _PlanMerge in that:
 
1638
    1. comparisons are done against LCAs only
 
1639
    2. cases where a contested line is new versus one LCA but old versus
 
1640
       another are marked as conflicts, by emitting the line as conflicted-a
 
1641
       or conflicted-b.
 
1642
 
 
1643
    This is faster, and hopefully produces more useful output.
 
1644
    """
 
1645
 
 
1646
    def __init__(self, a_rev, b_rev, vf, key_prefix, graph):
 
1647
        _PlanMergeBase.__init__(self, a_rev, b_rev, vf, key_prefix)
 
1648
        lcas = graph.find_lca(key_prefix + (a_rev,), key_prefix + (b_rev,))
 
1649
        self.lcas = set()
 
1650
        for lca in lcas:
 
1651
            if lca == NULL_REVISION:
 
1652
                self.lcas.add(lca)
 
1653
            else:
 
1654
                self.lcas.add(lca[-1])
 
1655
        for lca in self.lcas:
 
1656
            if _mod_revision.is_null(lca):
 
1657
                lca_lines = []
 
1658
            else:
 
1659
                lca_lines = self.get_lines([lca])[lca]
 
1660
            matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_a,
 
1661
                                                           lca_lines)
 
1662
            blocks = list(matcher.get_matching_blocks())
 
1663
            self._cached_matching_blocks[(a_rev, lca)] = blocks
 
1664
            matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_b,
 
1665
                                                           lca_lines)
 
1666
            blocks = list(matcher.get_matching_blocks())
 
1667
            self._cached_matching_blocks[(b_rev, lca)] = blocks
 
1668
 
 
1669
    def _determine_status(self, revision_id, unique_line_numbers):
 
1670
        """Determines the status unique lines versus all lcas.
 
1671
 
 
1672
        Basically, determines why the line is unique to this revision.
 
1673
 
 
1674
        A line may be determined new, killed, or both.
 
1675
 
 
1676
        If a line is determined new, that means it was not present in at least
 
1677
        one LCA, and is not present in the other merge revision.
 
1678
 
 
1679
        If a line is determined killed, that means the line was present in
 
1680
        at least one LCA.
 
1681
 
 
1682
        If a line is killed and new, this indicates that the two merge
 
1683
        revisions contain differing conflict resolutions.
 
1684
        :param revision_id: The id of the revision in which the lines are
 
1685
            unique
 
1686
        :param unique_line_numbers: The line numbers of unique lines.
 
1687
        :return a tuple of (new_this, killed_other):
 
1688
        """
 
1689
        new = set()
 
1690
        killed = set()
 
1691
        unique_line_numbers = set(unique_line_numbers)
 
1692
        for lca in self.lcas:
 
1693
            blocks = self._get_matching_blocks(revision_id, lca)
 
1694
            unique_vs_lca, _ignored = self._unique_lines(blocks)
 
1695
            new.update(unique_line_numbers.intersection(unique_vs_lca))
 
1696
            killed.update(unique_line_numbers.difference(unique_vs_lca))
 
1697
        return new, killed