~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Aaron Bentley
  • Date: 2007-08-16 00:54:00 UTC
  • mto: This revision was merged to the branch mainline in revision 2711.
  • Revision ID: aaron.bentley@utoronto.ca-20070816005400-oxxtqiy310wx10h9
Fix typo

Show diffs side-by-side

added added

removed removed

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