~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-02-17 07:46:11 UTC
  • mfrom: (5037.1.1 trivial)
  • Revision ID: pqm@pqm.ubuntu.com-20100217074611-0yifopv5mebb3aq0
(mbp) Don't show pointer in safe_string_from_size error

Show diffs side-by-side

added added

removed removed

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