1
# Copyright (C) 2005-2011 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,
24
conflicts as _mod_conflicts,
31
revision as _mod_revision,
47
from bzrlib.symbol_versioning import (
51
# TODO: Report back as changes are merged in
54
def transform_tree(from_tree, to_tree, interesting_ids=None):
55
from_tree.lock_tree_write()
56
operation = cleanup.OperationWithCleanups(merge_inner)
57
operation.add_cleanup(from_tree.unlock)
58
operation.run_simple(from_tree.branch, to_tree, from_tree,
59
ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
62
class MergeHooks(hooks.Hooks):
65
hooks.Hooks.__init__(self, "bzrlib.merge", "Merger.hooks")
66
self.add_hook('merge_file_content',
67
"Called with a bzrlib.merge.Merger object to create a per file "
68
"merge object when starting a merge. "
69
"Should return either None or a subclass of "
70
"``bzrlib.merge.AbstractPerFileMerger``. "
71
"Such objects will then be called per file "
72
"that needs to be merged (including when one "
73
"side has deleted the file and the other has changed it). "
74
"See the AbstractPerFileMerger API docs for details on how it is "
79
class AbstractPerFileMerger(object):
80
"""PerFileMerger objects are used by plugins extending merge for bzrlib.
82
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
84
:ivar merger: The Merge3Merger performing the merge.
87
def __init__(self, merger):
88
"""Create a PerFileMerger for use with merger."""
91
def merge_contents(self, merge_params):
92
"""Attempt to merge the contents of a single file.
94
:param merge_params: A bzrlib.merge.MergeHookParams
95
:return: A tuple of (status, chunks), where status is one of
96
'not_applicable', 'success', 'conflicted', or 'delete'. If status
97
is 'success' or 'conflicted', then chunks should be an iterable of
98
strings for the new file contents.
100
return ('not applicable', None)
103
class PerFileMerger(AbstractPerFileMerger):
104
"""Merge individual files when self.file_matches returns True.
106
This class is intended to be subclassed. The file_matches and
107
merge_matching methods should be overridden with concrete implementations.
110
def file_matches(self, params):
111
"""Return True if merge_matching should be called on this file.
113
Only called with merges of plain files with no clear winner.
115
Subclasses must override this.
117
raise NotImplementedError(self.file_matches)
119
def get_filename(self, params, tree):
120
"""Lookup the filename (i.e. basename, not path), given a Tree (e.g.
121
self.merger.this_tree) and a MergeHookParams.
123
return osutils.basename(tree.id2path(params.file_id))
125
def get_filepath(self, params, tree):
126
"""Calculate the path to the file in a tree.
128
:param params: A MergeHookParams describing the file to merge
129
:param tree: a Tree, e.g. self.merger.this_tree.
131
return tree.id2path(params.file_id)
133
def merge_contents(self, params):
134
"""Merge the contents of a single file."""
135
# Check whether this custom merge logic should be used.
137
# OTHER is a straight winner, rely on default merge.
138
params.winner == 'other' or
139
# THIS and OTHER aren't both files.
140
not params.is_file_merge() or
141
# The filename doesn't match *.xml
142
not self.file_matches(params)):
143
return 'not_applicable', None
144
return self.merge_matching(params)
146
def merge_matching(self, params):
147
"""Merge the contents of a single file that has matched the criteria
148
in PerFileMerger.merge_contents (is a conflict, is a file,
149
self.file_matches is True).
151
Subclasses must override this.
153
raise NotImplementedError(self.merge_matching)
156
class ConfigurableFileMerger(PerFileMerger):
157
"""Merge individual files when configured via a .conf file.
159
This is a base class for concrete custom file merging logic. Concrete
160
classes should implement ``merge_text``.
162
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
164
:ivar affected_files: The configured file paths to merge.
166
:cvar name_prefix: The prefix to use when looking up configuration
167
details. <name_prefix>_merge_files describes the files targeted by the
170
:cvar default_files: The default file paths to merge when no configuration
177
def __init__(self, merger):
178
super(ConfigurableFileMerger, self).__init__(merger)
179
self.affected_files = None
180
self.default_files = self.__class__.default_files or []
181
self.name_prefix = self.__class__.name_prefix
182
if self.name_prefix is None:
183
raise ValueError("name_prefix must be set.")
185
def file_matches(self, params):
186
"""Check whether the file should call the merge hook.
188
<name_prefix>_merge_files configuration variable is a list of files
189
that should use the hook.
191
affected_files = self.affected_files
192
if affected_files is None:
193
config = self.merger.this_branch.get_config()
194
# Until bzr provides a better policy for caching the config, we
195
# just add the part we're interested in to the params to avoid
196
# reading the config files repeatedly (bazaar.conf, location.conf,
198
config_key = self.name_prefix + '_merge_files'
199
affected_files = config.get_user_option_as_list(config_key)
200
if affected_files is None:
201
# If nothing was specified in the config, use the default.
202
affected_files = self.default_files
203
self.affected_files = affected_files
205
filepath = self.get_filepath(params, self.merger.this_tree)
206
if filepath in affected_files:
210
def merge_matching(self, params):
211
return self.merge_text(params)
213
def merge_text(self, params):
214
"""Merge the byte contents of a single file.
216
This is called after checking that the merge should be performed in
217
merge_contents, and it should behave as per
218
``bzrlib.merge.AbstractPerFileMerger.merge_contents``.
220
raise NotImplementedError(self.merge_text)
223
class MergeHookParams(object):
224
"""Object holding parameters passed to merge_file_content hooks.
226
There are some fields hooks can access:
228
:ivar file_id: the file ID of the file being merged
229
:ivar trans_id: the transform ID for the merge of this file
230
:ivar this_kind: kind of file_id in 'this' tree
231
:ivar other_kind: kind of file_id in 'other' tree
232
:ivar winner: one of 'this', 'other', 'conflict'
235
def __init__(self, merger, file_id, trans_id, this_kind, other_kind,
237
self._merger = merger
238
self.file_id = file_id
239
self.trans_id = trans_id
240
self.this_kind = this_kind
241
self.other_kind = other_kind
244
def is_file_merge(self):
245
"""True if this_kind and other_kind are both 'file'."""
246
return self.this_kind == 'file' and self.other_kind == 'file'
248
@decorators.cachedproperty
249
def base_lines(self):
250
"""The lines of the 'base' version of the file."""
251
return self._merger.get_lines(self._merger.base_tree, self.file_id)
253
@decorators.cachedproperty
254
def this_lines(self):
255
"""The lines of the 'this' version of the file."""
256
return self._merger.get_lines(self._merger.this_tree, self.file_id)
258
@decorators.cachedproperty
259
def other_lines(self):
260
"""The lines of the 'other' version of the file."""
261
return self._merger.get_lines(self._merger.other_tree, self.file_id)
264
class Merger(object):
268
def __init__(self, this_branch, other_tree=None, base_tree=None,
269
this_tree=None, pb=None, change_reporter=None,
270
recurse='down', revision_graph=None):
271
object.__init__(self)
272
self.this_branch = this_branch
273
self.this_basis = _mod_revision.ensure_null(
274
this_branch.last_revision())
275
self.this_rev_id = None
276
self.this_tree = this_tree
277
self.this_revision_tree = None
278
self.this_basis_tree = None
279
self.other_tree = other_tree
280
self.other_branch = None
281
self.base_tree = base_tree
282
self.ignore_zero = False
283
self.backup_files = False
284
self.interesting_ids = None
285
self.interesting_files = None
286
self.show_base = False
287
self.reprocess = False
289
warnings.warn("pb parameter to Merger() is deprecated and ignored")
291
self.recurse = recurse
292
self.change_reporter = change_reporter
293
self._cached_trees = {}
294
self._revision_graph = revision_graph
295
self._base_is_ancestor = None
296
self._base_is_other_ancestor = None
297
self._is_criss_cross = None
298
self._lca_trees = None
300
def cache_trees_with_revision_ids(self, trees):
301
"""Cache any tree in trees if it has a revision_id."""
302
for maybe_tree in trees:
303
if maybe_tree is None:
306
rev_id = maybe_tree.get_revision_id()
307
except AttributeError:
309
self._cached_trees[rev_id] = maybe_tree
312
def revision_graph(self):
313
if self._revision_graph is None:
314
self._revision_graph = self.this_branch.repository.get_graph()
315
return self._revision_graph
317
def _set_base_is_ancestor(self, value):
318
self._base_is_ancestor = value
320
def _get_base_is_ancestor(self):
321
if self._base_is_ancestor is None:
322
self._base_is_ancestor = self.revision_graph.is_ancestor(
323
self.base_rev_id, self.this_basis)
324
return self._base_is_ancestor
326
base_is_ancestor = property(_get_base_is_ancestor, _set_base_is_ancestor)
328
def _set_base_is_other_ancestor(self, value):
329
self._base_is_other_ancestor = value
331
def _get_base_is_other_ancestor(self):
332
if self._base_is_other_ancestor is None:
333
if self.other_basis is None:
335
self._base_is_other_ancestor = self.revision_graph.is_ancestor(
336
self.base_rev_id, self.other_basis)
337
return self._base_is_other_ancestor
339
base_is_other_ancestor = property(_get_base_is_other_ancestor,
340
_set_base_is_other_ancestor)
343
def from_uncommitted(tree, other_tree, pb=None, base_tree=None):
344
"""Return a Merger for uncommitted changes in other_tree.
346
:param tree: The tree to merge into
347
:param other_tree: The tree to get uncommitted changes from
348
:param pb: A progress indicator
349
:param base_tree: The basis to use for the merge. If unspecified,
350
other_tree.basis_tree() will be used.
352
if base_tree is None:
353
base_tree = other_tree.basis_tree()
354
merger = Merger(tree.branch, other_tree, base_tree, tree, pb)
355
merger.base_rev_id = merger.base_tree.get_revision_id()
356
merger.other_rev_id = None
357
merger.other_basis = merger.base_rev_id
361
def from_mergeable(klass, tree, mergeable, pb):
362
"""Return a Merger for a bundle or merge directive.
364
:param tree: The tree to merge changes into
365
:param mergeable: A merge directive or bundle
366
:param pb: A progress indicator
368
mergeable.install_revisions(tree.branch.repository)
369
base_revision_id, other_revision_id, verified =\
370
mergeable.get_merge_request(tree.branch.repository)
371
revision_graph = tree.branch.repository.get_graph()
372
if base_revision_id is not None:
373
if (base_revision_id != _mod_revision.NULL_REVISION and
374
revision_graph.is_ancestor(
375
base_revision_id, tree.branch.last_revision())):
376
base_revision_id = None
378
trace.warning('Performing cherrypick')
379
merger = klass.from_revision_ids(pb, tree, other_revision_id,
380
base_revision_id, revision_graph=
382
return merger, verified
385
def from_revision_ids(pb, tree, other, base=None, other_branch=None,
386
base_branch=None, revision_graph=None,
388
"""Return a Merger for revision-ids.
390
:param pb: A progress indicator
391
:param tree: The tree to merge changes into
392
:param other: The revision-id to use as OTHER
393
:param base: The revision-id to use as BASE. If not specified, will
395
:param other_branch: A branch containing the other revision-id. If
396
not supplied, tree.branch is used.
397
:param base_branch: A branch containing the base revision-id. If
398
not supplied, other_branch or tree.branch will be used.
399
:param revision_graph: If you have a revision_graph precomputed, pass
400
it in, otherwise it will be created for you.
401
:param tree_branch: The branch associated with tree. If not supplied,
402
tree.branch will be used.
404
if tree_branch is None:
405
tree_branch = tree.branch
406
merger = Merger(tree_branch, this_tree=tree, pb=pb,
407
revision_graph=revision_graph)
408
if other_branch is None:
409
other_branch = tree.branch
410
merger.set_other_revision(other, other_branch)
414
if base_branch is None:
415
base_branch = other_branch
416
merger.set_base_revision(base, base_branch)
419
def revision_tree(self, revision_id, branch=None):
420
if revision_id not in self._cached_trees:
422
branch = self.this_branch
424
tree = self.this_tree.revision_tree(revision_id)
425
except errors.NoSuchRevisionInTree:
426
tree = branch.repository.revision_tree(revision_id)
427
self._cached_trees[revision_id] = tree
428
return self._cached_trees[revision_id]
430
def _get_tree(self, treespec, possible_transports=None):
431
location, revno = treespec
433
tree = workingtree.WorkingTree.open_containing(location)[0]
434
return tree.branch, tree
435
branch = _mod_branch.Branch.open_containing(
436
location, possible_transports)[0]
438
revision_id = branch.last_revision()
440
revision_id = branch.get_rev_id(revno)
441
revision_id = _mod_revision.ensure_null(revision_id)
442
return branch, self.revision_tree(revision_id, branch)
444
@deprecated_method(deprecated_in((2, 1, 0)))
445
def ensure_revision_trees(self):
446
if self.this_revision_tree is None:
447
self.this_basis_tree = self.revision_tree(self.this_basis)
448
if self.this_basis == self.this_rev_id:
449
self.this_revision_tree = self.this_basis_tree
451
if self.other_rev_id is None:
452
other_basis_tree = self.revision_tree(self.other_basis)
453
if other_basis_tree.has_changes(self.other_tree):
454
raise errors.WorkingTreeNotRevision(self.this_tree)
455
other_rev_id = self.other_basis
456
self.other_tree = other_basis_tree
458
@deprecated_method(deprecated_in((2, 1, 0)))
459
def file_revisions(self, file_id):
460
self.ensure_revision_trees()
461
if self.this_rev_id is None:
462
if self.this_basis_tree.get_file_sha1(file_id) != \
463
self.this_tree.get_file_sha1(file_id):
464
raise errors.WorkingTreeNotRevision(self.this_tree)
466
trees = (self.this_basis_tree, self.other_tree)
467
return [tree.get_file_revision(file_id) for tree in trees]
469
@deprecated_method(deprecated_in((2, 1, 0)))
470
def check_basis(self, check_clean, require_commits=True):
471
if self.this_basis is None and require_commits is True:
472
raise errors.BzrCommandError(
473
"This branch has no commits."
474
" (perhaps you would prefer 'bzr pull')")
477
if self.this_basis != self.this_rev_id:
478
raise errors.UncommittedChanges(self.this_tree)
480
@deprecated_method(deprecated_in((2, 1, 0)))
481
def compare_basis(self):
483
basis_tree = self.revision_tree(self.this_tree.last_revision())
484
except errors.NoSuchRevision:
485
basis_tree = self.this_tree.basis_tree()
486
if not self.this_tree.has_changes(basis_tree):
487
self.this_rev_id = self.this_basis
489
def set_interesting_files(self, file_list):
490
self.interesting_files = file_list
492
def set_pending(self):
493
if (not self.base_is_ancestor or not self.base_is_other_ancestor
494
or self.other_rev_id is None):
498
def _add_parent(self):
499
new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
500
new_parent_trees = []
501
operation = cleanup.OperationWithCleanups(
502
self.this_tree.set_parent_trees)
503
for revision_id in new_parents:
505
tree = self.revision_tree(revision_id)
506
except errors.NoSuchRevision:
510
operation.add_cleanup(tree.unlock)
511
new_parent_trees.append((revision_id, tree))
512
operation.run_simple(new_parent_trees, allow_leftmost_as_ghost=True)
514
def set_other(self, other_revision, possible_transports=None):
515
"""Set the revision and tree to merge from.
517
This sets the other_tree, other_rev_id, other_basis attributes.
519
:param other_revision: The [path, revision] list to merge from.
521
self.other_branch, self.other_tree = self._get_tree(other_revision,
523
if other_revision[1] == -1:
524
self.other_rev_id = _mod_revision.ensure_null(
525
self.other_branch.last_revision())
526
if _mod_revision.is_null(self.other_rev_id):
527
raise errors.NoCommits(self.other_branch)
528
self.other_basis = self.other_rev_id
529
elif other_revision[1] is not None:
530
self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
531
self.other_basis = self.other_rev_id
533
self.other_rev_id = None
534
self.other_basis = self.other_branch.last_revision()
535
if self.other_basis is None:
536
raise errors.NoCommits(self.other_branch)
537
if self.other_rev_id is not None:
538
self._cached_trees[self.other_rev_id] = self.other_tree
539
self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
541
def set_other_revision(self, revision_id, other_branch):
542
"""Set 'other' based on a branch and revision id
544
:param revision_id: The revision to use for a tree
545
:param other_branch: The branch containing this tree
547
self.other_rev_id = revision_id
548
self.other_branch = other_branch
549
self._maybe_fetch(other_branch, self.this_branch, self.other_rev_id)
550
self.other_tree = self.revision_tree(revision_id)
551
self.other_basis = revision_id
553
def set_base_revision(self, revision_id, branch):
554
"""Set 'base' based on a branch and revision id
556
:param revision_id: The revision to use for a tree
557
:param branch: The branch containing this tree
559
self.base_rev_id = revision_id
560
self.base_branch = branch
561
self._maybe_fetch(branch, self.this_branch, revision_id)
562
self.base_tree = self.revision_tree(revision_id)
564
def _maybe_fetch(self, source, target, revision_id):
565
if not source.repository.has_same_location(target.repository):
566
target.fetch(source, revision_id)
569
revisions = [_mod_revision.ensure_null(self.this_basis),
570
_mod_revision.ensure_null(self.other_basis)]
571
if _mod_revision.NULL_REVISION in revisions:
572
self.base_rev_id = _mod_revision.NULL_REVISION
573
self.base_tree = self.revision_tree(self.base_rev_id)
574
self._is_criss_cross = False
576
lcas = self.revision_graph.find_lca(revisions[0], revisions[1])
577
self._is_criss_cross = False
579
self.base_rev_id = _mod_revision.NULL_REVISION
581
self.base_rev_id = list(lcas)[0]
582
else: # len(lcas) > 1
583
self._is_criss_cross = True
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
sorted_lca_keys = self.revision_graph.find_merge_order(
596
if self.base_rev_id == _mod_revision.NULL_REVISION:
597
self.base_rev_id = sorted_lca_keys[0]
599
if self.base_rev_id == _mod_revision.NULL_REVISION:
600
raise errors.UnrelatedBranches()
601
if self._is_criss_cross:
602
trace.warning('Warning: criss-cross merge encountered. See bzr'
603
' help criss-cross.')
604
trace.mutter('Criss-cross lcas: %r' % lcas)
605
if self.base_rev_id in lcas:
606
trace.mutter('Unable to find unique lca. '
607
'Fallback %r as best option.' % self.base_rev_id)
608
interesting_revision_ids = set(lcas)
609
interesting_revision_ids.add(self.base_rev_id)
610
interesting_trees = dict((t.get_revision_id(), t)
611
for t in self.this_branch.repository.revision_trees(
612
interesting_revision_ids))
613
self._cached_trees.update(interesting_trees)
614
if self.base_rev_id in lcas:
615
self.base_tree = interesting_trees[self.base_rev_id]
617
self.base_tree = interesting_trees.pop(self.base_rev_id)
618
self._lca_trees = [interesting_trees[key]
619
for key in sorted_lca_keys]
621
self.base_tree = self.revision_tree(self.base_rev_id)
622
self.base_is_ancestor = True
623
self.base_is_other_ancestor = True
624
trace.mutter('Base revid: %r' % self.base_rev_id)
626
def set_base(self, base_revision):
627
"""Set the base revision to use for the merge.
629
:param base_revision: A 2-list containing a path and revision number.
631
trace.mutter("doing merge() with no base_revision specified")
632
if base_revision == [None, None]:
635
base_branch, self.base_tree = self._get_tree(base_revision)
636
if base_revision[1] == -1:
637
self.base_rev_id = base_branch.last_revision()
638
elif base_revision[1] is None:
639
self.base_rev_id = _mod_revision.NULL_REVISION
641
self.base_rev_id = _mod_revision.ensure_null(
642
base_branch.get_rev_id(base_revision[1]))
643
self._maybe_fetch(base_branch, self.this_branch, self.base_rev_id)
645
def make_merger(self):
646
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
647
'other_tree': self.other_tree,
648
'interesting_ids': self.interesting_ids,
649
'interesting_files': self.interesting_files,
650
'this_branch': self.this_branch,
652
if self.merge_type.requires_base:
653
kwargs['base_tree'] = self.base_tree
654
if self.merge_type.supports_reprocess:
655
kwargs['reprocess'] = self.reprocess
657
raise errors.BzrError(
658
"Conflict reduction is not supported for merge"
659
" type %s." % self.merge_type)
660
if self.merge_type.supports_show_base:
661
kwargs['show_base'] = self.show_base
663
raise errors.BzrError("Showing base is not supported for this"
664
" merge type. %s" % self.merge_type)
665
if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
666
and not self.base_is_other_ancestor):
667
raise errors.CannotReverseCherrypick()
668
if self.merge_type.supports_cherrypick:
669
kwargs['cherrypick'] = (not self.base_is_ancestor or
670
not self.base_is_other_ancestor)
671
if self._is_criss_cross and getattr(self.merge_type,
672
'supports_lca_trees', False):
673
kwargs['lca_trees'] = self._lca_trees
674
return self.merge_type(pb=None,
675
change_reporter=self.change_reporter,
678
def _do_merge_to(self):
679
merge = self.make_merger()
680
if self.other_branch is not None:
681
self.other_branch.update_references(self.this_branch)
683
if self.recurse == 'down':
684
for relpath, file_id in self.this_tree.iter_references():
685
sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
686
other_revision = self.other_tree.get_reference_revision(
688
if other_revision == sub_tree.last_revision():
690
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
691
sub_merge.merge_type = self.merge_type
692
other_branch = self.other_branch.reference_parent(file_id, relpath)
693
sub_merge.set_other_revision(other_revision, other_branch)
694
base_revision = self.base_tree.get_reference_revision(file_id)
695
sub_merge.base_tree = \
696
sub_tree.branch.repository.revision_tree(base_revision)
697
sub_merge.base_rev_id = base_revision
702
operation = cleanup.OperationWithCleanups(self._do_merge_to)
703
self.this_tree.lock_tree_write()
704
operation.add_cleanup(self.this_tree.unlock)
705
if self.base_tree is not None:
706
self.base_tree.lock_read()
707
operation.add_cleanup(self.base_tree.unlock)
708
if self.other_tree is not None:
709
self.other_tree.lock_read()
710
operation.add_cleanup(self.other_tree.unlock)
711
merge = operation.run_simple()
712
if len(merge.cooked_conflicts) == 0:
713
if not self.ignore_zero and not trace.is_quiet():
714
trace.note("All changes applied successfully.")
716
trace.note("%d conflicts encountered."
717
% len(merge.cooked_conflicts))
719
return len(merge.cooked_conflicts)
722
class _InventoryNoneEntry(object):
723
"""This represents an inventory entry which *isn't there*.
725
It simplifies the merging logic if we always have an InventoryEntry, even
726
if it isn't actually present
733
symlink_target = None
736
_none_entry = _InventoryNoneEntry()
739
class Merge3Merger(object):
740
"""Three-way merger that uses the merge3 text merger"""
742
supports_reprocess = True
743
supports_show_base = True
744
history_based = False
745
supports_cherrypick = True
746
supports_reverse_cherrypick = True
747
winner_idx = {"this": 2, "other": 1, "conflict": 1}
748
supports_lca_trees = True
750
def __init__(self, working_tree, this_tree, base_tree, other_tree,
751
interesting_ids=None, reprocess=False, show_base=False,
752
pb=None, pp=None, change_reporter=None,
753
interesting_files=None, do_merge=True,
754
cherrypick=False, lca_trees=None, this_branch=None):
755
"""Initialize the merger object and perform the merge.
757
:param working_tree: The working tree to apply the merge to
758
:param this_tree: The local tree in the merge operation
759
:param base_tree: The common tree in the merge operation
760
:param other_tree: The other tree to merge changes from
761
:param this_branch: The branch associated with this_tree. Defaults to
762
this_tree.branch if not supplied.
763
:param interesting_ids: The file_ids of files that should be
764
participate in the merge. May not be combined with
766
:param: reprocess If True, perform conflict-reduction processing.
767
:param show_base: If True, show the base revision in text conflicts.
768
(incompatible with reprocess)
770
:param pp: A ProgressPhase object
771
:param change_reporter: An object that should report changes made
772
:param interesting_files: The tree-relative paths of files that should
773
participate in the merge. If these paths refer to directories,
774
the contents of those directories will also be included. May not
775
be combined with interesting_ids. If neither interesting_files nor
776
interesting_ids is specified, all files may participate in the
778
:param lca_trees: Can be set to a dictionary of {revision_id:rev_tree}
779
if the ancestry was found to include a criss-cross merge.
780
Otherwise should be None.
782
object.__init__(self)
783
if interesting_files is not None and interesting_ids is not None:
785
'specify either interesting_ids or interesting_files')
786
if this_branch is None:
787
this_branch = this_tree.branch
788
self.interesting_ids = interesting_ids
789
self.interesting_files = interesting_files
790
self.this_tree = working_tree
791
self.base_tree = base_tree
792
self.other_tree = other_tree
793
self.this_branch = this_branch
794
self._raw_conflicts = []
795
self.cooked_conflicts = []
796
self.reprocess = reprocess
797
self.show_base = show_base
798
self._lca_trees = lca_trees
799
# Uncommenting this will change the default algorithm to always use
800
# _entries_lca. This can be useful for running the test suite and
801
# making sure we haven't missed any corner cases.
802
# if lca_trees is None:
803
# self._lca_trees = [self.base_tree]
804
self.change_reporter = change_reporter
805
self.cherrypick = cherrypick
809
warnings.warn("pp argument to Merge3Merger is deprecated")
811
warnings.warn("pb argument to Merge3Merger is deprecated")
814
operation = cleanup.OperationWithCleanups(self._do_merge)
815
self.this_tree.lock_tree_write()
816
operation.add_cleanup(self.this_tree.unlock)
817
self.base_tree.lock_read()
818
operation.add_cleanup(self.base_tree.unlock)
819
self.other_tree.lock_read()
820
operation.add_cleanup(self.other_tree.unlock)
823
def _do_merge(self, operation):
824
self.tt = transform.TreeTransform(self.this_tree, None)
825
operation.add_cleanup(self.tt.finalize)
826
self._compute_transform()
827
results = self.tt.apply(no_conflicts=True)
828
self.write_modified(results)
830
self.this_tree.add_conflicts(self.cooked_conflicts)
831
except errors.UnsupportedOperation:
834
def make_preview_transform(self):
835
operation = cleanup.OperationWithCleanups(self._make_preview_transform)
836
self.base_tree.lock_read()
837
operation.add_cleanup(self.base_tree.unlock)
838
self.other_tree.lock_read()
839
operation.add_cleanup(self.other_tree.unlock)
840
return operation.run_simple()
842
def _make_preview_transform(self):
843
self.tt = transform.TransformPreview(self.this_tree)
844
self._compute_transform()
847
def _compute_transform(self):
848
if self._lca_trees is None:
849
entries = self._entries3()
850
resolver = self._three_way
852
entries = self._entries_lca()
853
resolver = self._lca_multi_way
854
child_pb = ui.ui_factory.nested_progress_bar()
856
factories = Merger.hooks['merge_file_content']
857
hooks = [factory(self) for factory in factories] + [self]
858
self.active_hooks = [hook for hook in hooks if hook is not None]
859
for num, (file_id, changed, parents3, names3,
860
executable3) in enumerate(entries):
861
child_pb.update('Preparing file merge', num, len(entries))
862
self._merge_names(file_id, parents3, names3, resolver=resolver)
864
file_status = self._do_merge_contents(file_id)
866
file_status = 'unmodified'
867
self._merge_executable(file_id,
868
executable3, file_status, resolver=resolver)
871
self.tt.fixup_new_roots()
872
self._finish_computing_transform()
874
def _finish_computing_transform(self):
875
"""Finalize the transform and report the changes.
877
This is the second half of _compute_transform.
879
child_pb = ui.ui_factory.nested_progress_bar()
881
fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
882
lambda t, c: transform.conflict_pass(t, c, self.other_tree))
885
if self.change_reporter is not None:
886
from bzrlib import delta
887
delta.report_changes(
888
self.tt.iter_changes(), self.change_reporter)
889
self.cook_conflicts(fs_conflicts)
890
for conflict in self.cooked_conflicts:
891
trace.warning(unicode(conflict))
894
"""Gather data about files modified between three trees.
896
Return a list of tuples of file_id, changed, parents3, names3,
897
executable3. changed is a boolean indicating whether the file contents
898
or kind were changed. parents3 is a tuple of parent ids for base,
899
other and this. names3 is a tuple of names for base, other and this.
900
executable3 is a tuple of execute-bit values for base, other and this.
903
iterator = self.other_tree.iter_changes(self.base_tree,
904
specific_files=self.interesting_files,
905
extra_trees=[self.this_tree])
906
this_entries = dict((e.file_id, e) for p, e in
907
self.this_tree.iter_entries_by_dir(
908
self.interesting_ids))
909
for (file_id, paths, changed, versioned, parents, names, kind,
910
executable) in iterator:
911
if (self.interesting_ids is not None and
912
file_id not in self.interesting_ids):
914
entry = this_entries.get(file_id)
915
if entry is not None:
916
this_name = entry.name
917
this_parent = entry.parent_id
918
this_executable = entry.executable
922
this_executable = None
923
parents3 = parents + (this_parent,)
924
names3 = names + (this_name,)
925
executable3 = executable + (this_executable,)
926
result.append((file_id, changed, parents3, names3, executable3))
929
def _entries_lca(self):
930
"""Gather data about files modified between multiple trees.
932
This compares OTHER versus all LCA trees, and for interesting entries,
933
it then compares with THIS and BASE.
935
For the multi-valued entries, the format will be (BASE, [lca1, lca2])
937
:return: [(file_id, changed, parents, names, executable)], where:
939
* file_id: Simple file_id of the entry
940
* changed: Boolean, True if the kind or contents changed else False
941
* parents: ((base, [parent_id, in, lcas]), parent_id_other,
943
* names: ((base, [name, in, lcas]), name_in_other, name_in_this)
944
* executable: ((base, [exec, in, lcas]), exec_in_other,
947
if self.interesting_files is not None:
948
lookup_trees = [self.this_tree, self.base_tree]
949
lookup_trees.extend(self._lca_trees)
950
# I think we should include the lca trees as well
951
interesting_ids = self.other_tree.paths2ids(self.interesting_files,
954
interesting_ids = self.interesting_ids
956
walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
958
base_inventory = self.base_tree.inventory
959
this_inventory = self.this_tree.inventory
960
for path, file_id, other_ie, lca_values in walker.iter_all():
961
# Is this modified at all from any of the other trees?
963
other_ie = _none_entry
964
if interesting_ids is not None and file_id not in interesting_ids:
967
# If other_revision is found in any of the lcas, that means this
968
# node is uninteresting. This is because when merging, if there are
969
# multiple heads(), we have to create a new node. So if we didn't,
970
# we know that the ancestry is linear, and that OTHER did not
972
# See doc/developers/lca_merge_resolution.txt for details
973
other_revision = other_ie.revision
974
if other_revision is not None:
975
# We can't use this shortcut when other_revision is None,
976
# because it may be None because things are WorkingTrees, and
977
# not because it is *actually* None.
978
is_unmodified = False
979
for lca_path, ie in lca_values:
980
if ie is not None and ie.revision == other_revision:
987
for lca_path, lca_ie in lca_values:
989
lca_entries.append(_none_entry)
991
lca_entries.append(lca_ie)
993
if base_inventory.has_id(file_id):
994
base_ie = base_inventory[file_id]
996
base_ie = _none_entry
998
if this_inventory.has_id(file_id):
999
this_ie = this_inventory[file_id]
1001
this_ie = _none_entry
1007
for lca_ie in lca_entries:
1008
lca_kinds.append(lca_ie.kind)
1009
lca_parent_ids.append(lca_ie.parent_id)
1010
lca_names.append(lca_ie.name)
1011
lca_executable.append(lca_ie.executable)
1013
kind_winner = self._lca_multi_way(
1014
(base_ie.kind, lca_kinds),
1015
other_ie.kind, this_ie.kind)
1016
parent_id_winner = self._lca_multi_way(
1017
(base_ie.parent_id, lca_parent_ids),
1018
other_ie.parent_id, this_ie.parent_id)
1019
name_winner = self._lca_multi_way(
1020
(base_ie.name, lca_names),
1021
other_ie.name, this_ie.name)
1023
content_changed = True
1024
if kind_winner == 'this':
1025
# No kind change in OTHER, see if there are *any* changes
1026
if other_ie.kind == 'directory':
1027
if parent_id_winner == 'this' and name_winner == 'this':
1028
# No change for this directory in OTHER, skip
1030
content_changed = False
1031
elif other_ie.kind is None or other_ie.kind == 'file':
1032
def get_sha1(ie, tree):
1033
if ie.kind != 'file':
1035
return tree.get_file_sha1(file_id)
1036
base_sha1 = get_sha1(base_ie, self.base_tree)
1037
lca_sha1s = [get_sha1(ie, tree) for ie, tree
1038
in zip(lca_entries, self._lca_trees)]
1039
this_sha1 = get_sha1(this_ie, self.this_tree)
1040
other_sha1 = get_sha1(other_ie, self.other_tree)
1041
sha1_winner = self._lca_multi_way(
1042
(base_sha1, lca_sha1s), other_sha1, this_sha1,
1043
allow_overriding_lca=False)
1044
exec_winner = self._lca_multi_way(
1045
(base_ie.executable, lca_executable),
1046
other_ie.executable, this_ie.executable)
1047
if (parent_id_winner == 'this' and name_winner == 'this'
1048
and sha1_winner == 'this' and exec_winner == 'this'):
1049
# No kind, parent, name, exec, or content change for
1050
# OTHER, so this node is not considered interesting
1052
if sha1_winner == 'this':
1053
content_changed = False
1054
elif other_ie.kind == 'symlink':
1055
def get_target(ie, tree):
1056
if ie.kind != 'symlink':
1058
return tree.get_symlink_target(file_id)
1059
base_target = get_target(base_ie, self.base_tree)
1060
lca_targets = [get_target(ie, tree) for ie, tree
1061
in zip(lca_entries, self._lca_trees)]
1062
this_target = get_target(this_ie, self.this_tree)
1063
other_target = get_target(other_ie, self.other_tree)
1064
target_winner = self._lca_multi_way(
1065
(base_target, lca_targets),
1066
other_target, this_target)
1067
if (parent_id_winner == 'this' and name_winner == 'this'
1068
and target_winner == 'this'):
1069
# No kind, parent, name, or symlink target change
1072
if target_winner == 'this':
1073
content_changed = False
1074
elif other_ie.kind == 'tree-reference':
1075
# The 'changed' information seems to be handled at a higher
1076
# level. At least, _entries3 returns False for content
1077
# changed, even when at a new revision_id.
1078
content_changed = False
1079
if (parent_id_winner == 'this' and name_winner == 'this'):
1080
# Nothing interesting
1083
raise AssertionError('unhandled kind: %s' % other_ie.kind)
1085
# If we have gotten this far, that means something has changed
1086
result.append((file_id, content_changed,
1087
((base_ie.parent_id, lca_parent_ids),
1088
other_ie.parent_id, this_ie.parent_id),
1089
((base_ie.name, lca_names),
1090
other_ie.name, this_ie.name),
1091
((base_ie.executable, lca_executable),
1092
other_ie.executable, this_ie.executable)
1096
@deprecated_method(deprecated_in((2, 4, 0)))
1098
if self.tt.final_kind(self.tt.root) is None:
1099
self.tt.cancel_deletion(self.tt.root)
1100
if self.tt.final_file_id(self.tt.root) is None:
1101
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
1103
other_root_file_id = self.other_tree.get_root_id()
1104
if other_root_file_id is None:
1106
other_root = self.tt.trans_id_file_id(other_root_file_id)
1107
if other_root == self.tt.root:
1109
if self.this_tree.inventory.has_id(
1110
self.other_tree.inventory.root.file_id):
1111
# the other tree's root is a non-root in the current tree (as
1112
# when a previously unrelated branch is merged into another)
1114
if self.tt.final_kind(other_root) is not None:
1115
other_root_is_present = True
1117
# other_root doesn't have a physical representation. We still need
1118
# to move any references to the actual root of the tree.
1119
other_root_is_present = False
1120
# 'other_tree.inventory.root' is not present in this tree. We are
1121
# calling adjust_path for children which *want* to be present with a
1122
# correct place to go.
1123
for _, child in self.other_tree.inventory.root.children.iteritems():
1124
trans_id = self.tt.trans_id_file_id(child.file_id)
1125
if not other_root_is_present:
1126
if self.tt.final_kind(trans_id) is not None:
1127
# The item exist in the final tree and has a defined place
1130
# Move the item into the root
1132
final_name = self.tt.final_name(trans_id)
1133
except errors.NoFinalPath:
1134
# This file is not present anymore, ignore it.
1136
self.tt.adjust_path(final_name, self.tt.root, trans_id)
1137
if other_root_is_present:
1138
self.tt.cancel_creation(other_root)
1139
self.tt.cancel_versioning(other_root)
1141
def write_modified(self, results):
1142
modified_hashes = {}
1143
for path in results.modified_paths:
1144
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
1147
hash = self.this_tree.get_file_sha1(file_id)
1150
modified_hashes[file_id] = hash
1151
self.this_tree.set_merge_modified(modified_hashes)
1154
def parent(entry, file_id):
1155
"""Determine the parent for a file_id (used as a key method)"""
1158
return entry.parent_id
1161
def name(entry, file_id):
1162
"""Determine the name for a file_id (used as a key method)"""
1168
def contents_sha1(tree, file_id):
1169
"""Determine the sha1 of the file contents (used as a key method)."""
1170
if not tree.has_id(file_id):
1172
return tree.get_file_sha1(file_id)
1175
def executable(tree, file_id):
1176
"""Determine the executability of a file-id (used as a key method)."""
1177
if not tree.has_id(file_id):
1179
if tree.kind(file_id) != "file":
1181
return tree.is_executable(file_id)
1184
def kind(tree, file_id):
1185
"""Determine the kind of a file-id (used as a key method)."""
1186
if not tree.has_id(file_id):
1188
return tree.kind(file_id)
1191
def _three_way(base, other, this):
1193
# if 'base == other', either they all agree, or only 'this' has
1196
elif this not in (base, other):
1197
# 'this' is neither 'base' nor 'other', so both sides changed
1200
# "Ambiguous clean merge" -- both sides have made the same change.
1203
# this == base: only other has changed.
1207
def _lca_multi_way(bases, other, this, allow_overriding_lca=True):
1208
"""Consider LCAs when determining whether a change has occurred.
1210
If LCAS are all identical, this is the same as a _three_way comparison.
1212
:param bases: value in (BASE, [LCAS])
1213
:param other: value in OTHER
1214
:param this: value in THIS
1215
:param allow_overriding_lca: If there is more than one unique lca
1216
value, allow OTHER to override THIS if it has a new value, and
1217
THIS only has an lca value, or vice versa. This is appropriate for
1218
truly scalar values, not as much for non-scalars.
1219
:return: 'this', 'other', or 'conflict' depending on whether an entry
1222
# See doc/developers/lca_tree_merging.txt for details about this
1225
# Either Ambiguously clean, or nothing was actually changed. We
1228
base_val, lca_vals = bases
1229
# Remove 'base_val' from the lca_vals, because it is not interesting
1230
filtered_lca_vals = [lca_val for lca_val in lca_vals
1231
if lca_val != base_val]
1232
if len(filtered_lca_vals) == 0:
1233
return Merge3Merger._three_way(base_val, other, this)
1235
unique_lca_vals = set(filtered_lca_vals)
1236
if len(unique_lca_vals) == 1:
1237
return Merge3Merger._three_way(unique_lca_vals.pop(), other, this)
1239
if allow_overriding_lca:
1240
if other in unique_lca_vals:
1241
if this in unique_lca_vals:
1242
# Each side picked a different lca, conflict
1245
# This has a value which supersedes both lca values, and
1246
# other only has an lca value
1248
elif this in unique_lca_vals:
1249
# OTHER has a value which supersedes both lca values, and this
1250
# only has an lca value
1253
# At this point, the lcas disagree, and the tip disagree
1257
@deprecated_method(deprecated_in((2, 2, 0)))
1258
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
1259
"""Do a three-way test on a scalar.
1260
Return "this", "other" or "conflict", depending whether a value wins.
1262
key_base = key(base_tree, file_id)
1263
key_other = key(other_tree, file_id)
1264
#if base == other, either they all agree, or only THIS has changed.
1265
if key_base == key_other:
1267
key_this = key(this_tree, file_id)
1268
# "Ambiguous clean merge"
1269
if key_this == key_other:
1271
elif key_this == key_base:
1276
def merge_names(self, file_id):
1277
def get_entry(tree):
1278
if tree.has_id(file_id):
1279
return tree.inventory[file_id]
1282
this_entry = get_entry(self.this_tree)
1283
other_entry = get_entry(self.other_tree)
1284
base_entry = get_entry(self.base_tree)
1285
entries = (base_entry, other_entry, this_entry)
1288
for entry in entries:
1291
parents.append(None)
1293
names.append(entry.name)
1294
parents.append(entry.parent_id)
1295
return self._merge_names(file_id, parents, names,
1296
resolver=self._three_way)
1298
def _merge_names(self, file_id, parents, names, resolver):
1299
"""Perform a merge on file_id names and parents"""
1300
base_name, other_name, this_name = names
1301
base_parent, other_parent, this_parent = parents
1303
name_winner = resolver(*names)
1305
parent_id_winner = resolver(*parents)
1306
if this_name is None:
1307
if name_winner == "this":
1308
name_winner = "other"
1309
if parent_id_winner == "this":
1310
parent_id_winner = "other"
1311
if name_winner == "this" and parent_id_winner == "this":
1313
if name_winner == 'conflict' or parent_id_winner == 'conflict':
1314
# Creating helpers (.OTHER or .THIS) here cause problems down the
1315
# road if a ContentConflict needs to be created so we should not do
1317
trans_id = self.tt.trans_id_file_id(file_id)
1318
self._raw_conflicts.append(('path conflict', trans_id, file_id,
1319
this_parent, this_name,
1320
other_parent, other_name))
1321
if not self.other_tree.has_id(file_id):
1322
# it doesn't matter whether the result was 'other' or
1323
# 'conflict'-- if it has no file id, we leave it alone.
1325
parent_id = parents[self.winner_idx[parent_id_winner]]
1326
name = names[self.winner_idx[name_winner]]
1327
if parent_id is not None or name is not None:
1328
# if we get here, name_winner and parent_winner are set to safe
1330
if parent_id is None and name is not None:
1331
# if parent_id is None and name is non-None, current file is
1333
if names[self.winner_idx[parent_id_winner]] != '':
1334
raise AssertionError(
1335
'File looks like a root, but named %s' %
1336
names[self.winner_idx[parent_id_winner]])
1337
parent_trans_id = transform.ROOT_PARENT
1339
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1340
self.tt.adjust_path(name, parent_trans_id,
1341
self.tt.trans_id_file_id(file_id))
1343
def _do_merge_contents(self, file_id):
1344
"""Performs a merge on file_id contents."""
1345
def contents_pair(tree):
1346
if not tree.has_id(file_id):
1348
kind = tree.kind(file_id)
1350
contents = tree.get_file_sha1(file_id)
1351
elif kind == "symlink":
1352
contents = tree.get_symlink_target(file_id)
1355
return kind, contents
1357
# See SPOT run. run, SPOT, run.
1358
# So we're not QUITE repeating ourselves; we do tricky things with
1360
base_pair = contents_pair(self.base_tree)
1361
other_pair = contents_pair(self.other_tree)
1363
this_pair = contents_pair(self.this_tree)
1364
lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1365
winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1366
this_pair, allow_overriding_lca=False)
1368
if base_pair == other_pair:
1371
# We delayed evaluating this_pair as long as we can to avoid
1372
# unnecessary sha1 calculation
1373
this_pair = contents_pair(self.this_tree)
1374
winner = self._three_way(base_pair, other_pair, this_pair)
1375
if winner == 'this':
1376
# No interesting changes introduced by OTHER
1378
# We have a hypothetical conflict, but if we have files, then we
1379
# can try to merge the content
1380
trans_id = self.tt.trans_id_file_id(file_id)
1381
params = MergeHookParams(self, file_id, trans_id, this_pair[0],
1382
other_pair[0], winner)
1383
hooks = self.active_hooks
1384
hook_status = 'not_applicable'
1386
hook_status, lines = hook.merge_contents(params)
1387
if hook_status != 'not_applicable':
1388
# Don't try any more hooks, this one applies.
1391
if hook_status == 'not_applicable':
1392
# This is a contents conflict, because none of the available
1393
# functions could merge it.
1395
name = self.tt.final_name(trans_id)
1396
parent_id = self.tt.final_parent(trans_id)
1397
if self.this_tree.has_id(file_id):
1398
self.tt.unversion_file(trans_id)
1399
file_group = self._dump_conflicts(name, parent_id, file_id,
1401
self._raw_conflicts.append(('contents conflict', file_group))
1402
elif hook_status == 'success':
1403
self.tt.create_file(lines, trans_id)
1404
elif hook_status == 'conflicted':
1405
# XXX: perhaps the hook should be able to provide
1406
# the BASE/THIS/OTHER files?
1407
self.tt.create_file(lines, trans_id)
1408
self._raw_conflicts.append(('text conflict', trans_id))
1409
name = self.tt.final_name(trans_id)
1410
parent_id = self.tt.final_parent(trans_id)
1411
self._dump_conflicts(name, parent_id, file_id)
1412
elif hook_status == 'delete':
1413
self.tt.unversion_file(trans_id)
1415
elif hook_status == 'done':
1416
# The hook function did whatever it needs to do directly, no
1417
# further action needed here.
1420
raise AssertionError('unknown hook_status: %r' % (hook_status,))
1421
if not self.this_tree.has_id(file_id) and result == "modified":
1422
self.tt.version_file(file_id, trans_id)
1423
# The merge has been performed, so the old contents should not be
1425
self.tt.delete_contents(trans_id)
1428
def _default_other_winner_merge(self, merge_hook_params):
1429
"""Replace this contents with other."""
1430
file_id = merge_hook_params.file_id
1431
trans_id = merge_hook_params.trans_id
1432
file_in_this = self.this_tree.has_id(file_id)
1433
if self.other_tree.has_id(file_id):
1434
# OTHER changed the file
1436
if wt.supports_content_filtering():
1437
# We get the path from the working tree if it exists.
1438
# That fails though when OTHER is adding a file, so
1439
# we fall back to the other tree to find the path if
1440
# it doesn't exist locally.
1442
filter_tree_path = wt.id2path(file_id)
1443
except errors.NoSuchId:
1444
filter_tree_path = self.other_tree.id2path(file_id)
1446
# Skip the id2path lookup for older formats
1447
filter_tree_path = None
1448
transform.create_from_tree(self.tt, trans_id,
1449
self.other_tree, file_id,
1450
filter_tree_path=filter_tree_path)
1453
# OTHER deleted the file
1454
return 'delete', None
1456
raise AssertionError(
1457
'winner is OTHER, but file_id %r not in THIS or OTHER tree'
1460
def merge_contents(self, merge_hook_params):
1461
"""Fallback merge logic after user installed hooks."""
1462
# This function is used in merge hooks as the fallback instance.
1463
# Perhaps making this function and the functions it calls be a
1464
# a separate class would be better.
1465
if merge_hook_params.winner == 'other':
1466
# OTHER is a straight winner, so replace this contents with other
1467
return self._default_other_winner_merge(merge_hook_params)
1468
elif merge_hook_params.is_file_merge():
1469
# THIS and OTHER are both files, so text merge. Either
1470
# BASE is a file, or both converted to files, so at least we
1471
# have agreement that output should be a file.
1473
self.text_merge(merge_hook_params.file_id,
1474
merge_hook_params.trans_id)
1475
except errors.BinaryFile:
1476
return 'not_applicable', None
1479
return 'not_applicable', None
1481
def get_lines(self, tree, file_id):
1482
"""Return the lines in a file, or an empty list."""
1483
if tree.has_id(file_id):
1484
return tree.get_file_lines(file_id)
1488
def text_merge(self, file_id, trans_id):
1489
"""Perform a three-way text merge on a file_id"""
1490
# it's possible that we got here with base as a different type.
1491
# if so, we just want two-way text conflicts.
1492
if self.base_tree.has_id(file_id) and \
1493
self.base_tree.kind(file_id) == "file":
1494
base_lines = self.get_lines(self.base_tree, file_id)
1497
other_lines = self.get_lines(self.other_tree, file_id)
1498
this_lines = self.get_lines(self.this_tree, file_id)
1499
m3 = merge3.Merge3(base_lines, this_lines, other_lines,
1500
is_cherrypick=self.cherrypick)
1501
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
1502
if self.show_base is True:
1503
base_marker = '|' * 7
1507
def iter_merge3(retval):
1508
retval["text_conflicts"] = False
1509
for line in m3.merge_lines(name_a = "TREE",
1510
name_b = "MERGE-SOURCE",
1511
name_base = "BASE-REVISION",
1512
start_marker=start_marker,
1513
base_marker=base_marker,
1514
reprocess=self.reprocess):
1515
if line.startswith(start_marker):
1516
retval["text_conflicts"] = True
1517
yield line.replace(start_marker, '<' * 7)
1521
merge3_iterator = iter_merge3(retval)
1522
self.tt.create_file(merge3_iterator, trans_id)
1523
if retval["text_conflicts"] is True:
1524
self._raw_conflicts.append(('text conflict', trans_id))
1525
name = self.tt.final_name(trans_id)
1526
parent_id = self.tt.final_parent(trans_id)
1527
file_group = self._dump_conflicts(name, parent_id, file_id,
1528
this_lines, base_lines,
1530
file_group.append(trans_id)
1532
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
1533
base_lines=None, other_lines=None, set_version=False,
1535
"""Emit conflict files.
1536
If this_lines, base_lines, or other_lines are omitted, they will be
1537
determined automatically. If set_version is true, the .OTHER, .THIS
1538
or .BASE (in that order) will be created as versioned files.
1540
data = [('OTHER', self.other_tree, other_lines),
1541
('THIS', self.this_tree, this_lines)]
1543
data.append(('BASE', self.base_tree, base_lines))
1545
# We need to use the actual path in the working tree of the file here,
1546
# ignoring the conflict suffixes
1548
if wt.supports_content_filtering():
1550
filter_tree_path = wt.id2path(file_id)
1551
except errors.NoSuchId:
1552
# file has been deleted
1553
filter_tree_path = None
1555
# Skip the id2path lookup for older formats
1556
filter_tree_path = None
1560
for suffix, tree, lines in data:
1561
if tree.has_id(file_id):
1562
trans_id = self._conflict_file(name, parent_id, tree, file_id,
1563
suffix, lines, filter_tree_path)
1564
file_group.append(trans_id)
1565
if set_version and not versioned:
1566
self.tt.version_file(file_id, trans_id)
1570
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1571
lines=None, filter_tree_path=None):
1572
"""Emit a single conflict file."""
1573
name = name + '.' + suffix
1574
trans_id = self.tt.create_path(name, parent_id)
1575
transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
1579
def merge_executable(self, file_id, file_status):
1580
"""Perform a merge on the execute bit."""
1581
executable = [self.executable(t, file_id) for t in (self.base_tree,
1582
self.other_tree, self.this_tree)]
1583
self._merge_executable(file_id, executable, file_status,
1584
resolver=self._three_way)
1586
def _merge_executable(self, file_id, executable, file_status,
1588
"""Perform a merge on the execute bit."""
1589
base_executable, other_executable, this_executable = executable
1590
if file_status == "deleted":
1592
winner = resolver(*executable)
1593
if winner == "conflict":
1594
# There must be a None in here, if we have a conflict, but we
1595
# need executability since file status was not deleted.
1596
if self.executable(self.other_tree, file_id) is None:
1600
if winner == 'this' and file_status != "modified":
1602
trans_id = self.tt.trans_id_file_id(file_id)
1603
if self.tt.final_kind(trans_id) != "file":
1605
if winner == "this":
1606
executability = this_executable
1608
if self.other_tree.has_id(file_id):
1609
executability = other_executable
1610
elif self.this_tree.has_id(file_id):
1611
executability = this_executable
1612
elif self.base_tree_has_id(file_id):
1613
executability = base_executable
1614
if executability is not None:
1615
trans_id = self.tt.trans_id_file_id(file_id)
1616
self.tt.set_executability(executability, trans_id)
1618
def cook_conflicts(self, fs_conflicts):
1619
"""Convert all conflicts into a form that doesn't depend on trans_id"""
1620
content_conflict_file_ids = set()
1621
cooked_conflicts = transform.cook_conflicts(fs_conflicts, self.tt)
1622
fp = transform.FinalPaths(self.tt)
1623
for conflict in self._raw_conflicts:
1624
conflict_type = conflict[0]
1625
if conflict_type == 'path conflict':
1627
this_parent, this_name,
1628
other_parent, other_name) = conflict[1:]
1629
if this_parent is None or this_name is None:
1630
this_path = '<deleted>'
1632
parent_path = fp.get_path(
1633
self.tt.trans_id_file_id(this_parent))
1634
this_path = osutils.pathjoin(parent_path, this_name)
1635
if other_parent is None or other_name is None:
1636
other_path = '<deleted>'
1638
if other_parent == self.other_tree.get_root_id():
1639
# The tree transform doesn't know about the other root,
1640
# so we special case here to avoid a NoFinalPath
1644
parent_path = fp.get_path(
1645
self.tt.trans_id_file_id(other_parent))
1646
other_path = osutils.pathjoin(parent_path, other_name)
1647
c = _mod_conflicts.Conflict.factory(
1648
'path conflict', path=this_path,
1649
conflict_path=other_path,
1651
elif conflict_type == 'contents conflict':
1652
for trans_id in conflict[1]:
1653
file_id = self.tt.final_file_id(trans_id)
1654
if file_id is not None:
1656
path = fp.get_path(trans_id)
1657
for suffix in ('.BASE', '.THIS', '.OTHER'):
1658
if path.endswith(suffix):
1659
path = path[:-len(suffix)]
1661
c = _mod_conflicts.Conflict.factory(conflict_type,
1662
path=path, file_id=file_id)
1663
content_conflict_file_ids.add(file_id)
1664
elif conflict_type == 'text conflict':
1665
trans_id = conflict[1]
1666
path = fp.get_path(trans_id)
1667
file_id = self.tt.final_file_id(trans_id)
1668
c = _mod_conflicts.Conflict.factory(conflict_type,
1669
path=path, file_id=file_id)
1671
raise AssertionError('bad conflict type: %r' % (conflict,))
1672
cooked_conflicts.append(c)
1674
self.cooked_conflicts = []
1675
# We want to get rid of path conflicts when a corresponding contents
1676
# conflict exists. This can occur when one branch deletes a file while
1677
# the other renames *and* modifies it. In this case, the content
1678
# conflict is enough.
1679
for c in cooked_conflicts:
1680
if (c.typestring == 'path conflict'
1681
and c.file_id in content_conflict_file_ids):
1683
self.cooked_conflicts.append(c)
1684
self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1687
class WeaveMerger(Merge3Merger):
1688
"""Three-way tree merger, text weave merger."""
1689
supports_reprocess = True
1690
supports_show_base = False
1691
supports_reverse_cherrypick = False
1692
history_based = True
1694
def _generate_merge_plan(self, file_id, base):
1695
return self.this_tree.plan_file_merge(file_id, self.other_tree,
1698
def _merged_lines(self, file_id):
1699
"""Generate the merged lines.
1700
There is no distinction between lines that are meant to contain <<<<<<<
1704
base = self.base_tree
1707
plan = self._generate_merge_plan(file_id, base)
1708
if 'merge' in debug.debug_flags:
1710
trans_id = self.tt.trans_id_file_id(file_id)
1711
name = self.tt.final_name(trans_id) + '.plan'
1712
contents = ('%11s|%s' % l for l in plan)
1713
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1714
textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1715
'>>>>>>> MERGE-SOURCE\n')
1716
lines, conflicts = textmerge.merge_lines(self.reprocess)
1718
base_lines = textmerge.base_from_plan()
1721
return lines, base_lines
1723
def text_merge(self, file_id, trans_id):
1724
"""Perform a (weave) text merge for a given file and file-id.
1725
If conflicts are encountered, .THIS and .OTHER files will be emitted,
1726
and a conflict will be noted.
1728
lines, base_lines = self._merged_lines(file_id)
1730
# Note we're checking whether the OUTPUT is binary in this case,
1731
# because we don't want to get into weave merge guts.
1732
textfile.check_text_lines(lines)
1733
self.tt.create_file(lines, trans_id)
1734
if base_lines is not None:
1736
self._raw_conflicts.append(('text conflict', trans_id))
1737
name = self.tt.final_name(trans_id)
1738
parent_id = self.tt.final_parent(trans_id)
1739
file_group = self._dump_conflicts(name, parent_id, file_id,
1741
base_lines=base_lines)
1742
file_group.append(trans_id)
1745
class LCAMerger(WeaveMerger):
1747
def _generate_merge_plan(self, file_id, base):
1748
return self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1751
class Diff3Merger(Merge3Merger):
1752
"""Three-way merger using external diff3 for text merging"""
1754
def dump_file(self, temp_dir, name, tree, file_id):
1755
out_path = osutils.pathjoin(temp_dir, name)
1756
out_file = open(out_path, "wb")
1758
in_file = tree.get_file(file_id)
1759
for line in in_file:
1760
out_file.write(line)
1765
def text_merge(self, file_id, trans_id):
1766
"""Perform a diff3 merge using a specified file-id and trans-id.
1767
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
1768
will be dumped, and a will be conflict noted.
1771
temp_dir = osutils.mkdtemp(prefix="bzr-")
1773
new_file = osutils.pathjoin(temp_dir, "new")
1774
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
1775
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
1776
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
1777
status = bzrlib.patch.diff3(new_file, this, base, other)
1778
if status not in (0, 1):
1779
raise errors.BzrError("Unhandled diff3 exit code")
1780
f = open(new_file, 'rb')
1782
self.tt.create_file(f, trans_id)
1786
name = self.tt.final_name(trans_id)
1787
parent_id = self.tt.final_parent(trans_id)
1788
self._dump_conflicts(name, parent_id, file_id)
1789
self._raw_conflicts.append(('text conflict', trans_id))
1791
osutils.rmtree(temp_dir)
1794
class PathNotInTree(errors.BzrError):
1796
_fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
1798
def __init__(self, path, tree):
1799
errors.BzrError.__init__(self, path=path, tree=tree)
1802
class MergeIntoMerger(Merger):
1803
"""Merger that understands other_tree will be merged into a subdir.
1805
This also changes the Merger api so that it uses real Branch, revision_id,
1806
and RevisonTree objects, rather than using revision specs.
1809
def __init__(self, this_tree, other_branch, other_tree, target_subdir,
1810
source_subpath, other_rev_id=None):
1811
"""Create a new MergeIntoMerger object.
1813
source_subpath in other_tree will be effectively copied to
1814
target_subdir in this_tree.
1816
:param this_tree: The tree that we will be merging into.
1817
:param other_branch: The Branch we will be merging from.
1818
:param other_tree: The RevisionTree object we want to merge.
1819
:param target_subdir: The relative path where we want to merge
1820
other_tree into this_tree
1821
:param source_subpath: The relative path specifying the subtree of
1822
other_tree to merge into this_tree.
1824
# It is assumed that we are merging a tree that is not in our current
1825
# ancestry, which means we are using the "EmptyTree" as our basis.
1826
null_ancestor_tree = this_tree.branch.repository.revision_tree(
1827
_mod_revision.NULL_REVISION)
1828
super(MergeIntoMerger, self).__init__(
1829
this_branch=this_tree.branch,
1830
this_tree=this_tree,
1831
other_tree=other_tree,
1832
base_tree=null_ancestor_tree,
1834
self._target_subdir = target_subdir
1835
self._source_subpath = source_subpath
1836
self.other_branch = other_branch
1837
if other_rev_id is None:
1838
other_rev_id = other_tree.get_revision_id()
1839
self.other_rev_id = self.other_basis = other_rev_id
1840
self.base_is_ancestor = True
1841
self.backup_files = True
1842
self.merge_type = Merge3Merger
1843
self.show_base = False
1844
self.reprocess = False
1845
self.interesting_ids = None
1846
self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
1847
target_subdir=self._target_subdir,
1848
source_subpath=self._source_subpath)
1849
if self._source_subpath != '':
1850
# If this isn't a partial merge make sure the revisions will be
1852
self._maybe_fetch(self.other_branch, self.this_branch,
1855
def set_pending(self):
1856
if self._source_subpath != '':
1858
Merger.set_pending(self)
1861
class _MergeTypeParameterizer(object):
1862
"""Wrap a merge-type class to provide extra parameters.
1864
This is hack used by MergeIntoMerger to pass some extra parameters to its
1865
merge_type. Merger.do_merge() sets up its own set of parameters to pass to
1866
the 'merge_type' member. It is difficult override do_merge without
1867
re-writing the whole thing, so instead we create a wrapper which will pass
1868
the extra parameters.
1871
def __init__(self, merge_type, **kwargs):
1872
self._extra_kwargs = kwargs
1873
self._merge_type = merge_type
1875
def __call__(self, *args, **kwargs):
1876
kwargs.update(self._extra_kwargs)
1877
return self._merge_type(*args, **kwargs)
1879
def __getattr__(self, name):
1880
return getattr(self._merge_type, name)
1883
class MergeIntoMergeType(Merge3Merger):
1884
"""Merger that incorporates a tree (or part of a tree) into another."""
1886
def __init__(self, *args, **kwargs):
1887
"""Initialize the merger object.
1889
:param args: See Merge3Merger.__init__'s args.
1890
:param kwargs: See Merge3Merger.__init__'s keyword args, except for
1891
source_subpath and target_subdir.
1892
:keyword source_subpath: The relative path specifying the subtree of
1893
other_tree to merge into this_tree.
1894
:keyword target_subdir: The relative path where we want to merge
1895
other_tree into this_tree
1897
# All of the interesting work happens during Merge3Merger.__init__(),
1898
# so we have have to hack in to get our extra parameters set.
1899
self._source_subpath = kwargs.pop('source_subpath')
1900
self._target_subdir = kwargs.pop('target_subdir')
1901
super(MergeIntoMergeType, self).__init__(*args, **kwargs)
1903
def _compute_transform(self):
1904
child_pb = ui.ui_factory.nested_progress_bar()
1906
entries = self._entries_to_incorporate()
1907
entries = list(entries)
1908
for num, (entry, parent_id) in enumerate(entries):
1909
child_pb.update('Preparing file merge', num, len(entries))
1910
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1911
trans_id = transform.new_by_entry(self.tt, entry,
1912
parent_trans_id, self.other_tree)
1915
self._finish_computing_transform()
1917
def _entries_to_incorporate(self):
1918
"""Yields pairs of (inventory_entry, new_parent)."""
1919
other_inv = self.other_tree.inventory
1920
subdir_id = other_inv.path2id(self._source_subpath)
1921
if subdir_id is None:
1922
# XXX: The error would be clearer if it gave the URL of the source
1923
# branch, but we don't have a reference to that here.
1924
raise PathNotInTree(self._source_subpath, "Source tree")
1925
subdir = other_inv[subdir_id]
1926
parent_in_target = osutils.dirname(self._target_subdir)
1927
target_id = self.this_tree.inventory.path2id(parent_in_target)
1928
if target_id is None:
1929
raise PathNotInTree(self._target_subdir, "Target tree")
1930
name_in_target = osutils.basename(self._target_subdir)
1931
merge_into_root = subdir.copy()
1932
merge_into_root.name = name_in_target
1933
if self.this_tree.inventory.has_id(merge_into_root.file_id):
1934
# Give the root a new file-id.
1935
# This can happen fairly easily if the directory we are
1936
# incorporating is the root, and both trees have 'TREE_ROOT' as
1937
# their root_id. Users will expect this to Just Work, so we
1938
# change the file-id here.
1939
# Non-root file-ids could potentially conflict too. That's really
1940
# an edge case, so we don't do anything special for those. We let
1941
# them cause conflicts.
1942
merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
1943
yield (merge_into_root, target_id)
1944
if subdir.kind != 'directory':
1945
# No children, so we are done.
1947
for ignored_path, entry in other_inv.iter_entries_by_dir(subdir_id):
1948
parent_id = entry.parent_id
1949
if parent_id == subdir.file_id:
1950
# The root's parent ID has changed, so make sure children of
1951
# the root refer to the new ID.
1952
parent_id = merge_into_root.file_id
1953
yield (entry, parent_id)
1956
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1958
merge_type=Merge3Merger,
1959
interesting_ids=None,
1963
interesting_files=None,
1966
change_reporter=None):
1967
"""Primary interface for merging.
1969
Typical use is probably::
1971
merge_inner(branch, branch.get_revision_tree(other_revision),
1972
branch.get_revision_tree(base_revision))
1974
if this_tree is None:
1975
raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
1977
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1978
pb=pb, change_reporter=change_reporter)
1979
merger.backup_files = backup_files
1980
merger.merge_type = merge_type
1981
merger.interesting_ids = interesting_ids
1982
merger.ignore_zero = ignore_zero
1983
if interesting_files:
1985
raise ValueError('Only supply interesting_ids'
1986
' or interesting_files')
1987
merger.interesting_files = interesting_files
1988
merger.show_base = show_base
1989
merger.reprocess = reprocess
1990
merger.other_rev_id = other_rev_id
1991
merger.other_basis = other_rev_id
1992
get_revision_id = getattr(base_tree, 'get_revision_id', None)
1993
if get_revision_id is None:
1994
get_revision_id = base_tree.last_revision
1995
merger.cache_trees_with_revision_ids([other_tree, base_tree, this_tree])
1996
merger.set_base_revision(get_revision_id(), this_branch)
1997
return merger.do_merge()
1999
def get_merge_type_registry():
2000
"""Merge type registry is in bzrlib.option to avoid circular imports.
2002
This method provides a sanctioned way to retrieve it.
2004
from bzrlib import option
2005
return option._merge_type_registry
2008
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
2009
def status_a(revision, text):
2010
if revision in ancestors_b:
2011
return 'killed-b', text
2013
return 'new-a', text
2015
def status_b(revision, text):
2016
if revision in ancestors_a:
2017
return 'killed-a', text
2019
return 'new-b', text
2021
plain_a = [t for (a, t) in annotated_a]
2022
plain_b = [t for (a, t) in annotated_b]
2023
matcher = patiencediff.PatienceSequenceMatcher(None, plain_a, plain_b)
2024
blocks = matcher.get_matching_blocks()
2027
for ai, bi, l in blocks:
2028
# process all mismatched sections
2029
# (last mismatched section is handled because blocks always
2030
# includes a 0-length last block)
2031
for revision, text in annotated_a[a_cur:ai]:
2032
yield status_a(revision, text)
2033
for revision, text in annotated_b[b_cur:bi]:
2034
yield status_b(revision, text)
2035
# and now the matched section
2038
for text_a in plain_a[ai:a_cur]:
2039
yield "unchanged", text_a
2042
class _PlanMergeBase(object):
2044
def __init__(self, a_rev, b_rev, vf, key_prefix):
2047
:param a_rev: Revision-id of one revision to merge
2048
:param b_rev: Revision-id of the other revision to merge
2049
:param vf: A VersionedFiles containing both revisions
2050
:param key_prefix: A prefix for accessing keys in vf, typically
2056
self._last_lines = None
2057
self._last_lines_revision_id = None
2058
self._cached_matching_blocks = {}
2059
self._key_prefix = key_prefix
2060
self._precache_tip_lines()
2062
def _precache_tip_lines(self):
2063
lines = self.get_lines([self.a_rev, self.b_rev])
2064
self.lines_a = lines[self.a_rev]
2065
self.lines_b = lines[self.b_rev]
2067
def get_lines(self, revisions):
2068
"""Get lines for revisions from the backing VersionedFiles.
2070
:raises RevisionNotPresent: on absent texts.
2072
keys = [(self._key_prefix + (rev,)) for rev in revisions]
2074
for record in self.vf.get_record_stream(keys, 'unordered', True):
2075
if record.storage_kind == 'absent':
2076
raise errors.RevisionNotPresent(record.key, self.vf)
2077
result[record.key[-1]] = osutils.chunks_to_lines(
2078
record.get_bytes_as('chunked'))
2081
def plan_merge(self):
2082
"""Generate a 'plan' for merging the two revisions.
2084
This involves comparing their texts and determining the cause of
2085
differences. If text A has a line and text B does not, then either the
2086
line was added to text A, or it was deleted from B. Once the causes
2087
are combined, they are written out in the format described in
2088
VersionedFile.plan_merge
2090
blocks = self._get_matching_blocks(self.a_rev, self.b_rev)
2091
unique_a, unique_b = self._unique_lines(blocks)
2092
new_a, killed_b = self._determine_status(self.a_rev, unique_a)
2093
new_b, killed_a = self._determine_status(self.b_rev, unique_b)
2094
return self._iter_plan(blocks, new_a, killed_b, new_b, killed_a)
2096
def _iter_plan(self, blocks, new_a, killed_b, new_b, killed_a):
2099
for i, j, n in blocks:
2100
for a_index in range(last_i, i):
2101
if a_index in new_a:
2102
if a_index in killed_b:
2103
yield 'conflicted-a', self.lines_a[a_index]
2105
yield 'new-a', self.lines_a[a_index]
2107
yield 'killed-b', self.lines_a[a_index]
2108
for b_index in range(last_j, j):
2109
if b_index in new_b:
2110
if b_index in killed_a:
2111
yield 'conflicted-b', self.lines_b[b_index]
2113
yield 'new-b', self.lines_b[b_index]
2115
yield 'killed-a', self.lines_b[b_index]
2116
# handle common lines
2117
for a_index in range(i, i+n):
2118
yield 'unchanged', self.lines_a[a_index]
2122
def _get_matching_blocks(self, left_revision, right_revision):
2123
"""Return a description of which sections of two revisions match.
2125
See SequenceMatcher.get_matching_blocks
2127
cached = self._cached_matching_blocks.get((left_revision,
2129
if cached is not None:
2131
if self._last_lines_revision_id == left_revision:
2132
left_lines = self._last_lines
2133
right_lines = self.get_lines([right_revision])[right_revision]
2135
lines = self.get_lines([left_revision, right_revision])
2136
left_lines = lines[left_revision]
2137
right_lines = lines[right_revision]
2138
self._last_lines = right_lines
2139
self._last_lines_revision_id = right_revision
2140
matcher = patiencediff.PatienceSequenceMatcher(None, left_lines,
2142
return matcher.get_matching_blocks()
2144
def _unique_lines(self, matching_blocks):
2145
"""Analyse matching_blocks to determine which lines are unique
2147
:return: a tuple of (unique_left, unique_right), where the values are
2148
sets of line numbers of unique lines.
2154
for i, j, n in matching_blocks:
2155
unique_left.extend(range(last_i, i))
2156
unique_right.extend(range(last_j, j))
2159
return unique_left, unique_right
2162
def _subtract_plans(old_plan, new_plan):
2163
"""Remove changes from new_plan that came from old_plan.
2165
It is assumed that the difference between the old_plan and new_plan
2166
is their choice of 'b' text.
2168
All lines from new_plan that differ from old_plan are emitted
2169
verbatim. All lines from new_plan that match old_plan but are
2170
not about the 'b' revision are emitted verbatim.
2172
Lines that match and are about the 'b' revision are the lines we
2173
don't want, so we convert 'killed-b' -> 'unchanged', and 'new-b'
2174
is skipped entirely.
2176
matcher = patiencediff.PatienceSequenceMatcher(None, old_plan,
2179
for i, j, n in matcher.get_matching_blocks():
2180
for jj in range(last_j, j):
2182
for jj in range(j, j+n):
2183
plan_line = new_plan[jj]
2184
if plan_line[0] == 'new-b':
2186
elif plan_line[0] == 'killed-b':
2187
yield 'unchanged', plan_line[1]
2193
class _PlanMerge(_PlanMergeBase):
2194
"""Plan an annotate merge using on-the-fly annotation"""
2196
def __init__(self, a_rev, b_rev, vf, key_prefix):
2197
super(_PlanMerge, self).__init__(a_rev, b_rev, vf, key_prefix)
2198
self.a_key = self._key_prefix + (self.a_rev,)
2199
self.b_key = self._key_prefix + (self.b_rev,)
2200
self.graph = _mod_graph.Graph(self.vf)
2201
heads = self.graph.heads((self.a_key, self.b_key))
2203
# one side dominates, so we can just return its values, yay for
2205
# Ideally we would know that before we get this far
2206
self._head_key = heads.pop()
2207
if self._head_key == self.a_key:
2211
trace.mutter('found dominating revision for %s\n%s > %s', self.vf,
2212
self._head_key[-1], other)
2215
self._head_key = None
2218
def _precache_tip_lines(self):
2219
# Turn this into a no-op, because we will do this later
2222
def _find_recursive_lcas(self):
2223
"""Find all the ancestors back to a unique lca"""
2224
cur_ancestors = (self.a_key, self.b_key)
2225
# graph.find_lca(uncommon, keys) now returns plain NULL_REVISION,
2226
# rather than a key tuple. We will just map that directly to no common
2230
next_lcas = self.graph.find_lca(*cur_ancestors)
2231
# Map a plain NULL_REVISION to a simple no-ancestors
2232
if next_lcas == set([_mod_revision.NULL_REVISION]):
2234
# Order the lca's based on when they were merged into the tip
2235
# While the actual merge portion of weave merge uses a set() of
2236
# active revisions, the order of insertion *does* effect the
2237
# implicit ordering of the texts.
2238
for rev_key in cur_ancestors:
2239
ordered_parents = tuple(self.graph.find_merge_order(rev_key,
2241
parent_map[rev_key] = ordered_parents
2242
if len(next_lcas) == 0:
2244
elif len(next_lcas) == 1:
2245
parent_map[list(next_lcas)[0]] = ()
2247
elif len(next_lcas) > 2:
2248
# More than 2 lca's, fall back to grabbing all nodes between
2249
# this and the unique lca.
2250
trace.mutter('More than 2 LCAs, falling back to all nodes for:'
2252
self.a_key, self.b_key, cur_ancestors)
2253
cur_lcas = next_lcas
2254
while len(cur_lcas) > 1:
2255
cur_lcas = self.graph.find_lca(*cur_lcas)
2256
if len(cur_lcas) == 0:
2257
# No common base to find, use the full ancestry
2260
unique_lca = list(cur_lcas)[0]
2261
if unique_lca == _mod_revision.NULL_REVISION:
2262
# find_lca will return a plain 'NULL_REVISION' rather
2263
# than a key tuple when there is no common ancestor, we
2264
# prefer to just use None, because it doesn't confuse
2265
# _get_interesting_texts()
2267
parent_map.update(self._find_unique_parents(next_lcas,
2270
cur_ancestors = next_lcas
2273
def _find_unique_parents(self, tip_keys, base_key):
2274
"""Find ancestors of tip that aren't ancestors of base.
2276
:param tip_keys: Nodes that are interesting
2277
:param base_key: Cull all ancestors of this node
2278
:return: The parent map for all revisions between tip_keys and
2279
base_key. base_key will be included. References to nodes outside of
2280
the ancestor set will also be removed.
2282
# TODO: this would be simpler if find_unique_ancestors took a list
2283
# instead of a single tip, internally it supports it, but it
2284
# isn't a "backwards compatible" api change.
2285
if base_key is None:
2286
parent_map = dict(self.graph.iter_ancestry(tip_keys))
2287
# We remove NULL_REVISION because it isn't a proper tuple key, and
2288
# thus confuses things like _get_interesting_texts, and our logic
2289
# to add the texts into the memory weave.
2290
if _mod_revision.NULL_REVISION in parent_map:
2291
parent_map.pop(_mod_revision.NULL_REVISION)
2294
for tip in tip_keys:
2296
self.graph.find_unique_ancestors(tip, [base_key]))
2297
parent_map = self.graph.get_parent_map(interesting)
2298
parent_map[base_key] = ()
2299
culled_parent_map, child_map, tails = self._remove_external_references(
2301
# Remove all the tails but base_key
2302
if base_key is not None:
2303
tails.remove(base_key)
2304
self._prune_tails(culled_parent_map, child_map, tails)
2305
# Now remove all the uninteresting 'linear' regions
2306
simple_map = _mod_graph.collapse_linear_regions(culled_parent_map)
2310
def _remove_external_references(parent_map):
2311
"""Remove references that go outside of the parent map.
2313
:param parent_map: Something returned from Graph.get_parent_map(keys)
2314
:return: (filtered_parent_map, child_map, tails)
2315
filtered_parent_map is parent_map without external references
2316
child_map is the {parent_key: [child_keys]} mapping
2317
tails is a list of nodes that do not have any parents in the map
2319
# TODO: The basic effect of this function seems more generic than
2320
# _PlanMerge. But the specific details of building a child_map,
2321
# and computing tails seems very specific to _PlanMerge.
2322
# Still, should this be in Graph land?
2323
filtered_parent_map = {}
2326
for key, parent_keys in parent_map.iteritems():
2327
culled_parent_keys = [p for p in parent_keys if p in parent_map]
2328
if not culled_parent_keys:
2330
for parent_key in culled_parent_keys:
2331
child_map.setdefault(parent_key, []).append(key)
2332
# TODO: Do we want to do this, it adds overhead for every node,
2333
# just to say that the node has no children
2334
child_map.setdefault(key, [])
2335
filtered_parent_map[key] = culled_parent_keys
2336
return filtered_parent_map, child_map, tails
2339
def _prune_tails(parent_map, child_map, tails_to_remove):
2340
"""Remove tails from the parent map.
2342
This will remove the supplied revisions until no more children have 0
2345
:param parent_map: A dict of {child: [parents]}, this dictionary will
2346
be modified in place.
2347
:param tails_to_remove: A list of tips that should be removed,
2348
this list will be consumed
2349
:param child_map: The reverse dict of parent_map ({parent: [children]})
2350
this dict will be modified
2351
:return: None, parent_map will be modified in place.
2353
while tails_to_remove:
2354
next = tails_to_remove.pop()
2355
parent_map.pop(next)
2356
children = child_map.pop(next)
2357
for child in children:
2358
child_parents = parent_map[child]
2359
child_parents.remove(next)
2360
if len(child_parents) == 0:
2361
tails_to_remove.append(child)
2363
def _get_interesting_texts(self, parent_map):
2364
"""Return a dict of texts we are interested in.
2366
Note that the input is in key tuples, but the output is in plain
2369
:param parent_map: The output from _find_recursive_lcas
2370
:return: A dict of {'revision_id':lines} as returned by
2371
_PlanMergeBase.get_lines()
2373
all_revision_keys = set(parent_map)
2374
all_revision_keys.add(self.a_key)
2375
all_revision_keys.add(self.b_key)
2377
# Everything else is in 'keys' but get_lines is in 'revision_ids'
2378
all_texts = self.get_lines([k[-1] for k in all_revision_keys])
2381
def _build_weave(self):
2382
from bzrlib import weave
2383
self._weave = weave.Weave(weave_name='in_memory_weave',
2384
allow_reserved=True)
2385
parent_map = self._find_recursive_lcas()
2387
all_texts = self._get_interesting_texts(parent_map)
2389
# Note: Unfortunately, the order given by topo_sort will effect the
2390
# ordering resolution in the output. Specifically, if you add A then B,
2391
# then in the output text A lines will show up before B lines. And, of
2392
# course, topo_sort doesn't guarantee any real ordering.
2393
# So we use merge_sort, and add a fake node on the tip.
2394
# This ensures that left-hand parents will always be inserted into the
2395
# weave before right-hand parents.
2396
tip_key = self._key_prefix + (_mod_revision.CURRENT_REVISION,)
2397
parent_map[tip_key] = (self.a_key, self.b_key)
2399
for seq_num, key, depth, eom in reversed(tsort.merge_sort(parent_map,
2403
# for key in tsort.topo_sort(parent_map):
2404
parent_keys = parent_map[key]
2405
revision_id = key[-1]
2406
parent_ids = [k[-1] for k in parent_keys]
2407
self._weave.add_lines(revision_id, parent_ids,
2408
all_texts[revision_id])
2410
def plan_merge(self):
2411
"""Generate a 'plan' for merging the two revisions.
2413
This involves comparing their texts and determining the cause of
2414
differences. If text A has a line and text B does not, then either the
2415
line was added to text A, or it was deleted from B. Once the causes
2416
are combined, they are written out in the format described in
2417
VersionedFile.plan_merge
2419
if self._head_key is not None: # There was a single head
2420
if self._head_key == self.a_key:
2423
if self._head_key != self.b_key:
2424
raise AssertionError('There was an invalid head: %s != %s'
2425
% (self.b_key, self._head_key))
2427
head_rev = self._head_key[-1]
2428
lines = self.get_lines([head_rev])[head_rev]
2429
return ((plan, line) for line in lines)
2430
return self._weave.plan_merge(self.a_rev, self.b_rev)
2433
class _PlanLCAMerge(_PlanMergeBase):
2435
This merge algorithm differs from _PlanMerge in that:
2437
1. comparisons are done against LCAs only
2438
2. cases where a contested line is new versus one LCA but old versus
2439
another are marked as conflicts, by emitting the line as conflicted-a
2442
This is faster, and hopefully produces more useful output.
2445
def __init__(self, a_rev, b_rev, vf, key_prefix, graph):
2446
_PlanMergeBase.__init__(self, a_rev, b_rev, vf, key_prefix)
2447
lcas = graph.find_lca(key_prefix + (a_rev,), key_prefix + (b_rev,))
2450
if lca == _mod_revision.NULL_REVISION:
2453
self.lcas.add(lca[-1])
2454
for lca in self.lcas:
2455
if _mod_revision.is_null(lca):
2458
lca_lines = self.get_lines([lca])[lca]
2459
matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_a,
2461
blocks = list(matcher.get_matching_blocks())
2462
self._cached_matching_blocks[(a_rev, lca)] = blocks
2463
matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_b,
2465
blocks = list(matcher.get_matching_blocks())
2466
self._cached_matching_blocks[(b_rev, lca)] = blocks
2468
def _determine_status(self, revision_id, unique_line_numbers):
2469
"""Determines the status unique lines versus all lcas.
2471
Basically, determines why the line is unique to this revision.
2473
A line may be determined new, killed, or both.
2475
If a line is determined new, that means it was not present in at least
2476
one LCA, and is not present in the other merge revision.
2478
If a line is determined killed, that means the line was present in
2481
If a line is killed and new, this indicates that the two merge
2482
revisions contain differing conflict resolutions.
2484
:param revision_id: The id of the revision in which the lines are
2486
:param unique_line_numbers: The line numbers of unique lines.
2487
:return: a tuple of (new_this, killed_other)
2491
unique_line_numbers = set(unique_line_numbers)
2492
for lca in self.lcas:
2493
blocks = self._get_matching_blocks(revision_id, lca)
2494
unique_vs_lca, _ignored = self._unique_lines(blocks)
2495
new.update(unique_line_numbers.intersection(unique_vs_lca))
2496
killed.update(unique_line_numbers.difference(unique_vs_lca))
added
removed
bzrlib/merge.py
