~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-09-03 20:58:40 UTC
  • mfrom: (3626.1.6 unicode_hostname)
  • Revision ID: pqm@pqm.ubuntu.com-20080903205840-mteswj8dfvld7vo3
(Mark Hammond) Fix bug #256550 by using a Unicode api on Windows for
        the host name.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2008 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
 
18
import errno
 
19
from itertools import chain
 
20
import os
17
21
import warnings
18
22
 
19
 
from bzrlib.lazy_import import lazy_import
20
 
lazy_import(globals(), """
21
23
from bzrlib import (
22
 
    branch as _mod_branch,
23
 
    conflicts as _mod_conflicts,
24
24
    debug,
25
 
    generate_ids,
 
25
    errors,
26
26
    graph as _mod_graph,
27
 
    merge3,
28
27
    osutils,
29
28
    patiencediff,
 
29
    registry,
30
30
    revision as _mod_revision,
31
 
    textfile,
32
 
    trace,
33
 
    transform,
34
 
    tree as _mod_tree,
35
31
    tsort,
36
 
    ui,
37
 
    versionedfile,
38
 
    workingtree,
39
 
    )
40
 
from bzrlib.cleanup import OperationWithCleanups
41
 
""")
42
 
from bzrlib import (
43
 
    decorators,
44
 
    errors,
45
 
    hooks,
46
 
    )
47
 
from bzrlib.symbol_versioning import (
48
 
    deprecated_in,
49
 
    deprecated_method,
50
 
    )
 
32
    )
 
33
from bzrlib.branch import Branch
 
34
from bzrlib.conflicts import ConflictList, Conflict
 
35
from bzrlib.errors import (BzrCommandError,
 
36
                           BzrError,
 
37
                           NoCommonAncestor,
 
38
                           NoCommits,
 
39
                           NoSuchRevision,
 
40
                           NoSuchFile,
 
41
                           NotBranchError,
 
42
                           NotVersionedError,
 
43
                           UnrelatedBranches,
 
44
                           UnsupportedOperation,
 
45
                           WorkingTreeNotRevision,
 
46
                           BinaryFile,
 
47
                           )
 
48
from bzrlib.graph import Graph
 
49
from bzrlib.merge3 import Merge3
 
50
from bzrlib.osutils import rename, pathjoin
 
51
from progress import DummyProgress, ProgressPhase
 
52
from bzrlib.revision import (NULL_REVISION, ensure_null)
 
53
from bzrlib.textfile import check_text_lines
 
54
from bzrlib.trace import mutter, warning, note, is_quiet
 
55
from bzrlib.transform import (TransformPreview, TreeTransform,
 
56
                              resolve_conflicts, cook_conflicts,
 
57
                              conflict_pass, FinalPaths, create_by_entry,
 
58
                              unique_add, ROOT_PARENT)
 
59
from bzrlib.versionedfile import PlanWeaveMerge
 
60
from bzrlib import ui
 
61
 
51
62
# TODO: Report back as changes are merged in
52
63
 
53
64
 
54
65
def transform_tree(from_tree, to_tree, interesting_ids=None):
55
 
    from_tree.lock_tree_write()
56
 
    operation = OperationWithCleanups(merge_inner)
57
 
    operation.add_cleanup(from_tree.unlock)
58
 
    operation.run_simple(from_tree.branch, to_tree, from_tree,
59
 
        ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
60
 
 
61
 
 
62
 
class MergeHooks(hooks.Hooks):
63
 
 
64
 
    def __init__(self):
65
 
        hooks.Hooks.__init__(self)
66
 
        self.create_hook(hooks.HookPoint('merge_file_content',
67
 
            "Called with a bzrlib.merge.Merger object to create a per file "
68
 
            "merge object when starting a merge. "
69
 
            "Should return either None or a subclass of "
70
 
            "``bzrlib.merge.AbstractPerFileMerger``. "
71
 
            "Such objects will then be called per file "
72
 
            "that needs to be merged (including when one "
73
 
            "side has deleted the file and the other has changed it). "
74
 
            "See the AbstractPerFileMerger API docs for details on how it is "
75
 
            "used by merge.",
76
 
            (2, 1), None))
77
 
 
78
 
 
79
 
class AbstractPerFileMerger(object):
80
 
    """PerFileMerger objects are used by plugins extending merge for bzrlib.
81
 
 
82
 
    See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
83
 
    
84
 
    :ivar merger: The Merge3Merger performing the merge.
85
 
    """
86
 
 
87
 
    def __init__(self, merger):
88
 
        """Create a PerFileMerger for use with merger."""
89
 
        self.merger = merger
90
 
 
91
 
    def merge_contents(self, merge_params):
92
 
        """Attempt to merge the contents of a single file.
93
 
        
94
 
        :param merge_params: A bzrlib.merge.MergeHookParams
95
 
        :return : A tuple of (status, chunks), where status is one of
96
 
            'not_applicable', 'success', 'conflicted', or 'delete'.  If status
97
 
            is 'success' or 'conflicted', then chunks should be an iterable of
98
 
            strings for the new file contents.
99
 
        """
100
 
        return ('not applicable', None)
101
 
 
102
 
 
103
 
class PerFileMerger(AbstractPerFileMerger):
104
 
    """Merge individual files when self.file_matches returns True.
105
 
 
106
 
    This class is intended to be subclassed.  The file_matches and
107
 
    merge_matching methods should be overridden with concrete implementations.
108
 
    """
109
 
 
110
 
    def file_matches(self, params):
111
 
        """Return True if merge_matching should be called on this file.
112
 
 
113
 
        Only called with merges of plain files with no clear winner.
114
 
 
115
 
        Subclasses must override this.
116
 
        """
117
 
        raise NotImplementedError(self.file_matches)
118
 
 
119
 
    def get_filename(self, params, tree):
120
 
        """Lookup the filename (i.e. basename, not path), given a Tree (e.g.
121
 
        self.merger.this_tree) and a MergeHookParams.
122
 
        """
123
 
        return osutils.basename(tree.id2path(params.file_id))
124
 
 
125
 
    def get_filepath(self, params, tree):
126
 
        """Calculate the path to the file in a tree.
127
 
 
128
 
        :param params: A MergeHookParams describing the file to merge
129
 
        :param tree: a Tree, e.g. self.merger.this_tree.
130
 
        """
131
 
        return tree.id2path(params.file_id)
132
 
 
133
 
    def merge_contents(self, params):
134
 
        """Merge the contents of a single file."""
135
 
        # Check whether this custom merge logic should be used.
136
 
        if (
137
 
            # OTHER is a straight winner, rely on default merge.
138
 
            params.winner == 'other' or
139
 
            # THIS and OTHER aren't both files.
140
 
            not params.is_file_merge() or
141
 
            # The filename doesn't match *.xml
142
 
            not self.file_matches(params)):
143
 
            return 'not_applicable', None
144
 
        return self.merge_matching(params)
145
 
 
146
 
    def merge_matching(self, params):
147
 
        """Merge the contents of a single file that has matched the criteria
148
 
        in PerFileMerger.merge_contents (is a conflict, is a file,
149
 
        self.file_matches is True).
150
 
 
151
 
        Subclasses must override this.
152
 
        """
153
 
        raise NotImplementedError(self.merge_matching)
154
 
 
155
 
 
156
 
class ConfigurableFileMerger(PerFileMerger):
157
 
    """Merge individual files when configured via a .conf file.
158
 
 
159
 
    This is a base class for concrete custom file merging logic. Concrete
160
 
    classes should implement ``merge_text``.
161
 
 
162
 
    See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
163
 
    
164
 
    :ivar affected_files: The configured file paths to merge.
165
 
 
166
 
    :cvar name_prefix: The prefix to use when looking up configuration
167
 
        details. <name_prefix>_merge_files describes the files targeted by the
168
 
        hook for example.
169
 
        
170
 
    :cvar default_files: The default file paths to merge when no configuration
171
 
        is present.
172
 
    """
173
 
 
174
 
    name_prefix = None
175
 
    default_files = None
176
 
 
177
 
    def __init__(self, merger):
178
 
        super(ConfigurableFileMerger, self).__init__(merger)
179
 
        self.affected_files = None
180
 
        self.default_files = self.__class__.default_files or []
181
 
        self.name_prefix = self.__class__.name_prefix
182
 
        if self.name_prefix is None:
183
 
            raise ValueError("name_prefix must be set.")
184
 
 
185
 
    def file_matches(self, params):
186
 
        """Check whether the file should call the merge hook.
187
 
 
188
 
        <name_prefix>_merge_files configuration variable is a list of files
189
 
        that should use the hook.
190
 
        """
191
 
        affected_files = self.affected_files
192
 
        if affected_files is None:
193
 
            config = self.merger.this_branch.get_config()
194
 
            # Until bzr provides a better policy for caching the config, we
195
 
            # just add the part we're interested in to the params to avoid
196
 
            # reading the config files repeatedly (bazaar.conf, location.conf,
197
 
            # branch.conf).
198
 
            config_key = self.name_prefix + '_merge_files'
199
 
            affected_files = config.get_user_option_as_list(config_key)
200
 
            if affected_files is None:
201
 
                # If nothing was specified in the config, use the default.
202
 
                affected_files = self.default_files
203
 
            self.affected_files = affected_files
204
 
        if affected_files:
205
 
            filepath = self.get_filepath(params, self.merger.this_tree)
206
 
            if filepath in affected_files:
207
 
                return True
208
 
        return False
209
 
 
210
 
    def merge_matching(self, params):
211
 
        return self.merge_text(params)
212
 
 
213
 
    def merge_text(self, params):
214
 
        """Merge the byte contents of a single file.
215
 
 
216
 
        This is called after checking that the merge should be performed in
217
 
        merge_contents, and it should behave as per
218
 
        ``bzrlib.merge.AbstractPerFileMerger.merge_contents``.
219
 
        """
220
 
        raise NotImplementedError(self.merge_text)
221
 
 
222
 
 
223
 
class MergeHookParams(object):
224
 
    """Object holding parameters passed to merge_file_content hooks.
225
 
 
226
 
    There are some fields hooks can access:
227
 
 
228
 
    :ivar file_id: the file ID of the file being merged
229
 
    :ivar trans_id: the transform ID for the merge of this file
230
 
    :ivar this_kind: kind of file_id in 'this' tree
231
 
    :ivar other_kind: kind of file_id in 'other' tree
232
 
    :ivar winner: one of 'this', 'other', 'conflict'
233
 
    """
234
 
 
235
 
    def __init__(self, merger, file_id, trans_id, this_kind, other_kind,
236
 
            winner):
237
 
        self._merger = merger
238
 
        self.file_id = file_id
239
 
        self.trans_id = trans_id
240
 
        self.this_kind = this_kind
241
 
        self.other_kind = other_kind
242
 
        self.winner = winner
243
 
 
244
 
    def is_file_merge(self):
245
 
        """True if this_kind and other_kind are both 'file'."""
246
 
        return self.this_kind == 'file' and self.other_kind == 'file'
247
 
 
248
 
    @decorators.cachedproperty
249
 
    def base_lines(self):
250
 
        """The lines of the 'base' version of the file."""
251
 
        return self._merger.get_lines(self._merger.base_tree, self.file_id)
252
 
 
253
 
    @decorators.cachedproperty
254
 
    def this_lines(self):
255
 
        """The lines of the 'this' version of the file."""
256
 
        return self._merger.get_lines(self._merger.this_tree, self.file_id)
257
 
 
258
 
    @decorators.cachedproperty
259
 
    def other_lines(self):
260
 
        """The lines of the 'other' version of the file."""
261
 
        return self._merger.get_lines(self._merger.other_tree, self.file_id)
 
66
    merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
 
67
                interesting_ids=interesting_ids, this_tree=from_tree)
262
68
 
263
69
 
264
70
class Merger(object):
265
 
 
266
 
    hooks = MergeHooks()
267
 
 
268
71
    def __init__(self, this_branch, other_tree=None, base_tree=None,
269
 
                 this_tree=None, pb=None, change_reporter=None,
 
72
                 this_tree=None, pb=DummyProgress(), change_reporter=None,
270
73
                 recurse='down', revision_graph=None):
271
74
        object.__init__(self)
272
75
        self.this_branch = this_branch
285
88
        self.interesting_files = None
286
89
        self.show_base = False
287
90
        self.reprocess = False
288
 
        if pb is not None:
289
 
            warnings.warn("pb parameter to Merger() is deprecated and ignored")
 
91
        self._pb = pb
290
92
        self.pp = None
291
93
        self.recurse = recurse
292
94
        self.change_reporter = change_reporter
294
96
        self._revision_graph = revision_graph
295
97
        self._base_is_ancestor = None
296
98
        self._base_is_other_ancestor = None
297
 
        self._is_criss_cross = None
298
 
        self._lca_trees = None
299
 
 
300
 
    def cache_trees_with_revision_ids(self, trees):
301
 
        """Cache any tree in trees if it has a revision_id."""
302
 
        for maybe_tree in trees:
303
 
            if maybe_tree is None:
304
 
                continue
305
 
            try:
306
 
                rev_id = maybe_tree.get_revision_id()
307
 
            except AttributeError:
308
 
                continue
309
 
            self._cached_trees[rev_id] = maybe_tree
310
99
 
311
100
    @property
312
101
    def revision_graph(self):
340
129
                                      _set_base_is_other_ancestor)
341
130
 
342
131
    @staticmethod
343
 
    def from_uncommitted(tree, other_tree, pb=None, base_tree=None):
 
132
    def from_uncommitted(tree, other_tree, pb):
344
133
        """Return a Merger for uncommitted changes in other_tree.
345
134
 
346
135
        :param tree: The tree to merge into
347
136
        :param other_tree: The tree to get uncommitted changes from
348
137
        :param pb: A progress indicator
349
 
        :param base_tree: The basis to use for the merge.  If unspecified,
350
 
            other_tree.basis_tree() will be used.
351
138
        """
352
 
        if base_tree is None:
353
 
            base_tree = other_tree.basis_tree()
354
 
        merger = Merger(tree.branch, other_tree, base_tree, tree, pb)
 
139
        merger = Merger(tree.branch, other_tree, other_tree.basis_tree(), tree,
 
140
                        pb)
355
141
        merger.base_rev_id = merger.base_tree.get_revision_id()
356
142
        merger.other_rev_id = None
357
143
        merger.other_basis = merger.base_rev_id
375
161
                base_revision_id, tree.branch.last_revision())):
376
162
                base_revision_id = None
377
163
            else:
378
 
                trace.warning('Performing cherrypick')
 
164
                warning('Performing cherrypick')
379
165
        merger = klass.from_revision_ids(pb, tree, other_revision_id,
380
166
                                         base_revision_id, revision_graph=
381
167
                                         revision_graph)
383
169
 
384
170
    @staticmethod
385
171
    def from_revision_ids(pb, tree, other, base=None, other_branch=None,
386
 
                          base_branch=None, revision_graph=None,
387
 
                          tree_branch=None):
 
172
                          base_branch=None, revision_graph=None):
388
173
        """Return a Merger for revision-ids.
389
174
 
390
 
        :param pb: A progress indicator
391
175
        :param tree: The tree to merge changes into
392
176
        :param other: The revision-id to use as OTHER
393
177
        :param base: The revision-id to use as BASE.  If not specified, will
398
182
            not supplied, other_branch or tree.branch will be used.
399
183
        :param revision_graph: If you have a revision_graph precomputed, pass
400
184
            it in, otherwise it will be created for you.
401
 
        :param tree_branch: The branch associated with tree.  If not supplied,
402
 
            tree.branch will be used.
 
185
        :param pb: A progress indicator
403
186
        """
404
 
        if tree_branch is None:
405
 
            tree_branch = tree.branch
406
 
        merger = Merger(tree_branch, this_tree=tree, pb=pb,
 
187
        merger = Merger(tree.branch, this_tree=tree, pb=pb,
407
188
                        revision_graph=revision_graph)
408
189
        if other_branch is None:
409
190
            other_branch = tree.branch
428
209
        return self._cached_trees[revision_id]
429
210
 
430
211
    def _get_tree(self, treespec, possible_transports=None):
 
212
        from bzrlib import workingtree
431
213
        location, revno = treespec
432
214
        if revno is None:
433
215
            tree = workingtree.WorkingTree.open_containing(location)[0]
434
216
            return tree.branch, tree
435
 
        branch = _mod_branch.Branch.open_containing(
436
 
            location, possible_transports)[0]
 
217
        branch = Branch.open_containing(location, possible_transports)[0]
437
218
        if revno == -1:
438
219
            revision_id = branch.last_revision()
439
220
        else:
440
221
            revision_id = branch.get_rev_id(revno)
441
 
        revision_id = _mod_revision.ensure_null(revision_id)
 
222
        revision_id = ensure_null(revision_id)
442
223
        return branch, self.revision_tree(revision_id, branch)
443
224
 
444
 
    @deprecated_method(deprecated_in((2, 1, 0)))
445
225
    def ensure_revision_trees(self):
446
226
        if self.this_revision_tree is None:
447
227
            self.this_basis_tree = self.revision_tree(self.this_basis)
450
230
 
451
231
        if self.other_rev_id is None:
452
232
            other_basis_tree = self.revision_tree(self.other_basis)
453
 
            if other_basis_tree.has_changes(self.other_tree):
454
 
                raise errors.WorkingTreeNotRevision(self.this_tree)
 
233
            changes = other_basis_tree.changes_from(self.other_tree)
 
234
            if changes.has_changed():
 
235
                raise WorkingTreeNotRevision(self.this_tree)
455
236
            other_rev_id = self.other_basis
456
237
            self.other_tree = other_basis_tree
457
238
 
458
 
    @deprecated_method(deprecated_in((2, 1, 0)))
459
239
    def file_revisions(self, file_id):
460
240
        self.ensure_revision_trees()
461
241
        def get_id(tree, file_id):
464
244
        if self.this_rev_id is None:
465
245
            if self.this_basis_tree.get_file_sha1(file_id) != \
466
246
                self.this_tree.get_file_sha1(file_id):
467
 
                raise errors.WorkingTreeNotRevision(self.this_tree)
 
247
                raise WorkingTreeNotRevision(self.this_tree)
468
248
 
469
249
        trees = (self.this_basis_tree, self.other_tree)
470
250
        return [get_id(tree, file_id) for tree in trees]
471
251
 
472
 
    @deprecated_method(deprecated_in((2, 1, 0)))
473
252
    def check_basis(self, check_clean, require_commits=True):
474
253
        if self.this_basis is None and require_commits is True:
475
 
            raise errors.BzrCommandError(
476
 
                "This branch has no commits."
477
 
                " (perhaps you would prefer 'bzr pull')")
 
254
            raise BzrCommandError("This branch has no commits."
 
255
                                  " (perhaps you would prefer 'bzr pull')")
478
256
        if check_clean:
479
257
            self.compare_basis()
480
258
            if self.this_basis != self.this_rev_id:
481
259
                raise errors.UncommittedChanges(self.this_tree)
482
260
 
483
 
    @deprecated_method(deprecated_in((2, 1, 0)))
484
261
    def compare_basis(self):
485
262
        try:
486
263
            basis_tree = self.revision_tree(self.this_tree.last_revision())
487
264
        except errors.NoSuchRevision:
488
265
            basis_tree = self.this_tree.basis_tree()
489
 
        if not self.this_tree.has_changes(basis_tree):
 
266
        changes = self.this_tree.changes_from(basis_tree)
 
267
        if not changes.has_changed():
490
268
            self.this_rev_id = self.this_basis
491
269
 
492
270
    def set_interesting_files(self, file_list):
493
271
        self.interesting_files = file_list
494
272
 
495
273
    def set_pending(self):
496
 
        if (not self.base_is_ancestor or not self.base_is_other_ancestor
497
 
            or self.other_rev_id is None):
 
274
        if not self.base_is_ancestor or not self.base_is_other_ancestor or self.other_rev_id is None:
498
275
            return
499
276
        self._add_parent()
500
277
 
501
278
    def _add_parent(self):
502
279
        new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
503
280
        new_parent_trees = []
504
 
        operation = OperationWithCleanups(self.this_tree.set_parent_trees)
505
281
        for revision_id in new_parents:
506
282
            try:
507
283
                tree = self.revision_tree(revision_id)
509
285
                tree = None
510
286
            else:
511
287
                tree.lock_read()
512
 
                operation.add_cleanup(tree.unlock)
513
288
            new_parent_trees.append((revision_id, tree))
514
 
        operation.run_simple(new_parent_trees, allow_leftmost_as_ghost=True)
 
289
        try:
 
290
            self.this_tree.set_parent_trees(new_parent_trees,
 
291
                                            allow_leftmost_as_ghost=True)
 
292
        finally:
 
293
            for _revision_id, tree in new_parent_trees:
 
294
                if tree is not None:
 
295
                    tree.unlock()
515
296
 
516
297
    def set_other(self, other_revision, possible_transports=None):
517
298
        """Set the revision and tree to merge from.
526
307
            self.other_rev_id = _mod_revision.ensure_null(
527
308
                self.other_branch.last_revision())
528
309
            if _mod_revision.is_null(self.other_rev_id):
529
 
                raise errors.NoCommits(self.other_branch)
 
310
                raise NoCommits(self.other_branch)
530
311
            self.other_basis = self.other_rev_id
531
312
        elif other_revision[1] is not None:
532
313
            self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
535
316
            self.other_rev_id = None
536
317
            self.other_basis = self.other_branch.last_revision()
537
318
            if self.other_basis is None:
538
 
                raise errors.NoCommits(self.other_branch)
 
319
                raise NoCommits(self.other_branch)
539
320
        if self.other_rev_id is not None:
540
321
            self._cached_trees[self.other_rev_id] = self.other_tree
541
322
        self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
565
346
 
566
347
    def _maybe_fetch(self, source, target, revision_id):
567
348
        if not source.repository.has_same_location(target.repository):
568
 
            try:
569
 
                tags_to_fetch = set(source.tags.get_reverse_tag_dict())
570
 
            except errors.TagsNotSupported:
571
 
                tags_to_fetch = None
572
 
            fetch_spec = _mod_graph.NotInOtherForRevs(target.repository,
573
 
                source.repository, [revision_id],
574
 
                if_present_ids=tags_to_fetch).execute()
575
 
            target.fetch(source, fetch_spec=fetch_spec)
 
349
            target.fetch(source, revision_id)
576
350
 
577
351
    def find_base(self):
578
 
        revisions = [_mod_revision.ensure_null(self.this_basis),
579
 
                     _mod_revision.ensure_null(self.other_basis)]
580
 
        if _mod_revision.NULL_REVISION in revisions:
581
 
            self.base_rev_id = _mod_revision.NULL_REVISION
582
 
            self.base_tree = self.revision_tree(self.base_rev_id)
583
 
            self._is_criss_cross = False
 
352
        revisions = [ensure_null(self.this_basis),
 
353
                     ensure_null(self.other_basis)]
 
354
        if NULL_REVISION in revisions:
 
355
            self.base_rev_id = NULL_REVISION
584
356
        else:
585
 
            lcas = self.revision_graph.find_lca(revisions[0], revisions[1])
586
 
            self._is_criss_cross = False
587
 
            if len(lcas) == 0:
588
 
                self.base_rev_id = _mod_revision.NULL_REVISION
589
 
            elif len(lcas) == 1:
590
 
                self.base_rev_id = list(lcas)[0]
591
 
            else: # len(lcas) > 1
592
 
                self._is_criss_cross = True
593
 
                if len(lcas) > 2:
594
 
                    # find_unique_lca can only handle 2 nodes, so we have to
595
 
                    # start back at the beginning. It is a shame to traverse
596
 
                    # the graph again, but better than re-implementing
597
 
                    # find_unique_lca.
598
 
                    self.base_rev_id = self.revision_graph.find_unique_lca(
599
 
                                            revisions[0], revisions[1])
600
 
                else:
601
 
                    self.base_rev_id = self.revision_graph.find_unique_lca(
602
 
                                            *lcas)
603
 
                sorted_lca_keys = self.revision_graph.find_merge_order(                
604
 
                    revisions[0], lcas)
605
 
                if self.base_rev_id == _mod_revision.NULL_REVISION:
606
 
                    self.base_rev_id = sorted_lca_keys[0]
607
 
                
608
 
            if self.base_rev_id == _mod_revision.NULL_REVISION:
609
 
                raise errors.UnrelatedBranches()
610
 
            if self._is_criss_cross:
611
 
                trace.warning('Warning: criss-cross merge encountered.  See bzr'
612
 
                              ' help criss-cross.')
613
 
                trace.mutter('Criss-cross lcas: %r' % lcas)
614
 
                if self.base_rev_id in lcas:
615
 
                    trace.mutter('Unable to find unique lca. '
616
 
                                 'Fallback %r as best option.' % self.base_rev_id)
617
 
                interesting_revision_ids = set(lcas)
618
 
                interesting_revision_ids.add(self.base_rev_id)
619
 
                interesting_trees = dict((t.get_revision_id(), t)
620
 
                    for t in self.this_branch.repository.revision_trees(
621
 
                        interesting_revision_ids))
622
 
                self._cached_trees.update(interesting_trees)
623
 
                if self.base_rev_id in lcas:
624
 
                    self.base_tree = interesting_trees[self.base_rev_id]
625
 
                else:
626
 
                    self.base_tree = interesting_trees.pop(self.base_rev_id)
627
 
                self._lca_trees = [interesting_trees[key]
628
 
                                   for key in sorted_lca_keys]
629
 
            else:
630
 
                self.base_tree = self.revision_tree(self.base_rev_id)
 
357
            self.base_rev_id, steps = self.revision_graph.find_unique_lca(
 
358
                revisions[0], revisions[1], count_steps=True)
 
359
            if self.base_rev_id == NULL_REVISION:
 
360
                raise UnrelatedBranches()
 
361
            if steps > 1:
 
362
                warning('Warning: criss-cross merge encountered.  See bzr'
 
363
                        ' help criss-cross.')
 
364
        self.base_tree = self.revision_tree(self.base_rev_id)
631
365
        self.base_is_ancestor = True
632
366
        self.base_is_other_ancestor = True
633
 
        trace.mutter('Base revid: %r' % self.base_rev_id)
634
367
 
635
368
    def set_base(self, base_revision):
636
369
        """Set the base revision to use for the merge.
637
370
 
638
371
        :param base_revision: A 2-list containing a path and revision number.
639
372
        """
640
 
        trace.mutter("doing merge() with no base_revision specified")
 
373
        mutter("doing merge() with no base_revision specified")
641
374
        if base_revision == [None, None]:
642
375
            self.find_base()
643
376
        else:
656
389
                  'other_tree': self.other_tree,
657
390
                  'interesting_ids': self.interesting_ids,
658
391
                  'interesting_files': self.interesting_files,
659
 
                  'this_branch': self.this_branch,
 
392
                  'pp': self.pp,
660
393
                  'do_merge': False}
661
394
        if self.merge_type.requires_base:
662
395
            kwargs['base_tree'] = self.base_tree
663
396
        if self.merge_type.supports_reprocess:
664
397
            kwargs['reprocess'] = self.reprocess
665
398
        elif self.reprocess:
666
 
            raise errors.BzrError(
667
 
                "Conflict reduction is not supported for merge"
668
 
                " type %s." % self.merge_type)
 
399
            raise BzrError("Conflict reduction is not supported for merge"
 
400
                                  " type %s." % self.merge_type)
669
401
        if self.merge_type.supports_show_base:
670
402
            kwargs['show_base'] = self.show_base
671
403
        elif self.show_base:
672
 
            raise errors.BzrError("Showing base is not supported for this"
673
 
                                  " merge type. %s" % self.merge_type)
 
404
            raise BzrError("Showing base is not supported for this"
 
405
                           " merge type. %s" % self.merge_type)
674
406
        if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
675
407
            and not self.base_is_other_ancestor):
676
408
            raise errors.CannotReverseCherrypick()
677
409
        if self.merge_type.supports_cherrypick:
678
410
            kwargs['cherrypick'] = (not self.base_is_ancestor or
679
411
                                    not self.base_is_other_ancestor)
680
 
        if self._is_criss_cross and getattr(self.merge_type,
681
 
                                            'supports_lca_trees', False):
682
 
            kwargs['lca_trees'] = self._lca_trees
683
 
        return self.merge_type(pb=None,
 
412
        return self.merge_type(pb=self._pb,
684
413
                               change_reporter=self.change_reporter,
685
414
                               **kwargs)
686
415
 
687
 
    def _do_merge_to(self):
688
 
        merge = self.make_merger()
689
 
        if self.other_branch is not None:
690
 
            self.other_branch.update_references(self.this_branch)
691
 
        merge.do_merge()
692
 
        if self.recurse == 'down':
693
 
            for relpath, file_id in self.this_tree.iter_references():
694
 
                sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
695
 
                other_revision = self.other_tree.get_reference_revision(
696
 
                    file_id, relpath)
697
 
                if  other_revision == sub_tree.last_revision():
698
 
                    continue
699
 
                sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
700
 
                sub_merge.merge_type = self.merge_type
701
 
                other_branch = self.other_branch.reference_parent(file_id, relpath)
702
 
                sub_merge.set_other_revision(other_revision, other_branch)
703
 
                base_revision = self.base_tree.get_reference_revision(file_id)
704
 
                sub_merge.base_tree = \
705
 
                    sub_tree.branch.repository.revision_tree(base_revision)
706
 
                sub_merge.base_rev_id = base_revision
707
 
                sub_merge.do_merge()
708
 
        return merge
709
 
 
710
416
    def do_merge(self):
711
 
        operation = OperationWithCleanups(self._do_merge_to)
712
417
        self.this_tree.lock_tree_write()
713
 
        operation.add_cleanup(self.this_tree.unlock)
714
418
        if self.base_tree is not None:
715
419
            self.base_tree.lock_read()
716
 
            operation.add_cleanup(self.base_tree.unlock)
717
420
        if self.other_tree is not None:
718
421
            self.other_tree.lock_read()
719
 
            operation.add_cleanup(self.other_tree.unlock)
720
 
        merge = operation.run_simple()
 
422
        try:
 
423
            merge = self.make_merger()
 
424
            merge.do_merge()
 
425
            if self.recurse == 'down':
 
426
                for relpath, file_id in self.this_tree.iter_references():
 
427
                    sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
 
428
                    other_revision = self.other_tree.get_reference_revision(
 
429
                        file_id, relpath)
 
430
                    if  other_revision == sub_tree.last_revision():
 
431
                        continue
 
432
                    sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
 
433
                    sub_merge.merge_type = self.merge_type
 
434
                    other_branch = self.other_branch.reference_parent(file_id, relpath)
 
435
                    sub_merge.set_other_revision(other_revision, other_branch)
 
436
                    base_revision = self.base_tree.get_reference_revision(file_id)
 
437
                    sub_merge.base_tree = \
 
438
                        sub_tree.branch.repository.revision_tree(base_revision)
 
439
                    sub_merge.base_rev_id = base_revision
 
440
                    sub_merge.do_merge()
 
441
 
 
442
        finally:
 
443
            if self.other_tree is not None:
 
444
                self.other_tree.unlock()
 
445
            if self.base_tree is not None:
 
446
                self.base_tree.unlock()
 
447
            self.this_tree.unlock()
721
448
        if len(merge.cooked_conflicts) == 0:
722
 
            if not self.ignore_zero and not trace.is_quiet():
723
 
                trace.note("All changes applied successfully.")
 
449
            if not self.ignore_zero and not is_quiet():
 
450
                note("All changes applied successfully.")
724
451
        else:
725
 
            trace.note("%d conflicts encountered."
726
 
                       % len(merge.cooked_conflicts))
 
452
            note("%d conflicts encountered." % len(merge.cooked_conflicts))
727
453
 
728
454
        return len(merge.cooked_conflicts)
729
455
 
730
456
 
731
 
class _InventoryNoneEntry(object):
732
 
    """This represents an inventory entry which *isn't there*.
733
 
 
734
 
    It simplifies the merging logic if we always have an InventoryEntry, even
735
 
    if it isn't actually present
736
 
    """
737
 
    executable = None
738
 
    kind = None
739
 
    name = None
740
 
    parent_id = None
741
 
    revision = None
742
 
    symlink_target = None
743
 
    text_sha1 = None
744
 
 
745
 
_none_entry = _InventoryNoneEntry()
746
 
 
747
 
 
748
457
class Merge3Merger(object):
749
458
    """Three-way merger that uses the merge3 text merger"""
750
459
    requires_base = True
754
463
    supports_cherrypick = True
755
464
    supports_reverse_cherrypick = True
756
465
    winner_idx = {"this": 2, "other": 1, "conflict": 1}
757
 
    supports_lca_trees = True
758
466
 
759
 
    def __init__(self, working_tree, this_tree, base_tree, other_tree,
 
467
    def __init__(self, working_tree, this_tree, base_tree, other_tree, 
760
468
                 interesting_ids=None, reprocess=False, show_base=False,
761
 
                 pb=None, pp=None, change_reporter=None,
 
469
                 pb=DummyProgress(), pp=None, change_reporter=None,
762
470
                 interesting_files=None, do_merge=True,
763
 
                 cherrypick=False, lca_trees=None, this_branch=None):
 
471
                 cherrypick=False):
764
472
        """Initialize the merger object and perform the merge.
765
473
 
766
474
        :param working_tree: The working tree to apply the merge to
767
475
        :param this_tree: The local tree in the merge operation
768
476
        :param base_tree: The common tree in the merge operation
769
 
        :param other_tree: The other tree to merge changes from
770
 
        :param this_branch: The branch associated with this_tree.  Defaults to
771
 
            this_tree.branch if not supplied.
 
477
        :param other_tree: The other other tree to merge changes from
772
478
        :param interesting_ids: The file_ids of files that should be
773
479
            participate in the merge.  May not be combined with
774
480
            interesting_files.
775
481
        :param: reprocess If True, perform conflict-reduction processing.
776
482
        :param show_base: If True, show the base revision in text conflicts.
777
483
            (incompatible with reprocess)
778
 
        :param pb: ignored
 
484
        :param pb: A Progress bar
779
485
        :param pp: A ProgressPhase object
780
486
        :param change_reporter: An object that should report changes made
781
487
        :param interesting_files: The tree-relative paths of files that should
784
490
            be combined with interesting_ids.  If neither interesting_files nor
785
491
            interesting_ids is specified, all files may participate in the
786
492
            merge.
787
 
        :param lca_trees: Can be set to a dictionary of {revision_id:rev_tree}
788
 
            if the ancestry was found to include a criss-cross merge.
789
 
            Otherwise should be None.
790
493
        """
791
494
        object.__init__(self)
792
495
        if interesting_files is not None and interesting_ids is not None:
793
496
            raise ValueError(
794
497
                'specify either interesting_ids or interesting_files')
795
 
        if this_branch is None:
796
 
            this_branch = this_tree.branch
797
498
        self.interesting_ids = interesting_ids
798
499
        self.interesting_files = interesting_files
799
500
        self.this_tree = working_tree
800
501
        self.base_tree = base_tree
801
502
        self.other_tree = other_tree
802
 
        self.this_branch = this_branch
803
503
        self._raw_conflicts = []
804
504
        self.cooked_conflicts = []
805
505
        self.reprocess = reprocess
806
506
        self.show_base = show_base
807
 
        self._lca_trees = lca_trees
808
 
        # Uncommenting this will change the default algorithm to always use
809
 
        # _entries_lca. This can be useful for running the test suite and
810
 
        # making sure we haven't missed any corner cases.
811
 
        # if lca_trees is None:
812
 
        #     self._lca_trees = [self.base_tree]
 
507
        self.pb = pb
 
508
        self.pp = pp
813
509
        self.change_reporter = change_reporter
814
510
        self.cherrypick = cherrypick
 
511
        if self.pp is None:
 
512
            self.pp = ProgressPhase("Merge phase", 3, self.pb)
815
513
        if do_merge:
816
514
            self.do_merge()
817
 
        if pp is not None:
818
 
            warnings.warn("pp argument to Merge3Merger is deprecated")
819
 
        if pb is not None:
820
 
            warnings.warn("pb argument to Merge3Merger is deprecated")
821
515
 
822
516
    def do_merge(self):
823
 
        operation = OperationWithCleanups(self._do_merge)
824
517
        self.this_tree.lock_tree_write()
825
 
        operation.add_cleanup(self.this_tree.unlock)
826
518
        self.base_tree.lock_read()
827
 
        operation.add_cleanup(self.base_tree.unlock)
828
519
        self.other_tree.lock_read()
829
 
        operation.add_cleanup(self.other_tree.unlock)
830
 
        operation.run()
831
 
 
832
 
    def _do_merge(self, operation):
833
 
        self.tt = transform.TreeTransform(self.this_tree, None)
834
 
        operation.add_cleanup(self.tt.finalize)
835
 
        self._compute_transform()
836
 
        results = self.tt.apply(no_conflicts=True)
837
 
        self.write_modified(results)
 
520
        self.tt = TreeTransform(self.this_tree, self.pb)
838
521
        try:
839
 
            self.this_tree.add_conflicts(self.cooked_conflicts)
840
 
        except errors.UnsupportedOperation:
841
 
            pass
 
522
            self.pp.next_phase()
 
523
            self._compute_transform()
 
524
            self.pp.next_phase()
 
525
            results = self.tt.apply(no_conflicts=True)
 
526
            self.write_modified(results)
 
527
            try:
 
528
                self.this_tree.add_conflicts(self.cooked_conflicts)
 
529
            except UnsupportedOperation:
 
530
                pass
 
531
        finally:
 
532
            self.tt.finalize()
 
533
            self.other_tree.unlock()
 
534
            self.base_tree.unlock()
 
535
            self.this_tree.unlock()
 
536
            self.pb.clear()
842
537
 
843
538
    def make_preview_transform(self):
844
 
        operation = OperationWithCleanups(self._make_preview_transform)
845
539
        self.base_tree.lock_read()
846
 
        operation.add_cleanup(self.base_tree.unlock)
847
540
        self.other_tree.lock_read()
848
 
        operation.add_cleanup(self.other_tree.unlock)
849
 
        return operation.run_simple()
850
 
 
851
 
    def _make_preview_transform(self):
852
 
        self.tt = transform.TransformPreview(self.this_tree)
853
 
        self._compute_transform()
 
541
        self.tt = TransformPreview(self.this_tree)
 
542
        try:
 
543
            self.pp.next_phase()
 
544
            self._compute_transform()
 
545
            self.pp.next_phase()
 
546
        finally:
 
547
            self.other_tree.unlock()
 
548
            self.base_tree.unlock()
 
549
            self.pb.clear()
854
550
        return self.tt
855
551
 
856
552
    def _compute_transform(self):
857
 
        if self._lca_trees is None:
858
 
            entries = self._entries3()
859
 
            resolver = self._three_way
860
 
        else:
861
 
            entries = self._entries_lca()
862
 
            resolver = self._lca_multi_way
 
553
        entries = self._entries3()
863
554
        child_pb = ui.ui_factory.nested_progress_bar()
864
555
        try:
865
 
            factories = Merger.hooks['merge_file_content']
866
 
            hooks = [factory(self) for factory in factories] + [self]
867
 
            self.active_hooks = [hook for hook in hooks if hook is not None]
868
556
            for num, (file_id, changed, parents3, names3,
869
557
                      executable3) in enumerate(entries):
870
558
                child_pb.update('Preparing file merge', num, len(entries))
871
 
                self._merge_names(file_id, parents3, names3, resolver=resolver)
 
559
                self._merge_names(file_id, parents3, names3)
872
560
                if changed:
873
 
                    file_status = self._do_merge_contents(file_id)
 
561
                    file_status = self.merge_contents(file_id)
874
562
                else:
875
563
                    file_status = 'unmodified'
876
564
                self._merge_executable(file_id,
877
 
                    executable3, file_status, resolver=resolver)
 
565
                    executable3, file_status)
878
566
        finally:
879
567
            child_pb.finished()
880
568
        self.fix_root()
881
 
        self._finish_computing_transform()
882
 
 
883
 
    def _finish_computing_transform(self):
884
 
        """Finalize the transform and report the changes.
885
 
 
886
 
        This is the second half of _compute_transform.
887
 
        """
 
569
        self.pp.next_phase()
888
570
        child_pb = ui.ui_factory.nested_progress_bar()
889
571
        try:
890
 
            fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
891
 
                lambda t, c: transform.conflict_pass(t, c, self.other_tree))
 
572
            fs_conflicts = resolve_conflicts(self.tt, child_pb,
 
573
                lambda t, c: conflict_pass(t, c, self.other_tree))
892
574
        finally:
893
575
            child_pb.finished()
894
576
        if self.change_reporter is not None:
897
579
                self.tt.iter_changes(), self.change_reporter)
898
580
        self.cook_conflicts(fs_conflicts)
899
581
        for conflict in self.cooked_conflicts:
900
 
            trace.warning(conflict)
 
582
            warning(conflict)
901
583
 
902
584
    def _entries3(self):
903
585
        """Gather data about files modified between three trees.
912
594
        iterator = self.other_tree.iter_changes(self.base_tree,
913
595
                include_unchanged=True, specific_files=self.interesting_files,
914
596
                extra_trees=[self.this_tree])
915
 
        this_entries = dict((e.file_id, e) for p, e in
916
 
                            self.this_tree.iter_entries_by_dir(
917
 
                            self.interesting_ids))
918
597
        for (file_id, paths, changed, versioned, parents, names, kind,
919
598
             executable) in iterator:
920
599
            if (self.interesting_ids is not None and
921
600
                file_id not in self.interesting_ids):
922
601
                continue
923
 
            entry = this_entries.get(file_id)
924
 
            if entry is not None:
 
602
            if file_id in self.this_tree.inventory:
 
603
                entry = self.this_tree.inventory[file_id]
925
604
                this_name = entry.name
926
605
                this_parent = entry.parent_id
927
606
                this_executable = entry.executable
935
614
            result.append((file_id, changed, parents3, names3, executable3))
936
615
        return result
937
616
 
938
 
    def _entries_lca(self):
939
 
        """Gather data about files modified between multiple trees.
940
 
 
941
 
        This compares OTHER versus all LCA trees, and for interesting entries,
942
 
        it then compares with THIS and BASE.
943
 
 
944
 
        For the multi-valued entries, the format will be (BASE, [lca1, lca2])
945
 
        :return: [(file_id, changed, parents, names, executable)]
946
 
            file_id     Simple file_id of the entry
947
 
            changed     Boolean, True if the kind or contents changed
948
 
                        else False
949
 
            parents     ((base, [parent_id, in, lcas]), parent_id_other,
950
 
                         parent_id_this)
951
 
            names       ((base, [name, in, lcas]), name_in_other, name_in_this)
952
 
            executable  ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
953
 
        """
954
 
        if self.interesting_files is not None:
955
 
            lookup_trees = [self.this_tree, self.base_tree]
956
 
            lookup_trees.extend(self._lca_trees)
957
 
            # I think we should include the lca trees as well
958
 
            interesting_ids = self.other_tree.paths2ids(self.interesting_files,
959
 
                                                        lookup_trees)
960
 
        else:
961
 
            interesting_ids = self.interesting_ids
962
 
        result = []
963
 
        walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
964
 
 
965
 
        base_inventory = self.base_tree.inventory
966
 
        this_inventory = self.this_tree.inventory
967
 
        for path, file_id, other_ie, lca_values in walker.iter_all():
968
 
            # Is this modified at all from any of the other trees?
969
 
            if other_ie is None:
970
 
                other_ie = _none_entry
971
 
            if interesting_ids is not None and file_id not in interesting_ids:
972
 
                continue
973
 
 
974
 
            # If other_revision is found in any of the lcas, that means this
975
 
            # node is uninteresting. This is because when merging, if there are
976
 
            # multiple heads(), we have to create a new node. So if we didn't,
977
 
            # we know that the ancestry is linear, and that OTHER did not
978
 
            # modify anything
979
 
            # See doc/developers/lca_merge_resolution.txt for details
980
 
            other_revision = other_ie.revision
981
 
            if other_revision is not None:
982
 
                # We can't use this shortcut when other_revision is None,
983
 
                # because it may be None because things are WorkingTrees, and
984
 
                # not because it is *actually* None.
985
 
                is_unmodified = False
986
 
                for lca_path, ie in lca_values:
987
 
                    if ie is not None and ie.revision == other_revision:
988
 
                        is_unmodified = True
989
 
                        break
990
 
                if is_unmodified:
991
 
                    continue
992
 
 
993
 
            lca_entries = []
994
 
            for lca_path, lca_ie in lca_values:
995
 
                if lca_ie is None:
996
 
                    lca_entries.append(_none_entry)
997
 
                else:
998
 
                    lca_entries.append(lca_ie)
999
 
 
1000
 
            if file_id in base_inventory:
1001
 
                base_ie = base_inventory[file_id]
1002
 
            else:
1003
 
                base_ie = _none_entry
1004
 
 
1005
 
            if file_id in this_inventory:
1006
 
                this_ie = this_inventory[file_id]
1007
 
            else:
1008
 
                this_ie = _none_entry
1009
 
 
1010
 
            lca_kinds = []
1011
 
            lca_parent_ids = []
1012
 
            lca_names = []
1013
 
            lca_executable = []
1014
 
            for lca_ie in lca_entries:
1015
 
                lca_kinds.append(lca_ie.kind)
1016
 
                lca_parent_ids.append(lca_ie.parent_id)
1017
 
                lca_names.append(lca_ie.name)
1018
 
                lca_executable.append(lca_ie.executable)
1019
 
 
1020
 
            kind_winner = self._lca_multi_way(
1021
 
                (base_ie.kind, lca_kinds),
1022
 
                other_ie.kind, this_ie.kind)
1023
 
            parent_id_winner = self._lca_multi_way(
1024
 
                (base_ie.parent_id, lca_parent_ids),
1025
 
                other_ie.parent_id, this_ie.parent_id)
1026
 
            name_winner = self._lca_multi_way(
1027
 
                (base_ie.name, lca_names),
1028
 
                other_ie.name, this_ie.name)
1029
 
 
1030
 
            content_changed = True
1031
 
            if kind_winner == 'this':
1032
 
                # No kind change in OTHER, see if there are *any* changes
1033
 
                if other_ie.kind == 'directory':
1034
 
                    if parent_id_winner == 'this' and name_winner == 'this':
1035
 
                        # No change for this directory in OTHER, skip
1036
 
                        continue
1037
 
                    content_changed = False
1038
 
                elif other_ie.kind is None or other_ie.kind == 'file':
1039
 
                    def get_sha1(ie, tree):
1040
 
                        if ie.kind != 'file':
1041
 
                            return None
1042
 
                        return tree.get_file_sha1(file_id)
1043
 
                    base_sha1 = get_sha1(base_ie, self.base_tree)
1044
 
                    lca_sha1s = [get_sha1(ie, tree) for ie, tree
1045
 
                                 in zip(lca_entries, self._lca_trees)]
1046
 
                    this_sha1 = get_sha1(this_ie, self.this_tree)
1047
 
                    other_sha1 = get_sha1(other_ie, self.other_tree)
1048
 
                    sha1_winner = self._lca_multi_way(
1049
 
                        (base_sha1, lca_sha1s), other_sha1, this_sha1,
1050
 
                        allow_overriding_lca=False)
1051
 
                    exec_winner = self._lca_multi_way(
1052
 
                        (base_ie.executable, lca_executable),
1053
 
                        other_ie.executable, this_ie.executable)
1054
 
                    if (parent_id_winner == 'this' and name_winner == 'this'
1055
 
                        and sha1_winner == 'this' and exec_winner == 'this'):
1056
 
                        # No kind, parent, name, exec, or content change for
1057
 
                        # OTHER, so this node is not considered interesting
1058
 
                        continue
1059
 
                    if sha1_winner == 'this':
1060
 
                        content_changed = False
1061
 
                elif other_ie.kind == 'symlink':
1062
 
                    def get_target(ie, tree):
1063
 
                        if ie.kind != 'symlink':
1064
 
                            return None
1065
 
                        return tree.get_symlink_target(file_id)
1066
 
                    base_target = get_target(base_ie, self.base_tree)
1067
 
                    lca_targets = [get_target(ie, tree) for ie, tree
1068
 
                                   in zip(lca_entries, self._lca_trees)]
1069
 
                    this_target = get_target(this_ie, self.this_tree)
1070
 
                    other_target = get_target(other_ie, self.other_tree)
1071
 
                    target_winner = self._lca_multi_way(
1072
 
                        (base_target, lca_targets),
1073
 
                        other_target, this_target)
1074
 
                    if (parent_id_winner == 'this' and name_winner == 'this'
1075
 
                        and target_winner == 'this'):
1076
 
                        # No kind, parent, name, or symlink target change
1077
 
                        # not interesting
1078
 
                        continue
1079
 
                    if target_winner == 'this':
1080
 
                        content_changed = False
1081
 
                elif other_ie.kind == 'tree-reference':
1082
 
                    # The 'changed' information seems to be handled at a higher
1083
 
                    # level. At least, _entries3 returns False for content
1084
 
                    # changed, even when at a new revision_id.
1085
 
                    content_changed = False
1086
 
                    if (parent_id_winner == 'this' and name_winner == 'this'):
1087
 
                        # Nothing interesting
1088
 
                        continue
1089
 
                else:
1090
 
                    raise AssertionError('unhandled kind: %s' % other_ie.kind)
1091
 
 
1092
 
            # If we have gotten this far, that means something has changed
1093
 
            result.append((file_id, content_changed,
1094
 
                           ((base_ie.parent_id, lca_parent_ids),
1095
 
                            other_ie.parent_id, this_ie.parent_id),
1096
 
                           ((base_ie.name, lca_names),
1097
 
                            other_ie.name, this_ie.name),
1098
 
                           ((base_ie.executable, lca_executable),
1099
 
                            other_ie.executable, this_ie.executable)
1100
 
                          ))
1101
 
        return result
1102
 
 
1103
617
    def fix_root(self):
1104
 
        if self.tt.final_kind(self.tt.root) is None:
 
618
        try:
 
619
            self.tt.final_kind(self.tt.root)
 
620
        except NoSuchFile:
1105
621
            self.tt.cancel_deletion(self.tt.root)
1106
622
        if self.tt.final_file_id(self.tt.root) is None:
1107
 
            self.tt.version_file(self.tt.tree_file_id(self.tt.root),
 
623
            self.tt.version_file(self.tt.tree_file_id(self.tt.root), 
1108
624
                                 self.tt.root)
 
625
        if self.other_tree.inventory.root is None:
 
626
            return
1109
627
        other_root_file_id = self.other_tree.get_root_id()
1110
 
        if other_root_file_id is None:
1111
 
            return
1112
628
        other_root = self.tt.trans_id_file_id(other_root_file_id)
1113
629
        if other_root == self.tt.root:
1114
630
            return
 
631
        try:
 
632
            self.tt.final_kind(other_root)
 
633
        except NoSuchFile:
 
634
            return
1115
635
        if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
1116
 
            # the other tree's root is a non-root in the current tree (as when
1117
 
            # a previously unrelated branch is merged into another)
 
636
            # the other tree's root is a non-root in the current tree
1118
637
            return
1119
 
        if self.tt.final_kind(other_root) is not None:
1120
 
            other_root_is_present = True
1121
 
        else:
1122
 
            # other_root doesn't have a physical representation. We still need
1123
 
            # to move any references to the actual root of the tree.
1124
 
            other_root_is_present = False
1125
 
        # 'other_tree.inventory.root' is not present in this tree. We are
1126
 
        # calling adjust_path for children which *want* to be present with a
1127
 
        # correct place to go.
1128
 
        for thing, child in self.other_tree.inventory.root.children.iteritems():
 
638
        self.reparent_children(self.other_tree.inventory.root, self.tt.root)
 
639
        self.tt.cancel_creation(other_root)
 
640
        self.tt.cancel_versioning(other_root)
 
641
 
 
642
    def reparent_children(self, ie, target):
 
643
        for thing, child in ie.children.iteritems():
1129
644
            trans_id = self.tt.trans_id_file_id(child.file_id)
1130
 
            if not other_root_is_present:
1131
 
                if self.tt.final_kind(trans_id) is not None:
1132
 
                    # The item exist in the final tree and has a defined place
1133
 
                    # to go already.
1134
 
                    continue
1135
 
            # Move the item into the root
1136
 
            self.tt.adjust_path(self.tt.final_name(trans_id),
1137
 
                                self.tt.root, trans_id)
1138
 
        if other_root_is_present:
1139
 
            self.tt.cancel_creation(other_root)
1140
 
            self.tt.cancel_versioning(other_root)
 
645
            self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
1141
646
 
1142
647
    def write_modified(self, results):
1143
648
        modified_hashes = {}
1164
669
        if entry is None:
1165
670
            return None
1166
671
        return entry.name
1167
 
 
 
672
    
1168
673
    @staticmethod
1169
674
    def contents_sha1(tree, file_id):
1170
675
        """Determine the sha1 of the file contents (used as a key method)."""
1175
680
    @staticmethod
1176
681
    def executable(tree, file_id):
1177
682
        """Determine the executability of a file-id (used as a key method)."""
1178
 
        if not tree.has_id(file_id):
 
683
        if file_id not in tree:
1179
684
            return None
1180
685
        if tree.kind(file_id) != "file":
1181
686
            return False
1184
689
    @staticmethod
1185
690
    def kind(tree, file_id):
1186
691
        """Determine the kind of a file-id (used as a key method)."""
1187
 
        if not tree.has_id(file_id):
 
692
        if file_id not in tree:
1188
693
            return None
1189
694
        return tree.kind(file_id)
1190
695
 
1191
696
    @staticmethod
1192
697
    def _three_way(base, other, this):
 
698
        #if base == other, either they all agree, or only THIS has changed.
1193
699
        if base == other:
1194
 
            # if 'base == other', either they all agree, or only 'this' has
1195
 
            # changed.
1196
700
            return 'this'
1197
701
        elif this not in (base, other):
1198
 
            # 'this' is neither 'base' nor 'other', so both sides changed
1199
702
            return 'conflict'
 
703
        # "Ambiguous clean merge" -- both sides have made the same change.
1200
704
        elif this == other:
1201
 
            # "Ambiguous clean merge" -- both sides have made the same change.
1202
705
            return "this"
 
706
        # this == base: only other has changed.
1203
707
        else:
1204
 
            # this == base: only other has changed.
1205
708
            return "other"
1206
709
 
1207
710
    @staticmethod
1208
 
    def _lca_multi_way(bases, other, this, allow_overriding_lca=True):
1209
 
        """Consider LCAs when determining whether a change has occurred.
1210
 
 
1211
 
        If LCAS are all identical, this is the same as a _three_way comparison.
1212
 
 
1213
 
        :param bases: value in (BASE, [LCAS])
1214
 
        :param other: value in OTHER
1215
 
        :param this: value in THIS
1216
 
        :param allow_overriding_lca: If there is more than one unique lca
1217
 
            value, allow OTHER to override THIS if it has a new value, and
1218
 
            THIS only has an lca value, or vice versa. This is appropriate for
1219
 
            truly scalar values, not as much for non-scalars.
1220
 
        :return: 'this', 'other', or 'conflict' depending on whether an entry
1221
 
            changed or not.
1222
 
        """
1223
 
        # See doc/developers/lca_tree_merging.txt for details about this
1224
 
        # algorithm.
1225
 
        if other == this:
1226
 
            # Either Ambiguously clean, or nothing was actually changed. We
1227
 
            # don't really care
1228
 
            return 'this'
1229
 
        base_val, lca_vals = bases
1230
 
        # Remove 'base_val' from the lca_vals, because it is not interesting
1231
 
        filtered_lca_vals = [lca_val for lca_val in lca_vals
1232
 
                                      if lca_val != base_val]
1233
 
        if len(filtered_lca_vals) == 0:
1234
 
            return Merge3Merger._three_way(base_val, other, this)
1235
 
 
1236
 
        unique_lca_vals = set(filtered_lca_vals)
1237
 
        if len(unique_lca_vals) == 1:
1238
 
            return Merge3Merger._three_way(unique_lca_vals.pop(), other, this)
1239
 
 
1240
 
        if allow_overriding_lca:
1241
 
            if other in unique_lca_vals:
1242
 
                if this in unique_lca_vals:
1243
 
                    # Each side picked a different lca, conflict
1244
 
                    return 'conflict'
1245
 
                else:
1246
 
                    # This has a value which supersedes both lca values, and
1247
 
                    # other only has an lca value
1248
 
                    return 'this'
1249
 
            elif this in unique_lca_vals:
1250
 
                # OTHER has a value which supersedes both lca values, and this
1251
 
                # only has an lca value
1252
 
                return 'other'
1253
 
 
1254
 
        # At this point, the lcas disagree, and the tip disagree
1255
 
        return 'conflict'
1256
 
 
1257
 
    @staticmethod
1258
 
    @deprecated_method(deprecated_in((2, 2, 0)))
1259
711
    def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
1260
712
        """Do a three-way test on a scalar.
1261
713
        Return "this", "other" or "conflict", depending whether a value wins.
1276
728
 
1277
729
    def merge_names(self, file_id):
1278
730
        def get_entry(tree):
1279
 
            if tree.has_id(file_id):
 
731
            if file_id in tree.inventory:
1280
732
                return tree.inventory[file_id]
1281
733
            else:
1282
734
                return None
1293
745
            else:
1294
746
                names.append(entry.name)
1295
747
                parents.append(entry.parent_id)
1296
 
        return self._merge_names(file_id, parents, names,
1297
 
                                 resolver=self._three_way)
 
748
        return self._merge_names(file_id, parents, names)
1298
749
 
1299
 
    def _merge_names(self, file_id, parents, names, resolver):
 
750
    def _merge_names(self, file_id, parents, names):
1300
751
        """Perform a merge on file_id names and parents"""
1301
752
        base_name, other_name, this_name = names
1302
753
        base_parent, other_parent, this_parent = parents
1303
754
 
1304
 
        name_winner = resolver(*names)
 
755
        name_winner = self._three_way(*names)
1305
756
 
1306
 
        parent_id_winner = resolver(*parents)
 
757
        parent_id_winner = self._three_way(*parents)
1307
758
        if this_name is None:
1308
759
            if name_winner == "this":
1309
760
                name_winner = "other"
1311
762
                parent_id_winner = "other"
1312
763
        if name_winner == "this" and parent_id_winner == "this":
1313
764
            return
1314
 
        if name_winner == 'conflict' or parent_id_winner == 'conflict':
1315
 
            # Creating helpers (.OTHER or .THIS) here cause problems down the
1316
 
            # road if a ContentConflict needs to be created so we should not do
1317
 
            # that
1318
 
            trans_id = self.tt.trans_id_file_id(file_id)
1319
 
            self._raw_conflicts.append(('path conflict', trans_id, file_id,
1320
 
                                        this_parent, this_name,
1321
 
                                        other_parent, other_name))
 
765
        if name_winner == "conflict":
 
766
            trans_id = self.tt.trans_id_file_id(file_id)
 
767
            self._raw_conflicts.append(('name conflict', trans_id, 
 
768
                                        this_name, other_name))
 
769
        if parent_id_winner == "conflict":
 
770
            trans_id = self.tt.trans_id_file_id(file_id)
 
771
            self._raw_conflicts.append(('parent conflict', trans_id, 
 
772
                                        this_parent, other_parent))
1322
773
        if other_name is None:
1323
 
            # it doesn't matter whether the result was 'other' or
 
774
            # it doesn't matter whether the result was 'other' or 
1324
775
            # 'conflict'-- if there's no 'other', we leave it alone.
1325
776
            return
 
777
        # if we get here, name_winner and parent_winner are set to safe values.
 
778
        trans_id = self.tt.trans_id_file_id(file_id)
1326
779
        parent_id = parents[self.winner_idx[parent_id_winner]]
1327
780
        if parent_id is not None:
1328
 
            # if we get here, name_winner and parent_winner are set to safe
1329
 
            # values.
 
781
            parent_trans_id = self.tt.trans_id_file_id(parent_id)
1330
782
            self.tt.adjust_path(names[self.winner_idx[name_winner]],
1331
 
                                self.tt.trans_id_file_id(parent_id),
1332
 
                                self.tt.trans_id_file_id(file_id))
 
783
                                parent_trans_id, trans_id)
1333
784
 
1334
 
    def _do_merge_contents(self, file_id):
1335
 
        """Performs a merge on file_id contents."""
 
785
    def merge_contents(self, file_id):
 
786
        """Performa a merge on file_id contents."""
1336
787
        def contents_pair(tree):
1337
788
            if file_id not in tree:
1338
789
                return (None, None)
1345
796
                contents = None
1346
797
            return kind, contents
1347
798
 
 
799
        def contents_conflict():
 
800
            trans_id = self.tt.trans_id_file_id(file_id)
 
801
            name = self.tt.final_name(trans_id)
 
802
            parent_id = self.tt.final_parent(trans_id)
 
803
            if file_id in self.this_tree.inventory:
 
804
                self.tt.unversion_file(trans_id)
 
805
                if file_id in self.this_tree:
 
806
                    self.tt.delete_contents(trans_id)
 
807
            file_group = self._dump_conflicts(name, parent_id, file_id, 
 
808
                                              set_version=True)
 
809
            self._raw_conflicts.append(('contents conflict', file_group))
 
810
 
1348
811
        # See SPOT run.  run, SPOT, run.
1349
812
        # So we're not QUITE repeating ourselves; we do tricky things with
1350
813
        # file kind...
1351
814
        base_pair = contents_pair(self.base_tree)
1352
815
        other_pair = contents_pair(self.other_tree)
1353
 
        if self._lca_trees:
1354
 
            this_pair = contents_pair(self.this_tree)
1355
 
            lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1356
 
            winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1357
 
                                         this_pair, allow_overriding_lca=False)
1358
 
        else:
1359
 
            if base_pair == other_pair:
1360
 
                winner = 'this'
1361
 
            else:
1362
 
                # We delayed evaluating this_pair as long as we can to avoid
1363
 
                # unnecessary sha1 calculation
1364
 
                this_pair = contents_pair(self.this_tree)
1365
 
                winner = self._three_way(base_pair, other_pair, this_pair)
1366
 
        if winner == 'this':
1367
 
            # No interesting changes introduced by OTHER
1368
 
            return "unmodified"
1369
 
        # We have a hypothetical conflict, but if we have files, then we
1370
 
        # can try to merge the content
1371
 
        trans_id = self.tt.trans_id_file_id(file_id)
1372
 
        params = MergeHookParams(self, file_id, trans_id, this_pair[0],
1373
 
            other_pair[0], winner)
1374
 
        hooks = self.active_hooks
1375
 
        hook_status = 'not_applicable'
1376
 
        for hook in hooks:
1377
 
            hook_status, lines = hook.merge_contents(params)
1378
 
            if hook_status != 'not_applicable':
1379
 
                # Don't try any more hooks, this one applies.
1380
 
                break
1381
 
        result = "modified"
1382
 
        if hook_status == 'not_applicable':
1383
 
            # This is a contents conflict, because none of the available
1384
 
            # functions could merge it.
1385
 
            result = None
1386
 
            name = self.tt.final_name(trans_id)
1387
 
            parent_id = self.tt.final_parent(trans_id)
1388
 
            if self.this_tree.has_id(file_id):
1389
 
                self.tt.unversion_file(trans_id)
1390
 
            file_group = self._dump_conflicts(name, parent_id, file_id,
1391
 
                                              set_version=True)
1392
 
            self._raw_conflicts.append(('contents conflict', file_group))
1393
 
        elif hook_status == 'success':
1394
 
            self.tt.create_file(lines, trans_id)
1395
 
        elif hook_status == 'conflicted':
1396
 
            # XXX: perhaps the hook should be able to provide
1397
 
            # the BASE/THIS/OTHER files?
1398
 
            self.tt.create_file(lines, trans_id)
1399
 
            self._raw_conflicts.append(('text conflict', trans_id))
1400
 
            name = self.tt.final_name(trans_id)
1401
 
            parent_id = self.tt.final_parent(trans_id)
1402
 
            self._dump_conflicts(name, parent_id, file_id)
1403
 
        elif hook_status == 'delete':
1404
 
            self.tt.unversion_file(trans_id)
1405
 
            result = "deleted"
1406
 
        elif hook_status == 'done':
1407
 
            # The hook function did whatever it needs to do directly, no
1408
 
            # further action needed here.
1409
 
            pass
1410
 
        else:
1411
 
            raise AssertionError('unknown hook_status: %r' % (hook_status,))
1412
 
        if not self.this_tree.has_id(file_id) and result == "modified":
1413
 
            self.tt.version_file(file_id, trans_id)
1414
 
        # The merge has been performed, so the old contents should not be
1415
 
        # retained.
1416
 
        self.tt.delete_contents(trans_id)
1417
 
        return result
1418
 
 
1419
 
    def _default_other_winner_merge(self, merge_hook_params):
1420
 
        """Replace this contents with other."""
1421
 
        file_id = merge_hook_params.file_id
1422
 
        trans_id = merge_hook_params.trans_id
1423
 
        file_in_this = self.this_tree.has_id(file_id)
1424
 
        if self.other_tree.has_id(file_id):
1425
 
            # OTHER changed the file
1426
 
            wt = self.this_tree
1427
 
            if wt.supports_content_filtering():
1428
 
                # We get the path from the working tree if it exists.
1429
 
                # That fails though when OTHER is adding a file, so
1430
 
                # we fall back to the other tree to find the path if
1431
 
                # it doesn't exist locally.
1432
 
                try:
1433
 
                    filter_tree_path = wt.id2path(file_id)
1434
 
                except errors.NoSuchId:
1435
 
                    filter_tree_path = self.other_tree.id2path(file_id)
1436
 
            else:
1437
 
                # Skip the id2path lookup for older formats
1438
 
                filter_tree_path = None
1439
 
            transform.create_from_tree(self.tt, trans_id,
1440
 
                             self.other_tree, file_id,
1441
 
                             filter_tree_path=filter_tree_path)
1442
 
            return 'done', None
1443
 
        elif file_in_this:
1444
 
            # OTHER deleted the file
1445
 
            return 'delete', None
1446
 
        else:
1447
 
            raise AssertionError(
1448
 
                'winner is OTHER, but file_id %r not in THIS or OTHER tree'
1449
 
                % (file_id,))
1450
 
 
1451
 
    def merge_contents(self, merge_hook_params):
1452
 
        """Fallback merge logic after user installed hooks."""
1453
 
        # This function is used in merge hooks as the fallback instance.
1454
 
        # Perhaps making this function and the functions it calls be a 
1455
 
        # a separate class would be better.
1456
 
        if merge_hook_params.winner == 'other':
1457
 
            # OTHER is a straight winner, so replace this contents with other
1458
 
            return self._default_other_winner_merge(merge_hook_params)
1459
 
        elif merge_hook_params.is_file_merge():
1460
 
            # THIS and OTHER are both files, so text merge.  Either
1461
 
            # BASE is a file, or both converted to files, so at least we
1462
 
            # have agreement that output should be a file.
1463
 
            try:
1464
 
                self.text_merge(merge_hook_params.file_id,
1465
 
                    merge_hook_params.trans_id)
1466
 
            except errors.BinaryFile:
1467
 
                return 'not_applicable', None
1468
 
            return 'done', None
1469
 
        else:
1470
 
            return 'not_applicable', None
 
816
        if base_pair == other_pair:
 
817
            # OTHER introduced no changes
 
818
            return "unmodified"
 
819
        this_pair = contents_pair(self.this_tree)
 
820
        if this_pair == other_pair:
 
821
            # THIS and OTHER introduced the same changes
 
822
            return "unmodified"
 
823
        else:
 
824
            trans_id = self.tt.trans_id_file_id(file_id)
 
825
            if this_pair == base_pair:
 
826
                # only OTHER introduced changes
 
827
                if file_id in self.this_tree:
 
828
                    # Remove any existing contents
 
829
                    self.tt.delete_contents(trans_id)
 
830
                if file_id in self.other_tree:
 
831
                    # OTHER changed the file
 
832
                    create_by_entry(self.tt, 
 
833
                                    self.other_tree.inventory[file_id], 
 
834
                                    self.other_tree, trans_id)
 
835
                    if file_id not in self.this_tree.inventory:
 
836
                        self.tt.version_file(file_id, trans_id)
 
837
                    return "modified"
 
838
                elif file_id in self.this_tree.inventory:
 
839
                    # OTHER deleted the file
 
840
                    self.tt.unversion_file(trans_id)
 
841
                    return "deleted"
 
842
            #BOTH THIS and OTHER introduced changes; scalar conflict
 
843
            elif this_pair[0] == "file" and other_pair[0] == "file":
 
844
                # THIS and OTHER are both files, so text merge.  Either
 
845
                # BASE is a file, or both converted to files, so at least we
 
846
                # have agreement that output should be a file.
 
847
                try:
 
848
                    self.text_merge(file_id, trans_id)
 
849
                except BinaryFile:
 
850
                    return contents_conflict()
 
851
                if file_id not in self.this_tree.inventory:
 
852
                    self.tt.version_file(file_id, trans_id)
 
853
                try:
 
854
                    self.tt.tree_kind(trans_id)
 
855
                    self.tt.delete_contents(trans_id)
 
856
                except NoSuchFile:
 
857
                    pass
 
858
                return "modified"
 
859
            else:
 
860
                # Scalar conflict, can't text merge.  Dump conflicts
 
861
                return contents_conflict()
1471
862
 
1472
863
    def get_lines(self, tree, file_id):
1473
864
        """Return the lines in a file, or an empty list."""
1474
 
        if tree.has_id(file_id):
1475
 
            return tree.get_file_lines(file_id)
 
865
        if file_id in tree:
 
866
            return tree.get_file(file_id).readlines()
1476
867
        else:
1477
868
            return []
1478
869
 
1480
871
        """Perform a three-way text merge on a file_id"""
1481
872
        # it's possible that we got here with base as a different type.
1482
873
        # if so, we just want two-way text conflicts.
1483
 
        if self.base_tree.has_id(file_id) and \
 
874
        if file_id in self.base_tree and \
1484
875
            self.base_tree.kind(file_id) == "file":
1485
876
            base_lines = self.get_lines(self.base_tree, file_id)
1486
877
        else:
1487
878
            base_lines = []
1488
879
        other_lines = self.get_lines(self.other_tree, file_id)
1489
880
        this_lines = self.get_lines(self.this_tree, file_id)
1490
 
        m3 = merge3.Merge3(base_lines, this_lines, other_lines,
1491
 
                           is_cherrypick=self.cherrypick)
 
881
        m3 = Merge3(base_lines, this_lines, other_lines,
 
882
                    is_cherrypick=self.cherrypick)
1492
883
        start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
1493
884
        if self.show_base is True:
1494
885
            base_marker = '|' * 7
1497
888
 
1498
889
        def iter_merge3(retval):
1499
890
            retval["text_conflicts"] = False
1500
 
            for line in m3.merge_lines(name_a = "TREE",
1501
 
                                       name_b = "MERGE-SOURCE",
 
891
            for line in m3.merge_lines(name_a = "TREE", 
 
892
                                       name_b = "MERGE-SOURCE", 
1502
893
                                       name_base = "BASE-REVISION",
1503
 
                                       start_marker=start_marker,
 
894
                                       start_marker=start_marker, 
1504
895
                                       base_marker=base_marker,
1505
896
                                       reprocess=self.reprocess):
1506
897
                if line.startswith(start_marker):
1515
906
            self._raw_conflicts.append(('text conflict', trans_id))
1516
907
            name = self.tt.final_name(trans_id)
1517
908
            parent_id = self.tt.final_parent(trans_id)
1518
 
            file_group = self._dump_conflicts(name, parent_id, file_id,
 
909
            file_group = self._dump_conflicts(name, parent_id, file_id, 
1519
910
                                              this_lines, base_lines,
1520
911
                                              other_lines)
1521
912
            file_group.append(trans_id)
1522
913
 
1523
 
    def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
 
914
    def _dump_conflicts(self, name, parent_id, file_id, this_lines=None, 
1524
915
                        base_lines=None, other_lines=None, set_version=False,
1525
916
                        no_base=False):
1526
917
        """Emit conflict files.
1528
919
        determined automatically.  If set_version is true, the .OTHER, .THIS
1529
920
        or .BASE (in that order) will be created as versioned files.
1530
921
        """
1531
 
        data = [('OTHER', self.other_tree, other_lines),
 
922
        data = [('OTHER', self.other_tree, other_lines), 
1532
923
                ('THIS', self.this_tree, this_lines)]
1533
924
        if not no_base:
1534
925
            data.append(('BASE', self.base_tree, base_lines))
1535
 
 
1536
 
        # We need to use the actual path in the working tree of the file here,
1537
 
        # ignoring the conflict suffixes
1538
 
        wt = self.this_tree
1539
 
        if wt.supports_content_filtering():
1540
 
            try:
1541
 
                filter_tree_path = wt.id2path(file_id)
1542
 
            except errors.NoSuchId:
1543
 
                # file has been deleted
1544
 
                filter_tree_path = None
1545
 
        else:
1546
 
            # Skip the id2path lookup for older formats
1547
 
            filter_tree_path = None
1548
 
 
1549
926
        versioned = False
1550
927
        file_group = []
1551
928
        for suffix, tree, lines in data:
1552
 
            if tree.has_id(file_id):
 
929
            if file_id in tree:
1553
930
                trans_id = self._conflict_file(name, parent_id, tree, file_id,
1554
 
                                               suffix, lines, filter_tree_path)
 
931
                                               suffix, lines)
1555
932
                file_group.append(trans_id)
1556
933
                if set_version and not versioned:
1557
934
                    self.tt.version_file(file_id, trans_id)
1558
935
                    versioned = True
1559
936
        return file_group
1560
 
 
1561
 
    def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1562
 
                       lines=None, filter_tree_path=None):
 
937
           
 
938
    def _conflict_file(self, name, parent_id, tree, file_id, suffix, 
 
939
                       lines=None):
1563
940
        """Emit a single conflict file."""
1564
941
        name = name + '.' + suffix
1565
942
        trans_id = self.tt.create_path(name, parent_id)
1566
 
        transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
1567
 
            filter_tree_path)
 
943
        entry = tree.inventory[file_id]
 
944
        create_by_entry(self.tt, entry, tree, trans_id, lines)
1568
945
        return trans_id
1569
946
 
1570
947
    def merge_executable(self, file_id, file_status):
1571
948
        """Perform a merge on the execute bit."""
1572
949
        executable = [self.executable(t, file_id) for t in (self.base_tree,
1573
950
                      self.other_tree, self.this_tree)]
1574
 
        self._merge_executable(file_id, executable, file_status,
1575
 
                               resolver=self._three_way)
 
951
        self._merge_executable(file_id, executable, file_status)
1576
952
 
1577
 
    def _merge_executable(self, file_id, executable, file_status,
1578
 
                          resolver):
 
953
    def _merge_executable(self, file_id, executable, file_status):
1579
954
        """Perform a merge on the execute bit."""
1580
955
        base_executable, other_executable, this_executable = executable
1581
956
        if file_status == "deleted":
1582
957
            return
1583
 
        winner = resolver(*executable)
 
958
        winner = self._three_way(*executable)
1584
959
        if winner == "conflict":
1585
960
        # There must be a None in here, if we have a conflict, but we
1586
961
        # need executability since file status was not deleted.
1591
966
        if winner == 'this' and file_status != "modified":
1592
967
            return
1593
968
        trans_id = self.tt.trans_id_file_id(file_id)
1594
 
        if self.tt.final_kind(trans_id) != "file":
 
969
        try:
 
970
            if self.tt.final_kind(trans_id) != "file":
 
971
                return
 
972
        except NoSuchFile:
1595
973
            return
1596
974
        if winner == "this":
1597
975
            executability = this_executable
1598
976
        else:
1599
 
            if self.other_tree.has_id(file_id):
 
977
            if file_id in self.other_tree:
1600
978
                executability = other_executable
1601
 
            elif self.this_tree.has_id(file_id):
 
979
            elif file_id in self.this_tree:
1602
980
                executability = this_executable
1603
 
            elif self.base_tree_has_id(file_id):
 
981
            elif file_id in self.base_tree:
1604
982
                executability = base_executable
1605
983
        if executability is not None:
1606
984
            trans_id = self.tt.trans_id_file_id(file_id)
1608
986
 
1609
987
    def cook_conflicts(self, fs_conflicts):
1610
988
        """Convert all conflicts into a form that doesn't depend on trans_id"""
1611
 
        self.cooked_conflicts.extend(transform.cook_conflicts(
1612
 
                fs_conflicts, self.tt))
1613
 
        fp = transform.FinalPaths(self.tt)
 
989
        from conflicts import Conflict
 
990
        name_conflicts = {}
 
991
        self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
 
992
        fp = FinalPaths(self.tt)
1614
993
        for conflict in self._raw_conflicts:
1615
994
            conflict_type = conflict[0]
1616
 
            if conflict_type == 'path conflict':
1617
 
                (trans_id, file_id,
1618
 
                this_parent, this_name,
1619
 
                other_parent, other_name) = conflict[1:]
1620
 
                if this_parent is None or this_name is None:
1621
 
                    this_path = '<deleted>'
1622
 
                else:
1623
 
                    parent_path =  fp.get_path(
1624
 
                        self.tt.trans_id_file_id(this_parent))
1625
 
                    this_path = osutils.pathjoin(parent_path, this_name)
1626
 
                if other_parent is None or other_name is None:
1627
 
                    other_path = '<deleted>'
1628
 
                else:
1629
 
                    parent_path =  fp.get_path(
1630
 
                        self.tt.trans_id_file_id(other_parent))
1631
 
                    other_path = osutils.pathjoin(parent_path, other_name)
1632
 
                c = _mod_conflicts.Conflict.factory(
1633
 
                    'path conflict', path=this_path,
1634
 
                    conflict_path=other_path,
1635
 
                    file_id=file_id)
1636
 
            elif conflict_type == 'contents conflict':
 
995
            if conflict_type in ('name conflict', 'parent conflict'):
 
996
                trans_id = conflict[1]
 
997
                conflict_args = conflict[2:]
 
998
                if trans_id not in name_conflicts:
 
999
                    name_conflicts[trans_id] = {}
 
1000
                unique_add(name_conflicts[trans_id], conflict_type, 
 
1001
                           conflict_args)
 
1002
            if conflict_type == 'contents conflict':
1637
1003
                for trans_id in conflict[1]:
1638
1004
                    file_id = self.tt.final_file_id(trans_id)
1639
1005
                    if file_id is not None:
1643
1009
                    if path.endswith(suffix):
1644
1010
                        path = path[:-len(suffix)]
1645
1011
                        break
1646
 
                c = _mod_conflicts.Conflict.factory(conflict_type,
1647
 
                                                    path=path, file_id=file_id)
1648
 
            elif conflict_type == 'text conflict':
 
1012
                c = Conflict.factory(conflict_type, path=path, file_id=file_id)
 
1013
                self.cooked_conflicts.append(c)
 
1014
            if conflict_type == 'text conflict':
1649
1015
                trans_id = conflict[1]
1650
1016
                path = fp.get_path(trans_id)
1651
1017
                file_id = self.tt.final_file_id(trans_id)
1652
 
                c = _mod_conflicts.Conflict.factory(conflict_type,
1653
 
                                                    path=path, file_id=file_id)
 
1018
                c = Conflict.factory(conflict_type, path=path, file_id=file_id)
 
1019
                self.cooked_conflicts.append(c)
 
1020
 
 
1021
        for trans_id, conflicts in name_conflicts.iteritems():
 
1022
            try:
 
1023
                this_parent, other_parent = conflicts['parent conflict']
 
1024
                if this_parent == other_parent:
 
1025
                    raise AssertionError()
 
1026
            except KeyError:
 
1027
                this_parent = other_parent = \
 
1028
                    self.tt.final_file_id(self.tt.final_parent(trans_id))
 
1029
            try:
 
1030
                this_name, other_name = conflicts['name conflict']
 
1031
                if this_name == other_name:
 
1032
                    raise AssertionError()
 
1033
            except KeyError:
 
1034
                this_name = other_name = self.tt.final_name(trans_id)
 
1035
            other_path = fp.get_path(trans_id)
 
1036
            if this_parent is not None and this_name is not None:
 
1037
                this_parent_path = \
 
1038
                    fp.get_path(self.tt.trans_id_file_id(this_parent))
 
1039
                this_path = pathjoin(this_parent_path, this_name)
1654
1040
            else:
1655
 
                raise AssertionError('bad conflict type: %r' % (conflict,))
 
1041
                this_path = "<deleted>"
 
1042
            file_id = self.tt.final_file_id(trans_id)
 
1043
            c = Conflict.factory('path conflict', path=this_path,
 
1044
                                 conflict_path=other_path, file_id=file_id)
1656
1045
            self.cooked_conflicts.append(c)
1657
 
        self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
 
1046
        self.cooked_conflicts.sort(key=Conflict.sort_key)
1658
1047
 
1659
1048
 
1660
1049
class WeaveMerger(Merge3Merger):
1664
1053
    supports_reverse_cherrypick = False
1665
1054
    history_based = True
1666
1055
 
1667
 
    def _generate_merge_plan(self, file_id, base):
1668
 
        return self.this_tree.plan_file_merge(file_id, self.other_tree,
 
1056
    def _merged_lines(self, file_id):
 
1057
        """Generate the merged lines.
 
1058
        There is no distinction between lines that are meant to contain <<<<<<<
 
1059
        and conflicts.
 
1060
        """
 
1061
        if self.cherrypick:
 
1062
            base = self.base_tree
 
1063
        else:
 
1064
            base = None
 
1065
        plan = self.this_tree.plan_file_merge(file_id, self.other_tree,
1669
1066
                                              base=base)
1670
 
 
1671
 
    def _merged_lines(self, file_id):
1672
 
        """Generate the merged lines.
1673
 
        There is no distinction between lines that are meant to contain <<<<<<<
1674
 
        and conflicts.
1675
 
        """
1676
 
        if self.cherrypick:
1677
 
            base = self.base_tree
1678
 
        else:
1679
 
            base = None
1680
 
        plan = self._generate_merge_plan(file_id, base)
1681
1067
        if 'merge' in debug.debug_flags:
1682
1068
            plan = list(plan)
1683
1069
            trans_id = self.tt.trans_id_file_id(file_id)
1684
1070
            name = self.tt.final_name(trans_id) + '.plan'
1685
 
            contents = ('%11s|%s' % l for l in plan)
 
1071
            contents = ('%10s|%s' % l for l in plan)
1686
1072
            self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1687
 
        textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1688
 
                                                 '>>>>>>> MERGE-SOURCE\n')
1689
 
        lines, conflicts = textmerge.merge_lines(self.reprocess)
1690
 
        if conflicts:
1691
 
            base_lines = textmerge.base_from_plan()
1692
 
        else:
1693
 
            base_lines = None
1694
 
        return lines, base_lines
 
1073
        textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
 
1074
            '>>>>>>> MERGE-SOURCE\n')
 
1075
        return textmerge.merge_lines(self.reprocess)
1695
1076
 
1696
1077
    def text_merge(self, file_id, trans_id):
1697
1078
        """Perform a (weave) text merge for a given file and file-id.
1698
1079
        If conflicts are encountered, .THIS and .OTHER files will be emitted,
1699
1080
        and a conflict will be noted.
1700
1081
        """
1701
 
        lines, base_lines = self._merged_lines(file_id)
 
1082
        lines, conflicts = self._merged_lines(file_id)
1702
1083
        lines = list(lines)
1703
 
        # Note we're checking whether the OUTPUT is binary in this case,
 
1084
        # Note we're checking whether the OUTPUT is binary in this case, 
1704
1085
        # because we don't want to get into weave merge guts.
1705
 
        textfile.check_text_lines(lines)
 
1086
        check_text_lines(lines)
1706
1087
        self.tt.create_file(lines, trans_id)
1707
 
        if base_lines is not None:
1708
 
            # Conflict
 
1088
        if conflicts:
1709
1089
            self._raw_conflicts.append(('text conflict', trans_id))
1710
1090
            name = self.tt.final_name(trans_id)
1711
1091
            parent_id = self.tt.final_parent(trans_id)
1712
 
            file_group = self._dump_conflicts(name, parent_id, file_id,
1713
 
                                              no_base=False,
1714
 
                                              base_lines=base_lines)
 
1092
            file_group = self._dump_conflicts(name, parent_id, file_id, 
 
1093
                                              no_base=True)
1715
1094
            file_group.append(trans_id)
1716
1095
 
1717
1096
 
1718
1097
class LCAMerger(WeaveMerger):
1719
1098
 
1720
 
    def _generate_merge_plan(self, file_id, base):
1721
 
        return self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
 
1099
    def _merged_lines(self, file_id):
 
1100
        """Generate the merged lines.
 
1101
        There is no distinction between lines that are meant to contain <<<<<<<
 
1102
        and conflicts.
 
1103
        """
 
1104
        if self.cherrypick:
 
1105
            base = self.base_tree
 
1106
        else:
 
1107
            base = None
 
1108
        plan = self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1722
1109
                                                  base=base)
 
1110
        if 'merge' in debug.debug_flags:
 
1111
            plan = list(plan)
 
1112
            trans_id = self.tt.trans_id_file_id(file_id)
 
1113
            name = self.tt.final_name(trans_id) + '.plan'
 
1114
            contents = ('%10s|%s' % l for l in plan)
 
1115
            self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
 
1116
        textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
 
1117
            '>>>>>>> MERGE-SOURCE\n')
 
1118
        return textmerge.merge_lines(self.reprocess)
 
1119
 
1723
1120
 
1724
1121
class Diff3Merger(Merge3Merger):
1725
1122
    """Three-way merger using external diff3 for text merging"""
1726
1123
 
1727
1124
    def dump_file(self, temp_dir, name, tree, file_id):
1728
 
        out_path = osutils.pathjoin(temp_dir, name)
 
1125
        out_path = pathjoin(temp_dir, name)
1729
1126
        out_file = open(out_path, "wb")
1730
1127
        try:
1731
1128
            in_file = tree.get_file(file_id)
1743
1140
        import bzrlib.patch
1744
1141
        temp_dir = osutils.mkdtemp(prefix="bzr-")
1745
1142
        try:
1746
 
            new_file = osutils.pathjoin(temp_dir, "new")
 
1143
            new_file = pathjoin(temp_dir, "new")
1747
1144
            this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
1748
1145
            base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
1749
1146
            other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
1750
1147
            status = bzrlib.patch.diff3(new_file, this, base, other)
1751
1148
            if status not in (0, 1):
1752
 
                raise errors.BzrError("Unhandled diff3 exit code")
 
1149
                raise BzrError("Unhandled diff3 exit code")
1753
1150
            f = open(new_file, 'rb')
1754
1151
            try:
1755
1152
                self.tt.create_file(f, trans_id)
1764
1161
            osutils.rmtree(temp_dir)
1765
1162
 
1766
1163
 
1767
 
class PathNotInTree(errors.BzrError):
1768
 
 
1769
 
    _fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
1770
 
 
1771
 
    def __init__(self, path, tree):
1772
 
        errors.BzrError.__init__(self, path=path, tree=tree)
1773
 
 
1774
 
 
1775
 
class MergeIntoMerger(Merger):
1776
 
    """Merger that understands other_tree will be merged into a subdir.
1777
 
 
1778
 
    This also changes the Merger api so that it uses real Branch, revision_id,
1779
 
    and RevisonTree objects, rather than using revision specs.
1780
 
    """
1781
 
 
1782
 
    def __init__(self, this_tree, other_branch, other_tree, target_subdir,
1783
 
            source_subpath, other_rev_id=None):
1784
 
        """Create a new MergeIntoMerger object.
1785
 
 
1786
 
        source_subpath in other_tree will be effectively copied to
1787
 
        target_subdir in this_tree.
1788
 
 
1789
 
        :param this_tree: The tree that we will be merging into.
1790
 
        :param other_branch: The Branch we will be merging from.
1791
 
        :param other_tree: The RevisionTree object we want to merge.
1792
 
        :param target_subdir: The relative path where we want to merge
1793
 
            other_tree into this_tree
1794
 
        :param source_subpath: The relative path specifying the subtree of
1795
 
            other_tree to merge into this_tree.
1796
 
        """
1797
 
        # It is assumed that we are merging a tree that is not in our current
1798
 
        # ancestry, which means we are using the "EmptyTree" as our basis.
1799
 
        null_ancestor_tree = this_tree.branch.repository.revision_tree(
1800
 
                                _mod_revision.NULL_REVISION)
1801
 
        super(MergeIntoMerger, self).__init__(
1802
 
            this_branch=this_tree.branch,
1803
 
            this_tree=this_tree,
1804
 
            other_tree=other_tree,
1805
 
            base_tree=null_ancestor_tree,
1806
 
            )
1807
 
        self._target_subdir = target_subdir
1808
 
        self._source_subpath = source_subpath
1809
 
        self.other_branch = other_branch
1810
 
        if other_rev_id is None:
1811
 
            other_rev_id = other_tree.get_revision_id()
1812
 
        self.other_rev_id = self.other_basis = other_rev_id
1813
 
        self.base_is_ancestor = True
1814
 
        self.backup_files = True
1815
 
        self.merge_type = Merge3Merger
1816
 
        self.show_base = False
1817
 
        self.reprocess = False
1818
 
        self.interesting_ids = None
1819
 
        self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
1820
 
              target_subdir=self._target_subdir,
1821
 
              source_subpath=self._source_subpath)
1822
 
        if self._source_subpath != '':
1823
 
            # If this isn't a partial merge make sure the revisions will be
1824
 
            # present.
1825
 
            self._maybe_fetch(self.other_branch, self.this_branch,
1826
 
                self.other_basis)
1827
 
 
1828
 
    def set_pending(self):
1829
 
        if self._source_subpath != '':
1830
 
            return
1831
 
        Merger.set_pending(self)
1832
 
 
1833
 
 
1834
 
class _MergeTypeParameterizer(object):
1835
 
    """Wrap a merge-type class to provide extra parameters.
1836
 
    
1837
 
    This is hack used by MergeIntoMerger to pass some extra parameters to its
1838
 
    merge_type.  Merger.do_merge() sets up its own set of parameters to pass to
1839
 
    the 'merge_type' member.  It is difficult override do_merge without
1840
 
    re-writing the whole thing, so instead we create a wrapper which will pass
1841
 
    the extra parameters.
1842
 
    """
1843
 
 
1844
 
    def __init__(self, merge_type, **kwargs):
1845
 
        self._extra_kwargs = kwargs
1846
 
        self._merge_type = merge_type
1847
 
 
1848
 
    def __call__(self, *args, **kwargs):
1849
 
        kwargs.update(self._extra_kwargs)
1850
 
        return self._merge_type(*args, **kwargs)
1851
 
 
1852
 
    def __getattr__(self, name):
1853
 
        return getattr(self._merge_type, name)
1854
 
 
1855
 
 
1856
 
class MergeIntoMergeType(Merge3Merger):
1857
 
    """Merger that incorporates a tree (or part of a tree) into another."""
1858
 
 
1859
 
    def __init__(self, *args, **kwargs):
1860
 
        """Initialize the merger object.
1861
 
 
1862
 
        :param args: See Merge3Merger.__init__'s args.
1863
 
        :param kwargs: See Merge3Merger.__init__'s keyword args, except for
1864
 
            source_subpath and target_subdir.
1865
 
        :keyword source_subpath: The relative path specifying the subtree of
1866
 
            other_tree to merge into this_tree.
1867
 
        :keyword target_subdir: The relative path where we want to merge
1868
 
            other_tree into this_tree
1869
 
        """
1870
 
        # All of the interesting work happens during Merge3Merger.__init__(),
1871
 
        # so we have have to hack in to get our extra parameters set.
1872
 
        self._source_subpath = kwargs.pop('source_subpath')
1873
 
        self._target_subdir = kwargs.pop('target_subdir')
1874
 
        super(MergeIntoMergeType, self).__init__(*args, **kwargs)
1875
 
 
1876
 
    def _compute_transform(self):
1877
 
        child_pb = ui.ui_factory.nested_progress_bar()
1878
 
        try:
1879
 
            entries = self._entries_to_incorporate()
1880
 
            entries = list(entries)
1881
 
            for num, (entry, parent_id) in enumerate(entries):
1882
 
                child_pb.update('Preparing file merge', num, len(entries))
1883
 
                parent_trans_id = self.tt.trans_id_file_id(parent_id)
1884
 
                trans_id = transform.new_by_entry(self.tt, entry,
1885
 
                    parent_trans_id, self.other_tree)
1886
 
        finally:
1887
 
            child_pb.finished()
1888
 
        self._finish_computing_transform()
1889
 
 
1890
 
    def _entries_to_incorporate(self):
1891
 
        """Yields pairs of (inventory_entry, new_parent)."""
1892
 
        other_inv = self.other_tree.inventory
1893
 
        subdir_id = other_inv.path2id(self._source_subpath)
1894
 
        if subdir_id is None:
1895
 
            # XXX: The error would be clearer if it gave the URL of the source
1896
 
            # branch, but we don't have a reference to that here.
1897
 
            raise PathNotInTree(self._source_subpath, "Source tree")
1898
 
        subdir = other_inv[subdir_id]
1899
 
        parent_in_target = osutils.dirname(self._target_subdir)
1900
 
        target_id = self.this_tree.inventory.path2id(parent_in_target)
1901
 
        if target_id is None:
1902
 
            raise PathNotInTree(self._target_subdir, "Target tree")
1903
 
        name_in_target = osutils.basename(self._target_subdir)
1904
 
        merge_into_root = subdir.copy()
1905
 
        merge_into_root.name = name_in_target
1906
 
        if merge_into_root.file_id in self.this_tree.inventory:
1907
 
            # Give the root a new file-id.
1908
 
            # This can happen fairly easily if the directory we are
1909
 
            # incorporating is the root, and both trees have 'TREE_ROOT' as
1910
 
            # their root_id.  Users will expect this to Just Work, so we
1911
 
            # change the file-id here.
1912
 
            # Non-root file-ids could potentially conflict too.  That's really
1913
 
            # an edge case, so we don't do anything special for those.  We let
1914
 
            # them cause conflicts.
1915
 
            merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
1916
 
        yield (merge_into_root, target_id)
1917
 
        if subdir.kind != 'directory':
1918
 
            # No children, so we are done.
1919
 
            return
1920
 
        for ignored_path, entry in other_inv.iter_entries_by_dir(subdir_id):
1921
 
            parent_id = entry.parent_id
1922
 
            if parent_id == subdir.file_id:
1923
 
                # The root's parent ID has changed, so make sure children of
1924
 
                # the root refer to the new ID.
1925
 
                parent_id = merge_into_root.file_id
1926
 
            yield (entry, parent_id)
1927
 
 
1928
 
 
1929
1164
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1930
1165
                backup_files=False,
1931
1166
                merge_type=Merge3Merger,
1935
1170
                other_rev_id=None,
1936
1171
                interesting_files=None,
1937
1172
                this_tree=None,
1938
 
                pb=None,
 
1173
                pb=DummyProgress(),
1939
1174
                change_reporter=None):
1940
 
    """Primary interface for merging.
1941
 
 
1942
 
    Typical use is probably::
1943
 
 
1944
 
        merge_inner(branch, branch.get_revision_tree(other_revision),
1945
 
                    branch.get_revision_tree(base_revision))
1946
 
    """
 
1175
    """Primary interface for merging. 
 
1176
 
 
1177
        typical use is probably 
 
1178
        'merge_inner(branch, branch.get_revision_tree(other_revision),
 
1179
                     branch.get_revision_tree(base_revision))'
 
1180
        """
1947
1181
    if this_tree is None:
1948
 
        raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
1949
 
                              "parameter as of bzrlib version 0.8.")
 
1182
        raise BzrError("bzrlib.merge.merge_inner requires a this_tree "
 
1183
            "parameter as of bzrlib version 0.8.")
1950
1184
    merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1951
1185
                    pb=pb, change_reporter=change_reporter)
1952
1186
    merger.backup_files = backup_files
1965
1199
    get_revision_id = getattr(base_tree, 'get_revision_id', None)
1966
1200
    if get_revision_id is None:
1967
1201
        get_revision_id = base_tree.last_revision
1968
 
    merger.cache_trees_with_revision_ids([other_tree, base_tree, this_tree])
1969
1202
    merger.set_base_revision(get_revision_id(), this_branch)
1970
1203
    return merger.do_merge()
1971
1204
 
2039
1272
 
2040
1273
    def get_lines(self, revisions):
2041
1274
        """Get lines for revisions from the backing VersionedFiles.
2042
 
 
 
1275
        
2043
1276
        :raises RevisionNotPresent: on absent texts.
2044
1277
        """
2045
1278
        keys = [(self._key_prefix + (rev,)) for rev in revisions]
2047
1280
        for record in self.vf.get_record_stream(keys, 'unordered', True):
2048
1281
            if record.storage_kind == 'absent':
2049
1282
                raise errors.RevisionNotPresent(record.key, self.vf)
2050
 
            result[record.key[-1]] = osutils.chunks_to_lines(
2051
 
                record.get_bytes_as('chunked'))
 
1283
            result[record.key[-1]] = osutils.split_lines(
 
1284
                record.get_bytes_as('fulltext'))
2052
1285
        return result
2053
1286
 
2054
1287
    def plan_merge(self):
2170
1403
        super(_PlanMerge, self).__init__(a_rev, b_rev, vf, key_prefix)
2171
1404
        self.a_key = self._key_prefix + (self.a_rev,)
2172
1405
        self.b_key = self._key_prefix + (self.b_rev,)
2173
 
        self.graph = _mod_graph.Graph(self.vf)
 
1406
        self.graph = Graph(self.vf)
2174
1407
        heads = self.graph.heads((self.a_key, self.b_key))
2175
1408
        if len(heads) == 1:
2176
1409
            # one side dominates, so we can just return its values, yay for
2181
1414
                other = b_rev
2182
1415
            else:
2183
1416
                other = a_rev
2184
 
            trace.mutter('found dominating revision for %s\n%s > %s', self.vf,
2185
 
                         self._head_key[-1], other)
 
1417
            mutter('found dominating revision for %s\n%s > %s', self.vf,
 
1418
                   self._head_key[-1], other)
2186
1419
            self._weave = None
2187
1420
        else:
2188
1421
            self._head_key = None
2202
1435
        while True:
2203
1436
            next_lcas = self.graph.find_lca(*cur_ancestors)
2204
1437
            # Map a plain NULL_REVISION to a simple no-ancestors
2205
 
            if next_lcas == set([_mod_revision.NULL_REVISION]):
 
1438
            if next_lcas == set([NULL_REVISION]):
2206
1439
                next_lcas = ()
2207
1440
            # Order the lca's based on when they were merged into the tip
2208
1441
            # While the actual merge portion of weave merge uses a set() of
2220
1453
            elif len(next_lcas) > 2:
2221
1454
                # More than 2 lca's, fall back to grabbing all nodes between
2222
1455
                # this and the unique lca.
2223
 
                trace.mutter('More than 2 LCAs, falling back to all nodes for:'
2224
 
                             ' %s, %s\n=> %s',
2225
 
                             self.a_key, self.b_key, cur_ancestors)
 
1456
                mutter('More than 2 LCAs, falling back to all nodes for:'
 
1457
                       ' %s, %s\n=> %s', self.a_key, self.b_key, cur_ancestors)
2226
1458
                cur_lcas = next_lcas
2227
1459
                while len(cur_lcas) > 1:
2228
1460
                    cur_lcas = self.graph.find_lca(*cur_lcas)
2231
1463
                    unique_lca = None
2232
1464
                else:
2233
1465
                    unique_lca = list(cur_lcas)[0]
2234
 
                    if unique_lca == _mod_revision.NULL_REVISION:
 
1466
                    if unique_lca == NULL_REVISION:
2235
1467
                        # find_lca will return a plain 'NULL_REVISION' rather
2236
1468
                        # than a key tuple when there is no common ancestor, we
2237
1469
                        # prefer to just use None, because it doesn't confuse
2245
1477
 
2246
1478
    def _find_unique_parents(self, tip_keys, base_key):
2247
1479
        """Find ancestors of tip that aren't ancestors of base.
2248
 
 
 
1480
        
2249
1481
        :param tip_keys: Nodes that are interesting
2250
1482
        :param base_key: Cull all ancestors of this node
2251
1483
        :return: The parent map for all revisions between tip_keys and
2260
1492
            # We remove NULL_REVISION because it isn't a proper tuple key, and
2261
1493
            # thus confuses things like _get_interesting_texts, and our logic
2262
1494
            # to add the texts into the memory weave.
2263
 
            if _mod_revision.NULL_REVISION in parent_map:
2264
 
                parent_map.pop(_mod_revision.NULL_REVISION)
 
1495
            if NULL_REVISION in parent_map:
 
1496
                parent_map.pop(NULL_REVISION)
2265
1497
        else:
2266
1498
            interesting = set()
2267
1499
            for tip in tip_keys:
2311
1543
    @staticmethod
2312
1544
    def _prune_tails(parent_map, child_map, tails_to_remove):
2313
1545
        """Remove tails from the parent map.
2314
 
 
 
1546
        
2315
1547
        This will remove the supplied revisions until no more children have 0
2316
1548
        parents.
2317
1549
 
2419
1651
        lcas = graph.find_lca(key_prefix + (a_rev,), key_prefix + (b_rev,))
2420
1652
        self.lcas = set()
2421
1653
        for lca in lcas:
2422
 
            if lca == _mod_revision.NULL_REVISION:
 
1654
            if lca == NULL_REVISION:
2423
1655
                self.lcas.add(lca)
2424
1656
            else:
2425
1657
                self.lcas.add(lca[-1])