/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: 2020-08-09 18:10:01 UTC
  • mto: (7490.133.15 transform)
  • mto: This revision was merged to the branch mainline in revision 7521.
  • Revision ID: jelmer@jelmer.uk-20200809181001-bt9wdmmquzij3e5l
Split out bzr-specific Conflicts code.

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
18
 
 
19
 
from bzrlib import (
 
17
from __future__ import absolute_import
 
18
 
 
19
from .lazy_import import lazy_import
 
20
lazy_import(globals(), """
 
21
import patiencediff
 
22
 
 
23
from breezy import (
20
24
    branch as _mod_branch,
 
25
    cleanup,
21
26
    conflicts as _mod_conflicts,
22
27
    debug,
23
 
    decorators,
24
 
    errors,
25
28
    graph as _mod_graph,
26
 
    hooks,
27
29
    merge3,
28
30
    osutils,
29
 
    patiencediff,
30
31
    revision as _mod_revision,
31
32
    textfile,
32
33
    trace,
33
 
    transform,
34
34
    tree as _mod_tree,
35
35
    tsort,
36
36
    ui,
37
 
    versionedfile
38
 
    )
39
 
from bzrlib.cleanup import OperationWithCleanups
40
 
from bzrlib.symbol_versioning import (
41
 
    deprecated_in,
42
 
    deprecated_method,
 
37
    workingtree,
 
38
    )
 
39
from breezy.bzr import (
 
40
    conflicts as _mod_bzr_conflicts,
 
41
    generate_ids,
 
42
    versionedfile,
 
43
    )
 
44
from breezy.i18n import gettext
 
45
""")
 
46
from . import (
 
47
    decorators,
 
48
    errors,
 
49
    hooks,
 
50
    registry,
 
51
    transform,
 
52
    )
 
53
from .sixish import (
 
54
    viewitems,
43
55
    )
44
56
# TODO: Report back as changes are merged in
45
57
 
46
58
 
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)
 
59
def transform_tree(from_tree, to_tree, interesting_files=None):
 
60
    with from_tree.lock_tree_write():
 
61
        merge_inner(from_tree.branch, to_tree, from_tree,
 
62
                    ignore_zero=True, this_tree=from_tree,
 
63
                    interesting_files=interesting_files)
53
64
 
54
65
 
55
66
class MergeHooks(hooks.Hooks):
56
67
 
57
68
    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))
 
69
        hooks.Hooks.__init__(self, "breezy.merge", "Merger.hooks")
 
70
        self.add_hook('merge_file_content',
 
71
                      "Called with a breezy.merge.Merger object to create a per file "
 
72
                      "merge object when starting a merge. "
 
73
                      "Should return either None or a subclass of "
 
74
                      "``breezy.merge.AbstractPerFileMerger``. "
 
75
                      "Such objects will then be called per file "
 
76
                      "that needs to be merged (including when one "
 
77
                      "side has deleted the file and the other has changed it). "
 
78
                      "See the AbstractPerFileMerger API docs for details on how it is "
 
79
                      "used by merge.",
 
80
                      (2, 1))
 
81
        self.add_hook('pre_merge',
 
82
                      'Called before a merge. '
 
83
                      'Receives a Merger object as the single argument.',
 
84
                      (2, 5))
 
85
        self.add_hook('post_merge',
 
86
                      'Called after a merge. '
 
87
                      'Receives a Merger object as the single argument. '
 
88
                      'The return value is ignored.',
 
89
                      (2, 5))
70
90
 
71
91
 
72
92
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
 
    
 
93
    """PerFileMerger objects are used by plugins extending merge for breezy.
 
94
 
 
95
    See ``breezy.plugins.news_merge.news_merge`` for an example concrete class.
 
96
 
77
97
    :ivar merger: The Merge3Merger performing the merge.
78
98
    """
79
99
 
83
103
 
84
104
    def merge_contents(self, merge_params):
85
105
        """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
 
106
 
 
107
        :param merge_params: A breezy.merge.MergeFileHookParams
 
108
        :return: A tuple of (status, chunks), where status is one of
89
109
            'not_applicable', 'success', 'conflicted', or 'delete'.  If status
90
110
            is 'success' or 'conflicted', then chunks should be an iterable of
91
111
            strings for the new file contents.
109
129
        """
110
130
        raise NotImplementedError(self.file_matches)
111
131
 
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
132
    def merge_contents(self, params):
127
133
        """Merge the contents of a single file."""
128
134
        # Check whether this custom merge logic should be used.
131
137
            params.winner == 'other' or
132
138
            # THIS and OTHER aren't both files.
133
139
            not params.is_file_merge() or
134
 
            # The filename doesn't match *.xml
135
 
            not self.file_matches(params)):
 
140
            # The filename doesn't match
 
141
                not self.file_matches(params)):
136
142
            return 'not_applicable', None
137
143
        return self.merge_matching(params)
138
144
 
152
158
    This is a base class for concrete custom file merging logic. Concrete
153
159
    classes should implement ``merge_text``.
154
160
 
155
 
    See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
156
 
    
 
161
    See ``breezy.plugins.news_merge.news_merge`` for an example concrete class.
 
162
 
157
163
    :ivar affected_files: The configured file paths to merge.
158
164
 
159
165
    :cvar name_prefix: The prefix to use when looking up configuration
160
166
        details. <name_prefix>_merge_files describes the files targeted by the
161
167
        hook for example.
162
 
        
 
168
 
163
169
    :cvar default_files: The default file paths to merge when no configuration
164
170
        is present.
165
171
    """
186
192
            config = self.merger.this_branch.get_config()
187
193
            # Until bzr provides a better policy for caching the config, we
188
194
            # just add the part we're interested in to the params to avoid
189
 
            # reading the config files repeatedly (bazaar.conf, location.conf,
 
195
            # reading the config files repeatedly (breezy.conf, location.conf,
190
196
            # branch.conf).
191
197
            config_key = self.name_prefix + '_merge_files'
192
198
            affected_files = config.get_user_option_as_list(config_key)
195
201
                affected_files = self.default_files
196
202
            self.affected_files = affected_files
197
203
        if affected_files:
198
 
            filepath = self.get_filepath(params, self.merger.this_tree)
 
204
            filepath = params.this_path
199
205
            if filepath in affected_files:
200
206
                return True
201
207
        return False
208
214
 
209
215
        This is called after checking that the merge should be performed in
210
216
        merge_contents, and it should behave as per
211
 
        ``bzrlib.merge.AbstractPerFileMerger.merge_contents``.
 
217
        ``breezy.merge.AbstractPerFileMerger.merge_contents``.
212
218
        """
213
219
        raise NotImplementedError(self.merge_text)
214
220
 
215
221
 
216
 
class MergeHookParams(object):
 
222
class MergeFileHookParams(object):
217
223
    """Object holding parameters passed to merge_file_content hooks.
218
224
 
219
225
    There are some fields hooks can access:
220
226
 
221
 
    :ivar file_id: the file ID of the file being merged
 
227
    :ivar base_path: Path in base tree
 
228
    :ivar other_path: Path in other tree
 
229
    :ivar this_path: Path in this tree
222
230
    :ivar trans_id: the transform ID for the merge of this file
223
 
    :ivar this_kind: kind of file_id in 'this' tree
224
 
    :ivar other_kind: kind of file_id in 'other' tree
 
231
    :ivar this_kind: kind of file in 'this' tree
 
232
    :ivar other_kind: kind of file in 'other' tree
225
233
    :ivar winner: one of 'this', 'other', 'conflict'
226
234
    """
227
235
 
228
 
    def __init__(self, merger, file_id, trans_id, this_kind, other_kind,
229
 
            winner):
 
236
    def __init__(self, merger, paths, trans_id, this_kind, other_kind,
 
237
                 winner):
230
238
        self._merger = merger
231
 
        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)
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)
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)
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)
499
 
        for revision_id in new_parents:
500
 
            try:
501
 
                tree = self.revision_tree(revision_id)
502
 
            except errors.NoSuchRevision:
503
 
                tree = None
504
 
            else:
505
 
                tree.lock_read()
506
 
                operation.add_cleanup(tree.unlock)
507
 
            new_parent_trees.append((revision_id, tree))
508
 
        operation.run_simple(new_parent_trees, allow_leftmost_as_ghost=True)
 
451
        with cleanup.ExitStack() as stack:
 
452
            for revision_id in new_parents:
 
453
                try:
 
454
                    tree = self.revision_tree(revision_id)
 
455
                except errors.NoSuchRevision:
 
456
                    tree = None
 
457
                else:
 
458
                    stack.enter_context(tree.lock_read())
 
459
                new_parent_trees.append((revision_id, tree))
 
460
            self.this_tree.set_parent_trees(new_parent_trees, allow_leftmost_as_ghost=True)
509
461
 
510
462
    def set_other(self, other_revision, possible_transports=None):
511
463
        """Set the revision and tree to merge from.
532
484
                raise errors.NoCommits(self.other_branch)
533
485
        if self.other_rev_id is not None:
534
486
            self._cached_trees[self.other_rev_id] = self.other_tree
535
 
        self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
 
487
        self._maybe_fetch(self.other_branch,
 
488
                          self.this_branch, self.other_basis)
536
489
 
537
490
    def set_other_revision(self, revision_id, other_branch):
538
491
        """Set 'other' based on a branch and revision id
575
528
                self.base_rev_id = _mod_revision.NULL_REVISION
576
529
            elif len(lcas) == 1:
577
530
                self.base_rev_id = list(lcas)[0]
578
 
            else: # len(lcas) > 1
 
531
            else:  # len(lcas) > 1
 
532
                self._is_criss_cross = True
579
533
                if len(lcas) > 2:
580
534
                    # find_unique_lca can only handle 2 nodes, so we have to
581
535
                    # start back at the beginning. It is a shame to traverse
582
536
                    # the graph again, but better than re-implementing
583
537
                    # find_unique_lca.
584
538
                    self.base_rev_id = self.revision_graph.find_unique_lca(
585
 
                                            revisions[0], revisions[1])
 
539
                        revisions[0], revisions[1])
586
540
                else:
587
541
                    self.base_rev_id = self.revision_graph.find_unique_lca(
588
 
                                            *lcas)
589
 
                self._is_criss_cross = True
 
542
                        *lcas)
 
543
                sorted_lca_keys = self.revision_graph.find_merge_order(
 
544
                    revisions[0], lcas)
 
545
                if self.base_rev_id == _mod_revision.NULL_REVISION:
 
546
                    self.base_rev_id = sorted_lca_keys[0]
 
547
 
590
548
            if self.base_rev_id == _mod_revision.NULL_REVISION:
591
549
                raise errors.UnrelatedBranches()
592
550
            if self._is_criss_cross:
593
551
                trace.warning('Warning: criss-cross merge encountered.  See bzr'
594
552
                              ' help criss-cross.')
595
553
                trace.mutter('Criss-cross lcas: %r' % lcas)
596
 
                interesting_revision_ids = [self.base_rev_id]
597
 
                interesting_revision_ids.extend(lcas)
 
554
                if self.base_rev_id in lcas:
 
555
                    trace.mutter('Unable to find unique lca. '
 
556
                                 'Fallback %r as best option.'
 
557
                                 % self.base_rev_id)
 
558
                interesting_revision_ids = set(lcas)
 
559
                interesting_revision_ids.add(self.base_rev_id)
598
560
                interesting_trees = dict((t.get_revision_id(), t)
599
 
                    for t in self.this_branch.repository.revision_trees(
600
 
                        interesting_revision_ids))
 
561
                                         for t in self.this_branch.repository.revision_trees(
 
562
                    interesting_revision_ids))
601
563
                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)
 
564
                if self.base_rev_id in lcas:
 
565
                    self.base_tree = interesting_trees[self.base_rev_id]
 
566
                else:
 
567
                    self.base_tree = interesting_trees.pop(self.base_rev_id)
605
568
                self._lca_trees = [interesting_trees[key]
606
569
                                   for key in sorted_lca_keys]
607
570
            else:
630
593
            self._maybe_fetch(base_branch, self.this_branch, self.base_rev_id)
631
594
 
632
595
    def make_merger(self):
633
 
        kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
 
596
        kwargs = {'working_tree': self.this_tree, 'this_tree': self.this_tree,
634
597
                  'other_tree': self.other_tree,
635
 
                  'interesting_ids': self.interesting_ids,
636
598
                  'interesting_files': self.interesting_files,
637
599
                  'this_branch': self.this_branch,
 
600
                  'other_branch': self.other_branch,
638
601
                  'do_merge': False}
639
602
        if self.merge_type.requires_base:
640
603
            kwargs['base_tree'] = self.base_tree
650
613
            raise errors.BzrError("Showing base is not supported for this"
651
614
                                  " merge type. %s" % self.merge_type)
652
615
        if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
653
 
            and not self.base_is_other_ancestor):
 
616
                and not self.base_is_other_ancestor):
654
617
            raise errors.CannotReverseCherrypick()
655
618
        if self.merge_type.supports_cherrypick:
656
619
            kwargs['cherrypick'] = (not self.base_is_ancestor or
658
621
        if self._is_criss_cross and getattr(self.merge_type,
659
622
                                            'supports_lca_trees', False):
660
623
            kwargs['lca_trees'] = self._lca_trees
661
 
        return self.merge_type(pb=None,
662
 
                               change_reporter=self.change_reporter,
 
624
        return self.merge_type(change_reporter=self.change_reporter,
663
625
                               **kwargs)
664
626
 
665
627
    def _do_merge_to(self):
666
628
        merge = self.make_merger()
667
629
        if self.other_branch is not None:
668
630
            self.other_branch.update_references(self.this_branch)
 
631
        for hook in Merger.hooks['pre_merge']:
 
632
            hook(merge)
669
633
        merge.do_merge()
 
634
        for hook in Merger.hooks['post_merge']:
 
635
            hook(merge)
670
636
        if self.recurse == 'down':
671
 
            for relpath, file_id in self.this_tree.iter_references():
672
 
                sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
 
637
            for relpath in self.this_tree.iter_references():
 
638
                sub_tree = self.this_tree.get_nested_tree(relpath)
673
639
                other_revision = self.other_tree.get_reference_revision(
674
 
                    file_id, relpath)
675
 
                if  other_revision == sub_tree.last_revision():
 
640
                    relpath)
 
641
                if other_revision == sub_tree.last_revision():
676
642
                    continue
677
643
                sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
678
644
                sub_merge.merge_type = self.merge_type
679
 
                other_branch = self.other_branch.reference_parent(file_id, relpath)
 
645
                other_branch = self.other_tree.reference_parent(relpath)
680
646
                sub_merge.set_other_revision(other_revision, other_branch)
681
 
                base_revision = self.base_tree.get_reference_revision(file_id)
 
647
                base_tree_path = _mod_tree.find_previous_path(
 
648
                    self.this_tree, self.base_tree, relpath)
 
649
                base_revision = self.base_tree.get_reference_revision(
 
650
                    base_tree_path)
682
651
                sub_merge.base_tree = \
683
652
                    sub_tree.branch.repository.revision_tree(base_revision)
684
653
                sub_merge.base_rev_id = base_revision
686
655
        return merge
687
656
 
688
657
    def do_merge(self):
689
 
        operation = OperationWithCleanups(self._do_merge_to)
690
 
        self.this_tree.lock_tree_write()
691
 
        operation.add_cleanup(self.this_tree.unlock)
692
 
        if self.base_tree is not None:
693
 
            self.base_tree.lock_read()
694
 
            operation.add_cleanup(self.base_tree.unlock)
695
 
        if self.other_tree is not None:
696
 
            self.other_tree.lock_read()
697
 
            operation.add_cleanup(self.other_tree.unlock)
698
 
        merge = operation.run_simple()
 
658
        with cleanup.ExitStack() as stack:
 
659
            stack.enter_context(self.this_tree.lock_tree_write())
 
660
            if self.base_tree is not None:
 
661
                stack.enter_context(self.base_tree.lock_read())
 
662
            if self.other_tree is not None:
 
663
                stack.enter_context(self.other_tree.lock_read())
 
664
            merge = self._do_merge_to()
699
665
        if len(merge.cooked_conflicts) == 0:
700
666
            if not self.ignore_zero and not trace.is_quiet():
701
 
                trace.note("All changes applied successfully.")
 
667
                trace.note(gettext("All changes applied successfully."))
702
668
        else:
703
 
            trace.note("%d conflicts encountered."
 
669
            trace.note(gettext("%d conflicts encountered.")
704
670
                       % len(merge.cooked_conflicts))
705
671
 
706
672
        return len(merge.cooked_conflicts)
720
686
    symlink_target = None
721
687
    text_sha1 = None
722
688
 
 
689
    def is_unmodified(self, other):
 
690
        return other is self
 
691
 
 
692
 
723
693
_none_entry = _InventoryNoneEntry()
724
694
 
725
695
 
733
703
    supports_reverse_cherrypick = True
734
704
    winner_idx = {"this": 2, "other": 1, "conflict": 1}
735
705
    supports_lca_trees = True
 
706
    requires_file_merge_plan = False
736
707
 
737
708
    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):
 
709
                 reprocess=False, show_base=False,
 
710
                 change_reporter=None, interesting_files=None, do_merge=True,
 
711
                 cherrypick=False, lca_trees=None, this_branch=None,
 
712
                 other_branch=None):
742
713
        """Initialize the merger object and perform the merge.
743
714
 
744
715
        :param working_tree: The working tree to apply the merge to
747
718
        :param other_tree: The other tree to merge changes from
748
719
        :param this_branch: The branch associated with this_tree.  Defaults to
749
720
            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.
 
721
        :param other_branch: The branch associated with other_tree, if any.
753
722
        :param: reprocess If True, perform conflict-reduction processing.
754
723
        :param show_base: If True, show the base revision in text conflicts.
755
724
            (incompatible with reprocess)
756
 
        :param pb: ignored
757
 
        :param pp: A ProgressPhase object
758
725
        :param change_reporter: An object that should report changes made
759
726
        :param interesting_files: The tree-relative paths of files that should
760
727
            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
 
728
            the contents of those directories will also be included.  If not
 
729
            specified, all files may participate in the
764
730
            merge.
765
731
        :param lca_trees: Can be set to a dictionary of {revision_id:rev_tree}
766
732
            if the ancestry was found to include a criss-cross merge.
767
733
            Otherwise should be None.
768
734
        """
769
735
        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
736
        if this_branch is None:
774
737
            this_branch = this_tree.branch
775
 
        self.interesting_ids = interesting_ids
776
738
        self.interesting_files = interesting_files
777
 
        self.this_tree = working_tree
 
739
        self.working_tree = working_tree
 
740
        self.this_tree = this_tree
778
741
        self.base_tree = base_tree
779
742
        self.other_tree = other_tree
780
743
        self.this_branch = this_branch
 
744
        self.other_branch = other_branch
781
745
        self._raw_conflicts = []
782
746
        self.cooked_conflicts = []
783
747
        self.reprocess = reprocess
792
756
        self.cherrypick = cherrypick
793
757
        if do_merge:
794
758
            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
759
 
800
760
    def do_merge(self):
801
 
        operation = OperationWithCleanups(self._do_merge)
802
 
        self.this_tree.lock_tree_write()
803
 
        operation.add_cleanup(self.this_tree.unlock)
804
 
        self.base_tree.lock_read()
805
 
        operation.add_cleanup(self.base_tree.unlock)
806
 
        self.other_tree.lock_read()
807
 
        operation.add_cleanup(self.other_tree.unlock)
808
 
        operation.run()
809
 
 
810
 
    def _do_merge(self, operation):
811
 
        self.tt = transform.TreeTransform(self.this_tree, None)
812
 
        operation.add_cleanup(self.tt.finalize)
813
 
        self._compute_transform()
814
 
        results = self.tt.apply(no_conflicts=True)
815
 
        self.write_modified(results)
816
 
        try:
817
 
            self.this_tree.add_conflicts(self.cooked_conflicts)
818
 
        except errors.UnsupportedOperation:
819
 
            pass
 
761
        with cleanup.ExitStack() as stack:
 
762
            stack.enter_context(self.working_tree.lock_tree_write())
 
763
            stack.enter_context(self.this_tree.lock_read())
 
764
            stack.enter_context(self.base_tree.lock_read())
 
765
            stack.enter_context(self.other_tree.lock_read())
 
766
            self.tt = self.working_tree.transform()
 
767
            stack.enter_context(self.tt)
 
768
            self._compute_transform()
 
769
            results = self.tt.apply(no_conflicts=True)
 
770
            self.write_modified(results)
 
771
            try:
 
772
                self.working_tree.add_conflicts(self.cooked_conflicts)
 
773
            except errors.UnsupportedOperation:
 
774
                pass
820
775
 
821
776
    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
 
777
        with self.base_tree.lock_read(), self.other_tree.lock_read():
 
778
            self.tt = self.working_tree.preview_transform()
 
779
            self._compute_transform()
 
780
            return self.tt
833
781
 
834
782
    def _compute_transform(self):
835
783
        if self._lca_trees is None:
836
 
            entries = self._entries3()
 
784
            entries = list(self._entries3())
837
785
            resolver = self._three_way
838
786
        else:
839
 
            entries = self._entries_lca()
 
787
            entries = list(self._entries_lca())
840
788
            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,
 
789
        # Prepare merge hooks
 
790
        factories = Merger.hooks['merge_file_content']
 
791
        # One hook for each registered one plus our default merger
 
792
        hooks = [factory(self) for factory in factories] + [self]
 
793
        self.active_hooks = [hook for hook in hooks if hook is not None]
 
794
        with ui.ui_factory.nested_progress_bar() as child_pb:
 
795
            for num, (file_id, changed, paths3, parents3, names3,
847
796
                      executable3) in enumerate(entries):
848
 
                child_pb.update('Preparing file merge', num, len(entries))
849
 
                self._merge_names(file_id, parents3, names3, resolver=resolver)
 
797
                trans_id = self.tt.trans_id_file_id(file_id)
 
798
                # Try merging each entry
 
799
                child_pb.update(gettext('Preparing file merge'),
 
800
                                num, len(entries))
 
801
                self._merge_names(trans_id, file_id, paths3, parents3,
 
802
                                  names3, resolver=resolver)
850
803
                if changed:
851
 
                    file_status = self._do_merge_contents(file_id)
 
804
                    file_status = self._do_merge_contents(paths3, trans_id, file_id)
852
805
                else:
853
806
                    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:
861
 
            fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
 
807
                self._merge_executable(paths3, trans_id, executable3,
 
808
                                       file_status, resolver=resolver)
 
809
        self.tt.fixup_new_roots()
 
810
        self._finish_computing_transform()
 
811
 
 
812
    def _finish_computing_transform(self):
 
813
        """Finalize the transform and report the changes.
 
814
 
 
815
        This is the second half of _compute_transform.
 
816
        """
 
817
        with ui.ui_factory.nested_progress_bar() as child_pb:
 
818
            fs_conflicts = transform.resolve_conflicts(
 
819
                self.tt, child_pb,
862
820
                lambda t, c: transform.conflict_pass(t, c, self.other_tree))
863
 
        finally:
864
 
            child_pb.finished()
865
821
        if self.change_reporter is not None:
866
 
            from bzrlib import delta
 
822
            from breezy import delta
867
823
            delta.report_changes(
868
824
                self.tt.iter_changes(), self.change_reporter)
869
825
        self.cook_conflicts(fs_conflicts)
870
826
        for conflict in self.cooked_conflicts:
871
 
            trace.warning(conflict)
 
827
            trace.warning('%s', conflict.describe())
872
828
 
873
829
    def _entries3(self):
874
830
        """Gather data about files modified between three trees.
879
835
        other and this.  names3 is a tuple of names for base, other and this.
880
836
        executable3 is a tuple of execute-bit values for base, other and this.
881
837
        """
882
 
        result = []
883
838
        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))
889
 
        for (file_id, paths, changed, versioned, parents, names, kind,
890
 
             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
 
839
                                                specific_files=self.interesting_files,
 
840
                                                extra_trees=[self.this_tree])
 
841
        this_interesting_files = self.this_tree.find_related_paths_across_trees(
 
842
            self.interesting_files, trees=[self.other_tree])
 
843
        this_entries = dict(self.this_tree.iter_entries_by_dir(
 
844
                            specific_files=this_interesting_files))
 
845
        for change in iterator:
 
846
            if change.path[0] is not None:
 
847
                this_path = _mod_tree.find_previous_path(
 
848
                    self.base_tree, self.this_tree, change.path[0])
 
849
            else:
 
850
                this_path = _mod_tree.find_previous_path(
 
851
                    self.other_tree, self.this_tree, change.path[1])
 
852
            this_entry = this_entries.get(this_path)
 
853
            if this_entry is not None:
 
854
                this_name = this_entry.name
 
855
                this_parent = this_entry.parent_id
 
856
                this_executable = this_entry.executable
899
857
            else:
900
858
                this_name = None
901
859
                this_parent = None
902
860
                this_executable = None
903
 
            parents3 = parents + (this_parent,)
904
 
            names3 = names + (this_name,)
905
 
            executable3 = executable + (this_executable,)
906
 
            result.append((file_id, changed, parents3, names3, executable3))
907
 
        return result
 
861
            parents3 = change.parent_id + (this_parent,)
 
862
            names3 = change.name + (this_name,)
 
863
            paths3 = change.path + (this_path, )
 
864
            executable3 = change.executable + (this_executable,)
 
865
            yield (
 
866
                (change.file_id, change.changed_content, paths3,
 
867
                 parents3, names3, executable3))
908
868
 
909
869
    def _entries_lca(self):
910
870
        """Gather data about files modified between multiple trees.
913
873
        it then compares with THIS and BASE.
914
874
 
915
875
        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)
 
876
 
 
877
        :return: [(file_id, changed, paths, parents, names, executable)], where:
 
878
 
 
879
            * file_id: Simple file_id of the entry
 
880
            * changed: Boolean, True if the kind or contents changed else False
 
881
            * paths: ((base, [path, in, lcas]), path_other, path_this)
 
882
            * parents: ((base, [parent_id, in, lcas]), parent_id_other,
 
883
                        parent_id_this)
 
884
            * names:   ((base, [name, in, lcas]), name_in_other, name_in_this)
 
885
            * executable: ((base, [exec, in, lcas]), exec_in_other,
 
886
                        exec_in_this)
924
887
        """
925
888
        if self.interesting_files is not None:
926
889
            lookup_trees = [self.this_tree, self.base_tree]
927
890
            lookup_trees.extend(self._lca_trees)
928
891
            # I think we should include the lca trees as well
929
 
            interesting_ids = self.other_tree.paths2ids(self.interesting_files,
930
 
                                                        lookup_trees)
 
892
            interesting_files = self.other_tree.find_related_paths_across_trees(
 
893
                self.interesting_files, lookup_trees)
931
894
        else:
932
 
            interesting_ids = self.interesting_ids
933
 
        result = []
934
 
        walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
 
895
            interesting_files = None
 
896
        from .multiwalker import MultiWalker
 
897
        walker = MultiWalker(self.other_tree, self._lca_trees)
935
898
 
936
 
        base_inventory = self.base_tree.inventory
937
 
        this_inventory = self.this_tree.inventory
938
 
        for path, file_id, other_ie, lca_values in walker.iter_all():
 
899
        for other_path, file_id, other_ie, lca_values in walker.iter_all():
939
900
            # Is this modified at all from any of the other trees?
940
901
            if other_ie is None:
941
902
                other_ie = _none_entry
942
 
            if interesting_ids is not None and file_id not in interesting_ids:
 
903
                other_path = None
 
904
            if interesting_files is not None and other_path not in interesting_files:
943
905
                continue
944
906
 
945
907
            # If other_revision is found in any of the lcas, that means this
948
910
            # we know that the ancestry is linear, and that OTHER did not
949
911
            # modify anything
950
912
            # See doc/developers/lca_merge_resolution.txt for details
951
 
            other_revision = other_ie.revision
952
 
            if other_revision is not None:
953
 
                # We can't use this shortcut when other_revision is None,
954
 
                # because it may be None because things are WorkingTrees, and
955
 
                # not because it is *actually* None.
956
 
                is_unmodified = False
957
 
                for lca_path, ie in lca_values:
958
 
                    if ie is not None and ie.revision == other_revision:
959
 
                        is_unmodified = True
960
 
                        break
961
 
                if is_unmodified:
962
 
                    continue
 
913
            # We can't use this shortcut when other_revision is None,
 
914
            # because it may be None because things are WorkingTrees, and
 
915
            # not because it is *actually* None.
 
916
            is_unmodified = False
 
917
            for lca_path, ie in lca_values:
 
918
                if ie is not None and other_ie.is_unmodified(ie):
 
919
                    is_unmodified = True
 
920
                    break
 
921
            if is_unmodified:
 
922
                continue
963
923
 
964
924
            lca_entries = []
 
925
            lca_paths = []
965
926
            for lca_path, lca_ie in lca_values:
966
927
                if lca_ie is None:
967
928
                    lca_entries.append(_none_entry)
 
929
                    lca_paths.append(None)
968
930
                else:
969
931
                    lca_entries.append(lca_ie)
 
932
                    lca_paths.append(lca_path)
970
933
 
971
 
            if file_id in base_inventory:
972
 
                base_ie = base_inventory[file_id]
973
 
            else:
 
934
            try:
 
935
                base_path = self.base_tree.id2path(file_id)
 
936
            except errors.NoSuchId:
 
937
                base_path = None
974
938
                base_ie = _none_entry
 
939
            else:
 
940
                base_ie = next(self.base_tree.iter_entries_by_dir(specific_files=[base_path]))[1]
975
941
 
976
 
            if file_id in this_inventory:
977
 
                this_ie = this_inventory[file_id]
978
 
            else:
 
942
            try:
 
943
                this_path = self.this_tree.id2path(file_id)
 
944
            except errors.NoSuchId:
979
945
                this_ie = _none_entry
 
946
                this_path = None
 
947
            else:
 
948
                this_ie = next(self.this_tree.iter_entries_by_dir(specific_files=[this_path]))[1]
980
949
 
981
950
            lca_kinds = []
982
951
            lca_parent_ids = []
1007
976
                        continue
1008
977
                    content_changed = False
1009
978
                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)
 
979
                    def get_sha1(tree, path):
 
980
                        if path is None:
 
981
                            return None
 
982
                        try:
 
983
                            return tree.get_file_sha1(path)
 
984
                        except errors.NoSuchFile:
 
985
                            return None
 
986
                    base_sha1 = get_sha1(self.base_tree, base_path)
 
987
                    lca_sha1s = [get_sha1(tree, lca_path)
 
988
                                 for tree, lca_path
 
989
                                 in zip(self._lca_trees, lca_paths)]
 
990
                    this_sha1 = get_sha1(self.this_tree, this_path)
 
991
                    other_sha1 = get_sha1(self.other_tree, other_path)
1019
992
                    sha1_winner = self._lca_multi_way(
1020
993
                        (base_sha1, lca_sha1s), other_sha1, this_sha1,
1021
994
                        allow_overriding_lca=False)
1023
996
                        (base_ie.executable, lca_executable),
1024
997
                        other_ie.executable, this_ie.executable)
1025
998
                    if (parent_id_winner == 'this' and name_winner == 'this'
1026
 
                        and sha1_winner == 'this' and exec_winner == 'this'):
 
999
                            and sha1_winner == 'this' and exec_winner == 'this'):
1027
1000
                        # No kind, parent, name, exec, or content change for
1028
1001
                        # OTHER, so this node is not considered interesting
1029
1002
                        continue
1030
1003
                    if sha1_winner == 'this':
1031
1004
                        content_changed = False
1032
1005
                elif other_ie.kind == 'symlink':
1033
 
                    def get_target(ie, tree):
 
1006
                    def get_target(ie, tree, path):
1034
1007
                        if ie.kind != 'symlink':
1035
1008
                            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)
 
1009
                        return tree.get_symlink_target(path)
 
1010
                    base_target = get_target(base_ie, self.base_tree, base_path)
 
1011
                    lca_targets = [get_target(ie, tree, lca_path) for ie, tree, lca_path
 
1012
                                   in zip(lca_entries, self._lca_trees, lca_paths)]
 
1013
                    this_target = get_target(
 
1014
                        this_ie, self.this_tree, this_path)
 
1015
                    other_target = get_target(
 
1016
                        other_ie, self.other_tree, other_path)
1042
1017
                    target_winner = self._lca_multi_way(
1043
1018
                        (base_target, lca_targets),
1044
1019
                        other_target, this_target)
1045
1020
                    if (parent_id_winner == 'this' and name_winner == 'this'
1046
 
                        and target_winner == 'this'):
 
1021
                            and target_winner == 'this'):
1047
1022
                        # No kind, parent, name, or symlink target change
1048
1023
                        # not interesting
1049
1024
                        continue
1061
1036
                    raise AssertionError('unhandled kind: %s' % other_ie.kind)
1062
1037
 
1063
1038
            # If we have gotten this far, that means something has changed
1064
 
            result.append((file_id, content_changed,
 
1039
            yield (file_id, content_changed,
 
1040
                           ((base_path, lca_paths),
 
1041
                            other_path, this_path),
1065
1042
                           ((base_ie.parent_id, lca_parent_ids),
1066
1043
                            other_ie.parent_id, this_ie.parent_id),
1067
1044
                           ((base_ie.name, lca_names),
1068
1045
                            other_ie.name, this_ie.name),
1069
1046
                           ((base_ie.executable, lca_executable),
1070
1047
                            other_ie.executable, this_ie.executable)
1071
 
                          ))
1072
 
        return result
1073
 
 
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)
 
1048
                           )
1121
1049
 
1122
1050
    def write_modified(self, results):
 
1051
        if not self.working_tree.supports_merge_modified():
 
1052
            return
1123
1053
        modified_hashes = {}
1124
1054
        for path in results.modified_paths:
1125
 
            file_id = self.this_tree.path2id(self.this_tree.relpath(path))
1126
 
            if file_id is None:
 
1055
            wt_relpath = self.working_tree.relpath(path)
 
1056
            if not self.working_tree.is_versioned(wt_relpath):
1127
1057
                continue
1128
 
            hash = self.this_tree.get_file_sha1(file_id)
 
1058
            hash = self.working_tree.get_file_sha1(wt_relpath)
1129
1059
            if hash is None:
1130
1060
                continue
1131
 
            modified_hashes[file_id] = hash
1132
 
        self.this_tree.set_merge_modified(modified_hashes)
 
1061
            modified_hashes[wt_relpath] = hash
 
1062
        self.working_tree.set_merge_modified(modified_hashes)
1133
1063
 
1134
1064
    @staticmethod
1135
 
    def parent(entry, file_id):
 
1065
    def parent(entry):
1136
1066
        """Determine the parent for a file_id (used as a key method)"""
1137
1067
        if entry is None:
1138
1068
            return None
1139
1069
        return entry.parent_id
1140
1070
 
1141
1071
    @staticmethod
1142
 
    def name(entry, file_id):
 
1072
    def name(entry):
1143
1073
        """Determine the name for a file_id (used as a key method)"""
1144
1074
        if entry is None:
1145
1075
            return None
1146
1076
        return entry.name
1147
1077
 
1148
1078
    @staticmethod
1149
 
    def contents_sha1(tree, file_id):
 
1079
    def contents_sha1(tree, path):
1150
1080
        """Determine the sha1 of the file contents (used as a key method)."""
1151
 
        if file_id not in tree:
 
1081
        try:
 
1082
            return tree.get_file_sha1(path)
 
1083
        except errors.NoSuchFile:
1152
1084
            return None
1153
 
        return tree.get_file_sha1(file_id)
1154
1085
 
1155
1086
    @staticmethod
1156
 
    def executable(tree, file_id):
 
1087
    def executable(tree, path):
1157
1088
        """Determine the executability of a file-id (used as a key method)."""
1158
 
        if not tree.has_id(file_id):
 
1089
        try:
 
1090
            if tree.kind(path) != "file":
 
1091
                return False
 
1092
        except errors.NoSuchFile:
1159
1093
            return None
1160
 
        if tree.kind(file_id) != "file":
1161
 
            return False
1162
 
        return tree.is_executable(file_id)
 
1094
        return tree.is_executable(path)
1163
1095
 
1164
1096
    @staticmethod
1165
 
    def kind(tree, file_id):
 
1097
    def kind(tree, path):
1166
1098
        """Determine the kind of a file-id (used as a key method)."""
1167
 
        if not tree.has_id(file_id):
 
1099
        try:
 
1100
            return tree.kind(path)
 
1101
        except errors.NoSuchFile:
1168
1102
            return None
1169
 
        return tree.kind(file_id)
1170
1103
 
1171
1104
    @staticmethod
1172
1105
    def _three_way(base, other, this):
1209
1142
        base_val, lca_vals = bases
1210
1143
        # Remove 'base_val' from the lca_vals, because it is not interesting
1211
1144
        filtered_lca_vals = [lca_val for lca_val in lca_vals
1212
 
                                      if lca_val != base_val]
 
1145
                             if lca_val != base_val]
1213
1146
        if len(filtered_lca_vals) == 0:
1214
1147
            return Merge3Merger._three_way(base_val, other, this)
1215
1148
 
1234
1167
        # At this point, the lcas disagree, and the tip disagree
1235
1168
        return 'conflict'
1236
1169
 
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):
1280
 
        """Perform a merge on file_id names and parents"""
 
1170
    def _merge_names(self, trans_id, file_id, paths, parents, names, resolver):
 
1171
        """Perform a merge on file names and parents"""
1281
1172
        base_name, other_name, this_name = names
1282
1173
        base_parent, other_parent, this_parent = parents
 
1174
        unused_base_path, other_path, this_path = paths
1283
1175
 
1284
1176
        name_winner = resolver(*names)
1285
1177
 
1295
1187
            # Creating helpers (.OTHER or .THIS) here cause problems down the
1296
1188
            # road if a ContentConflict needs to be created so we should not do
1297
1189
            # that
1298
 
            trans_id = self.tt.trans_id_file_id(file_id)
1299
1190
            self._raw_conflicts.append(('path conflict', trans_id, file_id,
1300
1191
                                        this_parent, this_name,
1301
1192
                                        other_parent, other_name))
1302
 
        if other_name is None:
 
1193
        if other_path is None:
1303
1194
            # it doesn't matter whether the result was 'other' or
1304
 
            # 'conflict'-- if there's no 'other', we leave it alone.
 
1195
            # 'conflict'-- if it has no file id, we leave it alone.
1305
1196
            return
1306
1197
        parent_id = parents[self.winner_idx[parent_id_winner]]
1307
 
        if parent_id is not None:
 
1198
        name = names[self.winner_idx[name_winner]]
 
1199
        if parent_id is not None or name is not None:
1308
1200
            # if we get here, name_winner and parent_winner are set to safe
1309
1201
            # values.
1310
 
            self.tt.adjust_path(names[self.winner_idx[name_winner]],
1311
 
                                self.tt.trans_id_file_id(parent_id),
1312
 
                                self.tt.trans_id_file_id(file_id))
 
1202
            if parent_id is None and name is not None:
 
1203
                # if parent_id is None and name is non-None, current file is
 
1204
                # the tree root.
 
1205
                if names[self.winner_idx[parent_id_winner]] != '':
 
1206
                    raise AssertionError(
 
1207
                        'File looks like a root, but named %s' %
 
1208
                        names[self.winner_idx[parent_id_winner]])
 
1209
                parent_trans_id = transform.ROOT_PARENT
 
1210
            else:
 
1211
                parent_trans_id = self.tt.trans_id_file_id(parent_id)
 
1212
            self.tt.adjust_path(name, parent_trans_id, trans_id)
1313
1213
 
1314
 
    def _do_merge_contents(self, file_id):
 
1214
    def _do_merge_contents(self, paths, trans_id, file_id):
1315
1215
        """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)
 
1216
        def contents_pair(tree, path):
 
1217
            if path is None:
 
1218
                return (None, None)
 
1219
            try:
 
1220
                kind = tree.kind(path)
 
1221
            except errors.NoSuchFile:
 
1222
                return (None, None)
1320
1223
            if kind == "file":
1321
 
                contents = tree.get_file_sha1(file_id)
 
1224
                contents = tree.get_file_sha1(path)
1322
1225
            elif kind == "symlink":
1323
 
                contents = tree.get_symlink_target(file_id)
 
1226
                contents = tree.get_symlink_target(path)
1324
1227
            else:
1325
1228
                contents = None
1326
1229
            return kind, contents
1327
1230
 
 
1231
        base_path, other_path, this_path = paths
1328
1232
        # See SPOT run.  run, SPOT, run.
1329
1233
        # So we're not QUITE repeating ourselves; we do tricky things with
1330
1234
        # file kind...
1331
 
        base_pair = contents_pair(self.base_tree)
1332
 
        other_pair = contents_pair(self.other_tree)
 
1235
        other_pair = contents_pair(self.other_tree, other_path)
 
1236
        this_pair = contents_pair(self.this_tree, this_path)
1333
1237
        if self._lca_trees:
1334
 
            this_pair = contents_pair(self.this_tree)
1335
 
            lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
 
1238
            (base_path, lca_paths) = base_path
 
1239
            base_pair = contents_pair(self.base_tree, base_path)
 
1240
            lca_pairs = [contents_pair(tree, path)
 
1241
                         for tree, path in zip(self._lca_trees, lca_paths)]
1336
1242
            winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1337
1243
                                         this_pair, allow_overriding_lca=False)
1338
1244
        else:
 
1245
            base_pair = contents_pair(self.base_tree, base_path)
1339
1246
            if base_pair == other_pair:
1340
1247
                winner = 'this'
1341
1248
            else:
1342
1249
                # We delayed evaluating this_pair as long as we can to avoid
1343
1250
                # unnecessary sha1 calculation
1344
 
                this_pair = contents_pair(self.this_tree)
 
1251
                this_pair = contents_pair(self.this_tree, this_path)
1345
1252
                winner = self._three_way(base_pair, other_pair, this_pair)
1346
1253
        if winner == 'this':
1347
1254
            # No interesting changes introduced by OTHER
1348
1255
            return "unmodified"
1349
1256
        # We have a hypothetical conflict, but if we have files, then we
1350
1257
        # can try to merge the content
1351
 
        trans_id = self.tt.trans_id_file_id(file_id)
1352
 
        params = MergeHookParams(self, file_id, trans_id, this_pair[0],
 
1258
        params = MergeFileHookParams(
 
1259
            self, (base_path, other_path, this_path), trans_id, this_pair[0],
1353
1260
            other_pair[0], winner)
1354
1261
        hooks = self.active_hooks
1355
1262
        hook_status = 'not_applicable'
1358
1265
            if hook_status != 'not_applicable':
1359
1266
                # Don't try any more hooks, this one applies.
1360
1267
                break
 
1268
        # If the merge ends up replacing the content of the file, we get rid of
 
1269
        # it at the end of this method (this variable is used to track the
 
1270
        # exceptions to this rule).
 
1271
        keep_this = False
1361
1272
        result = "modified"
1362
1273
        if hook_status == 'not_applicable':
1363
 
            # This is a contents conflict, because none of the available
1364
 
            # functions could merge it.
 
1274
            # No merge hook was able to resolve the situation. Two cases exist:
 
1275
            # a content conflict or a duplicate one.
1365
1276
            result = None
1366
1277
            name = self.tt.final_name(trans_id)
1367
1278
            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))
 
1279
            inhibit_content_conflict = False
 
1280
            if params.this_kind is None:  # file_id is not in THIS
 
1281
                # Is the name used for a different file_id ?
 
1282
                if self.this_tree.is_versioned(other_path):
 
1283
                    # Two entries for the same path
 
1284
                    keep_this = True
 
1285
                    # versioning the merged file will trigger a duplicate
 
1286
                    # conflict
 
1287
                    self.tt.version_file(trans_id, file_id=file_id)
 
1288
                    transform.create_from_tree(
 
1289
                        self.tt, trans_id, self.other_tree,
 
1290
                        other_path,
 
1291
                        filter_tree_path=self._get_filter_tree_path(other_path))
 
1292
                    inhibit_content_conflict = True
 
1293
            elif params.other_kind is None:  # file_id is not in OTHER
 
1294
                # Is the name used for a different file_id ?
 
1295
                if self.other_tree.is_versioned(this_path):
 
1296
                    # Two entries for the same path again, but here, the other
 
1297
                    # entry will also be merged.  We simply inhibit the
 
1298
                    # 'content' conflict creation because we know OTHER will
 
1299
                    # create (or has already created depending on ordering) an
 
1300
                    # entry at the same path. This will trigger a 'duplicate'
 
1301
                    # conflict later.
 
1302
                    keep_this = True
 
1303
                    inhibit_content_conflict = True
 
1304
            if not inhibit_content_conflict:
 
1305
                if params.this_kind is not None:
 
1306
                    self.tt.unversion_file(trans_id)
 
1307
                # This is a contents conflict, because none of the available
 
1308
                # functions could merge it.
 
1309
                file_group = self._dump_conflicts(
 
1310
                    name, (base_path, other_path, this_path), parent_id)
 
1311
                for tid in file_group:
 
1312
                    self.tt.version_file(tid, file_id=file_id)
 
1313
                    break
 
1314
                self._raw_conflicts.append(('contents conflict', file_group))
1373
1315
        elif hook_status == 'success':
1374
1316
            self.tt.create_file(lines, trans_id)
1375
1317
        elif hook_status == 'conflicted':
1379
1321
            self._raw_conflicts.append(('text conflict', trans_id))
1380
1322
            name = self.tt.final_name(trans_id)
1381
1323
            parent_id = self.tt.final_parent(trans_id)
1382
 
            self._dump_conflicts(name, parent_id, file_id)
 
1324
            self._dump_conflicts(
 
1325
                name, (base_path, other_path, this_path), parent_id)
1383
1326
        elif hook_status == 'delete':
1384
1327
            self.tt.unversion_file(trans_id)
1385
1328
            result = "deleted"
1389
1332
            pass
1390
1333
        else:
1391
1334
            raise AssertionError('unknown hook_status: %r' % (hook_status,))
1392
 
        if not self.this_tree.has_id(file_id) and result == "modified":
1393
 
            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:
 
1335
        if not this_path and result == "modified":
 
1336
            self.tt.version_file(trans_id, file_id=file_id)
 
1337
        if not keep_this:
 
1338
            # The merge has been performed and produced a new content, so the
 
1339
            # old contents should not be retained.
1397
1340
            self.tt.delete_contents(trans_id)
1398
 
        except errors.NoSuchFile:
1399
 
            pass
1400
1341
        return result
1401
1342
 
1402
1343
    def _default_other_winner_merge(self, merge_hook_params):
1403
1344
        """Replace this contents with other."""
1404
 
        file_id = merge_hook_params.file_id
1405
1345
        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):
 
1346
        if merge_hook_params.other_path is not None:
1408
1347
            # 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)
 
1348
            transform.create_from_tree(
 
1349
                self.tt, trans_id, self.other_tree,
 
1350
                merge_hook_params.other_path,
 
1351
                filter_tree_path=self._get_filter_tree_path(merge_hook_params.other_path))
1425
1352
            return 'done', None
1426
 
        elif file_in_this:
 
1353
        elif merge_hook_params.this_path is not None:
1427
1354
            # OTHER deleted the file
1428
1355
            return 'delete', None
1429
1356
        else:
1430
1357
            raise AssertionError(
1431
 
                'winner is OTHER, but file_id %r not in THIS or OTHER tree'
1432
 
                % (file_id,))
 
1358
                'winner is OTHER, but file %r not in THIS or OTHER tree'
 
1359
                % (merge_hook_params.base_path,))
1433
1360
 
1434
1361
    def merge_contents(self, merge_hook_params):
1435
1362
        """Fallback merge logic after user installed hooks."""
1436
1363
        # This function is used in merge hooks as the fallback instance.
1437
 
        # Perhaps making this function and the functions it calls be a 
 
1364
        # Perhaps making this function and the functions it calls be a
1438
1365
        # a separate class would be better.
1439
1366
        if merge_hook_params.winner == 'other':
1440
1367
            # OTHER is a straight winner, so replace this contents with other
1444
1371
            # BASE is a file, or both converted to files, so at least we
1445
1372
            # have agreement that output should be a file.
1446
1373
            try:
1447
 
                self.text_merge(merge_hook_params.file_id,
1448
 
                    merge_hook_params.trans_id)
 
1374
                self.text_merge(merge_hook_params.trans_id,
 
1375
                                merge_hook_params.paths)
1449
1376
            except errors.BinaryFile:
1450
1377
                return 'not_applicable', None
1451
1378
            return 'done', None
1452
1379
        else:
1453
1380
            return 'not_applicable', None
1454
1381
 
1455
 
    def get_lines(self, tree, file_id):
 
1382
    def get_lines(self, tree, path):
1456
1383
        """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()
 
1384
        if path is None:
 
1385
            return []
 
1386
        try:
 
1387
            kind = tree.kind(path)
 
1388
        except errors.NoSuchFile:
 
1389
            return []
1459
1390
        else:
1460
 
            return []
 
1391
            if kind != 'file':
 
1392
                return []
 
1393
            return tree.get_file_lines(path)
1461
1394
 
1462
 
    def text_merge(self, file_id, trans_id):
1463
 
        """Perform a three-way text merge on a file_id"""
 
1395
    def text_merge(self, trans_id, paths):
 
1396
        """Perform a three-way text merge on a file"""
1464
1397
        # it's possible that we got here with base as a different type.
1465
1398
        # 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)
 
1399
        base_path, other_path, this_path = paths
 
1400
        base_lines = self.get_lines(self.base_tree, base_path)
 
1401
        other_lines = self.get_lines(self.other_tree, other_path)
 
1402
        this_lines = self.get_lines(self.this_tree, this_path)
1473
1403
        m3 = merge3.Merge3(base_lines, this_lines, other_lines,
1474
1404
                           is_cherrypick=self.cherrypick)
1475
 
        start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
 
1405
        start_marker = b"!START OF MERGE CONFLICT!" + b"I HOPE THIS IS UNIQUE"
1476
1406
        if self.show_base is True:
1477
 
            base_marker = '|' * 7
 
1407
            base_marker = b'|' * 7
1478
1408
        else:
1479
1409
            base_marker = None
1480
1410
 
1481
1411
        def iter_merge3(retval):
1482
1412
            retval["text_conflicts"] = False
1483
 
            for line in m3.merge_lines(name_a = "TREE",
1484
 
                                       name_b = "MERGE-SOURCE",
1485
 
                                       name_base = "BASE-REVISION",
 
1413
            for line in m3.merge_lines(name_a=b"TREE",
 
1414
                                       name_b=b"MERGE-SOURCE",
 
1415
                                       name_base=b"BASE-REVISION",
1486
1416
                                       start_marker=start_marker,
1487
1417
                                       base_marker=base_marker,
1488
1418
                                       reprocess=self.reprocess):
1489
1419
                if line.startswith(start_marker):
1490
1420
                    retval["text_conflicts"] = True
1491
 
                    yield line.replace(start_marker, '<' * 7)
 
1421
                    yield line.replace(start_marker, b'<' * 7)
1492
1422
                else:
1493
1423
                    yield line
1494
1424
        retval = {}
1498
1428
            self._raw_conflicts.append(('text conflict', trans_id))
1499
1429
            name = self.tt.final_name(trans_id)
1500
1430
            parent_id = self.tt.final_parent(trans_id)
1501
 
            file_group = self._dump_conflicts(name, parent_id, file_id,
1502
 
                                              this_lines, base_lines,
1503
 
                                              other_lines)
 
1431
            file_group = self._dump_conflicts(
 
1432
                name, paths, parent_id,
 
1433
                lines=(base_lines, other_lines, this_lines))
1504
1434
            file_group.append(trans_id)
1505
1435
 
1506
 
    def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
1507
 
                        base_lines=None, other_lines=None, set_version=False,
 
1436
    def _get_filter_tree_path(self, path):
 
1437
        if self.this_tree.supports_content_filtering():
 
1438
            # We get the path from the working tree if it exists.
 
1439
            # That fails though when OTHER is adding a file, so
 
1440
            # we fall back to the other tree to find the path if
 
1441
            # it doesn't exist locally.
 
1442
            filter_path = _mod_tree.find_previous_path(
 
1443
                self.other_tree, self.working_tree, path)
 
1444
            if filter_path is None:
 
1445
                filter_path = path
 
1446
            return filter_path
 
1447
        # Skip the lookup for older formats
 
1448
        return None
 
1449
 
 
1450
    def _dump_conflicts(self, name, paths, parent_id, lines=None,
1508
1451
                        no_base=False):
1509
1452
        """Emit conflict files.
1510
1453
        If this_lines, base_lines, or other_lines are omitted, they will be
1511
1454
        determined automatically.  If set_version is true, the .OTHER, .THIS
1512
1455
        or .BASE (in that order) will be created as versioned files.
1513
1456
        """
1514
 
        data = [('OTHER', self.other_tree, other_lines),
1515
 
                ('THIS', self.this_tree, this_lines)]
 
1457
        base_path, other_path, this_path = paths
 
1458
        if lines:
 
1459
            base_lines, other_lines, this_lines = lines
 
1460
        else:
 
1461
            base_lines = other_lines = this_lines = None
 
1462
        data = [('OTHER', self.other_tree, other_path, other_lines),
 
1463
                ('THIS', self.this_tree, this_path, this_lines)]
1516
1464
        if not no_base:
1517
 
            data.append(('BASE', self.base_tree, base_lines))
 
1465
            data.append(('BASE', self.base_tree, base_path, base_lines))
1518
1466
 
1519
1467
        # We need to use the actual path in the working tree of the file here,
1520
 
        # ignoring the conflict suffixes
1521
 
        wt = self.this_tree
1522
 
        if wt.supports_content_filtering():
1523
 
            try:
1524
 
                filter_tree_path = wt.id2path(file_id)
1525
 
            except errors.NoSuchId:
1526
 
                # file has been deleted
1527
 
                filter_tree_path = None
 
1468
        if self.this_tree.supports_content_filtering():
 
1469
            filter_tree_path = this_path
1528
1470
        else:
1529
1471
            # Skip the id2path lookup for older formats
1530
1472
            filter_tree_path = None
1531
1473
 
1532
 
        versioned = False
1533
1474
        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)
 
1475
        for suffix, tree, path, lines in data:
 
1476
            if path is not None:
 
1477
                trans_id = self._conflict_file(
 
1478
                    name, parent_id, path, tree, suffix, lines,
 
1479
                    filter_tree_path)
1538
1480
                file_group.append(trans_id)
1539
 
                if set_version and not versioned:
1540
 
                    self.tt.version_file(file_id, trans_id)
1541
 
                    versioned = True
1542
1481
        return file_group
1543
1482
 
1544
 
    def _conflict_file(self, name, parent_id, tree, file_id, suffix,
 
1483
    def _conflict_file(self, name, parent_id, path, tree, suffix,
1545
1484
                       lines=None, filter_tree_path=None):
1546
1485
        """Emit a single conflict file."""
1547
1486
        name = name + '.' + suffix
1548
1487
        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)
 
1488
        transform.create_from_tree(
 
1489
            self.tt, trans_id, tree, path,
 
1490
            chunks=lines,
 
1491
            filter_tree_path=filter_tree_path)
1551
1492
        return trans_id
1552
1493
 
1553
 
    def merge_executable(self, file_id, file_status):
1554
 
        """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,
1558
 
                               resolver=self._three_way)
1559
 
 
1560
 
    def _merge_executable(self, file_id, executable, file_status,
 
1494
    def _merge_executable(self, paths, trans_id, executable, file_status,
1561
1495
                          resolver):
1562
1496
        """Perform a merge on the execute bit."""
1563
1497
        base_executable, other_executable, this_executable = executable
 
1498
        base_path, other_path, this_path = paths
1564
1499
        if file_status == "deleted":
1565
1500
            return
1566
1501
        winner = resolver(*executable)
1567
1502
        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:
 
1503
            # There must be a None in here, if we have a conflict, but we
 
1504
            # need executability since file status was not deleted.
 
1505
            if other_path is None:
1571
1506
                winner = "this"
1572
1507
            else:
1573
1508
                winner = "other"
1574
1509
        if winner == 'this' and file_status != "modified":
1575
1510
            return
1576
 
        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:
 
1511
        if self.tt.final_kind(trans_id) != "file":
1581
1512
            return
1582
1513
        if winner == "this":
1583
1514
            executability = this_executable
1584
1515
        else:
1585
 
            if self.other_tree.has_id(file_id):
 
1516
            if other_path is not None:
1586
1517
                executability = other_executable
1587
 
            elif self.this_tree.has_id(file_id):
 
1518
            elif this_path is not None:
1588
1519
                executability = this_executable
1589
 
            elif self.base_tree_has_id(file_id):
 
1520
            elif base_path is not None:
1590
1521
                executability = base_executable
1591
1522
        if executability is not None:
1592
 
            trans_id = self.tt.trans_id_file_id(file_id)
1593
1523
            self.tt.set_executability(executability, trans_id)
1594
1524
 
1595
1525
    def cook_conflicts(self, fs_conflicts):
1596
1526
        """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))
 
1527
        content_conflict_file_ids = set()
 
1528
        cooked_conflicts = self.tt.cook_conflicts(fs_conflicts)
1599
1529
        fp = transform.FinalPaths(self.tt)
1600
1530
        for conflict in self._raw_conflicts:
1601
1531
            conflict_type = conflict[0]
1602
1532
            if conflict_type == 'path conflict':
1603
1533
                (trans_id, file_id,
1604
 
                this_parent, this_name,
1605
 
                other_parent, other_name) = conflict[1:]
 
1534
                 this_parent, this_name,
 
1535
                 other_parent, other_name) = conflict[1:]
1606
1536
                if this_parent is None or this_name is None:
1607
1537
                    this_path = '<deleted>'
1608
1538
                else:
1609
 
                    parent_path =  fp.get_path(
 
1539
                    parent_path = fp.get_path(
1610
1540
                        self.tt.trans_id_file_id(this_parent))
1611
1541
                    this_path = osutils.pathjoin(parent_path, this_name)
1612
1542
                if other_parent is None or other_name is None:
1613
1543
                    other_path = '<deleted>'
1614
1544
                else:
1615
 
                    parent_path =  fp.get_path(
1616
 
                        self.tt.trans_id_file_id(other_parent))
 
1545
                    if other_parent == self.other_tree.path2id(''):
 
1546
                        # The tree transform doesn't know about the other root,
 
1547
                        # so we special case here to avoid a NoFinalPath
 
1548
                        # exception
 
1549
                        parent_path = ''
 
1550
                    else:
 
1551
                        parent_path = fp.get_path(
 
1552
                            self.tt.trans_id_file_id(other_parent))
1617
1553
                    other_path = osutils.pathjoin(parent_path, other_name)
1618
 
                c = _mod_conflicts.Conflict.factory(
 
1554
                c = _mod_bzr_conflicts.Conflict.factory(
1619
1555
                    'path conflict', path=this_path,
1620
1556
                    conflict_path=other_path,
1621
1557
                    file_id=file_id)
1623
1559
                for trans_id in conflict[1]:
1624
1560
                    file_id = self.tt.final_file_id(trans_id)
1625
1561
                    if file_id is not None:
 
1562
                        # Ok we found the relevant file-id
1626
1563
                        break
1627
1564
                path = fp.get_path(trans_id)
1628
1565
                for suffix in ('.BASE', '.THIS', '.OTHER'):
1629
1566
                    if path.endswith(suffix):
 
1567
                        # Here is the raw path
1630
1568
                        path = path[:-len(suffix)]
1631
1569
                        break
1632
 
                c = _mod_conflicts.Conflict.factory(conflict_type,
 
1570
                c = _mod_bzr_conflicts.Conflict.factory(conflict_type,
1633
1571
                                                    path=path, file_id=file_id)
 
1572
                content_conflict_file_ids.add(file_id)
1634
1573
            elif conflict_type == 'text conflict':
1635
1574
                trans_id = conflict[1]
1636
1575
                path = fp.get_path(trans_id)
1637
1576
                file_id = self.tt.final_file_id(trans_id)
1638
 
                c = _mod_conflicts.Conflict.factory(conflict_type,
1639
 
                                                    path=path, file_id=file_id)
 
1577
                c = _mod_bzr_conflicts.Conflict.factory(
 
1578
                    conflict_type, path=path, file_id=file_id)
1640
1579
            else:
1641
1580
                raise AssertionError('bad conflict type: %r' % (conflict,))
 
1581
            cooked_conflicts.append(c)
 
1582
 
 
1583
        self.cooked_conflicts = []
 
1584
        # We want to get rid of path conflicts when a corresponding contents
 
1585
        # conflict exists. This can occur when one branch deletes a file while
 
1586
        # the other renames *and* modifies it. In this case, the content
 
1587
        # conflict is enough.
 
1588
        for c in cooked_conflicts:
 
1589
            if (c.typestring == 'path conflict'
 
1590
                    and c.file_id in content_conflict_file_ids):
 
1591
                continue
1642
1592
            self.cooked_conflicts.append(c)
1643
 
        self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
 
1593
        self.cooked_conflicts.sort(key=_mod_bzr_conflicts.Conflict.sort_key)
1644
1594
 
1645
1595
 
1646
1596
class WeaveMerger(Merge3Merger):
1649
1599
    supports_show_base = False
1650
1600
    supports_reverse_cherrypick = False
1651
1601
    history_based = True
 
1602
    requires_file_merge_plan = True
1652
1603
 
1653
 
    def _generate_merge_plan(self, file_id, base):
1654
 
        return self.this_tree.plan_file_merge(file_id, self.other_tree,
 
1604
    def _generate_merge_plan(self, this_path, base):
 
1605
        return self.this_tree.plan_file_merge(this_path, self.other_tree,
1655
1606
                                              base=base)
1656
1607
 
1657
 
    def _merged_lines(self, file_id):
 
1608
    def _merged_lines(self, this_path):
1658
1609
        """Generate the merged lines.
1659
1610
        There is no distinction between lines that are meant to contain <<<<<<<
1660
1611
        and conflicts.
1663
1614
            base = self.base_tree
1664
1615
        else:
1665
1616
            base = None
1666
 
        plan = self._generate_merge_plan(file_id, base)
 
1617
        plan = self._generate_merge_plan(this_path, base)
1667
1618
        if 'merge' in debug.debug_flags:
1668
1619
            plan = list(plan)
1669
1620
            trans_id = self.tt.trans_id_file_id(file_id)
1670
1621
            name = self.tt.final_name(trans_id) + '.plan'
1671
 
            contents = ('%11s|%s' % l for l in plan)
 
1622
            contents = (b'%11s|%s' % l for l in plan)
1672
1623
            self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1673
 
        textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1674
 
                                                 '>>>>>>> MERGE-SOURCE\n')
 
1624
        textmerge = versionedfile.PlanWeaveMerge(plan, b'<<<<<<< TREE\n',
 
1625
                                                 b'>>>>>>> MERGE-SOURCE\n')
1675
1626
        lines, conflicts = textmerge.merge_lines(self.reprocess)
1676
1627
        if conflicts:
1677
1628
            base_lines = textmerge.base_from_plan()
1679
1630
            base_lines = None
1680
1631
        return lines, base_lines
1681
1632
 
1682
 
    def text_merge(self, file_id, trans_id):
 
1633
    def text_merge(self, trans_id, paths):
1683
1634
        """Perform a (weave) text merge for a given file and file-id.
1684
1635
        If conflicts are encountered, .THIS and .OTHER files will be emitted,
1685
1636
        and a conflict will be noted.
1686
1637
        """
1687
 
        lines, base_lines = self._merged_lines(file_id)
 
1638
        base_path, other_path, this_path = paths
 
1639
        lines, base_lines = self._merged_lines(this_path)
1688
1640
        lines = list(lines)
1689
1641
        # Note we're checking whether the OUTPUT is binary in this case,
1690
1642
        # because we don't want to get into weave merge guts.
1695
1647
            self._raw_conflicts.append(('text conflict', trans_id))
1696
1648
            name = self.tt.final_name(trans_id)
1697
1649
            parent_id = self.tt.final_parent(trans_id)
1698
 
            file_group = self._dump_conflicts(name, parent_id, file_id,
1699
 
                                              no_base=False,
1700
 
                                              base_lines=base_lines)
 
1650
            file_group = self._dump_conflicts(name, paths, parent_id,
 
1651
                                              (base_lines, None, None),
 
1652
                                              no_base=False)
1701
1653
            file_group.append(trans_id)
1702
1654
 
1703
1655
 
1704
1656
class LCAMerger(WeaveMerger):
1705
1657
 
1706
 
    def _generate_merge_plan(self, file_id, base):
1707
 
        return self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
 
1658
    requires_file_merge_plan = True
 
1659
 
 
1660
    def _generate_merge_plan(self, this_path, base):
 
1661
        return self.this_tree.plan_file_lca_merge(this_path, self.other_tree,
1708
1662
                                                  base=base)
1709
1663
 
 
1664
 
1710
1665
class Diff3Merger(Merge3Merger):
1711
1666
    """Three-way merger using external diff3 for text merging"""
1712
1667
 
1713
 
    def dump_file(self, temp_dir, name, tree, file_id):
 
1668
    requires_file_merge_plan = False
 
1669
 
 
1670
    def dump_file(self, temp_dir, name, tree, path):
1714
1671
        out_path = osutils.pathjoin(temp_dir, name)
1715
 
        out_file = open(out_path, "wb")
1716
 
        try:
1717
 
            in_file = tree.get_file(file_id)
 
1672
        with open(out_path, "wb") as out_file:
 
1673
            in_file = tree.get_file(path)
1718
1674
            for line in in_file:
1719
1675
                out_file.write(line)
1720
 
        finally:
1721
 
            out_file.close()
1722
1676
        return out_path
1723
1677
 
1724
 
    def text_merge(self, file_id, trans_id):
 
1678
    def text_merge(self, trans_id, paths):
1725
1679
        """Perform a diff3 merge using a specified file-id and trans-id.
1726
1680
        If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
1727
1681
        will be dumped, and a will be conflict noted.
1728
1682
        """
1729
 
        import bzrlib.patch
 
1683
        import breezy.patch
 
1684
        base_path, other_path, this_path = paths
1730
1685
        temp_dir = osutils.mkdtemp(prefix="bzr-")
1731
1686
        try:
1732
1687
            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)
 
1688
            this = self.dump_file(
 
1689
                temp_dir, "this", self.this_tree, this_path)
 
1690
            base = self.dump_file(
 
1691
                temp_dir, "base", self.base_tree, base_path)
 
1692
            other = self.dump_file(
 
1693
                temp_dir, "other", self.other_tree, other_path)
 
1694
            status = breezy.patch.diff3(new_file, this, base, other)
1737
1695
            if status not in (0, 1):
1738
1696
                raise errors.BzrError("Unhandled diff3 exit code")
1739
 
            f = open(new_file, 'rb')
1740
 
            try:
 
1697
            with open(new_file, 'rb') as f:
1741
1698
                self.tt.create_file(f, trans_id)
1742
 
            finally:
1743
 
                f.close()
1744
1699
            if status == 1:
1745
1700
                name = self.tt.final_name(trans_id)
1746
1701
                parent_id = self.tt.final_parent(trans_id)
1747
 
                self._dump_conflicts(name, parent_id, file_id)
 
1702
                self._dump_conflicts(name, paths, parent_id)
1748
1703
                self._raw_conflicts.append(('text conflict', trans_id))
1749
1704
        finally:
1750
1705
            osutils.rmtree(temp_dir)
1751
1706
 
1752
1707
 
 
1708
class PathNotInTree(errors.BzrError):
 
1709
 
 
1710
    _fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
 
1711
 
 
1712
    def __init__(self, path, tree):
 
1713
        errors.BzrError.__init__(self, path=path, tree=tree)
 
1714
 
 
1715
 
 
1716
class MergeIntoMerger(Merger):
 
1717
    """Merger that understands other_tree will be merged into a subdir.
 
1718
 
 
1719
    This also changes the Merger api so that it uses real Branch, revision_id,
 
1720
    and RevisonTree objects, rather than using revision specs.
 
1721
    """
 
1722
 
 
1723
    def __init__(self, this_tree, other_branch, other_tree, target_subdir,
 
1724
                 source_subpath, other_rev_id=None):
 
1725
        """Create a new MergeIntoMerger object.
 
1726
 
 
1727
        source_subpath in other_tree will be effectively copied to
 
1728
        target_subdir in this_tree.
 
1729
 
 
1730
        :param this_tree: The tree that we will be merging into.
 
1731
        :param other_branch: The Branch we will be merging from.
 
1732
        :param other_tree: The RevisionTree object we want to merge.
 
1733
        :param target_subdir: The relative path where we want to merge
 
1734
            other_tree into this_tree
 
1735
        :param source_subpath: The relative path specifying the subtree of
 
1736
            other_tree to merge into this_tree.
 
1737
        """
 
1738
        # It is assumed that we are merging a tree that is not in our current
 
1739
        # ancestry, which means we are using the "EmptyTree" as our basis.
 
1740
        null_ancestor_tree = this_tree.branch.repository.revision_tree(
 
1741
            _mod_revision.NULL_REVISION)
 
1742
        super(MergeIntoMerger, self).__init__(
 
1743
            this_branch=this_tree.branch,
 
1744
            this_tree=this_tree,
 
1745
            other_tree=other_tree,
 
1746
            base_tree=null_ancestor_tree,
 
1747
            )
 
1748
        self._target_subdir = target_subdir
 
1749
        self._source_subpath = source_subpath
 
1750
        self.other_branch = other_branch
 
1751
        if other_rev_id is None:
 
1752
            other_rev_id = other_tree.get_revision_id()
 
1753
        self.other_rev_id = self.other_basis = other_rev_id
 
1754
        self.base_is_ancestor = True
 
1755
        self.backup_files = True
 
1756
        self.merge_type = Merge3Merger
 
1757
        self.show_base = False
 
1758
        self.reprocess = False
 
1759
        self.interesting_files = None
 
1760
        self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
 
1761
                                                  target_subdir=self._target_subdir,
 
1762
                                                  source_subpath=self._source_subpath)
 
1763
        if self._source_subpath != '':
 
1764
            # If this isn't a partial merge make sure the revisions will be
 
1765
            # present.
 
1766
            self._maybe_fetch(self.other_branch, self.this_branch,
 
1767
                              self.other_basis)
 
1768
 
 
1769
    def set_pending(self):
 
1770
        if self._source_subpath != '':
 
1771
            return
 
1772
        Merger.set_pending(self)
 
1773
 
 
1774
 
 
1775
class _MergeTypeParameterizer(object):
 
1776
    """Wrap a merge-type class to provide extra parameters.
 
1777
 
 
1778
    This is hack used by MergeIntoMerger to pass some extra parameters to its
 
1779
    merge_type.  Merger.do_merge() sets up its own set of parameters to pass to
 
1780
    the 'merge_type' member.  It is difficult override do_merge without
 
1781
    re-writing the whole thing, so instead we create a wrapper which will pass
 
1782
    the extra parameters.
 
1783
    """
 
1784
 
 
1785
    def __init__(self, merge_type, **kwargs):
 
1786
        self._extra_kwargs = kwargs
 
1787
        self._merge_type = merge_type
 
1788
 
 
1789
    def __call__(self, *args, **kwargs):
 
1790
        kwargs.update(self._extra_kwargs)
 
1791
        return self._merge_type(*args, **kwargs)
 
1792
 
 
1793
    def __getattr__(self, name):
 
1794
        return getattr(self._merge_type, name)
 
1795
 
 
1796
 
 
1797
class MergeIntoMergeType(Merge3Merger):
 
1798
    """Merger that incorporates a tree (or part of a tree) into another."""
 
1799
 
 
1800
    def __init__(self, *args, **kwargs):
 
1801
        """Initialize the merger object.
 
1802
 
 
1803
        :param args: See Merge3Merger.__init__'s args.
 
1804
        :param kwargs: See Merge3Merger.__init__'s keyword args, except for
 
1805
            source_subpath and target_subdir.
 
1806
        :keyword source_subpath: The relative path specifying the subtree of
 
1807
            other_tree to merge into this_tree.
 
1808
        :keyword target_subdir: The relative path where we want to merge
 
1809
            other_tree into this_tree
 
1810
        """
 
1811
        # All of the interesting work happens during Merge3Merger.__init__(),
 
1812
        # so we have have to hack in to get our extra parameters set.
 
1813
        self._source_subpath = kwargs.pop('source_subpath')
 
1814
        self._target_subdir = kwargs.pop('target_subdir')
 
1815
        super(MergeIntoMergeType, self).__init__(*args, **kwargs)
 
1816
 
 
1817
    def _compute_transform(self):
 
1818
        with ui.ui_factory.nested_progress_bar() as child_pb:
 
1819
            entries = self._entries_to_incorporate()
 
1820
            entries = list(entries)
 
1821
            for num, (entry, parent_id, relpath) in enumerate(entries):
 
1822
                child_pb.update(gettext('Preparing file merge'),
 
1823
                                num, len(entries))
 
1824
                parent_trans_id = self.tt.trans_id_file_id(parent_id)
 
1825
                path = osutils.pathjoin(self._source_subpath, relpath)
 
1826
                trans_id = transform.new_by_entry(path, self.tt, entry,
 
1827
                                                  parent_trans_id, self.other_tree)
 
1828
        self._finish_computing_transform()
 
1829
 
 
1830
    def _entries_to_incorporate(self):
 
1831
        """Yields pairs of (inventory_entry, new_parent)."""
 
1832
        subdir_id = self.other_tree.path2id(self._source_subpath)
 
1833
        if subdir_id is None:
 
1834
            # XXX: The error would be clearer if it gave the URL of the source
 
1835
            # branch, but we don't have a reference to that here.
 
1836
            raise PathNotInTree(self._source_subpath, "Source tree")
 
1837
        subdir = next(self.other_tree.iter_entries_by_dir(
 
1838
            specific_files=[self._source_subpath]))[1]
 
1839
        parent_in_target = osutils.dirname(self._target_subdir)
 
1840
        target_id = self.this_tree.path2id(parent_in_target)
 
1841
        if target_id is None:
 
1842
            raise PathNotInTree(self._target_subdir, "Target tree")
 
1843
        name_in_target = osutils.basename(self._target_subdir)
 
1844
        merge_into_root = subdir.copy()
 
1845
        merge_into_root.name = name_in_target
 
1846
        try:
 
1847
            self.this_tree.id2path(merge_into_root.file_id)
 
1848
        except errors.NoSuchId:
 
1849
            pass
 
1850
        else:
 
1851
            # Give the root a new file-id.
 
1852
            # This can happen fairly easily if the directory we are
 
1853
            # incorporating is the root, and both trees have 'TREE_ROOT' as
 
1854
            # their root_id.  Users will expect this to Just Work, so we
 
1855
            # change the file-id here.
 
1856
            # Non-root file-ids could potentially conflict too.  That's really
 
1857
            # an edge case, so we don't do anything special for those.  We let
 
1858
            # them cause conflicts.
 
1859
            merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
 
1860
        yield (merge_into_root, target_id, '')
 
1861
        if subdir.kind != 'directory':
 
1862
            # No children, so we are done.
 
1863
            return
 
1864
        for path, entry in self.other_tree.root_inventory.iter_entries_by_dir(subdir_id):
 
1865
            parent_id = entry.parent_id
 
1866
            if parent_id == subdir.file_id:
 
1867
                # The root's parent ID has changed, so make sure children of
 
1868
                # the root refer to the new ID.
 
1869
                parent_id = merge_into_root.file_id
 
1870
            yield (entry, parent_id, path)
 
1871
 
 
1872
 
1753
1873
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1754
1874
                backup_files=False,
1755
1875
                merge_type=Merge3Merger,
1756
 
                interesting_ids=None,
1757
1876
                show_base=False,
1758
1877
                reprocess=False,
1759
1878
                other_rev_id=None,
1760
1879
                interesting_files=None,
1761
1880
                this_tree=None,
1762
 
                pb=None,
1763
1881
                change_reporter=None):
1764
1882
    """Primary interface for merging.
1765
1883
 
1766
 
        typical use is probably
1767
 
        'merge_inner(branch, branch.get_revision_tree(other_revision),
1768
 
                     branch.get_revision_tree(base_revision))'
1769
 
        """
 
1884
    Typical use is probably::
 
1885
 
 
1886
        merge_inner(branch, branch.get_revision_tree(other_revision),
 
1887
                    branch.get_revision_tree(base_revision))
 
1888
    """
1770
1889
    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.")
 
1890
        raise errors.BzrError("breezy.merge.merge_inner requires a this_tree "
 
1891
                              "parameter")
1773
1892
    merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1774
 
                    pb=pb, change_reporter=change_reporter)
 
1893
                    change_reporter=change_reporter)
1775
1894
    merger.backup_files = backup_files
1776
1895
    merger.merge_type = merge_type
1777
 
    merger.interesting_ids = interesting_ids
1778
1896
    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
 
1897
    merger.interesting_files = interesting_files
1784
1898
    merger.show_base = show_base
1785
1899
    merger.reprocess = reprocess
1786
1900
    merger.other_rev_id = other_rev_id
1792
1906
    merger.set_base_revision(get_revision_id(), this_branch)
1793
1907
    return merger.do_merge()
1794
1908
 
 
1909
 
 
1910
merge_type_registry = registry.Registry()
 
1911
merge_type_registry.register('diff3', Diff3Merger,
 
1912
                             "Merge using external diff3.")
 
1913
merge_type_registry.register('lca', LCAMerger,
 
1914
                             "LCA-newness merge.")
 
1915
merge_type_registry.register('merge3', Merge3Merger,
 
1916
                             "Native diff3-style merge.")
 
1917
merge_type_registry.register('weave', WeaveMerger,
 
1918
                             "Weave-based merge.")
 
1919
 
 
1920
 
1795
1921
def get_merge_type_registry():
1796
 
    """Merge type registry is in bzrlib.option to avoid circular imports.
 
1922
    """Merge type registry was previously in breezy.option
1797
1923
 
1798
 
    This method provides a sanctioned way to retrieve it.
 
1924
    This method provides a backwards compatible way to retrieve it.
1799
1925
    """
1800
 
    from bzrlib import option
1801
 
    return option._merge_type_registry
 
1926
    return merge_type_registry
1802
1927
 
1803
1928
 
1804
1929
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
1870
1995
        for record in self.vf.get_record_stream(keys, 'unordered', True):
1871
1996
            if record.storage_kind == 'absent':
1872
1997
                raise errors.RevisionNotPresent(record.key, self.vf)
1873
 
            result[record.key[-1]] = osutils.chunks_to_lines(
1874
 
                record.get_bytes_as('chunked'))
 
1998
            result[record.key[-1]] = record.get_bytes_as('lines')
1875
1999
        return result
1876
2000
 
1877
2001
    def plan_merge(self):
1910
2034
                else:
1911
2035
                    yield 'killed-a', self.lines_b[b_index]
1912
2036
            # handle common lines
1913
 
            for a_index in range(i, i+n):
 
2037
            for a_index in range(i, i + n):
1914
2038
                yield 'unchanged', self.lines_a[a_index]
1915
 
            last_i = i+n
1916
 
            last_j = j+n
 
2039
            last_i = i + n
 
2040
            last_j = j + n
1917
2041
 
1918
2042
    def _get_matching_blocks(self, left_revision, right_revision):
1919
2043
        """Return a description of which sections of two revisions match.
1975
2099
        for i, j, n in matcher.get_matching_blocks():
1976
2100
            for jj in range(last_j, j):
1977
2101
                yield new_plan[jj]
1978
 
            for jj in range(j, j+n):
 
2102
            for jj in range(j, j + n):
1979
2103
                plan_line = new_plan[jj]
1980
2104
                if plan_line[0] == 'new-b':
1981
2105
                    pass
2025
2149
        while True:
2026
2150
            next_lcas = self.graph.find_lca(*cur_ancestors)
2027
2151
            # Map a plain NULL_REVISION to a simple no-ancestors
2028
 
            if next_lcas == set([_mod_revision.NULL_REVISION]):
 
2152
            if next_lcas == {_mod_revision.NULL_REVISION}:
2029
2153
                next_lcas = ()
2030
2154
            # Order the lca's based on when they were merged into the tip
2031
2155
            # While the actual merge portion of weave merge uses a set() of
2119
2243
        filtered_parent_map = {}
2120
2244
        child_map = {}
2121
2245
        tails = []
2122
 
        for key, parent_keys in parent_map.iteritems():
 
2246
        for key, parent_keys in viewitems(parent_map):
2123
2247
            culled_parent_keys = [p for p in parent_keys if p in parent_map]
2124
2248
            if not culled_parent_keys:
2125
2249
                tails.append(key)
2175
2299
        return all_texts
2176
2300
 
2177
2301
    def _build_weave(self):
2178
 
        from bzrlib import weave
 
2302
        from .bzr import weave
2179
2303
        self._weave = weave.Weave(weave_name='in_memory_weave',
2180
2304
                                  allow_reserved=True)
2181
2305
        parent_map = self._find_recursive_lcas()
2212
2336
        are combined, they are written out in the format described in
2213
2337
        VersionedFile.plan_merge
2214
2338
        """
2215
 
        if self._head_key is not None: # There was a single head
 
2339
        if self._head_key is not None:  # There was a single head
2216
2340
            if self._head_key == self.a_key:
2217
2341
                plan = 'new-a'
2218
2342
            else:
2229
2353
class _PlanLCAMerge(_PlanMergeBase):
2230
2354
    """
2231
2355
    This merge algorithm differs from _PlanMerge in that:
 
2356
 
2232
2357
    1. comparisons are done against LCAs only
2233
2358
    2. cases where a contested line is new versus one LCA but old versus
2234
2359
       another are marked as conflicts, by emitting the line as conflicted-a
2275
2400
 
2276
2401
        If a line is killed and new, this indicates that the two merge
2277
2402
        revisions contain differing conflict resolutions.
 
2403
 
2278
2404
        :param revision_id: The id of the revision in which the lines are
2279
2405
            unique
2280
2406
        :param unique_line_numbers: The line numbers of unique lines.
2281
 
        :return a tuple of (new_this, killed_other):
 
2407
        :return: a tuple of (new_this, killed_other)
2282
2408
        """
2283
2409
        new = set()
2284
2410
        killed = set()