1
from merge_core import merge_flex
2
from changeset import generate_changeset, ExceptionConflictHandler
3
from changeset import Inventory
4
from bzrlib import find_branch
6
from bzrlib.errors import BzrCommandError
7
from bzrlib.delta import compare_trees
8
from trace import mutter, warning
14
class UnrelatedBranches(BzrCommandError):
1
# Copyright (C) 2005-2010 Canonical Ltd
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.
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.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
from bzrlib.lazy_import import lazy_import
20
lazy_import(globals(), """
22
branch as _mod_branch,
23
conflicts as _mod_conflicts,
30
revision as _mod_revision,
39
from bzrlib.cleanup import OperationWithCleanups
45
from bzrlib.symbol_versioning import (
49
# TODO: Report back as changes are merged in
52
def transform_tree(from_tree, to_tree, interesting_ids=None):
53
from_tree.lock_tree_write()
54
operation = OperationWithCleanups(merge_inner)
55
operation.add_cleanup(from_tree.unlock)
56
operation.run_simple(from_tree.branch, to_tree, from_tree,
57
ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
60
class MergeHooks(hooks.Hooks):
15
62
def __init__(self):
16
msg = "Branches have no common ancestor, and no base revision"\
18
BzrCommandError.__init__(self, msg)
21
class MergeConflictHandler(ExceptionConflictHandler):
22
"""Handle conflicts encountered while merging"""
23
def __init__(self, dir, ignore_zero=False):
24
ExceptionConflictHandler.__init__(self, dir)
26
self.ignore_zero = ignore_zero
28
def copy(self, source, dest):
29
"""Copy the text and mode of a file
30
:param source: The path of the file to copy
31
:param dest: The distination file to create
33
s_file = file(source, "rb")
34
d_file = file(dest, "wb")
37
os.chmod(dest, 0777 & os.stat(source).st_mode)
39
def add_suffix(self, name, suffix, last_new_name=None):
40
"""Rename a file to append a suffix. If the new name exists, the
41
suffix is added repeatedly until a non-existant name is found
43
:param name: The path of the file
44
:param suffix: The suffix to append
45
:param last_new_name: (used for recursive calls) the last name tried
47
if last_new_name is None:
49
new_name = last_new_name+suffix
51
os.rename(name, new_name)
54
if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
56
return self.add_suffix(name, suffix, last_new_name=new_name)
58
def conflict(self, text):
63
def merge_conflict(self, new_file, this_path, base_path, other_path):
65
Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER. The
66
main file will be a version with diff3 conflicts.
67
:param new_file: Path to the output file with diff3 markers
68
:param this_path: Path to the file text for the THIS tree
69
:param base_path: Path to the file text for the BASE tree
70
:param other_path: Path to the file text for the OTHER tree
72
self.add_suffix(this_path, ".THIS")
73
self.copy(base_path, this_path+".BASE")
74
self.copy(other_path, this_path+".OTHER")
75
os.rename(new_file, this_path)
76
self.conflict("Diff3 conflict encountered in %s" % this_path)
78
def target_exists(self, entry, target, old_path):
79
"""Handle the case when the target file or dir exists"""
80
moved_path = self.add_suffix(target, ".moved")
81
self.conflict("Moved existing %s to %s" % (target, moved_path))
83
def rmdir_non_empty(self, filename):
84
"""Handle the case where the dir to be removed still has contents"""
85
self.conflict("Directory %s not removed because it is not empty"\
90
if not self.ignore_zero:
91
print "%d conflicts encountered.\n" % self.conflicts
93
class SourceFile(object):
94
def __init__(self, path, id, present=None, isdir=None):
97
self.present = present
99
self.interesting = True
102
return "SourceFile(%s, %s)" % (self.path, self.id)
104
def get_tree(treespec, temp_root, label):
105
location, revno = treespec
106
branch = find_branch(location)
108
base_tree = branch.working_tree()
110
base_tree = branch.basis_tree()
112
base_tree = branch.revision_tree(branch.lookup_revision(revno))
113
temp_path = os.path.join(temp_root, label)
115
return branch, MergeTree(base_tree, temp_path)
118
def abspath(tree, file_id):
119
path = tree.inventory.id2path(file_id)
124
def file_exists(tree, file_id):
125
return tree.has_filename(tree.id2path(file_id))
127
def inventory_map(tree):
129
for file_id in tree.inventory:
130
path = abspath(tree, file_id)
131
inventory[path] = SourceFile(path, file_id)
135
class MergeTree(object):
136
def __init__(self, tree, tempdir):
63
hooks.Hooks.__init__(self)
64
self.create_hook(hooks.HookPoint('merge_file_content',
65
"Called with a bzrlib.merge.Merger object to create a per file "
66
"merge object when starting a merge. "
67
"Should return either None or a subclass of "
68
"``bzrlib.merge.AbstractPerFileMerger``. "
69
"Such objects will then be called per file "
70
"that needs to be merged (including when one "
71
"side has deleted the file and the other has changed it). "
72
"See the AbstractPerFileMerger API docs for details on how it is "
77
class AbstractPerFileMerger(object):
78
"""PerFileMerger objects are used by plugins extending merge for bzrlib.
80
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
82
:ivar merger: The Merge3Merger performing the merge.
85
def __init__(self, merger):
86
"""Create a PerFileMerger for use with merger."""
89
def merge_contents(self, merge_params):
90
"""Attempt to merge the contents of a single file.
92
:param merge_params: A bzrlib.merge.MergeHookParams
93
:return : A tuple of (status, chunks), where status is one of
94
'not_applicable', 'success', 'conflicted', or 'delete'. If status
95
is 'success' or 'conflicted', then chunks should be an iterable of
96
strings for the new file contents.
98
return ('not applicable', None)
101
class PerFileMerger(AbstractPerFileMerger):
102
"""Merge individual files when self.file_matches returns True.
104
This class is intended to be subclassed. The file_matches and
105
merge_matching methods should be overridden with concrete implementations.
108
def file_matches(self, params):
109
"""Return True if merge_matching should be called on this file.
111
Only called with merges of plain files with no clear winner.
113
Subclasses must override this.
115
raise NotImplementedError(self.file_matches)
117
def get_filename(self, params, tree):
118
"""Lookup the filename (i.e. basename, not path), given a Tree (e.g.
119
self.merger.this_tree) and a MergeHookParams.
121
return osutils.basename(tree.id2path(params.file_id))
123
def get_filepath(self, params, tree):
124
"""Calculate the path to the file in a tree.
126
:param params: A MergeHookParams describing the file to merge
127
:param tree: a Tree, e.g. self.merger.this_tree.
129
return tree.id2path(params.file_id)
131
def merge_contents(self, params):
132
"""Merge the contents of a single file."""
133
# Check whether this custom merge logic should be used.
135
# OTHER is a straight winner, rely on default merge.
136
params.winner == 'other' or
137
# THIS and OTHER aren't both files.
138
not params.is_file_merge() or
139
# The filename doesn't match *.xml
140
not self.file_matches(params)):
141
return 'not_applicable', None
142
return self.merge_matching(params)
144
def merge_matching(self, params):
145
"""Merge the contents of a single file that has matched the criteria
146
in PerFileMerger.merge_contents (is a conflict, is a file,
147
self.file_matches is True).
149
Subclasses must override this.
151
raise NotImplementedError(self.merge_matching)
154
class ConfigurableFileMerger(PerFileMerger):
155
"""Merge individual files when configured via a .conf file.
157
This is a base class for concrete custom file merging logic. Concrete
158
classes should implement ``merge_text``.
160
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
162
:ivar affected_files: The configured file paths to merge.
164
:cvar name_prefix: The prefix to use when looking up configuration
165
details. <name_prefix>_merge_files describes the files targeted by the
168
:cvar default_files: The default file paths to merge when no configuration
175
def __init__(self, merger):
176
super(ConfigurableFileMerger, self).__init__(merger)
177
self.affected_files = None
178
self.default_files = self.__class__.default_files or []
179
self.name_prefix = self.__class__.name_prefix
180
if self.name_prefix is None:
181
raise ValueError("name_prefix must be set.")
183
def file_matches(self, params):
184
"""Check whether the file should call the merge hook.
186
<name_prefix>_merge_files configuration variable is a list of files
187
that should use the hook.
189
affected_files = self.affected_files
190
if affected_files is None:
191
config = self.merger.this_branch.get_config()
192
# Until bzr provides a better policy for caching the config, we
193
# just add the part we're interested in to the params to avoid
194
# reading the config files repeatedly (bazaar.conf, location.conf,
196
config_key = self.name_prefix + '_merge_files'
197
affected_files = config.get_user_option_as_list(config_key)
198
if affected_files is None:
199
# If nothing was specified in the config, use the default.
200
affected_files = self.default_files
201
self.affected_files = affected_files
203
filepath = self.get_filepath(params, self.merger.this_tree)
204
if filepath in affected_files:
208
def merge_matching(self, params):
209
return self.merge_text(params)
211
def merge_text(self, params):
212
"""Merge the byte contents of a single file.
214
This is called after checking that the merge should be performed in
215
merge_contents, and it should behave as per
216
``bzrlib.merge.AbstractPerFileMerger.merge_contents``.
218
raise NotImplementedError(self.merge_text)
221
class MergeHookParams(object):
222
"""Object holding parameters passed to merge_file_content hooks.
224
There are some fields hooks can access:
226
:ivar file_id: the file ID of the file being merged
227
:ivar trans_id: the transform ID for the merge of this file
228
:ivar this_kind: kind of file_id in 'this' tree
229
:ivar other_kind: kind of file_id in 'other' tree
230
:ivar winner: one of 'this', 'other', 'conflict'
233
def __init__(self, merger, file_id, trans_id, this_kind, other_kind,
235
self._merger = merger
236
self.file_id = file_id
237
self.trans_id = trans_id
238
self.this_kind = this_kind
239
self.other_kind = other_kind
242
def is_file_merge(self):
243
"""True if this_kind and other_kind are both 'file'."""
244
return self.this_kind == 'file' and self.other_kind == 'file'
246
@decorators.cachedproperty
247
def base_lines(self):
248
"""The lines of the 'base' version of the file."""
249
return self._merger.get_lines(self._merger.base_tree, self.file_id)
251
@decorators.cachedproperty
252
def this_lines(self):
253
"""The lines of the 'this' version of the file."""
254
return self._merger.get_lines(self._merger.this_tree, self.file_id)
256
@decorators.cachedproperty
257
def other_lines(self):
258
"""The lines of the 'other' version of the file."""
259
return self._merger.get_lines(self._merger.other_tree, self.file_id)
262
class Merger(object):
266
def __init__(self, this_branch, other_tree=None, base_tree=None,
267
this_tree=None, pb=None, change_reporter=None,
268
recurse='down', revision_graph=None):
137
269
object.__init__(self)
138
if hasattr(tree, "basedir"):
139
self.root = tree.basedir
142
self.inventory = inventory_map(tree)
144
self.tempdir = tempdir
145
os.mkdir(os.path.join(self.tempdir, "texts"))
148
def readonly_path(self, id):
149
if id not in self.tree:
151
if self.root is not None:
152
return self.tree.abspath(self.tree.id2path(id))
154
if self.tree.inventory[id].kind in ("directory", "root_directory"):
156
if not self.cached.has_key(id):
157
path = os.path.join(self.tempdir, "texts", id)
158
outfile = file(path, "wb")
159
outfile.write(self.tree.get_file(id).read())
160
assert(os.path.exists(path))
161
self.cached[id] = path
162
return self.cached[id]
166
def merge(other_revision, base_revision,
167
check_clean=True, ignore_zero=False,
169
"""Merge changes into a tree.
172
Base for three-way merge.
174
Other revision for three-way merge.
176
Directory to merge changes into; '.' by default.
178
If true, this_dir must have no uncommitted changes before the
181
tempdir = tempfile.mkdtemp(prefix="bzr-")
185
this_branch = find_branch(this_dir)
270
self.this_branch = this_branch
271
self.this_basis = _mod_revision.ensure_null(
272
this_branch.last_revision())
273
self.this_rev_id = None
274
self.this_tree = this_tree
275
self.this_revision_tree = None
276
self.this_basis_tree = None
277
self.other_tree = other_tree
278
self.other_branch = None
279
self.base_tree = base_tree
280
self.ignore_zero = False
281
self.backup_files = False
282
self.interesting_ids = None
283
self.interesting_files = None
284
self.show_base = False
285
self.reprocess = False
287
warnings.warn("pb parameter to Merger() is deprecated and ignored")
289
self.recurse = recurse
290
self.change_reporter = change_reporter
291
self._cached_trees = {}
292
self._revision_graph = revision_graph
293
self._base_is_ancestor = None
294
self._base_is_other_ancestor = None
295
self._is_criss_cross = None
296
self._lca_trees = None
298
def cache_trees_with_revision_ids(self, trees):
299
"""Cache any tree in trees if it has a revision_id."""
300
for maybe_tree in trees:
301
if maybe_tree is None:
304
rev_id = maybe_tree.get_revision_id()
305
except AttributeError:
307
self._cached_trees[rev_id] = maybe_tree
310
def revision_graph(self):
311
if self._revision_graph is None:
312
self._revision_graph = self.this_branch.repository.get_graph()
313
return self._revision_graph
315
def _set_base_is_ancestor(self, value):
316
self._base_is_ancestor = value
318
def _get_base_is_ancestor(self):
319
if self._base_is_ancestor is None:
320
self._base_is_ancestor = self.revision_graph.is_ancestor(
321
self.base_rev_id, self.this_basis)
322
return self._base_is_ancestor
324
base_is_ancestor = property(_get_base_is_ancestor, _set_base_is_ancestor)
326
def _set_base_is_other_ancestor(self, value):
327
self._base_is_other_ancestor = value
329
def _get_base_is_other_ancestor(self):
330
if self._base_is_other_ancestor is None:
331
if self.other_basis is None:
333
self._base_is_other_ancestor = self.revision_graph.is_ancestor(
334
self.base_rev_id, self.other_basis)
335
return self._base_is_other_ancestor
337
base_is_other_ancestor = property(_get_base_is_other_ancestor,
338
_set_base_is_other_ancestor)
341
def from_uncommitted(tree, other_tree, pb=None, base_tree=None):
342
"""Return a Merger for uncommitted changes in other_tree.
344
:param tree: The tree to merge into
345
:param other_tree: The tree to get uncommitted changes from
346
:param pb: A progress indicator
347
:param base_tree: The basis to use for the merge. If unspecified,
348
other_tree.basis_tree() will be used.
350
if base_tree is None:
351
base_tree = other_tree.basis_tree()
352
merger = Merger(tree.branch, other_tree, base_tree, tree, pb)
353
merger.base_rev_id = merger.base_tree.get_revision_id()
354
merger.other_rev_id = None
355
merger.other_basis = merger.base_rev_id
359
def from_mergeable(klass, tree, mergeable, pb):
360
"""Return a Merger for a bundle or merge directive.
362
:param tree: The tree to merge changes into
363
:param mergeable: A merge directive or bundle
364
:param pb: A progress indicator
366
mergeable.install_revisions(tree.branch.repository)
367
base_revision_id, other_revision_id, verified =\
368
mergeable.get_merge_request(tree.branch.repository)
369
revision_graph = tree.branch.repository.get_graph()
370
if base_revision_id is not None:
371
if (base_revision_id != _mod_revision.NULL_REVISION and
372
revision_graph.is_ancestor(
373
base_revision_id, tree.branch.last_revision())):
374
base_revision_id = None
376
trace.warning('Performing cherrypick')
377
merger = klass.from_revision_ids(pb, tree, other_revision_id,
378
base_revision_id, revision_graph=
380
return merger, verified
383
def from_revision_ids(pb, tree, other, base=None, other_branch=None,
384
base_branch=None, revision_graph=None,
386
"""Return a Merger for revision-ids.
388
:param pb: A progress indicator
389
:param tree: The tree to merge changes into
390
:param other: The revision-id to use as OTHER
391
:param base: The revision-id to use as BASE. If not specified, will
393
:param other_branch: A branch containing the other revision-id. If
394
not supplied, tree.branch is used.
395
:param base_branch: A branch containing the base revision-id. If
396
not supplied, other_branch or tree.branch will be used.
397
:param revision_graph: If you have a revision_graph precomputed, pass
398
it in, otherwise it will be created for you.
399
:param tree_branch: The branch associated with tree. If not supplied,
400
tree.branch will be used.
402
if tree_branch is None:
403
tree_branch = tree.branch
404
merger = Merger(tree_branch, this_tree=tree, pb=pb,
405
revision_graph=revision_graph)
406
if other_branch is None:
407
other_branch = tree.branch
408
merger.set_other_revision(other, other_branch)
412
if base_branch is None:
413
base_branch = other_branch
414
merger.set_base_revision(base, base_branch)
417
def revision_tree(self, revision_id, branch=None):
418
if revision_id not in self._cached_trees:
420
branch = self.this_branch
422
tree = self.this_tree.revision_tree(revision_id)
423
except errors.NoSuchRevisionInTree:
424
tree = branch.repository.revision_tree(revision_id)
425
self._cached_trees[revision_id] = tree
426
return self._cached_trees[revision_id]
428
def _get_tree(self, treespec, possible_transports=None):
429
from bzrlib import workingtree
430
location, revno = treespec
432
tree = workingtree.WorkingTree.open_containing(location)[0]
433
return tree.branch, tree
434
branch = _mod_branch.Branch.open_containing(
435
location, possible_transports)[0]
437
revision_id = branch.last_revision()
439
revision_id = branch.get_rev_id(revno)
440
revision_id = _mod_revision.ensure_null(revision_id)
441
return branch, self.revision_tree(revision_id, branch)
443
@deprecated_method(deprecated_in((2, 1, 0)))
444
def ensure_revision_trees(self):
445
if self.this_revision_tree is None:
446
self.this_basis_tree = self.revision_tree(self.this_basis)
447
if self.this_basis == self.this_rev_id:
448
self.this_revision_tree = self.this_basis_tree
450
if self.other_rev_id is None:
451
other_basis_tree = self.revision_tree(self.other_basis)
452
if other_basis_tree.has_changes(self.other_tree):
453
raise errors.WorkingTreeNotRevision(self.this_tree)
454
other_rev_id = self.other_basis
455
self.other_tree = other_basis_tree
457
@deprecated_method(deprecated_in((2, 1, 0)))
458
def file_revisions(self, file_id):
459
self.ensure_revision_trees()
460
def get_id(tree, file_id):
461
revision_id = tree.inventory[file_id].revision
463
if self.this_rev_id is None:
464
if self.this_basis_tree.get_file_sha1(file_id) != \
465
self.this_tree.get_file_sha1(file_id):
466
raise errors.WorkingTreeNotRevision(self.this_tree)
468
trees = (self.this_basis_tree, self.other_tree)
469
return [get_id(tree, file_id) for tree in trees]
471
@deprecated_method(deprecated_in((2, 1, 0)))
472
def check_basis(self, check_clean, require_commits=True):
473
if self.this_basis is None and require_commits is True:
474
raise errors.BzrCommandError(
475
"This branch has no commits."
476
" (perhaps you would prefer 'bzr pull')")
187
changes = compare_trees(this_branch.working_tree(),
188
this_branch.basis_tree(), False)
189
if changes.has_changed():
190
raise BzrCommandError("Working tree has uncommitted changes.")
191
other_branch, other_tree = get_tree(other_revision, tempdir, "other")
479
if self.this_basis != self.this_rev_id:
480
raise errors.UncommittedChanges(self.this_tree)
482
@deprecated_method(deprecated_in((2, 1, 0)))
483
def compare_basis(self):
485
basis_tree = self.revision_tree(self.this_tree.last_revision())
486
except errors.NoSuchRevision:
487
basis_tree = self.this_tree.basis_tree()
488
if not self.this_tree.has_changes(basis_tree):
489
self.this_rev_id = self.this_basis
491
def set_interesting_files(self, file_list):
492
self.interesting_files = file_list
494
def set_pending(self):
495
if (not self.base_is_ancestor or not self.base_is_other_ancestor
496
or self.other_rev_id is None):
500
def _add_parent(self):
501
new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
502
new_parent_trees = []
503
operation = OperationWithCleanups(self.this_tree.set_parent_trees)
504
for revision_id in new_parents:
506
tree = self.revision_tree(revision_id)
507
except errors.NoSuchRevision:
511
operation.add_cleanup(tree.unlock)
512
new_parent_trees.append((revision_id, tree))
513
operation.run_simple(new_parent_trees, allow_leftmost_as_ghost=True)
515
def set_other(self, other_revision, possible_transports=None):
516
"""Set the revision and tree to merge from.
518
This sets the other_tree, other_rev_id, other_basis attributes.
520
:param other_revision: The [path, revision] list to merge from.
522
self.other_branch, self.other_tree = self._get_tree(other_revision,
524
if other_revision[1] == -1:
525
self.other_rev_id = _mod_revision.ensure_null(
526
self.other_branch.last_revision())
527
if _mod_revision.is_null(self.other_rev_id):
528
raise errors.NoCommits(self.other_branch)
529
self.other_basis = self.other_rev_id
530
elif other_revision[1] is not None:
531
self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
532
self.other_basis = self.other_rev_id
534
self.other_rev_id = None
535
self.other_basis = self.other_branch.last_revision()
536
if self.other_basis is None:
537
raise errors.NoCommits(self.other_branch)
538
if self.other_rev_id is not None:
539
self._cached_trees[self.other_rev_id] = self.other_tree
540
self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
542
def set_other_revision(self, revision_id, other_branch):
543
"""Set 'other' based on a branch and revision id
545
:param revision_id: The revision to use for a tree
546
:param other_branch: The branch containing this tree
548
self.other_rev_id = revision_id
549
self.other_branch = other_branch
550
self._maybe_fetch(other_branch, self.this_branch, self.other_rev_id)
551
self.other_tree = self.revision_tree(revision_id)
552
self.other_basis = revision_id
554
def set_base_revision(self, revision_id, branch):
555
"""Set 'base' based on a branch and revision id
557
:param revision_id: The revision to use for a tree
558
:param branch: The branch containing this tree
560
self.base_rev_id = revision_id
561
self.base_branch = branch
562
self._maybe_fetch(branch, self.this_branch, revision_id)
563
self.base_tree = self.revision_tree(revision_id)
565
def _maybe_fetch(self, source, target, revision_id):
566
if not source.repository.has_same_location(target.repository):
567
target.fetch(source, revision_id)
570
revisions = [_mod_revision.ensure_null(self.this_basis),
571
_mod_revision.ensure_null(self.other_basis)]
572
if _mod_revision.NULL_REVISION in revisions:
573
self.base_rev_id = _mod_revision.NULL_REVISION
574
self.base_tree = self.revision_tree(self.base_rev_id)
575
self._is_criss_cross = False
577
lcas = self.revision_graph.find_lca(revisions[0], revisions[1])
578
self._is_criss_cross = False
580
self.base_rev_id = _mod_revision.NULL_REVISION
582
self.base_rev_id = list(lcas)[0]
583
else: # len(lcas) > 1
585
# find_unique_lca can only handle 2 nodes, so we have to
586
# start back at the beginning. It is a shame to traverse
587
# the graph again, but better than re-implementing
589
self.base_rev_id = self.revision_graph.find_unique_lca(
590
revisions[0], revisions[1])
592
self.base_rev_id = self.revision_graph.find_unique_lca(
594
self._is_criss_cross = True
595
if self.base_rev_id == _mod_revision.NULL_REVISION:
596
raise errors.UnrelatedBranches()
597
if self._is_criss_cross:
598
trace.warning('Warning: criss-cross merge encountered. See bzr'
599
' help criss-cross.')
600
trace.mutter('Criss-cross lcas: %r' % lcas)
601
interesting_revision_ids = [self.base_rev_id]
602
interesting_revision_ids.extend(lcas)
603
interesting_trees = dict((t.get_revision_id(), t)
604
for t in self.this_branch.repository.revision_trees(
605
interesting_revision_ids))
606
self._cached_trees.update(interesting_trees)
607
self.base_tree = interesting_trees.pop(self.base_rev_id)
608
sorted_lca_keys = self.revision_graph.find_merge_order(
610
self._lca_trees = [interesting_trees[key]
611
for key in sorted_lca_keys]
613
self.base_tree = self.revision_tree(self.base_rev_id)
614
self.base_is_ancestor = True
615
self.base_is_other_ancestor = True
616
trace.mutter('Base revid: %r' % self.base_rev_id)
618
def set_base(self, base_revision):
619
"""Set the base revision to use for the merge.
621
:param base_revision: A 2-list containing a path and revision number.
623
trace.mutter("doing merge() with no base_revision specified")
192
624
if base_revision == [None, None]:
193
if other_revision[1] == -1:
196
o_revno = other_revision[1]
197
base_revno = this_branch.common_ancestor(other_branch,
198
other_revno=o_revno)[0]
199
if base_revno is None:
200
raise UnrelatedBranches()
201
base_revision = ['.', base_revno]
202
base_branch, base_tree = get_tree(base_revision, tempdir, "base")
203
merge_inner(this_branch, other_tree, base_tree, tempdir,
204
ignore_zero=ignore_zero)
206
shutil.rmtree(tempdir)
209
def generate_cset_optimized(tree_a, tree_b, inventory_a, inventory_b):
210
"""Generate a changeset, using the text_id to mark really-changed files.
211
This permits blazing comparisons when text_ids are present. It also
212
disables metadata comparison for files with identical texts.
214
for file_id in tree_a.tree.inventory:
215
if file_id not in tree_b.tree.inventory:
217
entry_a = tree_a.tree.inventory[file_id]
218
entry_b = tree_b.tree.inventory[file_id]
219
if (entry_a.kind, entry_b.kind) != ("file", "file"):
221
if None in (entry_a.text_id, entry_b.text_id):
223
if entry_a.text_id != entry_b.text_id:
225
inventory_a[abspath(tree_a.tree, file_id)].interesting = False
226
inventory_b[abspath(tree_b.tree, file_id)].interesting = False
227
cset = generate_changeset(tree_a, tree_b, inventory_a, inventory_b)
228
for entry in cset.entries.itervalues():
229
entry.metadata_change = None
233
def merge_inner(this_branch, other_tree, base_tree, tempdir,
235
this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
237
def get_inventory(tree):
238
return tree.inventory
240
inv_changes = merge_flex(this_tree, base_tree, other_tree,
241
generate_cset_optimized, get_inventory,
242
MergeConflictHandler(base_tree.root,
243
ignore_zero=ignore_zero))
246
for id, path in inv_changes.iteritems():
251
assert path.startswith('./')
253
adjust_ids.append((path, id))
254
this_branch.set_inventory(regen_inventory(this_branch, this_tree.root, adjust_ids))
257
def regen_inventory(this_branch, root, new_entries):
258
old_entries = this_branch.read_working_inventory()
261
for file_id in old_entries:
262
entry = old_entries[file_id]
263
path = old_entries.id2path(file_id)
264
new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
265
by_path[path] = file_id
270
for path, file_id in new_entries:
272
del new_inventory[file_id]
275
new_path_list.append((path, file_id))
276
if file_id not in old_entries:
278
# Ensure no file is added before its parent
280
for path, file_id in new_path_list:
284
parent = by_path[os.path.dirname(path)]
285
kind = bzrlib.osutils.file_kind(os.path.join(root, path))
286
new_inventory[file_id] = (path, file_id, parent, kind)
287
by_path[path] = file_id
289
# Get a list in insertion order
290
new_inventory_list = new_inventory.values()
291
mutter ("""Inventory regeneration:
292
old length: %i insertions: %i deletions: %i new_length: %i"""\
293
% (len(old_entries), insertions, deletions, len(new_inventory_list)))
294
assert len(new_inventory_list) == len(old_entries) + insertions - deletions
295
new_inventory_list.sort()
296
return new_inventory_list
627
base_branch, self.base_tree = self._get_tree(base_revision)
628
if base_revision[1] == -1:
629
self.base_rev_id = base_branch.last_revision()
630
elif base_revision[1] is None:
631
self.base_rev_id = _mod_revision.NULL_REVISION
633
self.base_rev_id = _mod_revision.ensure_null(
634
base_branch.get_rev_id(base_revision[1]))
635
self._maybe_fetch(base_branch, self.this_branch, self.base_rev_id)
637
def make_merger(self):
638
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
639
'other_tree': self.other_tree,
640
'interesting_ids': self.interesting_ids,
641
'interesting_files': self.interesting_files,
642
'this_branch': self.this_branch,
644
if self.merge_type.requires_base:
645
kwargs['base_tree'] = self.base_tree
646
if self.merge_type.supports_reprocess:
647
kwargs['reprocess'] = self.reprocess
649
raise errors.BzrError(
650
"Conflict reduction is not supported for merge"
651
" type %s." % self.merge_type)
652
if self.merge_type.supports_show_base:
653
kwargs['show_base'] = self.show_base
655
raise errors.BzrError("Showing base is not supported for this"
656
" merge type. %s" % self.merge_type)
657
if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
658
and not self.base_is_other_ancestor):
659
raise errors.CannotReverseCherrypick()
660
if self.merge_type.supports_cherrypick:
661
kwargs['cherrypick'] = (not self.base_is_ancestor or
662
not self.base_is_other_ancestor)
663
if self._is_criss_cross and getattr(self.merge_type,
664
'supports_lca_trees', False):
665
kwargs['lca_trees'] = self._lca_trees
666
return self.merge_type(pb=None,
667
change_reporter=self.change_reporter,
670
def _do_merge_to(self):
671
merge = self.make_merger()
672
if self.other_branch is not None:
673
self.other_branch.update_references(self.this_branch)
675
if self.recurse == 'down':
676
for relpath, file_id in self.this_tree.iter_references():
677
sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
678
other_revision = self.other_tree.get_reference_revision(
680
if other_revision == sub_tree.last_revision():
682
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
683
sub_merge.merge_type = self.merge_type
684
other_branch = self.other_branch.reference_parent(file_id, relpath)
685
sub_merge.set_other_revision(other_revision, other_branch)
686
base_revision = self.base_tree.get_reference_revision(file_id)
687
sub_merge.base_tree = \
688
sub_tree.branch.repository.revision_tree(base_revision)
689
sub_merge.base_rev_id = base_revision
694
operation = OperationWithCleanups(self._do_merge_to)
695
self.this_tree.lock_tree_write()
696
operation.add_cleanup(self.this_tree.unlock)
697
if self.base_tree is not None:
698
self.base_tree.lock_read()
699
operation.add_cleanup(self.base_tree.unlock)
700
if self.other_tree is not None:
701
self.other_tree.lock_read()
702
operation.add_cleanup(self.other_tree.unlock)
703
merge = operation.run_simple()
704
if len(merge.cooked_conflicts) == 0:
705
if not self.ignore_zero and not trace.is_quiet():
706
trace.note("All changes applied successfully.")
708
trace.note("%d conflicts encountered."
709
% len(merge.cooked_conflicts))
711
return len(merge.cooked_conflicts)
714
class _InventoryNoneEntry(object):
715
"""This represents an inventory entry which *isn't there*.
717
It simplifies the merging logic if we always have an InventoryEntry, even
718
if it isn't actually present
725
symlink_target = None
728
_none_entry = _InventoryNoneEntry()
731
class Merge3Merger(object):
732
"""Three-way merger that uses the merge3 text merger"""
734
supports_reprocess = True
735
supports_show_base = True
736
history_based = False
737
supports_cherrypick = True
738
supports_reverse_cherrypick = True
739
winner_idx = {"this": 2, "other": 1, "conflict": 1}
740
supports_lca_trees = True
742
def __init__(self, working_tree, this_tree, base_tree, other_tree,
743
interesting_ids=None, reprocess=False, show_base=False,
744
pb=None, pp=None, change_reporter=None,
745
interesting_files=None, do_merge=True,
746
cherrypick=False, lca_trees=None, this_branch=None):
747
"""Initialize the merger object and perform the merge.
749
:param working_tree: The working tree to apply the merge to
750
:param this_tree: The local tree in the merge operation
751
:param base_tree: The common tree in the merge operation
752
:param other_tree: The other tree to merge changes from
753
:param this_branch: The branch associated with this_tree. Defaults to
754
this_tree.branch if not supplied.
755
:param interesting_ids: The file_ids of files that should be
756
participate in the merge. May not be combined with
758
:param: reprocess If True, perform conflict-reduction processing.
759
:param show_base: If True, show the base revision in text conflicts.
760
(incompatible with reprocess)
762
:param pp: A ProgressPhase object
763
:param change_reporter: An object that should report changes made
764
:param interesting_files: The tree-relative paths of files that should
765
participate in the merge. If these paths refer to directories,
766
the contents of those directories will also be included. May not
767
be combined with interesting_ids. If neither interesting_files nor
768
interesting_ids is specified, all files may participate in the
770
:param lca_trees: Can be set to a dictionary of {revision_id:rev_tree}
771
if the ancestry was found to include a criss-cross merge.
772
Otherwise should be None.
774
object.__init__(self)
775
if interesting_files is not None and interesting_ids is not None:
777
'specify either interesting_ids or interesting_files')
778
if this_branch is None:
779
this_branch = this_tree.branch
780
self.interesting_ids = interesting_ids
781
self.interesting_files = interesting_files
782
self.this_tree = working_tree
783
self.base_tree = base_tree
784
self.other_tree = other_tree
785
self.this_branch = this_branch
786
self._raw_conflicts = []
787
self.cooked_conflicts = []
788
self.reprocess = reprocess
789
self.show_base = show_base
790
self._lca_trees = lca_trees
791
# Uncommenting this will change the default algorithm to always use
792
# _entries_lca. This can be useful for running the test suite and
793
# making sure we haven't missed any corner cases.
794
# if lca_trees is None:
795
# self._lca_trees = [self.base_tree]
796
self.change_reporter = change_reporter
797
self.cherrypick = cherrypick
801
warnings.warn("pp argument to Merge3Merger is deprecated")
803
warnings.warn("pb argument to Merge3Merger is deprecated")
806
operation = OperationWithCleanups(self._do_merge)
807
self.this_tree.lock_tree_write()
808
operation.add_cleanup(self.this_tree.unlock)
809
self.base_tree.lock_read()
810
operation.add_cleanup(self.base_tree.unlock)
811
self.other_tree.lock_read()
812
operation.add_cleanup(self.other_tree.unlock)
815
def _do_merge(self, operation):
816
self.tt = transform.TreeTransform(self.this_tree, None)
817
operation.add_cleanup(self.tt.finalize)
818
self._compute_transform()
819
results = self.tt.apply(no_conflicts=True)
820
self.write_modified(results)
822
self.this_tree.add_conflicts(self.cooked_conflicts)
823
except errors.UnsupportedOperation:
826
def make_preview_transform(self):
827
operation = OperationWithCleanups(self._make_preview_transform)
828
self.base_tree.lock_read()
829
operation.add_cleanup(self.base_tree.unlock)
830
self.other_tree.lock_read()
831
operation.add_cleanup(self.other_tree.unlock)
832
return operation.run_simple()
834
def _make_preview_transform(self):
835
self.tt = transform.TransformPreview(self.this_tree)
836
self._compute_transform()
839
def _compute_transform(self):
840
if self._lca_trees is None:
841
entries = self._entries3()
842
resolver = self._three_way
844
entries = self._entries_lca()
845
resolver = self._lca_multi_way
846
child_pb = ui.ui_factory.nested_progress_bar()
848
factories = Merger.hooks['merge_file_content']
849
hooks = [factory(self) for factory in factories] + [self]
850
self.active_hooks = [hook for hook in hooks if hook is not None]
851
for num, (file_id, changed, parents3, names3,
852
executable3) in enumerate(entries):
853
child_pb.update('Preparing file merge', num, len(entries))
854
self._merge_names(file_id, parents3, names3, resolver=resolver)
856
file_status = self._do_merge_contents(file_id)
858
file_status = 'unmodified'
859
self._merge_executable(file_id,
860
executable3, file_status, resolver=resolver)
864
child_pb = ui.ui_factory.nested_progress_bar()
866
fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
867
lambda t, c: transform.conflict_pass(t, c, self.other_tree))
870
if self.change_reporter is not None:
871
from bzrlib import delta
872
delta.report_changes(
873
self.tt.iter_changes(), self.change_reporter)
874
self.cook_conflicts(fs_conflicts)
875
for conflict in self.cooked_conflicts:
876
trace.warning(conflict)
879
"""Gather data about files modified between three trees.
881
Return a list of tuples of file_id, changed, parents3, names3,
882
executable3. changed is a boolean indicating whether the file contents
883
or kind were changed. parents3 is a tuple of parent ids for base,
884
other and this. names3 is a tuple of names for base, other and this.
885
executable3 is a tuple of execute-bit values for base, other and this.
888
iterator = self.other_tree.iter_changes(self.base_tree,
889
include_unchanged=True, specific_files=self.interesting_files,
890
extra_trees=[self.this_tree])
891
this_entries = dict((e.file_id, e) for p, e in
892
self.this_tree.iter_entries_by_dir(
893
self.interesting_ids))
894
for (file_id, paths, changed, versioned, parents, names, kind,
895
executable) in iterator:
896
if (self.interesting_ids is not None and
897
file_id not in self.interesting_ids):
899
entry = this_entries.get(file_id)
900
if entry is not None:
901
this_name = entry.name
902
this_parent = entry.parent_id
903
this_executable = entry.executable
907
this_executable = None
908
parents3 = parents + (this_parent,)
909
names3 = names + (this_name,)
910
executable3 = executable + (this_executable,)
911
result.append((file_id, changed, parents3, names3, executable3))
914
def _entries_lca(self):
915
"""Gather data about files modified between multiple trees.
917
This compares OTHER versus all LCA trees, and for interesting entries,
918
it then compares with THIS and BASE.
920
For the multi-valued entries, the format will be (BASE, [lca1, lca2])
921
:return: [(file_id, changed, parents, names, executable)]
922
file_id Simple file_id of the entry
923
changed Boolean, True if the kind or contents changed
925
parents ((base, [parent_id, in, lcas]), parent_id_other,
927
names ((base, [name, in, lcas]), name_in_other, name_in_this)
928
executable ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
930
if self.interesting_files is not None:
931
lookup_trees = [self.this_tree, self.base_tree]
932
lookup_trees.extend(self._lca_trees)
933
# I think we should include the lca trees as well
934
interesting_ids = self.other_tree.paths2ids(self.interesting_files,
937
interesting_ids = self.interesting_ids
939
walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
941
base_inventory = self.base_tree.inventory
942
this_inventory = self.this_tree.inventory
943
for path, file_id, other_ie, lca_values in walker.iter_all():
944
# Is this modified at all from any of the other trees?
946
other_ie = _none_entry
947
if interesting_ids is not None and file_id not in interesting_ids:
950
# If other_revision is found in any of the lcas, that means this
951
# node is uninteresting. This is because when merging, if there are
952
# multiple heads(), we have to create a new node. So if we didn't,
953
# we know that the ancestry is linear, and that OTHER did not
955
# See doc/developers/lca_merge_resolution.txt for details
956
other_revision = other_ie.revision
957
if other_revision is not None:
958
# We can't use this shortcut when other_revision is None,
959
# because it may be None because things are WorkingTrees, and
960
# not because it is *actually* None.
961
is_unmodified = False
962
for lca_path, ie in lca_values:
963
if ie is not None and ie.revision == other_revision:
970
for lca_path, lca_ie in lca_values:
972
lca_entries.append(_none_entry)
974
lca_entries.append(lca_ie)
976
if file_id in base_inventory:
977
base_ie = base_inventory[file_id]
979
base_ie = _none_entry
981
if file_id in this_inventory:
982
this_ie = this_inventory[file_id]
984
this_ie = _none_entry
990
for lca_ie in lca_entries:
991
lca_kinds.append(lca_ie.kind)
992
lca_parent_ids.append(lca_ie.parent_id)
993
lca_names.append(lca_ie.name)
994
lca_executable.append(lca_ie.executable)
996
kind_winner = self._lca_multi_way(
997
(base_ie.kind, lca_kinds),
998
other_ie.kind, this_ie.kind)
999
parent_id_winner = self._lca_multi_way(
1000
(base_ie.parent_id, lca_parent_ids),
1001
other_ie.parent_id, this_ie.parent_id)
1002
name_winner = self._lca_multi_way(
1003
(base_ie.name, lca_names),
1004
other_ie.name, this_ie.name)
1006
content_changed = True
1007
if kind_winner == 'this':
1008
# No kind change in OTHER, see if there are *any* changes
1009
if other_ie.kind == 'directory':
1010
if parent_id_winner == 'this' and name_winner == 'this':
1011
# No change for this directory in OTHER, skip
1013
content_changed = False
1014
elif other_ie.kind is None or other_ie.kind == 'file':
1015
def get_sha1(ie, tree):
1016
if ie.kind != 'file':
1018
return tree.get_file_sha1(file_id)
1019
base_sha1 = get_sha1(base_ie, self.base_tree)
1020
lca_sha1s = [get_sha1(ie, tree) for ie, tree
1021
in zip(lca_entries, self._lca_trees)]
1022
this_sha1 = get_sha1(this_ie, self.this_tree)
1023
other_sha1 = get_sha1(other_ie, self.other_tree)
1024
sha1_winner = self._lca_multi_way(
1025
(base_sha1, lca_sha1s), other_sha1, this_sha1,
1026
allow_overriding_lca=False)
1027
exec_winner = self._lca_multi_way(
1028
(base_ie.executable, lca_executable),
1029
other_ie.executable, this_ie.executable)
1030
if (parent_id_winner == 'this' and name_winner == 'this'
1031
and sha1_winner == 'this' and exec_winner == 'this'):
1032
# No kind, parent, name, exec, or content change for
1033
# OTHER, so this node is not considered interesting
1035
if sha1_winner == 'this':
1036
content_changed = False
1037
elif other_ie.kind == 'symlink':
1038
def get_target(ie, tree):
1039
if ie.kind != 'symlink':
1041
return tree.get_symlink_target(file_id)
1042
base_target = get_target(base_ie, self.base_tree)
1043
lca_targets = [get_target(ie, tree) for ie, tree
1044
in zip(lca_entries, self._lca_trees)]
1045
this_target = get_target(this_ie, self.this_tree)
1046
other_target = get_target(other_ie, self.other_tree)
1047
target_winner = self._lca_multi_way(
1048
(base_target, lca_targets),
1049
other_target, this_target)
1050
if (parent_id_winner == 'this' and name_winner == 'this'
1051
and target_winner == 'this'):
1052
# No kind, parent, name, or symlink target change
1055
if target_winner == 'this':
1056
content_changed = False
1057
elif other_ie.kind == 'tree-reference':
1058
# The 'changed' information seems to be handled at a higher
1059
# level. At least, _entries3 returns False for content
1060
# changed, even when at a new revision_id.
1061
content_changed = False
1062
if (parent_id_winner == 'this' and name_winner == 'this'):
1063
# Nothing interesting
1066
raise AssertionError('unhandled kind: %s' % other_ie.kind)
1068
# If we have gotten this far, that means something has changed
1069
result.append((file_id, content_changed,
1070
((base_ie.parent_id, lca_parent_ids),
1071
other_ie.parent_id, this_ie.parent_id),
1072
((base_ie.name, lca_names),
1073
other_ie.name, this_ie.name),
1074
((base_ie.executable, lca_executable),
1075
other_ie.executable, this_ie.executable)
1082
self.tt.final_kind(self.tt.root)
1083
except errors.NoSuchFile:
1084
self.tt.cancel_deletion(self.tt.root)
1085
if self.tt.final_file_id(self.tt.root) is None:
1086
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
1088
other_root_file_id = self.other_tree.get_root_id()
1089
if other_root_file_id is None:
1091
other_root = self.tt.trans_id_file_id(other_root_file_id)
1092
if other_root == self.tt.root:
1094
if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
1095
# the other tree's root is a non-root in the current tree (as when
1096
# a previously unrelated branch is merged into another)
1099
self.tt.final_kind(other_root)
1100
other_root_is_present = True
1101
except errors.NoSuchFile:
1102
# other_root doesn't have a physical representation. We still need
1103
# to move any references to the actual root of the tree.
1104
other_root_is_present = False
1105
# 'other_tree.inventory.root' is not present in this tree. We are
1106
# calling adjust_path for children which *want* to be present with a
1107
# correct place to go.
1108
for thing, child in self.other_tree.inventory.root.children.iteritems():
1109
trans_id = self.tt.trans_id_file_id(child.file_id)
1110
if not other_root_is_present:
1111
# FIXME: Make final_kind returns None instead of raising
1112
# NoSuchFile to avoid the ugly construct below -- vila 20100402
1114
self.tt.final_kind(trans_id)
1115
# The item exist in the final tree and has a defined place
1118
except errors.NoSuchFile, e:
1120
# Move the item into the root
1121
self.tt.adjust_path(self.tt.final_name(trans_id),
1122
self.tt.root, trans_id)
1123
if other_root_is_present:
1124
self.tt.cancel_creation(other_root)
1125
self.tt.cancel_versioning(other_root)
1127
def write_modified(self, results):
1128
modified_hashes = {}
1129
for path in results.modified_paths:
1130
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
1133
hash = self.this_tree.get_file_sha1(file_id)
1136
modified_hashes[file_id] = hash
1137
self.this_tree.set_merge_modified(modified_hashes)
1140
def parent(entry, file_id):
1141
"""Determine the parent for a file_id (used as a key method)"""
1144
return entry.parent_id
1147
def name(entry, file_id):
1148
"""Determine the name for a file_id (used as a key method)"""
1154
def contents_sha1(tree, file_id):
1155
"""Determine the sha1 of the file contents (used as a key method)."""
1156
if file_id not in tree:
1158
return tree.get_file_sha1(file_id)
1161
def executable(tree, file_id):
1162
"""Determine the executability of a file-id (used as a key method)."""
1163
if not tree.has_id(file_id):
1165
if tree.kind(file_id) != "file":
1167
return tree.is_executable(file_id)
1170
def kind(tree, file_id):
1171
"""Determine the kind of a file-id (used as a key method)."""
1172
if not tree.has_id(file_id):
1174
return tree.kind(file_id)
1177
def _three_way(base, other, this):
1179
# if 'base == other', either they all agree, or only 'this' has
1182
elif this not in (base, other):
1183
# 'this' is neither 'base' nor 'other', so both sides changed
1186
# "Ambiguous clean merge" -- both sides have made the same change.
1189
# this == base: only other has changed.
1193
def _lca_multi_way(bases, other, this, allow_overriding_lca=True):
1194
"""Consider LCAs when determining whether a change has occurred.
1196
If LCAS are all identical, this is the same as a _three_way comparison.
1198
:param bases: value in (BASE, [LCAS])
1199
:param other: value in OTHER
1200
:param this: value in THIS
1201
:param allow_overriding_lca: If there is more than one unique lca
1202
value, allow OTHER to override THIS if it has a new value, and
1203
THIS only has an lca value, or vice versa. This is appropriate for
1204
truly scalar values, not as much for non-scalars.
1205
:return: 'this', 'other', or 'conflict' depending on whether an entry
1208
# See doc/developers/lca_tree_merging.txt for details about this
1211
# Either Ambiguously clean, or nothing was actually changed. We
1214
base_val, lca_vals = bases
1215
# Remove 'base_val' from the lca_vals, because it is not interesting
1216
filtered_lca_vals = [lca_val for lca_val in lca_vals
1217
if lca_val != base_val]
1218
if len(filtered_lca_vals) == 0:
1219
return Merge3Merger._three_way(base_val, other, this)
1221
unique_lca_vals = set(filtered_lca_vals)
1222
if len(unique_lca_vals) == 1:
1223
return Merge3Merger._three_way(unique_lca_vals.pop(), other, this)
1225
if allow_overriding_lca:
1226
if other in unique_lca_vals:
1227
if this in unique_lca_vals:
1228
# Each side picked a different lca, conflict
1231
# This has a value which supersedes both lca values, and
1232
# other only has an lca value
1234
elif this in unique_lca_vals:
1235
# OTHER has a value which supersedes both lca values, and this
1236
# only has an lca value
1239
# At this point, the lcas disagree, and the tip disagree
1243
@deprecated_method(deprecated_in((2, 2, 0)))
1244
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
1245
"""Do a three-way test on a scalar.
1246
Return "this", "other" or "conflict", depending whether a value wins.
1248
key_base = key(base_tree, file_id)
1249
key_other = key(other_tree, file_id)
1250
#if base == other, either they all agree, or only THIS has changed.
1251
if key_base == key_other:
1253
key_this = key(this_tree, file_id)
1254
# "Ambiguous clean merge"
1255
if key_this == key_other:
1257
elif key_this == key_base:
1262
def merge_names(self, file_id):
1263
def get_entry(tree):
1264
if tree.has_id(file_id):
1265
return tree.inventory[file_id]
1268
this_entry = get_entry(self.this_tree)
1269
other_entry = get_entry(self.other_tree)
1270
base_entry = get_entry(self.base_tree)
1271
entries = (base_entry, other_entry, this_entry)
1274
for entry in entries:
1277
parents.append(None)
1279
names.append(entry.name)
1280
parents.append(entry.parent_id)
1281
return self._merge_names(file_id, parents, names,
1282
resolver=self._three_way)
1284
def _merge_names(self, file_id, parents, names, resolver):
1285
"""Perform a merge on file_id names and parents"""
1286
base_name, other_name, this_name = names
1287
base_parent, other_parent, this_parent = parents
1289
name_winner = resolver(*names)
1291
parent_id_winner = resolver(*parents)
1292
if this_name is None:
1293
if name_winner == "this":
1294
name_winner = "other"
1295
if parent_id_winner == "this":
1296
parent_id_winner = "other"
1297
if name_winner == "this" and parent_id_winner == "this":
1299
if name_winner == 'conflict' or parent_id_winner == 'conflict':
1300
# Creating helpers (.OTHER or .THIS) here cause problems down the
1301
# road if a ContentConflict needs to be created so we should not do
1303
trans_id = self.tt.trans_id_file_id(file_id)
1304
self._raw_conflicts.append(('path conflict', trans_id, file_id,
1305
this_parent, this_name,
1306
other_parent, other_name))
1307
if other_name is None:
1308
# it doesn't matter whether the result was 'other' or
1309
# 'conflict'-- if there's no 'other', we leave it alone.
1311
parent_id = parents[self.winner_idx[parent_id_winner]]
1312
if parent_id is not None:
1313
# if we get here, name_winner and parent_winner are set to safe
1315
self.tt.adjust_path(names[self.winner_idx[name_winner]],
1316
self.tt.trans_id_file_id(parent_id),
1317
self.tt.trans_id_file_id(file_id))
1319
def _do_merge_contents(self, file_id):
1320
"""Performs a merge on file_id contents."""
1321
def contents_pair(tree):
1322
if file_id not in tree:
1324
kind = tree.kind(file_id)
1326
contents = tree.get_file_sha1(file_id)
1327
elif kind == "symlink":
1328
contents = tree.get_symlink_target(file_id)
1331
return kind, contents
1333
# See SPOT run. run, SPOT, run.
1334
# So we're not QUITE repeating ourselves; we do tricky things with
1336
base_pair = contents_pair(self.base_tree)
1337
other_pair = contents_pair(self.other_tree)
1339
this_pair = contents_pair(self.this_tree)
1340
lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1341
winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1342
this_pair, allow_overriding_lca=False)
1344
if base_pair == other_pair:
1347
# We delayed evaluating this_pair as long as we can to avoid
1348
# unnecessary sha1 calculation
1349
this_pair = contents_pair(self.this_tree)
1350
winner = self._three_way(base_pair, other_pair, this_pair)
1351
if winner == 'this':
1352
# No interesting changes introduced by OTHER
1354
# We have a hypothetical conflict, but if we have files, then we
1355
# can try to merge the content
1356
trans_id = self.tt.trans_id_file_id(file_id)
1357
params = MergeHookParams(self, file_id, trans_id, this_pair[0],
1358
other_pair[0], winner)
1359
hooks = self.active_hooks
1360
hook_status = 'not_applicable'
1362
hook_status, lines = hook.merge_contents(params)
1363
if hook_status != 'not_applicable':
1364
# Don't try any more hooks, this one applies.
1367
if hook_status == 'not_applicable':
1368
# This is a contents conflict, because none of the available
1369
# functions could merge it.
1371
name = self.tt.final_name(trans_id)
1372
parent_id = self.tt.final_parent(trans_id)
1373
if self.this_tree.has_id(file_id):
1374
self.tt.unversion_file(trans_id)
1375
file_group = self._dump_conflicts(name, parent_id, file_id,
1377
self._raw_conflicts.append(('contents conflict', file_group))
1378
elif hook_status == 'success':
1379
self.tt.create_file(lines, trans_id)
1380
elif hook_status == 'conflicted':
1381
# XXX: perhaps the hook should be able to provide
1382
# the BASE/THIS/OTHER files?
1383
self.tt.create_file(lines, trans_id)
1384
self._raw_conflicts.append(('text conflict', trans_id))
1385
name = self.tt.final_name(trans_id)
1386
parent_id = self.tt.final_parent(trans_id)
1387
self._dump_conflicts(name, parent_id, file_id)
1388
elif hook_status == 'delete':
1389
self.tt.unversion_file(trans_id)
1391
elif hook_status == 'done':
1392
# The hook function did whatever it needs to do directly, no
1393
# further action needed here.
1396
raise AssertionError('unknown hook_status: %r' % (hook_status,))
1397
if not self.this_tree.has_id(file_id) and result == "modified":
1398
self.tt.version_file(file_id, trans_id)
1399
# The merge has been performed, so the old contents should not be
1402
self.tt.delete_contents(trans_id)
1403
except errors.NoSuchFile:
1407
def _default_other_winner_merge(self, merge_hook_params):
1408
"""Replace this contents with other."""
1409
file_id = merge_hook_params.file_id
1410
trans_id = merge_hook_params.trans_id
1411
file_in_this = self.this_tree.has_id(file_id)
1412
if self.other_tree.has_id(file_id):
1413
# OTHER changed the file
1415
if wt.supports_content_filtering():
1416
# We get the path from the working tree if it exists.
1417
# That fails though when OTHER is adding a file, so
1418
# we fall back to the other tree to find the path if
1419
# it doesn't exist locally.
1421
filter_tree_path = wt.id2path(file_id)
1422
except errors.NoSuchId:
1423
filter_tree_path = self.other_tree.id2path(file_id)
1425
# Skip the id2path lookup for older formats
1426
filter_tree_path = None
1427
transform.create_from_tree(self.tt, trans_id,
1428
self.other_tree, file_id,
1429
filter_tree_path=filter_tree_path)
1432
# OTHER deleted the file
1433
return 'delete', None
1435
raise AssertionError(
1436
'winner is OTHER, but file_id %r not in THIS or OTHER tree'
1439
def merge_contents(self, merge_hook_params):
1440
"""Fallback merge logic after user installed hooks."""
1441
# This function is used in merge hooks as the fallback instance.
1442
# Perhaps making this function and the functions it calls be a
1443
# a separate class would be better.
1444
if merge_hook_params.winner == 'other':
1445
# OTHER is a straight winner, so replace this contents with other
1446
return self._default_other_winner_merge(merge_hook_params)
1447
elif merge_hook_params.is_file_merge():
1448
# THIS and OTHER are both files, so text merge. Either
1449
# BASE is a file, or both converted to files, so at least we
1450
# have agreement that output should be a file.
1452
self.text_merge(merge_hook_params.file_id,
1453
merge_hook_params.trans_id)
1454
except errors.BinaryFile:
1455
return 'not_applicable', None
1458
return 'not_applicable', None
1460
def get_lines(self, tree, file_id):
1461
"""Return the lines in a file, or an empty list."""
1462
if tree.has_id(file_id):
1463
return tree.get_file_lines(file_id)
1467
def text_merge(self, file_id, trans_id):
1468
"""Perform a three-way text merge on a file_id"""
1469
# it's possible that we got here with base as a different type.
1470
# if so, we just want two-way text conflicts.
1471
if self.base_tree.has_id(file_id) and \
1472
self.base_tree.kind(file_id) == "file":
1473
base_lines = self.get_lines(self.base_tree, file_id)
1476
other_lines = self.get_lines(self.other_tree, file_id)
1477
this_lines = self.get_lines(self.this_tree, file_id)
1478
m3 = merge3.Merge3(base_lines, this_lines, other_lines,
1479
is_cherrypick=self.cherrypick)
1480
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
1481
if self.show_base is True:
1482
base_marker = '|' * 7
1486
def iter_merge3(retval):
1487
retval["text_conflicts"] = False
1488
for line in m3.merge_lines(name_a = "TREE",
1489
name_b = "MERGE-SOURCE",
1490
name_base = "BASE-REVISION",
1491
start_marker=start_marker,
1492
base_marker=base_marker,
1493
reprocess=self.reprocess):
1494
if line.startswith(start_marker):
1495
retval["text_conflicts"] = True
1496
yield line.replace(start_marker, '<' * 7)
1500
merge3_iterator = iter_merge3(retval)
1501
self.tt.create_file(merge3_iterator, trans_id)
1502
if retval["text_conflicts"] is True:
1503
self._raw_conflicts.append(('text conflict', trans_id))
1504
name = self.tt.final_name(trans_id)
1505
parent_id = self.tt.final_parent(trans_id)
1506
file_group = self._dump_conflicts(name, parent_id, file_id,
1507
this_lines, base_lines,
1509
file_group.append(trans_id)
1511
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
1512
base_lines=None, other_lines=None, set_version=False,
1514
"""Emit conflict files.
1515
If this_lines, base_lines, or other_lines are omitted, they will be
1516
determined automatically. If set_version is true, the .OTHER, .THIS
1517
or .BASE (in that order) will be created as versioned files.
1519
data = [('OTHER', self.other_tree, other_lines),
1520
('THIS', self.this_tree, this_lines)]
1522
data.append(('BASE', self.base_tree, base_lines))
1524
# We need to use the actual path in the working tree of the file here,
1525
# ignoring the conflict suffixes
1527
if wt.supports_content_filtering():
1529
filter_tree_path = wt.id2path(file_id)
1530
except errors.NoSuchId:
1531
# file has been deleted
1532
filter_tree_path = None
1534
# Skip the id2path lookup for older formats
1535
filter_tree_path = None
1539
for suffix, tree, lines in data:
1540
if tree.has_id(file_id):
1541
trans_id = self._conflict_file(name, parent_id, tree, file_id,
1542
suffix, lines, filter_tree_path)
1543
file_group.append(trans_id)
1544
if set_version and not versioned:
1545
self.tt.version_file(file_id, trans_id)
1549
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1550
lines=None, filter_tree_path=None):
1551
"""Emit a single conflict file."""
1552
name = name + '.' + suffix
1553
trans_id = self.tt.create_path(name, parent_id)
1554
transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
1558
def merge_executable(self, file_id, file_status):
1559
"""Perform a merge on the execute bit."""
1560
executable = [self.executable(t, file_id) for t in (self.base_tree,
1561
self.other_tree, self.this_tree)]
1562
self._merge_executable(file_id, executable, file_status,
1563
resolver=self._three_way)
1565
def _merge_executable(self, file_id, executable, file_status,
1567
"""Perform a merge on the execute bit."""
1568
base_executable, other_executable, this_executable = executable
1569
if file_status == "deleted":
1571
winner = resolver(*executable)
1572
if winner == "conflict":
1573
# There must be a None in here, if we have a conflict, but we
1574
# need executability since file status was not deleted.
1575
if self.executable(self.other_tree, file_id) is None:
1579
if winner == 'this' and file_status != "modified":
1581
trans_id = self.tt.trans_id_file_id(file_id)
1583
if self.tt.final_kind(trans_id) != "file":
1585
except errors.NoSuchFile:
1587
if winner == "this":
1588
executability = this_executable
1590
if self.other_tree.has_id(file_id):
1591
executability = other_executable
1592
elif self.this_tree.has_id(file_id):
1593
executability = this_executable
1594
elif self.base_tree_has_id(file_id):
1595
executability = base_executable
1596
if executability is not None:
1597
trans_id = self.tt.trans_id_file_id(file_id)
1598
self.tt.set_executability(executability, trans_id)
1600
def cook_conflicts(self, fs_conflicts):
1601
"""Convert all conflicts into a form that doesn't depend on trans_id"""
1602
self.cooked_conflicts.extend(transform.cook_conflicts(
1603
fs_conflicts, self.tt))
1604
fp = transform.FinalPaths(self.tt)
1605
for conflict in self._raw_conflicts:
1606
conflict_type = conflict[0]
1607
if conflict_type == 'path conflict':
1609
this_parent, this_name,
1610
other_parent, other_name) = conflict[1:]
1611
if this_parent is None or this_name is None:
1612
this_path = '<deleted>'
1614
parent_path = fp.get_path(
1615
self.tt.trans_id_file_id(this_parent))
1616
this_path = osutils.pathjoin(parent_path, this_name)
1617
if other_parent is None or other_name is None:
1618
other_path = '<deleted>'
1620
parent_path = fp.get_path(
1621
self.tt.trans_id_file_id(other_parent))
1622
other_path = osutils.pathjoin(parent_path, other_name)
1623
c = _mod_conflicts.Conflict.factory(
1624
'path conflict', path=this_path,
1625
conflict_path=other_path,
1627
elif conflict_type == 'contents conflict':
1628
for trans_id in conflict[1]:
1629
file_id = self.tt.final_file_id(trans_id)
1630
if file_id is not None:
1632
path = fp.get_path(trans_id)
1633
for suffix in ('.BASE', '.THIS', '.OTHER'):
1634
if path.endswith(suffix):
1635
path = path[:-len(suffix)]
1637
c = _mod_conflicts.Conflict.factory(conflict_type,
1638
path=path, file_id=file_id)
1639
elif conflict_type == 'text conflict':
1640
trans_id = conflict[1]
1641
path = fp.get_path(trans_id)
1642
file_id = self.tt.final_file_id(trans_id)
1643
c = _mod_conflicts.Conflict.factory(conflict_type,
1644
path=path, file_id=file_id)
1646
raise AssertionError('bad conflict type: %r' % (conflict,))
1647
self.cooked_conflicts.append(c)
1648
self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1651
class WeaveMerger(Merge3Merger):
1652
"""Three-way tree merger, text weave merger."""
1653
supports_reprocess = True
1654
supports_show_base = False
1655
supports_reverse_cherrypick = False
1656
history_based = True
1658
def _generate_merge_plan(self, file_id, base):
1659
return self.this_tree.plan_file_merge(file_id, self.other_tree,
1662
def _merged_lines(self, file_id):
1663
"""Generate the merged lines.
1664
There is no distinction between lines that are meant to contain <<<<<<<
1668
base = self.base_tree
1671
plan = self._generate_merge_plan(file_id, base)
1672
if 'merge' in debug.debug_flags:
1674
trans_id = self.tt.trans_id_file_id(file_id)
1675
name = self.tt.final_name(trans_id) + '.plan'
1676
contents = ('%11s|%s' % l for l in plan)
1677
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1678
textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1679
'>>>>>>> MERGE-SOURCE\n')
1680
lines, conflicts = textmerge.merge_lines(self.reprocess)
1682
base_lines = textmerge.base_from_plan()
1685
return lines, base_lines
1687
def text_merge(self, file_id, trans_id):
1688
"""Perform a (weave) text merge for a given file and file-id.
1689
If conflicts are encountered, .THIS and .OTHER files will be emitted,
1690
and a conflict will be noted.
1692
lines, base_lines = self._merged_lines(file_id)
1694
# Note we're checking whether the OUTPUT is binary in this case,
1695
# because we don't want to get into weave merge guts.
1696
textfile.check_text_lines(lines)
1697
self.tt.create_file(lines, trans_id)
1698
if base_lines is not None:
1700
self._raw_conflicts.append(('text conflict', trans_id))
1701
name = self.tt.final_name(trans_id)
1702
parent_id = self.tt.final_parent(trans_id)
1703
file_group = self._dump_conflicts(name, parent_id, file_id,
1705
base_lines=base_lines)
1706
file_group.append(trans_id)
1709
class LCAMerger(WeaveMerger):
1711
def _generate_merge_plan(self, file_id, base):
1712
return self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1715
class Diff3Merger(Merge3Merger):
1716
"""Three-way merger using external diff3 for text merging"""
1718
def dump_file(self, temp_dir, name, tree, file_id):
1719
out_path = osutils.pathjoin(temp_dir, name)
1720
out_file = open(out_path, "wb")
1722
in_file = tree.get_file(file_id)
1723
for line in in_file:
1724
out_file.write(line)
1729
def text_merge(self, file_id, trans_id):
1730
"""Perform a diff3 merge using a specified file-id and trans-id.
1731
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
1732
will be dumped, and a will be conflict noted.
1735
temp_dir = osutils.mkdtemp(prefix="bzr-")
1737
new_file = osutils.pathjoin(temp_dir, "new")
1738
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
1739
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
1740
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
1741
status = bzrlib.patch.diff3(new_file, this, base, other)
1742
if status not in (0, 1):
1743
raise errors.BzrError("Unhandled diff3 exit code")
1744
f = open(new_file, 'rb')
1746
self.tt.create_file(f, trans_id)
1750
name = self.tt.final_name(trans_id)
1751
parent_id = self.tt.final_parent(trans_id)
1752
self._dump_conflicts(name, parent_id, file_id)
1753
self._raw_conflicts.append(('text conflict', trans_id))
1755
osutils.rmtree(temp_dir)
1758
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1760
merge_type=Merge3Merger,
1761
interesting_ids=None,
1765
interesting_files=None,
1768
change_reporter=None):
1769
"""Primary interface for merging.
1771
typical use is probably
1772
'merge_inner(branch, branch.get_revision_tree(other_revision),
1773
branch.get_revision_tree(base_revision))'
1775
if this_tree is None:
1776
raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
1777
"parameter as of bzrlib version 0.8.")
1778
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1779
pb=pb, change_reporter=change_reporter)
1780
merger.backup_files = backup_files
1781
merger.merge_type = merge_type
1782
merger.interesting_ids = interesting_ids
1783
merger.ignore_zero = ignore_zero
1784
if interesting_files:
1786
raise ValueError('Only supply interesting_ids'
1787
' or interesting_files')
1788
merger.interesting_files = interesting_files
1789
merger.show_base = show_base
1790
merger.reprocess = reprocess
1791
merger.other_rev_id = other_rev_id
1792
merger.other_basis = other_rev_id
1793
get_revision_id = getattr(base_tree, 'get_revision_id', None)
1794
if get_revision_id is None:
1795
get_revision_id = base_tree.last_revision
1796
merger.cache_trees_with_revision_ids([other_tree, base_tree, this_tree])
1797
merger.set_base_revision(get_revision_id(), this_branch)
1798
return merger.do_merge()
1800
def get_merge_type_registry():
1801
"""Merge type registry is in bzrlib.option to avoid circular imports.
1803
This method provides a sanctioned way to retrieve it.
1805
from bzrlib import option
1806
return option._merge_type_registry
1809
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
1810
def status_a(revision, text):
1811
if revision in ancestors_b:
1812
return 'killed-b', text
1814
return 'new-a', text
1816
def status_b(revision, text):
1817
if revision in ancestors_a:
1818
return 'killed-a', text
1820
return 'new-b', text
1822
plain_a = [t for (a, t) in annotated_a]
1823
plain_b = [t for (a, t) in annotated_b]
1824
matcher = patiencediff.PatienceSequenceMatcher(None, plain_a, plain_b)
1825
blocks = matcher.get_matching_blocks()
1828
for ai, bi, l in blocks:
1829
# process all mismatched sections
1830
# (last mismatched section is handled because blocks always
1831
# includes a 0-length last block)
1832
for revision, text in annotated_a[a_cur:ai]:
1833
yield status_a(revision, text)
1834
for revision, text in annotated_b[b_cur:bi]:
1835
yield status_b(revision, text)
1836
# and now the matched section
1839
for text_a in plain_a[ai:a_cur]:
1840
yield "unchanged", text_a
1843
class _PlanMergeBase(object):
1845
def __init__(self, a_rev, b_rev, vf, key_prefix):
1848
:param a_rev: Revision-id of one revision to merge
1849
:param b_rev: Revision-id of the other revision to merge
1850
:param vf: A VersionedFiles containing both revisions
1851
:param key_prefix: A prefix for accessing keys in vf, typically
1857
self._last_lines = None
1858
self._last_lines_revision_id = None
1859
self._cached_matching_blocks = {}
1860
self._key_prefix = key_prefix
1861
self._precache_tip_lines()
1863
def _precache_tip_lines(self):
1864
lines = self.get_lines([self.a_rev, self.b_rev])
1865
self.lines_a = lines[self.a_rev]
1866
self.lines_b = lines[self.b_rev]
1868
def get_lines(self, revisions):
1869
"""Get lines for revisions from the backing VersionedFiles.
1871
:raises RevisionNotPresent: on absent texts.
1873
keys = [(self._key_prefix + (rev,)) for rev in revisions]
1875
for record in self.vf.get_record_stream(keys, 'unordered', True):
1876
if record.storage_kind == 'absent':
1877
raise errors.RevisionNotPresent(record.key, self.vf)
1878
result[record.key[-1]] = osutils.chunks_to_lines(
1879
record.get_bytes_as('chunked'))
1882
def plan_merge(self):
1883
"""Generate a 'plan' for merging the two revisions.
1885
This involves comparing their texts and determining the cause of
1886
differences. If text A has a line and text B does not, then either the
1887
line was added to text A, or it was deleted from B. Once the causes
1888
are combined, they are written out in the format described in
1889
VersionedFile.plan_merge
1891
blocks = self._get_matching_blocks(self.a_rev, self.b_rev)
1892
unique_a, unique_b = self._unique_lines(blocks)
1893
new_a, killed_b = self._determine_status(self.a_rev, unique_a)
1894
new_b, killed_a = self._determine_status(self.b_rev, unique_b)
1895
return self._iter_plan(blocks, new_a, killed_b, new_b, killed_a)
1897
def _iter_plan(self, blocks, new_a, killed_b, new_b, killed_a):
1900
for i, j, n in blocks:
1901
for a_index in range(last_i, i):
1902
if a_index in new_a:
1903
if a_index in killed_b:
1904
yield 'conflicted-a', self.lines_a[a_index]
1906
yield 'new-a', self.lines_a[a_index]
1908
yield 'killed-b', self.lines_a[a_index]
1909
for b_index in range(last_j, j):
1910
if b_index in new_b:
1911
if b_index in killed_a:
1912
yield 'conflicted-b', self.lines_b[b_index]
1914
yield 'new-b', self.lines_b[b_index]
1916
yield 'killed-a', self.lines_b[b_index]
1917
# handle common lines
1918
for a_index in range(i, i+n):
1919
yield 'unchanged', self.lines_a[a_index]
1923
def _get_matching_blocks(self, left_revision, right_revision):
1924
"""Return a description of which sections of two revisions match.
1926
See SequenceMatcher.get_matching_blocks
1928
cached = self._cached_matching_blocks.get((left_revision,
1930
if cached is not None:
1932
if self._last_lines_revision_id == left_revision:
1933
left_lines = self._last_lines
1934
right_lines = self.get_lines([right_revision])[right_revision]
1936
lines = self.get_lines([left_revision, right_revision])
1937
left_lines = lines[left_revision]
1938
right_lines = lines[right_revision]
1939
self._last_lines = right_lines
1940
self._last_lines_revision_id = right_revision
1941
matcher = patiencediff.PatienceSequenceMatcher(None, left_lines,
1943
return matcher.get_matching_blocks()
1945
def _unique_lines(self, matching_blocks):
1946
"""Analyse matching_blocks to determine which lines are unique
1948
:return: a tuple of (unique_left, unique_right), where the values are
1949
sets of line numbers of unique lines.
1955
for i, j, n in matching_blocks:
1956
unique_left.extend(range(last_i, i))
1957
unique_right.extend(range(last_j, j))
1960
return unique_left, unique_right
1963
def _subtract_plans(old_plan, new_plan):
1964
"""Remove changes from new_plan that came from old_plan.
1966
It is assumed that the difference between the old_plan and new_plan
1967
is their choice of 'b' text.
1969
All lines from new_plan that differ from old_plan are emitted
1970
verbatim. All lines from new_plan that match old_plan but are
1971
not about the 'b' revision are emitted verbatim.
1973
Lines that match and are about the 'b' revision are the lines we
1974
don't want, so we convert 'killed-b' -> 'unchanged', and 'new-b'
1975
is skipped entirely.
1977
matcher = patiencediff.PatienceSequenceMatcher(None, old_plan,
1980
for i, j, n in matcher.get_matching_blocks():
1981
for jj in range(last_j, j):
1983
for jj in range(j, j+n):
1984
plan_line = new_plan[jj]
1985
if plan_line[0] == 'new-b':
1987
elif plan_line[0] == 'killed-b':
1988
yield 'unchanged', plan_line[1]
1994
class _PlanMerge(_PlanMergeBase):
1995
"""Plan an annotate merge using on-the-fly annotation"""
1997
def __init__(self, a_rev, b_rev, vf, key_prefix):
1998
super(_PlanMerge, self).__init__(a_rev, b_rev, vf, key_prefix)
1999
self.a_key = self._key_prefix + (self.a_rev,)
2000
self.b_key = self._key_prefix + (self.b_rev,)
2001
self.graph = _mod_graph.Graph(self.vf)
2002
heads = self.graph.heads((self.a_key, self.b_key))
2004
# one side dominates, so we can just return its values, yay for
2006
# Ideally we would know that before we get this far
2007
self._head_key = heads.pop()
2008
if self._head_key == self.a_key:
2012
trace.mutter('found dominating revision for %s\n%s > %s', self.vf,
2013
self._head_key[-1], other)
2016
self._head_key = None
2019
def _precache_tip_lines(self):
2020
# Turn this into a no-op, because we will do this later
2023
def _find_recursive_lcas(self):
2024
"""Find all the ancestors back to a unique lca"""
2025
cur_ancestors = (self.a_key, self.b_key)
2026
# graph.find_lca(uncommon, keys) now returns plain NULL_REVISION,
2027
# rather than a key tuple. We will just map that directly to no common
2031
next_lcas = self.graph.find_lca(*cur_ancestors)
2032
# Map a plain NULL_REVISION to a simple no-ancestors
2033
if next_lcas == set([_mod_revision.NULL_REVISION]):
2035
# Order the lca's based on when they were merged into the tip
2036
# While the actual merge portion of weave merge uses a set() of
2037
# active revisions, the order of insertion *does* effect the
2038
# implicit ordering of the texts.
2039
for rev_key in cur_ancestors:
2040
ordered_parents = tuple(self.graph.find_merge_order(rev_key,
2042
parent_map[rev_key] = ordered_parents
2043
if len(next_lcas) == 0:
2045
elif len(next_lcas) == 1:
2046
parent_map[list(next_lcas)[0]] = ()
2048
elif len(next_lcas) > 2:
2049
# More than 2 lca's, fall back to grabbing all nodes between
2050
# this and the unique lca.
2051
trace.mutter('More than 2 LCAs, falling back to all nodes for:'
2053
self.a_key, self.b_key, cur_ancestors)
2054
cur_lcas = next_lcas
2055
while len(cur_lcas) > 1:
2056
cur_lcas = self.graph.find_lca(*cur_lcas)
2057
if len(cur_lcas) == 0:
2058
# No common base to find, use the full ancestry
2061
unique_lca = list(cur_lcas)[0]
2062
if unique_lca == _mod_revision.NULL_REVISION:
2063
# find_lca will return a plain 'NULL_REVISION' rather
2064
# than a key tuple when there is no common ancestor, we
2065
# prefer to just use None, because it doesn't confuse
2066
# _get_interesting_texts()
2068
parent_map.update(self._find_unique_parents(next_lcas,
2071
cur_ancestors = next_lcas
2074
def _find_unique_parents(self, tip_keys, base_key):
2075
"""Find ancestors of tip that aren't ancestors of base.
2077
:param tip_keys: Nodes that are interesting
2078
:param base_key: Cull all ancestors of this node
2079
:return: The parent map for all revisions between tip_keys and
2080
base_key. base_key will be included. References to nodes outside of
2081
the ancestor set will also be removed.
2083
# TODO: this would be simpler if find_unique_ancestors took a list
2084
# instead of a single tip, internally it supports it, but it
2085
# isn't a "backwards compatible" api change.
2086
if base_key is None:
2087
parent_map = dict(self.graph.iter_ancestry(tip_keys))
2088
# We remove NULL_REVISION because it isn't a proper tuple key, and
2089
# thus confuses things like _get_interesting_texts, and our logic
2090
# to add the texts into the memory weave.
2091
if _mod_revision.NULL_REVISION in parent_map:
2092
parent_map.pop(_mod_revision.NULL_REVISION)
2095
for tip in tip_keys:
2097
self.graph.find_unique_ancestors(tip, [base_key]))
2098
parent_map = self.graph.get_parent_map(interesting)
2099
parent_map[base_key] = ()
2100
culled_parent_map, child_map, tails = self._remove_external_references(
2102
# Remove all the tails but base_key
2103
if base_key is not None:
2104
tails.remove(base_key)
2105
self._prune_tails(culled_parent_map, child_map, tails)
2106
# Now remove all the uninteresting 'linear' regions
2107
simple_map = _mod_graph.collapse_linear_regions(culled_parent_map)
2111
def _remove_external_references(parent_map):
2112
"""Remove references that go outside of the parent map.
2114
:param parent_map: Something returned from Graph.get_parent_map(keys)
2115
:return: (filtered_parent_map, child_map, tails)
2116
filtered_parent_map is parent_map without external references
2117
child_map is the {parent_key: [child_keys]} mapping
2118
tails is a list of nodes that do not have any parents in the map
2120
# TODO: The basic effect of this function seems more generic than
2121
# _PlanMerge. But the specific details of building a child_map,
2122
# and computing tails seems very specific to _PlanMerge.
2123
# Still, should this be in Graph land?
2124
filtered_parent_map = {}
2127
for key, parent_keys in parent_map.iteritems():
2128
culled_parent_keys = [p for p in parent_keys if p in parent_map]
2129
if not culled_parent_keys:
2131
for parent_key in culled_parent_keys:
2132
child_map.setdefault(parent_key, []).append(key)
2133
# TODO: Do we want to do this, it adds overhead for every node,
2134
# just to say that the node has no children
2135
child_map.setdefault(key, [])
2136
filtered_parent_map[key] = culled_parent_keys
2137
return filtered_parent_map, child_map, tails
2140
def _prune_tails(parent_map, child_map, tails_to_remove):
2141
"""Remove tails from the parent map.
2143
This will remove the supplied revisions until no more children have 0
2146
:param parent_map: A dict of {child: [parents]}, this dictionary will
2147
be modified in place.
2148
:param tails_to_remove: A list of tips that should be removed,
2149
this list will be consumed
2150
:param child_map: The reverse dict of parent_map ({parent: [children]})
2151
this dict will be modified
2152
:return: None, parent_map will be modified in place.
2154
while tails_to_remove:
2155
next = tails_to_remove.pop()
2156
parent_map.pop(next)
2157
children = child_map.pop(next)
2158
for child in children:
2159
child_parents = parent_map[child]
2160
child_parents.remove(next)
2161
if len(child_parents) == 0:
2162
tails_to_remove.append(child)
2164
def _get_interesting_texts(self, parent_map):
2165
"""Return a dict of texts we are interested in.
2167
Note that the input is in key tuples, but the output is in plain
2170
:param parent_map: The output from _find_recursive_lcas
2171
:return: A dict of {'revision_id':lines} as returned by
2172
_PlanMergeBase.get_lines()
2174
all_revision_keys = set(parent_map)
2175
all_revision_keys.add(self.a_key)
2176
all_revision_keys.add(self.b_key)
2178
# Everything else is in 'keys' but get_lines is in 'revision_ids'
2179
all_texts = self.get_lines([k[-1] for k in all_revision_keys])
2182
def _build_weave(self):
2183
from bzrlib import weave
2184
self._weave = weave.Weave(weave_name='in_memory_weave',
2185
allow_reserved=True)
2186
parent_map = self._find_recursive_lcas()
2188
all_texts = self._get_interesting_texts(parent_map)
2190
# Note: Unfortunately, the order given by topo_sort will effect the
2191
# ordering resolution in the output. Specifically, if you add A then B,
2192
# then in the output text A lines will show up before B lines. And, of
2193
# course, topo_sort doesn't guarantee any real ordering.
2194
# So we use merge_sort, and add a fake node on the tip.
2195
# This ensures that left-hand parents will always be inserted into the
2196
# weave before right-hand parents.
2197
tip_key = self._key_prefix + (_mod_revision.CURRENT_REVISION,)
2198
parent_map[tip_key] = (self.a_key, self.b_key)
2200
for seq_num, key, depth, eom in reversed(tsort.merge_sort(parent_map,
2204
# for key in tsort.topo_sort(parent_map):
2205
parent_keys = parent_map[key]
2206
revision_id = key[-1]
2207
parent_ids = [k[-1] for k in parent_keys]
2208
self._weave.add_lines(revision_id, parent_ids,
2209
all_texts[revision_id])
2211
def plan_merge(self):
2212
"""Generate a 'plan' for merging the two revisions.
2214
This involves comparing their texts and determining the cause of
2215
differences. If text A has a line and text B does not, then either the
2216
line was added to text A, or it was deleted from B. Once the causes
2217
are combined, they are written out in the format described in
2218
VersionedFile.plan_merge
2220
if self._head_key is not None: # There was a single head
2221
if self._head_key == self.a_key:
2224
if self._head_key != self.b_key:
2225
raise AssertionError('There was an invalid head: %s != %s'
2226
% (self.b_key, self._head_key))
2228
head_rev = self._head_key[-1]
2229
lines = self.get_lines([head_rev])[head_rev]
2230
return ((plan, line) for line in lines)
2231
return self._weave.plan_merge(self.a_rev, self.b_rev)
2234
class _PlanLCAMerge(_PlanMergeBase):
2236
This merge algorithm differs from _PlanMerge in that:
2237
1. comparisons are done against LCAs only
2238
2. cases where a contested line is new versus one LCA but old versus
2239
another are marked as conflicts, by emitting the line as conflicted-a
2242
This is faster, and hopefully produces more useful output.
2245
def __init__(self, a_rev, b_rev, vf, key_prefix, graph):
2246
_PlanMergeBase.__init__(self, a_rev, b_rev, vf, key_prefix)
2247
lcas = graph.find_lca(key_prefix + (a_rev,), key_prefix + (b_rev,))
2250
if lca == _mod_revision.NULL_REVISION:
2253
self.lcas.add(lca[-1])
2254
for lca in self.lcas:
2255
if _mod_revision.is_null(lca):
2258
lca_lines = self.get_lines([lca])[lca]
2259
matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_a,
2261
blocks = list(matcher.get_matching_blocks())
2262
self._cached_matching_blocks[(a_rev, lca)] = blocks
2263
matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_b,
2265
blocks = list(matcher.get_matching_blocks())
2266
self._cached_matching_blocks[(b_rev, lca)] = blocks
2268
def _determine_status(self, revision_id, unique_line_numbers):
2269
"""Determines the status unique lines versus all lcas.
2271
Basically, determines why the line is unique to this revision.
2273
A line may be determined new, killed, or both.
2275
If a line is determined new, that means it was not present in at least
2276
one LCA, and is not present in the other merge revision.
2278
If a line is determined killed, that means the line was present in
2281
If a line is killed and new, this indicates that the two merge
2282
revisions contain differing conflict resolutions.
2283
:param revision_id: The id of the revision in which the lines are
2285
:param unique_line_numbers: The line numbers of unique lines.
2286
:return a tuple of (new_this, killed_other):
2290
unique_line_numbers = set(unique_line_numbers)
2291
for lca in self.lcas:
2292
blocks = self._get_matching_blocks(revision_id, lca)
2293
unique_vs_lca, _ignored = self._unique_lines(blocks)
2294
new.update(unique_line_numbers.intersection(unique_vs_lca))
2295
killed.update(unique_line_numbers.difference(unique_vs_lca))
added
removed
bzrlib/merge.py
