/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: Marius Kruger
  • Date: 2010-07-10 21:28:56 UTC
  • mto: (5384.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5385.
  • Revision ID: marius.kruger@enerweb.co.za-20100710212856-uq4ji3go0u5se7hx
* Update documentation
* add NEWS

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