/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 15:20:23 UTC
  • mto: (7490.40.61 work)
  • mto: This revision was merged to the branch mainline in revision 7519.
  • Revision ID: jelmer@jelmer.uk-20200718152023-cabh92o24ke217te
Ignore missing revs.

Show diffs side-by-side

added added

removed removed

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