/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-09-02 16:35:18 UTC
  • mto: (7490.40.109 work)
  • mto: This revision was merged to the branch mainline in revision 7526.
  • Revision ID: jelmer@jelmer.uk-20200902163518-sy9f4unbboljphgu
Handle duplicate directories entries for git.

Show diffs side-by-side

added added

removed removed

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