/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to breezy/merge.py

  • Committer: Jelmer Vernooij
  • Date: 2018-11-16 18:15:40 UTC
  • mto: (7143.16.20 even-more-cleanups)
  • mto: This revision was merged to the branch mainline in revision 7175.
  • Revision ID: jelmer@jelmer.uk-20181116181540-7y2wbhqzjk067mqy
Fix repo acquisition.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
import warnings
 
17
from __future__ import absolute_import
18
18
 
19
 
from bzrlib import (
 
19
from .lazy_import import lazy_import
 
20
lazy_import(globals(), """
 
21
from breezy import (
20
22
    branch as _mod_branch,
 
23
    cleanup,
21
24
    conflicts as _mod_conflicts,
22
25
    debug,
23
 
    decorators,
24
 
    errors,
 
26
    generate_ids,
25
27
    graph as _mod_graph,
26
 
    hooks,
27
28
    merge3,
28
29
    osutils,
29
30
    patiencediff,
34
35
    tree as _mod_tree,
35
36
    tsort,
36
37
    ui,
37
 
    versionedfile
38
 
    )
39
 
from bzrlib.cleanup import OperationWithCleanups
40
 
from bzrlib.symbol_versioning import (
41
 
    deprecated_in,
42
 
    deprecated_method,
 
38
    workingtree,
 
39
    )
 
40
from breezy.bzr import (
 
41
    versionedfile,
 
42
    )
 
43
from breezy.i18n import gettext
 
44
""")
 
45
from . import (
 
46
    decorators,
 
47
    errors,
 
48
    hooks,
 
49
    registry,
 
50
    )
 
51
from .sixish import (
 
52
    viewitems,
43
53
    )
44
54
# TODO: Report back as changes are merged in
45
55
 
46
56
 
47
 
def transform_tree(from_tree, to_tree, interesting_ids=None):
48
 
    from_tree.lock_tree_write()
49
 
    operation = OperationWithCleanups(merge_inner)
50
 
    operation.add_cleanup(from_tree.unlock)
51
 
    operation.run_simple(from_tree.branch, to_tree, from_tree,
52
 
        ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
 
57
def transform_tree(from_tree, to_tree, interesting_files=None):
 
58
    with from_tree.lock_tree_write():
 
59
        merge_inner(from_tree.branch, to_tree, from_tree,
 
60
                    ignore_zero=True, this_tree=from_tree,
 
61
                    interesting_files=interesting_files)
53
62
 
54
63
 
55
64
class MergeHooks(hooks.Hooks):
56
65
 
57
66
    def __init__(self):
58
 
        hooks.Hooks.__init__(self)
59
 
        self.create_hook(hooks.HookPoint('merge_file_content',
60
 
            "Called with a bzrlib.merge.Merger object to create a per file "
61
 
            "merge object when starting a merge. "
62
 
            "Should return either None or a subclass of "
63
 
            "``bzrlib.merge.AbstractPerFileMerger``. "
64
 
            "Such objects will then be called per file "
65
 
            "that needs to be merged (including when one "
66
 
            "side has deleted the file and the other has changed it). "
67
 
            "See the AbstractPerFileMerger API docs for details on how it is "
68
 
            "used by merge.",
69
 
            (2, 1), None))
 
67
        hooks.Hooks.__init__(self, "breezy.merge", "Merger.hooks")
 
68
        self.add_hook('merge_file_content',
 
69
                      "Called with a breezy.merge.Merger object to create a per file "
 
70
                      "merge object when starting a merge. "
 
71
                      "Should return either None or a subclass of "
 
72
                      "``breezy.merge.AbstractPerFileMerger``. "
 
73
                      "Such objects will then be called per file "
 
74
                      "that needs to be merged (including when one "
 
75
                      "side has deleted the file and the other has changed it). "
 
76
                      "See the AbstractPerFileMerger API docs for details on how it is "
 
77
                      "used by merge.",
 
78
                      (2, 1))
 
79
        self.add_hook('pre_merge',
 
80
                      'Called before a merge. '
 
81
                      'Receives a Merger object as the single argument.',
 
82
                      (2, 5))
 
83
        self.add_hook('post_merge',
 
84
                      'Called after a merge. '
 
85
                      'Receives a Merger object as the single argument. '
 
86
                      'The return value is ignored.',
 
87
                      (2, 5))
70
88
 
71
89
 
72
90
class AbstractPerFileMerger(object):
73
 
    """PerFileMerger objects are used by plugins extending merge for bzrlib.
74
 
 
75
 
    See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
76
 
    
 
91
    """PerFileMerger objects are used by plugins extending merge for breezy.
 
92
 
 
93
    See ``breezy.plugins.news_merge.news_merge`` for an example concrete class.
 
94
 
77
95
    :ivar merger: The Merge3Merger performing the merge.
78
96
    """
79
97
 
83
101
 
84
102
    def merge_contents(self, merge_params):
85
103
        """Attempt to merge the contents of a single file.
86
 
        
87
 
        :param merge_params: A bzrlib.merge.MergeHookParams
88
 
        :return : A tuple of (status, chunks), where status is one of
 
104
 
 
105
        :param merge_params: A breezy.merge.MergeFileHookParams
 
106
        :return: A tuple of (status, chunks), where status is one of
89
107
            'not_applicable', 'success', 'conflicted', or 'delete'.  If status
90
108
            is 'success' or 'conflicted', then chunks should be an iterable of
91
109
            strings for the new file contents.
109
127
        """
110
128
        raise NotImplementedError(self.file_matches)
111
129
 
112
 
    def get_filename(self, params, tree):
113
 
        """Lookup the filename (i.e. basename, not path), given a Tree (e.g.
114
 
        self.merger.this_tree) and a MergeHookParams.
115
 
        """
116
 
        return osutils.basename(tree.id2path(params.file_id))
117
 
 
118
 
    def get_filepath(self, params, tree):
119
 
        """Calculate the path to the file in a tree.
120
 
 
121
 
        :param params: A MergeHookParams describing the file to merge
122
 
        :param tree: a Tree, e.g. self.merger.this_tree.
123
 
        """
124
 
        return tree.id2path(params.file_id)
125
 
 
126
130
    def merge_contents(self, params):
127
131
        """Merge the contents of a single file."""
128
132
        # Check whether this custom merge logic should be used.
131
135
            params.winner == 'other' or
132
136
            # THIS and OTHER aren't both files.
133
137
            not params.is_file_merge() or
134
 
            # The filename doesn't match *.xml
135
 
            not self.file_matches(params)):
 
138
            # The filename doesn't match
 
139
                not self.file_matches(params)):
136
140
            return 'not_applicable', None
137
141
        return self.merge_matching(params)
138
142
 
152
156
    This is a base class for concrete custom file merging logic. Concrete
153
157
    classes should implement ``merge_text``.
154
158
 
155
 
    See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
156
 
    
 
159
    See ``breezy.plugins.news_merge.news_merge`` for an example concrete class.
 
160
 
157
161
    :ivar affected_files: The configured file paths to merge.
158
162
 
159
163
    :cvar name_prefix: The prefix to use when looking up configuration
160
164
        details. <name_prefix>_merge_files describes the files targeted by the
161
165
        hook for example.
162
 
        
 
166
 
163
167
    :cvar default_files: The default file paths to merge when no configuration
164
168
        is present.
165
169
    """
186
190
            config = self.merger.this_branch.get_config()
187
191
            # Until bzr provides a better policy for caching the config, we
188
192
            # just add the part we're interested in to the params to avoid
189
 
            # reading the config files repeatedly (bazaar.conf, location.conf,
 
193
            # reading the config files repeatedly (breezy.conf, location.conf,
190
194
            # branch.conf).
191
195
            config_key = self.name_prefix + '_merge_files'
192
196
            affected_files = config.get_user_option_as_list(config_key)
195
199
                affected_files = self.default_files
196
200
            self.affected_files = affected_files
197
201
        if affected_files:
198
 
            filepath = self.get_filepath(params, self.merger.this_tree)
 
202
            filepath = params.this_path
199
203
            if filepath in affected_files:
200
204
                return True
201
205
        return False
208
212
 
209
213
        This is called after checking that the merge should be performed in
210
214
        merge_contents, and it should behave as per
211
 
        ``bzrlib.merge.AbstractPerFileMerger.merge_contents``.
 
215
        ``breezy.merge.AbstractPerFileMerger.merge_contents``.
212
216
        """
213
217
        raise NotImplementedError(self.merge_text)
214
218
 
215
219
 
216
 
class MergeHookParams(object):
 
220
class MergeFileHookParams(object):
217
221
    """Object holding parameters passed to merge_file_content hooks.
218
222
 
219
223
    There are some fields hooks can access:
220
224
 
221
225
    :ivar file_id: the file ID of the file being merged
 
226
    :ivar base_path: Path in base tree
 
227
    :ivar other_path: Path in other tree
 
228
    :ivar this_path: Path in this tree
222
229
    :ivar trans_id: the transform ID for the merge of this file
223
230
    :ivar this_kind: kind of file_id in 'this' tree
224
231
    :ivar other_kind: kind of file_id in 'other' tree
225
232
    :ivar winner: one of 'this', 'other', 'conflict'
226
233
    """
227
234
 
228
 
    def __init__(self, merger, file_id, trans_id, this_kind, other_kind,
229
 
            winner):
 
235
    def __init__(self, merger, file_id, paths, trans_id, this_kind, other_kind,
 
236
                 winner):
230
237
        self._merger = merger
231
238
        self.file_id = file_id
 
239
        self.paths = paths
 
240
        self.base_path, self.other_path, self.this_path = paths
232
241
        self.trans_id = trans_id
233
242
        self.this_kind = this_kind
234
243
        self.other_kind = other_kind
241
250
    @decorators.cachedproperty
242
251
    def base_lines(self):
243
252
        """The lines of the 'base' version of the file."""
244
 
        return self._merger.get_lines(self._merger.base_tree, self.file_id)
 
253
        return self._merger.get_lines(self._merger.base_tree, self.base_path, self.file_id)
245
254
 
246
255
    @decorators.cachedproperty
247
256
    def this_lines(self):
248
257
        """The lines of the 'this' version of the file."""
249
 
        return self._merger.get_lines(self._merger.this_tree, self.file_id)
 
258
        return self._merger.get_lines(self._merger.this_tree, self.this_path, self.file_id)
250
259
 
251
260
    @decorators.cachedproperty
252
261
    def other_lines(self):
253
262
        """The lines of the 'other' version of the file."""
254
 
        return self._merger.get_lines(self._merger.other_tree, self.file_id)
 
263
        return self._merger.get_lines(self._merger.other_tree, self.other_path, self.file_id)
255
264
 
256
265
 
257
266
class Merger(object):
259
268
    hooks = MergeHooks()
260
269
 
261
270
    def __init__(self, this_branch, other_tree=None, base_tree=None,
262
 
                 this_tree=None, pb=None, change_reporter=None,
 
271
                 this_tree=None, change_reporter=None,
263
272
                 recurse='down', revision_graph=None):
264
273
        object.__init__(self)
265
274
        self.this_branch = this_branch
274
283
        self.base_tree = base_tree
275
284
        self.ignore_zero = False
276
285
        self.backup_files = False
277
 
        self.interesting_ids = None
278
286
        self.interesting_files = None
279
287
        self.show_base = False
280
288
        self.reprocess = False
281
 
        if pb is not None:
282
 
            warnings.warn("pb parameter to Merger() is deprecated and ignored")
283
289
        self.pp = None
284
290
        self.recurse = recurse
285
291
        self.change_reporter = change_reporter
333
339
                                      _set_base_is_other_ancestor)
334
340
 
335
341
    @staticmethod
336
 
    def from_uncommitted(tree, other_tree, pb=None, base_tree=None):
 
342
    def from_uncommitted(tree, other_tree, base_tree=None):
337
343
        """Return a Merger for uncommitted changes in other_tree.
338
344
 
339
345
        :param tree: The tree to merge into
340
346
        :param other_tree: The tree to get uncommitted changes from
341
 
        :param pb: A progress indicator
342
347
        :param base_tree: The basis to use for the merge.  If unspecified,
343
348
            other_tree.basis_tree() will be used.
344
349
        """
345
350
        if base_tree is None:
346
351
            base_tree = other_tree.basis_tree()
347
 
        merger = Merger(tree.branch, other_tree, base_tree, tree, pb)
 
352
        merger = Merger(tree.branch, other_tree, base_tree, tree)
348
353
        merger.base_rev_id = merger.base_tree.get_revision_id()
349
354
        merger.other_rev_id = None
350
355
        merger.other_basis = merger.base_rev_id
351
356
        return merger
352
357
 
353
358
    @classmethod
354
 
    def from_mergeable(klass, tree, mergeable, pb):
 
359
    def from_mergeable(klass, tree, mergeable):
355
360
        """Return a Merger for a bundle or merge directive.
356
361
 
357
362
        :param tree: The tree to merge changes into
358
363
        :param mergeable: A merge directive or bundle
359
 
        :param pb: A progress indicator
360
364
        """
361
365
        mergeable.install_revisions(tree.branch.repository)
362
366
        base_revision_id, other_revision_id, verified =\
365
369
        if base_revision_id is not None:
366
370
            if (base_revision_id != _mod_revision.NULL_REVISION and
367
371
                revision_graph.is_ancestor(
368
 
                base_revision_id, tree.branch.last_revision())):
 
372
                    base_revision_id, tree.branch.last_revision())):
369
373
                base_revision_id = None
370
374
            else:
371
375
                trace.warning('Performing cherrypick')
372
 
        merger = klass.from_revision_ids(pb, tree, other_revision_id,
373
 
                                         base_revision_id, revision_graph=
374
 
                                         revision_graph)
 
376
        merger = klass.from_revision_ids(tree, other_revision_id,
 
377
                                         base_revision_id, revision_graph=revision_graph)
375
378
        return merger, verified
376
379
 
377
380
    @staticmethod
378
 
    def from_revision_ids(pb, tree, other, base=None, other_branch=None,
 
381
    def from_revision_ids(tree, other, base=None, other_branch=None,
379
382
                          base_branch=None, revision_graph=None,
380
383
                          tree_branch=None):
381
384
        """Return a Merger for revision-ids.
382
385
 
383
 
        :param pb: A progress indicator
384
386
        :param tree: The tree to merge changes into
385
387
        :param other: The revision-id to use as OTHER
386
388
        :param base: The revision-id to use as BASE.  If not specified, will
396
398
        """
397
399
        if tree_branch is None:
398
400
            tree_branch = tree.branch
399
 
        merger = Merger(tree_branch, this_tree=tree, pb=pb,
 
401
        merger = Merger(tree_branch, this_tree=tree,
400
402
                        revision_graph=revision_graph)
401
403
        if other_branch is None:
402
404
            other_branch = tree.branch
421
423
        return self._cached_trees[revision_id]
422
424
 
423
425
    def _get_tree(self, treespec, possible_transports=None):
424
 
        from bzrlib import workingtree
425
426
        location, revno = treespec
426
427
        if revno is None:
427
428
            tree = workingtree.WorkingTree.open_containing(location)[0]
435
436
        revision_id = _mod_revision.ensure_null(revision_id)
436
437
        return branch, self.revision_tree(revision_id, branch)
437
438
 
438
 
    @deprecated_method(deprecated_in((2, 1, 0)))
439
 
    def ensure_revision_trees(self):
440
 
        if self.this_revision_tree is None:
441
 
            self.this_basis_tree = self.revision_tree(self.this_basis)
442
 
            if self.this_basis == self.this_rev_id:
443
 
                self.this_revision_tree = self.this_basis_tree
444
 
 
445
 
        if self.other_rev_id is None:
446
 
            other_basis_tree = self.revision_tree(self.other_basis)
447
 
            if other_basis_tree.has_changes(self.other_tree):
448
 
                raise errors.WorkingTreeNotRevision(self.this_tree)
449
 
            other_rev_id = self.other_basis
450
 
            self.other_tree = other_basis_tree
451
 
 
452
 
    @deprecated_method(deprecated_in((2, 1, 0)))
453
 
    def file_revisions(self, file_id):
454
 
        self.ensure_revision_trees()
455
 
        def get_id(tree, file_id):
456
 
            revision_id = tree.inventory[file_id].revision
457
 
            return revision_id
458
 
        if self.this_rev_id is None:
459
 
            if self.this_basis_tree.get_file_sha1(file_id) != \
460
 
                self.this_tree.get_file_sha1(file_id):
461
 
                raise errors.WorkingTreeNotRevision(self.this_tree)
462
 
 
463
 
        trees = (self.this_basis_tree, self.other_tree)
464
 
        return [get_id(tree, file_id) for tree in trees]
465
 
 
466
 
    @deprecated_method(deprecated_in((2, 1, 0)))
467
 
    def check_basis(self, check_clean, require_commits=True):
468
 
        if self.this_basis is None and require_commits is True:
469
 
            raise errors.BzrCommandError(
470
 
                "This branch has no commits."
471
 
                " (perhaps you would prefer 'bzr pull')")
472
 
        if check_clean:
473
 
            self.compare_basis()
474
 
            if self.this_basis != self.this_rev_id:
475
 
                raise errors.UncommittedChanges(self.this_tree)
476
 
 
477
 
    @deprecated_method(deprecated_in((2, 1, 0)))
478
 
    def compare_basis(self):
479
 
        try:
480
 
            basis_tree = self.revision_tree(self.this_tree.last_revision())
481
 
        except errors.NoSuchRevision:
482
 
            basis_tree = self.this_tree.basis_tree()
483
 
        if not self.this_tree.has_changes(basis_tree):
484
 
            self.this_rev_id = self.this_basis
485
 
 
486
439
    def set_interesting_files(self, file_list):
487
440
        self.interesting_files = file_list
488
441
 
489
442
    def set_pending(self):
490
443
        if (not self.base_is_ancestor or not self.base_is_other_ancestor
491
 
            or self.other_rev_id is None):
 
444
                or self.other_rev_id is None):
492
445
            return
493
446
        self._add_parent()
494
447
 
495
448
    def _add_parent(self):
496
449
        new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
497
450
        new_parent_trees = []
498
 
        operation = OperationWithCleanups(self.this_tree.set_parent_trees)
 
451
        operation = cleanup.OperationWithCleanups(
 
452
            self.this_tree.set_parent_trees)
499
453
        for revision_id in new_parents:
500
454
            try:
501
455
                tree = self.revision_tree(revision_id)
532
486
                raise errors.NoCommits(self.other_branch)
533
487
        if self.other_rev_id is not None:
534
488
            self._cached_trees[self.other_rev_id] = self.other_tree
535
 
        self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
 
489
        self._maybe_fetch(self.other_branch,
 
490
                          self.this_branch, self.other_basis)
536
491
 
537
492
    def set_other_revision(self, revision_id, other_branch):
538
493
        """Set 'other' based on a branch and revision id
575
530
                self.base_rev_id = _mod_revision.NULL_REVISION
576
531
            elif len(lcas) == 1:
577
532
                self.base_rev_id = list(lcas)[0]
578
 
            else: # len(lcas) > 1
 
533
            else:  # len(lcas) > 1
 
534
                self._is_criss_cross = True
579
535
                if len(lcas) > 2:
580
536
                    # find_unique_lca can only handle 2 nodes, so we have to
581
537
                    # start back at the beginning. It is a shame to traverse
582
538
                    # the graph again, but better than re-implementing
583
539
                    # find_unique_lca.
584
540
                    self.base_rev_id = self.revision_graph.find_unique_lca(
585
 
                                            revisions[0], revisions[1])
 
541
                        revisions[0], revisions[1])
586
542
                else:
587
543
                    self.base_rev_id = self.revision_graph.find_unique_lca(
588
 
                                            *lcas)
589
 
                self._is_criss_cross = True
 
544
                        *lcas)
 
545
                sorted_lca_keys = self.revision_graph.find_merge_order(
 
546
                    revisions[0], lcas)
 
547
                if self.base_rev_id == _mod_revision.NULL_REVISION:
 
548
                    self.base_rev_id = sorted_lca_keys[0]
 
549
 
590
550
            if self.base_rev_id == _mod_revision.NULL_REVISION:
591
551
                raise errors.UnrelatedBranches()
592
552
            if self._is_criss_cross:
593
553
                trace.warning('Warning: criss-cross merge encountered.  See bzr'
594
554
                              ' help criss-cross.')
595
555
                trace.mutter('Criss-cross lcas: %r' % lcas)
596
 
                interesting_revision_ids = [self.base_rev_id]
597
 
                interesting_revision_ids.extend(lcas)
 
556
                if self.base_rev_id in lcas:
 
557
                    trace.mutter('Unable to find unique lca. '
 
558
                                 'Fallback %r as best option.'
 
559
                                 % self.base_rev_id)
 
560
                interesting_revision_ids = set(lcas)
 
561
                interesting_revision_ids.add(self.base_rev_id)
598
562
                interesting_trees = dict((t.get_revision_id(), t)
599
 
                    for t in self.this_branch.repository.revision_trees(
600
 
                        interesting_revision_ids))
 
563
                                         for t in self.this_branch.repository.revision_trees(
 
564
                    interesting_revision_ids))
601
565
                self._cached_trees.update(interesting_trees)
602
 
                self.base_tree = interesting_trees.pop(self.base_rev_id)
603
 
                sorted_lca_keys = self.revision_graph.find_merge_order(
604
 
                    revisions[0], lcas)
 
566
                if self.base_rev_id in lcas:
 
567
                    self.base_tree = interesting_trees[self.base_rev_id]
 
568
                else:
 
569
                    self.base_tree = interesting_trees.pop(self.base_rev_id)
605
570
                self._lca_trees = [interesting_trees[key]
606
571
                                   for key in sorted_lca_keys]
607
572
            else:
630
595
            self._maybe_fetch(base_branch, self.this_branch, self.base_rev_id)
631
596
 
632
597
    def make_merger(self):
633
 
        kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
 
598
        kwargs = {'working_tree': self.this_tree, 'this_tree': self.this_tree,
634
599
                  'other_tree': self.other_tree,
635
 
                  'interesting_ids': self.interesting_ids,
636
600
                  'interesting_files': self.interesting_files,
637
601
                  'this_branch': self.this_branch,
 
602
                  'other_branch': self.other_branch,
638
603
                  'do_merge': False}
639
604
        if self.merge_type.requires_base:
640
605
            kwargs['base_tree'] = self.base_tree
650
615
            raise errors.BzrError("Showing base is not supported for this"
651
616
                                  " merge type. %s" % self.merge_type)
652
617
        if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
653
 
            and not self.base_is_other_ancestor):
 
618
                and not self.base_is_other_ancestor):
654
619
            raise errors.CannotReverseCherrypick()
655
620
        if self.merge_type.supports_cherrypick:
656
621
            kwargs['cherrypick'] = (not self.base_is_ancestor or
658
623
        if self._is_criss_cross and getattr(self.merge_type,
659
624
                                            'supports_lca_trees', False):
660
625
            kwargs['lca_trees'] = self._lca_trees
661
 
        return self.merge_type(pb=None,
662
 
                               change_reporter=self.change_reporter,
 
626
        return self.merge_type(change_reporter=self.change_reporter,
663
627
                               **kwargs)
664
628
 
665
629
    def _do_merge_to(self):
666
630
        merge = self.make_merger()
667
631
        if self.other_branch is not None:
668
632
            self.other_branch.update_references(self.this_branch)
 
633
        for hook in Merger.hooks['pre_merge']:
 
634
            hook(merge)
669
635
        merge.do_merge()
 
636
        for hook in Merger.hooks['post_merge']:
 
637
            hook(merge)
670
638
        if self.recurse == 'down':
671
639
            for relpath, file_id in self.this_tree.iter_references():
672
 
                sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
 
640
                sub_tree = self.this_tree.get_nested_tree(relpath, file_id)
673
641
                other_revision = self.other_tree.get_reference_revision(
674
 
                    file_id, relpath)
675
 
                if  other_revision == sub_tree.last_revision():
 
642
                    relpath, file_id)
 
643
                if other_revision == sub_tree.last_revision():
676
644
                    continue
677
645
                sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
678
646
                sub_merge.merge_type = self.merge_type
679
 
                other_branch = self.other_branch.reference_parent(file_id, relpath)
 
647
                other_branch = self.other_branch.reference_parent(
 
648
                    relpath, file_id)
680
649
                sub_merge.set_other_revision(other_revision, other_branch)
681
 
                base_revision = self.base_tree.get_reference_revision(file_id)
 
650
                base_tree_path = _mod_tree.find_previous_path(
 
651
                    self.this_tree, self.base_tree, relpath)
 
652
                base_revision = self.base_tree.get_reference_revision(
 
653
                    base_tree_path, file_id)
682
654
                sub_merge.base_tree = \
683
655
                    sub_tree.branch.repository.revision_tree(base_revision)
684
656
                sub_merge.base_rev_id = base_revision
686
658
        return merge
687
659
 
688
660
    def do_merge(self):
689
 
        operation = OperationWithCleanups(self._do_merge_to)
 
661
        operation = cleanup.OperationWithCleanups(self._do_merge_to)
690
662
        self.this_tree.lock_tree_write()
691
663
        operation.add_cleanup(self.this_tree.unlock)
692
664
        if self.base_tree is not None:
698
670
        merge = operation.run_simple()
699
671
        if len(merge.cooked_conflicts) == 0:
700
672
            if not self.ignore_zero and not trace.is_quiet():
701
 
                trace.note("All changes applied successfully.")
 
673
                trace.note(gettext("All changes applied successfully."))
702
674
        else:
703
 
            trace.note("%d conflicts encountered."
 
675
            trace.note(gettext("%d conflicts encountered.")
704
676
                       % len(merge.cooked_conflicts))
705
677
 
706
678
        return len(merge.cooked_conflicts)
720
692
    symlink_target = None
721
693
    text_sha1 = None
722
694
 
 
695
 
723
696
_none_entry = _InventoryNoneEntry()
724
697
 
725
698
 
733
706
    supports_reverse_cherrypick = True
734
707
    winner_idx = {"this": 2, "other": 1, "conflict": 1}
735
708
    supports_lca_trees = True
 
709
    requires_file_merge_plan = False
736
710
 
737
711
    def __init__(self, working_tree, this_tree, base_tree, other_tree,
738
 
                 interesting_ids=None, reprocess=False, show_base=False,
739
 
                 pb=None, pp=None, change_reporter=None,
740
 
                 interesting_files=None, do_merge=True,
741
 
                 cherrypick=False, lca_trees=None, this_branch=None):
 
712
                 reprocess=False, show_base=False,
 
713
                 change_reporter=None, interesting_files=None, do_merge=True,
 
714
                 cherrypick=False, lca_trees=None, this_branch=None,
 
715
                 other_branch=None):
742
716
        """Initialize the merger object and perform the merge.
743
717
 
744
718
        :param working_tree: The working tree to apply the merge to
747
721
        :param other_tree: The other tree to merge changes from
748
722
        :param this_branch: The branch associated with this_tree.  Defaults to
749
723
            this_tree.branch if not supplied.
750
 
        :param interesting_ids: The file_ids of files that should be
751
 
            participate in the merge.  May not be combined with
752
 
            interesting_files.
 
724
        :param other_branch: The branch associated with other_tree, if any.
753
725
        :param: reprocess If True, perform conflict-reduction processing.
754
726
        :param show_base: If True, show the base revision in text conflicts.
755
727
            (incompatible with reprocess)
756
 
        :param pb: ignored
757
 
        :param pp: A ProgressPhase object
758
728
        :param change_reporter: An object that should report changes made
759
729
        :param interesting_files: The tree-relative paths of files that should
760
730
            participate in the merge.  If these paths refer to directories,
761
 
            the contents of those directories will also be included.  May not
762
 
            be combined with interesting_ids.  If neither interesting_files nor
763
 
            interesting_ids is specified, all files may participate in the
 
731
            the contents of those directories will also be included.  If not
 
732
            specified, all files may participate in the
764
733
            merge.
765
734
        :param lca_trees: Can be set to a dictionary of {revision_id:rev_tree}
766
735
            if the ancestry was found to include a criss-cross merge.
767
736
            Otherwise should be None.
768
737
        """
769
738
        object.__init__(self)
770
 
        if interesting_files is not None and interesting_ids is not None:
771
 
            raise ValueError(
772
 
                'specify either interesting_ids or interesting_files')
773
739
        if this_branch is None:
774
740
            this_branch = this_tree.branch
775
 
        self.interesting_ids = interesting_ids
776
741
        self.interesting_files = interesting_files
777
 
        self.this_tree = working_tree
 
742
        self.working_tree = working_tree
 
743
        self.this_tree = this_tree
778
744
        self.base_tree = base_tree
779
745
        self.other_tree = other_tree
780
746
        self.this_branch = this_branch
 
747
        self.other_branch = other_branch
781
748
        self._raw_conflicts = []
782
749
        self.cooked_conflicts = []
783
750
        self.reprocess = reprocess
792
759
        self.cherrypick = cherrypick
793
760
        if do_merge:
794
761
            self.do_merge()
795
 
        if pp is not None:
796
 
            warnings.warn("pp argument to Merge3Merger is deprecated")
797
 
        if pb is not None:
798
 
            warnings.warn("pb argument to Merge3Merger is deprecated")
799
762
 
800
763
    def do_merge(self):
801
 
        operation = OperationWithCleanups(self._do_merge)
802
 
        self.this_tree.lock_tree_write()
 
764
        operation = cleanup.OperationWithCleanups(self._do_merge)
 
765
        self.working_tree.lock_tree_write()
 
766
        operation.add_cleanup(self.working_tree.unlock)
 
767
        self.this_tree.lock_read()
803
768
        operation.add_cleanup(self.this_tree.unlock)
804
769
        self.base_tree.lock_read()
805
770
        operation.add_cleanup(self.base_tree.unlock)
808
773
        operation.run()
809
774
 
810
775
    def _do_merge(self, operation):
811
 
        self.tt = transform.TreeTransform(self.this_tree, None)
 
776
        self.tt = transform.TreeTransform(self.working_tree, None)
812
777
        operation.add_cleanup(self.tt.finalize)
813
778
        self._compute_transform()
814
779
        results = self.tt.apply(no_conflicts=True)
815
780
        self.write_modified(results)
816
781
        try:
817
 
            self.this_tree.add_conflicts(self.cooked_conflicts)
 
782
            self.working_tree.add_conflicts(self.cooked_conflicts)
818
783
        except errors.UnsupportedOperation:
819
784
            pass
820
785
 
821
786
    def make_preview_transform(self):
822
 
        operation = OperationWithCleanups(self._make_preview_transform)
823
 
        self.base_tree.lock_read()
824
 
        operation.add_cleanup(self.base_tree.unlock)
825
 
        self.other_tree.lock_read()
826
 
        operation.add_cleanup(self.other_tree.unlock)
827
 
        return operation.run_simple()
828
 
 
829
 
    def _make_preview_transform(self):
830
 
        self.tt = transform.TransformPreview(self.this_tree)
831
 
        self._compute_transform()
832
 
        return self.tt
 
787
        with self.base_tree.lock_read(), self.other_tree.lock_read():
 
788
            self.tt = transform.TransformPreview(self.working_tree)
 
789
            self._compute_transform()
 
790
            return self.tt
833
791
 
834
792
    def _compute_transform(self):
835
793
        if self._lca_trees is None:
838
796
        else:
839
797
            entries = self._entries_lca()
840
798
            resolver = self._lca_multi_way
841
 
        child_pb = ui.ui_factory.nested_progress_bar()
842
 
        try:
843
 
            factories = Merger.hooks['merge_file_content']
844
 
            hooks = [factory(self) for factory in factories] + [self]
845
 
            self.active_hooks = [hook for hook in hooks if hook is not None]
846
 
            for num, (file_id, changed, parents3, names3,
 
799
        # Prepare merge hooks
 
800
        factories = Merger.hooks['merge_file_content']
 
801
        # One hook for each registered one plus our default merger
 
802
        hooks = [factory(self) for factory in factories] + [self]
 
803
        self.active_hooks = [hook for hook in hooks if hook is not None]
 
804
        with ui.ui_factory.nested_progress_bar() as child_pb:
 
805
            for num, (file_id, changed, paths3, parents3, names3,
847
806
                      executable3) in enumerate(entries):
848
 
                child_pb.update('Preparing file merge', num, len(entries))
849
 
                self._merge_names(file_id, parents3, names3, resolver=resolver)
 
807
                # Try merging each entry
 
808
                child_pb.update(gettext('Preparing file merge'),
 
809
                                num, len(entries))
 
810
                self._merge_names(file_id, paths3, parents3,
 
811
                                  names3, resolver=resolver)
850
812
                if changed:
851
 
                    file_status = self._do_merge_contents(file_id)
 
813
                    file_status = self._do_merge_contents(paths3, file_id)
852
814
                else:
853
815
                    file_status = 'unmodified'
854
 
                self._merge_executable(file_id,
855
 
                    executable3, file_status, resolver=resolver)
856
 
        finally:
857
 
            child_pb.finished()
858
 
        self.fix_root()
859
 
        child_pb = ui.ui_factory.nested_progress_bar()
860
 
        try:
 
816
                self._merge_executable(paths3, file_id, executable3,
 
817
                                       file_status, resolver=resolver)
 
818
        self.tt.fixup_new_roots()
 
819
        self._finish_computing_transform()
 
820
 
 
821
    def _finish_computing_transform(self):
 
822
        """Finalize the transform and report the changes.
 
823
 
 
824
        This is the second half of _compute_transform.
 
825
        """
 
826
        with ui.ui_factory.nested_progress_bar() as child_pb:
861
827
            fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
862
 
                lambda t, c: transform.conflict_pass(t, c, self.other_tree))
863
 
        finally:
864
 
            child_pb.finished()
 
828
                                                       lambda t, c: transform.conflict_pass(t, c, self.other_tree))
865
829
        if self.change_reporter is not None:
866
 
            from bzrlib import delta
 
830
            from breezy import delta
867
831
            delta.report_changes(
868
832
                self.tt.iter_changes(), self.change_reporter)
869
833
        self.cook_conflicts(fs_conflicts)
870
834
        for conflict in self.cooked_conflicts:
871
 
            trace.warning(conflict)
 
835
            trace.warning('%s', conflict.describe())
872
836
 
873
837
    def _entries3(self):
874
838
        """Gather data about files modified between three trees.
881
845
        """
882
846
        result = []
883
847
        iterator = self.other_tree.iter_changes(self.base_tree,
884
 
                include_unchanged=True, specific_files=self.interesting_files,
885
 
                extra_trees=[self.this_tree])
886
 
        this_entries = dict((e.file_id, e) for p, e in
887
 
                            self.this_tree.iter_entries_by_dir(
888
 
                            self.interesting_ids))
 
848
                                                specific_files=self.interesting_files,
 
849
                                                extra_trees=[self.this_tree])
 
850
        this_interesting_files = self.this_tree.find_related_paths_across_trees(
 
851
            self.interesting_files, trees=[self.other_tree])
 
852
        this_entries = dict(self.this_tree.iter_entries_by_dir(
 
853
                            specific_files=this_interesting_files))
889
854
        for (file_id, paths, changed, versioned, parents, names, kind,
890
855
             executable) in iterator:
891
 
            if (self.interesting_ids is not None and
892
 
                file_id not in self.interesting_ids):
893
 
                continue
894
 
            entry = this_entries.get(file_id)
895
 
            if entry is not None:
896
 
                this_name = entry.name
897
 
                this_parent = entry.parent_id
898
 
                this_executable = entry.executable
 
856
            if paths[0] is not None:
 
857
                this_path = _mod_tree.find_previous_path(
 
858
                    self.base_tree, self.this_tree, paths[0])
 
859
            else:
 
860
                this_path = _mod_tree.find_previous_path(
 
861
                    self.other_tree, self.this_tree, paths[1])
 
862
            this_entry = this_entries.get(this_path)
 
863
            if this_entry is not None:
 
864
                this_name = this_entry.name
 
865
                this_parent = this_entry.parent_id
 
866
                this_executable = this_entry.executable
899
867
            else:
900
868
                this_name = None
901
869
                this_parent = None
902
870
                this_executable = None
903
871
            parents3 = parents + (this_parent,)
904
872
            names3 = names + (this_name,)
 
873
            paths3 = paths + (this_path, )
905
874
            executable3 = executable + (this_executable,)
906
 
            result.append((file_id, changed, parents3, names3, executable3))
 
875
            result.append((file_id, changed, paths3,
 
876
                           parents3, names3, executable3))
907
877
        return result
908
878
 
909
879
    def _entries_lca(self):
913
883
        it then compares with THIS and BASE.
914
884
 
915
885
        For the multi-valued entries, the format will be (BASE, [lca1, lca2])
916
 
        :return: [(file_id, changed, parents, names, executable)]
917
 
            file_id     Simple file_id of the entry
918
 
            changed     Boolean, True if the kind or contents changed
919
 
                        else False
920
 
            parents     ((base, [parent_id, in, lcas]), parent_id_other,
921
 
                         parent_id_this)
922
 
            names       ((base, [name, in, lcas]), name_in_other, name_in_this)
923
 
            executable  ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
 
886
 
 
887
        :return: [(file_id, changed, paths, parents, names, executable)], where:
 
888
 
 
889
            * file_id: Simple file_id of the entry
 
890
            * changed: Boolean, True if the kind or contents changed else False
 
891
            * paths: ((base, [path, in, lcas]), path_other, path_this)
 
892
            * parents: ((base, [parent_id, in, lcas]), parent_id_other,
 
893
                        parent_id_this)
 
894
            * names:   ((base, [name, in, lcas]), name_in_other, name_in_this)
 
895
            * executable: ((base, [exec, in, lcas]), exec_in_other,
 
896
                        exec_in_this)
924
897
        """
925
898
        if self.interesting_files is not None:
926
899
            lookup_trees = [self.this_tree, self.base_tree]
927
900
            lookup_trees.extend(self._lca_trees)
928
901
            # I think we should include the lca trees as well
929
 
            interesting_ids = self.other_tree.paths2ids(self.interesting_files,
930
 
                                                        lookup_trees)
 
902
            interesting_files = self.other_tree.find_related_paths_across_trees(
 
903
                self.interesting_files, lookup_trees)
931
904
        else:
932
 
            interesting_ids = self.interesting_ids
 
905
            interesting_files = None
933
906
        result = []
934
907
        walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
935
908
 
936
 
        base_inventory = self.base_tree.inventory
937
 
        this_inventory = self.this_tree.inventory
 
909
        base_inventory = self.base_tree.root_inventory
 
910
        this_inventory = self.this_tree.root_inventory
938
911
        for path, file_id, other_ie, lca_values in walker.iter_all():
939
912
            # Is this modified at all from any of the other trees?
940
913
            if other_ie is None:
941
914
                other_ie = _none_entry
942
 
            if interesting_ids is not None and file_id not in interesting_ids:
 
915
                other_path = None
 
916
            else:
 
917
                other_path = self.other_tree.id2path(file_id)
 
918
            if interesting_files is not None and other_path not in interesting_files:
943
919
                continue
944
920
 
945
921
            # If other_revision is found in any of the lcas, that means this
962
938
                    continue
963
939
 
964
940
            lca_entries = []
 
941
            lca_paths = []
965
942
            for lca_path, lca_ie in lca_values:
966
943
                if lca_ie is None:
967
944
                    lca_entries.append(_none_entry)
 
945
                    lca_paths.append(None)
968
946
                else:
969
947
                    lca_entries.append(lca_ie)
 
948
                    lca_paths.append(lca_path)
970
949
 
971
 
            if file_id in base_inventory:
972
 
                base_ie = base_inventory[file_id]
973
 
            else:
 
950
            try:
 
951
                base_ie = base_inventory.get_entry(file_id)
 
952
            except errors.NoSuchId:
974
953
                base_ie = _none_entry
 
954
                base_path = None
 
955
            else:
 
956
                base_path = self.base_tree.id2path(file_id)
975
957
 
976
 
            if file_id in this_inventory:
977
 
                this_ie = this_inventory[file_id]
978
 
            else:
 
958
            try:
 
959
                this_ie = this_inventory.get_entry(file_id)
 
960
            except errors.NoSuchId:
979
961
                this_ie = _none_entry
 
962
                this_path = None
 
963
            else:
 
964
                this_path = self.this_tree.id2path(file_id)
980
965
 
981
966
            lca_kinds = []
982
967
            lca_parent_ids = []
1007
992
                        continue
1008
993
                    content_changed = False
1009
994
                elif other_ie.kind is None or other_ie.kind == 'file':
1010
 
                    def get_sha1(ie, tree):
1011
 
                        if ie.kind != 'file':
1012
 
                            return None
1013
 
                        return tree.get_file_sha1(file_id)
1014
 
                    base_sha1 = get_sha1(base_ie, self.base_tree)
1015
 
                    lca_sha1s = [get_sha1(ie, tree) for ie, tree
1016
 
                                 in zip(lca_entries, self._lca_trees)]
1017
 
                    this_sha1 = get_sha1(this_ie, self.this_tree)
1018
 
                    other_sha1 = get_sha1(other_ie, self.other_tree)
 
995
                    def get_sha1(tree, path):
 
996
                        if path is None:
 
997
                            return None
 
998
                        try:
 
999
                            return tree.get_file_sha1(path, file_id)
 
1000
                        except errors.NoSuchFile:
 
1001
                            return None
 
1002
                    base_sha1 = get_sha1(self.base_tree, base_path)
 
1003
                    lca_sha1s = [get_sha1(tree, lca_path)
 
1004
                                 for tree, lca_path
 
1005
                                 in zip(self._lca_trees, lca_paths)]
 
1006
                    this_sha1 = get_sha1(self.this_tree, this_path)
 
1007
                    other_sha1 = get_sha1(self.other_tree, other_path)
1019
1008
                    sha1_winner = self._lca_multi_way(
1020
1009
                        (base_sha1, lca_sha1s), other_sha1, this_sha1,
1021
1010
                        allow_overriding_lca=False)
1023
1012
                        (base_ie.executable, lca_executable),
1024
1013
                        other_ie.executable, this_ie.executable)
1025
1014
                    if (parent_id_winner == 'this' and name_winner == 'this'
1026
 
                        and sha1_winner == 'this' and exec_winner == 'this'):
 
1015
                            and sha1_winner == 'this' and exec_winner == 'this'):
1027
1016
                        # No kind, parent, name, exec, or content change for
1028
1017
                        # OTHER, so this node is not considered interesting
1029
1018
                        continue
1030
1019
                    if sha1_winner == 'this':
1031
1020
                        content_changed = False
1032
1021
                elif other_ie.kind == 'symlink':
1033
 
                    def get_target(ie, tree):
 
1022
                    def get_target(ie, tree, path):
1034
1023
                        if ie.kind != 'symlink':
1035
1024
                            return None
1036
 
                        return tree.get_symlink_target(file_id)
1037
 
                    base_target = get_target(base_ie, self.base_tree)
1038
 
                    lca_targets = [get_target(ie, tree) for ie, tree
1039
 
                                   in zip(lca_entries, self._lca_trees)]
1040
 
                    this_target = get_target(this_ie, self.this_tree)
1041
 
                    other_target = get_target(other_ie, self.other_tree)
 
1025
                        return tree.get_symlink_target(path, file_id)
 
1026
                    base_target = get_target(
 
1027
                        base_ie, self.base_tree, base_path)
 
1028
                    lca_targets = [get_target(ie, tree, lca_path) for ie, tree, lca_path
 
1029
                                   in zip(lca_entries, self._lca_trees, lca_paths)]
 
1030
                    this_target = get_target(
 
1031
                        this_ie, self.this_tree, this_path)
 
1032
                    other_target = get_target(
 
1033
                        other_ie, self.other_tree, other_path)
1042
1034
                    target_winner = self._lca_multi_way(
1043
1035
                        (base_target, lca_targets),
1044
1036
                        other_target, this_target)
1045
1037
                    if (parent_id_winner == 'this' and name_winner == 'this'
1046
 
                        and target_winner == 'this'):
 
1038
                            and target_winner == 'this'):
1047
1039
                        # No kind, parent, name, or symlink target change
1048
1040
                        # not interesting
1049
1041
                        continue
1062
1054
 
1063
1055
            # If we have gotten this far, that means something has changed
1064
1056
            result.append((file_id, content_changed,
 
1057
                           ((base_path, lca_paths),
 
1058
                            other_path, this_path),
1065
1059
                           ((base_ie.parent_id, lca_parent_ids),
1066
1060
                            other_ie.parent_id, this_ie.parent_id),
1067
1061
                           ((base_ie.name, lca_names),
1068
1062
                            other_ie.name, this_ie.name),
1069
1063
                           ((base_ie.executable, lca_executable),
1070
1064
                            other_ie.executable, this_ie.executable)
1071
 
                          ))
 
1065
                           ))
1072
1066
        return result
1073
1067
 
1074
 
 
1075
 
    def fix_root(self):
1076
 
        try:
1077
 
            self.tt.final_kind(self.tt.root)
1078
 
        except errors.NoSuchFile:
1079
 
            self.tt.cancel_deletion(self.tt.root)
1080
 
        if self.tt.final_file_id(self.tt.root) is None:
1081
 
            self.tt.version_file(self.tt.tree_file_id(self.tt.root),
1082
 
                                 self.tt.root)
1083
 
        other_root_file_id = self.other_tree.get_root_id()
1084
 
        if other_root_file_id is None:
1085
 
            return
1086
 
        other_root = self.tt.trans_id_file_id(other_root_file_id)
1087
 
        if other_root == self.tt.root:
1088
 
            return
1089
 
        if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
1090
 
            # the other tree's root is a non-root in the current tree (as when
1091
 
            # a previously unrelated branch is merged into another)
1092
 
            return
1093
 
        try:
1094
 
            self.tt.final_kind(other_root)
1095
 
            other_root_is_present = True
1096
 
        except errors.NoSuchFile:
1097
 
            # other_root doesn't have a physical representation. We still need
1098
 
            # to move any references to the actual root of the tree.
1099
 
            other_root_is_present = False
1100
 
        # 'other_tree.inventory.root' is not present in this tree. We are
1101
 
        # calling adjust_path for children which *want* to be present with a
1102
 
        # correct place to go.
1103
 
        for thing, child in self.other_tree.inventory.root.children.iteritems():
1104
 
            trans_id = self.tt.trans_id_file_id(child.file_id)
1105
 
            if not other_root_is_present:
1106
 
                # FIXME: Make final_kind returns None instead of raising
1107
 
                # NoSuchFile to avoid the ugly construct below -- vila 20100402
1108
 
                try:
1109
 
                    self.tt.final_kind(trans_id)
1110
 
                    # The item exist in the final tree and has a defined place
1111
 
                    # to go already.
1112
 
                    continue
1113
 
                except errors.NoSuchFile, e:
1114
 
                    pass
1115
 
            # Move the item into the root
1116
 
            self.tt.adjust_path(self.tt.final_name(trans_id),
1117
 
                                self.tt.root, trans_id)
1118
 
        if other_root_is_present:
1119
 
            self.tt.cancel_creation(other_root)
1120
 
            self.tt.cancel_versioning(other_root)
1121
 
 
1122
1068
    def write_modified(self, results):
 
1069
        if not self.working_tree.supports_merge_modified():
 
1070
            return
1123
1071
        modified_hashes = {}
1124
1072
        for path in results.modified_paths:
1125
 
            file_id = self.this_tree.path2id(self.this_tree.relpath(path))
 
1073
            wt_relpath = self.working_tree.relpath(path)
 
1074
            file_id = self.working_tree.path2id(wt_relpath)
1126
1075
            if file_id is None:
1127
1076
                continue
1128
 
            hash = self.this_tree.get_file_sha1(file_id)
 
1077
            hash = self.working_tree.get_file_sha1(wt_relpath, file_id)
1129
1078
            if hash is None:
1130
1079
                continue
1131
1080
            modified_hashes[file_id] = hash
1132
 
        self.this_tree.set_merge_modified(modified_hashes)
 
1081
        self.working_tree.set_merge_modified(modified_hashes)
1133
1082
 
1134
1083
    @staticmethod
1135
1084
    def parent(entry, file_id):
1146
1095
        return entry.name
1147
1096
 
1148
1097
    @staticmethod
1149
 
    def contents_sha1(tree, file_id):
 
1098
    def contents_sha1(tree, path, file_id=None):
1150
1099
        """Determine the sha1 of the file contents (used as a key method)."""
1151
 
        if file_id not in tree:
 
1100
        try:
 
1101
            return tree.get_file_sha1(path, file_id)
 
1102
        except errors.NoSuchFile:
1152
1103
            return None
1153
 
        return tree.get_file_sha1(file_id)
1154
1104
 
1155
1105
    @staticmethod
1156
 
    def executable(tree, file_id):
 
1106
    def executable(tree, path, file_id=None):
1157
1107
        """Determine the executability of a file-id (used as a key method)."""
1158
 
        if not tree.has_id(file_id):
 
1108
        try:
 
1109
            if tree.kind(path, file_id) != "file":
 
1110
                return False
 
1111
        except errors.NoSuchFile:
1159
1112
            return None
1160
 
        if tree.kind(file_id) != "file":
1161
 
            return False
1162
 
        return tree.is_executable(file_id)
 
1113
        return tree.is_executable(path, file_id)
1163
1114
 
1164
1115
    @staticmethod
1165
 
    def kind(tree, file_id):
 
1116
    def kind(tree, path, file_id=None):
1166
1117
        """Determine the kind of a file-id (used as a key method)."""
1167
 
        if not tree.has_id(file_id):
 
1118
        try:
 
1119
            return tree.kind(path, file_id)
 
1120
        except errors.NoSuchFile:
1168
1121
            return None
1169
 
        return tree.kind(file_id)
1170
1122
 
1171
1123
    @staticmethod
1172
1124
    def _three_way(base, other, this):
1209
1161
        base_val, lca_vals = bases
1210
1162
        # Remove 'base_val' from the lca_vals, because it is not interesting
1211
1163
        filtered_lca_vals = [lca_val for lca_val in lca_vals
1212
 
                                      if lca_val != base_val]
 
1164
                             if lca_val != base_val]
1213
1165
        if len(filtered_lca_vals) == 0:
1214
1166
            return Merge3Merger._three_way(base_val, other, this)
1215
1167
 
1234
1186
        # At this point, the lcas disagree, and the tip disagree
1235
1187
        return 'conflict'
1236
1188
 
1237
 
    @staticmethod
1238
 
    @deprecated_method(deprecated_in((2, 2, 0)))
1239
 
    def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
1240
 
        """Do a three-way test on a scalar.
1241
 
        Return "this", "other" or "conflict", depending whether a value wins.
1242
 
        """
1243
 
        key_base = key(base_tree, file_id)
1244
 
        key_other = key(other_tree, file_id)
1245
 
        #if base == other, either they all agree, or only THIS has changed.
1246
 
        if key_base == key_other:
1247
 
            return "this"
1248
 
        key_this = key(this_tree, file_id)
1249
 
        # "Ambiguous clean merge"
1250
 
        if key_this == key_other:
1251
 
            return "this"
1252
 
        elif key_this == key_base:
1253
 
            return "other"
1254
 
        else:
1255
 
            return "conflict"
1256
 
 
1257
 
    def merge_names(self, file_id):
1258
 
        def get_entry(tree):
1259
 
            if tree.has_id(file_id):
1260
 
                return tree.inventory[file_id]
1261
 
            else:
1262
 
                return None
1263
 
        this_entry = get_entry(self.this_tree)
1264
 
        other_entry = get_entry(self.other_tree)
1265
 
        base_entry = get_entry(self.base_tree)
1266
 
        entries = (base_entry, other_entry, this_entry)
1267
 
        names = []
1268
 
        parents = []
1269
 
        for entry in entries:
1270
 
            if entry is None:
1271
 
                names.append(None)
1272
 
                parents.append(None)
1273
 
            else:
1274
 
                names.append(entry.name)
1275
 
                parents.append(entry.parent_id)
1276
 
        return self._merge_names(file_id, parents, names,
1277
 
                                 resolver=self._three_way)
1278
 
 
1279
 
    def _merge_names(self, file_id, parents, names, resolver):
 
1189
    def _merge_names(self, file_id, paths, parents, names, resolver):
1280
1190
        """Perform a merge on file_id names and parents"""
1281
1191
        base_name, other_name, this_name = names
1282
1192
        base_parent, other_parent, this_parent = parents
 
1193
        unused_base_path, other_path, this_path = paths
1283
1194
 
1284
1195
        name_winner = resolver(*names)
1285
1196
 
1299
1210
            self._raw_conflicts.append(('path conflict', trans_id, file_id,
1300
1211
                                        this_parent, this_name,
1301
1212
                                        other_parent, other_name))
1302
 
        if other_name is None:
 
1213
        if other_path is None:
1303
1214
            # it doesn't matter whether the result was 'other' or
1304
 
            # 'conflict'-- if there's no 'other', we leave it alone.
 
1215
            # 'conflict'-- if it has no file id, we leave it alone.
1305
1216
            return
1306
1217
        parent_id = parents[self.winner_idx[parent_id_winner]]
1307
 
        if parent_id is not None:
 
1218
        name = names[self.winner_idx[name_winner]]
 
1219
        if parent_id is not None or name is not None:
1308
1220
            # if we get here, name_winner and parent_winner are set to safe
1309
1221
            # values.
1310
 
            self.tt.adjust_path(names[self.winner_idx[name_winner]],
1311
 
                                self.tt.trans_id_file_id(parent_id),
 
1222
            if parent_id is None and name is not None:
 
1223
                # if parent_id is None and name is non-None, current file is
 
1224
                # the tree root.
 
1225
                if names[self.winner_idx[parent_id_winner]] != '':
 
1226
                    raise AssertionError(
 
1227
                        'File looks like a root, but named %s' %
 
1228
                        names[self.winner_idx[parent_id_winner]])
 
1229
                parent_trans_id = transform.ROOT_PARENT
 
1230
            else:
 
1231
                parent_trans_id = self.tt.trans_id_file_id(parent_id)
 
1232
            self.tt.adjust_path(name, parent_trans_id,
1312
1233
                                self.tt.trans_id_file_id(file_id))
1313
1234
 
1314
 
    def _do_merge_contents(self, file_id):
 
1235
    def _do_merge_contents(self, paths, file_id):
1315
1236
        """Performs a merge on file_id contents."""
1316
 
        def contents_pair(tree):
1317
 
            if file_id not in tree:
1318
 
                return (None, None)
1319
 
            kind = tree.kind(file_id)
 
1237
        def contents_pair(tree, path):
 
1238
            if path is None:
 
1239
                return (None, None)
 
1240
            try:
 
1241
                kind = tree.kind(path, file_id)
 
1242
            except errors.NoSuchFile:
 
1243
                return (None, None)
1320
1244
            if kind == "file":
1321
 
                contents = tree.get_file_sha1(file_id)
 
1245
                contents = tree.get_file_sha1(path, file_id)
1322
1246
            elif kind == "symlink":
1323
 
                contents = tree.get_symlink_target(file_id)
 
1247
                contents = tree.get_symlink_target(path, file_id)
1324
1248
            else:
1325
1249
                contents = None
1326
1250
            return kind, contents
1327
1251
 
 
1252
        base_path, other_path, this_path = paths
1328
1253
        # See SPOT run.  run, SPOT, run.
1329
1254
        # So we're not QUITE repeating ourselves; we do tricky things with
1330
1255
        # file kind...
1331
 
        base_pair = contents_pair(self.base_tree)
1332
 
        other_pair = contents_pair(self.other_tree)
 
1256
        other_pair = contents_pair(self.other_tree, other_path)
 
1257
        this_pair = contents_pair(self.this_tree, this_path)
1333
1258
        if self._lca_trees:
1334
 
            this_pair = contents_pair(self.this_tree)
1335
 
            lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
 
1259
            (base_path, lca_paths) = base_path
 
1260
            base_pair = contents_pair(self.base_tree, base_path)
 
1261
            lca_pairs = [contents_pair(tree, path)
 
1262
                         for tree, path in zip(self._lca_trees, lca_paths)]
1336
1263
            winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1337
1264
                                         this_pair, allow_overriding_lca=False)
1338
1265
        else:
 
1266
            base_pair = contents_pair(self.base_tree, base_path)
1339
1267
            if base_pair == other_pair:
1340
1268
                winner = 'this'
1341
1269
            else:
1342
1270
                # We delayed evaluating this_pair as long as we can to avoid
1343
1271
                # unnecessary sha1 calculation
1344
 
                this_pair = contents_pair(self.this_tree)
 
1272
                this_pair = contents_pair(self.this_tree, this_path)
1345
1273
                winner = self._three_way(base_pair, other_pair, this_pair)
1346
1274
        if winner == 'this':
1347
1275
            # No interesting changes introduced by OTHER
1349
1277
        # We have a hypothetical conflict, but if we have files, then we
1350
1278
        # can try to merge the content
1351
1279
        trans_id = self.tt.trans_id_file_id(file_id)
1352
 
        params = MergeHookParams(self, file_id, trans_id, this_pair[0],
 
1280
        params = MergeFileHookParams(
 
1281
            self, file_id, (base_path, other_path,
 
1282
                            this_path), trans_id, this_pair[0],
1353
1283
            other_pair[0], winner)
1354
1284
        hooks = self.active_hooks
1355
1285
        hook_status = 'not_applicable'
1358
1288
            if hook_status != 'not_applicable':
1359
1289
                # Don't try any more hooks, this one applies.
1360
1290
                break
 
1291
        # If the merge ends up replacing the content of the file, we get rid of
 
1292
        # it at the end of this method (this variable is used to track the
 
1293
        # exceptions to this rule).
 
1294
        keep_this = False
1361
1295
        result = "modified"
1362
1296
        if hook_status == 'not_applicable':
1363
 
            # This is a contents conflict, because none of the available
1364
 
            # functions could merge it.
 
1297
            # No merge hook was able to resolve the situation. Two cases exist:
 
1298
            # a content conflict or a duplicate one.
1365
1299
            result = None
1366
1300
            name = self.tt.final_name(trans_id)
1367
1301
            parent_id = self.tt.final_parent(trans_id)
1368
 
            if self.this_tree.has_id(file_id):
1369
 
                self.tt.unversion_file(trans_id)
1370
 
            file_group = self._dump_conflicts(name, parent_id, file_id,
1371
 
                                              set_version=True)
1372
 
            self._raw_conflicts.append(('contents conflict', file_group))
 
1302
            inhibit_content_conflict = False
 
1303
            if params.this_kind is None:  # file_id is not in THIS
 
1304
                # Is the name used for a different file_id ?
 
1305
                if self.this_tree.is_versioned(other_path):
 
1306
                    # Two entries for the same path
 
1307
                    keep_this = True
 
1308
                    # versioning the merged file will trigger a duplicate
 
1309
                    # conflict
 
1310
                    self.tt.version_file(file_id, trans_id)
 
1311
                    transform.create_from_tree(
 
1312
                        self.tt, trans_id, self.other_tree,
 
1313
                        other_path, file_id=file_id,
 
1314
                        filter_tree_path=self._get_filter_tree_path(file_id))
 
1315
                    inhibit_content_conflict = True
 
1316
            elif params.other_kind is None:  # file_id is not in OTHER
 
1317
                # Is the name used for a different file_id ?
 
1318
                if self.other_tree.is_versioned(this_path):
 
1319
                    # Two entries for the same path again, but here, the other
 
1320
                    # entry will also be merged.  We simply inhibit the
 
1321
                    # 'content' conflict creation because we know OTHER will
 
1322
                    # create (or has already created depending on ordering) an
 
1323
                    # entry at the same path. This will trigger a 'duplicate'
 
1324
                    # conflict later.
 
1325
                    keep_this = True
 
1326
                    inhibit_content_conflict = True
 
1327
            if not inhibit_content_conflict:
 
1328
                if params.this_kind is not None:
 
1329
                    self.tt.unversion_file(trans_id)
 
1330
                # This is a contents conflict, because none of the available
 
1331
                # functions could merge it.
 
1332
                file_group = self._dump_conflicts(
 
1333
                    name, (base_path, other_path, this_path), parent_id,
 
1334
                    file_id, set_version=True)
 
1335
                self._raw_conflicts.append(('contents conflict', file_group))
1373
1336
        elif hook_status == 'success':
1374
1337
            self.tt.create_file(lines, trans_id)
1375
1338
        elif hook_status == 'conflicted':
1379
1342
            self._raw_conflicts.append(('text conflict', trans_id))
1380
1343
            name = self.tt.final_name(trans_id)
1381
1344
            parent_id = self.tt.final_parent(trans_id)
1382
 
            self._dump_conflicts(name, parent_id, file_id)
 
1345
            self._dump_conflicts(
 
1346
                name, (base_path, other_path, this_path), parent_id, file_id)
1383
1347
        elif hook_status == 'delete':
1384
1348
            self.tt.unversion_file(trans_id)
1385
1349
            result = "deleted"
1389
1353
            pass
1390
1354
        else:
1391
1355
            raise AssertionError('unknown hook_status: %r' % (hook_status,))
1392
 
        if not self.this_tree.has_id(file_id) and result == "modified":
 
1356
        if not this_path and result == "modified":
1393
1357
            self.tt.version_file(file_id, trans_id)
1394
 
        # The merge has been performed, so the old contents should not be
1395
 
        # retained.
1396
 
        try:
 
1358
        if not keep_this:
 
1359
            # The merge has been performed and produced a new content, so the
 
1360
            # old contents should not be retained.
1397
1361
            self.tt.delete_contents(trans_id)
1398
 
        except errors.NoSuchFile:
1399
 
            pass
1400
1362
        return result
1401
1363
 
1402
1364
    def _default_other_winner_merge(self, merge_hook_params):
1403
1365
        """Replace this contents with other."""
1404
1366
        file_id = merge_hook_params.file_id
1405
1367
        trans_id = merge_hook_params.trans_id
1406
 
        file_in_this = self.this_tree.has_id(file_id)
1407
 
        if self.other_tree.has_id(file_id):
 
1368
        if merge_hook_params.other_path is not None:
1408
1369
            # OTHER changed the file
1409
 
            wt = self.this_tree
1410
 
            if wt.supports_content_filtering():
1411
 
                # We get the path from the working tree if it exists.
1412
 
                # That fails though when OTHER is adding a file, so
1413
 
                # we fall back to the other tree to find the path if
1414
 
                # it doesn't exist locally.
1415
 
                try:
1416
 
                    filter_tree_path = wt.id2path(file_id)
1417
 
                except errors.NoSuchId:
1418
 
                    filter_tree_path = self.other_tree.id2path(file_id)
1419
 
            else:
1420
 
                # Skip the id2path lookup for older formats
1421
 
                filter_tree_path = None
1422
 
            transform.create_from_tree(self.tt, trans_id,
1423
 
                             self.other_tree, file_id,
1424
 
                             filter_tree_path=filter_tree_path)
 
1370
            transform.create_from_tree(
 
1371
                self.tt, trans_id, self.other_tree,
 
1372
                merge_hook_params.other_path, file_id=file_id,
 
1373
                filter_tree_path=self._get_filter_tree_path(file_id))
1425
1374
            return 'done', None
1426
 
        elif file_in_this:
 
1375
        elif merge_hook_params.this_path is not None:
1427
1376
            # OTHER deleted the file
1428
1377
            return 'delete', None
1429
1378
        else:
1434
1383
    def merge_contents(self, merge_hook_params):
1435
1384
        """Fallback merge logic after user installed hooks."""
1436
1385
        # This function is used in merge hooks as the fallback instance.
1437
 
        # Perhaps making this function and the functions it calls be a 
 
1386
        # Perhaps making this function and the functions it calls be a
1438
1387
        # a separate class would be better.
1439
1388
        if merge_hook_params.winner == 'other':
1440
1389
            # OTHER is a straight winner, so replace this contents with other
1444
1393
            # BASE is a file, or both converted to files, so at least we
1445
1394
            # have agreement that output should be a file.
1446
1395
            try:
1447
 
                self.text_merge(merge_hook_params.file_id,
1448
 
                    merge_hook_params.trans_id)
 
1396
                self.text_merge(merge_hook_params.trans_id,
 
1397
                                merge_hook_params.paths, merge_hook_params.file_id)
1449
1398
            except errors.BinaryFile:
1450
1399
                return 'not_applicable', None
1451
1400
            return 'done', None
1452
1401
        else:
1453
1402
            return 'not_applicable', None
1454
1403
 
1455
 
    def get_lines(self, tree, file_id):
 
1404
    def get_lines(self, tree, path, file_id=None):
1456
1405
        """Return the lines in a file, or an empty list."""
1457
 
        if tree.has_id(file_id):
1458
 
            return tree.get_file(file_id).readlines()
 
1406
        if path is None:
 
1407
            return []
 
1408
        try:
 
1409
            kind = tree.kind(path, file_id)
 
1410
        except errors.NoSuchFile:
 
1411
            return []
1459
1412
        else:
1460
 
            return []
 
1413
            if kind != 'file':
 
1414
                return []
 
1415
            return tree.get_file_lines(path, file_id)
1461
1416
 
1462
 
    def text_merge(self, file_id, trans_id):
 
1417
    def text_merge(self, trans_id, paths, file_id):
1463
1418
        """Perform a three-way text merge on a file_id"""
1464
1419
        # it's possible that we got here with base as a different type.
1465
1420
        # if so, we just want two-way text conflicts.
1466
 
        if self.base_tree.has_id(file_id) and \
1467
 
            self.base_tree.kind(file_id) == "file":
1468
 
            base_lines = self.get_lines(self.base_tree, file_id)
1469
 
        else:
1470
 
            base_lines = []
1471
 
        other_lines = self.get_lines(self.other_tree, file_id)
1472
 
        this_lines = self.get_lines(self.this_tree, file_id)
 
1421
        base_path, other_path, this_path = paths
 
1422
        base_lines = self.get_lines(self.base_tree, base_path, file_id)
 
1423
        other_lines = self.get_lines(self.other_tree, other_path, file_id)
 
1424
        this_lines = self.get_lines(self.this_tree, this_path, file_id)
1473
1425
        m3 = merge3.Merge3(base_lines, this_lines, other_lines,
1474
1426
                           is_cherrypick=self.cherrypick)
1475
 
        start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
 
1427
        start_marker = b"!START OF MERGE CONFLICT!" + b"I HOPE THIS IS UNIQUE"
1476
1428
        if self.show_base is True:
1477
 
            base_marker = '|' * 7
 
1429
            base_marker = b'|' * 7
1478
1430
        else:
1479
1431
            base_marker = None
1480
1432
 
1481
1433
        def iter_merge3(retval):
1482
1434
            retval["text_conflicts"] = False
1483
 
            for line in m3.merge_lines(name_a = "TREE",
1484
 
                                       name_b = "MERGE-SOURCE",
1485
 
                                       name_base = "BASE-REVISION",
 
1435
            for line in m3.merge_lines(name_a=b"TREE",
 
1436
                                       name_b=b"MERGE-SOURCE",
 
1437
                                       name_base=b"BASE-REVISION",
1486
1438
                                       start_marker=start_marker,
1487
1439
                                       base_marker=base_marker,
1488
1440
                                       reprocess=self.reprocess):
1489
1441
                if line.startswith(start_marker):
1490
1442
                    retval["text_conflicts"] = True
1491
 
                    yield line.replace(start_marker, '<' * 7)
 
1443
                    yield line.replace(start_marker, b'<' * 7)
1492
1444
                else:
1493
1445
                    yield line
1494
1446
        retval = {}
1498
1450
            self._raw_conflicts.append(('text conflict', trans_id))
1499
1451
            name = self.tt.final_name(trans_id)
1500
1452
            parent_id = self.tt.final_parent(trans_id)
1501
 
            file_group = self._dump_conflicts(name, parent_id, file_id,
 
1453
            file_group = self._dump_conflicts(name, paths, parent_id, file_id,
1502
1454
                                              this_lines, base_lines,
1503
1455
                                              other_lines)
1504
1456
            file_group.append(trans_id)
1505
1457
 
1506
 
    def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
 
1458
    def _get_filter_tree_path(self, file_id):
 
1459
        if self.this_tree.supports_content_filtering():
 
1460
            # We get the path from the working tree if it exists.
 
1461
            # That fails though when OTHER is adding a file, so
 
1462
            # we fall back to the other tree to find the path if
 
1463
            # it doesn't exist locally.
 
1464
            try:
 
1465
                return self.this_tree.id2path(file_id)
 
1466
            except errors.NoSuchId:
 
1467
                return self.other_tree.id2path(file_id)
 
1468
        # Skip the id2path lookup for older formats
 
1469
        return None
 
1470
 
 
1471
    def _dump_conflicts(self, name, paths, parent_id, file_id, this_lines=None,
1507
1472
                        base_lines=None, other_lines=None, set_version=False,
1508
1473
                        no_base=False):
1509
1474
        """Emit conflict files.
1511
1476
        determined automatically.  If set_version is true, the .OTHER, .THIS
1512
1477
        or .BASE (in that order) will be created as versioned files.
1513
1478
        """
1514
 
        data = [('OTHER', self.other_tree, other_lines),
1515
 
                ('THIS', self.this_tree, this_lines)]
 
1479
        base_path, other_path, this_path = paths
 
1480
        data = [('OTHER', self.other_tree, other_path, other_lines),
 
1481
                ('THIS', self.this_tree, this_path, this_lines)]
1516
1482
        if not no_base:
1517
 
            data.append(('BASE', self.base_tree, base_lines))
 
1483
            data.append(('BASE', self.base_tree, base_path, base_lines))
1518
1484
 
1519
1485
        # We need to use the actual path in the working tree of the file here,
1520
1486
        # ignoring the conflict suffixes
1531
1497
 
1532
1498
        versioned = False
1533
1499
        file_group = []
1534
 
        for suffix, tree, lines in data:
1535
 
            if tree.has_id(file_id):
1536
 
                trans_id = self._conflict_file(name, parent_id, tree, file_id,
1537
 
                                               suffix, lines, filter_tree_path)
 
1500
        for suffix, tree, path, lines in data:
 
1501
            if path is not None:
 
1502
                trans_id = self._conflict_file(
 
1503
                    name, parent_id, path, tree, file_id, suffix, lines,
 
1504
                    filter_tree_path)
1538
1505
                file_group.append(trans_id)
1539
1506
                if set_version and not versioned:
1540
1507
                    self.tt.version_file(file_id, trans_id)
1541
1508
                    versioned = True
1542
1509
        return file_group
1543
1510
 
1544
 
    def _conflict_file(self, name, parent_id, tree, file_id, suffix,
 
1511
    def _conflict_file(self, name, parent_id, path, tree, file_id, suffix,
1545
1512
                       lines=None, filter_tree_path=None):
1546
1513
        """Emit a single conflict file."""
1547
1514
        name = name + '.' + suffix
1548
1515
        trans_id = self.tt.create_path(name, parent_id)
1549
 
        transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
1550
 
            filter_tree_path)
 
1516
        transform.create_from_tree(
 
1517
            self.tt, trans_id, tree, path,
 
1518
            file_id=file_id, chunks=lines,
 
1519
            filter_tree_path=filter_tree_path)
1551
1520
        return trans_id
1552
1521
 
1553
 
    def merge_executable(self, file_id, file_status):
 
1522
    def merge_executable(self, paths, file_id, file_status):
1554
1523
        """Perform a merge on the execute bit."""
1555
 
        executable = [self.executable(t, file_id) for t in (self.base_tree,
1556
 
                      self.other_tree, self.this_tree)]
1557
 
        self._merge_executable(file_id, executable, file_status,
 
1524
        executable = [self.executable(t, p, file_id)
 
1525
                      for t, p in zip([self.base_tree, self.other_tree, self.this_tree], paths)]
 
1526
        self._merge_executable(paths, file_id, executable, file_status,
1558
1527
                               resolver=self._three_way)
1559
1528
 
1560
 
    def _merge_executable(self, file_id, executable, file_status,
 
1529
    def _merge_executable(self, paths, file_id, executable, file_status,
1561
1530
                          resolver):
1562
1531
        """Perform a merge on the execute bit."""
1563
1532
        base_executable, other_executable, this_executable = executable
 
1533
        base_path, other_path, this_path = paths
1564
1534
        if file_status == "deleted":
1565
1535
            return
1566
1536
        winner = resolver(*executable)
1567
1537
        if winner == "conflict":
1568
 
        # There must be a None in here, if we have a conflict, but we
1569
 
        # need executability since file status was not deleted.
1570
 
            if self.executable(self.other_tree, file_id) is None:
 
1538
            # There must be a None in here, if we have a conflict, but we
 
1539
            # need executability since file status was not deleted.
 
1540
            if other_path is None:
1571
1541
                winner = "this"
1572
1542
            else:
1573
1543
                winner = "other"
1574
1544
        if winner == 'this' and file_status != "modified":
1575
1545
            return
1576
1546
        trans_id = self.tt.trans_id_file_id(file_id)
1577
 
        try:
1578
 
            if self.tt.final_kind(trans_id) != "file":
1579
 
                return
1580
 
        except errors.NoSuchFile:
 
1547
        if self.tt.final_kind(trans_id) != "file":
1581
1548
            return
1582
1549
        if winner == "this":
1583
1550
            executability = this_executable
1584
1551
        else:
1585
 
            if self.other_tree.has_id(file_id):
 
1552
            if other_path is not None:
1586
1553
                executability = other_executable
1587
 
            elif self.this_tree.has_id(file_id):
 
1554
            elif this_path is not None:
1588
1555
                executability = this_executable
1589
 
            elif self.base_tree_has_id(file_id):
 
1556
            elif base_path is not None:
1590
1557
                executability = base_executable
1591
1558
        if executability is not None:
1592
1559
            trans_id = self.tt.trans_id_file_id(file_id)
1594
1561
 
1595
1562
    def cook_conflicts(self, fs_conflicts):
1596
1563
        """Convert all conflicts into a form that doesn't depend on trans_id"""
1597
 
        self.cooked_conflicts.extend(transform.cook_conflicts(
1598
 
                fs_conflicts, self.tt))
 
1564
        content_conflict_file_ids = set()
 
1565
        cooked_conflicts = transform.cook_conflicts(fs_conflicts, self.tt)
1599
1566
        fp = transform.FinalPaths(self.tt)
1600
1567
        for conflict in self._raw_conflicts:
1601
1568
            conflict_type = conflict[0]
1602
1569
            if conflict_type == 'path conflict':
1603
1570
                (trans_id, file_id,
1604
 
                this_parent, this_name,
1605
 
                other_parent, other_name) = conflict[1:]
 
1571
                 this_parent, this_name,
 
1572
                 other_parent, other_name) = conflict[1:]
1606
1573
                if this_parent is None or this_name is None:
1607
1574
                    this_path = '<deleted>'
1608
1575
                else:
1609
 
                    parent_path =  fp.get_path(
 
1576
                    parent_path = fp.get_path(
1610
1577
                        self.tt.trans_id_file_id(this_parent))
1611
1578
                    this_path = osutils.pathjoin(parent_path, this_name)
1612
1579
                if other_parent is None or other_name is None:
1613
1580
                    other_path = '<deleted>'
1614
1581
                else:
1615
 
                    parent_path =  fp.get_path(
1616
 
                        self.tt.trans_id_file_id(other_parent))
 
1582
                    if other_parent == self.other_tree.get_root_id():
 
1583
                        # The tree transform doesn't know about the other root,
 
1584
                        # so we special case here to avoid a NoFinalPath
 
1585
                        # exception
 
1586
                        parent_path = ''
 
1587
                    else:
 
1588
                        parent_path = fp.get_path(
 
1589
                            self.tt.trans_id_file_id(other_parent))
1617
1590
                    other_path = osutils.pathjoin(parent_path, other_name)
1618
1591
                c = _mod_conflicts.Conflict.factory(
1619
1592
                    'path conflict', path=this_path,
1623
1596
                for trans_id in conflict[1]:
1624
1597
                    file_id = self.tt.final_file_id(trans_id)
1625
1598
                    if file_id is not None:
 
1599
                        # Ok we found the relevant file-id
1626
1600
                        break
1627
1601
                path = fp.get_path(trans_id)
1628
1602
                for suffix in ('.BASE', '.THIS', '.OTHER'):
1629
1603
                    if path.endswith(suffix):
 
1604
                        # Here is the raw path
1630
1605
                        path = path[:-len(suffix)]
1631
1606
                        break
1632
1607
                c = _mod_conflicts.Conflict.factory(conflict_type,
1633
1608
                                                    path=path, file_id=file_id)
 
1609
                content_conflict_file_ids.add(file_id)
1634
1610
            elif conflict_type == 'text conflict':
1635
1611
                trans_id = conflict[1]
1636
1612
                path = fp.get_path(trans_id)
1639
1615
                                                    path=path, file_id=file_id)
1640
1616
            else:
1641
1617
                raise AssertionError('bad conflict type: %r' % (conflict,))
 
1618
            cooked_conflicts.append(c)
 
1619
 
 
1620
        self.cooked_conflicts = []
 
1621
        # We want to get rid of path conflicts when a corresponding contents
 
1622
        # conflict exists. This can occur when one branch deletes a file while
 
1623
        # the other renames *and* modifies it. In this case, the content
 
1624
        # conflict is enough.
 
1625
        for c in cooked_conflicts:
 
1626
            if (c.typestring == 'path conflict'
 
1627
                    and c.file_id in content_conflict_file_ids):
 
1628
                continue
1642
1629
            self.cooked_conflicts.append(c)
1643
1630
        self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1644
1631
 
1649
1636
    supports_show_base = False
1650
1637
    supports_reverse_cherrypick = False
1651
1638
    history_based = True
 
1639
    requires_file_merge_plan = True
1652
1640
 
1653
1641
    def _generate_merge_plan(self, file_id, base):
1654
1642
        return self.this_tree.plan_file_merge(file_id, self.other_tree,
1668
1656
            plan = list(plan)
1669
1657
            trans_id = self.tt.trans_id_file_id(file_id)
1670
1658
            name = self.tt.final_name(trans_id) + '.plan'
1671
 
            contents = ('%11s|%s' % l for l in plan)
 
1659
            contents = (b'%11s|%s' % l for l in plan)
1672
1660
            self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1673
 
        textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1674
 
                                                 '>>>>>>> MERGE-SOURCE\n')
 
1661
        textmerge = versionedfile.PlanWeaveMerge(plan, b'<<<<<<< TREE\n',
 
1662
                                                 b'>>>>>>> MERGE-SOURCE\n')
1675
1663
        lines, conflicts = textmerge.merge_lines(self.reprocess)
1676
1664
        if conflicts:
1677
1665
            base_lines = textmerge.base_from_plan()
1679
1667
            base_lines = None
1680
1668
        return lines, base_lines
1681
1669
 
1682
 
    def text_merge(self, file_id, trans_id):
 
1670
    def text_merge(self, trans_id, paths, file_id):
1683
1671
        """Perform a (weave) text merge for a given file and file-id.
1684
1672
        If conflicts are encountered, .THIS and .OTHER files will be emitted,
1685
1673
        and a conflict will be noted.
1686
1674
        """
 
1675
        base_path, other_path, this_path = paths
1687
1676
        lines, base_lines = self._merged_lines(file_id)
1688
1677
        lines = list(lines)
1689
1678
        # Note we're checking whether the OUTPUT is binary in this case,
1695
1684
            self._raw_conflicts.append(('text conflict', trans_id))
1696
1685
            name = self.tt.final_name(trans_id)
1697
1686
            parent_id = self.tt.final_parent(trans_id)
1698
 
            file_group = self._dump_conflicts(name, parent_id, file_id,
 
1687
            file_group = self._dump_conflicts(name, paths, parent_id, file_id,
1699
1688
                                              no_base=False,
1700
1689
                                              base_lines=base_lines)
1701
1690
            file_group.append(trans_id)
1703
1692
 
1704
1693
class LCAMerger(WeaveMerger):
1705
1694
 
 
1695
    requires_file_merge_plan = True
 
1696
 
1706
1697
    def _generate_merge_plan(self, file_id, base):
1707
1698
        return self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1708
1699
                                                  base=base)
1709
1700
 
 
1701
 
1710
1702
class Diff3Merger(Merge3Merger):
1711
1703
    """Three-way merger using external diff3 for text merging"""
1712
1704
 
1713
 
    def dump_file(self, temp_dir, name, tree, file_id):
 
1705
    requires_file_merge_plan = False
 
1706
 
 
1707
    def dump_file(self, temp_dir, name, tree, path, file_id=None):
1714
1708
        out_path = osutils.pathjoin(temp_dir, name)
1715
 
        out_file = open(out_path, "wb")
1716
 
        try:
1717
 
            in_file = tree.get_file(file_id)
 
1709
        with open(out_path, "wb") as out_file:
 
1710
            in_file = tree.get_file(path, file_id=None)
1718
1711
            for line in in_file:
1719
1712
                out_file.write(line)
1720
 
        finally:
1721
 
            out_file.close()
1722
1713
        return out_path
1723
1714
 
1724
 
    def text_merge(self, file_id, trans_id):
 
1715
    def text_merge(self, trans_id, paths, file_id):
1725
1716
        """Perform a diff3 merge using a specified file-id and trans-id.
1726
1717
        If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
1727
1718
        will be dumped, and a will be conflict noted.
1728
1719
        """
1729
 
        import bzrlib.patch
 
1720
        import breezy.patch
 
1721
        base_path, other_path, this_path = paths
1730
1722
        temp_dir = osutils.mkdtemp(prefix="bzr-")
1731
1723
        try:
1732
1724
            new_file = osutils.pathjoin(temp_dir, "new")
1733
 
            this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
1734
 
            base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
1735
 
            other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
1736
 
            status = bzrlib.patch.diff3(new_file, this, base, other)
 
1725
            this = self.dump_file(
 
1726
                temp_dir, "this", self.this_tree, this_path, file_id)
 
1727
            base = self.dump_file(
 
1728
                temp_dir, "base", self.base_tree, base_path, file_id)
 
1729
            other = self.dump_file(
 
1730
                temp_dir, "other", self.other_tree, other_path, file_id)
 
1731
            status = breezy.patch.diff3(new_file, this, base, other)
1737
1732
            if status not in (0, 1):
1738
1733
                raise errors.BzrError("Unhandled diff3 exit code")
1739
 
            f = open(new_file, 'rb')
1740
 
            try:
 
1734
            with open(new_file, 'rb') as f:
1741
1735
                self.tt.create_file(f, trans_id)
1742
 
            finally:
1743
 
                f.close()
1744
1736
            if status == 1:
1745
1737
                name = self.tt.final_name(trans_id)
1746
1738
                parent_id = self.tt.final_parent(trans_id)
1747
 
                self._dump_conflicts(name, parent_id, file_id)
 
1739
                self._dump_conflicts(name, paths, parent_id, file_id)
1748
1740
                self._raw_conflicts.append(('text conflict', trans_id))
1749
1741
        finally:
1750
1742
            osutils.rmtree(temp_dir)
1751
1743
 
1752
1744
 
 
1745
class PathNotInTree(errors.BzrError):
 
1746
 
 
1747
    _fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
 
1748
 
 
1749
    def __init__(self, path, tree):
 
1750
        errors.BzrError.__init__(self, path=path, tree=tree)
 
1751
 
 
1752
 
 
1753
class MergeIntoMerger(Merger):
 
1754
    """Merger that understands other_tree will be merged into a subdir.
 
1755
 
 
1756
    This also changes the Merger api so that it uses real Branch, revision_id,
 
1757
    and RevisonTree objects, rather than using revision specs.
 
1758
    """
 
1759
 
 
1760
    def __init__(self, this_tree, other_branch, other_tree, target_subdir,
 
1761
                 source_subpath, other_rev_id=None):
 
1762
        """Create a new MergeIntoMerger object.
 
1763
 
 
1764
        source_subpath in other_tree will be effectively copied to
 
1765
        target_subdir in this_tree.
 
1766
 
 
1767
        :param this_tree: The tree that we will be merging into.
 
1768
        :param other_branch: The Branch we will be merging from.
 
1769
        :param other_tree: The RevisionTree object we want to merge.
 
1770
        :param target_subdir: The relative path where we want to merge
 
1771
            other_tree into this_tree
 
1772
        :param source_subpath: The relative path specifying the subtree of
 
1773
            other_tree to merge into this_tree.
 
1774
        """
 
1775
        # It is assumed that we are merging a tree that is not in our current
 
1776
        # ancestry, which means we are using the "EmptyTree" as our basis.
 
1777
        null_ancestor_tree = this_tree.branch.repository.revision_tree(
 
1778
            _mod_revision.NULL_REVISION)
 
1779
        super(MergeIntoMerger, self).__init__(
 
1780
            this_branch=this_tree.branch,
 
1781
            this_tree=this_tree,
 
1782
            other_tree=other_tree,
 
1783
            base_tree=null_ancestor_tree,
 
1784
            )
 
1785
        self._target_subdir = target_subdir
 
1786
        self._source_subpath = source_subpath
 
1787
        self.other_branch = other_branch
 
1788
        if other_rev_id is None:
 
1789
            other_rev_id = other_tree.get_revision_id()
 
1790
        self.other_rev_id = self.other_basis = other_rev_id
 
1791
        self.base_is_ancestor = True
 
1792
        self.backup_files = True
 
1793
        self.merge_type = Merge3Merger
 
1794
        self.show_base = False
 
1795
        self.reprocess = False
 
1796
        self.interesting_files = None
 
1797
        self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
 
1798
                                                  target_subdir=self._target_subdir,
 
1799
                                                  source_subpath=self._source_subpath)
 
1800
        if self._source_subpath != '':
 
1801
            # If this isn't a partial merge make sure the revisions will be
 
1802
            # present.
 
1803
            self._maybe_fetch(self.other_branch, self.this_branch,
 
1804
                              self.other_basis)
 
1805
 
 
1806
    def set_pending(self):
 
1807
        if self._source_subpath != '':
 
1808
            return
 
1809
        Merger.set_pending(self)
 
1810
 
 
1811
 
 
1812
class _MergeTypeParameterizer(object):
 
1813
    """Wrap a merge-type class to provide extra parameters.
 
1814
 
 
1815
    This is hack used by MergeIntoMerger to pass some extra parameters to its
 
1816
    merge_type.  Merger.do_merge() sets up its own set of parameters to pass to
 
1817
    the 'merge_type' member.  It is difficult override do_merge without
 
1818
    re-writing the whole thing, so instead we create a wrapper which will pass
 
1819
    the extra parameters.
 
1820
    """
 
1821
 
 
1822
    def __init__(self, merge_type, **kwargs):
 
1823
        self._extra_kwargs = kwargs
 
1824
        self._merge_type = merge_type
 
1825
 
 
1826
    def __call__(self, *args, **kwargs):
 
1827
        kwargs.update(self._extra_kwargs)
 
1828
        return self._merge_type(*args, **kwargs)
 
1829
 
 
1830
    def __getattr__(self, name):
 
1831
        return getattr(self._merge_type, name)
 
1832
 
 
1833
 
 
1834
class MergeIntoMergeType(Merge3Merger):
 
1835
    """Merger that incorporates a tree (or part of a tree) into another."""
 
1836
 
 
1837
    def __init__(self, *args, **kwargs):
 
1838
        """Initialize the merger object.
 
1839
 
 
1840
        :param args: See Merge3Merger.__init__'s args.
 
1841
        :param kwargs: See Merge3Merger.__init__'s keyword args, except for
 
1842
            source_subpath and target_subdir.
 
1843
        :keyword source_subpath: The relative path specifying the subtree of
 
1844
            other_tree to merge into this_tree.
 
1845
        :keyword target_subdir: The relative path where we want to merge
 
1846
            other_tree into this_tree
 
1847
        """
 
1848
        # All of the interesting work happens during Merge3Merger.__init__(),
 
1849
        # so we have have to hack in to get our extra parameters set.
 
1850
        self._source_subpath = kwargs.pop('source_subpath')
 
1851
        self._target_subdir = kwargs.pop('target_subdir')
 
1852
        super(MergeIntoMergeType, self).__init__(*args, **kwargs)
 
1853
 
 
1854
    def _compute_transform(self):
 
1855
        with ui.ui_factory.nested_progress_bar() as child_pb:
 
1856
            entries = self._entries_to_incorporate()
 
1857
            entries = list(entries)
 
1858
            for num, (entry, parent_id, relpath) in enumerate(entries):
 
1859
                child_pb.update(gettext('Preparing file merge'),
 
1860
                                num, len(entries))
 
1861
                parent_trans_id = self.tt.trans_id_file_id(parent_id)
 
1862
                path = osutils.pathjoin(self._source_subpath, relpath)
 
1863
                trans_id = transform.new_by_entry(path, self.tt, entry,
 
1864
                                                  parent_trans_id, self.other_tree)
 
1865
        self._finish_computing_transform()
 
1866
 
 
1867
    def _entries_to_incorporate(self):
 
1868
        """Yields pairs of (inventory_entry, new_parent)."""
 
1869
        other_inv = self.other_tree.root_inventory
 
1870
        subdir_id = other_inv.path2id(self._source_subpath)
 
1871
        if subdir_id is None:
 
1872
            # XXX: The error would be clearer if it gave the URL of the source
 
1873
            # branch, but we don't have a reference to that here.
 
1874
            raise PathNotInTree(self._source_subpath, "Source tree")
 
1875
        subdir = other_inv.get_entry(subdir_id)
 
1876
        parent_in_target = osutils.dirname(self._target_subdir)
 
1877
        target_id = self.this_tree.path2id(parent_in_target)
 
1878
        if target_id is None:
 
1879
            raise PathNotInTree(self._target_subdir, "Target tree")
 
1880
        name_in_target = osutils.basename(self._target_subdir)
 
1881
        merge_into_root = subdir.copy()
 
1882
        merge_into_root.name = name_in_target
 
1883
        if self.this_tree.has_id(merge_into_root.file_id):
 
1884
            # Give the root a new file-id.
 
1885
            # This can happen fairly easily if the directory we are
 
1886
            # incorporating is the root, and both trees have 'TREE_ROOT' as
 
1887
            # their root_id.  Users will expect this to Just Work, so we
 
1888
            # change the file-id here.
 
1889
            # Non-root file-ids could potentially conflict too.  That's really
 
1890
            # an edge case, so we don't do anything special for those.  We let
 
1891
            # them cause conflicts.
 
1892
            merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
 
1893
        yield (merge_into_root, target_id, '')
 
1894
        if subdir.kind != 'directory':
 
1895
            # No children, so we are done.
 
1896
            return
 
1897
        for path, entry in other_inv.iter_entries_by_dir(subdir_id):
 
1898
            parent_id = entry.parent_id
 
1899
            if parent_id == subdir.file_id:
 
1900
                # The root's parent ID has changed, so make sure children of
 
1901
                # the root refer to the new ID.
 
1902
                parent_id = merge_into_root.file_id
 
1903
            yield (entry, parent_id, path)
 
1904
 
 
1905
 
1753
1906
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1754
1907
                backup_files=False,
1755
1908
                merge_type=Merge3Merger,
1756
 
                interesting_ids=None,
1757
1909
                show_base=False,
1758
1910
                reprocess=False,
1759
1911
                other_rev_id=None,
1760
1912
                interesting_files=None,
1761
1913
                this_tree=None,
1762
 
                pb=None,
1763
1914
                change_reporter=None):
1764
1915
    """Primary interface for merging.
1765
1916
 
1766
 
        typical use is probably
1767
 
        'merge_inner(branch, branch.get_revision_tree(other_revision),
1768
 
                     branch.get_revision_tree(base_revision))'
1769
 
        """
 
1917
    Typical use is probably::
 
1918
 
 
1919
        merge_inner(branch, branch.get_revision_tree(other_revision),
 
1920
                    branch.get_revision_tree(base_revision))
 
1921
    """
1770
1922
    if this_tree is None:
1771
 
        raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
1772
 
                              "parameter as of bzrlib version 0.8.")
 
1923
        raise errors.BzrError("breezy.merge.merge_inner requires a this_tree "
 
1924
                              "parameter")
1773
1925
    merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1774
 
                    pb=pb, change_reporter=change_reporter)
 
1926
                    change_reporter=change_reporter)
1775
1927
    merger.backup_files = backup_files
1776
1928
    merger.merge_type = merge_type
1777
 
    merger.interesting_ids = interesting_ids
1778
1929
    merger.ignore_zero = ignore_zero
1779
 
    if interesting_files:
1780
 
        if interesting_ids:
1781
 
            raise ValueError('Only supply interesting_ids'
1782
 
                             ' or interesting_files')
1783
 
        merger.interesting_files = interesting_files
 
1930
    merger.interesting_files = interesting_files
1784
1931
    merger.show_base = show_base
1785
1932
    merger.reprocess = reprocess
1786
1933
    merger.other_rev_id = other_rev_id
1792
1939
    merger.set_base_revision(get_revision_id(), this_branch)
1793
1940
    return merger.do_merge()
1794
1941
 
 
1942
 
 
1943
merge_type_registry = registry.Registry()
 
1944
merge_type_registry.register('diff3', Diff3Merger,
 
1945
                             "Merge using external diff3.")
 
1946
merge_type_registry.register('lca', LCAMerger,
 
1947
                             "LCA-newness merge.")
 
1948
merge_type_registry.register('merge3', Merge3Merger,
 
1949
                             "Native diff3-style merge.")
 
1950
merge_type_registry.register('weave', WeaveMerger,
 
1951
                             "Weave-based merge.")
 
1952
 
 
1953
 
1795
1954
def get_merge_type_registry():
1796
 
    """Merge type registry is in bzrlib.option to avoid circular imports.
 
1955
    """Merge type registry was previously in breezy.option
1797
1956
 
1798
 
    This method provides a sanctioned way to retrieve it.
 
1957
    This method provides a backwards compatible way to retrieve it.
1799
1958
    """
1800
 
    from bzrlib import option
1801
 
    return option._merge_type_registry
 
1959
    return merge_type_registry
1802
1960
 
1803
1961
 
1804
1962
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
1910
2068
                else:
1911
2069
                    yield 'killed-a', self.lines_b[b_index]
1912
2070
            # handle common lines
1913
 
            for a_index in range(i, i+n):
 
2071
            for a_index in range(i, i + n):
1914
2072
                yield 'unchanged', self.lines_a[a_index]
1915
 
            last_i = i+n
1916
 
            last_j = j+n
 
2073
            last_i = i + n
 
2074
            last_j = j + n
1917
2075
 
1918
2076
    def _get_matching_blocks(self, left_revision, right_revision):
1919
2077
        """Return a description of which sections of two revisions match.
1975
2133
        for i, j, n in matcher.get_matching_blocks():
1976
2134
            for jj in range(last_j, j):
1977
2135
                yield new_plan[jj]
1978
 
            for jj in range(j, j+n):
 
2136
            for jj in range(j, j + n):
1979
2137
                plan_line = new_plan[jj]
1980
2138
                if plan_line[0] == 'new-b':
1981
2139
                    pass
2025
2183
        while True:
2026
2184
            next_lcas = self.graph.find_lca(*cur_ancestors)
2027
2185
            # Map a plain NULL_REVISION to a simple no-ancestors
2028
 
            if next_lcas == set([_mod_revision.NULL_REVISION]):
 
2186
            if next_lcas == {_mod_revision.NULL_REVISION}:
2029
2187
                next_lcas = ()
2030
2188
            # Order the lca's based on when they were merged into the tip
2031
2189
            # While the actual merge portion of weave merge uses a set() of
2119
2277
        filtered_parent_map = {}
2120
2278
        child_map = {}
2121
2279
        tails = []
2122
 
        for key, parent_keys in parent_map.iteritems():
 
2280
        for key, parent_keys in viewitems(parent_map):
2123
2281
            culled_parent_keys = [p for p in parent_keys if p in parent_map]
2124
2282
            if not culled_parent_keys:
2125
2283
                tails.append(key)
2175
2333
        return all_texts
2176
2334
 
2177
2335
    def _build_weave(self):
2178
 
        from bzrlib import weave
 
2336
        from .bzr import weave
2179
2337
        self._weave = weave.Weave(weave_name='in_memory_weave',
2180
2338
                                  allow_reserved=True)
2181
2339
        parent_map = self._find_recursive_lcas()
2212
2370
        are combined, they are written out in the format described in
2213
2371
        VersionedFile.plan_merge
2214
2372
        """
2215
 
        if self._head_key is not None: # There was a single head
 
2373
        if self._head_key is not None:  # There was a single head
2216
2374
            if self._head_key == self.a_key:
2217
2375
                plan = 'new-a'
2218
2376
            else:
2229
2387
class _PlanLCAMerge(_PlanMergeBase):
2230
2388
    """
2231
2389
    This merge algorithm differs from _PlanMerge in that:
 
2390
 
2232
2391
    1. comparisons are done against LCAs only
2233
2392
    2. cases where a contested line is new versus one LCA but old versus
2234
2393
       another are marked as conflicts, by emitting the line as conflicted-a
2275
2434
 
2276
2435
        If a line is killed and new, this indicates that the two merge
2277
2436
        revisions contain differing conflict resolutions.
 
2437
 
2278
2438
        :param revision_id: The id of the revision in which the lines are
2279
2439
            unique
2280
2440
        :param unique_line_numbers: The line numbers of unique lines.
2281
 
        :return a tuple of (new_this, killed_other):
 
2441
        :return: a tuple of (new_this, killed_other)
2282
2442
        """
2283
2443
        new = set()
2284
2444
        killed = set()