/brz/remove-bazaar : contents of bzrlib/merge.py at revision 6406.1.4

: (revision 6406.1.4)

To get this branch, use:

bzr branch
http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

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
1110 by Martin Pool - merge aaron's merge improvements:	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):
4869.3.1 by Andrew Bennetts Basic per-file merge hook.	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. '
6388.1.4 by Jelmer Vernooij Fix tests.	83	'Receives a Merger object as the single argument.',
6388.1.3 by Jelmer Vernooij Add pre and post merge hooks.	84	(2, 5))
6388.1.3 by Jelmer Vernooij Add pre and post merge hooks.	85	self.add_hook('post_merge',
6388.1.4 by Jelmer Vernooij Fix tests.	86	'Called after a merge. '
6388.1.4 by Jelmer Vernooij Fix tests.	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.',
6388.1.3 by Jelmer Vernooij Add pre and post merge hooks.	89	(2, 5))
4869.3.1 by Andrew Bennetts Basic per-file merge hook.	90
4869.3.1 by Andrew Bennetts Basic per-file merge hook.	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.
4869.3.11 by Andrew Bennetts More docs.	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
4869.3.11 by Andrew Bennetts More docs.	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
4869.3.1 by Andrew Bennetts Basic per-file merge hook.	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.
1551.15.74 by Aaron Bentley Textual updates from review	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,
3363.17.15 by Aaron Bentley Update docs	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(
4721.3.1 by Vincent Ladeuil Cleanup imports.	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,
2485.8.58 by Vincent Ladeuil merge bzr.dev@1617	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:
4721.3.1 by Vincent Ladeuil Cleanup imports.	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)
5540.1.6 by Gary van der Merwe We just need a set for this.	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(
2598.5.3 by Aaron Bentley Push NULL_REVISION deeper	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,
3008.1.11 by Michael Hudson restore the default behaviour of Merge3Merger.__init__().	620	'do_merge': False}
1534.7.84 by Aaron Bentley Added reprocess support, support for varying merge types	621	if self.merge_type.requires_base:
	622	kwargs['base_tree'] = self.base_tree
1534.7.137 by Aaron Bentley Avoided generating a new tree for every weave merge	623	if self.merge_type.supports_reprocess:
	624	kwargs['reprocess'] = self.reprocess
	625	elif self.reprocess:
4721.3.1 by Vincent Ladeuil Cleanup imports.	626	raise errors.BzrError(
	627	"Conflict reduction is not supported for merge"
	628	" type %s." % self.merge_type)
1534.7.137 by Aaron Bentley Avoided generating a new tree for every weave merge	629	if self.merge_type.supports_show_base:
	630	kwargs['show_base'] = self.show_base
	631	elif self.show_base:
4721.3.1 by Vincent Ladeuil Cleanup imports.	632	raise errors.BzrError("Showing base is not supported for this"
4721.3.1 by Vincent Ladeuil Cleanup imports.	633	" merge type. %s" % self.merge_type)
3062.2.7 by Aaron Bentley Prevent reverse cherry-picking with weave	634	if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
	635	and not self.base_is_other_ancestor):
	636	raise errors.CannotReverseCherrypick()
3249.3.1 by John Arbash Meinel Implement cherrypick support for Merge3	637	if self.merge_type.supports_cherrypick:
3062.2.9 by Aaron Bentley Don't use the base if not cherrypicking	638	kwargs['cherrypick'] = (not self.base_is_ancestor or
	639	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.	640	if self._is_criss_cross and getattr(self.merge_type,
	641	'supports_lca_trees', False):
	642	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	643	return self.merge_type(pb=None,
3008.1.8 by Michael Hudson extract merger creation into a method	644	change_reporter=self.change_reporter,
	645	**kwargs)
	646
4797.16.1 by Andrew Bennetts Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.	647	def _do_merge_to(self):
	648	merge = self.make_merger()
4273.1.9 by Aaron Bentley Cleanup	649	if self.other_branch is not None:
4273.1.9 by Aaron Bentley Cleanup	650	self.other_branch.update_references(self.this_branch)
6388.1.4 by Jelmer Vernooij Fix tests.	651	for hook in Merger.hooks['pre_merge']:
6388.1.4 by Jelmer Vernooij Fix tests.	652	hook(merge)
3619.6.4 by Mark Hammond do_merge gets one 'finally' per lock so locks always released on failure.	653	merge.do_merge()
6388.1.3 by Jelmer Vernooij Add pre and post merge hooks.	654	for hook in Merger.hooks['post_merge']:
6388.1.3 by Jelmer Vernooij Add pre and post merge hooks.	655	hook(merge)
3619.6.4 by Mark Hammond do_merge gets one 'finally' per lock so locks always released on failure.	656	if self.recurse == 'down':
	657	for relpath, file_id in self.this_tree.iter_references():
	658	sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
	659	other_revision = self.other_tree.get_reference_revision(
	660	file_id, relpath)
	661	if other_revision == sub_tree.last_revision():
	662	continue
	663	sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
	664	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.	665	other_branch = self.other_branch.reference_parent(file_id,
	666	relpath)
3619.6.4 by Mark Hammond do_merge gets one 'finally' per lock so locks always released on failure.	667	sub_merge.set_other_revision(other_revision, other_branch)
	668	base_revision = self.base_tree.get_reference_revision(file_id)
	669	sub_merge.base_tree = \
	670	sub_tree.branch.repository.revision_tree(base_revision)
	671	sub_merge.base_rev_id = base_revision
	672	sub_merge.do_merge()
4797.16.1 by Andrew Bennetts Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.	673	return merge
3943.8.1 by Marius Kruger remove all trailing whitespace from bzr source	674
3008.1.8 by Michael Hudson extract merger creation into a method	675	def do_merge(self):
5753.2.2 by Jelmer Vernooij Remove some unnecessary imports, clean up lazy imports.	676	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()	677	self.this_tree.lock_tree_write()
4797.16.1 by Andrew Bennetts Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.	678	operation.add_cleanup(self.this_tree.unlock)
	679	if self.base_tree is not None:
	680	self.base_tree.lock_read()
	681	operation.add_cleanup(self.base_tree.unlock)
	682	if self.other_tree is not None:
	683	self.other_tree.lock_read()
	684	operation.add_cleanup(self.other_tree.unlock)
	685	merge = operation.run_simple()
1534.7.151 by Aaron Bentley Fixed all changes applied successfully	686	if len(merge.cooked_conflicts) == 0:
4721.3.1 by Vincent Ladeuil Cleanup imports.	687	if not self.ignore_zero and not trace.is_quiet():
6138.3.4 by Jonathan Riddell add gettext() to uses of trace.note()	688	trace.note(gettext("All changes applied successfully."))
1534.7.141 by Aaron Bentley Added conflict reporting	689	else:
6138.3.4 by Jonathan Riddell add gettext() to uses of trace.note()	690	trace.note(gettext("%d conflicts encountered.")
4721.3.1 by Vincent Ladeuil Cleanup imports.	691	% len(merge.cooked_conflicts))
1534.7.141 by Aaron Bentley Added conflict reporting	692
1534.7.134 by Aaron Bentley Hid raw conflicts	693	return len(merge.cooked_conflicts)
1185.12.76 by Aaron Bentley Refactored merge and merge_inner to use Merger	694
1545.2.4 by Aaron Bentley PEP8 fixes	695
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.	696	class _InventoryNoneEntry(object):
	697	"""This represents an inventory entry which isn't there.
	698
	699	It simplifies the merging logic if we always have an InventoryEntry, even
	700	if it isn't actually present
	701	"""
	702	executable = None
	703	kind = None
	704	name = None
	705	parent_id = None
	706	revision = None
	707	symlink_target = None
	708	text_sha1 = None
	709
	710	_none_entry = _InventoryNoneEntry()
	711
	712
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	713	class Merge3Merger(object):
1534.7.167 by Aaron Bentley PEP8 and comment cleanups	714	"""Three-way merger that uses the merge3 text merger"""
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	715	requires_base = True
	716	supports_reprocess = True
	717	supports_show_base = True
	718	history_based = False
3249.3.1 by John Arbash Meinel Implement cherrypick support for Merge3	719	supports_cherrypick = True
3062.2.7 by Aaron Bentley Prevent reverse cherry-picking with weave	720	supports_reverse_cherrypick = True
2590.2.7 by Aaron Bentley Misc cleanup	721	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.	722	supports_lca_trees = True
1534.7.167 by Aaron Bentley PEP8 and comment cleanups	723
3943.8.1 by Marius Kruger remove all trailing whitespace from bzr source	724	def __init__(self, working_tree, this_tree, base_tree, other_tree,
1558.2.2 by Aaron Bentley Make remerge honour interesting-ids	725	interesting_ids=None, reprocess=False, show_base=False,
4961.2.9 by Martin Pool Rip out most remaining uses of DummyProgressBar	726	pb=None, pp=None, change_reporter=None,
3249.3.1 by John Arbash Meinel Implement cherrypick support for Merge3	727	interesting_files=None, do_merge=True,
5993.2.4 by Jelmer Vernooij Remove feature flag.	728	cherrypick=False, lca_trees=None, this_branch=None):
2590.2.10 by Aaron Bentley Updates from review	729	"""Initialize the merger object and perform the merge.
	730
	731	:param working_tree: The working tree to apply the merge to
	732	:param this_tree: The local tree in the merge operation
	733	:param base_tree: The common tree in the merge operation
4031.3.1 by Frank Aspell Fixing various typos	734	:param other_tree: The other tree to merge changes from
5162.3.1 by Aaron Bentley Fix switch/merge when a ConfigurableFileMerger is used.	735	:param this_branch: The branch associated with this_tree. Defaults to
	736	this_tree.branch if not supplied.
2590.2.10 by Aaron Bentley Updates from review	737	:param interesting_ids: The file_ids of files that should be
	738	participate in the merge. May not be combined with
	739	interesting_files.
	740	:param: reprocess If True, perform conflict-reduction processing.
	741	:param show_base: If True, show the base revision in text conflicts.
	742	(incompatible with reprocess)
4961.2.9 by Martin Pool Rip out most remaining uses of DummyProgressBar	743	:param pb: ignored
2590.2.10 by Aaron Bentley Updates from review	744	:param pp: A ProgressPhase object
	745	:param change_reporter: An object that should report changes made
	746	:param interesting_files: The tree-relative paths of files that should
	747	participate in the merge. If these paths refer to directories,
	748	the contents of those directories will also be included. May not
	749	be combined with interesting_ids. If neither interesting_files nor
	750	interesting_ids is specified, all files may participate in the
	751	merge.
3514.4.4 by John Arbash Meinel Test that the lca_trees are passed down to the Merger object when appropriate.	752	:param lca_trees: Can be set to a dictionary of {revision_id:rev_tree}
	753	if the ancestry was found to include a criss-cross merge.
	754	Otherwise should be None.
2590.2.10 by Aaron Bentley Updates from review	755	"""
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	756	object.__init__(self)
3376.2.4 by Martin Pool Remove every assert statement from bzrlib!	757	if interesting_files is not None and interesting_ids is not None:
	758	raise ValueError(
	759	'specify either interesting_ids or interesting_files')
5162.3.1 by Aaron Bentley Fix switch/merge when a ConfigurableFileMerger is used.	760	if this_branch is None:
	761	this_branch = this_tree.branch
2590.2.4 by Aaron Bentley Move entry generation to a helper	762	self.interesting_ids = interesting_ids
2590.2.5 by Aaron Bentley Allow selected files to be specified instead of selected ids	763	self.interesting_files = interesting_files
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	764	self.this_tree = working_tree
	765	self.base_tree = base_tree
	766	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.	767	self.this_branch = this_branch
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	768	self._raw_conflicts = []
	769	self.cooked_conflicts = []
	770	self.reprocess = reprocess
	771	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.	772	self._lca_trees = lca_trees
3514.4.37 by John Arbash Meinel Tests pass when using _entries_lca as the default algorithm.	773	# Uncommenting this will change the default algorithm to always use
	774	# _entries_lca. This can be useful for running the test suite and
	775	# making sure we haven't missed any corner cases.
3514.4.34 by John Arbash Meinel Handle symlinks properly when objects are not RevisionTrees	776	# if lca_trees is None:
	777	# self._lca_trees = [self.base_tree]
1551.11.9 by Aaron Bentley Apply change reporting to merge	778	self.change_reporter = change_reporter
3249.3.1 by John Arbash Meinel Implement cherrypick support for Merge3	779	self.cherrypick = cherrypick
3008.1.11 by Michael Hudson restore the default behaviour of Merge3Merger.__init__().	780	if do_merge:
	781	self.do_merge()
4961.2.12 by Martin Pool Further pb/pp removals	782	if pp is not None:
	783	warnings.warn("pp argument to Merge3Merger is deprecated")
	784	if pb is not None:
	785	warnings.warn("pb argument to Merge3Merger is deprecated")
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	786
3008.1.6 by Michael Hudson chop up Merge3Merger.__init__ into pieces	787	def do_merge(self):
5753.2.2 by Jelmer Vernooij Remove some unnecessary imports, clean up lazy imports.	788	operation = cleanup.OperationWithCleanups(self._do_merge)
3008.1.6 by Michael Hudson chop up Merge3Merger.__init__ into pieces	789	self.this_tree.lock_tree_write()
4797.16.1 by Andrew Bennetts Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.	790	operation.add_cleanup(self.this_tree.unlock)
3008.1.6 by Michael Hudson chop up Merge3Merger.__init__ into pieces	791	self.base_tree.lock_read()
4797.16.1 by Andrew Bennetts Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.	792	operation.add_cleanup(self.base_tree.unlock)
3008.1.6 by Michael Hudson chop up Merge3Merger.__init__ into pieces	793	self.other_tree.lock_read()
4797.16.1 by Andrew Bennetts Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.	794	operation.add_cleanup(self.other_tree.unlock)
	795	operation.run()
	796
	797	def _do_merge(self, operation):
5031.1.2 by Andrew Bennetts Merge lp:bzr/2.1	798	self.tt = transform.TreeTransform(self.this_tree, None)
4797.16.1 by Andrew Bennetts Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.	799	operation.add_cleanup(self.tt.finalize)
	800	self._compute_transform()
	801	results = self.tt.apply(no_conflicts=True)
	802	self.write_modified(results)
5031.1.3 by Andrew Bennetts Fix syntax error from bad conflict resolution.	803	try:
4797.16.1 by Andrew Bennetts Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.	804	self.this_tree.add_conflicts(self.cooked_conflicts)
	805	except errors.UnsupportedOperation:
	806	pass
1534.7.192 by Aaron Bentley Record hashes produced by merges	807
3008.1.9 by Michael Hudson wanton hacking that lets me write an efficient version of get_diff_as_merged	808	def make_preview_transform(self):
5753.2.2 by Jelmer Vernooij Remove some unnecessary imports, clean up lazy imports.	809	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	810	self.base_tree.lock_read()
4797.16.1 by Andrew Bennetts Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.	811	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	812	self.other_tree.lock_read()
4797.16.1 by Andrew Bennetts Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.	813	operation.add_cleanup(self.other_tree.unlock)
	814	return operation.run_simple()
	815
	816	def _make_preview_transform(self):
4721.3.1 by Vincent Ladeuil Cleanup imports.	817	self.tt = transform.TransformPreview(self.this_tree)
4797.16.1 by Andrew Bennetts Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.	818	self._compute_transform()
3008.1.9 by Michael Hudson wanton hacking that lets me write an efficient version of get_diff_as_merged	819	return self.tt
	820
3008.1.21 by Aaron Bentley Make compute_transform private, test make_preview_transform	821	def _compute_transform(self):
3514.4.21 by John Arbash Meinel Hook up the lca-way logic into the path handlers.	822	if self._lca_trees is None:
	823	entries = self._entries3()
	824	resolver = self._three_way
	825	else:
	826	entries = self._entries_lca()
	827	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.	828	# Prepare merge hooks
	829	factories = Merger.hooks['merge_file_content']
	830	# One hook for each registered one plus our default merger
	831	hooks = [factory(self) for factory in factories] + [self]
	832	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	833	child_pb = ui.ui_factory.nested_progress_bar()
	834	try:
	835	for num, (file_id, changed, parents3, names3,
	836	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.	837	# Try merging each entry
	838	child_pb.update(gettext('Preparing file merge'),
	839	num, len(entries))
3514.4.21 by John Arbash Meinel Hook up the lca-way logic into the path handlers.	840	self._merge_names(file_id, parents3, names3, resolver=resolver)
3008.1.6 by Michael Hudson chop up Merge3Merger.__init__ into pieces	841	if changed:
4797.5.1 by Robert Collins Support state on per-file merging to permit more efficient use of configuration data.	842	file_status = self._do_merge_contents(file_id)
3008.1.6 by Michael Hudson chop up Merge3Merger.__init__ into pieces	843	else:
	844	file_status = 'unmodified'
	845	self._merge_executable(file_id,
3514.4.21 by John Arbash Meinel Hook up the lca-way logic into the path handlers.	846	executable3, file_status, resolver=resolver)
3008.1.6 by Michael Hudson chop up Merge3Merger.__init__ into pieces	847	finally:
	848	child_pb.finished()
5993.2.4 by Jelmer Vernooij Remove feature flag.	849	self.tt.fixup_new_roots()
5246.2.33 by Andrew Bennetts Rename _finish_transform to _finish_computing_transform.	850	self._finish_computing_transform()
5246.2.4 by Andrew Bennetts Remove a little bit of duplication.	851
5246.2.33 by Andrew Bennetts Rename _finish_transform to _finish_computing_transform.	852	def _finish_computing_transform(self):
5246.2.4 by Andrew Bennetts Remove a little bit of duplication.	853	"""Finalize the transform and report the changes.
	854
	855	This is the second half of _compute_transform.
	856	"""
3008.1.6 by Michael Hudson chop up Merge3Merger.__init__ into pieces	857	child_pb = ui.ui_factory.nested_progress_bar()
	858	try:
4721.3.1 by Vincent Ladeuil Cleanup imports.	859	fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
4721.3.1 by Vincent Ladeuil Cleanup imports.	860	lambda t, c: transform.conflict_pass(t, c, self.other_tree))
3008.1.6 by Michael Hudson chop up Merge3Merger.__init__ into pieces	861	finally:
	862	child_pb.finished()
	863	if self.change_reporter is not None:
	864	from bzrlib import delta
	865	delta.report_changes(
3254.1.1 by Aaron Bentley Make Tree.iter_changes a public method	866	self.tt.iter_changes(), self.change_reporter)
3008.1.6 by Michael Hudson chop up Merge3Merger.__init__ into pieces	867	self.cook_conflicts(fs_conflicts)
	868	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	869	trace.warning(unicode(conflict))
3008.1.6 by Michael Hudson chop up Merge3Merger.__init__ into pieces	870
2590.2.4 by Aaron Bentley Move entry generation to a helper	871	def _entries3(self):
2590.2.7 by Aaron Bentley Misc cleanup	872	"""Gather data about files modified between three trees.
	873
	874	Return a list of tuples of file_id, changed, parents3, names3,
	875	executable3. changed is a boolean indicating whether the file contents
	876	or kind were changed. parents3 is a tuple of parent ids for base,
	877	other and this. names3 is a tuple of names for base, other and this.
	878	executable3 is a tuple of execute-bit values for base, other and this.
	879	"""
2590.2.4 by Aaron Bentley Move entry generation to a helper	880	result = []
3254.1.1 by Aaron Bentley Make Tree.iter_changes a public method	881	iterator = self.other_tree.iter_changes(self.base_tree,
5783.2.1 by John Arbash Meinel Remove the 'include_unchanged=True' from iter_changes.	882	specific_files=self.interesting_files,
2590.2.5 by Aaron Bentley Allow selected files to be specified instead of selected ids	883	extra_trees=[self.this_tree])
3363.17.1 by Aaron Bentley Avoid inventory for merge and transform code	884	this_entries = dict((e.file_id, e) for p, e in
	885	self.this_tree.iter_entries_by_dir(
	886	self.interesting_ids))
2590.2.4 by Aaron Bentley Move entry generation to a helper	887	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	888	executable) in iterator:
2590.2.4 by Aaron Bentley Move entry generation to a helper	889	if (self.interesting_ids is not None and
	890	file_id not in self.interesting_ids):
	891	continue
3363.17.1 by Aaron Bentley Avoid inventory for merge and transform code	892	entry = this_entries.get(file_id)
	893	if entry is not None:
2590.2.4 by Aaron Bentley Move entry generation to a helper	894	this_name = entry.name
	895	this_parent = entry.parent_id
	896	this_executable = entry.executable
	897	else:
	898	this_name = None
	899	this_parent = None
	900	this_executable = None
	901	parents3 = parents + (this_parent,)
	902	names3 = names + (this_name,)
	903	executable3 = executable + (this_executable,)
	904	result.append((file_id, changed, parents3, names3, executable3))
	905	return result
	906
3514.4.5 by John Arbash Meinel Initial work on _entries_lca.	907	def _entries_lca(self):
	908	"""Gather data about files modified between multiple trees.
	909
	910	This compares OTHER versus all LCA trees, and for interesting entries,
	911	it then compares with THIS and BASE.
	912
	913	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.	914
	915	:return: [(file_id, changed, parents, names, executable)], where:
	916
	917	* file_id: Simple file_id of the entry
	918	* changed: Boolean, True if the kind or contents changed else False
	919	* parents: ((base, [parent_id, in, lcas]), parent_id_other,
	920	parent_id_this)
	921	* names: ((base, [name, in, lcas]), name_in_other, name_in_this)
	922	* executable: ((base, [exec, in, lcas]), exec_in_other,
	923	exec_in_this)
3514.4.5 by John Arbash Meinel Initial work on _entries_lca.	924	"""
3514.4.24 by John Arbash Meinel Implement support for 'interesting_files' and 'interesting_ids' for _entries_lca	925	if self.interesting_files is not None:
	926	lookup_trees = [self.this_tree, self.base_tree]
	927	lookup_trees.extend(self._lca_trees)
	928	# I think we should include the lca trees as well
	929	interesting_ids = self.other_tree.paths2ids(self.interesting_files,
	930	lookup_trees)
	931	else:
	932	interesting_ids = self.interesting_ids
3514.4.5 by John Arbash Meinel Initial work on _entries_lca.	933	result = []
3514.4.13 by John Arbash Meinel Switch the lca_trees to be in 'find_merge_order'.	934	walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
3514.4.5 by John Arbash Meinel Initial work on _entries_lca.	935
3514.4.10 by John Arbash Meinel Test the case where BASE is missing a file that is present in THIS, OTHER and all LCAs.	936	base_inventory = self.base_tree.inventory
	937	this_inventory = self.this_tree.inventory
3514.4.5 by John Arbash Meinel Initial work on _entries_lca.	938	for path, file_id, other_ie, lca_values in walker.iter_all():
	939	# Is this modified at all from any of the other trees?
3514.4.15 by John Arbash Meinel Handle when OTHER doesn't have the entry.	940	if other_ie is None:
3514.4.20 by John Arbash Meinel Use the _lca_multi_way to work out if there is actually a kind/parent/name/content change.	941	other_ie = _none_entry
3514.4.24 by John Arbash Meinel Implement support for 'interesting_files' and 'interesting_ids' for _entries_lca	942	if interesting_ids is not None and file_id not in interesting_ids:
	943	continue
3514.4.15 by John Arbash Meinel Handle when OTHER doesn't have the entry.	944
3514.4.30 by John Arbash Meinel Several updates.	945	# If other_revision is found in any of the lcas, that means this
	946	# node is uninteresting. This is because when merging, if there are
	947	# multiple heads(), we have to create a new node. So if we didn't,
	948	# we know that the ancestry is linear, and that OTHER did not
	949	# modify anything
	950	# See doc/developers/lca_merge_resolution.txt for details
3514.4.20 by John Arbash Meinel Use the _lca_multi_way to work out if there is actually a kind/parent/name/content change.	951	other_revision = other_ie.revision
3514.4.32 by John Arbash Meinel Add a test for proper behavior when everything is a WT.	952	if other_revision is not None:
	953	# We can't use this shortcut when other_revision is None,
	954	# because it may be None because things are WorkingTrees, and
	955	# not because it is actually None.
	956	is_unmodified = False
	957	for lca_path, ie in lca_values:
	958	if ie is not None and ie.revision == other_revision:
	959	is_unmodified = True
	960	break
	961	if is_unmodified:
	962	continue
3514.4.20 by John Arbash Meinel Use the _lca_multi_way to work out if there is actually a kind/parent/name/content change.	963
	964	lca_entries = []
	965	for lca_path, lca_ie in lca_values:
	966	if lca_ie is None:
	967	lca_entries.append(_none_entry)
	968	else:
	969	lca_entries.append(lca_ie)
3514.4.19 by John Arbash Meinel Add the _lca_multi_way function, and explicit tests.	970
5967.7.1 by Martin Pool Deprecate __contains__ on Tree and Inventory	971	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.	972	base_ie = base_inventory[file_id]
3514.4.10 by John Arbash Meinel Test the case where BASE is missing a file that is present in THIS, OTHER and all LCAs.	973	else:
3514.4.20 by John Arbash Meinel Use the _lca_multi_way to work out if there is actually a kind/parent/name/content change.	974	base_ie = _none_entry
	975
5967.7.1 by Martin Pool Deprecate __contains__ on Tree and Inventory	976	if this_inventory.has_id(file_id):
3514.4.11 by John Arbash Meinel Handle when an entry is missing in THIS	977	this_ie = this_inventory[file_id]
	978	else:
3514.4.20 by John Arbash Meinel Use the _lca_multi_way to work out if there is actually a kind/parent/name/content change.	979	this_ie = _none_entry
3514.4.11 by John Arbash Meinel Handle when an entry is missing in THIS	980
3514.4.21 by John Arbash Meinel Hook up the lca-way logic into the path handlers.	981	lca_kinds = []
	982	lca_parent_ids = []
	983	lca_names = []
	984	lca_executable = []
	985	for lca_ie in lca_entries:
	986	lca_kinds.append(lca_ie.kind)
	987	lca_parent_ids.append(lca_ie.parent_id)
	988	lca_names.append(lca_ie.name)
	989	lca_executable.append(lca_ie.executable)
	990
3514.4.39 by John Arbash Meinel Use self._lca_multi_way rather than Merge3Merger._lca_multi_way by Aaron's request.	991	kind_winner = self._lca_multi_way(
3514.4.21 by John Arbash Meinel Hook up the lca-way logic into the path handlers.	992	(base_ie.kind, lca_kinds),
3514.4.20 by John Arbash Meinel Use the _lca_multi_way to work out if there is actually a kind/parent/name/content change.	993	other_ie.kind, this_ie.kind)
3514.4.39 by John Arbash Meinel Use self._lca_multi_way rather than Merge3Merger._lca_multi_way by Aaron's request.	994	parent_id_winner = self._lca_multi_way(
3514.4.21 by John Arbash Meinel Hook up the lca-way logic into the path handlers.	995	(base_ie.parent_id, lca_parent_ids),
3514.4.20 by John Arbash Meinel Use the _lca_multi_way to work out if there is actually a kind/parent/name/content change.	996	other_ie.parent_id, this_ie.parent_id)
3514.4.39 by John Arbash Meinel Use self._lca_multi_way rather than Merge3Merger._lca_multi_way by Aaron's request.	997	name_winner = self._lca_multi_way(
3514.4.21 by John Arbash Meinel Hook up the lca-way logic into the path handlers.	998	(base_ie.name, lca_names),
3514.4.20 by John Arbash Meinel Use the _lca_multi_way to work out if there is actually a kind/parent/name/content change.	999	other_ie.name, this_ie.name)
3514.4.21 by John Arbash Meinel Hook up the lca-way logic into the path handlers.	1000
3514.4.20 by John Arbash Meinel Use the _lca_multi_way to work out if there is actually a kind/parent/name/content change.	1001	content_changed = True
	1002	if kind_winner == 'this':
	1003	# No kind change in OTHER, see if there are any changes
3948.1.1 by John Arbash Meinel Fix an edge case with deleted files and criss-cross merges.	1004	if other_ie.kind == 'directory':
3514.4.20 by John Arbash Meinel Use the _lca_multi_way to work out if there is actually a kind/parent/name/content change.	1005	if parent_id_winner == 'this' and name_winner == 'this':
	1006	# No change for this directory in OTHER, skip
	1007	continue
	1008	content_changed = False
3948.1.1 by John Arbash Meinel Fix an edge case with deleted files and criss-cross merges.	1009	elif other_ie.kind is None or other_ie.kind == 'file':
3514.4.30 by John Arbash Meinel Several updates.	1010	def get_sha1(ie, tree):
3514.4.35 by John Arbash Meinel Add a test that we only call get_symlink_target if the object should be a symlink.	1011	if ie.kind != 'file':
3514.4.30 by John Arbash Meinel Several updates.	1012	return None
	1013	return tree.get_file_sha1(file_id)
	1014	base_sha1 = get_sha1(base_ie, self.base_tree)
	1015	lca_sha1s = [get_sha1(ie, tree) for ie, tree
	1016	in zip(lca_entries, self._lca_trees)]
	1017	this_sha1 = get_sha1(this_ie, self.this_tree)
	1018	other_sha1 = get_sha1(other_ie, self.other_tree)
3514.4.39 by John Arbash Meinel Use self._lca_multi_way rather than Merge3Merger._lca_multi_way by Aaron's request.	1019	sha1_winner = self._lca_multi_way(
3514.4.30 by John Arbash Meinel Several updates.	1020	(base_sha1, lca_sha1s), other_sha1, this_sha1,
3514.4.30 by John Arbash Meinel Several updates.	1021	allow_overriding_lca=False)
3514.4.39 by John Arbash Meinel Use self._lca_multi_way rather than Merge3Merger._lca_multi_way by Aaron's request.	1022	exec_winner = self._lca_multi_way(
3514.4.22 by John Arbash Meinel Handle executable bit changes as well.	1023	(base_ie.executable, lca_executable),
	1024	other_ie.executable, this_ie.executable)
3514.4.20 by John Arbash Meinel Use the _lca_multi_way to work out if there is actually a kind/parent/name/content change.	1025	if (parent_id_winner == 'this' and name_winner == 'this'
3514.4.22 by John Arbash Meinel Handle executable bit changes as well.	1026	and sha1_winner == 'this' and exec_winner == 'this'):
	1027	# No kind, parent, name, exec, or content change for
	1028	# OTHER, so this node is not considered interesting
3514.4.20 by John Arbash Meinel Use the _lca_multi_way to work out if there is actually a kind/parent/name/content change.	1029	continue
	1030	if sha1_winner == 'this':
	1031	content_changed = False
3514.4.27 by John Arbash Meinel A couple of symlink tests, we need to do more.	1032	elif other_ie.kind == 'symlink':
3514.4.34 by John Arbash Meinel Handle symlinks properly when objects are not RevisionTrees	1033	def get_target(ie, tree):
3514.4.35 by John Arbash Meinel Add a test that we only call get_symlink_target if the object should be a symlink.	1034	if ie.kind != 'symlink':
3514.4.34 by John Arbash Meinel Handle symlinks properly when objects are not RevisionTrees	1035	return None
	1036	return tree.get_symlink_target(file_id)
	1037	base_target = get_target(base_ie, self.base_tree)
	1038	lca_targets = [get_target(ie, tree) for ie, tree
	1039	in zip(lca_entries, self._lca_trees)]
	1040	this_target = get_target(this_ie, self.this_tree)
	1041	other_target = get_target(other_ie, self.other_tree)
3514.4.39 by John Arbash Meinel Use self._lca_multi_way rather than Merge3Merger._lca_multi_way by Aaron's request.	1042	target_winner = self._lca_multi_way(
3514.4.34 by John Arbash Meinel Handle symlinks properly when objects are not RevisionTrees	1043	(base_target, lca_targets),
	1044	other_target, this_target)
3514.4.28 by John Arbash Meinel More symlink tests.	1045	if (parent_id_winner == 'this' and name_winner == 'this'
	1046	and target_winner == 'this'):
	1047	# No kind, parent, name, or symlink target change
	1048	# not interesting
	1049	continue
	1050	if target_winner == 'this':
	1051	content_changed = False
3514.4.33 by John Arbash Meinel Implement support for 'tree-reference'.	1052	elif other_ie.kind == 'tree-reference':
	1053	# The 'changed' information seems to be handled at a higher
	1054	# level. At least, _entries3 returns False for content
	1055	# changed, even when at a new revision_id.
	1056	content_changed = False
	1057	if (parent_id_winner == 'this' and name_winner == 'this'):
	1058	# Nothing interesting
	1059	continue
3514.4.21 by John Arbash Meinel Hook up the lca-way logic into the path handlers.	1060	else:
	1061	raise AssertionError('unhandled kind: %s' % other_ie.kind)
3514.4.13 by John Arbash Meinel Switch the lca_trees to be in 'find_merge_order'.	1062
	1063	# If we have gotten this far, that means something has changed
3514.4.20 by John Arbash Meinel Use the _lca_multi_way to work out if there is actually a kind/parent/name/content change.	1064	result.append((file_id, content_changed,
	1065	((base_ie.parent_id, lca_parent_ids),
	1066	other_ie.parent_id, this_ie.parent_id),
	1067	((base_ie.name, lca_names),
	1068	other_ie.name, this_ie.name),
	1069	((base_ie.executable, lca_executable),
	1070	other_ie.executable, this_ie.executable)
3514.4.5 by John Arbash Meinel Initial work on _entries_lca.	1071	))
	1072	return result
	1073
5954.4.3 by Aaron Bentley Mark fix_root as deprecated.	1074	@deprecated_method(deprecated_in((2, 4, 0)))
1731.1.33 by Aaron Bentley Revert no-special-root changes	1075	def fix_root(self):
4597.9.7 by Vincent Ladeuil transform.final_kind() now returns None instead of raising NoSuchFile.	1076	if self.tt.final_kind(self.tt.root) is None:
1731.1.33 by Aaron Bentley Revert no-special-root changes	1077	self.tt.cancel_deletion(self.tt.root)
1731.1.33 by Aaron Bentley Revert no-special-root changes	1078	if self.tt.final_file_id(self.tt.root) is None:
3943.8.1 by Marius Kruger remove all trailing whitespace from bzr source	1079	self.tt.version_file(self.tt.tree_file_id(self.tt.root),
1731.1.33 by Aaron Bentley Revert no-special-root changes	1080	self.tt.root)
2946.3.3 by John Arbash Meinel Prefer tree.get_root_id() as more explicit than tree.path2id('')	1081	other_root_file_id = self.other_tree.get_root_id()
3363.17.17 by Aaron Bentley Start testing merging PreviewTree as OTHER	1082	if other_root_file_id is None:
	1083	return
1731.1.33 by Aaron Bentley Revert no-special-root changes	1084	other_root = self.tt.trans_id_file_id(other_root_file_id)
	1085	if other_root == self.tt.root:
	1086	return
5967.7.1 by Martin Pool Deprecate __contains__ on Tree and Inventory	1087	if self.this_tree.inventory.has_id(
	1088	self.other_tree.inventory.root.file_id):
	1089	# the other tree's root is a non-root in the current tree (as
	1090	# 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.	1091	return
4597.9.9 by Vincent Ladeuil Fix wrong conflict resolution (thanks to test coverage...).	1092	if self.tt.final_kind(other_root) is not None:
4634.149.5 by Vincent Ladeuil Fixed as per John's review comments.	1093	other_root_is_present = True
4597.9.8 by Vincent Ladeuil Merge bzr.dev into cleanup	1094	else:
4634.149.5 by Vincent Ladeuil Fixed as per John's review comments.	1095	# other_root doesn't have a physical representation. We still need
	1096	# to move any references to the actual root of the tree.
	1097	other_root_is_present = False
	1098	# 'other_tree.inventory.root' is not present in this tree. We are
	1099	# calling adjust_path for children which want to be present with a
	1100	# correct place to go.
5783.2.1 by John Arbash Meinel Remove the 'include_unchanged=True' from iter_changes.	1101	for _, child in self.other_tree.inventory.root.children.iteritems():
4634.149.5 by Vincent Ladeuil Fixed as per John's review comments.	1102	trans_id = self.tt.trans_id_file_id(child.file_id)
	1103	if not other_root_is_present:
4597.9.8 by Vincent Ladeuil Merge bzr.dev into cleanup	1104	if self.tt.final_kind(trans_id) is not None:
4634.149.5 by Vincent Ladeuil Fixed as per John's review comments.	1105	# The item exist in the final tree and has a defined place
	1106	# to go already.
	1107	continue
	1108	# Move the item into the root
5783.2.2 by John Arbash Meinel Handle when a file doesn't exist anymore.	1109	try:
	1110	final_name = self.tt.final_name(trans_id)
	1111	except errors.NoFinalPath:
	1112	# This file is not present anymore, ignore it.
	1113	continue
	1114	self.tt.adjust_path(final_name, self.tt.root, trans_id)
4634.149.5 by Vincent Ladeuil Fixed as per John's review comments.	1115	if other_root_is_present:
4634.149.3 by Vincent Ladeuil Fix bug #3735898 by filtering out garbage paths.	1116	self.tt.cancel_creation(other_root)
	1117	self.tt.cancel_versioning(other_root)
1731.1.33 by Aaron Bentley Revert no-special-root changes	1118
1534.7.192 by Aaron Bentley Record hashes produced by merges	1119	def write_modified(self, results):
	1120	modified_hashes = {}
	1121	for path in results.modified_paths:
	1122	file_id = self.this_tree.path2id(self.this_tree.relpath(path))
	1123	if file_id is None:
	1124	continue
	1125	hash = self.this_tree.get_file_sha1(file_id)
	1126	if hash is None:
	1127	continue
	1128	modified_hashes[file_id] = hash
	1129	self.this_tree.set_merge_modified(modified_hashes)
	1130
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1131	@staticmethod
	1132	def parent(entry, file_id):
1534.7.157 by Aaron Bentley Added more docs	1133	"""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	1134	if entry is None:
	1135	return None
	1136	return entry.parent_id
	1137
	1138	@staticmethod
	1139	def name(entry, file_id):
1534.7.157 by Aaron Bentley Added more docs	1140	"""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	1141	if entry is None:
	1142	return None
	1143	return entry.name
3943.8.1 by Marius Kruger remove all trailing whitespace from bzr source	1144
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1145	@staticmethod
	1146	def contents_sha1(tree, file_id):
1534.7.157 by Aaron Bentley Added more docs	1147	"""Determine the sha1 of the file contents (used as a key method)."""
5967.7.1 by Martin Pool Deprecate __contains__ on Tree and Inventory	1148	if not tree.has_id(file_id):
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1149	return None
	1150	return tree.get_file_sha1(file_id)
	1151
	1152	@staticmethod
	1153	def executable(tree, file_id):
1534.7.157 by Aaron Bentley Added more docs	1154	"""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.	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	if tree.kind(file_id) != "file":
	1158	return False
	1159	return tree.is_executable(file_id)
	1160
	1161	@staticmethod
	1162	def kind(tree, file_id):
1534.7.157 by Aaron Bentley Added more docs	1163	"""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.	1164	if not tree.has_id(file_id):
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1165	return None
	1166	return tree.kind(file_id)
	1167
	1168	@staticmethod
2590.2.8 by Aaron Bentley Restore conflict handling changes	1169	def _three_way(base, other, this):
2590.2.8 by Aaron Bentley Restore conflict handling changes	1170	if base == other:
5128.1.1 by Vincent Ladeuil Uncontroversial cleanups, mostly comments	1171	# if 'base == other', either they all agree, or only 'this' has
	1172	# changed.
2590.2.8 by Aaron Bentley Restore conflict handling changes	1173	return 'this'
2590.2.10 by Aaron Bentley Updates from review	1174	elif this not in (base, other):
5128.1.1 by Vincent Ladeuil Uncontroversial cleanups, mostly comments	1175	# 'this' is neither 'base' nor 'other', so both sides changed
2590.2.8 by Aaron Bentley Restore conflict handling changes	1176	return 'conflict'
2590.2.8 by Aaron Bentley Restore conflict handling changes	1177	elif this == other:
5128.1.1 by Vincent Ladeuil Uncontroversial cleanups, mostly comments	1178	# "Ambiguous clean merge" -- both sides have made the same change.
2590.2.8 by Aaron Bentley Restore conflict handling changes	1179	return "this"
2590.2.8 by Aaron Bentley Restore conflict handling changes	1180	else:
5128.1.1 by Vincent Ladeuil Uncontroversial cleanups, mostly comments	1181	# this == base: only other has changed.
2590.2.8 by Aaron Bentley Restore conflict handling changes	1182	return "other"
	1183
	1184	@staticmethod
3514.4.30 by John Arbash Meinel Several updates.	1185	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.	1186	"""Consider LCAs when determining whether a change has occurred.
	1187
	1188	If LCAS are all identical, this is the same as a _three_way comparison.
	1189
	1190	:param bases: value in (BASE, [LCAS])
	1191	:param other: value in OTHER
	1192	:param this: value in THIS
3514.4.30 by John Arbash Meinel Several updates.	1193	:param allow_overriding_lca: If there is more than one unique lca
	1194	value, allow OTHER to override THIS if it has a new value, and
	1195	THIS only has an lca value, or vice versa. This is appropriate for
	1196	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.	1197	:return: 'this', 'other', or 'conflict' depending on whether an entry
	1198	changed or not.
	1199	"""
3948.1.7 by Vincent Ladeuil Slight refactoring and test fixing.	1200	# See doc/developers/lca_tree_merging.txt for details about this
3514.4.30 by John Arbash Meinel Several updates.	1201	# algorithm.
3514.4.19 by John Arbash Meinel Add the _lca_multi_way function, and explicit tests.	1202	if other == this:
	1203	# Either Ambiguously clean, or nothing was actually changed. We
	1204	# don't really care
	1205	return 'this'
	1206	base_val, lca_vals = bases
	1207	# Remove 'base_val' from the lca_vals, because it is not interesting
	1208	filtered_lca_vals = [lca_val for lca_val in lca_vals
	1209	if lca_val != base_val]
	1210	if len(filtered_lca_vals) == 0:
	1211	return Merge3Merger._three_way(base_val, other, this)
3514.4.30 by John Arbash Meinel Several updates.	1212
	1213	unique_lca_vals = set(filtered_lca_vals)
	1214	if len(unique_lca_vals) == 1:
	1215	return Merge3Merger._three_way(unique_lca_vals.pop(), other, this)
	1216
	1217	if allow_overriding_lca:
	1218	if other in unique_lca_vals:
	1219	if this in unique_lca_vals:
	1220	# Each side picked a different lca, conflict
	1221	return 'conflict'
	1222	else:
	1223	# This has a value which supersedes both lca values, and
	1224	# other only has an lca value
	1225	return 'this'
	1226	elif this in unique_lca_vals:
	1227	# 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.	1228	# only has an lca value
3514.4.30 by John Arbash Meinel Several updates.	1229	return 'other'
3514.4.19 by John Arbash Meinel Add the _lca_multi_way function, and explicit tests.	1230
5128.1.1 by Vincent Ladeuil Uncontroversial cleanups, mostly comments	1231	# 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.	1232	return 'conflict'
	1233
	1234	@staticmethod
5077.2.1 by Vincent Ladeuil Deprecate Merge3Merger.scalar_three_way.	1235	@deprecated_method(deprecated_in((2, 2, 0)))
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1236	def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
	1237	"""Do a three-way test on a scalar.
	1238	Return "this", "other" or "conflict", depending whether a value wins.
	1239	"""
	1240	key_base = key(base_tree, file_id)
	1241	key_other = key(other_tree, file_id)
	1242	#if base == other, either they all agree, or only THIS has changed.
	1243	if key_base == key_other:
	1244	return "this"
	1245	key_this = key(this_tree, file_id)
3376.2.4 by Martin Pool Remove every assert statement from bzrlib!	1246	# "Ambiguous clean merge"
	1247	if key_this == key_other:
	1248	return "this"
	1249	elif key_this == key_base:
	1250	return "other"
	1251	else:
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1252	return "conflict"
	1253
	1254	def merge_names(self, file_id):
	1255	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.	1256	if tree.has_id(file_id):
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1257	return tree.inventory[file_id]
	1258	else:
	1259	return None
	1260	this_entry = get_entry(self.this_tree)
	1261	other_entry = get_entry(self.other_tree)
	1262	base_entry = get_entry(self.base_tree)
2590.2.1 by Aaron Bentley Start work on merging names based on iter_changes	1263	entries = (base_entry, other_entry, this_entry)
	1264	names = []
	1265	parents = []
	1266	for entry in entries:
	1267	if entry is None:
	1268	names.append(None)
	1269	parents.append(None)
	1270	else:
	1271	names.append(entry.name)
	1272	parents.append(entry.parent_id)
3514.4.40 by John Arbash Meinel Make 'resolver' a required parameter.	1273	return self._merge_names(file_id, parents, names,
	1274	resolver=self._three_way)
2590.2.1 by Aaron Bentley Start work on merging names based on iter_changes	1275
3514.4.40 by John Arbash Meinel Make 'resolver' a required parameter.	1276	def _merge_names(self, file_id, parents, names, resolver):
2590.2.7 by Aaron Bentley Misc cleanup	1277	"""Perform a merge on file_id names and parents"""
2590.2.1 by Aaron Bentley Start work on merging names based on iter_changes	1278	base_name, other_name, this_name = names
	1279	base_parent, other_parent, this_parent = parents
2590.2.2 by Aaron Bentley Do most name merging from iter_changes output	1280
3514.4.21 by John Arbash Meinel Hook up the lca-way logic into the path handlers.	1281	name_winner = resolver(*names)
2590.2.1 by Aaron Bentley Start work on merging names based on iter_changes	1282
3514.4.21 by John Arbash Meinel Hook up the lca-way logic into the path handlers.	1283	parent_id_winner = resolver(*parents)
2590.2.2 by Aaron Bentley Do most name merging from iter_changes output	1284	if this_name is None:
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1285	if name_winner == "this":
	1286	name_winner = "other"
	1287	if parent_id_winner == "this":
	1288	parent_id_winner = "other"
	1289	if name_winner == "this" and parent_id_winner == "this":
	1290	return
4597.7.11 by Vincent Ladeuil Fix #531967 by creating helpers for PathConflicts when a deletion	1291	if name_winner == 'conflict' or parent_id_winner == 'conflict':
4597.7.18 by Vincent Ladeuil Start addressing Andrew's concerns.	1292	# Creating helpers (.OTHER or .THIS) here cause problems down the
	1293	# road if a ContentConflict needs to be created so we should not do
	1294	# that
4597.7.11 by Vincent Ladeuil Fix #531967 by creating helpers for PathConflicts when a deletion	1295	trans_id = self.tt.trans_id_file_id(file_id)
	1296	self._raw_conflicts.append(('path conflict', trans_id, file_id,
	1297	this_parent, this_name,
	1298	other_parent, other_name))
5954.4.2 by Aaron Bentley Support merging into null tree.	1299	if not self.other_tree.has_id(file_id):
3943.8.1 by Marius Kruger remove all trailing whitespace from bzr source	1300	# it doesn't matter whether the result was 'other' or
5954.4.6 by Aaron Bentley Updates from review.	1301	# 'conflict'-- if it has no file id, we leave it alone.
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1302	return
2590.2.7 by Aaron Bentley Misc cleanup	1303	parent_id = parents[self.winner_idx[parent_id_winner]]
5954.4.2 by Aaron Bentley Support merging into null tree.	1304	name = names[self.winner_idx[name_winner]]
5954.4.2 by Aaron Bentley Support merging into null tree.	1305	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	1306	# if we get here, name_winner and parent_winner are set to safe
	1307	# values.
5954.4.2 by Aaron Bentley Support merging into null tree.	1308	if parent_id is None and name is not None:
	1309	# if parent_id is None and name is non-None, current file is
	1310	# the tree root.
	1311	if names[self.winner_idx[parent_id_winner]] != '':
	1312	raise AssertionError(
	1313	'File looks like a root, but named %s' %
	1314	names[self.winner_idx[parent_id_winner]])
	1315	parent_trans_id = transform.ROOT_PARENT
	1316	else:
	1317	parent_trans_id = self.tt.trans_id_file_id(parent_id)
	1318	self.tt.adjust_path(name, parent_trans_id,
4597.7.11 by Vincent Ladeuil Fix #531967 by creating helpers for PathConflicts when a deletion	1319	self.tt.trans_id_file_id(file_id))
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1320
4797.5.1 by Robert Collins Support state on per-file merging to permit more efficient use of configuration data.	1321	def _do_merge_contents(self, file_id):
3874.2.10 by Vincent Ladeuil Fix typo.	1322	"""Performs a merge on file_id contents."""
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1323	def contents_pair(tree):
5967.7.1 by Martin Pool Deprecate __contains__ on Tree and Inventory	1324	if not tree.has_id(file_id):
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1325	return (None, None)
	1326	kind = tree.kind(file_id)
	1327	if kind == "file":
	1328	contents = tree.get_file_sha1(file_id)
	1329	elif kind == "symlink":
	1330	contents = tree.get_symlink_target(file_id)
	1331	else:
	1332	contents = None
	1333	return kind, contents
1558.15.3 by Aaron Bentley Handle binary files for diff3 merges	1334
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1335	# See SPOT run. run, SPOT, run.
	1336	# So we're not QUITE repeating ourselves; we do tricky things with
	1337	# file kind...
	1338	base_pair = contents_pair(self.base_tree)
	1339	other_pair = contents_pair(self.other_tree)
3955.2.1 by John Arbash Meinel Change the workings of merge_content to be lca aware.	1340	if self._lca_trees:
3948.1.7 by Vincent Ladeuil Slight refactoring and test fixing.	1341	this_pair = contents_pair(self.this_tree)
3955.2.1 by John Arbash Meinel Change the workings of merge_content to be lca aware.	1342	lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
	1343	winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
	1344	this_pair, allow_overriding_lca=False)
	1345	else:
3948.1.7 by Vincent Ladeuil Slight refactoring and test fixing.	1346	if base_pair == other_pair:
	1347	winner = 'this'
	1348	else:
	1349	# We delayed evaluating this_pair as long as we can to avoid
	1350	# unnecessary sha1 calculation
	1351	this_pair = contents_pair(self.this_tree)
	1352	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.	1353	if winner == 'this':
	1354	# No interesting changes introduced by OTHER
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1355	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.	1356	# We have a hypothetical conflict, but if we have files, then we
	1357	# can try to merge the content
4869.3.16 by Andrew Bennetts Move handling of winner==OTHER case into generic hook path too.	1358	trans_id = self.tt.trans_id_file_id(file_id)
6388.1.3 by Jelmer Vernooij Add pre and post merge hooks.	1359	params = MergeFileHookParams(self, file_id, trans_id, this_pair[0],
4869.3.21 by Andrew Bennetts Pass kinds (not pairs) to MergeHookParams.	1360	other_pair[0], winner)
4797.5.1 by Robert Collins Support state on per-file merging to permit more efficient use of configuration data.	1361	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.	1362	hook_status = 'not_applicable'
	1363	for hook in hooks:
4797.5.1 by Robert Collins Support state on per-file merging to permit more efficient use of configuration data.	1364	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.	1365	if hook_status != 'not_applicable':
	1366	# 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.	1367	break
6015.47.8 by Vincent Ladeuil Address some points from gz's review.	1368	# If the merge ends up replacing the content of the file, we get rid of
	1369	# it at the end of this method (this variable is used to track the
	1370	# 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.	1371	keep_this = False
4869.3.18 by Andrew Bennetts Simplify slightly more.	1372	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.	1373	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	1374	# No merge hook was able to resolve the situation. Two cases exist:
	1375	# a content conflict or a duplicate one.
4869.3.18 by Andrew Bennetts Simplify slightly more.	1376	result = None
4869.3.17 by Andrew Bennetts Remove contents_conflict nested function, replace last callsite with simpler form.	1377	name = self.tt.final_name(trans_id)
	1378	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.	1379	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	1380	inhibit_content_conflict = False
	1381	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.	1382	# Is the name used for a different file_id ?
	1383	dupe_path = self.other_tree.id2path(file_id)
	1384	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	1385	if this_id is not None:
	1386	# Two entries for the same path
	1387	keep_this = True
	1388	# versioning the merged file will trigger a duplicate
	1389	# conflict
	1390	self.tt.version_file(file_id, trans_id)
	1391	transform.create_from_tree(
	1392	self.tt, trans_id, self.other_tree, file_id,
	1393	filter_tree_path=self._get_filter_tree_path(file_id))
	1394	inhibit_content_conflict = True
	1395	elif params.other_kind is None: # file_id is not in OTHER
	1396	# Is the name used for a different file_id ?
	1397	dupe_path = self.this_tree.id2path(file_id)
	1398	other_id = self.other_tree.path2id(dupe_path)
	1399	if other_id is not None:
	1400	# Two entries for the same path again, but here, the other
	1401	# entry will also be merged. We simply inhibit the
	1402	# 'content' conflict creation because we know OTHER will
	1403	# create (or has already created depending on ordering) an
	1404	# entry at the same path. This will trigger a 'duplicate'
	1405	# conflict later.
	1406	keep_this = True
	1407	inhibit_content_conflict = True
	1408	if not inhibit_content_conflict:
	1409	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.	1410	self.tt.unversion_file(trans_id)
	1411	# This is a contents conflict, because none of the available
	1412	# functions could merge it.
	1413	file_group = self._dump_conflicts(name, parent_id, file_id,
	1414	set_version=True)
	1415	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.	1416	elif hook_status == 'success':
	1417	self.tt.create_file(lines, trans_id)
	1418	elif hook_status == 'conflicted':
	1419	# XXX: perhaps the hook should be able to provide
	1420	# the BASE/THIS/OTHER files?
	1421	self.tt.create_file(lines, trans_id)
	1422	self._raw_conflicts.append(('text conflict', trans_id))
	1423	name = self.tt.final_name(trans_id)
	1424	parent_id = self.tt.final_parent(trans_id)
4869.3.23 by Andrew Bennetts Remove some confusing code that has no effect.	1425	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.	1426	elif hook_status == 'delete':
	1427	self.tt.unversion_file(trans_id)
4869.3.18 by Andrew Bennetts Simplify slightly more.	1428	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.	1429	elif hook_status == 'done':
	1430	# The hook function did whatever it needs to do directly, no
	1431	# further action needed here.
	1432	pass
	1433	else:
4869.3.18 by Andrew Bennetts Simplify slightly more.	1434	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.	1435	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.	1436	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.	1437	if not keep_this:
6015.47.8 by Vincent Ladeuil Address some points from gz's review.	1438	# The merge has been performed and produced a new content, so the
	1439	# 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.	1440	self.tt.delete_contents(trans_id)
4869.3.18 by Andrew Bennetts Simplify slightly more.	1441	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.	1442
4869.3.16 by Andrew Bennetts Move handling of winner==OTHER case into generic hook path too.	1443	def _default_other_winner_merge(self, merge_hook_params):
	1444	"""Replace this contents with other."""
	1445	file_id = merge_hook_params.file_id
	1446	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.	1447	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.	1448	# 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.	1449	transform.create_from_tree(
	1450	self.tt, trans_id, self.other_tree, file_id,
	1451	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.	1452	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.	1453	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.	1454	# OTHER deleted the file
	1455	return 'delete', None
	1456	else:
	1457	raise AssertionError(
	1458	'winner is OTHER, but file_id %r not in THIS or OTHER tree'
	1459	% (file_id,))
	1460
4797.5.1 by Robert Collins Support state on per-file merging to permit more efficient use of configuration data.	1461	def merge_contents(self, merge_hook_params):
	1462	"""Fallback merge logic after user installed hooks."""
	1463	# This function is used in merge hooks as the fallback instance.
	1464	# Perhaps making this function and the functions it calls be a
	1465	# a separate class would be better.
4869.3.16 by Andrew Bennetts Move handling of winner==OTHER case into generic hook path too.	1466	if merge_hook_params.winner == 'other':
	1467	# OTHER is a straight winner, so replace this contents with other
	1468	return self._default_other_winner_merge(merge_hook_params)
	1469	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.	1470	# THIS and OTHER are both files, so text merge. Either
	1471	# BASE is a file, or both converted to files, so at least we
	1472	# have agreement that output should be a file.
	1473	try:
	1474	self.text_merge(merge_hook_params.file_id,
	1475	merge_hook_params.trans_id)
	1476	except errors.BinaryFile:
	1477	return 'not_applicable', None
4869.3.16 by Andrew Bennetts Move handling of winner==OTHER case into generic hook path too.	1478	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.	1479	else:
	1480	return 'not_applicable', None
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1481
	1482	def get_lines(self, tree, file_id):
1534.7.157 by Aaron Bentley Added more docs	1483	"""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.	1484	if tree.has_id(file_id):
4708.2.1 by Martin Ensure all files opened by bazaar proper are explicitly closed	1485	return tree.get_file_lines(file_id)
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1486	else:
	1487	return []
	1488
	1489	def text_merge(self, file_id, trans_id):
	1490	"""Perform a three-way text merge on a file_id"""
	1491	# it's possible that we got here with base as a different type.
	1492	# 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.	1493	if self.base_tree.has_id(file_id) and \
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1494	self.base_tree.kind(file_id) == "file":
	1495	base_lines = self.get_lines(self.base_tree, file_id)
	1496	else:
	1497	base_lines = []
	1498	other_lines = self.get_lines(self.other_tree, file_id)
	1499	this_lines = self.get_lines(self.this_tree, file_id)
4721.3.1 by Vincent Ladeuil Cleanup imports.	1500	m3 = merge3.Merge3(base_lines, this_lines, other_lines,
4721.3.1 by Vincent Ladeuil Cleanup imports.	1501	is_cherrypick=self.cherrypick)
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1502	start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
	1503	if self.show_base is True:
	1504	base_marker = '\|' * 7
	1505	else:
	1506	base_marker = None
	1507
	1508	def iter_merge3(retval):
	1509	retval["text_conflicts"] = False
3943.8.1 by Marius Kruger remove all trailing whitespace from bzr source	1510	for line in m3.merge_lines(name_a = "TREE",
	1511	name_b = "MERGE-SOURCE",
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1512	name_base = "BASE-REVISION",
3943.8.1 by Marius Kruger remove all trailing whitespace from bzr source	1513	start_marker=start_marker,
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1514	base_marker=base_marker,
	1515	reprocess=self.reprocess):
	1516	if line.startswith(start_marker):
	1517	retval["text_conflicts"] = True
	1518	yield line.replace(start_marker, '<' * 7)
	1519	else:
	1520	yield line
	1521	retval = {}
	1522	merge3_iterator = iter_merge3(retval)
	1523	self.tt.create_file(merge3_iterator, trans_id)
	1524	if retval["text_conflicts"] is True:
	1525	self._raw_conflicts.append(('text conflict', trans_id))
	1526	name = self.tt.final_name(trans_id)
	1527	parent_id = self.tt.final_parent(trans_id)
3943.8.1 by Marius Kruger remove all trailing whitespace from bzr source	1528	file_group = self._dump_conflicts(name, parent_id, file_id,
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1529	this_lines, base_lines,
	1530	other_lines)
	1531	file_group.append(trans_id)
	1532
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.	1533
	1534	def _get_filter_tree_path(self, file_id):
6015.47.8 by Vincent Ladeuil Address some points from gz's review.	1535	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.	1536	# We get the path from the working tree if it exists.
	1537	# That fails though when OTHER is adding a file, so
	1538	# we fall back to the other tree to find the path if
	1539	# it doesn't exist locally.
	1540	try:
6015.47.8 by Vincent Ladeuil Address some points from gz's review.	1541	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.	1542	except errors.NoSuchId:
6015.47.8 by Vincent Ladeuil Address some points from gz's review.	1543	return self.other_tree.id2path(file_id)
	1544	# Skip the id2path lookup for older formats
	1545	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.	1546
3943.8.1 by Marius Kruger remove all trailing whitespace from bzr source	1547	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	1548	base_lines=None, other_lines=None, set_version=False,
	1549	no_base=False):
1534.7.157 by Aaron Bentley Added more docs	1550	"""Emit conflict files.
	1551	If this_lines, base_lines, or other_lines are omitted, they will be
	1552	determined automatically. If set_version is true, the .OTHER, .THIS
	1553	or .BASE (in that order) will be created as versioned files.
	1554	"""
3943.8.1 by Marius Kruger remove all trailing whitespace from bzr source	1555	data = [('OTHER', self.other_tree, other_lines),
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1556	('THIS', self.this_tree, this_lines)]
	1557	if not no_base:
	1558	data.append(('BASE', self.base_tree, base_lines))
4443.2.1 by Ian Clatworthy apply content filters when merging new files	1559
	1560	# We need to use the actual path in the working tree of the file here,
	1561	# ignoring the conflict suffixes
	1562	wt = self.this_tree
	1563	if wt.supports_content_filtering():
	1564	try:
	1565	filter_tree_path = wt.id2path(file_id)
	1566	except errors.NoSuchId:
	1567	# file has been deleted
	1568	filter_tree_path = None
	1569	else:
	1570	# Skip the id2path lookup for older formats
	1571	filter_tree_path = None
	1572
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1573	versioned = False
	1574	file_group = []
	1575	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.	1576	if tree.has_id(file_id):
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1577	trans_id = self._conflict_file(name, parent_id, tree, file_id,
4443.2.1 by Ian Clatworthy apply content filters when merging new files	1578	suffix, lines, filter_tree_path)
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1579	file_group.append(trans_id)
	1580	if set_version and not versioned:
	1581	self.tt.version_file(file_id, trans_id)
	1582	versioned = True
	1583	return file_group
3943.8.1 by Marius Kruger remove all trailing whitespace from bzr source	1584
3363.17.21 by Aaron Bentley Conflicts are handled when merging from preview trees	1585	def _conflict_file(self, name, parent_id, tree, file_id, suffix,
4443.2.1 by Ian Clatworthy apply content filters when merging new files	1586	lines=None, filter_tree_path=None):
1534.7.157 by Aaron Bentley Added more docs	1587	"""Emit a single conflict file."""
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1588	name = name + '.' + suffix
	1589	trans_id = self.tt.create_path(name, parent_id)
4854.1.1 by Andrew Bennetts Merge lp:bzr/2.0 into lp:bzr.	1590	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	1591	filter_tree_path)
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1592	return trans_id
	1593
	1594	def merge_executable(self, file_id, file_status):
1534.7.157 by Aaron Bentley Added more docs	1595	"""Perform a merge on the execute bit."""
2590.2.3 by Aaron Bentley Merge the execute bit based on iter_changes	1596	executable = [self.executable(t, file_id) for t in (self.base_tree,
	1597	self.other_tree, self.this_tree)]
3514.4.40 by John Arbash Meinel Make 'resolver' a required parameter.	1598	self._merge_executable(file_id, executable, file_status,
	1599	resolver=self._three_way)
2590.2.3 by Aaron Bentley Merge the execute bit based on iter_changes	1600
3514.4.21 by John Arbash Meinel Hook up the lca-way logic into the path handlers.	1601	def _merge_executable(self, file_id, executable, file_status,
3514.4.40 by John Arbash Meinel Make 'resolver' a required parameter.	1602	resolver):
2590.2.3 by Aaron Bentley Merge the execute bit based on iter_changes	1603	"""Perform a merge on the execute bit."""
	1604	base_executable, other_executable, this_executable = executable
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1605	if file_status == "deleted":
	1606	return
3514.4.21 by John Arbash Meinel Hook up the lca-way logic into the path handlers.	1607	winner = resolver(*executable)
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1608	if winner == "conflict":
	1609	# There must be a None in here, if we have a conflict, but we
	1610	# need executability since file status was not deleted.
1534.10.35 by Aaron Bentley Merge handles contents + executable + deletion conflict	1611	if self.executable(self.other_tree, file_id) is None:
1534.7.142 by Aaron Bentley Fixed executability conflicts	1612	winner = "this"
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1613	else:
1534.7.142 by Aaron Bentley Fixed executability conflicts	1614	winner = "other"
1551.19.30 by Aaron Bentley Accelerate merge by skipping file existence check when merging execute bit	1615	if winner == 'this' and file_status != "modified":
	1616	return
	1617	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.	1618	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	1619	return
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1620	if winner == "this":
1551.19.30 by Aaron Bentley Accelerate merge by skipping file existence check when merging execute bit	1621	executability = this_executable
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1622	else:
4869.3.22 by Andrew Bennetts Use 'tree.has_id(file_id)' rather than using 'file_id in tree' or using tree.inventory.	1623	if self.other_tree.has_id(file_id):
2590.2.3 by Aaron Bentley Merge the execute bit based on iter_changes	1624	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.	1625	elif self.this_tree.has_id(file_id):
2590.2.3 by Aaron Bentley Merge the execute bit based on iter_changes	1626	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.	1627	elif self.base_tree_has_id(file_id):
2590.2.3 by Aaron Bentley Merge the execute bit based on iter_changes	1628	executability = base_executable
1551.19.30 by Aaron Bentley Accelerate merge by skipping file existence check when merging execute bit	1629	if executability is not None:
	1630	trans_id = self.tt.trans_id_file_id(file_id)
	1631	self.tt.set_executability(executability, trans_id)
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1632
1534.7.172 by Aaron Bentley Integrated fs conflicts with merge conflicts.	1633	def cook_conflicts(self, fs_conflicts):
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1634	"""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	1635	content_conflict_file_ids = set()
	1636	cooked_conflicts = transform.cook_conflicts(fs_conflicts, self.tt)
4721.3.1 by Vincent Ladeuil Cleanup imports.	1637	fp = transform.FinalPaths(self.tt)
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1638	for conflict in self._raw_conflicts:
	1639	conflict_type = conflict[0]
4597.7.11 by Vincent Ladeuil Fix #531967 by creating helpers for PathConflicts when a deletion	1640	if conflict_type == 'path conflict':
	1641	(trans_id, file_id,
	1642	this_parent, this_name,
	1643	other_parent, other_name) = conflict[1:]
	1644	if this_parent is None or this_name is None:
	1645	this_path = '<deleted>'
	1646	else:
	1647	parent_path = fp.get_path(
	1648	self.tt.trans_id_file_id(this_parent))
	1649	this_path = osutils.pathjoin(parent_path, this_name)
	1650	if other_parent is None or other_name is None:
	1651	other_path = '<deleted>'
	1652	else:
5050.73.8 by Vincent Ladeuil Handle path conflicts involving different root-ids	1653	if other_parent == self.other_tree.get_root_id():
5050.73.9 by Vincent Ladeuil Fix typo.	1654	# The tree transform doesn't know about the other root,
5050.73.8 by Vincent Ladeuil Handle path conflicts involving different root-ids	1655	# so we special case here to avoid a NoFinalPath
	1656	# exception
	1657	parent_path = ''
	1658	else:
	1659	parent_path = fp.get_path(
	1660	self.tt.trans_id_file_id(other_parent))
4597.7.11 by Vincent Ladeuil Fix #531967 by creating helpers for PathConflicts when a deletion	1661	other_path = osutils.pathjoin(parent_path, other_name)
	1662	c = _mod_conflicts.Conflict.factory(
	1663	'path conflict', path=this_path,
	1664	conflict_path=other_path,
	1665	file_id=file_id)
	1666	elif conflict_type == 'contents conflict':
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1667	for trans_id in conflict[1]:
	1668	file_id = self.tt.final_file_id(trans_id)
	1669	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.	1670	# Ok we found the relevant file-id
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1671	break
	1672	path = fp.get_path(trans_id)
	1673	for suffix in ('.BASE', '.THIS', '.OTHER'):
	1674	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.	1675	# Here is the raw path
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1676	path = path[:-len(suffix)]
	1677	break
4721.3.1 by Vincent Ladeuil Cleanup imports.	1678	c = _mod_conflicts.Conflict.factory(conflict_type,
4721.3.1 by Vincent Ladeuil Cleanup imports.	1679	path=path, file_id=file_id)
5988.2.1 by Vincent Ladeuil Do not generate path conflicts if a corresponding content conflict exists	1680	content_conflict_file_ids.add(file_id)
4597.7.11 by Vincent Ladeuil Fix #531967 by creating helpers for PathConflicts when a deletion	1681	elif conflict_type == 'text conflict':
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1682	trans_id = conflict[1]
	1683	path = fp.get_path(trans_id)
	1684	file_id = self.tt.final_file_id(trans_id)
4721.3.1 by Vincent Ladeuil Cleanup imports.	1685	c = _mod_conflicts.Conflict.factory(conflict_type,
4721.3.1 by Vincent Ladeuil Cleanup imports.	1686	path=path, file_id=file_id)
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1687	else:
4597.7.18 by Vincent Ladeuil Start addressing Andrew's concerns.	1688	raise AssertionError('bad conflict type: %r' % (conflict,))
5988.2.1 by Vincent Ladeuil Do not generate path conflicts if a corresponding content conflict exists	1689	cooked_conflicts.append(c)
5988.2.2 by Vincent Ladeuil Make it clear that we start from an empty cooked_conflicts list.	1690
	1691	self.cooked_conflicts = []
5988.2.1 by Vincent Ladeuil Do not generate path conflicts if a corresponding content conflict exists	1692	# We want to get rid of path conflicts when a corresponding contents
	1693	# conflict exists. This can occur when one branch deletes a file while
	1694	# the other renames and modifies it. In this case, the content
	1695	# conflict is enough.
	1696	for c in cooked_conflicts:
	1697	if (c.typestring == 'path conflict'
	1698	and c.file_id in content_conflict_file_ids):
	1699	continue
1534.10.19 by Aaron Bentley Stanza conversion, cooking	1700	self.cooked_conflicts.append(c)
4721.3.1 by Vincent Ladeuil Cleanup imports.	1701	self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1534.7.141 by Aaron Bentley Added conflict reporting	1702
1534.7.141 by Aaron Bentley Added conflict reporting	1703
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1704	class WeaveMerger(Merge3Merger):
1534.7.167 by Aaron Bentley PEP8 and comment cleanups	1705	"""Three-way tree merger, text weave merger."""
1551.6.8 by Aaron Bentley Implemented reprocess for weave	1706	supports_reprocess = True
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1707	supports_show_base = False
3062.2.7 by Aaron Bentley Prevent reverse cherry-picking with weave	1708	supports_reverse_cherrypick = False
3062.2.9 by Aaron Bentley Don't use the base if not cherrypicking	1709	history_based = True
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1710
4634.101.7 by John Arbash Meinel Start working on the ability to drop a .BASE file for --weave and --lca merge.	1711	def _generate_merge_plan(self, file_id, base):
	1712	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	1713	base=base)
4634.101.7 by John Arbash Meinel Start working on the ability to drop a .BASE file for --weave and --lca merge.	1714
	1715	def _merged_lines(self, file_id):
	1716	"""Generate the merged lines.
	1717	There is no distinction between lines that are meant to contain <<<<<<<
	1718	and conflicts.
	1719	"""
	1720	if self.cherrypick:
	1721	base = self.base_tree
	1722	else:
	1723	base = None
	1724	plan = self._generate_merge_plan(file_id, base)
1551.19.17 by Aaron Bentley Add debugging flag for merges	1725	if 'merge' in debug.debug_flags:
	1726	plan = list(plan)
	1727	trans_id = self.tt.trans_id_file_id(file_id)
	1728	name = self.tt.final_name(trans_id) + '.plan'
4634.101.6 by John Arbash Meinel killed-both and killed-base is 11 chars long.	1729	contents = ('%11s\|%s' % l for l in plan)
1551.19.17 by Aaron Bentley Add debugging flag for merges	1730	self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
4721.3.1 by Vincent Ladeuil Cleanup imports.	1731	textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
4721.3.1 by Vincent Ladeuil Cleanup imports.	1732	'>>>>>>> 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.	1733	lines, conflicts = textmerge.merge_lines(self.reprocess)
	1734	if conflicts:
	1735	base_lines = textmerge.base_from_plan()
	1736	else:
	1737	base_lines = None
	1738	return lines, base_lines
4869.2.2 by Andrew Bennetts Remove some duplication.	1739
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1740	def text_merge(self, file_id, trans_id):
1534.7.157 by Aaron Bentley Added more docs	1741	"""Perform a (weave) text merge for a given file and file-id.
	1742	If conflicts are encountered, .THIS and .OTHER files will be emitted,
	1743	and a conflict will be noted.
	1744	"""
4634.101.7 by John Arbash Meinel Start working on the ability to drop a .BASE file for --weave and --lca merge.	1745	lines, base_lines = self._merged_lines(file_id)
1558.15.10 by Aaron Bentley Merge bzr.dev	1746	lines = list(lines)
3943.8.1 by Marius Kruger remove all trailing whitespace from bzr source	1747	# Note we're checking whether the OUTPUT is binary in this case,
1558.15.5 by Aaron Bentley Fixed binary handling in weave merge	1748	# because we don't want to get into weave merge guts.
4721.3.1 by Vincent Ladeuil Cleanup imports.	1749	textfile.check_text_lines(lines)
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1750	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.	1751	if base_lines is not None:
	1752	# Conflict
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1753	self._raw_conflicts.append(('text conflict', trans_id))
	1754	name = self.tt.final_name(trans_id)
	1755	parent_id = self.tt.final_parent(trans_id)
3943.8.1 by Marius Kruger remove all trailing whitespace from bzr source	1756	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.	1757	no_base=False,
	1758	base_lines=base_lines)
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1759	file_group.append(trans_id)
	1760
	1761
3144.3.1 by Aaron Bentley Implement LCA merge, with problematic conflict markers	1762	class LCAMerger(WeaveMerger):
	1763
4634.101.7 by John Arbash Meinel Start working on the ability to drop a .BASE file for --weave and --lca merge.	1764	def _generate_merge_plan(self, file_id, base):
	1765	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	1766	base=base)
	1767
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1768	class Diff3Merger(Merge3Merger):
1534.7.167 by Aaron Bentley PEP8 and comment cleanups	1769	"""Three-way merger using external diff3 for text merging"""
1711.7.20 by John Arbash Meinel always close files, minor PEP8 cleanup	1770
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1771	def dump_file(self, temp_dir, name, tree, file_id):
4721.3.1 by Vincent Ladeuil Cleanup imports.	1772	out_path = osutils.pathjoin(temp_dir, name)
1711.7.20 by John Arbash Meinel always close files, minor PEP8 cleanup	1773	out_file = open(out_path, "wb")
	1774	try:
	1775	in_file = tree.get_file(file_id)
	1776	for line in in_file:
	1777	out_file.write(line)
	1778	finally:
	1779	out_file.close()
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1780	return out_path
	1781
	1782	def text_merge(self, file_id, trans_id):
1534.7.157 by Aaron Bentley Added more docs	1783	"""Perform a diff3 merge using a specified file-id and trans-id.
	1784	If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
	1785	will be dumped, and a will be conflict noted.
	1786	"""
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1787	import bzrlib.patch
1996.3.18 by John Arbash Meinel Now that mkdtemp and rmtree are lazy, they should not be directly improted.	1788	temp_dir = osutils.mkdtemp(prefix="bzr-")
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1789	try:
4721.3.1 by Vincent Ladeuil Cleanup imports.	1790	new_file = osutils.pathjoin(temp_dir, "new")
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1791	this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
	1792	base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
	1793	other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
	1794	status = bzrlib.patch.diff3(new_file, this, base, other)
	1795	if status not in (0, 1):
4721.3.1 by Vincent Ladeuil Cleanup imports.	1796	raise errors.BzrError("Unhandled diff3 exit code")
1711.7.20 by John Arbash Meinel always close files, minor PEP8 cleanup	1797	f = open(new_file, 'rb')
	1798	try:
	1799	self.tt.create_file(f, trans_id)
	1800	finally:
	1801	f.close()
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1802	if status == 1:
	1803	name = self.tt.final_name(trans_id)
	1804	parent_id = self.tt.final_parent(trans_id)
	1805	self._dump_conflicts(name, parent_id, file_id)
1551.8.39 by Aaron Bentley Fix diff3 conflict-reporting bug	1806	self._raw_conflicts.append(('text conflict', trans_id))
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1807	finally:
1996.3.18 by John Arbash Meinel Now that mkdtemp and rmtree are lazy, they should not be directly improted.	1808	osutils.rmtree(temp_dir)
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1809
	1810
5246.2.18 by Andrew Bennetts Fix traceback if source path does not exist.	1811	class PathNotInTree(errors.BzrError):
	1812
5246.2.28 by Andrew Bennetts Improve some docstrings.	1813	_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.	1814
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.	1815	def __init__(self, path, tree):
	1816	errors.BzrError.__init__(self, path=path, tree=tree)
5246.2.18 by Andrew Bennetts Fix traceback if source path does not exist.	1817
	1818
5246.2.1 by Andrew Bennetts Very rough first draft of cmd_merge_into from bzr-merge-into. Passes its blackbox tests.	1819	class MergeIntoMerger(Merger):
	1820	"""Merger that understands other_tree will be merged into a subdir.
	1821
	1822	This also changes the Merger api so that it uses real Branch, revision_id,
	1823	and RevisonTree objects, rather than using revision specs.
	1824	"""
	1825
	1826	def __init__(self, this_tree, other_branch, other_tree, target_subdir,
5246.2.22 by Andrew Bennetts Minor tweaks.	1827	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.	1828	"""Create a new MergeIntoMerger object.
	1829
5246.2.6 by Andrew Bennetts Improve some docstrings. Simplify code slightly.	1830	source_subpath in other_tree will be effectively copied to
	1831	target_subdir in this_tree.
	1832
5246.2.1 by Andrew Bennetts Very rough first draft of cmd_merge_into from bzr-merge-into. Passes its blackbox tests.	1833	:param this_tree: The tree that we will be merging into.
	1834	:param other_branch: The Branch we will be merging from.
	1835	:param other_tree: The RevisionTree object we want to merge.
	1836	:param target_subdir: The relative path where we want to merge
	1837	other_tree into this_tree
5246.2.6 by Andrew Bennetts Improve some docstrings. Simplify code slightly.	1838	:param source_subpath: The relative path specifying the subtree of
	1839	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.	1840	"""
	1841	# It is assumed that we are merging a tree that is not in our current
	1842	# ancestry, which means we are using the "EmptyTree" as our basis.
	1843	null_ancestor_tree = this_tree.branch.repository.revision_tree(
	1844	_mod_revision.NULL_REVISION)
	1845	super(MergeIntoMerger, self).__init__(
	1846	this_branch=this_tree.branch,
	1847	this_tree=this_tree,
	1848	other_tree=other_tree,
	1849	base_tree=null_ancestor_tree,
	1850	)
	1851	self._target_subdir = target_subdir
	1852	self._source_subpath = source_subpath
	1853	self.other_branch = other_branch
5246.2.22 by Andrew Bennetts Minor tweaks.	1854	if other_rev_id is None:
	1855	other_rev_id = other_tree.get_revision_id()
	1856	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.	1857	self.base_is_ancestor = True
	1858	self.backup_files = True
	1859	self.merge_type = Merge3Merger
	1860	self.show_base = False
	1861	self.reprocess = False
	1862	self.interesting_ids = None
5246.2.32 by Andrew Bennetts Rename _Wrapper to _MergeTypeParameterizer.	1863	self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
	1864	target_subdir=self._target_subdir,
	1865	source_subpath=self._source_subpath)
5246.2.11 by Andrew Bennetts Handle partial tree merges, add more tests, refactor tests a little.	1866	if self._source_subpath != '':
	1867	# If this isn't a partial merge make sure the revisions will be
	1868	# present.
	1869	self._maybe_fetch(self.other_branch, self.this_branch,
	1870	self.other_basis)
	1871
	1872	def set_pending(self):
	1873	if self._source_subpath != '':
	1874	return
	1875	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.	1876
	1877
5246.2.32 by Andrew Bennetts Rename _Wrapper to _MergeTypeParameterizer.	1878	class _MergeTypeParameterizer(object):
5246.2.29 by Andrew Bennetts Improve some docstrings.	1879	"""Wrap a merge-type class to provide extra parameters.
	1880
	1881	This is hack used by MergeIntoMerger to pass some extra parameters to its
	1882	merge_type. Merger.do_merge() sets up its own set of parameters to pass to
	1883	the 'merge_type' member. It is difficult override do_merge without
	1884	re-writing the whole thing, so instead we create a wrapper which will pass
	1885	the extra parameters.
	1886	"""
5246.2.1 by Andrew Bennetts Very rough first draft of cmd_merge_into from bzr-merge-into. Passes its blackbox tests.	1887
	1888	def __init__(self, merge_type, **kwargs):
	1889	self._extra_kwargs = kwargs
	1890	self._merge_type = merge_type
	1891
	1892	def __call__(self, args, *kwargs):
	1893	kwargs.update(self._extra_kwargs)
	1894	return self._merge_type(args, *kwargs)
	1895
	1896	def __getattr__(self, name):
	1897	return getattr(self._merge_type, name)
	1898
	1899
5246.2.30 by Andrew Bennetts Rename Merge3MergeIntoMerger to MergeIntoMergeType.	1900	class MergeIntoMergeType(Merge3Merger):
5246.2.18 by Andrew Bennetts Fix traceback if source path does not exist.	1901	"""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.	1902
	1903	def __init__(self, args, *kwargs):
5246.2.28 by Andrew Bennetts Improve some docstrings.	1904	"""Initialize the merger object.
	1905
	1906	:param args: See Merge3Merger.__init__'s args.
	1907	:param kwargs: See Merge3Merger.__init__'s keyword args, except for
	1908	source_subpath and target_subdir.
	1909	:keyword source_subpath: The relative path specifying the subtree of
	1910	other_tree to merge into this_tree.
	1911	:keyword target_subdir: The relative path where we want to merge
	1912	other_tree into this_tree
	1913	"""
5246.2.1 by Andrew Bennetts Very rough first draft of cmd_merge_into from bzr-merge-into. Passes its blackbox tests.	1914	# All of the interesting work happens during Merge3Merger.__init__(),
	1915	# so we have have to hack in to get our extra parameters set.
	1916	self._source_subpath = kwargs.pop('source_subpath')
	1917	self._target_subdir = kwargs.pop('target_subdir')
5246.2.30 by Andrew Bennetts Rename Merge3MergeIntoMerger to MergeIntoMergeType.	1918	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.	1919
	1920	def _compute_transform(self):
	1921	child_pb = ui.ui_factory.nested_progress_bar()
	1922	try:
	1923	entries = self._entries_to_incorporate()
	1924	entries = list(entries)
	1925	for num, (entry, parent_id) in enumerate(entries):
6138.4.1 by Jonathan Riddell add gettext to progress bar strings	1926	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.	1927	parent_trans_id = self.tt.trans_id_file_id(parent_id)
	1928	trans_id = transform.new_by_entry(self.tt, entry,
	1929	parent_trans_id, self.other_tree)
	1930	finally:
	1931	child_pb.finished()
5246.2.33 by Andrew Bennetts Rename _finish_transform to _finish_computing_transform.	1932	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.	1933
	1934	def _entries_to_incorporate(self):
5246.2.18 by Andrew Bennetts Fix traceback if source path does not exist.	1935	"""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.	1936	other_inv = self.other_tree.inventory
	1937	subdir_id = other_inv.path2id(self._source_subpath)
5246.2.18 by Andrew Bennetts Fix traceback if source path does not exist.	1938	if subdir_id is None:
5246.2.20 by Andrew Bennetts Tweak comments, add NEWS entry.	1939	# XXX: The error would be clearer if it gave the URL of the source
	1940	# 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.	1941	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.	1942	subdir = other_inv[subdir_id]
	1943	parent_in_target = osutils.dirname(self._target_subdir)
	1944	target_id = self.this_tree.inventory.path2id(parent_in_target)
	1945	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.	1946	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.	1947	name_in_target = osutils.basename(self._target_subdir)
	1948	merge_into_root = subdir.copy()
	1949	merge_into_root.name = name_in_target
5967.7.1 by Martin Pool Deprecate __contains__ on Tree and Inventory	1950	if self.this_tree.inventory.has_id(merge_into_root.file_id):
5246.2.18 by Andrew Bennetts Fix traceback if source path does not exist.	1951	# 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.	1952	# This can happen fairly easily if the directory we are
	1953	# incorporating is the root, and both trees have 'TREE_ROOT' as
	1954	# their root_id. Users will expect this to Just Work, so we
	1955	# change the file-id here.
	1956	# Non-root file-ids could potentially conflict too. That's really
	1957	# an edge case, so we don't do anything special for those. We let
	1958	# them cause conflicts.
5246.2.9 by Andrew Bennetts Make all the existing tests pass.	1959	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.	1960	yield (merge_into_root, target_id)
5246.2.10 by Andrew Bennetts Add more tests.	1961	if subdir.kind != 'directory':
	1962	# No children, so we are done.
	1963	return
5246.2.1 by Andrew Bennetts Very rough first draft of cmd_merge_into from bzr-merge-into. Passes its blackbox tests.	1964	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.	1965	parent_id = entry.parent_id
	1966	if parent_id == subdir.file_id:
	1967	# The root's parent ID has changed, so make sure children of
	1968	# the root refer to the new ID.
	1969	parent_id = merge_into_root.file_id
	1970	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.	1971
	1972
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1973	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.	1974	backup_files=False,
	1975	merge_type=Merge3Merger,
	1976	interesting_ids=None,
	1977	show_base=False,
	1978	reprocess=False,
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1979	other_rev_id=None,
	1980	interesting_files=None,
1534.9.9 by Aaron Bentley Added progress bar to pull	1981	this_tree=None,
4961.2.9 by Martin Pool Rip out most remaining uses of DummyProgressBar	1982	pb=None,
5993.2.4 by Jelmer Vernooij Remove feature flag.	1983	change_reporter=None):
3943.8.1 by Marius Kruger remove all trailing whitespace from bzr source	1984	"""Primary interface for merging.
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1985
5246.2.1 by Andrew Bennetts Very rough first draft of cmd_merge_into from bzr-merge-into. Passes its blackbox tests.	1986	Typical use is probably::
	1987
	1988	merge_inner(branch, branch.get_revision_tree(other_revision),
	1989	branch.get_revision_tree(base_revision))
	1990	"""
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1991	if this_tree is None:
4721.3.1 by Vincent Ladeuil Cleanup imports.	1992	raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
5993.2.1 by Jelmer Vernooij Add test for rootless tree merge.	1993	"parameter")
2255.2.31 by Robert Collins Work in progress to make merge_inner work with dirstate trees.	1994	merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1551.11.10 by Aaron Bentley Add change reporting to pull	1995	pb=pb, change_reporter=change_reporter)
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	1996	merger.backup_files = backup_files
	1997	merger.merge_type = merge_type
	1998	merger.interesting_ids = interesting_ids
1551.2.23 by Aaron Bentley Got merge_inner's ignore_zero parameter working	1999	merger.ignore_zero = ignore_zero
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	2000	if interesting_files:
3376.2.4 by Martin Pool Remove every assert statement from bzrlib!	2001	if interesting_ids:
	2002	raise ValueError('Only supply interesting_ids'
	2003	' or interesting_files')
2590.2.5 by Aaron Bentley Allow selected files to be specified instead of selected ids	2004	merger.interesting_files = interesting_files
1979.2.1 by Robert Collins (robertc) adds a convenience method "merge_from_branch" to WorkingTree.	2005	merger.show_base = show_base
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	2006	merger.reprocess = reprocess
	2007	merger.other_rev_id = other_rev_id
	2008	merger.other_basis = other_rev_id
3249.3.1 by John Arbash Meinel Implement cherrypick support for Merge3	2009	get_revision_id = getattr(base_tree, 'get_revision_id', None)
	2010	if get_revision_id is None:
	2011	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)	2012	merger.cache_trees_with_revision_ids([other_tree, base_tree, this_tree])
3249.3.1 by John Arbash Meinel Implement cherrypick support for Merge3	2013	merger.set_base_revision(get_revision_id(), this_branch)
1534.7.140 by Aaron Bentley Moved the merge stuff into merge.py	2014	return merger.do_merge()
	2015
6259.3.1 by Martin Packman Relocate merge type registry to bzrlib.merge from bzrlib.option	2016
	2017	merge_type_registry = registry.Registry()
6259.3.2 by Martin Packman No longer want register_lazy as passing objects directly	2018	merge_type_registry.register('diff3', Diff3Merger,
6259.3.3 by Martin Packman Merge bzr.dev to resolve conflicts with updated registry help strings	2019	"Merge using external diff3.")
6259.3.2 by Martin Packman No longer want register_lazy as passing objects directly	2020	merge_type_registry.register('lca', LCAMerger,
6259.3.3 by Martin Packman Merge bzr.dev to resolve conflicts with updated registry help strings	2021	"LCA-newness merge.")
6259.3.2 by Martin Packman No longer want register_lazy as passing objects directly	2022	merge_type_registry.register('merge3', Merge3Merger,
6259.3.3 by Martin Packman Merge bzr.dev to resolve conflicts with updated registry help strings	2023	"Native diff3-style merge.")
6259.3.2 by Martin Packman No longer want register_lazy as passing objects directly	2024	merge_type_registry.register('weave', WeaveMerger,
6259.3.3 by Martin Packman Merge bzr.dev to resolve conflicts with updated registry help strings	2025	"Weave-based merge.")
6259.3.1 by Martin Packman Relocate merge type registry to bzrlib.merge from bzrlib.option	2026
	2027
2221.4.15 by Aaron Bentley Use RegistryOption for merge type	2028	def get_merge_type_registry():
6259.3.1 by Martin Packman Relocate merge type registry to bzrlib.merge from bzrlib.option	2029	"""Merge type registry was previously in bzrlib.option
2221.4.15 by Aaron Bentley Use RegistryOption for merge type	2030
6259.3.1 by Martin Packman Relocate merge type registry to bzrlib.merge from bzrlib.option	2031	This method provides a backwards compatible way to retrieve it.
2221.4.15 by Aaron Bentley Use RegistryOption for merge type	2032	"""
6259.3.1 by Martin Packman Relocate merge type registry to bzrlib.merge from bzrlib.option	2033	return merge_type_registry
1551.15.46 by Aaron Bentley Move plan merge to tree	2034
	2035
	2036	def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
	2037	def status_a(revision, text):
	2038	if revision in ancestors_b:
	2039	return 'killed-b', text
	2040	else:
	2041	return 'new-a', text
	2042
	2043	def status_b(revision, text):
	2044	if revision in ancestors_a:
	2045	return 'killed-a', text
	2046	else:
	2047	return 'new-b', text
	2048
	2049	plain_a = [t for (a, t) in annotated_a]
	2050	plain_b = [t for (a, t) in annotated_b]
	2051	matcher = patiencediff.PatienceSequenceMatcher(None, plain_a, plain_b)
	2052	blocks = matcher.get_matching_blocks()
	2053	a_cur = 0
	2054	b_cur = 0
	2055	for ai, bi, l in blocks:
	2056	# process all mismatched sections
	2057	# (last mismatched section is handled because blocks always
	2058	# includes a 0-length last block)
	2059	for revision, text in annotated_a[a_cur:ai]:
	2060	yield status_a(revision, text)
	2061	for revision, text in annotated_b[b_cur:bi]:
	2062	yield status_b(revision, text)
	2063	# and now the matched section
	2064	a_cur = ai + l
	2065	b_cur = bi + l
3376.2.8 by Martin Pool Some review cleanups for assertion removal	2066	for text_a in plain_a[ai:a_cur]:
1551.15.46 by Aaron Bentley Move plan merge to tree	2067	yield "unchanged", text_a
3062.1.9 by Aaron Bentley Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile	2068
	2069
3144.3.1 by Aaron Bentley Implement LCA merge, with problematic conflict markers	2070	class _PlanMergeBase(object):
3062.1.9 by Aaron Bentley Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile	2071
3350.6.10 by Martin Pool VersionedFiles review cleanups	2072	def __init__(self, a_rev, b_rev, vf, key_prefix):
3062.1.9 by Aaron Bentley Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile	2073	"""Contructor.
	2074
	2075	:param a_rev: Revision-id of one revision to merge
	2076	: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.	2077	:param vf: A VersionedFiles containing both revisions
3350.6.10 by Martin Pool VersionedFiles review cleanups	2078	:param key_prefix: A prefix for accessing keys in vf, typically
3350.6.10 by Martin Pool VersionedFiles review cleanups	2079	(file_id,).
3062.1.9 by Aaron Bentley Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile	2080	"""
	2081	self.a_rev = a_rev
	2082	self.b_rev = b_rev
	2083	self.vf = vf
3062.1.12 by Aaron Bentley Implement simple text cache	2084	self._last_lines = None
3062.1.12 by Aaron Bentley Implement simple text cache	2085	self._last_lines_revision_id = None
3144.3.7 by Aaron Bentley Update from review	2086	self._cached_matching_blocks = {}
3350.6.10 by Martin Pool VersionedFiles review cleanups	2087	self._key_prefix = key_prefix
3514.2.2 by John Arbash Meinel Restore a real weave merge to 'bzr merge --weave'.	2088	self._precache_tip_lines()
	2089
	2090	def _precache_tip_lines(self):
	2091	lines = self.get_lines([self.a_rev, self.b_rev])
	2092	self.lines_a = lines[self.a_rev]
	2093	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.	2094
	2095	def get_lines(self, revisions):
	2096	"""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.	2097
3350.6.10 by Martin Pool VersionedFiles review cleanups	2098	: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.	2099	"""
3350.6.10 by Martin Pool VersionedFiles review cleanups	2100	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.	2101	result = {}
	2102	for record in self.vf.get_record_stream(keys, 'unordered', True):
	2103	if record.storage_kind == 'absent':
	2104	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.	2105	result[record.key[-1]] = osutils.chunks_to_lines(
	2106	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.	2107	return result
3062.1.9 by Aaron Bentley Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile	2108
	2109	def plan_merge(self):
	2110	"""Generate a 'plan' for merging the two revisions.
	2111
	2112	This involves comparing their texts and determining the cause of
	2113	differences. If text A has a line and text B does not, then either the
	2114	line was added to text A, or it was deleted from B. Once the causes
	2115	are combined, they are written out in the format described in
	2116	VersionedFile.plan_merge
	2117	"""
	2118	blocks = self._get_matching_blocks(self.a_rev, self.b_rev)
3144.3.1 by Aaron Bentley Implement LCA merge, with problematic conflict markers	2119	unique_a, unique_b = self._unique_lines(blocks)
	2120	new_a, killed_b = self._determine_status(self.a_rev, unique_a)
	2121	new_b, killed_a = self._determine_status(self.b_rev, unique_b)
	2122	return self._iter_plan(blocks, new_a, killed_b, new_b, killed_a)
	2123
	2124	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	2125	last_i = 0
	2126	last_j = 0
	2127	for i, j, n in blocks:
	2128	for a_index in range(last_i, i):
	2129	if a_index in new_a:
3144.3.2 by Aaron Bentley Get conflict handling working	2130	if a_index in killed_b:
	2131	yield 'conflicted-a', self.lines_a[a_index]
	2132	else:
	2133	yield 'new-a', self.lines_a[a_index]
	2134	else:
3144.3.1 by Aaron Bentley Implement LCA merge, with problematic conflict markers	2135	yield 'killed-b', self.lines_a[a_index]
3062.1.9 by Aaron Bentley Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile	2136	for b_index in range(last_j, j):
	2137	if b_index in new_b:
3144.3.2 by Aaron Bentley Get conflict handling working	2138	if b_index in killed_a:
3144.3.10 by Aaron Bentley Use correct index when emitting conflicted-b	2139	yield 'conflicted-b', self.lines_b[b_index]
3144.3.2 by Aaron Bentley Get conflict handling working	2140	else:
	2141	yield 'new-b', self.lines_b[b_index]
	2142	else:
3144.3.1 by Aaron Bentley Implement LCA merge, with problematic conflict markers	2143	yield 'killed-a', self.lines_b[b_index]
3062.1.9 by Aaron Bentley Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile	2144	# handle common lines
	2145	for a_index in range(i, i+n):
3144.3.1 by Aaron Bentley Implement LCA merge, with problematic conflict markers	2146	yield 'unchanged', self.lines_a[a_index]
3062.1.9 by Aaron Bentley Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile	2147	last_i = i+n
	2148	last_j = j+n
	2149
	2150	def _get_matching_blocks(self, left_revision, right_revision):
	2151	"""Return a description of which sections of two revisions match.
	2152
	2153	See SequenceMatcher.get_matching_blocks
	2154	"""
3144.3.7 by Aaron Bentley Update from review	2155	cached = self._cached_matching_blocks.get((left_revision,
	2156	right_revision))
	2157	if cached is not None:
	2158	return cached
3062.1.12 by Aaron Bentley Implement simple text cache	2159	if self._last_lines_revision_id == left_revision:
3062.1.12 by Aaron Bentley Implement simple text cache	2160	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.	2161	right_lines = self.get_lines([right_revision])[right_revision]
3062.1.12 by Aaron Bentley Implement simple text cache	2162	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.	2163	lines = self.get_lines([left_revision, right_revision])
	2164	left_lines = lines[left_revision]
	2165	right_lines = lines[right_revision]
3062.1.12 by Aaron Bentley Implement simple text cache	2166	self._last_lines = right_lines
3062.1.12 by Aaron Bentley Implement simple text cache	2167	self._last_lines_revision_id = right_revision
3062.1.9 by Aaron Bentley Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile	2168	matcher = patiencediff.PatienceSequenceMatcher(None, left_lines,
	2169	right_lines)
	2170	return matcher.get_matching_blocks()
	2171
	2172	def _unique_lines(self, matching_blocks):
	2173	"""Analyse matching_blocks to determine which lines are unique
	2174
	2175	:return: a tuple of (unique_left, unique_right), where the values are
	2176	sets of line numbers of unique lines.
	2177	"""
	2178	last_i = 0
	2179	last_j = 0
	2180	unique_left = []
	2181	unique_right = []
	2182	for i, j, n in matching_blocks:
	2183	unique_left.extend(range(last_i, i))
	2184	unique_right.extend(range(last_j, j))
	2185	last_i = i + n
	2186	last_j = j + n
	2187	return unique_left, unique_right
	2188
3144.3.1 by Aaron Bentley Implement LCA merge, with problematic conflict markers	2189	@staticmethod
	2190	def _subtract_plans(old_plan, new_plan):
3144.3.7 by Aaron Bentley Update from review	2191	"""Remove changes from new_plan that came from old_plan.
	2192
	2193	It is assumed that the difference between the old_plan and new_plan
	2194	is their choice of 'b' text.
	2195
	2196	All lines from new_plan that differ from old_plan are emitted
	2197	verbatim. All lines from new_plan that match old_plan but are
	2198	not about the 'b' revision are emitted verbatim.
	2199
	2200	Lines that match and are about the 'b' revision are the lines we
	2201	don't want, so we convert 'killed-b' -> 'unchanged', and 'new-b'
	2202	is skipped entirely.
	2203	"""
3144.3.1 by Aaron Bentley Implement LCA merge, with problematic conflict markers	2204	matcher = patiencediff.PatienceSequenceMatcher(None, old_plan,
	2205	new_plan)
	2206	last_j = 0
	2207	for i, j, n in matcher.get_matching_blocks():
	2208	for jj in range(last_j, j):
	2209	yield new_plan[jj]
	2210	for jj in range(j, j+n):
	2211	plan_line = new_plan[jj]
	2212	if plan_line[0] == 'new-b':
	2213	pass
	2214	elif plan_line[0] == 'killed-b':
	2215	yield 'unchanged', plan_line[1]
	2216	else:
	2217	yield plan_line
	2218	last_j = j + n
	2219
	2220
	2221	class _PlanMerge(_PlanMergeBase):
	2222	"""Plan an annotate merge using on-the-fly annotation"""
	2223
3350.6.10 by Martin Pool VersionedFiles review cleanups	2224	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'.	2225	super(_PlanMerge, self).__init__(a_rev, b_rev, vf, key_prefix)
	2226	self.a_key = self._key_prefix + (self.a_rev,)
	2227	self.b_key = self._key_prefix + (self.b_rev,)
4721.3.1 by Vincent Ladeuil Cleanup imports.	2228	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.	2229	heads = self.graph.heads((self.a_key, self.b_key))
	2230	if len(heads) == 1:
	2231	# one side dominates, so we can just return its values, yay for
	2232	# per-file graphs
	2233	# Ideally we would know that before we get this far
	2234	self._head_key = heads.pop()
	2235	if self._head_key == self.a_key:
	2236	other = b_rev
	2237	else:
	2238	other = a_rev
4721.3.1 by Vincent Ladeuil Cleanup imports.	2239	trace.mutter('found dominating revision for %s\n%s > %s', self.vf,
4721.3.1 by Vincent Ladeuil Cleanup imports.	2240	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.	2241	self._weave = None
	2242	else:
	2243	self._head_key = None
	2244	self._build_weave()
3514.2.2 by John Arbash Meinel Restore a real weave merge to 'bzr merge --weave'.	2245
	2246	def _precache_tip_lines(self):
	2247	# Turn this into a no-op, because we will do this later
	2248	pass
	2249
	2250	def _find_recursive_lcas(self):
	2251	"""Find all the ancestors back to a unique lca"""
	2252	cur_ancestors = (self.a_key, self.b_key)
	2253	# 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.	2254	# rather than a key tuple. We will just map that directly to no common
	2255	# ancestors.
	2256	parent_map = {}
3514.2.2 by John Arbash Meinel Restore a real weave merge to 'bzr merge --weave'.	2257	while True:
	2258	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.	2259	# Map a plain NULL_REVISION to a simple no-ancestors
4721.3.1 by Vincent Ladeuil Cleanup imports.	2260	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.	2261	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.	2262	# Order the lca's based on when they were merged into the tip
	2263	# While the actual merge portion of weave merge uses a set() of
	2264	# active revisions, the order of insertion does effect the
	2265	# implicit ordering of the texts.
3514.2.5 by John Arbash Meinel Switch to the get_parent_map design I had settled on.	2266	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.	2267	ordered_parents = tuple(self.graph.find_merge_order(rev_key,
	2268	next_lcas))
	2269	parent_map[rev_key] = ordered_parents
3514.2.2 by John Arbash Meinel Restore a real weave merge to 'bzr merge --weave'.	2270	if len(next_lcas) == 0:
	2271	break
	2272	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.	2273	parent_map[list(next_lcas)[0]] = ()
3514.2.2 by John Arbash Meinel Restore a real weave merge to 'bzr merge --weave'.	2274	break
3514.2.10 by John Arbash Meinel Handle more edge cases.	2275	elif len(next_lcas) > 2:
3514.2.7 by John Arbash Meinel Fix the failing test by implementing the fallback logic.	2276	# More than 2 lca's, fall back to grabbing all nodes between
	2277	# this and the unique lca.
4721.3.1 by Vincent Ladeuil Cleanup imports.	2278	trace.mutter('More than 2 LCAs, falling back to all nodes for:'
	2279	' %s, %s\n=> %s',
	2280	self.a_key, self.b_key, cur_ancestors)
3514.2.7 by John Arbash Meinel Fix the failing test by implementing the fallback logic.	2281	cur_lcas = next_lcas
	2282	while len(cur_lcas) > 1:
	2283	cur_lcas = self.graph.find_lca(*cur_lcas)
	2284	if len(cur_lcas) == 0:
	2285	# No common base to find, use the full ancestry
	2286	unique_lca = None
	2287	else:
3514.2.8 by John Arbash Meinel The insertion ordering into the weave has an impact on conflicts.	2288	unique_lca = list(cur_lcas)[0]
4721.3.1 by Vincent Ladeuil Cleanup imports.	2289	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.	2290	# find_lca will return a plain 'NULL_REVISION' rather
	2291	# than a key tuple when there is no common ancestor, we
	2292	# prefer to just use None, because it doesn't confuse
	2293	# _get_interesting_texts()
	2294	unique_lca = None
3514.2.7 by John Arbash Meinel Fix the failing test by implementing the fallback logic.	2295	parent_map.update(self._find_unique_parents(next_lcas,
	2296	unique_lca))
	2297	break
3514.2.2 by John Arbash Meinel Restore a real weave merge to 'bzr merge --weave'.	2298	cur_ancestors = next_lcas
3514.2.5 by John Arbash Meinel Switch to the get_parent_map design I had settled on.	2299	return parent_map
3514.2.2 by John Arbash Meinel Restore a real weave merge to 'bzr merge --weave'.	2300
3514.2.7 by John Arbash Meinel Fix the failing test by implementing the fallback logic.	2301	def _find_unique_parents(self, tip_keys, base_key):
	2302	"""Find ancestors of tip that aren't ancestors of base.
3943.8.1 by Marius Kruger remove all trailing whitespace from bzr source	2303
3514.2.7 by John Arbash Meinel Fix the failing test by implementing the fallback logic.	2304	:param tip_keys: Nodes that are interesting
	2305	:param base_key: Cull all ancestors of this node
	2306	:return: The parent map for all revisions between tip_keys and
	2307	base_key. base_key will be included. References to nodes outside of
	2308	the ancestor set will also be removed.
	2309	"""
	2310	# TODO: this would be simpler if find_unique_ancestors took a list
	2311	# instead of a single tip, internally it supports it, but it
	2312	# isn't a "backwards compatible" api change.
	2313	if base_key is None:
	2314	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.	2315	# We remove NULL_REVISION because it isn't a proper tuple key, and
	2316	# thus confuses things like _get_interesting_texts, and our logic
	2317	# to add the texts into the memory weave.
4721.3.1 by Vincent Ladeuil Cleanup imports.	2318	if _mod_revision.NULL_REVISION in parent_map:
4721.3.1 by Vincent Ladeuil Cleanup imports.	2319	parent_map.pop(_mod_revision.NULL_REVISION)
3514.2.7 by John Arbash Meinel Fix the failing test by implementing the fallback logic.	2320	else:
	2321	interesting = set()
	2322	for tip in tip_keys:
	2323	interesting.update(
	2324	self.graph.find_unique_ancestors(tip, [base_key]))
	2325	parent_map = self.graph.get_parent_map(interesting)
	2326	parent_map[base_key] = ()
3514.2.12 by John Arbash Meinel Start refactoring into helper functions	2327	culled_parent_map, child_map, tails = self._remove_external_references(
	2328	parent_map)
3514.2.13 by John Arbash Meinel Add the ability to prune extra tails from the parent_map.	2329	# 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.	2330	if base_key is not None:
	2331	tails.remove(base_key)
	2332	self._prune_tails(culled_parent_map, child_map, tails)
	2333	# Now remove all the uninteresting 'linear' regions
3514.2.15 by John Arbash Meinel Enable collapsing linear regions.	2334	simple_map = _mod_graph.collapse_linear_regions(culled_parent_map)
	2335	return simple_map
3514.2.12 by John Arbash Meinel Start refactoring into helper functions	2336
	2337	@staticmethod
	2338	def _remove_external_references(parent_map):
	2339	"""Remove references that go outside of the parent map.
	2340
	2341	:param parent_map: Something returned from Graph.get_parent_map(keys)
	2342	:return: (filtered_parent_map, child_map, tails)
	2343	filtered_parent_map is parent_map without external references
	2344	child_map is the {parent_key: [child_keys]} mapping
	2345	tails is a list of nodes that do not have any parents in the map
	2346	"""
	2347	# TODO: The basic effect of this function seems more generic than
	2348	# _PlanMerge. But the specific details of building a child_map,
	2349	# and computing tails seems very specific to _PlanMerge.
	2350	# Still, should this be in Graph land?
	2351	filtered_parent_map = {}
	2352	child_map = {}
	2353	tails = []
3514.2.7 by John Arbash Meinel Fix the failing test by implementing the fallback logic.	2354	for key, parent_keys in parent_map.iteritems():
3514.2.12 by John Arbash Meinel Start refactoring into helper functions	2355	culled_parent_keys = [p for p in parent_keys if p in parent_map]
	2356	if not culled_parent_keys:
	2357	tails.append(key)
	2358	for parent_key in culled_parent_keys:
	2359	child_map.setdefault(parent_key, []).append(key)
	2360	# TODO: Do we want to do this, it adds overhead for every node,
	2361	# just to say that the node has no children
	2362	child_map.setdefault(key, [])
	2363	filtered_parent_map[key] = culled_parent_keys
	2364	return filtered_parent_map, child_map, tails
	2365
3514.2.13 by John Arbash Meinel Add the ability to prune extra tails from the parent_map.	2366	@staticmethod
	2367	def _prune_tails(parent_map, child_map, tails_to_remove):
	2368	"""Remove tails from the parent map.
3943.8.1 by Marius Kruger remove all trailing whitespace from bzr source	2369
3514.2.13 by John Arbash Meinel Add the ability to prune extra tails from the parent_map.	2370	This will remove the supplied revisions until no more children have 0
	2371	parents.
	2372
	2373	:param parent_map: A dict of {child: [parents]}, this dictionary will
	2374	be modified in place.
	2375	:param tails_to_remove: A list of tips that should be removed,
	2376	this list will be consumed
	2377	:param child_map: The reverse dict of parent_map ({parent: [children]})
	2378	this dict will be modified
	2379	:return: None, parent_map will be modified in place.
	2380	"""
	2381	while tails_to_remove:
	2382	next = tails_to_remove.pop()
	2383	parent_map.pop(next)
	2384	children = child_map.pop(next)
	2385	for child in children:
	2386	child_parents = parent_map[child]
	2387	child_parents.remove(next)
	2388	if len(child_parents) == 0:
	2389	tails_to_remove.append(child)
3514.2.7 by John Arbash Meinel Fix the failing test by implementing the fallback logic.	2390
3514.2.5 by John Arbash Meinel Switch to the get_parent_map design I had settled on.	2391	def _get_interesting_texts(self, parent_map):
3514.2.2 by John Arbash Meinel Restore a real weave merge to 'bzr merge --weave'.	2392	"""Return a dict of texts we are interested in.
	2393
	2394	Note that the input is in key tuples, but the output is in plain
	2395	revision ids.
	2396
3514.2.5 by John Arbash Meinel Switch to the get_parent_map design I had settled on.	2397	: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'.	2398	:return: A dict of {'revision_id':lines} as returned by
	2399	_PlanMergeBase.get_lines()
	2400	"""
3514.2.5 by John Arbash Meinel Switch to the get_parent_map design I had settled on.	2401	all_revision_keys = set(parent_map)
	2402	all_revision_keys.add(self.a_key)
	2403	all_revision_keys.add(self.b_key)
3514.2.2 by John Arbash Meinel Restore a real weave merge to 'bzr merge --weave'.	2404
3514.2.5 by John Arbash Meinel Switch to the get_parent_map design I had settled on.	2405	# Everything else is in 'keys' but get_lines is in 'revision_ids'
	2406	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'.	2407	return all_texts
	2408
	2409	def _build_weave(self):
	2410	from bzrlib import weave
	2411	self._weave = weave.Weave(weave_name='in_memory_weave',
	2412	allow_reserved=True)
3514.2.5 by John Arbash Meinel Switch to the get_parent_map design I had settled on.	2413	parent_map = self._find_recursive_lcas()
	2414
	2415	all_texts = self._get_interesting_texts(parent_map)
	2416
	2417	# Note: Unfortunately, the order given by topo_sort will effect the
	2418	# ordering resolution in the output. Specifically, if you add A then B,
	2419	# then in the output text A lines will show up before B lines. And, of
	2420	# 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.	2421	# So we use merge_sort, and add a fake node on the tip.
	2422	# This ensures that left-hand parents will always be inserted into the
	2423	# weave before right-hand parents.
	2424	tip_key = self._key_prefix + (_mod_revision.CURRENT_REVISION,)
	2425	parent_map[tip_key] = (self.a_key, self.b_key)
	2426
	2427	for seq_num, key, depth, eom in reversed(tsort.merge_sort(parent_map,
	2428	tip_key)):
	2429	if key == tip_key:
	2430	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.	2431	# 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.	2432	parent_keys = parent_map[key]
	2433	revision_id = key[-1]
	2434	parent_ids = [k[-1] for k in parent_keys]
	2435	self._weave.add_lines(revision_id, parent_ids,
	2436	all_texts[revision_id])
3514.2.2 by John Arbash Meinel Restore a real weave merge to 'bzr merge --weave'.	2437
	2438	def plan_merge(self):
	2439	"""Generate a 'plan' for merging the two revisions.
	2440
	2441	This involves comparing their texts and determining the cause of
	2442	differences. If text A has a line and text B does not, then either the
	2443	line was added to text A, or it was deleted from B. Once the causes
	2444	are combined, they are written out in the format described in
	2445	VersionedFile.plan_merge
	2446	"""
	2447	if self._head_key is not None: # There was a single head
	2448	if self._head_key == self.a_key:
	2449	plan = 'new-a'
3062.1.9 by Aaron Bentley Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile	2450	else:
3514.2.2 by John Arbash Meinel Restore a real weave merge to 'bzr merge --weave'.	2451	if self._head_key != self.b_key:
	2452	raise AssertionError('There was an invalid head: %s != %s'
	2453	% (self.b_key, self._head_key))
	2454	plan = 'new-b'
3514.2.16 by John Arbash Meinel Review feedback from Ian.	2455	head_rev = self._head_key[-1]
3514.2.16 by John Arbash Meinel Review feedback from Ian.	2456	lines = self.get_lines([head_rev])[head_rev]
3514.2.2 by John Arbash Meinel Restore a real weave merge to 'bzr merge --weave'.	2457	return ((plan, line) for line in lines)
	2458	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	2459
3144.3.1 by Aaron Bentley Implement LCA merge, with problematic conflict markers	2460
	2461	class _PlanLCAMerge(_PlanMergeBase):
	2462	"""
3144.3.7 by Aaron Bentley Update from review	2463	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.	2464
3144.3.1 by Aaron Bentley Implement LCA merge, with problematic conflict markers	2465	1. comparisons are done against LCAs only
	2466	2. cases where a contested line is new versus one LCA but old versus
3144.3.7 by Aaron Bentley Update from review	2467	another are marked as conflicts, by emitting the line as conflicted-a
3144.3.7 by Aaron Bentley Update from review	2468	or conflicted-b.
3144.3.1 by Aaron Bentley Implement LCA merge, with problematic conflict markers	2469
	2470	This is faster, and hopefully produces more useful output.
	2471	"""
	2472
3350.6.10 by Martin Pool VersionedFiles review cleanups	2473	def __init__(self, a_rev, b_rev, vf, key_prefix, graph):
	2474	_PlanMergeBase.__init__(self, a_rev, b_rev, vf, key_prefix)
	2475	lcas = graph.find_lca(key_prefix + (a_rev,), key_prefix + (b_rev,))
3350.6.5 by Robert Collins Update to bzr.dev.	2476	self.lcas = set()
3350.6.5 by Robert Collins Update to bzr.dev.	2477	for lca in lcas:
4721.3.1 by Vincent Ladeuil Cleanup imports.	2478	if lca == _mod_revision.NULL_REVISION:
3350.6.5 by Robert Collins Update to bzr.dev.	2479	self.lcas.add(lca)
	2480	else:
	2481	self.lcas.add(lca[-1])
3144.3.7 by Aaron Bentley Update from review	2482	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.	2483	if _mod_revision.is_null(lca):
	2484	lca_lines = []
	2485	else:
3350.6.5 by Robert Collins Update to bzr.dev.	2486	lca_lines = self.get_lines([lca])[lca]
3144.3.7 by Aaron Bentley Update from review	2487	matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_a,
	2488	lca_lines)
	2489	blocks = list(matcher.get_matching_blocks())
	2490	self._cached_matching_blocks[(a_rev, lca)] = blocks
	2491	matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_b,
	2492	lca_lines)
	2493	blocks = list(matcher.get_matching_blocks())
	2494	self._cached_matching_blocks[(b_rev, lca)] = blocks
3144.3.1 by Aaron Bentley Implement LCA merge, with problematic conflict markers	2495
3144.3.7 by Aaron Bentley Update from review	2496	def _determine_status(self, revision_id, unique_line_numbers):
3144.3.1 by Aaron Bentley Implement LCA merge, with problematic conflict markers	2497	"""Determines the status unique lines versus all lcas.
	2498
	2499	Basically, determines why the line is unique to this revision.
	2500
	2501	A line may be determined new, killed, or both.
	2502
3144.3.7 by Aaron Bentley Update from review	2503	If a line is determined new, that means it was not present in at least
3144.3.7 by Aaron Bentley Update from review	2504	one LCA, and is not present in the other merge revision.
3144.3.1 by Aaron Bentley Implement LCA merge, with problematic conflict markers	2505
	2506	If a line is determined killed, that means the line was present in
	2507	at least one LCA.
	2508
	2509	If a line is killed and new, this indicates that the two merge
	2510	revisions contain differing conflict resolutions.
5891.1.2 by Andrew Bennetts Fix a bunch of docstring formatting nits, making pydoctor a bit happier.	2511
3144.3.7 by Aaron Bentley Update from review	2512	:param revision_id: The id of the revision in which the lines are
	2513	unique
	2514	: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.	2515	:return: a tuple of (new_this, killed_other)
3144.3.1 by Aaron Bentley Implement LCA merge, with problematic conflict markers	2516	"""
	2517	new = set()
	2518	killed = set()
3144.3.7 by Aaron Bentley Update from review	2519	unique_line_numbers = set(unique_line_numbers)
3144.3.1 by Aaron Bentley Implement LCA merge, with problematic conflict markers	2520	for lca in self.lcas:
	2521	blocks = self._get_matching_blocks(revision_id, lca)
	2522	unique_vs_lca, _ignored = self._unique_lines(blocks)
3144.3.7 by Aaron Bentley Update from review	2523	new.update(unique_line_numbers.intersection(unique_vs_lca))
3144.3.7 by Aaron Bentley Update from review	2524	killed.update(unique_line_numbers.difference(unique_vs_lca))
3144.3.1 by Aaron Bentley Implement LCA merge, with problematic conflict markers	2525	return new, killed