/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-02-11 04:02:41 UTC
  • mfrom: (5017.2.2 tariff)
  • Revision ID: pqm@pqm.ubuntu.com-20100211040241-w6n021dz0uus341n
(mbp) add import-tariff tests

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