~bzr-pqm/bzr/bzr.dev

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