/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-07-18 23:14:00 UTC
  • mfrom: (7490.40.62 work)
  • mto: This revision was merged to the branch mainline in revision 7519.
  • Revision ID: jelmer@jelmer.uk-20200718231400-jaes9qltn8oi8xss
Merge lp:brz/3.1.

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