/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

Remove duplicate code.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
2
 
#
3
 
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License as published by
5
 
# the Free Software Foundation; either version 2 of the License, or
6
 
# (at your option) any later version.
7
 
#
8
 
# This program is distributed in the hope that it will be useful,
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
 
# GNU General Public License for more details.
12
 
#
13
 
# You should have received a copy of the GNU General Public License
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
 
 
17
 
import warnings
18
 
 
19
 
from bzrlib import (
20
 
    branch as _mod_branch,
21
 
    conflicts as _mod_conflicts,
22
 
    debug,
23
 
    decorators,
24
 
    errors,
25
 
    graph as _mod_graph,
26
 
    hooks,
27
 
    merge3,
28
 
    osutils,
29
 
    patiencediff,
30
 
    revision as _mod_revision,
31
 
    textfile,
32
 
    trace,
33
 
    transform,
34
 
    tree as _mod_tree,
35
 
    tsort,
36
 
    ui,
37
 
    versionedfile
38
 
    )
39
 
from bzrlib.cleanup import OperationWithCleanups
40
 
from bzrlib.symbol_versioning import (
41
 
    deprecated_in,
42
 
    deprecated_method,
43
 
    )
44
 
# TODO: Report back as changes are merged in
45
 
 
46
 
 
47
 
def transform_tree(from_tree, to_tree, interesting_ids=None):
48
 
    from_tree.lock_tree_write()
49
 
    operation = OperationWithCleanups(merge_inner)
50
 
    operation.add_cleanup(from_tree.unlock)
51
 
    operation.run_simple(from_tree.branch, to_tree, from_tree,
52
 
        ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
53
 
 
54
 
 
55
 
class MergeHooks(hooks.Hooks):
56
 
 
57
 
    def __init__(self):
58
 
        hooks.Hooks.__init__(self)
59
 
        self.create_hook(hooks.HookPoint('merge_file_content',
60
 
            "Called with a bzrlib.merge.Merger object to create a per file "
61
 
            "merge object when starting a merge. "
62
 
            "Should return either None or a subclass of "
63
 
            "``bzrlib.merge.AbstractPerFileMerger``. "
64
 
            "Such objects will then be called per file "
65
 
            "that needs to be merged (including when one "
66
 
            "side has deleted the file and the other has changed it). "
67
 
            "See the AbstractPerFileMerger API docs for details on how it is "
68
 
            "used by merge.",
69
 
            (2, 1), None))
70
 
 
71
 
 
72
 
class AbstractPerFileMerger(object):
73
 
    """PerFileMerger objects are used by plugins extending merge for bzrlib.
74
 
 
75
 
    See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
76
 
    
77
 
    :ivar merger: The Merge3Merger performing the merge.
78
 
    """
79
 
 
80
 
    def __init__(self, merger):
81
 
        """Create a PerFileMerger for use with merger."""
82
 
        self.merger = merger
83
 
 
84
 
    def merge_contents(self, merge_params):
85
 
        """Attempt to merge the contents of a single file.
86
 
        
87
 
        :param merge_params: A bzrlib.merge.MergeHookParams
88
 
        :return : A tuple of (status, chunks), where status is one of
89
 
            'not_applicable', 'success', 'conflicted', or 'delete'.  If status
90
 
            is 'success' or 'conflicted', then chunks should be an iterable of
91
 
            strings for the new file contents.
92
 
        """
93
 
        return ('not applicable', None)
94
 
 
95
 
 
96
 
class ConfigurableFileMerger(AbstractPerFileMerger):
97
 
    """Merge individual files when configured via a .conf file.
98
 
 
99
 
    This is a base class for concrete custom file merging logic. Concrete
100
 
    classes should implement ``merge_text``.
101
 
 
102
 
    See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
103
 
    
104
 
    :ivar affected_files: The configured file paths to merge.
105
 
 
106
 
    :cvar name_prefix: The prefix to use when looking up configuration
107
 
        details. <name_prefix>_merge_files describes the files targeted by the
108
 
        hook for example.
109
 
        
110
 
    :cvar default_files: The default file paths to merge when no configuration
111
 
        is present.
112
 
    """
113
 
 
114
 
    name_prefix = None
115
 
    default_files = None
116
 
 
117
 
    def __init__(self, merger):
118
 
        super(ConfigurableFileMerger, self).__init__(merger)
119
 
        self.affected_files = None
120
 
        self.default_files = self.__class__.default_files or []
121
 
        self.name_prefix = self.__class__.name_prefix
122
 
        if self.name_prefix is None:
123
 
            raise ValueError("name_prefix must be set.")
124
 
 
125
 
    def filename_matches_config(self, params):
126
 
        """Check whether the file should call the merge hook.
127
 
 
128
 
        <name_prefix>_merge_files configuration variable is a list of files
129
 
        that should use the hook.
130
 
        """
131
 
        affected_files = self.affected_files
132
 
        if affected_files is None:
133
 
            config = self.merger.this_branch.get_config()
134
 
            # Until bzr provides a better policy for caching the config, we
135
 
            # just add the part we're interested in to the params to avoid
136
 
            # reading the config files repeatedly (bazaar.conf, location.conf,
137
 
            # branch.conf).
138
 
            config_key = self.name_prefix + '_merge_files'
139
 
            affected_files = config.get_user_option_as_list(config_key)
140
 
            if affected_files is None:
141
 
                # If nothing was specified in the config, use the default.
142
 
                affected_files = self.default_files
143
 
            self.affected_files = affected_files
144
 
        if affected_files:
145
 
            filename = self.merger.this_tree.id2path(params.file_id)
146
 
            if filename in affected_files:
147
 
                return True
148
 
        return False
149
 
 
150
 
    def merge_contents(self, params):
151
 
        """Merge the contents of a single file."""
152
 
        # First, check whether this custom merge logic should be used.  We
153
 
        # expect most files should not be merged by this handler.
154
 
        if (
155
 
            # OTHER is a straight winner, rely on default merge.
156
 
            params.winner == 'other' or
157
 
            # THIS and OTHER aren't both files.
158
 
            not params.is_file_merge() or
159
 
            # The filename isn't listed in the 'NAME_merge_files' config
160
 
            # option.
161
 
            not self.filename_matches_config(params)):
162
 
            return 'not_applicable', None
163
 
        return self.merge_text(params)
164
 
 
165
 
    def merge_text(self, params):
166
 
        """Merge the byte contents of a single file.
167
 
 
168
 
        This is called after checking that the merge should be performed in
169
 
        merge_contents, and it should behave as per
170
 
        ``bzrlib.merge.AbstractPerFileMerger.merge_contents``.
171
 
        """
172
 
        raise NotImplementedError(self.merge_text)
173
 
 
174
 
 
175
 
class MergeHookParams(object):
176
 
    """Object holding parameters passed to merge_file_content hooks.
177
 
 
178
 
    There are some fields hooks can access:
179
 
 
180
 
    :ivar file_id: the file ID of the file being merged
181
 
    :ivar trans_id: the transform ID for the merge of this file
182
 
    :ivar this_kind: kind of file_id in 'this' tree
183
 
    :ivar other_kind: kind of file_id in 'other' tree
184
 
    :ivar winner: one of 'this', 'other', 'conflict'
185
 
    """
186
 
 
187
 
    def __init__(self, merger, file_id, trans_id, this_kind, other_kind,
188
 
            winner):
189
 
        self._merger = merger
190
 
        self.file_id = file_id
191
 
        self.trans_id = trans_id
192
 
        self.this_kind = this_kind
193
 
        self.other_kind = other_kind
194
 
        self.winner = winner
195
 
 
196
 
    def is_file_merge(self):
197
 
        """True if this_kind and other_kind are both 'file'."""
198
 
        return self.this_kind == 'file' and self.other_kind == 'file'
199
 
 
200
 
    @decorators.cachedproperty
201
 
    def base_lines(self):
202
 
        """The lines of the 'base' version of the file."""
203
 
        return self._merger.get_lines(self._merger.base_tree, self.file_id)
204
 
 
205
 
    @decorators.cachedproperty
206
 
    def this_lines(self):
207
 
        """The lines of the 'this' version of the file."""
208
 
        return self._merger.get_lines(self._merger.this_tree, self.file_id)
209
 
 
210
 
    @decorators.cachedproperty
211
 
    def other_lines(self):
212
 
        """The lines of the 'other' version of the file."""
213
 
        return self._merger.get_lines(self._merger.other_tree, self.file_id)
214
 
 
215
 
 
216
 
class Merger(object):
217
 
 
218
 
    hooks = MergeHooks()
219
 
 
220
 
    def __init__(self, this_branch, other_tree=None, base_tree=None,
221
 
                 this_tree=None, pb=None, change_reporter=None,
222
 
                 recurse='down', revision_graph=None):
223
 
        object.__init__(self)
224
 
        self.this_branch = this_branch
225
 
        self.this_basis = _mod_revision.ensure_null(
226
 
            this_branch.last_revision())
227
 
        self.this_rev_id = None
228
 
        self.this_tree = this_tree
229
 
        self.this_revision_tree = None
230
 
        self.this_basis_tree = None
231
 
        self.other_tree = other_tree
232
 
        self.other_branch = None
233
 
        self.base_tree = base_tree
234
 
        self.ignore_zero = False
235
 
        self.backup_files = False
236
 
        self.interesting_ids = None
237
 
        self.interesting_files = None
238
 
        self.show_base = False
239
 
        self.reprocess = False
240
 
        if pb is not None:
241
 
            warnings.warn("pb parameter to Merger() is deprecated and ignored")
242
 
        self.pp = None
243
 
        self.recurse = recurse
244
 
        self.change_reporter = change_reporter
245
 
        self._cached_trees = {}
246
 
        self._revision_graph = revision_graph
247
 
        self._base_is_ancestor = None
248
 
        self._base_is_other_ancestor = None
249
 
        self._is_criss_cross = None
250
 
        self._lca_trees = None
251
 
 
252
 
    def cache_trees_with_revision_ids(self, trees):
253
 
        """Cache any tree in trees if it has a revision_id."""
254
 
        for maybe_tree in trees:
255
 
            if maybe_tree is None:
256
 
                continue
257
 
            try:
258
 
                rev_id = maybe_tree.get_revision_id()
259
 
            except AttributeError:
260
 
                continue
261
 
            self._cached_trees[rev_id] = maybe_tree
262
 
 
263
 
    @property
264
 
    def revision_graph(self):
265
 
        if self._revision_graph is None:
266
 
            self._revision_graph = self.this_branch.repository.get_graph()
267
 
        return self._revision_graph
268
 
 
269
 
    def _set_base_is_ancestor(self, value):
270
 
        self._base_is_ancestor = value
271
 
 
272
 
    def _get_base_is_ancestor(self):
273
 
        if self._base_is_ancestor is None:
274
 
            self._base_is_ancestor = self.revision_graph.is_ancestor(
275
 
                self.base_rev_id, self.this_basis)
276
 
        return self._base_is_ancestor
277
 
 
278
 
    base_is_ancestor = property(_get_base_is_ancestor, _set_base_is_ancestor)
279
 
 
280
 
    def _set_base_is_other_ancestor(self, value):
281
 
        self._base_is_other_ancestor = value
282
 
 
283
 
    def _get_base_is_other_ancestor(self):
284
 
        if self._base_is_other_ancestor is None:
285
 
            if self.other_basis is None:
286
 
                return True
287
 
            self._base_is_other_ancestor = self.revision_graph.is_ancestor(
288
 
                self.base_rev_id, self.other_basis)
289
 
        return self._base_is_other_ancestor
290
 
 
291
 
    base_is_other_ancestor = property(_get_base_is_other_ancestor,
292
 
                                      _set_base_is_other_ancestor)
293
 
 
294
 
    @staticmethod
295
 
    def from_uncommitted(tree, other_tree, pb=None, base_tree=None):
296
 
        """Return a Merger for uncommitted changes in other_tree.
297
 
 
298
 
        :param tree: The tree to merge into
299
 
        :param other_tree: The tree to get uncommitted changes from
300
 
        :param pb: A progress indicator
301
 
        :param base_tree: The basis to use for the merge.  If unspecified,
302
 
            other_tree.basis_tree() will be used.
303
 
        """
304
 
        if base_tree is None:
305
 
            base_tree = other_tree.basis_tree()
306
 
        merger = Merger(tree.branch, other_tree, base_tree, tree, pb)
307
 
        merger.base_rev_id = merger.base_tree.get_revision_id()
308
 
        merger.other_rev_id = None
309
 
        merger.other_basis = merger.base_rev_id
310
 
        return merger
311
 
 
312
 
    @classmethod
313
 
    def from_mergeable(klass, tree, mergeable, pb):
314
 
        """Return a Merger for a bundle or merge directive.
315
 
 
316
 
        :param tree: The tree to merge changes into
317
 
        :param mergeable: A merge directive or bundle
318
 
        :param pb: A progress indicator
319
 
        """
320
 
        mergeable.install_revisions(tree.branch.repository)
321
 
        base_revision_id, other_revision_id, verified =\
322
 
            mergeable.get_merge_request(tree.branch.repository)
323
 
        revision_graph = tree.branch.repository.get_graph()
324
 
        if base_revision_id is not None:
325
 
            if (base_revision_id != _mod_revision.NULL_REVISION and
326
 
                revision_graph.is_ancestor(
327
 
                base_revision_id, tree.branch.last_revision())):
328
 
                base_revision_id = None
329
 
            else:
330
 
                trace.warning('Performing cherrypick')
331
 
        merger = klass.from_revision_ids(pb, tree, other_revision_id,
332
 
                                         base_revision_id, revision_graph=
333
 
                                         revision_graph)
334
 
        return merger, verified
335
 
 
336
 
    @staticmethod
337
 
    def from_revision_ids(pb, tree, other, base=None, other_branch=None,
338
 
                          base_branch=None, revision_graph=None,
339
 
                          tree_branch=None):
340
 
        """Return a Merger for revision-ids.
341
 
 
342
 
        :param pb: A progress indicator
343
 
        :param tree: The tree to merge changes into
344
 
        :param other: The revision-id to use as OTHER
345
 
        :param base: The revision-id to use as BASE.  If not specified, will
346
 
            be auto-selected.
347
 
        :param other_branch: A branch containing the other revision-id.  If
348
 
            not supplied, tree.branch is used.
349
 
        :param base_branch: A branch containing the base revision-id.  If
350
 
            not supplied, other_branch or tree.branch will be used.
351
 
        :param revision_graph: If you have a revision_graph precomputed, pass
352
 
            it in, otherwise it will be created for you.
353
 
        :param tree_branch: The branch associated with tree.  If not supplied,
354
 
            tree.branch will be used.
355
 
        """
356
 
        if tree_branch is None:
357
 
            tree_branch = tree.branch
358
 
        merger = Merger(tree_branch, this_tree=tree, pb=pb,
359
 
                        revision_graph=revision_graph)
360
 
        if other_branch is None:
361
 
            other_branch = tree.branch
362
 
        merger.set_other_revision(other, other_branch)
363
 
        if base is None:
364
 
            merger.find_base()
365
 
        else:
366
 
            if base_branch is None:
367
 
                base_branch = other_branch
368
 
            merger.set_base_revision(base, base_branch)
369
 
        return merger
370
 
 
371
 
    def revision_tree(self, revision_id, branch=None):
372
 
        if revision_id not in self._cached_trees:
373
 
            if branch is None:
374
 
                branch = self.this_branch
375
 
            try:
376
 
                tree = self.this_tree.revision_tree(revision_id)
377
 
            except errors.NoSuchRevisionInTree:
378
 
                tree = branch.repository.revision_tree(revision_id)
379
 
            self._cached_trees[revision_id] = tree
380
 
        return self._cached_trees[revision_id]
381
 
 
382
 
    def _get_tree(self, treespec, possible_transports=None):
383
 
        from bzrlib import workingtree
384
 
        location, revno = treespec
385
 
        if revno is None:
386
 
            tree = workingtree.WorkingTree.open_containing(location)[0]
387
 
            return tree.branch, tree
388
 
        branch = _mod_branch.Branch.open_containing(
389
 
            location, possible_transports)[0]
390
 
        if revno == -1:
391
 
            revision_id = branch.last_revision()
392
 
        else:
393
 
            revision_id = branch.get_rev_id(revno)
394
 
        revision_id = _mod_revision.ensure_null(revision_id)
395
 
        return branch, self.revision_tree(revision_id, branch)
396
 
 
397
 
    @deprecated_method(deprecated_in((2, 1, 0)))
398
 
    def ensure_revision_trees(self):
399
 
        if self.this_revision_tree is None:
400
 
            self.this_basis_tree = self.revision_tree(self.this_basis)
401
 
            if self.this_basis == self.this_rev_id:
402
 
                self.this_revision_tree = self.this_basis_tree
403
 
 
404
 
        if self.other_rev_id is None:
405
 
            other_basis_tree = self.revision_tree(self.other_basis)
406
 
            if other_basis_tree.has_changes(self.other_tree):
407
 
                raise errors.WorkingTreeNotRevision(self.this_tree)
408
 
            other_rev_id = self.other_basis
409
 
            self.other_tree = other_basis_tree
410
 
 
411
 
    @deprecated_method(deprecated_in((2, 1, 0)))
412
 
    def file_revisions(self, file_id):
413
 
        self.ensure_revision_trees()
414
 
        def get_id(tree, file_id):
415
 
            revision_id = tree.inventory[file_id].revision
416
 
            return revision_id
417
 
        if self.this_rev_id is None:
418
 
            if self.this_basis_tree.get_file_sha1(file_id) != \
419
 
                self.this_tree.get_file_sha1(file_id):
420
 
                raise errors.WorkingTreeNotRevision(self.this_tree)
421
 
 
422
 
        trees = (self.this_basis_tree, self.other_tree)
423
 
        return [get_id(tree, file_id) for tree in trees]
424
 
 
425
 
    @deprecated_method(deprecated_in((2, 1, 0)))
426
 
    def check_basis(self, check_clean, require_commits=True):
427
 
        if self.this_basis is None and require_commits is True:
428
 
            raise errors.BzrCommandError(
429
 
                "This branch has no commits."
430
 
                " (perhaps you would prefer 'bzr pull')")
431
 
        if check_clean:
432
 
            self.compare_basis()
433
 
            if self.this_basis != self.this_rev_id:
434
 
                raise errors.UncommittedChanges(self.this_tree)
435
 
 
436
 
    @deprecated_method(deprecated_in((2, 1, 0)))
437
 
    def compare_basis(self):
438
 
        try:
439
 
            basis_tree = self.revision_tree(self.this_tree.last_revision())
440
 
        except errors.NoSuchRevision:
441
 
            basis_tree = self.this_tree.basis_tree()
442
 
        if not self.this_tree.has_changes(basis_tree):
443
 
            self.this_rev_id = self.this_basis
444
 
 
445
 
    def set_interesting_files(self, file_list):
446
 
        self.interesting_files = file_list
447
 
 
448
 
    def set_pending(self):
449
 
        if (not self.base_is_ancestor or not self.base_is_other_ancestor
450
 
            or self.other_rev_id is None):
451
 
            return
452
 
        self._add_parent()
453
 
 
454
 
    def _add_parent(self):
455
 
        new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
456
 
        new_parent_trees = []
457
 
        operation = OperationWithCleanups(self.this_tree.set_parent_trees)
458
 
        for revision_id in new_parents:
459
 
            try:
460
 
                tree = self.revision_tree(revision_id)
461
 
            except errors.NoSuchRevision:
462
 
                tree = None
463
 
            else:
464
 
                tree.lock_read()
465
 
                operation.add_cleanup(tree.unlock)
466
 
            new_parent_trees.append((revision_id, tree))
467
 
        operation.run_simple(new_parent_trees, allow_leftmost_as_ghost=True)
468
 
 
469
 
    def set_other(self, other_revision, possible_transports=None):
470
 
        """Set the revision and tree to merge from.
471
 
 
472
 
        This sets the other_tree, other_rev_id, other_basis attributes.
473
 
 
474
 
        :param other_revision: The [path, revision] list to merge from.
475
 
        """
476
 
        self.other_branch, self.other_tree = self._get_tree(other_revision,
477
 
                                                            possible_transports)
478
 
        if other_revision[1] == -1:
479
 
            self.other_rev_id = _mod_revision.ensure_null(
480
 
                self.other_branch.last_revision())
481
 
            if _mod_revision.is_null(self.other_rev_id):
482
 
                raise errors.NoCommits(self.other_branch)
483
 
            self.other_basis = self.other_rev_id
484
 
        elif other_revision[1] is not None:
485
 
            self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
486
 
            self.other_basis = self.other_rev_id
487
 
        else:
488
 
            self.other_rev_id = None
489
 
            self.other_basis = self.other_branch.last_revision()
490
 
            if self.other_basis is None:
491
 
                raise errors.NoCommits(self.other_branch)
492
 
        if self.other_rev_id is not None:
493
 
            self._cached_trees[self.other_rev_id] = self.other_tree
494
 
        self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
495
 
 
496
 
    def set_other_revision(self, revision_id, other_branch):
497
 
        """Set 'other' based on a branch and revision id
498
 
 
499
 
        :param revision_id: The revision to use for a tree
500
 
        :param other_branch: The branch containing this tree
501
 
        """
502
 
        self.other_rev_id = revision_id
503
 
        self.other_branch = other_branch
504
 
        self._maybe_fetch(other_branch, self.this_branch, self.other_rev_id)
505
 
        self.other_tree = self.revision_tree(revision_id)
506
 
        self.other_basis = revision_id
507
 
 
508
 
    def set_base_revision(self, revision_id, branch):
509
 
        """Set 'base' based on a branch and revision id
510
 
 
511
 
        :param revision_id: The revision to use for a tree
512
 
        :param branch: The branch containing this tree
513
 
        """
514
 
        self.base_rev_id = revision_id
515
 
        self.base_branch = branch
516
 
        self._maybe_fetch(branch, self.this_branch, revision_id)
517
 
        self.base_tree = self.revision_tree(revision_id)
518
 
 
519
 
    def _maybe_fetch(self, source, target, revision_id):
520
 
        if not source.repository.has_same_location(target.repository):
521
 
            target.fetch(source, revision_id)
522
 
 
523
 
    def find_base(self):
524
 
        revisions = [_mod_revision.ensure_null(self.this_basis),
525
 
                     _mod_revision.ensure_null(self.other_basis)]
526
 
        if _mod_revision.NULL_REVISION in revisions:
527
 
            self.base_rev_id = _mod_revision.NULL_REVISION
528
 
            self.base_tree = self.revision_tree(self.base_rev_id)
529
 
            self._is_criss_cross = False
530
 
        else:
531
 
            lcas = self.revision_graph.find_lca(revisions[0], revisions[1])
532
 
            self._is_criss_cross = False
533
 
            if len(lcas) == 0:
534
 
                self.base_rev_id = _mod_revision.NULL_REVISION
535
 
            elif len(lcas) == 1:
536
 
                self.base_rev_id = list(lcas)[0]
537
 
            else: # len(lcas) > 1
538
 
                if len(lcas) > 2:
539
 
                    # find_unique_lca can only handle 2 nodes, so we have to
540
 
                    # start back at the beginning. It is a shame to traverse
541
 
                    # the graph again, but better than re-implementing
542
 
                    # find_unique_lca.
543
 
                    self.base_rev_id = self.revision_graph.find_unique_lca(
544
 
                                            revisions[0], revisions[1])
545
 
                else:
546
 
                    self.base_rev_id = self.revision_graph.find_unique_lca(
547
 
                                            *lcas)
548
 
                self._is_criss_cross = True
549
 
            if self.base_rev_id == _mod_revision.NULL_REVISION:
550
 
                raise errors.UnrelatedBranches()
551
 
            if self._is_criss_cross:
552
 
                trace.warning('Warning: criss-cross merge encountered.  See bzr'
553
 
                              ' help criss-cross.')
554
 
                trace.mutter('Criss-cross lcas: %r' % lcas)
555
 
                interesting_revision_ids = [self.base_rev_id]
556
 
                interesting_revision_ids.extend(lcas)
557
 
                interesting_trees = dict((t.get_revision_id(), t)
558
 
                    for t in self.this_branch.repository.revision_trees(
559
 
                        interesting_revision_ids))
560
 
                self._cached_trees.update(interesting_trees)
561
 
                self.base_tree = interesting_trees.pop(self.base_rev_id)
562
 
                sorted_lca_keys = self.revision_graph.find_merge_order(
563
 
                    revisions[0], lcas)
564
 
                self._lca_trees = [interesting_trees[key]
565
 
                                   for key in sorted_lca_keys]
566
 
            else:
567
 
                self.base_tree = self.revision_tree(self.base_rev_id)
568
 
        self.base_is_ancestor = True
569
 
        self.base_is_other_ancestor = True
570
 
        trace.mutter('Base revid: %r' % self.base_rev_id)
571
 
 
572
 
    def set_base(self, base_revision):
573
 
        """Set the base revision to use for the merge.
574
 
 
575
 
        :param base_revision: A 2-list containing a path and revision number.
576
 
        """
577
 
        trace.mutter("doing merge() with no base_revision specified")
578
 
        if base_revision == [None, None]:
579
 
            self.find_base()
580
 
        else:
581
 
            base_branch, self.base_tree = self._get_tree(base_revision)
582
 
            if base_revision[1] == -1:
583
 
                self.base_rev_id = base_branch.last_revision()
584
 
            elif base_revision[1] is None:
585
 
                self.base_rev_id = _mod_revision.NULL_REVISION
586
 
            else:
587
 
                self.base_rev_id = _mod_revision.ensure_null(
588
 
                    base_branch.get_rev_id(base_revision[1]))
589
 
            self._maybe_fetch(base_branch, self.this_branch, self.base_rev_id)
590
 
 
591
 
    def make_merger(self):
592
 
        kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
593
 
                  'other_tree': self.other_tree,
594
 
                  'interesting_ids': self.interesting_ids,
595
 
                  'interesting_files': self.interesting_files,
596
 
                  'this_branch': self.this_branch,
597
 
                  'do_merge': False}
598
 
        if self.merge_type.requires_base:
599
 
            kwargs['base_tree'] = self.base_tree
600
 
        if self.merge_type.supports_reprocess:
601
 
            kwargs['reprocess'] = self.reprocess
602
 
        elif self.reprocess:
603
 
            raise errors.BzrError(
604
 
                "Conflict reduction is not supported for merge"
605
 
                " type %s." % self.merge_type)
606
 
        if self.merge_type.supports_show_base:
607
 
            kwargs['show_base'] = self.show_base
608
 
        elif self.show_base:
609
 
            raise errors.BzrError("Showing base is not supported for this"
610
 
                                  " merge type. %s" % self.merge_type)
611
 
        if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
612
 
            and not self.base_is_other_ancestor):
613
 
            raise errors.CannotReverseCherrypick()
614
 
        if self.merge_type.supports_cherrypick:
615
 
            kwargs['cherrypick'] = (not self.base_is_ancestor or
616
 
                                    not self.base_is_other_ancestor)
617
 
        if self._is_criss_cross and getattr(self.merge_type,
618
 
                                            'supports_lca_trees', False):
619
 
            kwargs['lca_trees'] = self._lca_trees
620
 
        return self.merge_type(pb=None,
621
 
                               change_reporter=self.change_reporter,
622
 
                               **kwargs)
623
 
 
624
 
    def _do_merge_to(self):
625
 
        merge = self.make_merger()
626
 
        if self.other_branch is not None:
627
 
            self.other_branch.update_references(self.this_branch)
628
 
        merge.do_merge()
629
 
        if self.recurse == 'down':
630
 
            for relpath, file_id in self.this_tree.iter_references():
631
 
                sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
632
 
                other_revision = self.other_tree.get_reference_revision(
633
 
                    file_id, relpath)
634
 
                if  other_revision == sub_tree.last_revision():
635
 
                    continue
636
 
                sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
637
 
                sub_merge.merge_type = self.merge_type
638
 
                other_branch = self.other_branch.reference_parent(file_id, relpath)
639
 
                sub_merge.set_other_revision(other_revision, other_branch)
640
 
                base_revision = self.base_tree.get_reference_revision(file_id)
641
 
                sub_merge.base_tree = \
642
 
                    sub_tree.branch.repository.revision_tree(base_revision)
643
 
                sub_merge.base_rev_id = base_revision
644
 
                sub_merge.do_merge()
645
 
        return merge
646
 
 
647
 
    def do_merge(self):
648
 
        operation = OperationWithCleanups(self._do_merge_to)
649
 
        self.this_tree.lock_tree_write()
650
 
        operation.add_cleanup(self.this_tree.unlock)
651
 
        if self.base_tree is not None:
652
 
            self.base_tree.lock_read()
653
 
            operation.add_cleanup(self.base_tree.unlock)
654
 
        if self.other_tree is not None:
655
 
            self.other_tree.lock_read()
656
 
            operation.add_cleanup(self.other_tree.unlock)
657
 
        merge = operation.run_simple()
658
 
        if len(merge.cooked_conflicts) == 0:
659
 
            if not self.ignore_zero and not trace.is_quiet():
660
 
                trace.note("All changes applied successfully.")
661
 
        else:
662
 
            trace.note("%d conflicts encountered."
663
 
                       % len(merge.cooked_conflicts))
664
 
 
665
 
        return len(merge.cooked_conflicts)
666
 
 
667
 
 
668
 
class _InventoryNoneEntry(object):
669
 
    """This represents an inventory entry which *isn't there*.
670
 
 
671
 
    It simplifies the merging logic if we always have an InventoryEntry, even
672
 
    if it isn't actually present
673
 
    """
674
 
    executable = None
675
 
    kind = None
676
 
    name = None
677
 
    parent_id = None
678
 
    revision = None
679
 
    symlink_target = None
680
 
    text_sha1 = None
681
 
 
682
 
_none_entry = _InventoryNoneEntry()
683
 
 
684
 
 
685
 
class Merge3Merger(object):
686
 
    """Three-way merger that uses the merge3 text merger"""
687
 
    requires_base = True
688
 
    supports_reprocess = True
689
 
    supports_show_base = True
690
 
    history_based = False
691
 
    supports_cherrypick = True
692
 
    supports_reverse_cherrypick = True
693
 
    winner_idx = {"this": 2, "other": 1, "conflict": 1}
694
 
    supports_lca_trees = True
695
 
 
696
 
    def __init__(self, working_tree, this_tree, base_tree, other_tree,
697
 
                 interesting_ids=None, reprocess=False, show_base=False,
698
 
                 pb=None, pp=None, change_reporter=None,
699
 
                 interesting_files=None, do_merge=True,
700
 
                 cherrypick=False, lca_trees=None, this_branch=None):
701
 
        """Initialize the merger object and perform the merge.
702
 
 
703
 
        :param working_tree: The working tree to apply the merge to
704
 
        :param this_tree: The local tree in the merge operation
705
 
        :param base_tree: The common tree in the merge operation
706
 
        :param other_tree: The other tree to merge changes from
707
 
        :param this_branch: The branch associated with this_tree
708
 
        :param interesting_ids: The file_ids of files that should be
709
 
            participate in the merge.  May not be combined with
710
 
            interesting_files.
711
 
        :param: reprocess If True, perform conflict-reduction processing.
712
 
        :param show_base: If True, show the base revision in text conflicts.
713
 
            (incompatible with reprocess)
714
 
        :param pb: ignored
715
 
        :param pp: A ProgressPhase object
716
 
        :param change_reporter: An object that should report changes made
717
 
        :param interesting_files: The tree-relative paths of files that should
718
 
            participate in the merge.  If these paths refer to directories,
719
 
            the contents of those directories will also be included.  May not
720
 
            be combined with interesting_ids.  If neither interesting_files nor
721
 
            interesting_ids is specified, all files may participate in the
722
 
            merge.
723
 
        :param lca_trees: Can be set to a dictionary of {revision_id:rev_tree}
724
 
            if the ancestry was found to include a criss-cross merge.
725
 
            Otherwise should be None.
726
 
        """
727
 
        object.__init__(self)
728
 
        if interesting_files is not None and interesting_ids is not None:
729
 
            raise ValueError(
730
 
                'specify either interesting_ids or interesting_files')
731
 
        self.interesting_ids = interesting_ids
732
 
        self.interesting_files = interesting_files
733
 
        self.this_tree = working_tree
734
 
        self.base_tree = base_tree
735
 
        self.other_tree = other_tree
736
 
        self.this_branch = this_branch
737
 
        self._raw_conflicts = []
738
 
        self.cooked_conflicts = []
739
 
        self.reprocess = reprocess
740
 
        self.show_base = show_base
741
 
        self._lca_trees = lca_trees
742
 
        # Uncommenting this will change the default algorithm to always use
743
 
        # _entries_lca. This can be useful for running the test suite and
744
 
        # making sure we haven't missed any corner cases.
745
 
        # if lca_trees is None:
746
 
        #     self._lca_trees = [self.base_tree]
747
 
        self.change_reporter = change_reporter
748
 
        self.cherrypick = cherrypick
749
 
        if do_merge:
750
 
            self.do_merge()
751
 
        if pp is not None:
752
 
            warnings.warn("pp argument to Merge3Merger is deprecated")
753
 
        if pb is not None:
754
 
            warnings.warn("pb argument to Merge3Merger is deprecated")
755
 
 
756
 
    def do_merge(self):
757
 
        operation = OperationWithCleanups(self._do_merge)
758
 
        self.this_tree.lock_tree_write()
759
 
        operation.add_cleanup(self.this_tree.unlock)
760
 
        self.base_tree.lock_read()
761
 
        operation.add_cleanup(self.base_tree.unlock)
762
 
        self.other_tree.lock_read()
763
 
        operation.add_cleanup(self.other_tree.unlock)
764
 
        operation.run()
765
 
 
766
 
    def _do_merge(self, operation):
767
 
        self.tt = transform.TreeTransform(self.this_tree, None)
768
 
        operation.add_cleanup(self.tt.finalize)
769
 
        self._compute_transform()
770
 
        results = self.tt.apply(no_conflicts=True)
771
 
        self.write_modified(results)
772
 
        try:
773
 
            self.this_tree.add_conflicts(self.cooked_conflicts)
774
 
        except errors.UnsupportedOperation:
775
 
            pass
776
 
 
777
 
    def make_preview_transform(self):
778
 
        operation = OperationWithCleanups(self._make_preview_transform)
779
 
        self.base_tree.lock_read()
780
 
        operation.add_cleanup(self.base_tree.unlock)
781
 
        self.other_tree.lock_read()
782
 
        operation.add_cleanup(self.other_tree.unlock)
783
 
        return operation.run_simple()
784
 
 
785
 
    def _make_preview_transform(self):
786
 
        self.tt = transform.TransformPreview(self.this_tree)
787
 
        self._compute_transform()
788
 
        return self.tt
789
 
 
790
 
    def _compute_transform(self):
791
 
        if self._lca_trees is None:
792
 
            entries = self._entries3()
793
 
            resolver = self._three_way
794
 
        else:
795
 
            entries = self._entries_lca()
796
 
            resolver = self._lca_multi_way
797
 
        child_pb = ui.ui_factory.nested_progress_bar()
798
 
        try:
799
 
            factories = Merger.hooks['merge_file_content']
800
 
            hooks = [factory(self) for factory in factories] + [self]
801
 
            self.active_hooks = [hook for hook in hooks if hook is not None]
802
 
            for num, (file_id, changed, parents3, names3,
803
 
                      executable3) in enumerate(entries):
804
 
                child_pb.update('Preparing file merge', num, len(entries))
805
 
                self._merge_names(file_id, parents3, names3, resolver=resolver)
806
 
                if changed:
807
 
                    file_status = self._do_merge_contents(file_id)
808
 
                else:
809
 
                    file_status = 'unmodified'
810
 
                self._merge_executable(file_id,
811
 
                    executable3, file_status, resolver=resolver)
812
 
        finally:
813
 
            child_pb.finished()
814
 
        self.fix_root()
815
 
        child_pb = ui.ui_factory.nested_progress_bar()
816
 
        try:
817
 
            fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
818
 
                lambda t, c: transform.conflict_pass(t, c, self.other_tree))
819
 
        finally:
820
 
            child_pb.finished()
821
 
        if self.change_reporter is not None:
822
 
            from bzrlib import delta
823
 
            delta.report_changes(
824
 
                self.tt.iter_changes(), self.change_reporter)
825
 
        self.cook_conflicts(fs_conflicts)
826
 
        for conflict in self.cooked_conflicts:
827
 
            trace.warning(conflict)
828
 
 
829
 
    def _entries3(self):
830
 
        """Gather data about files modified between three trees.
831
 
 
832
 
        Return a list of tuples of file_id, changed, parents3, names3,
833
 
        executable3.  changed is a boolean indicating whether the file contents
834
 
        or kind were changed.  parents3 is a tuple of parent ids for base,
835
 
        other and this.  names3 is a tuple of names for base, other and this.
836
 
        executable3 is a tuple of execute-bit values for base, other and this.
837
 
        """
838
 
        result = []
839
 
        iterator = self.other_tree.iter_changes(self.base_tree,
840
 
                include_unchanged=True, specific_files=self.interesting_files,
841
 
                extra_trees=[self.this_tree])
842
 
        this_entries = dict((e.file_id, e) for p, e in
843
 
                            self.this_tree.iter_entries_by_dir(
844
 
                            self.interesting_ids))
845
 
        for (file_id, paths, changed, versioned, parents, names, kind,
846
 
             executable) in iterator:
847
 
            if (self.interesting_ids is not None and
848
 
                file_id not in self.interesting_ids):
849
 
                continue
850
 
            entry = this_entries.get(file_id)
851
 
            if entry is not None:
852
 
                this_name = entry.name
853
 
                this_parent = entry.parent_id
854
 
                this_executable = entry.executable
855
 
            else:
856
 
                this_name = None
857
 
                this_parent = None
858
 
                this_executable = None
859
 
            parents3 = parents + (this_parent,)
860
 
            names3 = names + (this_name,)
861
 
            executable3 = executable + (this_executable,)
862
 
            result.append((file_id, changed, parents3, names3, executable3))
863
 
        return result
864
 
 
865
 
    def _entries_lca(self):
866
 
        """Gather data about files modified between multiple trees.
867
 
 
868
 
        This compares OTHER versus all LCA trees, and for interesting entries,
869
 
        it then compares with THIS and BASE.
870
 
 
871
 
        For the multi-valued entries, the format will be (BASE, [lca1, lca2])
872
 
        :return: [(file_id, changed, parents, names, executable)]
873
 
            file_id     Simple file_id of the entry
874
 
            changed     Boolean, True if the kind or contents changed
875
 
                        else False
876
 
            parents     ((base, [parent_id, in, lcas]), parent_id_other,
877
 
                         parent_id_this)
878
 
            names       ((base, [name, in, lcas]), name_in_other, name_in_this)
879
 
            executable  ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
880
 
        """
881
 
        if self.interesting_files is not None:
882
 
            lookup_trees = [self.this_tree, self.base_tree]
883
 
            lookup_trees.extend(self._lca_trees)
884
 
            # I think we should include the lca trees as well
885
 
            interesting_ids = self.other_tree.paths2ids(self.interesting_files,
886
 
                                                        lookup_trees)
887
 
        else:
888
 
            interesting_ids = self.interesting_ids
889
 
        result = []
890
 
        walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
891
 
 
892
 
        base_inventory = self.base_tree.inventory
893
 
        this_inventory = self.this_tree.inventory
894
 
        for path, file_id, other_ie, lca_values in walker.iter_all():
895
 
            # Is this modified at all from any of the other trees?
896
 
            if other_ie is None:
897
 
                other_ie = _none_entry
898
 
            if interesting_ids is not None and file_id not in interesting_ids:
899
 
                continue
900
 
 
901
 
            # If other_revision is found in any of the lcas, that means this
902
 
            # node is uninteresting. This is because when merging, if there are
903
 
            # multiple heads(), we have to create a new node. So if we didn't,
904
 
            # we know that the ancestry is linear, and that OTHER did not
905
 
            # modify anything
906
 
            # See doc/developers/lca_merge_resolution.txt for details
907
 
            other_revision = other_ie.revision
908
 
            if other_revision is not None:
909
 
                # We can't use this shortcut when other_revision is None,
910
 
                # because it may be None because things are WorkingTrees, and
911
 
                # not because it is *actually* None.
912
 
                is_unmodified = False
913
 
                for lca_path, ie in lca_values:
914
 
                    if ie is not None and ie.revision == other_revision:
915
 
                        is_unmodified = True
916
 
                        break
917
 
                if is_unmodified:
918
 
                    continue
919
 
 
920
 
            lca_entries = []
921
 
            for lca_path, lca_ie in lca_values:
922
 
                if lca_ie is None:
923
 
                    lca_entries.append(_none_entry)
924
 
                else:
925
 
                    lca_entries.append(lca_ie)
926
 
 
927
 
            if file_id in base_inventory:
928
 
                base_ie = base_inventory[file_id]
929
 
            else:
930
 
                base_ie = _none_entry
931
 
 
932
 
            if file_id in this_inventory:
933
 
                this_ie = this_inventory[file_id]
934
 
            else:
935
 
                this_ie = _none_entry
936
 
 
937
 
            lca_kinds = []
938
 
            lca_parent_ids = []
939
 
            lca_names = []
940
 
            lca_executable = []
941
 
            for lca_ie in lca_entries:
942
 
                lca_kinds.append(lca_ie.kind)
943
 
                lca_parent_ids.append(lca_ie.parent_id)
944
 
                lca_names.append(lca_ie.name)
945
 
                lca_executable.append(lca_ie.executable)
946
 
 
947
 
            kind_winner = self._lca_multi_way(
948
 
                (base_ie.kind, lca_kinds),
949
 
                other_ie.kind, this_ie.kind)
950
 
            parent_id_winner = self._lca_multi_way(
951
 
                (base_ie.parent_id, lca_parent_ids),
952
 
                other_ie.parent_id, this_ie.parent_id)
953
 
            name_winner = self._lca_multi_way(
954
 
                (base_ie.name, lca_names),
955
 
                other_ie.name, this_ie.name)
956
 
 
957
 
            content_changed = True
958
 
            if kind_winner == 'this':
959
 
                # No kind change in OTHER, see if there are *any* changes
960
 
                if other_ie.kind == 'directory':
961
 
                    if parent_id_winner == 'this' and name_winner == 'this':
962
 
                        # No change for this directory in OTHER, skip
963
 
                        continue
964
 
                    content_changed = False
965
 
                elif other_ie.kind is None or other_ie.kind == 'file':
966
 
                    def get_sha1(ie, tree):
967
 
                        if ie.kind != 'file':
968
 
                            return None
969
 
                        return tree.get_file_sha1(file_id)
970
 
                    base_sha1 = get_sha1(base_ie, self.base_tree)
971
 
                    lca_sha1s = [get_sha1(ie, tree) for ie, tree
972
 
                                 in zip(lca_entries, self._lca_trees)]
973
 
                    this_sha1 = get_sha1(this_ie, self.this_tree)
974
 
                    other_sha1 = get_sha1(other_ie, self.other_tree)
975
 
                    sha1_winner = self._lca_multi_way(
976
 
                        (base_sha1, lca_sha1s), other_sha1, this_sha1,
977
 
                        allow_overriding_lca=False)
978
 
                    exec_winner = self._lca_multi_way(
979
 
                        (base_ie.executable, lca_executable),
980
 
                        other_ie.executable, this_ie.executable)
981
 
                    if (parent_id_winner == 'this' and name_winner == 'this'
982
 
                        and sha1_winner == 'this' and exec_winner == 'this'):
983
 
                        # No kind, parent, name, exec, or content change for
984
 
                        # OTHER, so this node is not considered interesting
985
 
                        continue
986
 
                    if sha1_winner == 'this':
987
 
                        content_changed = False
988
 
                elif other_ie.kind == 'symlink':
989
 
                    def get_target(ie, tree):
990
 
                        if ie.kind != 'symlink':
991
 
                            return None
992
 
                        return tree.get_symlink_target(file_id)
993
 
                    base_target = get_target(base_ie, self.base_tree)
994
 
                    lca_targets = [get_target(ie, tree) for ie, tree
995
 
                                   in zip(lca_entries, self._lca_trees)]
996
 
                    this_target = get_target(this_ie, self.this_tree)
997
 
                    other_target = get_target(other_ie, self.other_tree)
998
 
                    target_winner = self._lca_multi_way(
999
 
                        (base_target, lca_targets),
1000
 
                        other_target, this_target)
1001
 
                    if (parent_id_winner == 'this' and name_winner == 'this'
1002
 
                        and target_winner == 'this'):
1003
 
                        # No kind, parent, name, or symlink target change
1004
 
                        # not interesting
1005
 
                        continue
1006
 
                    if target_winner == 'this':
1007
 
                        content_changed = False
1008
 
                elif other_ie.kind == 'tree-reference':
1009
 
                    # The 'changed' information seems to be handled at a higher
1010
 
                    # level. At least, _entries3 returns False for content
1011
 
                    # changed, even when at a new revision_id.
1012
 
                    content_changed = False
1013
 
                    if (parent_id_winner == 'this' and name_winner == 'this'):
1014
 
                        # Nothing interesting
1015
 
                        continue
1016
 
                else:
1017
 
                    raise AssertionError('unhandled kind: %s' % other_ie.kind)
1018
 
 
1019
 
            # If we have gotten this far, that means something has changed
1020
 
            result.append((file_id, content_changed,
1021
 
                           ((base_ie.parent_id, lca_parent_ids),
1022
 
                            other_ie.parent_id, this_ie.parent_id),
1023
 
                           ((base_ie.name, lca_names),
1024
 
                            other_ie.name, this_ie.name),
1025
 
                           ((base_ie.executable, lca_executable),
1026
 
                            other_ie.executable, this_ie.executable)
1027
 
                          ))
1028
 
        return result
1029
 
 
1030
 
 
1031
 
    def fix_root(self):
1032
 
        try:
1033
 
            self.tt.final_kind(self.tt.root)
1034
 
        except errors.NoSuchFile:
1035
 
            self.tt.cancel_deletion(self.tt.root)
1036
 
        if self.tt.final_file_id(self.tt.root) is None:
1037
 
            self.tt.version_file(self.tt.tree_file_id(self.tt.root),
1038
 
                                 self.tt.root)
1039
 
        other_root_file_id = self.other_tree.get_root_id()
1040
 
        if other_root_file_id is None:
1041
 
            return
1042
 
        other_root = self.tt.trans_id_file_id(other_root_file_id)
1043
 
        if other_root == self.tt.root:
1044
 
            return
1045
 
        if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
1046
 
            # the other tree's root is a non-root in the current tree (as when
1047
 
            # a previously unrelated branch is merged into another)
1048
 
            return
1049
 
        try:
1050
 
            self.tt.final_kind(other_root)
1051
 
            other_root_is_present = True
1052
 
        except errors.NoSuchFile:
1053
 
            # other_root doesn't have a physical representation. We still need
1054
 
            # to move any references to the actual root of the tree.
1055
 
            other_root_is_present = False
1056
 
        # 'other_tree.inventory.root' is not present in this tree. We are
1057
 
        # calling adjust_path for children which *want* to be present with a
1058
 
        # correct place to go.
1059
 
        for thing, child in self.other_tree.inventory.root.children.iteritems():
1060
 
            trans_id = self.tt.trans_id_file_id(child.file_id)
1061
 
            if not other_root_is_present:
1062
 
                # FIXME: Make final_kind returns None instead of raising
1063
 
                # NoSuchFile to avoid the ugly construct below -- vila 20100402
1064
 
                try:
1065
 
                    self.tt.final_kind(trans_id)
1066
 
                    # The item exist in the final tree and has a defined place
1067
 
                    # to go already.
1068
 
                    continue
1069
 
                except errors.NoSuchFile, e:
1070
 
                    pass
1071
 
            # Move the item into the root
1072
 
            self.tt.adjust_path(self.tt.final_name(trans_id),
1073
 
                                self.tt.root, trans_id)
1074
 
        if other_root_is_present:
1075
 
            self.tt.cancel_creation(other_root)
1076
 
            self.tt.cancel_versioning(other_root)
1077
 
 
1078
 
    def write_modified(self, results):
1079
 
        modified_hashes = {}
1080
 
        for path in results.modified_paths:
1081
 
            file_id = self.this_tree.path2id(self.this_tree.relpath(path))
1082
 
            if file_id is None:
1083
 
                continue
1084
 
            hash = self.this_tree.get_file_sha1(file_id)
1085
 
            if hash is None:
1086
 
                continue
1087
 
            modified_hashes[file_id] = hash
1088
 
        self.this_tree.set_merge_modified(modified_hashes)
1089
 
 
1090
 
    @staticmethod
1091
 
    def parent(entry, file_id):
1092
 
        """Determine the parent for a file_id (used as a key method)"""
1093
 
        if entry is None:
1094
 
            return None
1095
 
        return entry.parent_id
1096
 
 
1097
 
    @staticmethod
1098
 
    def name(entry, file_id):
1099
 
        """Determine the name for a file_id (used as a key method)"""
1100
 
        if entry is None:
1101
 
            return None
1102
 
        return entry.name
1103
 
 
1104
 
    @staticmethod
1105
 
    def contents_sha1(tree, file_id):
1106
 
        """Determine the sha1 of the file contents (used as a key method)."""
1107
 
        if file_id not in tree:
1108
 
            return None
1109
 
        return tree.get_file_sha1(file_id)
1110
 
 
1111
 
    @staticmethod
1112
 
    def executable(tree, file_id):
1113
 
        """Determine the executability of a file-id (used as a key method)."""
1114
 
        if not tree.has_id(file_id):
1115
 
            return None
1116
 
        if tree.kind(file_id) != "file":
1117
 
            return False
1118
 
        return tree.is_executable(file_id)
1119
 
 
1120
 
    @staticmethod
1121
 
    def kind(tree, file_id):
1122
 
        """Determine the kind of a file-id (used as a key method)."""
1123
 
        if not tree.has_id(file_id):
1124
 
            return None
1125
 
        return tree.kind(file_id)
1126
 
 
1127
 
    @staticmethod
1128
 
    def _three_way(base, other, this):
1129
 
        if base == other:
1130
 
            # if 'base == other', either they all agree, or only 'this' has
1131
 
            # changed.
1132
 
            return 'this'
1133
 
        elif this not in (base, other):
1134
 
            # 'this' is neither 'base' nor 'other', so both sides changed
1135
 
            return 'conflict'
1136
 
        elif this == other:
1137
 
            # "Ambiguous clean merge" -- both sides have made the same change.
1138
 
            return "this"
1139
 
        else:
1140
 
            # this == base: only other has changed.
1141
 
            return "other"
1142
 
 
1143
 
    @staticmethod
1144
 
    def _lca_multi_way(bases, other, this, allow_overriding_lca=True):
1145
 
        """Consider LCAs when determining whether a change has occurred.
1146
 
 
1147
 
        If LCAS are all identical, this is the same as a _three_way comparison.
1148
 
 
1149
 
        :param bases: value in (BASE, [LCAS])
1150
 
        :param other: value in OTHER
1151
 
        :param this: value in THIS
1152
 
        :param allow_overriding_lca: If there is more than one unique lca
1153
 
            value, allow OTHER to override THIS if it has a new value, and
1154
 
            THIS only has an lca value, or vice versa. This is appropriate for
1155
 
            truly scalar values, not as much for non-scalars.
1156
 
        :return: 'this', 'other', or 'conflict' depending on whether an entry
1157
 
            changed or not.
1158
 
        """
1159
 
        # See doc/developers/lca_tree_merging.txt for details about this
1160
 
        # algorithm.
1161
 
        if other == this:
1162
 
            # Either Ambiguously clean, or nothing was actually changed. We
1163
 
            # don't really care
1164
 
            return 'this'
1165
 
        base_val, lca_vals = bases
1166
 
        # Remove 'base_val' from the lca_vals, because it is not interesting
1167
 
        filtered_lca_vals = [lca_val for lca_val in lca_vals
1168
 
                                      if lca_val != base_val]
1169
 
        if len(filtered_lca_vals) == 0:
1170
 
            return Merge3Merger._three_way(base_val, other, this)
1171
 
 
1172
 
        unique_lca_vals = set(filtered_lca_vals)
1173
 
        if len(unique_lca_vals) == 1:
1174
 
            return Merge3Merger._three_way(unique_lca_vals.pop(), other, this)
1175
 
 
1176
 
        if allow_overriding_lca:
1177
 
            if other in unique_lca_vals:
1178
 
                if this in unique_lca_vals:
1179
 
                    # Each side picked a different lca, conflict
1180
 
                    return 'conflict'
1181
 
                else:
1182
 
                    # This has a value which supersedes both lca values, and
1183
 
                    # other only has an lca value
1184
 
                    return 'this'
1185
 
            elif this in unique_lca_vals:
1186
 
                # OTHER has a value which supersedes both lca values, and this
1187
 
                # only has an lca value
1188
 
                return 'other'
1189
 
 
1190
 
        # At this point, the lcas disagree, and the tip disagree
1191
 
        return 'conflict'
1192
 
 
1193
 
    @staticmethod
1194
 
    @deprecated_method(deprecated_in((2, 2, 0)))
1195
 
    def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
1196
 
        """Do a three-way test on a scalar.
1197
 
        Return "this", "other" or "conflict", depending whether a value wins.
1198
 
        """
1199
 
        key_base = key(base_tree, file_id)
1200
 
        key_other = key(other_tree, file_id)
1201
 
        #if base == other, either they all agree, or only THIS has changed.
1202
 
        if key_base == key_other:
1203
 
            return "this"
1204
 
        key_this = key(this_tree, file_id)
1205
 
        # "Ambiguous clean merge"
1206
 
        if key_this == key_other:
1207
 
            return "this"
1208
 
        elif key_this == key_base:
1209
 
            return "other"
1210
 
        else:
1211
 
            return "conflict"
1212
 
 
1213
 
    def merge_names(self, file_id):
1214
 
        def get_entry(tree):
1215
 
            if tree.has_id(file_id):
1216
 
                return tree.inventory[file_id]
1217
 
            else:
1218
 
                return None
1219
 
        this_entry = get_entry(self.this_tree)
1220
 
        other_entry = get_entry(self.other_tree)
1221
 
        base_entry = get_entry(self.base_tree)
1222
 
        entries = (base_entry, other_entry, this_entry)
1223
 
        names = []
1224
 
        parents = []
1225
 
        for entry in entries:
1226
 
            if entry is None:
1227
 
                names.append(None)
1228
 
                parents.append(None)
1229
 
            else:
1230
 
                names.append(entry.name)
1231
 
                parents.append(entry.parent_id)
1232
 
        return self._merge_names(file_id, parents, names,
1233
 
                                 resolver=self._three_way)
1234
 
 
1235
 
    def _merge_names(self, file_id, parents, names, resolver):
1236
 
        """Perform a merge on file_id names and parents"""
1237
 
        base_name, other_name, this_name = names
1238
 
        base_parent, other_parent, this_parent = parents
1239
 
 
1240
 
        name_winner = resolver(*names)
1241
 
 
1242
 
        parent_id_winner = resolver(*parents)
1243
 
        if this_name is None:
1244
 
            if name_winner == "this":
1245
 
                name_winner = "other"
1246
 
            if parent_id_winner == "this":
1247
 
                parent_id_winner = "other"
1248
 
        if name_winner == "this" and parent_id_winner == "this":
1249
 
            return
1250
 
        if name_winner == 'conflict' or parent_id_winner == 'conflict':
1251
 
            # Creating helpers (.OTHER or .THIS) here cause problems down the
1252
 
            # road if a ContentConflict needs to be created so we should not do
1253
 
            # that
1254
 
            trans_id = self.tt.trans_id_file_id(file_id)
1255
 
            self._raw_conflicts.append(('path conflict', trans_id, file_id,
1256
 
                                        this_parent, this_name,
1257
 
                                        other_parent, other_name))
1258
 
        if other_name is None:
1259
 
            # it doesn't matter whether the result was 'other' or
1260
 
            # 'conflict'-- if there's no 'other', we leave it alone.
1261
 
            return
1262
 
        parent_id = parents[self.winner_idx[parent_id_winner]]
1263
 
        if parent_id is not None:
1264
 
            # if we get here, name_winner and parent_winner are set to safe
1265
 
            # values.
1266
 
            self.tt.adjust_path(names[self.winner_idx[name_winner]],
1267
 
                                self.tt.trans_id_file_id(parent_id),
1268
 
                                self.tt.trans_id_file_id(file_id))
1269
 
 
1270
 
    def _do_merge_contents(self, file_id):
1271
 
        """Performs a merge on file_id contents."""
1272
 
        def contents_pair(tree):
1273
 
            if file_id not in tree:
1274
 
                return (None, None)
1275
 
            kind = tree.kind(file_id)
1276
 
            if kind == "file":
1277
 
                contents = tree.get_file_sha1(file_id)
1278
 
            elif kind == "symlink":
1279
 
                contents = tree.get_symlink_target(file_id)
1280
 
            else:
1281
 
                contents = None
1282
 
            return kind, contents
1283
 
 
1284
 
        # See SPOT run.  run, SPOT, run.
1285
 
        # So we're not QUITE repeating ourselves; we do tricky things with
1286
 
        # file kind...
1287
 
        base_pair = contents_pair(self.base_tree)
1288
 
        other_pair = contents_pair(self.other_tree)
1289
 
        if self._lca_trees:
1290
 
            this_pair = contents_pair(self.this_tree)
1291
 
            lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1292
 
            winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1293
 
                                         this_pair, allow_overriding_lca=False)
1294
 
        else:
1295
 
            if base_pair == other_pair:
1296
 
                winner = 'this'
1297
 
            else:
1298
 
                # We delayed evaluating this_pair as long as we can to avoid
1299
 
                # unnecessary sha1 calculation
1300
 
                this_pair = contents_pair(self.this_tree)
1301
 
                winner = self._three_way(base_pair, other_pair, this_pair)
1302
 
        if winner == 'this':
1303
 
            # No interesting changes introduced by OTHER
1304
 
            return "unmodified"
1305
 
        # We have a hypothetical conflict, but if we have files, then we
1306
 
        # can try to merge the content
1307
 
        trans_id = self.tt.trans_id_file_id(file_id)
1308
 
        params = MergeHookParams(self, file_id, trans_id, this_pair[0],
1309
 
            other_pair[0], winner)
1310
 
        hooks = self.active_hooks
1311
 
        hook_status = 'not_applicable'
1312
 
        for hook in hooks:
1313
 
            hook_status, lines = hook.merge_contents(params)
1314
 
            if hook_status != 'not_applicable':
1315
 
                # Don't try any more hooks, this one applies.
1316
 
                break
1317
 
        result = "modified"
1318
 
        if hook_status == 'not_applicable':
1319
 
            # This is a contents conflict, because none of the available
1320
 
            # functions could merge it.
1321
 
            result = None
1322
 
            name = self.tt.final_name(trans_id)
1323
 
            parent_id = self.tt.final_parent(trans_id)
1324
 
            if self.this_tree.has_id(file_id):
1325
 
                self.tt.unversion_file(trans_id)
1326
 
            file_group = self._dump_conflicts(name, parent_id, file_id,
1327
 
                                              set_version=True)
1328
 
            self._raw_conflicts.append(('contents conflict', file_group))
1329
 
        elif hook_status == 'success':
1330
 
            self.tt.create_file(lines, trans_id)
1331
 
        elif hook_status == 'conflicted':
1332
 
            # XXX: perhaps the hook should be able to provide
1333
 
            # the BASE/THIS/OTHER files?
1334
 
            self.tt.create_file(lines, trans_id)
1335
 
            self._raw_conflicts.append(('text conflict', trans_id))
1336
 
            name = self.tt.final_name(trans_id)
1337
 
            parent_id = self.tt.final_parent(trans_id)
1338
 
            self._dump_conflicts(name, parent_id, file_id)
1339
 
        elif hook_status == 'delete':
1340
 
            self.tt.unversion_file(trans_id)
1341
 
            result = "deleted"
1342
 
        elif hook_status == 'done':
1343
 
            # The hook function did whatever it needs to do directly, no
1344
 
            # further action needed here.
1345
 
            pass
1346
 
        else:
1347
 
            raise AssertionError('unknown hook_status: %r' % (hook_status,))
1348
 
        if not self.this_tree.has_id(file_id) and result == "modified":
1349
 
            self.tt.version_file(file_id, trans_id)
1350
 
        # The merge has been performed, so the old contents should not be
1351
 
        # retained.
1352
 
        try:
1353
 
            self.tt.delete_contents(trans_id)
1354
 
        except errors.NoSuchFile:
1355
 
            pass
1356
 
        return result
1357
 
 
1358
 
    def _default_other_winner_merge(self, merge_hook_params):
1359
 
        """Replace this contents with other."""
1360
 
        file_id = merge_hook_params.file_id
1361
 
        trans_id = merge_hook_params.trans_id
1362
 
        file_in_this = self.this_tree.has_id(file_id)
1363
 
        if self.other_tree.has_id(file_id):
1364
 
            # OTHER changed the file
1365
 
            wt = self.this_tree
1366
 
            if wt.supports_content_filtering():
1367
 
                # We get the path from the working tree if it exists.
1368
 
                # That fails though when OTHER is adding a file, so
1369
 
                # we fall back to the other tree to find the path if
1370
 
                # it doesn't exist locally.
1371
 
                try:
1372
 
                    filter_tree_path = wt.id2path(file_id)
1373
 
                except errors.NoSuchId:
1374
 
                    filter_tree_path = self.other_tree.id2path(file_id)
1375
 
            else:
1376
 
                # Skip the id2path lookup for older formats
1377
 
                filter_tree_path = None
1378
 
            transform.create_from_tree(self.tt, trans_id,
1379
 
                             self.other_tree, file_id,
1380
 
                             filter_tree_path=filter_tree_path)
1381
 
            return 'done', None
1382
 
        elif file_in_this:
1383
 
            # OTHER deleted the file
1384
 
            return 'delete', None
1385
 
        else:
1386
 
            raise AssertionError(
1387
 
                'winner is OTHER, but file_id %r not in THIS or OTHER tree'
1388
 
                % (file_id,))
1389
 
 
1390
 
    def merge_contents(self, merge_hook_params):
1391
 
        """Fallback merge logic after user installed hooks."""
1392
 
        # This function is used in merge hooks as the fallback instance.
1393
 
        # Perhaps making this function and the functions it calls be a 
1394
 
        # a separate class would be better.
1395
 
        if merge_hook_params.winner == 'other':
1396
 
            # OTHER is a straight winner, so replace this contents with other
1397
 
            return self._default_other_winner_merge(merge_hook_params)
1398
 
        elif merge_hook_params.is_file_merge():
1399
 
            # THIS and OTHER are both files, so text merge.  Either
1400
 
            # BASE is a file, or both converted to files, so at least we
1401
 
            # have agreement that output should be a file.
1402
 
            try:
1403
 
                self.text_merge(merge_hook_params.file_id,
1404
 
                    merge_hook_params.trans_id)
1405
 
            except errors.BinaryFile:
1406
 
                return 'not_applicable', None
1407
 
            return 'done', None
1408
 
        else:
1409
 
            return 'not_applicable', None
1410
 
 
1411
 
    def get_lines(self, tree, file_id):
1412
 
        """Return the lines in a file, or an empty list."""
1413
 
        if tree.has_id(file_id):
1414
 
            return tree.get_file(file_id).readlines()
1415
 
        else:
1416
 
            return []
1417
 
 
1418
 
    def text_merge(self, file_id, trans_id):
1419
 
        """Perform a three-way text merge on a file_id"""
1420
 
        # it's possible that we got here with base as a different type.
1421
 
        # if so, we just want two-way text conflicts.
1422
 
        if self.base_tree.has_id(file_id) and \
1423
 
            self.base_tree.kind(file_id) == "file":
1424
 
            base_lines = self.get_lines(self.base_tree, file_id)
1425
 
        else:
1426
 
            base_lines = []
1427
 
        other_lines = self.get_lines(self.other_tree, file_id)
1428
 
        this_lines = self.get_lines(self.this_tree, file_id)
1429
 
        m3 = merge3.Merge3(base_lines, this_lines, other_lines,
1430
 
                           is_cherrypick=self.cherrypick)
1431
 
        start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
1432
 
        if self.show_base is True:
1433
 
            base_marker = '|' * 7
1434
 
        else:
1435
 
            base_marker = None
1436
 
 
1437
 
        def iter_merge3(retval):
1438
 
            retval["text_conflicts"] = False
1439
 
            for line in m3.merge_lines(name_a = "TREE",
1440
 
                                       name_b = "MERGE-SOURCE",
1441
 
                                       name_base = "BASE-REVISION",
1442
 
                                       start_marker=start_marker,
1443
 
                                       base_marker=base_marker,
1444
 
                                       reprocess=self.reprocess):
1445
 
                if line.startswith(start_marker):
1446
 
                    retval["text_conflicts"] = True
1447
 
                    yield line.replace(start_marker, '<' * 7)
1448
 
                else:
1449
 
                    yield line
1450
 
        retval = {}
1451
 
        merge3_iterator = iter_merge3(retval)
1452
 
        self.tt.create_file(merge3_iterator, trans_id)
1453
 
        if retval["text_conflicts"] is True:
1454
 
            self._raw_conflicts.append(('text conflict', trans_id))
1455
 
            name = self.tt.final_name(trans_id)
1456
 
            parent_id = self.tt.final_parent(trans_id)
1457
 
            file_group = self._dump_conflicts(name, parent_id, file_id,
1458
 
                                              this_lines, base_lines,
1459
 
                                              other_lines)
1460
 
            file_group.append(trans_id)
1461
 
 
1462
 
    def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
1463
 
                        base_lines=None, other_lines=None, set_version=False,
1464
 
                        no_base=False):
1465
 
        """Emit conflict files.
1466
 
        If this_lines, base_lines, or other_lines are omitted, they will be
1467
 
        determined automatically.  If set_version is true, the .OTHER, .THIS
1468
 
        or .BASE (in that order) will be created as versioned files.
1469
 
        """
1470
 
        data = [('OTHER', self.other_tree, other_lines),
1471
 
                ('THIS', self.this_tree, this_lines)]
1472
 
        if not no_base:
1473
 
            data.append(('BASE', self.base_tree, base_lines))
1474
 
 
1475
 
        # We need to use the actual path in the working tree of the file here,
1476
 
        # ignoring the conflict suffixes
1477
 
        wt = self.this_tree
1478
 
        if wt.supports_content_filtering():
1479
 
            try:
1480
 
                filter_tree_path = wt.id2path(file_id)
1481
 
            except errors.NoSuchId:
1482
 
                # file has been deleted
1483
 
                filter_tree_path = None
1484
 
        else:
1485
 
            # Skip the id2path lookup for older formats
1486
 
            filter_tree_path = None
1487
 
 
1488
 
        versioned = False
1489
 
        file_group = []
1490
 
        for suffix, tree, lines in data:
1491
 
            if tree.has_id(file_id):
1492
 
                trans_id = self._conflict_file(name, parent_id, tree, file_id,
1493
 
                                               suffix, lines, filter_tree_path)
1494
 
                file_group.append(trans_id)
1495
 
                if set_version and not versioned:
1496
 
                    self.tt.version_file(file_id, trans_id)
1497
 
                    versioned = True
1498
 
        return file_group
1499
 
 
1500
 
    def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1501
 
                       lines=None, filter_tree_path=None):
1502
 
        """Emit a single conflict file."""
1503
 
        name = name + '.' + suffix
1504
 
        trans_id = self.tt.create_path(name, parent_id)
1505
 
        transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
1506
 
            filter_tree_path)
1507
 
        return trans_id
1508
 
 
1509
 
    def merge_executable(self, file_id, file_status):
1510
 
        """Perform a merge on the execute bit."""
1511
 
        executable = [self.executable(t, file_id) for t in (self.base_tree,
1512
 
                      self.other_tree, self.this_tree)]
1513
 
        self._merge_executable(file_id, executable, file_status,
1514
 
                               resolver=self._three_way)
1515
 
 
1516
 
    def _merge_executable(self, file_id, executable, file_status,
1517
 
                          resolver):
1518
 
        """Perform a merge on the execute bit."""
1519
 
        base_executable, other_executable, this_executable = executable
1520
 
        if file_status == "deleted":
1521
 
            return
1522
 
        winner = resolver(*executable)
1523
 
        if winner == "conflict":
1524
 
        # There must be a None in here, if we have a conflict, but we
1525
 
        # need executability since file status was not deleted.
1526
 
            if self.executable(self.other_tree, file_id) is None:
1527
 
                winner = "this"
1528
 
            else:
1529
 
                winner = "other"
1530
 
        if winner == 'this' and file_status != "modified":
1531
 
            return
1532
 
        trans_id = self.tt.trans_id_file_id(file_id)
1533
 
        try:
1534
 
            if self.tt.final_kind(trans_id) != "file":
1535
 
                return
1536
 
        except errors.NoSuchFile:
1537
 
            return
1538
 
        if winner == "this":
1539
 
            executability = this_executable
1540
 
        else:
1541
 
            if self.other_tree.has_id(file_id):
1542
 
                executability = other_executable
1543
 
            elif self.this_tree.has_id(file_id):
1544
 
                executability = this_executable
1545
 
            elif self.base_tree_has_id(file_id):
1546
 
                executability = base_executable
1547
 
        if executability is not None:
1548
 
            trans_id = self.tt.trans_id_file_id(file_id)
1549
 
            self.tt.set_executability(executability, trans_id)
1550
 
 
1551
 
    def cook_conflicts(self, fs_conflicts):
1552
 
        """Convert all conflicts into a form that doesn't depend on trans_id"""
1553
 
        self.cooked_conflicts.extend(transform.cook_conflicts(
1554
 
                fs_conflicts, self.tt))
1555
 
        fp = transform.FinalPaths(self.tt)
1556
 
        for conflict in self._raw_conflicts:
1557
 
            conflict_type = conflict[0]
1558
 
            if conflict_type == 'path conflict':
1559
 
                (trans_id, file_id,
1560
 
                this_parent, this_name,
1561
 
                other_parent, other_name) = conflict[1:]
1562
 
                if this_parent is None or this_name is None:
1563
 
                    this_path = '<deleted>'
1564
 
                else:
1565
 
                    parent_path =  fp.get_path(
1566
 
                        self.tt.trans_id_file_id(this_parent))
1567
 
                    this_path = osutils.pathjoin(parent_path, this_name)
1568
 
                if other_parent is None or other_name is None:
1569
 
                    other_path = '<deleted>'
1570
 
                else:
1571
 
                    parent_path =  fp.get_path(
1572
 
                        self.tt.trans_id_file_id(other_parent))
1573
 
                    other_path = osutils.pathjoin(parent_path, other_name)
1574
 
                c = _mod_conflicts.Conflict.factory(
1575
 
                    'path conflict', path=this_path,
1576
 
                    conflict_path=other_path,
1577
 
                    file_id=file_id)
1578
 
            elif conflict_type == 'contents conflict':
1579
 
                for trans_id in conflict[1]:
1580
 
                    file_id = self.tt.final_file_id(trans_id)
1581
 
                    if file_id is not None:
1582
 
                        break
1583
 
                path = fp.get_path(trans_id)
1584
 
                for suffix in ('.BASE', '.THIS', '.OTHER'):
1585
 
                    if path.endswith(suffix):
1586
 
                        path = path[:-len(suffix)]
1587
 
                        break
1588
 
                c = _mod_conflicts.Conflict.factory(conflict_type,
1589
 
                                                    path=path, file_id=file_id)
1590
 
            elif conflict_type == 'text conflict':
1591
 
                trans_id = conflict[1]
1592
 
                path = fp.get_path(trans_id)
1593
 
                file_id = self.tt.final_file_id(trans_id)
1594
 
                c = _mod_conflicts.Conflict.factory(conflict_type,
1595
 
                                                    path=path, file_id=file_id)
1596
 
            else:
1597
 
                raise AssertionError('bad conflict type: %r' % (conflict,))
1598
 
            self.cooked_conflicts.append(c)
1599
 
        self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1600
 
 
1601
 
 
1602
 
class WeaveMerger(Merge3Merger):
1603
 
    """Three-way tree merger, text weave merger."""
1604
 
    supports_reprocess = True
1605
 
    supports_show_base = False
1606
 
    supports_reverse_cherrypick = False
1607
 
    history_based = True
1608
 
 
1609
 
    def _generate_merge_plan(self, file_id, base):
1610
 
        return self.this_tree.plan_file_merge(file_id, self.other_tree,
1611
 
                                              base=base)
1612
 
 
1613
 
    def _merged_lines(self, file_id):
1614
 
        """Generate the merged lines.
1615
 
        There is no distinction between lines that are meant to contain <<<<<<<
1616
 
        and conflicts.
1617
 
        """
1618
 
        if self.cherrypick:
1619
 
            base = self.base_tree
1620
 
        else:
1621
 
            base = None
1622
 
        plan = self._generate_merge_plan(file_id, base)
1623
 
        if 'merge' in debug.debug_flags:
1624
 
            plan = list(plan)
1625
 
            trans_id = self.tt.trans_id_file_id(file_id)
1626
 
            name = self.tt.final_name(trans_id) + '.plan'
1627
 
            contents = ('%11s|%s' % l for l in plan)
1628
 
            self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1629
 
        textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1630
 
                                                 '>>>>>>> MERGE-SOURCE\n')
1631
 
        lines, conflicts = textmerge.merge_lines(self.reprocess)
1632
 
        if conflicts:
1633
 
            base_lines = textmerge.base_from_plan()
1634
 
        else:
1635
 
            base_lines = None
1636
 
        return lines, base_lines
1637
 
 
1638
 
    def text_merge(self, file_id, trans_id):
1639
 
        """Perform a (weave) text merge for a given file and file-id.
1640
 
        If conflicts are encountered, .THIS and .OTHER files will be emitted,
1641
 
        and a conflict will be noted.
1642
 
        """
1643
 
        lines, base_lines = self._merged_lines(file_id)
1644
 
        lines = list(lines)
1645
 
        # Note we're checking whether the OUTPUT is binary in this case,
1646
 
        # because we don't want to get into weave merge guts.
1647
 
        textfile.check_text_lines(lines)
1648
 
        self.tt.create_file(lines, trans_id)
1649
 
        if base_lines is not None:
1650
 
            # Conflict
1651
 
            self._raw_conflicts.append(('text conflict', trans_id))
1652
 
            name = self.tt.final_name(trans_id)
1653
 
            parent_id = self.tt.final_parent(trans_id)
1654
 
            file_group = self._dump_conflicts(name, parent_id, file_id,
1655
 
                                              no_base=False,
1656
 
                                              base_lines=base_lines)
1657
 
            file_group.append(trans_id)
1658
 
 
1659
 
 
1660
 
class LCAMerger(WeaveMerger):
1661
 
 
1662
 
    def _generate_merge_plan(self, file_id, base):
1663
 
        return self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1664
 
                                                  base=base)
1665
 
 
1666
 
class Diff3Merger(Merge3Merger):
1667
 
    """Three-way merger using external diff3 for text merging"""
1668
 
 
1669
 
    def dump_file(self, temp_dir, name, tree, file_id):
1670
 
        out_path = osutils.pathjoin(temp_dir, name)
1671
 
        out_file = open(out_path, "wb")
1672
 
        try:
1673
 
            in_file = tree.get_file(file_id)
1674
 
            for line in in_file:
1675
 
                out_file.write(line)
1676
 
        finally:
1677
 
            out_file.close()
1678
 
        return out_path
1679
 
 
1680
 
    def text_merge(self, file_id, trans_id):
1681
 
        """Perform a diff3 merge using a specified file-id and trans-id.
1682
 
        If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
1683
 
        will be dumped, and a will be conflict noted.
1684
 
        """
1685
 
        import bzrlib.patch
1686
 
        temp_dir = osutils.mkdtemp(prefix="bzr-")
1687
 
        try:
1688
 
            new_file = osutils.pathjoin(temp_dir, "new")
1689
 
            this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
1690
 
            base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
1691
 
            other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
1692
 
            status = bzrlib.patch.diff3(new_file, this, base, other)
1693
 
            if status not in (0, 1):
1694
 
                raise errors.BzrError("Unhandled diff3 exit code")
1695
 
            f = open(new_file, 'rb')
1696
 
            try:
1697
 
                self.tt.create_file(f, trans_id)
1698
 
            finally:
1699
 
                f.close()
1700
 
            if status == 1:
1701
 
                name = self.tt.final_name(trans_id)
1702
 
                parent_id = self.tt.final_parent(trans_id)
1703
 
                self._dump_conflicts(name, parent_id, file_id)
1704
 
                self._raw_conflicts.append(('text conflict', trans_id))
1705
 
        finally:
1706
 
            osutils.rmtree(temp_dir)
1707
 
 
1708
 
 
1709
 
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1710
 
                backup_files=False,
1711
 
                merge_type=Merge3Merger,
1712
 
                interesting_ids=None,
1713
 
                show_base=False,
1714
 
                reprocess=False,
1715
 
                other_rev_id=None,
1716
 
                interesting_files=None,
1717
 
                this_tree=None,
1718
 
                pb=None,
1719
 
                change_reporter=None):
1720
 
    """Primary interface for merging.
1721
 
 
1722
 
        typical use is probably
1723
 
        'merge_inner(branch, branch.get_revision_tree(other_revision),
1724
 
                     branch.get_revision_tree(base_revision))'
1725
 
        """
1726
 
    if this_tree is None:
1727
 
        raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
1728
 
                              "parameter as of bzrlib version 0.8.")
1729
 
    merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1730
 
                    pb=pb, change_reporter=change_reporter)
1731
 
    merger.backup_files = backup_files
1732
 
    merger.merge_type = merge_type
1733
 
    merger.interesting_ids = interesting_ids
1734
 
    merger.ignore_zero = ignore_zero
1735
 
    if interesting_files:
1736
 
        if interesting_ids:
1737
 
            raise ValueError('Only supply interesting_ids'
1738
 
                             ' or interesting_files')
1739
 
        merger.interesting_files = interesting_files
1740
 
    merger.show_base = show_base
1741
 
    merger.reprocess = reprocess
1742
 
    merger.other_rev_id = other_rev_id
1743
 
    merger.other_basis = other_rev_id
1744
 
    get_revision_id = getattr(base_tree, 'get_revision_id', None)
1745
 
    if get_revision_id is None:
1746
 
        get_revision_id = base_tree.last_revision
1747
 
    merger.cache_trees_with_revision_ids([other_tree, base_tree, this_tree])
1748
 
    merger.set_base_revision(get_revision_id(), this_branch)
1749
 
    return merger.do_merge()
1750
 
 
1751
 
def get_merge_type_registry():
1752
 
    """Merge type registry is in bzrlib.option to avoid circular imports.
1753
 
 
1754
 
    This method provides a sanctioned way to retrieve it.
1755
 
    """
1756
 
    from bzrlib import option
1757
 
    return option._merge_type_registry
1758
 
 
1759
 
 
1760
 
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
1761
 
    def status_a(revision, text):
1762
 
        if revision in ancestors_b:
1763
 
            return 'killed-b', text
1764
 
        else:
1765
 
            return 'new-a', text
1766
 
 
1767
 
    def status_b(revision, text):
1768
 
        if revision in ancestors_a:
1769
 
            return 'killed-a', text
1770
 
        else:
1771
 
            return 'new-b', text
1772
 
 
1773
 
    plain_a = [t for (a, t) in annotated_a]
1774
 
    plain_b = [t for (a, t) in annotated_b]
1775
 
    matcher = patiencediff.PatienceSequenceMatcher(None, plain_a, plain_b)
1776
 
    blocks = matcher.get_matching_blocks()
1777
 
    a_cur = 0
1778
 
    b_cur = 0
1779
 
    for ai, bi, l in blocks:
1780
 
        # process all mismatched sections
1781
 
        # (last mismatched section is handled because blocks always
1782
 
        # includes a 0-length last block)
1783
 
        for revision, text in annotated_a[a_cur:ai]:
1784
 
            yield status_a(revision, text)
1785
 
        for revision, text in annotated_b[b_cur:bi]:
1786
 
            yield status_b(revision, text)
1787
 
        # and now the matched section
1788
 
        a_cur = ai + l
1789
 
        b_cur = bi + l
1790
 
        for text_a in plain_a[ai:a_cur]:
1791
 
            yield "unchanged", text_a
1792
 
 
1793
 
 
1794
 
class _PlanMergeBase(object):
1795
 
 
1796
 
    def __init__(self, a_rev, b_rev, vf, key_prefix):
1797
 
        """Contructor.
1798
 
 
1799
 
        :param a_rev: Revision-id of one revision to merge
1800
 
        :param b_rev: Revision-id of the other revision to merge
1801
 
        :param vf: A VersionedFiles containing both revisions
1802
 
        :param key_prefix: A prefix for accessing keys in vf, typically
1803
 
            (file_id,).
1804
 
        """
1805
 
        self.a_rev = a_rev
1806
 
        self.b_rev = b_rev
1807
 
        self.vf = vf
1808
 
        self._last_lines = None
1809
 
        self._last_lines_revision_id = None
1810
 
        self._cached_matching_blocks = {}
1811
 
        self._key_prefix = key_prefix
1812
 
        self._precache_tip_lines()
1813
 
 
1814
 
    def _precache_tip_lines(self):
1815
 
        lines = self.get_lines([self.a_rev, self.b_rev])
1816
 
        self.lines_a = lines[self.a_rev]
1817
 
        self.lines_b = lines[self.b_rev]
1818
 
 
1819
 
    def get_lines(self, revisions):
1820
 
        """Get lines for revisions from the backing VersionedFiles.
1821
 
 
1822
 
        :raises RevisionNotPresent: on absent texts.
1823
 
        """
1824
 
        keys = [(self._key_prefix + (rev,)) for rev in revisions]
1825
 
        result = {}
1826
 
        for record in self.vf.get_record_stream(keys, 'unordered', True):
1827
 
            if record.storage_kind == 'absent':
1828
 
                raise errors.RevisionNotPresent(record.key, self.vf)
1829
 
            result[record.key[-1]] = osutils.chunks_to_lines(
1830
 
                record.get_bytes_as('chunked'))
1831
 
        return result
1832
 
 
1833
 
    def plan_merge(self):
1834
 
        """Generate a 'plan' for merging the two revisions.
1835
 
 
1836
 
        This involves comparing their texts and determining the cause of
1837
 
        differences.  If text A has a line and text B does not, then either the
1838
 
        line was added to text A, or it was deleted from B.  Once the causes
1839
 
        are combined, they are written out in the format described in
1840
 
        VersionedFile.plan_merge
1841
 
        """
1842
 
        blocks = self._get_matching_blocks(self.a_rev, self.b_rev)
1843
 
        unique_a, unique_b = self._unique_lines(blocks)
1844
 
        new_a, killed_b = self._determine_status(self.a_rev, unique_a)
1845
 
        new_b, killed_a = self._determine_status(self.b_rev, unique_b)
1846
 
        return self._iter_plan(blocks, new_a, killed_b, new_b, killed_a)
1847
 
 
1848
 
    def _iter_plan(self, blocks, new_a, killed_b, new_b, killed_a):
1849
 
        last_i = 0
1850
 
        last_j = 0
1851
 
        for i, j, n in blocks:
1852
 
            for a_index in range(last_i, i):
1853
 
                if a_index in new_a:
1854
 
                    if a_index in killed_b:
1855
 
                        yield 'conflicted-a', self.lines_a[a_index]
1856
 
                    else:
1857
 
                        yield 'new-a', self.lines_a[a_index]
1858
 
                else:
1859
 
                    yield 'killed-b', self.lines_a[a_index]
1860
 
            for b_index in range(last_j, j):
1861
 
                if b_index in new_b:
1862
 
                    if b_index in killed_a:
1863
 
                        yield 'conflicted-b', self.lines_b[b_index]
1864
 
                    else:
1865
 
                        yield 'new-b', self.lines_b[b_index]
1866
 
                else:
1867
 
                    yield 'killed-a', self.lines_b[b_index]
1868
 
            # handle common lines
1869
 
            for a_index in range(i, i+n):
1870
 
                yield 'unchanged', self.lines_a[a_index]
1871
 
            last_i = i+n
1872
 
            last_j = j+n
1873
 
 
1874
 
    def _get_matching_blocks(self, left_revision, right_revision):
1875
 
        """Return a description of which sections of two revisions match.
1876
 
 
1877
 
        See SequenceMatcher.get_matching_blocks
1878
 
        """
1879
 
        cached = self._cached_matching_blocks.get((left_revision,
1880
 
                                                   right_revision))
1881
 
        if cached is not None:
1882
 
            return cached
1883
 
        if self._last_lines_revision_id == left_revision:
1884
 
            left_lines = self._last_lines
1885
 
            right_lines = self.get_lines([right_revision])[right_revision]
1886
 
        else:
1887
 
            lines = self.get_lines([left_revision, right_revision])
1888
 
            left_lines = lines[left_revision]
1889
 
            right_lines = lines[right_revision]
1890
 
        self._last_lines = right_lines
1891
 
        self._last_lines_revision_id = right_revision
1892
 
        matcher = patiencediff.PatienceSequenceMatcher(None, left_lines,
1893
 
                                                       right_lines)
1894
 
        return matcher.get_matching_blocks()
1895
 
 
1896
 
    def _unique_lines(self, matching_blocks):
1897
 
        """Analyse matching_blocks to determine which lines are unique
1898
 
 
1899
 
        :return: a tuple of (unique_left, unique_right), where the values are
1900
 
            sets of line numbers of unique lines.
1901
 
        """
1902
 
        last_i = 0
1903
 
        last_j = 0
1904
 
        unique_left = []
1905
 
        unique_right = []
1906
 
        for i, j, n in matching_blocks:
1907
 
            unique_left.extend(range(last_i, i))
1908
 
            unique_right.extend(range(last_j, j))
1909
 
            last_i = i + n
1910
 
            last_j = j + n
1911
 
        return unique_left, unique_right
1912
 
 
1913
 
    @staticmethod
1914
 
    def _subtract_plans(old_plan, new_plan):
1915
 
        """Remove changes from new_plan that came from old_plan.
1916
 
 
1917
 
        It is assumed that the difference between the old_plan and new_plan
1918
 
        is their choice of 'b' text.
1919
 
 
1920
 
        All lines from new_plan that differ from old_plan are emitted
1921
 
        verbatim.  All lines from new_plan that match old_plan but are
1922
 
        not about the 'b' revision are emitted verbatim.
1923
 
 
1924
 
        Lines that match and are about the 'b' revision are the lines we
1925
 
        don't want, so we convert 'killed-b' -> 'unchanged', and 'new-b'
1926
 
        is skipped entirely.
1927
 
        """
1928
 
        matcher = patiencediff.PatienceSequenceMatcher(None, old_plan,
1929
 
                                                       new_plan)
1930
 
        last_j = 0
1931
 
        for i, j, n in matcher.get_matching_blocks():
1932
 
            for jj in range(last_j, j):
1933
 
                yield new_plan[jj]
1934
 
            for jj in range(j, j+n):
1935
 
                plan_line = new_plan[jj]
1936
 
                if plan_line[0] == 'new-b':
1937
 
                    pass
1938
 
                elif plan_line[0] == 'killed-b':
1939
 
                    yield 'unchanged', plan_line[1]
1940
 
                else:
1941
 
                    yield plan_line
1942
 
            last_j = j + n
1943
 
 
1944
 
 
1945
 
class _PlanMerge(_PlanMergeBase):
1946
 
    """Plan an annotate merge using on-the-fly annotation"""
1947
 
 
1948
 
    def __init__(self, a_rev, b_rev, vf, key_prefix):
1949
 
        super(_PlanMerge, self).__init__(a_rev, b_rev, vf, key_prefix)
1950
 
        self.a_key = self._key_prefix + (self.a_rev,)
1951
 
        self.b_key = self._key_prefix + (self.b_rev,)
1952
 
        self.graph = _mod_graph.Graph(self.vf)
1953
 
        heads = self.graph.heads((self.a_key, self.b_key))
1954
 
        if len(heads) == 1:
1955
 
            # one side dominates, so we can just return its values, yay for
1956
 
            # per-file graphs
1957
 
            # Ideally we would know that before we get this far
1958
 
            self._head_key = heads.pop()
1959
 
            if self._head_key == self.a_key:
1960
 
                other = b_rev
1961
 
            else:
1962
 
                other = a_rev
1963
 
            trace.mutter('found dominating revision for %s\n%s > %s', self.vf,
1964
 
                         self._head_key[-1], other)
1965
 
            self._weave = None
1966
 
        else:
1967
 
            self._head_key = None
1968
 
            self._build_weave()
1969
 
 
1970
 
    def _precache_tip_lines(self):
1971
 
        # Turn this into a no-op, because we will do this later
1972
 
        pass
1973
 
 
1974
 
    def _find_recursive_lcas(self):
1975
 
        """Find all the ancestors back to a unique lca"""
1976
 
        cur_ancestors = (self.a_key, self.b_key)
1977
 
        # graph.find_lca(uncommon, keys) now returns plain NULL_REVISION,
1978
 
        # rather than a key tuple. We will just map that directly to no common
1979
 
        # ancestors.
1980
 
        parent_map = {}
1981
 
        while True:
1982
 
            next_lcas = self.graph.find_lca(*cur_ancestors)
1983
 
            # Map a plain NULL_REVISION to a simple no-ancestors
1984
 
            if next_lcas == set([_mod_revision.NULL_REVISION]):
1985
 
                next_lcas = ()
1986
 
            # Order the lca's based on when they were merged into the tip
1987
 
            # While the actual merge portion of weave merge uses a set() of
1988
 
            # active revisions, the order of insertion *does* effect the
1989
 
            # implicit ordering of the texts.
1990
 
            for rev_key in cur_ancestors:
1991
 
                ordered_parents = tuple(self.graph.find_merge_order(rev_key,
1992
 
                                                                    next_lcas))
1993
 
                parent_map[rev_key] = ordered_parents
1994
 
            if len(next_lcas) == 0:
1995
 
                break
1996
 
            elif len(next_lcas) == 1:
1997
 
                parent_map[list(next_lcas)[0]] = ()
1998
 
                break
1999
 
            elif len(next_lcas) > 2:
2000
 
                # More than 2 lca's, fall back to grabbing all nodes between
2001
 
                # this and the unique lca.
2002
 
                trace.mutter('More than 2 LCAs, falling back to all nodes for:'
2003
 
                             ' %s, %s\n=> %s',
2004
 
                             self.a_key, self.b_key, cur_ancestors)
2005
 
                cur_lcas = next_lcas
2006
 
                while len(cur_lcas) > 1:
2007
 
                    cur_lcas = self.graph.find_lca(*cur_lcas)
2008
 
                if len(cur_lcas) == 0:
2009
 
                    # No common base to find, use the full ancestry
2010
 
                    unique_lca = None
2011
 
                else:
2012
 
                    unique_lca = list(cur_lcas)[0]
2013
 
                    if unique_lca == _mod_revision.NULL_REVISION:
2014
 
                        # find_lca will return a plain 'NULL_REVISION' rather
2015
 
                        # than a key tuple when there is no common ancestor, we
2016
 
                        # prefer to just use None, because it doesn't confuse
2017
 
                        # _get_interesting_texts()
2018
 
                        unique_lca = None
2019
 
                parent_map.update(self._find_unique_parents(next_lcas,
2020
 
                                                            unique_lca))
2021
 
                break
2022
 
            cur_ancestors = next_lcas
2023
 
        return parent_map
2024
 
 
2025
 
    def _find_unique_parents(self, tip_keys, base_key):
2026
 
        """Find ancestors of tip that aren't ancestors of base.
2027
 
 
2028
 
        :param tip_keys: Nodes that are interesting
2029
 
        :param base_key: Cull all ancestors of this node
2030
 
        :return: The parent map for all revisions between tip_keys and
2031
 
            base_key. base_key will be included. References to nodes outside of
2032
 
            the ancestor set will also be removed.
2033
 
        """
2034
 
        # TODO: this would be simpler if find_unique_ancestors took a list
2035
 
        #       instead of a single tip, internally it supports it, but it
2036
 
        #       isn't a "backwards compatible" api change.
2037
 
        if base_key is None:
2038
 
            parent_map = dict(self.graph.iter_ancestry(tip_keys))
2039
 
            # We remove NULL_REVISION because it isn't a proper tuple key, and
2040
 
            # thus confuses things like _get_interesting_texts, and our logic
2041
 
            # to add the texts into the memory weave.
2042
 
            if _mod_revision.NULL_REVISION in parent_map:
2043
 
                parent_map.pop(_mod_revision.NULL_REVISION)
2044
 
        else:
2045
 
            interesting = set()
2046
 
            for tip in tip_keys:
2047
 
                interesting.update(
2048
 
                    self.graph.find_unique_ancestors(tip, [base_key]))
2049
 
            parent_map = self.graph.get_parent_map(interesting)
2050
 
            parent_map[base_key] = ()
2051
 
        culled_parent_map, child_map, tails = self._remove_external_references(
2052
 
            parent_map)
2053
 
        # Remove all the tails but base_key
2054
 
        if base_key is not None:
2055
 
            tails.remove(base_key)
2056
 
            self._prune_tails(culled_parent_map, child_map, tails)
2057
 
        # Now remove all the uninteresting 'linear' regions
2058
 
        simple_map = _mod_graph.collapse_linear_regions(culled_parent_map)
2059
 
        return simple_map
2060
 
 
2061
 
    @staticmethod
2062
 
    def _remove_external_references(parent_map):
2063
 
        """Remove references that go outside of the parent map.
2064
 
 
2065
 
        :param parent_map: Something returned from Graph.get_parent_map(keys)
2066
 
        :return: (filtered_parent_map, child_map, tails)
2067
 
            filtered_parent_map is parent_map without external references
2068
 
            child_map is the {parent_key: [child_keys]} mapping
2069
 
            tails is a list of nodes that do not have any parents in the map
2070
 
        """
2071
 
        # TODO: The basic effect of this function seems more generic than
2072
 
        #       _PlanMerge. But the specific details of building a child_map,
2073
 
        #       and computing tails seems very specific to _PlanMerge.
2074
 
        #       Still, should this be in Graph land?
2075
 
        filtered_parent_map = {}
2076
 
        child_map = {}
2077
 
        tails = []
2078
 
        for key, parent_keys in parent_map.iteritems():
2079
 
            culled_parent_keys = [p for p in parent_keys if p in parent_map]
2080
 
            if not culled_parent_keys:
2081
 
                tails.append(key)
2082
 
            for parent_key in culled_parent_keys:
2083
 
                child_map.setdefault(parent_key, []).append(key)
2084
 
            # TODO: Do we want to do this, it adds overhead for every node,
2085
 
            #       just to say that the node has no children
2086
 
            child_map.setdefault(key, [])
2087
 
            filtered_parent_map[key] = culled_parent_keys
2088
 
        return filtered_parent_map, child_map, tails
2089
 
 
2090
 
    @staticmethod
2091
 
    def _prune_tails(parent_map, child_map, tails_to_remove):
2092
 
        """Remove tails from the parent map.
2093
 
 
2094
 
        This will remove the supplied revisions until no more children have 0
2095
 
        parents.
2096
 
 
2097
 
        :param parent_map: A dict of {child: [parents]}, this dictionary will
2098
 
            be modified in place.
2099
 
        :param tails_to_remove: A list of tips that should be removed,
2100
 
            this list will be consumed
2101
 
        :param child_map: The reverse dict of parent_map ({parent: [children]})
2102
 
            this dict will be modified
2103
 
        :return: None, parent_map will be modified in place.
2104
 
        """
2105
 
        while tails_to_remove:
2106
 
            next = tails_to_remove.pop()
2107
 
            parent_map.pop(next)
2108
 
            children = child_map.pop(next)
2109
 
            for child in children:
2110
 
                child_parents = parent_map[child]
2111
 
                child_parents.remove(next)
2112
 
                if len(child_parents) == 0:
2113
 
                    tails_to_remove.append(child)
2114
 
 
2115
 
    def _get_interesting_texts(self, parent_map):
2116
 
        """Return a dict of texts we are interested in.
2117
 
 
2118
 
        Note that the input is in key tuples, but the output is in plain
2119
 
        revision ids.
2120
 
 
2121
 
        :param parent_map: The output from _find_recursive_lcas
2122
 
        :return: A dict of {'revision_id':lines} as returned by
2123
 
            _PlanMergeBase.get_lines()
2124
 
        """
2125
 
        all_revision_keys = set(parent_map)
2126
 
        all_revision_keys.add(self.a_key)
2127
 
        all_revision_keys.add(self.b_key)
2128
 
 
2129
 
        # Everything else is in 'keys' but get_lines is in 'revision_ids'
2130
 
        all_texts = self.get_lines([k[-1] for k in all_revision_keys])
2131
 
        return all_texts
2132
 
 
2133
 
    def _build_weave(self):
2134
 
        from bzrlib import weave
2135
 
        self._weave = weave.Weave(weave_name='in_memory_weave',
2136
 
                                  allow_reserved=True)
2137
 
        parent_map = self._find_recursive_lcas()
2138
 
 
2139
 
        all_texts = self._get_interesting_texts(parent_map)
2140
 
 
2141
 
        # Note: Unfortunately, the order given by topo_sort will effect the
2142
 
        # ordering resolution in the output. Specifically, if you add A then B,
2143
 
        # then in the output text A lines will show up before B lines. And, of
2144
 
        # course, topo_sort doesn't guarantee any real ordering.
2145
 
        # So we use merge_sort, and add a fake node on the tip.
2146
 
        # This ensures that left-hand parents will always be inserted into the
2147
 
        # weave before right-hand parents.
2148
 
        tip_key = self._key_prefix + (_mod_revision.CURRENT_REVISION,)
2149
 
        parent_map[tip_key] = (self.a_key, self.b_key)
2150
 
 
2151
 
        for seq_num, key, depth, eom in reversed(tsort.merge_sort(parent_map,
2152
 
                                                                  tip_key)):
2153
 
            if key == tip_key:
2154
 
                continue
2155
 
        # for key in tsort.topo_sort(parent_map):
2156
 
            parent_keys = parent_map[key]
2157
 
            revision_id = key[-1]
2158
 
            parent_ids = [k[-1] for k in parent_keys]
2159
 
            self._weave.add_lines(revision_id, parent_ids,
2160
 
                                  all_texts[revision_id])
2161
 
 
2162
 
    def plan_merge(self):
2163
 
        """Generate a 'plan' for merging the two revisions.
2164
 
 
2165
 
        This involves comparing their texts and determining the cause of
2166
 
        differences.  If text A has a line and text B does not, then either the
2167
 
        line was added to text A, or it was deleted from B.  Once the causes
2168
 
        are combined, they are written out in the format described in
2169
 
        VersionedFile.plan_merge
2170
 
        """
2171
 
        if self._head_key is not None: # There was a single head
2172
 
            if self._head_key == self.a_key:
2173
 
                plan = 'new-a'
2174
 
            else:
2175
 
                if self._head_key != self.b_key:
2176
 
                    raise AssertionError('There was an invalid head: %s != %s'
2177
 
                                         % (self.b_key, self._head_key))
2178
 
                plan = 'new-b'
2179
 
            head_rev = self._head_key[-1]
2180
 
            lines = self.get_lines([head_rev])[head_rev]
2181
 
            return ((plan, line) for line in lines)
2182
 
        return self._weave.plan_merge(self.a_rev, self.b_rev)
2183
 
 
2184
 
 
2185
 
class _PlanLCAMerge(_PlanMergeBase):
2186
 
    """
2187
 
    This merge algorithm differs from _PlanMerge in that:
2188
 
    1. comparisons are done against LCAs only
2189
 
    2. cases where a contested line is new versus one LCA but old versus
2190
 
       another are marked as conflicts, by emitting the line as conflicted-a
2191
 
       or conflicted-b.
2192
 
 
2193
 
    This is faster, and hopefully produces more useful output.
2194
 
    """
2195
 
 
2196
 
    def __init__(self, a_rev, b_rev, vf, key_prefix, graph):
2197
 
        _PlanMergeBase.__init__(self, a_rev, b_rev, vf, key_prefix)
2198
 
        lcas = graph.find_lca(key_prefix + (a_rev,), key_prefix + (b_rev,))
2199
 
        self.lcas = set()
2200
 
        for lca in lcas:
2201
 
            if lca == _mod_revision.NULL_REVISION:
2202
 
                self.lcas.add(lca)
2203
 
            else:
2204
 
                self.lcas.add(lca[-1])
2205
 
        for lca in self.lcas:
2206
 
            if _mod_revision.is_null(lca):
2207
 
                lca_lines = []
2208
 
            else:
2209
 
                lca_lines = self.get_lines([lca])[lca]
2210
 
            matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_a,
2211
 
                                                           lca_lines)
2212
 
            blocks = list(matcher.get_matching_blocks())
2213
 
            self._cached_matching_blocks[(a_rev, lca)] = blocks
2214
 
            matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_b,
2215
 
                                                           lca_lines)
2216
 
            blocks = list(matcher.get_matching_blocks())
2217
 
            self._cached_matching_blocks[(b_rev, lca)] = blocks
2218
 
 
2219
 
    def _determine_status(self, revision_id, unique_line_numbers):
2220
 
        """Determines the status unique lines versus all lcas.
2221
 
 
2222
 
        Basically, determines why the line is unique to this revision.
2223
 
 
2224
 
        A line may be determined new, killed, or both.
2225
 
 
2226
 
        If a line is determined new, that means it was not present in at least
2227
 
        one LCA, and is not present in the other merge revision.
2228
 
 
2229
 
        If a line is determined killed, that means the line was present in
2230
 
        at least one LCA.
2231
 
 
2232
 
        If a line is killed and new, this indicates that the two merge
2233
 
        revisions contain differing conflict resolutions.
2234
 
        :param revision_id: The id of the revision in which the lines are
2235
 
            unique
2236
 
        :param unique_line_numbers: The line numbers of unique lines.
2237
 
        :return a tuple of (new_this, killed_other):
2238
 
        """
2239
 
        new = set()
2240
 
        killed = set()
2241
 
        unique_line_numbers = set(unique_line_numbers)
2242
 
        for lca in self.lcas:
2243
 
            blocks = self._get_matching_blocks(revision_id, lca)
2244
 
            unique_vs_lca, _ignored = self._unique_lines(blocks)
2245
 
            new.update(unique_line_numbers.intersection(unique_vs_lca))
2246
 
            killed.update(unique_line_numbers.difference(unique_vs_lca))
2247
 
        return new, killed