~bzr-pqm/bzr/bzr.dev

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