/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: Aaron Bentley
  • Date: 2007-07-25 22:03:13 UTC
  • mto: (1551.19.24 Aaron's mergeable stuff)
  • mto: This revision was merged to the branch mainline in revision 2664.
  • Revision ID: abentley@panoramicfeedback.com-20070725220313-3yi654e1utu1xd73
Avoid using builtins.merge

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
 
18
import os
 
19
import errno
 
20
import warnings
 
21
 
 
22
from bzrlib import (
 
23
    errors,
 
24
    osutils,
 
25
    patiencediff,
 
26
    registry,
 
27
    revision as _mod_revision,
 
28
    )
 
29
from bzrlib.branch import Branch
 
30
from bzrlib.conflicts import ConflictList, Conflict
 
31
from bzrlib.errors import (BzrCommandError,
 
32
                           BzrError,
 
33
                           NoCommonAncestor,
 
34
                           NoCommits,
 
35
                           NoSuchRevision,
 
36
                           NoSuchFile,
 
37
                           NotBranchError,
 
38
                           NotVersionedError,
 
39
                           UnrelatedBranches,
 
40
                           UnsupportedOperation,
 
41
                           WorkingTreeNotRevision,
 
42
                           BinaryFile,
 
43
                           )
 
44
from bzrlib.merge3 import Merge3
 
45
from bzrlib.osutils import rename, pathjoin
 
46
from progress import DummyProgress, ProgressPhase
 
47
from bzrlib.revision import (is_ancestor, NULL_REVISION, ensure_null)
 
48
from bzrlib.textfile import check_text_lines
 
49
from bzrlib.trace import mutter, warning, note
 
50
from bzrlib.transform import (TreeTransform, resolve_conflicts, cook_conflicts,
 
51
                              conflict_pass, FinalPaths, create_by_entry,
 
52
                              unique_add, ROOT_PARENT)
 
53
from bzrlib.versionedfile import PlanWeaveMerge
 
54
from bzrlib import ui
 
55
 
 
56
# TODO: Report back as changes are merged in
 
57
 
 
58
 
 
59
def transform_tree(from_tree, to_tree, interesting_ids=None):
 
60
    merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
 
61
                interesting_ids=interesting_ids, this_tree=from_tree)
 
62
 
 
63
 
 
64
class Merger(object):
 
65
    def __init__(self, this_branch, other_tree=None, base_tree=None,
 
66
                 this_tree=None, pb=DummyProgress(), change_reporter=None,
 
67
                 recurse='down'):
 
68
        object.__init__(self)
 
69
        assert this_tree is not None, "this_tree is required"
 
70
        self.this_branch = this_branch
 
71
        self.this_basis = _mod_revision.ensure_null(
 
72
            this_branch.last_revision())
 
73
        self.this_rev_id = None
 
74
        self.this_tree = this_tree
 
75
        self.this_revision_tree = None
 
76
        self.this_basis_tree = None
 
77
        self.other_tree = other_tree
 
78
        self.other_branch = None
 
79
        self.base_tree = base_tree
 
80
        self.ignore_zero = False
 
81
        self.backup_files = False
 
82
        self.interesting_ids = None
 
83
        self.interesting_files = None
 
84
        self.show_base = False
 
85
        self.reprocess = False
 
86
        self._pb = pb
 
87
        self.pp = None
 
88
        self.recurse = recurse
 
89
        self.change_reporter = change_reporter
 
90
        self._cached_trees = {}
 
91
 
 
92
    @staticmethod
 
93
    def from_uncommitted(tree, other_tree, pb):
 
94
        merger = Merger(tree.branch, other_tree, other_tree.basis_tree(), tree,
 
95
                        pb)
 
96
        merger.base_rev_id = merger.base_tree.get_revision_id()
 
97
        merger.other_rev_id = None
 
98
        return merger
 
99
 
 
100
    @classmethod
 
101
    def from_mergeable(klass, tree, mergeable, pb):
 
102
        mergeable.install_revisions(tree.branch.repository)
 
103
        base_revision_id, other_revision_id, verified =\
 
104
            mergeable.get_merge_request(tree.branch.repository)
 
105
        if base_revision_id in tree.branch.repository.get_ancestry(
 
106
            tree.branch.last_revision(), topo_sorted=False):
 
107
            base_revision_id = None
 
108
        merger = klass.from_revision_ids(pb, tree, other_revision_id,
 
109
                                         base_revision_id)
 
110
        return merger, verified
 
111
 
 
112
    @staticmethod
 
113
    def from_revision_ids(pb, this, other, base=None, other_branch=None,
 
114
                          base_branch=None):
 
115
        merger = Merger(this.branch, this_tree=this, pb=pb)
 
116
        if other_branch is None:
 
117
            other_branch = this.branch
 
118
        merger.set_other_revision(other, other_branch)
 
119
        if base is None:
 
120
            merger.find_base()
 
121
        else:
 
122
            if base_branch is None:
 
123
                base_branch = other_branch
 
124
            merger.set_base_revision(base, base_branch)
 
125
        return merger
 
126
 
 
127
    def revision_tree(self, revision_id, branch=None):
 
128
        if revision_id not in self._cached_trees:
 
129
            if branch is None:
 
130
                branch = self.this_branch
 
131
            try:
 
132
                tree = self.this_tree.revision_tree(revision_id)
 
133
            except errors.NoSuchRevisionInTree:
 
134
                tree = branch.repository.revision_tree(revision_id)
 
135
            self._cached_trees[revision_id] = tree
 
136
        return self._cached_trees[revision_id]
 
137
 
 
138
    def _get_tree(self, treespec, possible_transports=None):
 
139
        from bzrlib import workingtree
 
140
        location, revno = treespec
 
141
        if revno is None:
 
142
            tree = workingtree.WorkingTree.open_containing(location)[0]
 
143
            return tree.branch, tree
 
144
        branch = Branch.open_containing(location, possible_transports)[0]
 
145
        if revno == -1:
 
146
            revision_id = branch.last_revision()
 
147
        else:
 
148
            revision_id = branch.get_rev_id(revno)
 
149
        revision_id = ensure_null(revision_id)
 
150
        return branch, self.revision_tree(revision_id, branch)
 
151
 
 
152
    def ensure_revision_trees(self):
 
153
        if self.this_revision_tree is None:
 
154
            self.this_basis_tree = self.revision_tree(self.this_basis)
 
155
            if self.this_basis == self.this_rev_id:
 
156
                self.this_revision_tree = self.this_basis_tree
 
157
 
 
158
        if self.other_rev_id is None:
 
159
            other_basis_tree = self.revision_tree(self.other_basis)
 
160
            changes = other_basis_tree.changes_from(self.other_tree)
 
161
            if changes.has_changed():
 
162
                raise WorkingTreeNotRevision(self.this_tree)
 
163
            other_rev_id = self.other_basis
 
164
            self.other_tree = other_basis_tree
 
165
 
 
166
    def file_revisions(self, file_id):
 
167
        self.ensure_revision_trees()
 
168
        def get_id(tree, file_id):
 
169
            revision_id = tree.inventory[file_id].revision
 
170
            assert revision_id is not None
 
171
            return revision_id
 
172
        if self.this_rev_id is None:
 
173
            if self.this_basis_tree.get_file_sha1(file_id) != \
 
174
                self.this_tree.get_file_sha1(file_id):
 
175
                raise WorkingTreeNotRevision(self.this_tree)
 
176
 
 
177
        trees = (self.this_basis_tree, self.other_tree)
 
178
        return [get_id(tree, file_id) for tree in trees]
 
179
 
 
180
    def check_basis(self, check_clean, require_commits=True):
 
181
        if self.this_basis is None and require_commits is True:
 
182
            raise BzrCommandError("This branch has no commits."
 
183
                                  " (perhaps you would prefer 'bzr pull')")
 
184
        if check_clean:
 
185
            self.compare_basis()
 
186
            if self.this_basis != self.this_rev_id:
 
187
                raise BzrCommandError("Working tree has uncommitted changes.")
 
188
 
 
189
    def compare_basis(self):
 
190
        try:
 
191
            basis_tree = self.revision_tree(self.this_tree.last_revision())
 
192
        except errors.RevisionNotPresent:
 
193
            basis_tree = self.this_tree.basis_tree()
 
194
        changes = self.this_tree.changes_from(basis_tree)
 
195
        if not changes.has_changed():
 
196
            self.this_rev_id = self.this_basis
 
197
 
 
198
    def set_interesting_files(self, file_list):
 
199
        self.interesting_files = file_list
 
200
 
 
201
    def set_pending(self):
 
202
        if not self.base_is_ancestor or not self.base_is_other_ancestor or self.other_rev_id is None:
 
203
            return
 
204
        self._add_parent()
 
205
 
 
206
    def _add_parent(self):
 
207
        new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
 
208
        new_parent_trees = []
 
209
        for revision_id in new_parents:
 
210
            try:
 
211
                tree = self.revision_tree(revision_id)
 
212
            except errors.RevisionNotPresent:
 
213
                tree = None
 
214
            else:
 
215
                tree.lock_read()
 
216
            new_parent_trees.append((revision_id, tree))
 
217
        try:
 
218
            self.this_tree.set_parent_trees(new_parent_trees,
 
219
                                            allow_leftmost_as_ghost=True)
 
220
        finally:
 
221
            for _revision_id, tree in new_parent_trees:
 
222
                if tree is not None:
 
223
                    tree.unlock()
 
224
 
 
225
    def set_other(self, other_revision, possible_transports=None):
 
226
        """Set the revision and tree to merge from.
 
227
 
 
228
        This sets the other_tree, other_rev_id, other_basis attributes.
 
229
 
 
230
        :param other_revision: The [path, revision] list to merge from.
 
231
        """
 
232
        self.other_branch, self.other_tree = self._get_tree(other_revision,
 
233
                                                            possible_transports)
 
234
        if other_revision[1] == -1:
 
235
            self.other_rev_id = _mod_revision.ensure_null(
 
236
                self.other_branch.last_revision())
 
237
            if _mod_revision.is_null(self.other_rev_id):
 
238
                raise NoCommits(self.other_branch)
 
239
            self.other_basis = self.other_rev_id
 
240
        elif other_revision[1] is not None:
 
241
            self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
 
242
            self.other_basis = self.other_rev_id
 
243
        else:
 
244
            self.other_rev_id = None
 
245
            self.other_basis = self.other_branch.last_revision()
 
246
            if self.other_basis is None:
 
247
                raise NoCommits(self.other_branch)
 
248
        if self.other_rev_id is not None:
 
249
            self._cached_trees[self.other_rev_id] = self.other_tree
 
250
        self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
 
251
 
 
252
    def set_other_revision(self, revision_id, other_branch):
 
253
        """Set 'other' based on a branch and revision id
 
254
 
 
255
        :param revision_id: The revision to use for a tree
 
256
        :param other_branch: The branch containing this tree
 
257
        """
 
258
        self.other_rev_id = revision_id
 
259
        self.other_branch = other_branch
 
260
        self._maybe_fetch(other_branch, self.this_branch, self.other_rev_id)
 
261
        self.other_tree = self.revision_tree(revision_id)
 
262
        self.other_basis = revision_id
 
263
 
 
264
    def set_base_revision(self, revision_id, branch):
 
265
        """Set 'base' based on a branch and revision id
 
266
 
 
267
        :param revision_id: The revision to use for a tree
 
268
        :param branch: The branch containing this tree
 
269
        """
 
270
        self.base_rev_id = revision_id
 
271
        self.base_branch = branch
 
272
        self._maybe_fetch(branch, self.this_branch, revision_id)
 
273
        self.base_tree = self.revision_tree(revision_id)
 
274
        self.base_is_ancestor = is_ancestor(self.this_basis,
 
275
                                            self.base_rev_id,
 
276
                                            self.this_branch)
 
277
        self.base_is_other_ancestor = is_ancestor(self.other_basis,
 
278
                                                  self.base_rev_id,
 
279
                                                  self.this_branch)
 
280
 
 
281
    def _maybe_fetch(self, source, target, revision_id):
 
282
        if (source.repository.bzrdir.root_transport.base !=
 
283
            target.repository.bzrdir.root_transport.base):
 
284
            target.fetch(source, revision_id)
 
285
 
 
286
    def find_base(self):
 
287
        this_repo = self.this_branch.repository
 
288
        graph = this_repo.get_graph()
 
289
        revisions = [ensure_null(self.this_basis),
 
290
                     ensure_null(self.other_basis)]
 
291
        if NULL_REVISION in revisions:
 
292
            self.base_rev_id = NULL_REVISION
 
293
        else:
 
294
            self.base_rev_id = graph.find_unique_lca(*revisions)
 
295
            if self.base_rev_id == NULL_REVISION:
 
296
                raise UnrelatedBranches()
 
297
        self.base_tree = self.revision_tree(self.base_rev_id)
 
298
        self.base_is_ancestor = True
 
299
        self.base_is_other_ancestor = True
 
300
 
 
301
    def set_base(self, base_revision):
 
302
        """Set the base revision to use for the merge.
 
303
 
 
304
        :param base_revision: A 2-list containing a path and revision number.
 
305
        """
 
306
        mutter("doing merge() with no base_revision specified")
 
307
        if base_revision == [None, None]:
 
308
            self.find_base()
 
309
        else:
 
310
            base_branch, self.base_tree = self._get_tree(base_revision)
 
311
            if base_revision[1] == -1:
 
312
                self.base_rev_id = base_branch.last_revision()
 
313
            elif base_revision[1] is None:
 
314
                self.base_rev_id = _mod_revision.NULL_REVISION
 
315
            else:
 
316
                self.base_rev_id = _mod_revision.ensure_null(
 
317
                    base_branch.get_rev_id(base_revision[1]))
 
318
            self._maybe_fetch(base_branch, self.this_branch, self.base_rev_id)
 
319
            self.base_is_ancestor = is_ancestor(self.this_basis, 
 
320
                                                self.base_rev_id,
 
321
                                                self.this_branch)
 
322
            self.base_is_other_ancestor = is_ancestor(self.other_basis,
 
323
                                                      self.base_rev_id,
 
324
                                                      self.this_branch)
 
325
 
 
326
    def do_merge(self):
 
327
        kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
 
328
                  'other_tree': self.other_tree,
 
329
                  'interesting_ids': self.interesting_ids,
 
330
                  'interesting_files': self.interesting_files,
 
331
                  'pp': self.pp}
 
332
        if self.merge_type.requires_base:
 
333
            kwargs['base_tree'] = self.base_tree
 
334
        if self.merge_type.supports_reprocess:
 
335
            kwargs['reprocess'] = self.reprocess
 
336
        elif self.reprocess:
 
337
            raise BzrError("Conflict reduction is not supported for merge"
 
338
                                  " type %s." % self.merge_type)
 
339
        if self.merge_type.supports_show_base:
 
340
            kwargs['show_base'] = self.show_base
 
341
        elif self.show_base:
 
342
            raise BzrError("Showing base is not supported for this"
 
343
                                  " merge type. %s" % self.merge_type)
 
344
        self.this_tree.lock_tree_write()
 
345
        if self.base_tree is not None:
 
346
            self.base_tree.lock_read()
 
347
        if self.other_tree is not None:
 
348
            self.other_tree.lock_read()
 
349
        try:
 
350
            merge = self.merge_type(pb=self._pb,
 
351
                                    change_reporter=self.change_reporter,
 
352
                                    **kwargs)
 
353
            if self.recurse == 'down':
 
354
                for path, file_id in self.this_tree.iter_references():
 
355
                    sub_tree = self.this_tree.get_nested_tree(file_id, path)
 
356
                    other_revision = self.other_tree.get_reference_revision(
 
357
                        file_id, path)
 
358
                    if  other_revision == sub_tree.last_revision():
 
359
                        continue
 
360
                    sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
 
361
                    sub_merge.merge_type = self.merge_type
 
362
                    relpath = self.this_tree.relpath(path)
 
363
                    other_branch = self.other_branch.reference_parent(file_id, relpath)
 
364
                    sub_merge.set_other_revision(other_revision, other_branch)
 
365
                    base_revision = self.base_tree.get_reference_revision(file_id)
 
366
                    sub_merge.base_tree = \
 
367
                        sub_tree.branch.repository.revision_tree(base_revision)
 
368
                    sub_merge.do_merge()
 
369
 
 
370
        finally:
 
371
            if self.other_tree is not None:
 
372
                self.other_tree.unlock()
 
373
            if self.base_tree is not None:
 
374
                self.base_tree.unlock()
 
375
            self.this_tree.unlock()
 
376
        if len(merge.cooked_conflicts) == 0:
 
377
            if not self.ignore_zero:
 
378
                note("All changes applied successfully.")
 
379
        else:
 
380
            note("%d conflicts encountered." % len(merge.cooked_conflicts))
 
381
 
 
382
        return len(merge.cooked_conflicts)
 
383
 
 
384
 
 
385
class Merge3Merger(object):
 
386
    """Three-way merger that uses the merge3 text merger"""
 
387
    requires_base = True
 
388
    supports_reprocess = True
 
389
    supports_show_base = True
 
390
    history_based = False
 
391
    winner_idx = {"this": 2, "other": 1, "conflict": 1}
 
392
 
 
393
    def __init__(self, working_tree, this_tree, base_tree, other_tree, 
 
394
                 interesting_ids=None, reprocess=False, show_base=False,
 
395
                 pb=DummyProgress(), pp=None, change_reporter=None,
 
396
                 interesting_files=None):
 
397
        """Initialize the merger object and perform the merge.
 
398
 
 
399
        :param working_tree: The working tree to apply the merge to
 
400
        :param this_tree: The local tree in the merge operation
 
401
        :param base_tree: The common tree in the merge operation
 
402
        :param other_tree: The other other tree to merge changes from
 
403
        :param interesting_ids: The file_ids of files that should be
 
404
            participate in the merge.  May not be combined with
 
405
            interesting_files.
 
406
        :param: reprocess If True, perform conflict-reduction processing.
 
407
        :param show_base: If True, show the base revision in text conflicts.
 
408
            (incompatible with reprocess)
 
409
        :param pb: A Progress bar
 
410
        :param pp: A ProgressPhase object
 
411
        :param change_reporter: An object that should report changes made
 
412
        :param interesting_files: The tree-relative paths of files that should
 
413
            participate in the merge.  If these paths refer to directories,
 
414
            the contents of those directories will also be included.  May not
 
415
            be combined with interesting_ids.  If neither interesting_files nor
 
416
            interesting_ids is specified, all files may participate in the
 
417
            merge.
 
418
        """
 
419
        object.__init__(self)
 
420
        if interesting_files is not None:
 
421
            assert interesting_ids is None
 
422
        self.interesting_ids = interesting_ids
 
423
        self.interesting_files = interesting_files
 
424
        self.this_tree = working_tree
 
425
        self.this_tree.lock_tree_write()
 
426
        self.base_tree = base_tree
 
427
        self.base_tree.lock_read()
 
428
        self.other_tree = other_tree
 
429
        self.other_tree.lock_read()
 
430
        self._raw_conflicts = []
 
431
        self.cooked_conflicts = []
 
432
        self.reprocess = reprocess
 
433
        self.show_base = show_base
 
434
        self.pb = pb
 
435
        self.pp = pp
 
436
        self.change_reporter = change_reporter
 
437
        if self.pp is None:
 
438
            self.pp = ProgressPhase("Merge phase", 3, self.pb)
 
439
 
 
440
        self.tt = TreeTransform(working_tree, self.pb)
 
441
        try:
 
442
            self.pp.next_phase()
 
443
            entries = self._entries3()
 
444
            child_pb = ui.ui_factory.nested_progress_bar()
 
445
            try:
 
446
                for num, (file_id, changed, parents3, names3,
 
447
                          executable3) in enumerate(entries):
 
448
                    child_pb.update('Preparing file merge', num, len(entries))
 
449
                    self._merge_names(file_id, parents3, names3)
 
450
                    if changed:
 
451
                        file_status = self.merge_contents(file_id)
 
452
                    else:
 
453
                        file_status = 'unmodified'
 
454
                    self._merge_executable(file_id,
 
455
                        executable3, file_status)
 
456
            finally:
 
457
                child_pb.finished()
 
458
            self.fix_root()
 
459
            self.pp.next_phase()
 
460
            child_pb = ui.ui_factory.nested_progress_bar()
 
461
            try:
 
462
                fs_conflicts = resolve_conflicts(self.tt, child_pb,
 
463
                    lambda t, c: conflict_pass(t, c, self.other_tree))
 
464
            finally:
 
465
                child_pb.finished()
 
466
            if change_reporter is not None:
 
467
                from bzrlib import delta
 
468
                delta.report_changes(self.tt._iter_changes(), change_reporter)
 
469
            self.cook_conflicts(fs_conflicts)
 
470
            for conflict in self.cooked_conflicts:
 
471
                warning(conflict)
 
472
            self.pp.next_phase()
 
473
            results = self.tt.apply(no_conflicts=True)
 
474
            self.write_modified(results)
 
475
            try:
 
476
                working_tree.add_conflicts(self.cooked_conflicts)
 
477
            except UnsupportedOperation:
 
478
                pass
 
479
        finally:
 
480
            self.tt.finalize()
 
481
            self.other_tree.unlock()
 
482
            self.base_tree.unlock()
 
483
            self.this_tree.unlock()
 
484
            self.pb.clear()
 
485
 
 
486
    def _entries3(self):
 
487
        """Gather data about files modified between three trees.
 
488
 
 
489
        Return a list of tuples of file_id, changed, parents3, names3,
 
490
        executable3.  changed is a boolean indicating whether the file contents
 
491
        or kind were changed.  parents3 is a tuple of parent ids for base,
 
492
        other and this.  names3 is a tuple of names for base, other and this.
 
493
        executable3 is a tuple of execute-bit values for base, other and this.
 
494
        """
 
495
        result = []
 
496
        iterator = self.other_tree._iter_changes(self.base_tree,
 
497
                include_unchanged=True, specific_files=self.interesting_files,
 
498
                extra_trees=[self.this_tree])
 
499
        for (file_id, paths, changed, versioned, parents, names, kind,
 
500
             executable) in iterator:
 
501
            if (self.interesting_ids is not None and
 
502
                file_id not in self.interesting_ids):
 
503
                continue
 
504
            if file_id in self.this_tree.inventory:
 
505
                entry = self.this_tree.inventory[file_id]
 
506
                this_name = entry.name
 
507
                this_parent = entry.parent_id
 
508
                this_executable = entry.executable
 
509
            else:
 
510
                this_name = None
 
511
                this_parent = None
 
512
                this_executable = None
 
513
            parents3 = parents + (this_parent,)
 
514
            names3 = names + (this_name,)
 
515
            executable3 = executable + (this_executable,)
 
516
            result.append((file_id, changed, parents3, names3, executable3))
 
517
        return result
 
518
 
 
519
    def fix_root(self):
 
520
        try:
 
521
            self.tt.final_kind(self.tt.root)
 
522
        except NoSuchFile:
 
523
            self.tt.cancel_deletion(self.tt.root)
 
524
        if self.tt.final_file_id(self.tt.root) is None:
 
525
            self.tt.version_file(self.tt.tree_file_id(self.tt.root), 
 
526
                                 self.tt.root)
 
527
        if self.other_tree.inventory.root is None:
 
528
            return
 
529
        other_root_file_id = self.other_tree.inventory.root.file_id
 
530
        other_root = self.tt.trans_id_file_id(other_root_file_id)
 
531
        if other_root == self.tt.root:
 
532
            return
 
533
        try:
 
534
            self.tt.final_kind(other_root)
 
535
        except NoSuchFile:
 
536
            return
 
537
        self.reparent_children(self.other_tree.inventory.root, self.tt.root)
 
538
        self.tt.cancel_creation(other_root)
 
539
        self.tt.cancel_versioning(other_root)
 
540
 
 
541
    def reparent_children(self, ie, target):
 
542
        for thing, child in ie.children.iteritems():
 
543
            trans_id = self.tt.trans_id_file_id(child.file_id)
 
544
            self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
 
545
 
 
546
    def write_modified(self, results):
 
547
        modified_hashes = {}
 
548
        for path in results.modified_paths:
 
549
            file_id = self.this_tree.path2id(self.this_tree.relpath(path))
 
550
            if file_id is None:
 
551
                continue
 
552
            hash = self.this_tree.get_file_sha1(file_id)
 
553
            if hash is None:
 
554
                continue
 
555
            modified_hashes[file_id] = hash
 
556
        self.this_tree.set_merge_modified(modified_hashes)
 
557
 
 
558
    @staticmethod
 
559
    def parent(entry, file_id):
 
560
        """Determine the parent for a file_id (used as a key method)"""
 
561
        if entry is None:
 
562
            return None
 
563
        return entry.parent_id
 
564
 
 
565
    @staticmethod
 
566
    def name(entry, file_id):
 
567
        """Determine the name for a file_id (used as a key method)"""
 
568
        if entry is None:
 
569
            return None
 
570
        return entry.name
 
571
    
 
572
    @staticmethod
 
573
    def contents_sha1(tree, file_id):
 
574
        """Determine the sha1 of the file contents (used as a key method)."""
 
575
        if file_id not in tree:
 
576
            return None
 
577
        return tree.get_file_sha1(file_id)
 
578
 
 
579
    @staticmethod
 
580
    def executable(tree, file_id):
 
581
        """Determine the executability of a file-id (used as a key method)."""
 
582
        if file_id not in tree:
 
583
            return None
 
584
        if tree.kind(file_id) != "file":
 
585
            return False
 
586
        return tree.is_executable(file_id)
 
587
 
 
588
    @staticmethod
 
589
    def kind(tree, file_id):
 
590
        """Determine the kind of a file-id (used as a key method)."""
 
591
        if file_id not in tree:
 
592
            return None
 
593
        return tree.kind(file_id)
 
594
 
 
595
    @staticmethod
 
596
    def _three_way(base, other, this):
 
597
        #if base == other, either they all agree, or only THIS has changed.
 
598
        if base == other:
 
599
            return 'this'
 
600
        elif this not in (base, other):
 
601
            return 'conflict'
 
602
        # "Ambiguous clean merge" -- both sides have made the same change.
 
603
        elif this == other:
 
604
            return "this"
 
605
        # this == base: only other has changed.
 
606
        else:
 
607
            return "other"
 
608
 
 
609
    @staticmethod
 
610
    def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
 
611
        """Do a three-way test on a scalar.
 
612
        Return "this", "other" or "conflict", depending whether a value wins.
 
613
        """
 
614
        key_base = key(base_tree, file_id)
 
615
        key_other = key(other_tree, file_id)
 
616
        #if base == other, either they all agree, or only THIS has changed.
 
617
        if key_base == key_other:
 
618
            return "this"
 
619
        key_this = key(this_tree, file_id)
 
620
        if key_this not in (key_base, key_other):
 
621
            return "conflict"
 
622
        # "Ambiguous clean merge"
 
623
        elif key_this == key_other:
 
624
            return "this"
 
625
        else:
 
626
            assert key_this == key_base
 
627
            return "other"
 
628
 
 
629
    def merge_names(self, file_id):
 
630
        def get_entry(tree):
 
631
            if file_id in tree.inventory:
 
632
                return tree.inventory[file_id]
 
633
            else:
 
634
                return None
 
635
        this_entry = get_entry(self.this_tree)
 
636
        other_entry = get_entry(self.other_tree)
 
637
        base_entry = get_entry(self.base_tree)
 
638
        entries = (base_entry, other_entry, this_entry)
 
639
        names = []
 
640
        parents = []
 
641
        for entry in entries:
 
642
            if entry is None:
 
643
                names.append(None)
 
644
                parents.append(None)
 
645
            else:
 
646
                names.append(entry.name)
 
647
                parents.append(entry.parent_id)
 
648
        return self._merge_names(file_id, parents, names)
 
649
 
 
650
    def _merge_names(self, file_id, parents, names):
 
651
        """Perform a merge on file_id names and parents"""
 
652
        base_name, other_name, this_name = names
 
653
        base_parent, other_parent, this_parent = parents
 
654
 
 
655
        name_winner = self._three_way(*names)
 
656
 
 
657
        parent_id_winner = self._three_way(*parents)
 
658
        if this_name is None:
 
659
            if name_winner == "this":
 
660
                name_winner = "other"
 
661
            if parent_id_winner == "this":
 
662
                parent_id_winner = "other"
 
663
        if name_winner == "this" and parent_id_winner == "this":
 
664
            return
 
665
        if name_winner == "conflict":
 
666
            trans_id = self.tt.trans_id_file_id(file_id)
 
667
            self._raw_conflicts.append(('name conflict', trans_id, 
 
668
                                        this_name, other_name))
 
669
        if parent_id_winner == "conflict":
 
670
            trans_id = self.tt.trans_id_file_id(file_id)
 
671
            self._raw_conflicts.append(('parent conflict', trans_id, 
 
672
                                        this_parent, other_parent))
 
673
        if other_name is None:
 
674
            # it doesn't matter whether the result was 'other' or 
 
675
            # 'conflict'-- if there's no 'other', we leave it alone.
 
676
            return
 
677
        # if we get here, name_winner and parent_winner are set to safe values.
 
678
        trans_id = self.tt.trans_id_file_id(file_id)
 
679
        parent_id = parents[self.winner_idx[parent_id_winner]]
 
680
        if parent_id is not None:
 
681
            parent_trans_id = self.tt.trans_id_file_id(parent_id)
 
682
            self.tt.adjust_path(names[self.winner_idx[name_winner]],
 
683
                                parent_trans_id, trans_id)
 
684
 
 
685
    def merge_contents(self, file_id):
 
686
        """Performa a merge on file_id contents."""
 
687
        def contents_pair(tree):
 
688
            if file_id not in tree:
 
689
                return (None, None)
 
690
            kind = tree.kind(file_id)
 
691
            if kind == "file":
 
692
                contents = tree.get_file_sha1(file_id)
 
693
            elif kind == "symlink":
 
694
                contents = tree.get_symlink_target(file_id)
 
695
            else:
 
696
                contents = None
 
697
            return kind, contents
 
698
 
 
699
        def contents_conflict():
 
700
            trans_id = self.tt.trans_id_file_id(file_id)
 
701
            name = self.tt.final_name(trans_id)
 
702
            parent_id = self.tt.final_parent(trans_id)
 
703
            if file_id in self.this_tree.inventory:
 
704
                self.tt.unversion_file(trans_id)
 
705
                if file_id in self.this_tree:
 
706
                    self.tt.delete_contents(trans_id)
 
707
            file_group = self._dump_conflicts(name, parent_id, file_id, 
 
708
                                              set_version=True)
 
709
            self._raw_conflicts.append(('contents conflict', file_group))
 
710
 
 
711
        # See SPOT run.  run, SPOT, run.
 
712
        # So we're not QUITE repeating ourselves; we do tricky things with
 
713
        # file kind...
 
714
        base_pair = contents_pair(self.base_tree)
 
715
        other_pair = contents_pair(self.other_tree)
 
716
        if base_pair == other_pair:
 
717
            # OTHER introduced no changes
 
718
            return "unmodified"
 
719
        this_pair = contents_pair(self.this_tree)
 
720
        if this_pair == other_pair:
 
721
            # THIS and OTHER introduced the same changes
 
722
            return "unmodified"
 
723
        else:
 
724
            trans_id = self.tt.trans_id_file_id(file_id)
 
725
            if this_pair == base_pair:
 
726
                # only OTHER introduced changes
 
727
                if file_id in self.this_tree:
 
728
                    # Remove any existing contents
 
729
                    self.tt.delete_contents(trans_id)
 
730
                if file_id in self.other_tree:
 
731
                    # OTHER changed the file
 
732
                    create_by_entry(self.tt, 
 
733
                                    self.other_tree.inventory[file_id], 
 
734
                                    self.other_tree, trans_id)
 
735
                    if file_id not in self.this_tree.inventory:
 
736
                        self.tt.version_file(file_id, trans_id)
 
737
                    return "modified"
 
738
                elif file_id in self.this_tree.inventory:
 
739
                    # OTHER deleted the file
 
740
                    self.tt.unversion_file(trans_id)
 
741
                    return "deleted"
 
742
            #BOTH THIS and OTHER introduced changes; scalar conflict
 
743
            elif this_pair[0] == "file" and other_pair[0] == "file":
 
744
                # THIS and OTHER are both files, so text merge.  Either
 
745
                # BASE is a file, or both converted to files, so at least we
 
746
                # have agreement that output should be a file.
 
747
                try:
 
748
                    self.text_merge(file_id, trans_id)
 
749
                except BinaryFile:
 
750
                    return contents_conflict()
 
751
                if file_id not in self.this_tree.inventory:
 
752
                    self.tt.version_file(file_id, trans_id)
 
753
                try:
 
754
                    self.tt.tree_kind(trans_id)
 
755
                    self.tt.delete_contents(trans_id)
 
756
                except NoSuchFile:
 
757
                    pass
 
758
                return "modified"
 
759
            else:
 
760
                # Scalar conflict, can't text merge.  Dump conflicts
 
761
                return contents_conflict()
 
762
 
 
763
    def get_lines(self, tree, file_id):
 
764
        """Return the lines in a file, or an empty list."""
 
765
        if file_id in tree:
 
766
            return tree.get_file(file_id).readlines()
 
767
        else:
 
768
            return []
 
769
 
 
770
    def text_merge(self, file_id, trans_id):
 
771
        """Perform a three-way text merge on a file_id"""
 
772
        # it's possible that we got here with base as a different type.
 
773
        # if so, we just want two-way text conflicts.
 
774
        if file_id in self.base_tree and \
 
775
            self.base_tree.kind(file_id) == "file":
 
776
            base_lines = self.get_lines(self.base_tree, file_id)
 
777
        else:
 
778
            base_lines = []
 
779
        other_lines = self.get_lines(self.other_tree, file_id)
 
780
        this_lines = self.get_lines(self.this_tree, file_id)
 
781
        m3 = Merge3(base_lines, this_lines, other_lines)
 
782
        start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
 
783
        if self.show_base is True:
 
784
            base_marker = '|' * 7
 
785
        else:
 
786
            base_marker = None
 
787
 
 
788
        def iter_merge3(retval):
 
789
            retval["text_conflicts"] = False
 
790
            for line in m3.merge_lines(name_a = "TREE", 
 
791
                                       name_b = "MERGE-SOURCE", 
 
792
                                       name_base = "BASE-REVISION",
 
793
                                       start_marker=start_marker, 
 
794
                                       base_marker=base_marker,
 
795
                                       reprocess=self.reprocess):
 
796
                if line.startswith(start_marker):
 
797
                    retval["text_conflicts"] = True
 
798
                    yield line.replace(start_marker, '<' * 7)
 
799
                else:
 
800
                    yield line
 
801
        retval = {}
 
802
        merge3_iterator = iter_merge3(retval)
 
803
        self.tt.create_file(merge3_iterator, trans_id)
 
804
        if retval["text_conflicts"] is True:
 
805
            self._raw_conflicts.append(('text conflict', trans_id))
 
806
            name = self.tt.final_name(trans_id)
 
807
            parent_id = self.tt.final_parent(trans_id)
 
808
            file_group = self._dump_conflicts(name, parent_id, file_id, 
 
809
                                              this_lines, base_lines,
 
810
                                              other_lines)
 
811
            file_group.append(trans_id)
 
812
 
 
813
    def _dump_conflicts(self, name, parent_id, file_id, this_lines=None, 
 
814
                        base_lines=None, other_lines=None, set_version=False,
 
815
                        no_base=False):
 
816
        """Emit conflict files.
 
817
        If this_lines, base_lines, or other_lines are omitted, they will be
 
818
        determined automatically.  If set_version is true, the .OTHER, .THIS
 
819
        or .BASE (in that order) will be created as versioned files.
 
820
        """
 
821
        data = [('OTHER', self.other_tree, other_lines), 
 
822
                ('THIS', self.this_tree, this_lines)]
 
823
        if not no_base:
 
824
            data.append(('BASE', self.base_tree, base_lines))
 
825
        versioned = False
 
826
        file_group = []
 
827
        for suffix, tree, lines in data:
 
828
            if file_id in tree:
 
829
                trans_id = self._conflict_file(name, parent_id, tree, file_id,
 
830
                                               suffix, lines)
 
831
                file_group.append(trans_id)
 
832
                if set_version and not versioned:
 
833
                    self.tt.version_file(file_id, trans_id)
 
834
                    versioned = True
 
835
        return file_group
 
836
           
 
837
    def _conflict_file(self, name, parent_id, tree, file_id, suffix, 
 
838
                       lines=None):
 
839
        """Emit a single conflict file."""
 
840
        name = name + '.' + suffix
 
841
        trans_id = self.tt.create_path(name, parent_id)
 
842
        entry = tree.inventory[file_id]
 
843
        create_by_entry(self.tt, entry, tree, trans_id, lines)
 
844
        return trans_id
 
845
 
 
846
    def merge_executable(self, file_id, file_status):
 
847
        """Perform a merge on the execute bit."""
 
848
        executable = [self.executable(t, file_id) for t in (self.base_tree,
 
849
                      self.other_tree, self.this_tree)]
 
850
        self._merge_executable(file_id, executable, file_status)
 
851
 
 
852
    def _merge_executable(self, file_id, executable, file_status):
 
853
        """Perform a merge on the execute bit."""
 
854
        base_executable, other_executable, this_executable = executable
 
855
        if file_status == "deleted":
 
856
            return
 
857
        trans_id = self.tt.trans_id_file_id(file_id)
 
858
        try:
 
859
            if self.tt.final_kind(trans_id) != "file":
 
860
                return
 
861
        except NoSuchFile:
 
862
            return
 
863
        winner = self._three_way(*executable)
 
864
        if winner == "conflict":
 
865
        # There must be a None in here, if we have a conflict, but we
 
866
        # need executability since file status was not deleted.
 
867
            if self.executable(self.other_tree, file_id) is None:
 
868
                winner = "this"
 
869
            else:
 
870
                winner = "other"
 
871
        if winner == "this":
 
872
            if file_status == "modified":
 
873
                executability = this_executable
 
874
                if executability is not None:
 
875
                    trans_id = self.tt.trans_id_file_id(file_id)
 
876
                    self.tt.set_executability(executability, trans_id)
 
877
        else:
 
878
            assert winner == "other"
 
879
            if file_id in self.other_tree:
 
880
                executability = other_executable
 
881
            elif file_id in self.this_tree:
 
882
                executability = this_executable
 
883
            elif file_id in self.base_tree:
 
884
                executability = base_executable
 
885
            if executability is not None:
 
886
                trans_id = self.tt.trans_id_file_id(file_id)
 
887
                self.tt.set_executability(executability, trans_id)
 
888
 
 
889
    def cook_conflicts(self, fs_conflicts):
 
890
        """Convert all conflicts into a form that doesn't depend on trans_id"""
 
891
        from conflicts import Conflict
 
892
        name_conflicts = {}
 
893
        self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
 
894
        fp = FinalPaths(self.tt)
 
895
        for conflict in self._raw_conflicts:
 
896
            conflict_type = conflict[0]
 
897
            if conflict_type in ('name conflict', 'parent conflict'):
 
898
                trans_id = conflict[1]
 
899
                conflict_args = conflict[2:]
 
900
                if trans_id not in name_conflicts:
 
901
                    name_conflicts[trans_id] = {}
 
902
                unique_add(name_conflicts[trans_id], conflict_type, 
 
903
                           conflict_args)
 
904
            if conflict_type == 'contents conflict':
 
905
                for trans_id in conflict[1]:
 
906
                    file_id = self.tt.final_file_id(trans_id)
 
907
                    if file_id is not None:
 
908
                        break
 
909
                path = fp.get_path(trans_id)
 
910
                for suffix in ('.BASE', '.THIS', '.OTHER'):
 
911
                    if path.endswith(suffix):
 
912
                        path = path[:-len(suffix)]
 
913
                        break
 
914
                c = Conflict.factory(conflict_type, path=path, file_id=file_id)
 
915
                self.cooked_conflicts.append(c)
 
916
            if conflict_type == 'text conflict':
 
917
                trans_id = conflict[1]
 
918
                path = fp.get_path(trans_id)
 
919
                file_id = self.tt.final_file_id(trans_id)
 
920
                c = Conflict.factory(conflict_type, path=path, file_id=file_id)
 
921
                self.cooked_conflicts.append(c)
 
922
 
 
923
        for trans_id, conflicts in name_conflicts.iteritems():
 
924
            try:
 
925
                this_parent, other_parent = conflicts['parent conflict']
 
926
                assert this_parent != other_parent
 
927
            except KeyError:
 
928
                this_parent = other_parent = \
 
929
                    self.tt.final_file_id(self.tt.final_parent(trans_id))
 
930
            try:
 
931
                this_name, other_name = conflicts['name conflict']
 
932
                assert this_name != other_name
 
933
            except KeyError:
 
934
                this_name = other_name = self.tt.final_name(trans_id)
 
935
            other_path = fp.get_path(trans_id)
 
936
            if this_parent is not None and this_name is not None:
 
937
                this_parent_path = \
 
938
                    fp.get_path(self.tt.trans_id_file_id(this_parent))
 
939
                this_path = pathjoin(this_parent_path, this_name)
 
940
            else:
 
941
                this_path = "<deleted>"
 
942
            file_id = self.tt.final_file_id(trans_id)
 
943
            c = Conflict.factory('path conflict', path=this_path,
 
944
                                 conflict_path=other_path, file_id=file_id)
 
945
            self.cooked_conflicts.append(c)
 
946
        self.cooked_conflicts.sort(key=Conflict.sort_key)
 
947
 
 
948
 
 
949
class WeaveMerger(Merge3Merger):
 
950
    """Three-way tree merger, text weave merger."""
 
951
    supports_reprocess = True
 
952
    supports_show_base = False
 
953
 
 
954
    def __init__(self, working_tree, this_tree, base_tree, other_tree, 
 
955
                 interesting_ids=None, pb=DummyProgress(), pp=None,
 
956
                 reprocess=False, change_reporter=None,
 
957
                 interesting_files=None):
 
958
        super(WeaveMerger, self).__init__(working_tree, this_tree, 
 
959
                                          base_tree, other_tree, 
 
960
                                          interesting_ids=interesting_ids, 
 
961
                                          pb=pb, pp=pp, reprocess=reprocess,
 
962
                                          change_reporter=change_reporter)
 
963
 
 
964
    def _merged_lines(self, file_id):
 
965
        """Generate the merged lines.
 
966
        There is no distinction between lines that are meant to contain <<<<<<<
 
967
        and conflicts.
 
968
        """
 
969
        plan = self.this_tree.plan_file_merge(file_id, self.other_tree)
 
970
        textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
 
971
            '>>>>>>> MERGE-SOURCE\n')
 
972
        return textmerge.merge_lines(self.reprocess)
 
973
 
 
974
    def text_merge(self, file_id, trans_id):
 
975
        """Perform a (weave) text merge for a given file and file-id.
 
976
        If conflicts are encountered, .THIS and .OTHER files will be emitted,
 
977
        and a conflict will be noted.
 
978
        """
 
979
        lines, conflicts = self._merged_lines(file_id)
 
980
        lines = list(lines)
 
981
        # Note we're checking whether the OUTPUT is binary in this case, 
 
982
        # because we don't want to get into weave merge guts.
 
983
        check_text_lines(lines)
 
984
        self.tt.create_file(lines, trans_id)
 
985
        if conflicts:
 
986
            self._raw_conflicts.append(('text conflict', trans_id))
 
987
            name = self.tt.final_name(trans_id)
 
988
            parent_id = self.tt.final_parent(trans_id)
 
989
            file_group = self._dump_conflicts(name, parent_id, file_id, 
 
990
                                              no_base=True)
 
991
            file_group.append(trans_id)
 
992
 
 
993
 
 
994
class Diff3Merger(Merge3Merger):
 
995
    """Three-way merger using external diff3 for text merging"""
 
996
 
 
997
    def dump_file(self, temp_dir, name, tree, file_id):
 
998
        out_path = pathjoin(temp_dir, name)
 
999
        out_file = open(out_path, "wb")
 
1000
        try:
 
1001
            in_file = tree.get_file(file_id)
 
1002
            for line in in_file:
 
1003
                out_file.write(line)
 
1004
        finally:
 
1005
            out_file.close()
 
1006
        return out_path
 
1007
 
 
1008
    def text_merge(self, file_id, trans_id):
 
1009
        """Perform a diff3 merge using a specified file-id and trans-id.
 
1010
        If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
 
1011
        will be dumped, and a will be conflict noted.
 
1012
        """
 
1013
        import bzrlib.patch
 
1014
        temp_dir = osutils.mkdtemp(prefix="bzr-")
 
1015
        try:
 
1016
            new_file = pathjoin(temp_dir, "new")
 
1017
            this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
 
1018
            base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
 
1019
            other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
 
1020
            status = bzrlib.patch.diff3(new_file, this, base, other)
 
1021
            if status not in (0, 1):
 
1022
                raise BzrError("Unhandled diff3 exit code")
 
1023
            f = open(new_file, 'rb')
 
1024
            try:
 
1025
                self.tt.create_file(f, trans_id)
 
1026
            finally:
 
1027
                f.close()
 
1028
            if status == 1:
 
1029
                name = self.tt.final_name(trans_id)
 
1030
                parent_id = self.tt.final_parent(trans_id)
 
1031
                self._dump_conflicts(name, parent_id, file_id)
 
1032
                self._raw_conflicts.append(('text conflict', trans_id))
 
1033
        finally:
 
1034
            osutils.rmtree(temp_dir)
 
1035
 
 
1036
 
 
1037
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
 
1038
                backup_files=False,
 
1039
                merge_type=Merge3Merger,
 
1040
                interesting_ids=None,
 
1041
                show_base=False,
 
1042
                reprocess=False,
 
1043
                other_rev_id=None,
 
1044
                interesting_files=None,
 
1045
                this_tree=None,
 
1046
                pb=DummyProgress(),
 
1047
                change_reporter=None):
 
1048
    """Primary interface for merging. 
 
1049
 
 
1050
        typical use is probably 
 
1051
        'merge_inner(branch, branch.get_revision_tree(other_revision),
 
1052
                     branch.get_revision_tree(base_revision))'
 
1053
        """
 
1054
    if this_tree is None:
 
1055
        raise BzrError("bzrlib.merge.merge_inner requires a this_tree "
 
1056
            "parameter as of bzrlib version 0.8.")
 
1057
    merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
 
1058
                    pb=pb, change_reporter=change_reporter)
 
1059
    merger.backup_files = backup_files
 
1060
    merger.merge_type = merge_type
 
1061
    merger.interesting_ids = interesting_ids
 
1062
    merger.ignore_zero = ignore_zero
 
1063
    if interesting_files:
 
1064
        assert not interesting_ids, ('Only supply interesting_ids'
 
1065
                                     ' or interesting_files')
 
1066
        merger.interesting_files = interesting_files
 
1067
    merger.show_base = show_base
 
1068
    merger.reprocess = reprocess
 
1069
    merger.other_rev_id = other_rev_id
 
1070
    merger.other_basis = other_rev_id
 
1071
    return merger.do_merge()
 
1072
 
 
1073
def get_merge_type_registry():
 
1074
    """Merge type registry is in bzrlib.option to avoid circular imports.
 
1075
 
 
1076
    This method provides a sanctioned way to retrieve it.
 
1077
    """
 
1078
    from bzrlib import option
 
1079
    return option._merge_type_registry
 
1080
 
 
1081
 
 
1082
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
 
1083
    def status_a(revision, text):
 
1084
        if revision in ancestors_b:
 
1085
            return 'killed-b', text
 
1086
        else:
 
1087
            return 'new-a', text
 
1088
 
 
1089
    def status_b(revision, text):
 
1090
        if revision in ancestors_a:
 
1091
            return 'killed-a', text
 
1092
        else:
 
1093
            return 'new-b', text
 
1094
 
 
1095
    plain_a = [t for (a, t) in annotated_a]
 
1096
    plain_b = [t for (a, t) in annotated_b]
 
1097
    matcher = patiencediff.PatienceSequenceMatcher(None, plain_a, plain_b)
 
1098
    blocks = matcher.get_matching_blocks()
 
1099
    a_cur = 0
 
1100
    b_cur = 0
 
1101
    for ai, bi, l in blocks:
 
1102
        # process all mismatched sections
 
1103
        # (last mismatched section is handled because blocks always
 
1104
        # includes a 0-length last block)
 
1105
        for revision, text in annotated_a[a_cur:ai]:
 
1106
            yield status_a(revision, text)
 
1107
        for revision, text in annotated_b[b_cur:bi]:
 
1108
            yield status_b(revision, text)
 
1109
 
 
1110
        # and now the matched section
 
1111
        a_cur = ai + l
 
1112
        b_cur = bi + l
 
1113
        for text_a, text_b in zip(plain_a[ai:a_cur], plain_b[bi:b_cur]):
 
1114
            assert text_a == text_b
 
1115
            yield "unchanged", text_a