/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 bzrlib/merge.py

  • Committer: Robert Collins
  • Date: 2010-05-11 08:36:16 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100511083616-b8fjb19zomwupid0
Make all lock methods return Result objects, rather than lock_read returning self, as per John's review.

Show diffs side-by-side

added added

removed removed

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