~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Ian Clatworthy
  • Date: 2008-04-01 04:19:06 UTC
  • mfrom: (3302.6.1 xma-mailmode)
  • mto: This revision was merged to the branch mainline in revision 3323.
  • Revision ID: ian.clatworthy@canonical.com-20080401041906-s7ekpfpo0tnyfkbz
Add mail-mode GNU Emacs mail package as a mail client option (Xavier Maillard)

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
23
    debug,
25
24
    errors,
26
 
    graph as _mod_graph,
27
25
    osutils,
28
26
    patiencediff,
29
27
    registry,
30
28
    revision as _mod_revision,
31
 
    tree as _mod_tree,
32
 
    tsort,
33
29
    )
34
30
from bzrlib.branch import Branch
35
31
from bzrlib.conflicts import ConflictList, Conflict
46
42
                           WorkingTreeNotRevision,
47
43
                           BinaryFile,
48
44
                           )
49
 
from bzrlib.graph import Graph
50
45
from bzrlib.merge3 import Merge3
51
46
from bzrlib.osutils import rename, pathjoin
52
47
from progress import DummyProgress, ProgressPhase
55
50
from bzrlib.trace import mutter, warning, note, is_quiet
56
51
from bzrlib.transform import (TransformPreview, TreeTransform,
57
52
                              resolve_conflicts, cook_conflicts,
58
 
                              conflict_pass, FinalPaths, create_from_tree,
 
53
                              conflict_pass, FinalPaths, create_by_entry,
59
54
                              unique_add, ROOT_PARENT)
60
55
from bzrlib.versionedfile import PlanWeaveMerge
61
56
from bzrlib import ui
70
65
 
71
66
class Merger(object):
72
67
    def __init__(self, this_branch, other_tree=None, base_tree=None,
73
 
                 this_tree=None, pb=None, change_reporter=None,
 
68
                 this_tree=None, pb=DummyProgress(), change_reporter=None,
74
69
                 recurse='down', revision_graph=None):
75
70
        object.__init__(self)
 
71
        assert this_tree is not None, "this_tree is required"
76
72
        self.this_branch = this_branch
77
73
        self.this_basis = _mod_revision.ensure_null(
78
74
            this_branch.last_revision())
89
85
        self.interesting_files = None
90
86
        self.show_base = False
91
87
        self.reprocess = False
92
 
        if pb is None:
93
 
            pb = DummyProgress()
94
88
        self._pb = pb
95
89
        self.pp = None
96
90
        self.recurse = recurse
99
93
        self._revision_graph = revision_graph
100
94
        self._base_is_ancestor = None
101
95
        self._base_is_other_ancestor = None
102
 
        self._is_criss_cross = None
103
 
        self._lca_trees = None
104
96
 
105
97
    @property
106
98
    def revision_graph(self):
134
126
                                      _set_base_is_other_ancestor)
135
127
 
136
128
    @staticmethod
137
 
    def from_uncommitted(tree, other_tree, pb=None, base_tree=None):
 
129
    def from_uncommitted(tree, other_tree, pb):
138
130
        """Return a Merger for uncommitted changes in other_tree.
139
131
 
140
132
        :param tree: The tree to merge into
141
133
        :param other_tree: The tree to get uncommitted changes from
142
134
        :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
135
        """
146
 
        if base_tree is None:
147
 
            base_tree = other_tree.basis_tree()
148
 
        merger = Merger(tree.branch, other_tree, base_tree, tree, pb)
 
136
        merger = Merger(tree.branch, other_tree, other_tree.basis_tree(), tree,
 
137
                        pb)
149
138
        merger.base_rev_id = merger.base_tree.get_revision_id()
150
139
        merger.other_rev_id = None
151
140
        merger.other_basis = merger.base_rev_id
163
152
        base_revision_id, other_revision_id, verified =\
164
153
            mergeable.get_merge_request(tree.branch.repository)
165
154
        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')
 
155
        if (base_revision_id != _mod_revision.NULL_REVISION and
 
156
            revision_graph.is_ancestor(
 
157
            base_revision_id, tree.branch.last_revision())):
 
158
            base_revision_id = None
 
159
        else:
 
160
            warning('Performing cherrypick')
173
161
        merger = klass.from_revision_ids(pb, tree, other_revision_id,
174
162
                                         base_revision_id, revision_graph=
175
163
                                         revision_graph)
177
165
 
178
166
    @staticmethod
179
167
    def from_revision_ids(pb, tree, other, base=None, other_branch=None,
180
 
                          base_branch=None, revision_graph=None,
181
 
                          tree_branch=None):
 
168
                          base_branch=None, revision_graph=None):
182
169
        """Return a Merger for revision-ids.
183
170
 
184
 
        :param pb: A progress indicator
185
171
        :param tree: The tree to merge changes into
186
172
        :param other: The revision-id to use as OTHER
187
173
        :param base: The revision-id to use as BASE.  If not specified, will
192
178
            not supplied, other_branch or tree.branch will be used.
193
179
        :param revision_graph: If you have a revision_graph precomputed, pass
194
180
            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.
 
181
        :param pb: A progress indicator
197
182
        """
198
 
        if tree_branch is None:
199
 
            tree_branch = tree.branch
200
 
        merger = Merger(tree_branch, this_tree=tree, pb=pb,
 
183
        merger = Merger(tree.branch, this_tree=tree, pb=pb,
201
184
                        revision_graph=revision_graph)
202
185
        if other_branch is None:
203
186
            other_branch = tree.branch
253
236
        self.ensure_revision_trees()
254
237
        def get_id(tree, file_id):
255
238
            revision_id = tree.inventory[file_id].revision
 
239
            assert revision_id is not None
256
240
            return revision_id
257
241
        if self.this_rev_id is None:
258
242
            if self.this_basis_tree.get_file_sha1(file_id) != \
274
258
    def compare_basis(self):
275
259
        try:
276
260
            basis_tree = self.revision_tree(self.this_tree.last_revision())
277
 
        except errors.NoSuchRevision:
 
261
        except errors.RevisionNotPresent:
278
262
            basis_tree = self.this_tree.basis_tree()
279
263
        changes = self.this_tree.changes_from(basis_tree)
280
264
        if not changes.has_changed():
294
278
        for revision_id in new_parents:
295
279
            try:
296
280
                tree = self.revision_tree(revision_id)
297
 
            except errors.NoSuchRevision:
 
281
            except errors.RevisionNotPresent:
298
282
                tree = None
299
283
            else:
300
284
                tree.lock_read()
366
350
                     ensure_null(self.other_basis)]
367
351
        if NULL_REVISION in revisions:
368
352
            self.base_rev_id = NULL_REVISION
369
 
            self.base_tree = self.revision_tree(self.base_rev_id)
370
 
            self._is_criss_cross = False
371
353
        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
 
354
            self.base_rev_id, steps = self.revision_graph.find_unique_lca(
 
355
                revisions[0], revisions[1], count_steps=True)
390
356
            if self.base_rev_id == NULL_REVISION:
391
357
                raise UnrelatedBranches()
392
 
            if self._is_criss_cross:
 
358
            if steps > 1:
393
359
                warning('Warning: criss-cross merge encountered.  See bzr'
394
360
                        ' 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)
 
361
        self.base_tree = self.revision_tree(self.base_rev_id)
409
362
        self.base_is_ancestor = True
410
363
        self.base_is_other_ancestor = True
411
 
        mutter('Base revid: %r' % self.base_rev_id)
412
364
 
413
365
    def set_base(self, base_revision):
414
366
        """Set the base revision to use for the merge.
454
406
        if self.merge_type.supports_cherrypick:
455
407
            kwargs['cherrypick'] = (not self.base_is_ancestor or
456
408
                                    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
409
        return self.merge_type(pb=self._pb,
461
410
                               change_reporter=self.change_reporter,
462
411
                               **kwargs)
463
412
 
464
 
    def _do_merge_to(self, merge):
465
 
        merge.do_merge()
466
 
        if self.recurse == 'down':
467
 
            for relpath, file_id in self.this_tree.iter_references():
468
 
                sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
469
 
                other_revision = self.other_tree.get_reference_revision(
470
 
                    file_id, relpath)
471
 
                if  other_revision == sub_tree.last_revision():
472
 
                    continue
473
 
                sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
474
 
                sub_merge.merge_type = self.merge_type
475
 
                other_branch = self.other_branch.reference_parent(file_id, relpath)
476
 
                sub_merge.set_other_revision(other_revision, other_branch)
477
 
                base_revision = self.base_tree.get_reference_revision(file_id)
478
 
                sub_merge.base_tree = \
479
 
                    sub_tree.branch.repository.revision_tree(base_revision)
480
 
                sub_merge.base_rev_id = base_revision
481
 
                sub_merge.do_merge()
482
 
 
483
413
    def do_merge(self):
484
414
        self.this_tree.lock_tree_write()
 
415
        if self.base_tree is not None:
 
416
            self.base_tree.lock_read()
 
417
        if self.other_tree is not None:
 
418
            self.other_tree.lock_read()
485
419
        try:
 
420
            merge = self.make_merger()
 
421
            merge.do_merge()
 
422
            if self.recurse == 'down':
 
423
                for path, file_id in self.this_tree.iter_references():
 
424
                    sub_tree = self.this_tree.get_nested_tree(file_id, path)
 
425
                    other_revision = self.other_tree.get_reference_revision(
 
426
                        file_id, path)
 
427
                    if  other_revision == sub_tree.last_revision():
 
428
                        continue
 
429
                    sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
 
430
                    sub_merge.merge_type = self.merge_type
 
431
                    relpath = self.this_tree.relpath(path)
 
432
                    other_branch = self.other_branch.reference_parent(file_id, relpath)
 
433
                    sub_merge.set_other_revision(other_revision, other_branch)
 
434
                    base_revision = self.base_tree.get_reference_revision(file_id)
 
435
                    sub_merge.base_tree = \
 
436
                        sub_tree.branch.repository.revision_tree(base_revision)
 
437
                    sub_merge.base_rev_id = base_revision
 
438
                    sub_merge.do_merge()
 
439
 
 
440
        finally:
 
441
            if self.other_tree is not None:
 
442
                self.other_tree.unlock()
486
443
            if self.base_tree is not None:
487
 
                self.base_tree.lock_read()
488
 
            try:
489
 
                if self.other_tree is not None:
490
 
                    self.other_tree.lock_read()
491
 
                try:
492
 
                    merge = self.make_merger()
493
 
                    self._do_merge_to(merge)
494
 
                finally:
495
 
                    if self.other_tree is not None:
496
 
                        self.other_tree.unlock()
497
 
            finally:
498
 
                if self.base_tree is not None:
499
 
                    self.base_tree.unlock()
500
 
        finally:
 
444
                self.base_tree.unlock()
501
445
            self.this_tree.unlock()
502
446
        if len(merge.cooked_conflicts) == 0:
503
447
            if not self.ignore_zero and not is_quiet():
508
452
        return len(merge.cooked_conflicts)
509
453
 
510
454
 
511
 
class _InventoryNoneEntry(object):
512
 
    """This represents an inventory entry which *isn't there*.
513
 
 
514
 
    It simplifies the merging logic if we always have an InventoryEntry, even
515
 
    if it isn't actually present
516
 
    """
517
 
    executable = None
518
 
    kind = None
519
 
    name = None
520
 
    parent_id = None
521
 
    revision = None
522
 
    symlink_target = None
523
 
    text_sha1 = None
524
 
 
525
 
_none_entry = _InventoryNoneEntry()
526
 
 
527
 
 
528
455
class Merge3Merger(object):
529
456
    """Three-way merger that uses the merge3 text merger"""
530
457
    requires_base = True
534
461
    supports_cherrypick = True
535
462
    supports_reverse_cherrypick = True
536
463
    winner_idx = {"this": 2, "other": 1, "conflict": 1}
537
 
    supports_lca_trees = True
538
464
 
539
 
    def __init__(self, working_tree, this_tree, base_tree, other_tree,
 
465
    def __init__(self, working_tree, this_tree, base_tree, other_tree, 
540
466
                 interesting_ids=None, reprocess=False, show_base=False,
541
467
                 pb=DummyProgress(), pp=None, change_reporter=None,
542
468
                 interesting_files=None, do_merge=True,
543
 
                 cherrypick=False, lca_trees=None):
 
469
                 cherrypick=False):
544
470
        """Initialize the merger object and perform the merge.
545
471
 
546
472
        :param working_tree: The working tree to apply the merge to
547
473
        :param this_tree: The local tree in the merge operation
548
474
        :param base_tree: The common tree in the merge operation
549
 
        :param other_tree: The other tree to merge changes from
 
475
        :param other_tree: The other other tree to merge changes from
550
476
        :param interesting_ids: The file_ids of files that should be
551
477
            participate in the merge.  May not be combined with
552
478
            interesting_files.
562
488
            be combined with interesting_ids.  If neither interesting_files nor
563
489
            interesting_ids is specified, all files may participate in the
564
490
            merge.
565
 
        :param lca_trees: Can be set to a dictionary of {revision_id:rev_tree}
566
 
            if the ancestry was found to include a criss-cross merge.
567
 
            Otherwise should be None.
568
491
        """
569
492
        object.__init__(self)
570
 
        if interesting_files is not None and interesting_ids is not None:
571
 
            raise ValueError(
572
 
                'specify either interesting_ids or interesting_files')
 
493
        if interesting_files is not None:
 
494
            assert interesting_ids is None
573
495
        self.interesting_ids = interesting_ids
574
496
        self.interesting_files = interesting_files
575
497
        self.this_tree = working_tree
579
501
        self.cooked_conflicts = []
580
502
        self.reprocess = reprocess
581
503
        self.show_base = show_base
582
 
        self._lca_trees = lca_trees
583
 
        # Uncommenting this will change the default algorithm to always use
584
 
        # _entries_lca. This can be useful for running the test suite and
585
 
        # making sure we haven't missed any corner cases.
586
 
        # if lca_trees is None:
587
 
        #     self._lca_trees = [self.base_tree]
588
504
        self.pb = pb
589
505
        self.pp = pp
590
506
        self.change_reporter = change_reporter
631
547
        return self.tt
632
548
 
633
549
    def _compute_transform(self):
634
 
        if self._lca_trees is None:
635
 
            entries = self._entries3()
636
 
            resolver = self._three_way
637
 
        else:
638
 
            entries = self._entries_lca()
639
 
            resolver = self._lca_multi_way
 
550
        entries = self._entries3()
640
551
        child_pb = ui.ui_factory.nested_progress_bar()
641
552
        try:
642
553
            for num, (file_id, changed, parents3, names3,
643
554
                      executable3) in enumerate(entries):
644
555
                child_pb.update('Preparing file merge', num, len(entries))
645
 
                self._merge_names(file_id, parents3, names3, resolver=resolver)
 
556
                self._merge_names(file_id, parents3, names3)
646
557
                if changed:
647
558
                    file_status = self.merge_contents(file_id)
648
559
                else:
649
560
                    file_status = 'unmodified'
650
561
                self._merge_executable(file_id,
651
 
                    executable3, file_status, resolver=resolver)
 
562
                    executable3, file_status)
652
563
        finally:
653
564
            child_pb.finished()
654
565
        self.fix_root()
680
591
        iterator = self.other_tree.iter_changes(self.base_tree,
681
592
                include_unchanged=True, specific_files=self.interesting_files,
682
593
                extra_trees=[self.this_tree])
683
 
        this_entries = dict((e.file_id, e) for p, e in
684
 
                            self.this_tree.iter_entries_by_dir(
685
 
                            self.interesting_ids))
686
594
        for (file_id, paths, changed, versioned, parents, names, kind,
687
595
             executable) in iterator:
688
596
            if (self.interesting_ids is not None and
689
597
                file_id not in self.interesting_ids):
690
598
                continue
691
 
            entry = this_entries.get(file_id)
692
 
            if entry is not None:
 
599
            if file_id in self.this_tree.inventory:
 
600
                entry = self.this_tree.inventory[file_id]
693
601
                this_name = entry.name
694
602
                this_parent = entry.parent_id
695
603
                this_executable = entry.executable
703
611
            result.append((file_id, changed, parents3, names3, executable3))
704
612
        return result
705
613
 
706
 
    def _entries_lca(self):
707
 
        """Gather data about files modified between multiple trees.
708
 
 
709
 
        This compares OTHER versus all LCA trees, and for interesting entries,
710
 
        it then compares with THIS and BASE.
711
 
 
712
 
        For the multi-valued entries, the format will be (BASE, [lca1, lca2])
713
 
        :return: [(file_id, changed, parents, names, executable)]
714
 
            file_id     Simple file_id of the entry
715
 
            changed     Boolean, True if the kind or contents changed
716
 
                        else False
717
 
            parents     ((base, [parent_id, in, lcas]), parent_id_other,
718
 
                         parent_id_this)
719
 
            names       ((base, [name, in, lcas]), name_in_other, name_in_this)
720
 
            executable  ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
721
 
        """
722
 
        if self.interesting_files is not None:
723
 
            lookup_trees = [self.this_tree, self.base_tree]
724
 
            lookup_trees.extend(self._lca_trees)
725
 
            # I think we should include the lca trees as well
726
 
            interesting_ids = self.other_tree.paths2ids(self.interesting_files,
727
 
                                                        lookup_trees)
728
 
        else:
729
 
            interesting_ids = self.interesting_ids
730
 
        result = []
731
 
        walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
732
 
 
733
 
        base_inventory = self.base_tree.inventory
734
 
        this_inventory = self.this_tree.inventory
735
 
        for path, file_id, other_ie, lca_values in walker.iter_all():
736
 
            # Is this modified at all from any of the other trees?
737
 
            if other_ie is None:
738
 
                other_ie = _none_entry
739
 
            if interesting_ids is not None and file_id not in interesting_ids:
740
 
                continue
741
 
 
742
 
            # If other_revision is found in any of the lcas, that means this
743
 
            # node is uninteresting. This is because when merging, if there are
744
 
            # multiple heads(), we have to create a new node. So if we didn't,
745
 
            # we know that the ancestry is linear, and that OTHER did not
746
 
            # modify anything
747
 
            # See doc/developers/lca_merge_resolution.txt for details
748
 
            other_revision = other_ie.revision
749
 
            if other_revision is not None:
750
 
                # We can't use this shortcut when other_revision is None,
751
 
                # because it may be None because things are WorkingTrees, and
752
 
                # not because it is *actually* None.
753
 
                is_unmodified = False
754
 
                for lca_path, ie in lca_values:
755
 
                    if ie is not None and ie.revision == other_revision:
756
 
                        is_unmodified = True
757
 
                        break
758
 
                if is_unmodified:
759
 
                    continue
760
 
 
761
 
            lca_entries = []
762
 
            for lca_path, lca_ie in lca_values:
763
 
                if lca_ie is None:
764
 
                    lca_entries.append(_none_entry)
765
 
                else:
766
 
                    lca_entries.append(lca_ie)
767
 
 
768
 
            if file_id in base_inventory:
769
 
                base_ie = base_inventory[file_id]
770
 
            else:
771
 
                base_ie = _none_entry
772
 
 
773
 
            if file_id in this_inventory:
774
 
                this_ie = this_inventory[file_id]
775
 
            else:
776
 
                this_ie = _none_entry
777
 
 
778
 
            lca_kinds = []
779
 
            lca_parent_ids = []
780
 
            lca_names = []
781
 
            lca_executable = []
782
 
            for lca_ie in lca_entries:
783
 
                lca_kinds.append(lca_ie.kind)
784
 
                lca_parent_ids.append(lca_ie.parent_id)
785
 
                lca_names.append(lca_ie.name)
786
 
                lca_executable.append(lca_ie.executable)
787
 
 
788
 
            kind_winner = self._lca_multi_way(
789
 
                (base_ie.kind, lca_kinds),
790
 
                other_ie.kind, this_ie.kind)
791
 
            parent_id_winner = self._lca_multi_way(
792
 
                (base_ie.parent_id, lca_parent_ids),
793
 
                other_ie.parent_id, this_ie.parent_id)
794
 
            name_winner = self._lca_multi_way(
795
 
                (base_ie.name, lca_names),
796
 
                other_ie.name, this_ie.name)
797
 
 
798
 
            content_changed = True
799
 
            if kind_winner == 'this':
800
 
                # No kind change in OTHER, see if there are *any* changes
801
 
                if other_ie.kind == 'directory':
802
 
                    if parent_id_winner == 'this' and name_winner == 'this':
803
 
                        # No change for this directory in OTHER, skip
804
 
                        continue
805
 
                    content_changed = False
806
 
                elif other_ie.kind is None or other_ie.kind == 'file':
807
 
                    def get_sha1(ie, tree):
808
 
                        if ie.kind != 'file':
809
 
                            return None
810
 
                        return tree.get_file_sha1(file_id)
811
 
                    base_sha1 = get_sha1(base_ie, self.base_tree)
812
 
                    lca_sha1s = [get_sha1(ie, tree) for ie, tree
813
 
                                 in zip(lca_entries, self._lca_trees)]
814
 
                    this_sha1 = get_sha1(this_ie, self.this_tree)
815
 
                    other_sha1 = get_sha1(other_ie, self.other_tree)
816
 
                    sha1_winner = self._lca_multi_way(
817
 
                        (base_sha1, lca_sha1s), other_sha1, this_sha1,
818
 
                        allow_overriding_lca=False)
819
 
                    exec_winner = self._lca_multi_way(
820
 
                        (base_ie.executable, lca_executable),
821
 
                        other_ie.executable, this_ie.executable)
822
 
                    if (parent_id_winner == 'this' and name_winner == 'this'
823
 
                        and sha1_winner == 'this' and exec_winner == 'this'):
824
 
                        # No kind, parent, name, exec, or content change for
825
 
                        # OTHER, so this node is not considered interesting
826
 
                        continue
827
 
                    if sha1_winner == 'this':
828
 
                        content_changed = False
829
 
                elif other_ie.kind == 'symlink':
830
 
                    def get_target(ie, tree):
831
 
                        if ie.kind != 'symlink':
832
 
                            return None
833
 
                        return tree.get_symlink_target(file_id)
834
 
                    base_target = get_target(base_ie, self.base_tree)
835
 
                    lca_targets = [get_target(ie, tree) for ie, tree
836
 
                                   in zip(lca_entries, self._lca_trees)]
837
 
                    this_target = get_target(this_ie, self.this_tree)
838
 
                    other_target = get_target(other_ie, self.other_tree)
839
 
                    target_winner = self._lca_multi_way(
840
 
                        (base_target, lca_targets),
841
 
                        other_target, this_target)
842
 
                    if (parent_id_winner == 'this' and name_winner == 'this'
843
 
                        and target_winner == 'this'):
844
 
                        # No kind, parent, name, or symlink target change
845
 
                        # not interesting
846
 
                        continue
847
 
                    if target_winner == 'this':
848
 
                        content_changed = False
849
 
                elif other_ie.kind == 'tree-reference':
850
 
                    # The 'changed' information seems to be handled at a higher
851
 
                    # level. At least, _entries3 returns False for content
852
 
                    # changed, even when at a new revision_id.
853
 
                    content_changed = False
854
 
                    if (parent_id_winner == 'this' and name_winner == 'this'):
855
 
                        # Nothing interesting
856
 
                        continue
857
 
                else:
858
 
                    raise AssertionError('unhandled kind: %s' % other_ie.kind)
859
 
                # XXX: We need to handle kind == 'symlink'
860
 
 
861
 
            # If we have gotten this far, that means something has changed
862
 
            result.append((file_id, content_changed,
863
 
                           ((base_ie.parent_id, lca_parent_ids),
864
 
                            other_ie.parent_id, this_ie.parent_id),
865
 
                           ((base_ie.name, lca_names),
866
 
                            other_ie.name, this_ie.name),
867
 
                           ((base_ie.executable, lca_executable),
868
 
                            other_ie.executable, this_ie.executable)
869
 
                          ))
870
 
        return result
871
 
 
872
 
 
873
614
    def fix_root(self):
874
615
        try:
875
616
            self.tt.final_kind(self.tt.root)
876
617
        except NoSuchFile:
877
618
            self.tt.cancel_deletion(self.tt.root)
878
619
        if self.tt.final_file_id(self.tt.root) is None:
879
 
            self.tt.version_file(self.tt.tree_file_id(self.tt.root),
 
620
            self.tt.version_file(self.tt.tree_file_id(self.tt.root), 
880
621
                                 self.tt.root)
 
622
        if self.other_tree.inventory.root is None:
 
623
            return
881
624
        other_root_file_id = self.other_tree.get_root_id()
882
 
        if other_root_file_id is None:
883
 
            return
884
625
        other_root = self.tt.trans_id_file_id(other_root_file_id)
885
626
        if other_root == self.tt.root:
886
627
            return
888
629
            self.tt.final_kind(other_root)
889
630
        except NoSuchFile:
890
631
            return
891
 
        if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
892
 
            # the other tree's root is a non-root in the current tree
893
 
            return
894
632
        self.reparent_children(self.other_tree.inventory.root, self.tt.root)
895
633
        self.tt.cancel_creation(other_root)
896
634
        self.tt.cancel_versioning(other_root)
925
663
        if entry is None:
926
664
            return None
927
665
        return entry.name
928
 
 
 
666
    
929
667
    @staticmethod
930
668
    def contents_sha1(tree, file_id):
931
669
        """Determine the sha1 of the file contents (used as a key method)."""
964
702
            return "other"
965
703
 
966
704
    @staticmethod
967
 
    def _lca_multi_way(bases, other, this, allow_overriding_lca=True):
968
 
        """Consider LCAs when determining whether a change has occurred.
969
 
 
970
 
        If LCAS are all identical, this is the same as a _three_way comparison.
971
 
 
972
 
        :param bases: value in (BASE, [LCAS])
973
 
        :param other: value in OTHER
974
 
        :param this: value in THIS
975
 
        :param allow_overriding_lca: If there is more than one unique lca
976
 
            value, allow OTHER to override THIS if it has a new value, and
977
 
            THIS only has an lca value, or vice versa. This is appropriate for
978
 
            truly scalar values, not as much for non-scalars.
979
 
        :return: 'this', 'other', or 'conflict' depending on whether an entry
980
 
            changed or not.
981
 
        """
982
 
        # See doc/developers/lca_tree_merging.txt for details about this
983
 
        # algorithm.
984
 
        if other == this:
985
 
            # Either Ambiguously clean, or nothing was actually changed. We
986
 
            # don't really care
987
 
            return 'this'
988
 
        base_val, lca_vals = bases
989
 
        # Remove 'base_val' from the lca_vals, because it is not interesting
990
 
        filtered_lca_vals = [lca_val for lca_val in lca_vals
991
 
                                      if lca_val != base_val]
992
 
        if len(filtered_lca_vals) == 0:
993
 
            return Merge3Merger._three_way(base_val, other, this)
994
 
 
995
 
        unique_lca_vals = set(filtered_lca_vals)
996
 
        if len(unique_lca_vals) == 1:
997
 
            return Merge3Merger._three_way(unique_lca_vals.pop(), other, this)
998
 
 
999
 
        if allow_overriding_lca:
1000
 
            if other in unique_lca_vals:
1001
 
                if this in unique_lca_vals:
1002
 
                    # Each side picked a different lca, conflict
1003
 
                    return 'conflict'
1004
 
                else:
1005
 
                    # This has a value which supersedes both lca values, and
1006
 
                    # other only has an lca value
1007
 
                    return 'this'
1008
 
            elif this in unique_lca_vals:
1009
 
                # OTHER has a value which supersedes both lca values, and this
1010
 
                # only has an lca value
1011
 
                return 'other'
1012
 
 
1013
 
        # At this point, the lcas disagree, and the tips disagree
1014
 
        return 'conflict'
1015
 
 
1016
 
    @staticmethod
1017
705
    def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
1018
706
        """Do a three-way test on a scalar.
1019
707
        Return "this", "other" or "conflict", depending whether a value wins.
1024
712
        if key_base == key_other:
1025
713
            return "this"
1026
714
        key_this = key(this_tree, file_id)
 
715
        if key_this not in (key_base, key_other):
 
716
            return "conflict"
1027
717
        # "Ambiguous clean merge"
1028
 
        if key_this == key_other:
 
718
        elif key_this == key_other:
1029
719
            return "this"
1030
 
        elif key_this == key_base:
 
720
        else:
 
721
            assert key_this == key_base
1031
722
            return "other"
1032
 
        else:
1033
 
            return "conflict"
1034
723
 
1035
724
    def merge_names(self, file_id):
1036
725
        def get_entry(tree):
1051
740
            else:
1052
741
                names.append(entry.name)
1053
742
                parents.append(entry.parent_id)
1054
 
        return self._merge_names(file_id, parents, names,
1055
 
                                 resolver=self._three_way)
 
743
        return self._merge_names(file_id, parents, names)
1056
744
 
1057
 
    def _merge_names(self, file_id, parents, names, resolver):
 
745
    def _merge_names(self, file_id, parents, names):
1058
746
        """Perform a merge on file_id names and parents"""
1059
747
        base_name, other_name, this_name = names
1060
748
        base_parent, other_parent, this_parent = parents
1061
749
 
1062
 
        name_winner = resolver(*names)
 
750
        name_winner = self._three_way(*names)
1063
751
 
1064
 
        parent_id_winner = resolver(*parents)
 
752
        parent_id_winner = self._three_way(*parents)
1065
753
        if this_name is None:
1066
754
            if name_winner == "this":
1067
755
                name_winner = "other"
1071
759
            return
1072
760
        if name_winner == "conflict":
1073
761
            trans_id = self.tt.trans_id_file_id(file_id)
1074
 
            self._raw_conflicts.append(('name conflict', trans_id,
 
762
            self._raw_conflicts.append(('name conflict', trans_id, 
1075
763
                                        this_name, other_name))
1076
764
        if parent_id_winner == "conflict":
1077
765
            trans_id = self.tt.trans_id_file_id(file_id)
1078
 
            self._raw_conflicts.append(('parent conflict', trans_id,
 
766
            self._raw_conflicts.append(('parent conflict', trans_id, 
1079
767
                                        this_parent, other_parent))
1080
768
        if other_name is None:
1081
 
            # it doesn't matter whether the result was 'other' or
 
769
            # it doesn't matter whether the result was 'other' or 
1082
770
            # 'conflict'-- if there's no 'other', we leave it alone.
1083
771
            return
1084
772
        # if we get here, name_winner and parent_winner are set to safe values.
1090
778
                                parent_trans_id, trans_id)
1091
779
 
1092
780
    def merge_contents(self, file_id):
1093
 
        """Performs a merge on file_id contents."""
 
781
        """Performa a merge on file_id contents."""
1094
782
        def contents_pair(tree):
1095
783
            if file_id not in tree:
1096
784
                return (None, None)
1111
799
                self.tt.unversion_file(trans_id)
1112
800
                if file_id in self.this_tree:
1113
801
                    self.tt.delete_contents(trans_id)
1114
 
            file_group = self._dump_conflicts(name, parent_id, file_id,
 
802
            file_group = self._dump_conflicts(name, parent_id, file_id, 
1115
803
                                              set_version=True)
1116
804
            self._raw_conflicts.append(('contents conflict', file_group))
1117
805
 
1120
808
        # file kind...
1121
809
        base_pair = contents_pair(self.base_tree)
1122
810
        other_pair = contents_pair(self.other_tree)
1123
 
        if self._lca_trees:
1124
 
            this_pair = contents_pair(self.this_tree)
1125
 
            lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1126
 
            winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1127
 
                                         this_pair, allow_overriding_lca=False)
1128
 
        else:
1129
 
            if base_pair == other_pair:
1130
 
                winner = 'this'
1131
 
            else:
1132
 
                # We delayed evaluating this_pair as long as we can to avoid
1133
 
                # unnecessary sha1 calculation
1134
 
                this_pair = contents_pair(self.this_tree)
1135
 
                winner = self._three_way(base_pair, other_pair, this_pair)
1136
 
        if winner == 'this':
1137
 
            # No interesting changes introduced by OTHER
1138
 
            return "unmodified"
1139
 
        trans_id = self.tt.trans_id_file_id(file_id)
1140
 
        if winner == 'other':
1141
 
            # OTHER is a straight winner, so replace this contents with other
1142
 
            file_in_this = file_id in self.this_tree
1143
 
            if file_in_this:
1144
 
                # Remove any existing contents
1145
 
                self.tt.delete_contents(trans_id)
1146
 
            if file_id in self.other_tree:
1147
 
                # OTHER changed the file
1148
 
                create_from_tree(self.tt, trans_id,
1149
 
                                 self.other_tree, file_id)
1150
 
                if not file_in_this:
1151
 
                    self.tt.version_file(file_id, trans_id)
1152
 
                return "modified"
1153
 
            elif file_in_this:
1154
 
                # OTHER deleted the file
1155
 
                self.tt.unversion_file(trans_id)
1156
 
                return "deleted"
1157
 
        else:
1158
 
            # We have a hypothetical conflict, but if we have files, then we
1159
 
            # can try to merge the content
1160
 
            if this_pair[0] == 'file' and other_pair[0] == 'file':
 
811
        if base_pair == other_pair:
 
812
            # OTHER introduced no changes
 
813
            return "unmodified"
 
814
        this_pair = contents_pair(self.this_tree)
 
815
        if this_pair == other_pair:
 
816
            # THIS and OTHER introduced the same changes
 
817
            return "unmodified"
 
818
        else:
 
819
            trans_id = self.tt.trans_id_file_id(file_id)
 
820
            if this_pair == base_pair:
 
821
                # only OTHER introduced changes
 
822
                if file_id in self.this_tree:
 
823
                    # Remove any existing contents
 
824
                    self.tt.delete_contents(trans_id)
 
825
                if file_id in self.other_tree:
 
826
                    # OTHER changed the file
 
827
                    create_by_entry(self.tt, 
 
828
                                    self.other_tree.inventory[file_id], 
 
829
                                    self.other_tree, trans_id)
 
830
                    if file_id not in self.this_tree.inventory:
 
831
                        self.tt.version_file(file_id, trans_id)
 
832
                    return "modified"
 
833
                elif file_id in self.this_tree.inventory:
 
834
                    # OTHER deleted the file
 
835
                    self.tt.unversion_file(trans_id)
 
836
                    return "deleted"
 
837
            #BOTH THIS and OTHER introduced changes; scalar conflict
 
838
            elif this_pair[0] == "file" and other_pair[0] == "file":
1161
839
                # THIS and OTHER are both files, so text merge.  Either
1162
840
                # BASE is a file, or both converted to files, so at least we
1163
841
                # have agreement that output should be a file.
1165
843
                    self.text_merge(file_id, trans_id)
1166
844
                except BinaryFile:
1167
845
                    return contents_conflict()
1168
 
                if file_id not in self.this_tree:
 
846
                if file_id not in self.this_tree.inventory:
1169
847
                    self.tt.version_file(file_id, trans_id)
1170
848
                try:
1171
849
                    self.tt.tree_kind(trans_id)
1174
852
                    pass
1175
853
                return "modified"
1176
854
            else:
 
855
                # Scalar conflict, can't text merge.  Dump conflicts
1177
856
                return contents_conflict()
1178
857
 
1179
858
    def get_lines(self, tree, file_id):
1204
883
 
1205
884
        def iter_merge3(retval):
1206
885
            retval["text_conflicts"] = False
1207
 
            for line in m3.merge_lines(name_a = "TREE",
1208
 
                                       name_b = "MERGE-SOURCE",
 
886
            for line in m3.merge_lines(name_a = "TREE", 
 
887
                                       name_b = "MERGE-SOURCE", 
1209
888
                                       name_base = "BASE-REVISION",
1210
 
                                       start_marker=start_marker,
 
889
                                       start_marker=start_marker, 
1211
890
                                       base_marker=base_marker,
1212
891
                                       reprocess=self.reprocess):
1213
892
                if line.startswith(start_marker):
1222
901
            self._raw_conflicts.append(('text conflict', trans_id))
1223
902
            name = self.tt.final_name(trans_id)
1224
903
            parent_id = self.tt.final_parent(trans_id)
1225
 
            file_group = self._dump_conflicts(name, parent_id, file_id,
 
904
            file_group = self._dump_conflicts(name, parent_id, file_id, 
1226
905
                                              this_lines, base_lines,
1227
906
                                              other_lines)
1228
907
            file_group.append(trans_id)
1229
908
 
1230
 
    def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
 
909
    def _dump_conflicts(self, name, parent_id, file_id, this_lines=None, 
1231
910
                        base_lines=None, other_lines=None, set_version=False,
1232
911
                        no_base=False):
1233
912
        """Emit conflict files.
1235
914
        determined automatically.  If set_version is true, the .OTHER, .THIS
1236
915
        or .BASE (in that order) will be created as versioned files.
1237
916
        """
1238
 
        data = [('OTHER', self.other_tree, other_lines),
 
917
        data = [('OTHER', self.other_tree, other_lines), 
1239
918
                ('THIS', self.this_tree, this_lines)]
1240
919
        if not no_base:
1241
920
            data.append(('BASE', self.base_tree, base_lines))
1250
929
                    self.tt.version_file(file_id, trans_id)
1251
930
                    versioned = True
1252
931
        return file_group
1253
 
 
1254
 
    def _conflict_file(self, name, parent_id, tree, file_id, suffix,
 
932
           
 
933
    def _conflict_file(self, name, parent_id, tree, file_id, suffix, 
1255
934
                       lines=None):
1256
935
        """Emit a single conflict file."""
1257
936
        name = name + '.' + suffix
1258
937
        trans_id = self.tt.create_path(name, parent_id)
1259
 
        create_from_tree(self.tt, trans_id, tree, file_id, lines)
 
938
        entry = tree.inventory[file_id]
 
939
        create_by_entry(self.tt, entry, tree, trans_id, lines)
1260
940
        return trans_id
1261
941
 
1262
942
    def merge_executable(self, file_id, file_status):
1263
943
        """Perform a merge on the execute bit."""
1264
944
        executable = [self.executable(t, file_id) for t in (self.base_tree,
1265
945
                      self.other_tree, self.this_tree)]
1266
 
        self._merge_executable(file_id, executable, file_status,
1267
 
                               resolver=self._three_way)
 
946
        self._merge_executable(file_id, executable, file_status)
1268
947
 
1269
 
    def _merge_executable(self, file_id, executable, file_status,
1270
 
                          resolver):
 
948
    def _merge_executable(self, file_id, executable, file_status):
1271
949
        """Perform a merge on the execute bit."""
1272
950
        base_executable, other_executable, this_executable = executable
1273
951
        if file_status == "deleted":
1274
952
            return
1275
 
        winner = resolver(*executable)
 
953
        winner = self._three_way(*executable)
1276
954
        if winner == "conflict":
1277
955
        # There must be a None in here, if we have a conflict, but we
1278
956
        # need executability since file status was not deleted.
1291
969
        if winner == "this":
1292
970
            executability = this_executable
1293
971
        else:
 
972
            assert winner == "other"
1294
973
            if file_id in self.other_tree:
1295
974
                executability = other_executable
1296
975
            elif file_id in self.this_tree:
1314
993
                conflict_args = conflict[2:]
1315
994
                if trans_id not in name_conflicts:
1316
995
                    name_conflicts[trans_id] = {}
1317
 
                unique_add(name_conflicts[trans_id], conflict_type,
 
996
                unique_add(name_conflicts[trans_id], conflict_type, 
1318
997
                           conflict_args)
1319
998
            if conflict_type == 'contents conflict':
1320
999
                for trans_id in conflict[1]:
1338
1017
        for trans_id, conflicts in name_conflicts.iteritems():
1339
1018
            try:
1340
1019
                this_parent, other_parent = conflicts['parent conflict']
1341
 
                if this_parent == other_parent:
1342
 
                    raise AssertionError()
 
1020
                assert this_parent != other_parent
1343
1021
            except KeyError:
1344
1022
                this_parent = other_parent = \
1345
1023
                    self.tt.final_file_id(self.tt.final_parent(trans_id))
1346
1024
            try:
1347
1025
                this_name, other_name = conflicts['name conflict']
1348
 
                if this_name == other_name:
1349
 
                    raise AssertionError()
 
1026
                assert this_name != other_name
1350
1027
            except KeyError:
1351
1028
                this_name = other_name = self.tt.final_name(trans_id)
1352
1029
            other_path = fp.get_path(trans_id)
1398
1075
        """
1399
1076
        lines, conflicts = self._merged_lines(file_id)
1400
1077
        lines = list(lines)
1401
 
        # Note we're checking whether the OUTPUT is binary in this case,
 
1078
        # Note we're checking whether the OUTPUT is binary in this case, 
1402
1079
        # because we don't want to get into weave merge guts.
1403
1080
        check_text_lines(lines)
1404
1081
        self.tt.create_file(lines, trans_id)
1406
1083
            self._raw_conflicts.append(('text conflict', trans_id))
1407
1084
            name = self.tt.final_name(trans_id)
1408
1085
            parent_id = self.tt.final_parent(trans_id)
1409
 
            file_group = self._dump_conflicts(name, parent_id, file_id,
 
1086
            file_group = self._dump_conflicts(name, parent_id, file_id, 
1410
1087
                                              no_base=True)
1411
1088
            file_group.append(trans_id)
1412
1089
 
1489
1166
                this_tree=None,
1490
1167
                pb=DummyProgress(),
1491
1168
                change_reporter=None):
1492
 
    """Primary interface for merging.
 
1169
    """Primary interface for merging. 
1493
1170
 
1494
 
        typical use is probably
 
1171
        typical use is probably 
1495
1172
        'merge_inner(branch, branch.get_revision_tree(other_revision),
1496
1173
                     branch.get_revision_tree(base_revision))'
1497
1174
        """
1505
1182
    merger.interesting_ids = interesting_ids
1506
1183
    merger.ignore_zero = ignore_zero
1507
1184
    if interesting_files:
1508
 
        if interesting_ids:
1509
 
            raise ValueError('Only supply interesting_ids'
1510
 
                             ' or interesting_files')
 
1185
        assert not interesting_ids, ('Only supply interesting_ids'
 
1186
                                     ' or interesting_files')
1511
1187
        merger.interesting_files = interesting_files
1512
1188
    merger.show_base = show_base
1513
1189
    merger.reprocess = reprocess
1555
1231
            yield status_a(revision, text)
1556
1232
        for revision, text in annotated_b[b_cur:bi]:
1557
1233
            yield status_b(revision, text)
 
1234
 
1558
1235
        # and now the matched section
1559
1236
        a_cur = ai + l
1560
1237
        b_cur = bi + l
1561
 
        for text_a in plain_a[ai:a_cur]:
 
1238
        for text_a, text_b in zip(plain_a[ai:a_cur], plain_b[bi:b_cur]):
 
1239
            assert text_a == text_b
1562
1240
            yield "unchanged", text_a
1563
1241
 
1564
1242
 
1565
1243
class _PlanMergeBase(object):
1566
1244
 
1567
 
    def __init__(self, a_rev, b_rev, vf, key_prefix):
 
1245
    def __init__(self, a_rev, b_rev, vf):
1568
1246
        """Contructor.
1569
1247
 
1570
1248
        :param a_rev: Revision-id of one revision to merge
1571
1249
        :param b_rev: Revision-id of the other revision to merge
1572
 
        :param vf: A VersionedFiles containing both revisions
1573
 
        :param key_prefix: A prefix for accessing keys in vf, typically
1574
 
            (file_id,).
 
1250
        :param vf: A versionedfile containing both revisions
1575
1251
        """
1576
1252
        self.a_rev = a_rev
1577
1253
        self.b_rev = b_rev
 
1254
        self.lines_a = vf.get_lines(a_rev)
 
1255
        self.lines_b = vf.get_lines(b_rev)
1578
1256
        self.vf = vf
1579
1257
        self._last_lines = None
1580
1258
        self._last_lines_revision_id = None
1581
1259
        self._cached_matching_blocks = {}
1582
 
        self._key_prefix = key_prefix
1583
 
        self._precache_tip_lines()
1584
 
 
1585
 
    def _precache_tip_lines(self):
1586
 
        lines = self.get_lines([self.a_rev, self.b_rev])
1587
 
        self.lines_a = lines[self.a_rev]
1588
 
        self.lines_b = lines[self.b_rev]
1589
 
 
1590
 
    def get_lines(self, revisions):
1591
 
        """Get lines for revisions from the backing VersionedFiles.
1592
 
 
1593
 
        :raises RevisionNotPresent: on absent texts.
1594
 
        """
1595
 
        keys = [(self._key_prefix + (rev,)) for rev in revisions]
1596
 
        result = {}
1597
 
        for record in self.vf.get_record_stream(keys, 'unordered', True):
1598
 
            if record.storage_kind == 'absent':
1599
 
                raise errors.RevisionNotPresent(record.key, self.vf)
1600
 
            result[record.key[-1]] = osutils.chunks_to_lines(
1601
 
                record.get_bytes_as('chunked'))
1602
 
        return result
1603
1260
 
1604
1261
    def plan_merge(self):
1605
1262
        """Generate a 'plan' for merging the two revisions.
1653
1310
            return cached
1654
1311
        if self._last_lines_revision_id == left_revision:
1655
1312
            left_lines = self._last_lines
1656
 
            right_lines = self.get_lines([right_revision])[right_revision]
1657
1313
        else:
1658
 
            lines = self.get_lines([left_revision, right_revision])
1659
 
            left_lines = lines[left_revision]
1660
 
            right_lines = lines[right_revision]
 
1314
            left_lines = self.vf.get_lines(left_revision)
 
1315
        right_lines = self.vf.get_lines(right_revision)
1661
1316
        self._last_lines = right_lines
1662
1317
        self._last_lines_revision_id = right_revision
1663
1318
        matcher = patiencediff.PatienceSequenceMatcher(None, left_lines,
1716
1371
class _PlanMerge(_PlanMergeBase):
1717
1372
    """Plan an annotate merge using on-the-fly annotation"""
1718
1373
 
1719
 
    def __init__(self, a_rev, b_rev, vf, key_prefix):
1720
 
        super(_PlanMerge, self).__init__(a_rev, b_rev, vf, key_prefix)
1721
 
        self.a_key = self._key_prefix + (self.a_rev,)
1722
 
        self.b_key = self._key_prefix + (self.b_rev,)
1723
 
        self.graph = Graph(self.vf)
1724
 
        heads = self.graph.heads((self.a_key, self.b_key))
1725
 
        if len(heads) == 1:
1726
 
            # one side dominates, so we can just return its values, yay for
1727
 
            # per-file graphs
1728
 
            # Ideally we would know that before we get this far
1729
 
            self._head_key = heads.pop()
1730
 
            if self._head_key == self.a_key:
1731
 
                other = b_rev
1732
 
            else:
1733
 
                other = a_rev
1734
 
            mutter('found dominating revision for %s\n%s > %s', self.vf,
1735
 
                   self._head_key[-1], other)
1736
 
            self._weave = None
1737
 
        else:
1738
 
            self._head_key = None
1739
 
            self._build_weave()
1740
 
 
1741
 
    def _precache_tip_lines(self):
1742
 
        # Turn this into a no-op, because we will do this later
1743
 
        pass
1744
 
 
1745
 
    def _find_recursive_lcas(self):
1746
 
        """Find all the ancestors back to a unique lca"""
1747
 
        cur_ancestors = (self.a_key, self.b_key)
1748
 
        # graph.find_lca(uncommon, keys) now returns plain NULL_REVISION,
1749
 
        # rather than a key tuple. We will just map that directly to no common
1750
 
        # ancestors.
1751
 
        parent_map = {}
1752
 
        while True:
1753
 
            next_lcas = self.graph.find_lca(*cur_ancestors)
1754
 
            # Map a plain NULL_REVISION to a simple no-ancestors
1755
 
            if next_lcas == set([NULL_REVISION]):
1756
 
                next_lcas = ()
1757
 
            # Order the lca's based on when they were merged into the tip
1758
 
            # While the actual merge portion of weave merge uses a set() of
1759
 
            # active revisions, the order of insertion *does* effect the
1760
 
            # implicit ordering of the texts.
1761
 
            for rev_key in cur_ancestors:
1762
 
                ordered_parents = tuple(self.graph.find_merge_order(rev_key,
1763
 
                                                                    next_lcas))
1764
 
                parent_map[rev_key] = ordered_parents
1765
 
            if len(next_lcas) == 0:
1766
 
                break
1767
 
            elif len(next_lcas) == 1:
1768
 
                parent_map[list(next_lcas)[0]] = ()
1769
 
                break
1770
 
            elif len(next_lcas) > 2:
1771
 
                # More than 2 lca's, fall back to grabbing all nodes between
1772
 
                # this and the unique lca.
1773
 
                mutter('More than 2 LCAs, falling back to all nodes for:'
1774
 
                       ' %s, %s\n=> %s', self.a_key, self.b_key, cur_ancestors)
1775
 
                cur_lcas = next_lcas
1776
 
                while len(cur_lcas) > 1:
1777
 
                    cur_lcas = self.graph.find_lca(*cur_lcas)
1778
 
                if len(cur_lcas) == 0:
1779
 
                    # No common base to find, use the full ancestry
1780
 
                    unique_lca = None
1781
 
                else:
1782
 
                    unique_lca = list(cur_lcas)[0]
1783
 
                    if unique_lca == NULL_REVISION:
1784
 
                        # find_lca will return a plain 'NULL_REVISION' rather
1785
 
                        # than a key tuple when there is no common ancestor, we
1786
 
                        # prefer to just use None, because it doesn't confuse
1787
 
                        # _get_interesting_texts()
1788
 
                        unique_lca = None
1789
 
                parent_map.update(self._find_unique_parents(next_lcas,
1790
 
                                                            unique_lca))
1791
 
                break
1792
 
            cur_ancestors = next_lcas
1793
 
        return parent_map
1794
 
 
1795
 
    def _find_unique_parents(self, tip_keys, base_key):
1796
 
        """Find ancestors of tip that aren't ancestors of base.
1797
 
 
1798
 
        :param tip_keys: Nodes that are interesting
1799
 
        :param base_key: Cull all ancestors of this node
1800
 
        :return: The parent map for all revisions between tip_keys and
1801
 
            base_key. base_key will be included. References to nodes outside of
1802
 
            the ancestor set will also be removed.
1803
 
        """
1804
 
        # TODO: this would be simpler if find_unique_ancestors took a list
1805
 
        #       instead of a single tip, internally it supports it, but it
1806
 
        #       isn't a "backwards compatible" api change.
1807
 
        if base_key is None:
1808
 
            parent_map = dict(self.graph.iter_ancestry(tip_keys))
1809
 
            # We remove NULL_REVISION because it isn't a proper tuple key, and
1810
 
            # thus confuses things like _get_interesting_texts, and our logic
1811
 
            # to add the texts into the memory weave.
1812
 
            if NULL_REVISION in parent_map:
1813
 
                parent_map.pop(NULL_REVISION)
1814
 
        else:
1815
 
            interesting = set()
1816
 
            for tip in tip_keys:
1817
 
                interesting.update(
1818
 
                    self.graph.find_unique_ancestors(tip, [base_key]))
1819
 
            parent_map = self.graph.get_parent_map(interesting)
1820
 
            parent_map[base_key] = ()
1821
 
        culled_parent_map, child_map, tails = self._remove_external_references(
1822
 
            parent_map)
1823
 
        # Remove all the tails but base_key
1824
 
        if base_key is not None:
1825
 
            tails.remove(base_key)
1826
 
            self._prune_tails(culled_parent_map, child_map, tails)
1827
 
        # Now remove all the uninteresting 'linear' regions
1828
 
        simple_map = _mod_graph.collapse_linear_regions(culled_parent_map)
1829
 
        return simple_map
1830
 
 
1831
 
    @staticmethod
1832
 
    def _remove_external_references(parent_map):
1833
 
        """Remove references that go outside of the parent map.
1834
 
 
1835
 
        :param parent_map: Something returned from Graph.get_parent_map(keys)
1836
 
        :return: (filtered_parent_map, child_map, tails)
1837
 
            filtered_parent_map is parent_map without external references
1838
 
            child_map is the {parent_key: [child_keys]} mapping
1839
 
            tails is a list of nodes that do not have any parents in the map
1840
 
        """
1841
 
        # TODO: The basic effect of this function seems more generic than
1842
 
        #       _PlanMerge. But the specific details of building a child_map,
1843
 
        #       and computing tails seems very specific to _PlanMerge.
1844
 
        #       Still, should this be in Graph land?
1845
 
        filtered_parent_map = {}
1846
 
        child_map = {}
1847
 
        tails = []
1848
 
        for key, parent_keys in parent_map.iteritems():
1849
 
            culled_parent_keys = [p for p in parent_keys if p in parent_map]
1850
 
            if not culled_parent_keys:
1851
 
                tails.append(key)
1852
 
            for parent_key in culled_parent_keys:
1853
 
                child_map.setdefault(parent_key, []).append(key)
1854
 
            # TODO: Do we want to do this, it adds overhead for every node,
1855
 
            #       just to say that the node has no children
1856
 
            child_map.setdefault(key, [])
1857
 
            filtered_parent_map[key] = culled_parent_keys
1858
 
        return filtered_parent_map, child_map, tails
1859
 
 
1860
 
    @staticmethod
1861
 
    def _prune_tails(parent_map, child_map, tails_to_remove):
1862
 
        """Remove tails from the parent map.
1863
 
 
1864
 
        This will remove the supplied revisions until no more children have 0
1865
 
        parents.
1866
 
 
1867
 
        :param parent_map: A dict of {child: [parents]}, this dictionary will
1868
 
            be modified in place.
1869
 
        :param tails_to_remove: A list of tips that should be removed,
1870
 
            this list will be consumed
1871
 
        :param child_map: The reverse dict of parent_map ({parent: [children]})
1872
 
            this dict will be modified
1873
 
        :return: None, parent_map will be modified in place.
1874
 
        """
1875
 
        while tails_to_remove:
1876
 
            next = tails_to_remove.pop()
1877
 
            parent_map.pop(next)
1878
 
            children = child_map.pop(next)
1879
 
            for child in children:
1880
 
                child_parents = parent_map[child]
1881
 
                child_parents.remove(next)
1882
 
                if len(child_parents) == 0:
1883
 
                    tails_to_remove.append(child)
1884
 
 
1885
 
    def _get_interesting_texts(self, parent_map):
1886
 
        """Return a dict of texts we are interested in.
1887
 
 
1888
 
        Note that the input is in key tuples, but the output is in plain
1889
 
        revision ids.
1890
 
 
1891
 
        :param parent_map: The output from _find_recursive_lcas
1892
 
        :return: A dict of {'revision_id':lines} as returned by
1893
 
            _PlanMergeBase.get_lines()
1894
 
        """
1895
 
        all_revision_keys = set(parent_map)
1896
 
        all_revision_keys.add(self.a_key)
1897
 
        all_revision_keys.add(self.b_key)
1898
 
 
1899
 
        # Everything else is in 'keys' but get_lines is in 'revision_ids'
1900
 
        all_texts = self.get_lines([k[-1] for k in all_revision_keys])
1901
 
        return all_texts
1902
 
 
1903
 
    def _build_weave(self):
1904
 
        from bzrlib import weave
1905
 
        self._weave = weave.Weave(weave_name='in_memory_weave',
1906
 
                                  allow_reserved=True)
1907
 
        parent_map = self._find_recursive_lcas()
1908
 
 
1909
 
        all_texts = self._get_interesting_texts(parent_map)
1910
 
 
1911
 
        # Note: Unfortunately, the order given by topo_sort will effect the
1912
 
        # ordering resolution in the output. Specifically, if you add A then B,
1913
 
        # then in the output text A lines will show up before B lines. And, of
1914
 
        # course, topo_sort doesn't guarantee any real ordering.
1915
 
        # So we use merge_sort, and add a fake node on the tip.
1916
 
        # This ensures that left-hand parents will always be inserted into the
1917
 
        # weave before right-hand parents.
1918
 
        tip_key = self._key_prefix + (_mod_revision.CURRENT_REVISION,)
1919
 
        parent_map[tip_key] = (self.a_key, self.b_key)
1920
 
 
1921
 
        for seq_num, key, depth, eom in reversed(tsort.merge_sort(parent_map,
1922
 
                                                                  tip_key)):
1923
 
            if key == tip_key:
1924
 
                continue
1925
 
        # for key in tsort.topo_sort(parent_map):
1926
 
            parent_keys = parent_map[key]
1927
 
            revision_id = key[-1]
1928
 
            parent_ids = [k[-1] for k in parent_keys]
1929
 
            self._weave.add_lines(revision_id, parent_ids,
1930
 
                                  all_texts[revision_id])
1931
 
 
1932
 
    def plan_merge(self):
1933
 
        """Generate a 'plan' for merging the two revisions.
1934
 
 
1935
 
        This involves comparing their texts and determining the cause of
1936
 
        differences.  If text A has a line and text B does not, then either the
1937
 
        line was added to text A, or it was deleted from B.  Once the causes
1938
 
        are combined, they are written out in the format described in
1939
 
        VersionedFile.plan_merge
1940
 
        """
1941
 
        if self._head_key is not None: # There was a single head
1942
 
            if self._head_key == self.a_key:
1943
 
                plan = 'new-a'
1944
 
            else:
1945
 
                if self._head_key != self.b_key:
1946
 
                    raise AssertionError('There was an invalid head: %s != %s'
1947
 
                                         % (self.b_key, self._head_key))
1948
 
                plan = 'new-b'
1949
 
            head_rev = self._head_key[-1]
1950
 
            lines = self.get_lines([head_rev])[head_rev]
1951
 
            return ((plan, line) for line in lines)
1952
 
        return self._weave.plan_merge(self.a_rev, self.b_rev)
 
1374
    def __init__(self, a_rev, b_rev, vf):
 
1375
       _PlanMergeBase.__init__(self, a_rev, b_rev, vf)
 
1376
       a_ancestry = set(vf.get_ancestry(a_rev, topo_sorted=False))
 
1377
       b_ancestry = set(vf.get_ancestry(b_rev, topo_sorted=False))
 
1378
       self.uncommon = a_ancestry.symmetric_difference(b_ancestry)
 
1379
 
 
1380
    def _determine_status(self, revision_id, unique_line_numbers):
 
1381
        """Determines the status unique lines versus all lcas.
 
1382
 
 
1383
        Basically, determines why the line is unique to this revision.
 
1384
 
 
1385
        A line may be determined new or killed, but not both.
 
1386
 
 
1387
        :param revision_id: The id of the revision in which the lines are
 
1388
            unique
 
1389
        :param unique_line_numbers: The line numbers of unique lines.
 
1390
        :return a tuple of (new_this, killed_other):
 
1391
        """
 
1392
        new = self._find_new(revision_id)
 
1393
        killed = set(unique_line_numbers).difference(new)
 
1394
        return new, killed
 
1395
 
 
1396
    def _find_new(self, version_id):
 
1397
        """Determine which lines are new in the ancestry of this version.
 
1398
 
 
1399
        If a lines is present in this version, and not present in any
 
1400
        common ancestor, it is considered new.
 
1401
        """
 
1402
        if version_id not in self.uncommon:
 
1403
            return set()
 
1404
        parents = self.vf.get_parent_map([version_id])[version_id]
 
1405
        if len(parents) == 0:
 
1406
            return set(range(len(self.vf.get_lines(version_id))))
 
1407
        new = None
 
1408
        for parent in parents:
 
1409
            blocks = self._get_matching_blocks(version_id, parent)
 
1410
            result, unused = self._unique_lines(blocks)
 
1411
            parent_new = self._find_new(parent)
 
1412
            for i, j, n in blocks:
 
1413
                for ii, jj in [(i+r, j+r) for r in range(n)]:
 
1414
                    if jj in parent_new:
 
1415
                        result.append(ii)
 
1416
            if new is None:
 
1417
                new = set(result)
 
1418
            else:
 
1419
                new.intersection_update(result)
 
1420
        return new
1953
1421
 
1954
1422
 
1955
1423
class _PlanLCAMerge(_PlanMergeBase):
1963
1431
    This is faster, and hopefully produces more useful output.
1964
1432
    """
1965
1433
 
1966
 
    def __init__(self, a_rev, b_rev, vf, key_prefix, graph):
1967
 
        _PlanMergeBase.__init__(self, a_rev, b_rev, vf, key_prefix)
1968
 
        lcas = graph.find_lca(key_prefix + (a_rev,), key_prefix + (b_rev,))
1969
 
        self.lcas = set()
1970
 
        for lca in lcas:
1971
 
            if lca == NULL_REVISION:
1972
 
                self.lcas.add(lca)
1973
 
            else:
1974
 
                self.lcas.add(lca[-1])
 
1434
    def __init__(self, a_rev, b_rev, vf, graph):
 
1435
        _PlanMergeBase.__init__(self, a_rev, b_rev, vf)
 
1436
        self.lcas = graph.find_lca(a_rev, b_rev)
1975
1437
        for lca in self.lcas:
1976
 
            if _mod_revision.is_null(lca):
1977
 
                lca_lines = []
1978
 
            else:
1979
 
                lca_lines = self.get_lines([lca])[lca]
 
1438
            lca_lines = self.vf.get_lines(lca)
1980
1439
            matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_a,
1981
1440
                                                           lca_lines)
1982
1441
            blocks = list(matcher.get_matching_blocks())