/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Vincent Ladeuil
  • Date: 2010-02-10 16:41:09 UTC
  • mto: (5029.2.1 integration2)
  • mto: This revision was merged to the branch mainline in revision 5031.
  • Revision ID: v.ladeuil+lp@free.fr-20100210164109-q5wluu91am3vsf6d
Use a set() for conflicts_related to stay O(1).

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