/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: Gustav Hartvigsson
  • Date: 2021-01-09 21:36:27 UTC
  • Revision ID: gustav.hartvigsson@gmail.com-20210109213627-h1xwcutzy9m7a99b
Added 'Case Preserving Working Tree Use Cases' from Canonical Wiki

* Addod a page from the Canonical Bazaar wiki
  with information on the scmeatics of case
  perserving filesystems an a case insensitive
  filesystem works.
  
  * Needs re-work, but this will do as it is the
    same inforamoton as what was on the linked
    page in the currint documentation.

Show diffs side-by-side

added added

removed removed

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