13
13
# You should have received a copy of the GNU General Public License
14
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
17
from __future__ import absolute_import
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
23
22
from bzrlib import (
24
branch as _mod_branch,
26
conflicts as _mod_conflicts,
33
28
revision as _mod_revision,
43
from bzrlib.i18n import gettext
51
from bzrlib.symbol_versioning import (
30
from bzrlib.branch import Branch
31
from bzrlib.conflicts import ConflictList, Conflict
32
from bzrlib.errors import (BzrCommandError,
42
WorkingTreeNotRevision,
45
from bzrlib.merge3 import Merge3
46
from bzrlib.osutils import rename, pathjoin
47
from progress import DummyProgress, ProgressPhase
48
from bzrlib.revision import (NULL_REVISION, ensure_null)
49
from bzrlib.textfile import check_text_lines
50
from bzrlib.trace import mutter, warning, note, is_quiet
51
from bzrlib.transform import (TransformPreview, TreeTransform,
52
resolve_conflicts, cook_conflicts,
53
conflict_pass, FinalPaths, create_by_entry,
54
unique_add, ROOT_PARENT)
55
from bzrlib.versionedfile import PlanWeaveMerge
55
58
# TODO: Report back as changes are merged in
58
61
def transform_tree(from_tree, to_tree, interesting_ids=None):
59
from_tree.lock_tree_write()
60
operation = cleanup.OperationWithCleanups(merge_inner)
61
operation.add_cleanup(from_tree.unlock)
62
operation.run_simple(from_tree.branch, to_tree, from_tree,
63
ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
66
class MergeHooks(hooks.Hooks):
69
hooks.Hooks.__init__(self, "bzrlib.merge", "Merger.hooks")
70
self.add_hook('merge_file_content',
71
"Called with a bzrlib.merge.Merger object to create a per file "
72
"merge object when starting a merge. "
73
"Should return either None or a subclass of "
74
"``bzrlib.merge.AbstractPerFileMerger``. "
75
"Such objects will then be called per file "
76
"that needs to be merged (including when one "
77
"side has deleted the file and the other has changed it). "
78
"See the AbstractPerFileMerger API docs for details on how it is "
81
self.add_hook('pre_merge',
82
'Called before a merge. '
83
'Receives a Merger object as the single argument.',
85
self.add_hook('post_merge',
86
'Called after a merge. '
87
'Receives a Merger object as the single argument. '
88
'The return value is ignored.',
92
class AbstractPerFileMerger(object):
93
"""PerFileMerger objects are used by plugins extending merge for bzrlib.
95
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
97
:ivar merger: The Merge3Merger performing the merge.
100
def __init__(self, merger):
101
"""Create a PerFileMerger for use with merger."""
104
def merge_contents(self, merge_params):
105
"""Attempt to merge the contents of a single file.
107
:param merge_params: A bzrlib.merge.MergeFileHookParams
108
:return: A tuple of (status, chunks), where status is one of
109
'not_applicable', 'success', 'conflicted', or 'delete'. If status
110
is 'success' or 'conflicted', then chunks should be an iterable of
111
strings for the new file contents.
113
return ('not applicable', None)
116
class PerFileMerger(AbstractPerFileMerger):
117
"""Merge individual files when self.file_matches returns True.
119
This class is intended to be subclassed. The file_matches and
120
merge_matching methods should be overridden with concrete implementations.
123
def file_matches(self, params):
124
"""Return True if merge_matching should be called on this file.
126
Only called with merges of plain files with no clear winner.
128
Subclasses must override this.
130
raise NotImplementedError(self.file_matches)
132
def get_filename(self, params, tree):
133
"""Lookup the filename (i.e. basename, not path), given a Tree (e.g.
134
self.merger.this_tree) and a MergeFileHookParams.
136
return osutils.basename(tree.id2path(params.file_id))
138
def get_filepath(self, params, tree):
139
"""Calculate the path to the file in a tree.
141
:param params: A MergeFileHookParams describing the file to merge
142
:param tree: a Tree, e.g. self.merger.this_tree.
144
return tree.id2path(params.file_id)
146
def merge_contents(self, params):
147
"""Merge the contents of a single file."""
148
# Check whether this custom merge logic should be used.
150
# OTHER is a straight winner, rely on default merge.
151
params.winner == 'other' or
152
# THIS and OTHER aren't both files.
153
not params.is_file_merge() or
154
# The filename doesn't match
155
not self.file_matches(params)):
156
return 'not_applicable', None
157
return self.merge_matching(params)
159
def merge_matching(self, params):
160
"""Merge the contents of a single file that has matched the criteria
161
in PerFileMerger.merge_contents (is a conflict, is a file,
162
self.file_matches is True).
164
Subclasses must override this.
166
raise NotImplementedError(self.merge_matching)
169
class ConfigurableFileMerger(PerFileMerger):
170
"""Merge individual files when configured via a .conf file.
172
This is a base class for concrete custom file merging logic. Concrete
173
classes should implement ``merge_text``.
175
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
177
:ivar affected_files: The configured file paths to merge.
179
:cvar name_prefix: The prefix to use when looking up configuration
180
details. <name_prefix>_merge_files describes the files targeted by the
183
:cvar default_files: The default file paths to merge when no configuration
190
def __init__(self, merger):
191
super(ConfigurableFileMerger, self).__init__(merger)
192
self.affected_files = None
193
self.default_files = self.__class__.default_files or []
194
self.name_prefix = self.__class__.name_prefix
195
if self.name_prefix is None:
196
raise ValueError("name_prefix must be set.")
198
def file_matches(self, params):
199
"""Check whether the file should call the merge hook.
201
<name_prefix>_merge_files configuration variable is a list of files
202
that should use the hook.
204
affected_files = self.affected_files
205
if affected_files is None:
206
config = self.merger.this_branch.get_config()
207
# Until bzr provides a better policy for caching the config, we
208
# just add the part we're interested in to the params to avoid
209
# reading the config files repeatedly (bazaar.conf, location.conf,
211
config_key = self.name_prefix + '_merge_files'
212
affected_files = config.get_user_option_as_list(config_key)
213
if affected_files is None:
214
# If nothing was specified in the config, use the default.
215
affected_files = self.default_files
216
self.affected_files = affected_files
218
filepath = self.get_filepath(params, self.merger.this_tree)
219
if filepath in affected_files:
223
def merge_matching(self, params):
224
return self.merge_text(params)
226
def merge_text(self, params):
227
"""Merge the byte contents of a single file.
229
This is called after checking that the merge should be performed in
230
merge_contents, and it should behave as per
231
``bzrlib.merge.AbstractPerFileMerger.merge_contents``.
233
raise NotImplementedError(self.merge_text)
236
class MergeFileHookParams(object):
237
"""Object holding parameters passed to merge_file_content hooks.
239
There are some fields hooks can access:
241
:ivar file_id: the file ID of the file being merged
242
:ivar trans_id: the transform ID for the merge of this file
243
:ivar this_kind: kind of file_id in 'this' tree
244
:ivar other_kind: kind of file_id in 'other' tree
245
:ivar winner: one of 'this', 'other', 'conflict'
248
def __init__(self, merger, file_id, trans_id, this_kind, other_kind,
250
self._merger = merger
251
self.file_id = file_id
252
self.trans_id = trans_id
253
self.this_kind = this_kind
254
self.other_kind = other_kind
257
def is_file_merge(self):
258
"""True if this_kind and other_kind are both 'file'."""
259
return self.this_kind == 'file' and self.other_kind == 'file'
261
@decorators.cachedproperty
262
def base_lines(self):
263
"""The lines of the 'base' version of the file."""
264
return self._merger.get_lines(self._merger.base_tree, self.file_id)
266
@decorators.cachedproperty
267
def this_lines(self):
268
"""The lines of the 'this' version of the file."""
269
return self._merger.get_lines(self._merger.this_tree, self.file_id)
271
@decorators.cachedproperty
272
def other_lines(self):
273
"""The lines of the 'other' version of the file."""
274
return self._merger.get_lines(self._merger.other_tree, self.file_id)
62
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
63
interesting_ids=interesting_ids, this_tree=from_tree)
277
66
class Merger(object):
281
67
def __init__(self, this_branch, other_tree=None, base_tree=None,
282
this_tree=None, pb=None, change_reporter=None,
68
this_tree=None, pb=DummyProgress(), change_reporter=None,
283
69
recurse='down', revision_graph=None):
284
70
object.__init__(self)
71
assert this_tree is not None, "this_tree is required"
285
72
self.this_branch = this_branch
286
73
self.this_basis = _mod_revision.ensure_null(
287
74
this_branch.last_revision())
441
205
return self._cached_trees[revision_id]
443
207
def _get_tree(self, treespec, possible_transports=None):
208
from bzrlib import workingtree
444
209
location, revno = treespec
445
210
if revno is None:
446
211
tree = workingtree.WorkingTree.open_containing(location)[0]
447
212
return tree.branch, tree
448
branch = _mod_branch.Branch.open_containing(
449
location, possible_transports)[0]
213
branch = Branch.open_containing(location, possible_transports)[0]
451
215
revision_id = branch.last_revision()
453
217
revision_id = branch.get_rev_id(revno)
454
revision_id = _mod_revision.ensure_null(revision_id)
218
revision_id = ensure_null(revision_id)
455
219
return branch, self.revision_tree(revision_id, branch)
221
def ensure_revision_trees(self):
222
if self.this_revision_tree is None:
223
self.this_basis_tree = self.revision_tree(self.this_basis)
224
if self.this_basis == self.this_rev_id:
225
self.this_revision_tree = self.this_basis_tree
227
if self.other_rev_id is None:
228
other_basis_tree = self.revision_tree(self.other_basis)
229
changes = other_basis_tree.changes_from(self.other_tree)
230
if changes.has_changed():
231
raise WorkingTreeNotRevision(self.this_tree)
232
other_rev_id = self.other_basis
233
self.other_tree = other_basis_tree
235
def file_revisions(self, file_id):
236
self.ensure_revision_trees()
237
def get_id(tree, file_id):
238
revision_id = tree.inventory[file_id].revision
239
assert revision_id is not None
241
if self.this_rev_id is None:
242
if self.this_basis_tree.get_file_sha1(file_id) != \
243
self.this_tree.get_file_sha1(file_id):
244
raise WorkingTreeNotRevision(self.this_tree)
246
trees = (self.this_basis_tree, self.other_tree)
247
return [get_id(tree, file_id) for tree in trees]
249
def check_basis(self, check_clean, require_commits=True):
250
if self.this_basis is None and require_commits is True:
251
raise BzrCommandError("This branch has no commits."
252
" (perhaps you would prefer 'bzr pull')")
255
if self.this_basis != self.this_rev_id:
256
raise errors.UncommittedChanges(self.this_tree)
258
def compare_basis(self):
260
basis_tree = self.revision_tree(self.this_tree.last_revision())
261
except errors.RevisionNotPresent:
262
basis_tree = self.this_tree.basis_tree()
263
changes = self.this_tree.changes_from(basis_tree)
264
if not changes.has_changed():
265
self.this_rev_id = self.this_basis
457
267
def set_interesting_files(self, file_list):
458
268
self.interesting_files = file_list
460
270
def set_pending(self):
461
if (not self.base_is_ancestor or not self.base_is_other_ancestor
462
or self.other_rev_id is None):
271
if not self.base_is_ancestor or not self.base_is_other_ancestor or self.other_rev_id is None:
464
273
self._add_parent()
466
275
def _add_parent(self):
467
276
new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
468
277
new_parent_trees = []
469
operation = cleanup.OperationWithCleanups(
470
self.this_tree.set_parent_trees)
471
278
for revision_id in new_parents:
473
280
tree = self.revision_tree(revision_id)
474
except errors.NoSuchRevision:
281
except errors.RevisionNotPresent:
478
operation.add_cleanup(tree.unlock)
479
285
new_parent_trees.append((revision_id, tree))
480
operation.run_simple(new_parent_trees, allow_leftmost_as_ghost=True)
287
self.this_tree.set_parent_trees(new_parent_trees,
288
allow_leftmost_as_ghost=True)
290
for _revision_id, tree in new_parent_trees:
482
294
def set_other(self, other_revision, possible_transports=None):
483
295
"""Set the revision and tree to merge from.
534
346
target.fetch(source, revision_id)
536
348
def find_base(self):
537
revisions = [_mod_revision.ensure_null(self.this_basis),
538
_mod_revision.ensure_null(self.other_basis)]
539
if _mod_revision.NULL_REVISION in revisions:
540
self.base_rev_id = _mod_revision.NULL_REVISION
541
self.base_tree = self.revision_tree(self.base_rev_id)
542
self._is_criss_cross = False
349
revisions = [ensure_null(self.this_basis),
350
ensure_null(self.other_basis)]
351
if NULL_REVISION in revisions:
352
self.base_rev_id = NULL_REVISION
544
lcas = self.revision_graph.find_lca(revisions[0], revisions[1])
545
self._is_criss_cross = False
547
self.base_rev_id = _mod_revision.NULL_REVISION
549
self.base_rev_id = list(lcas)[0]
550
else: # len(lcas) > 1
551
self._is_criss_cross = True
553
# find_unique_lca can only handle 2 nodes, so we have to
554
# start back at the beginning. It is a shame to traverse
555
# the graph again, but better than re-implementing
557
self.base_rev_id = self.revision_graph.find_unique_lca(
558
revisions[0], revisions[1])
560
self.base_rev_id = self.revision_graph.find_unique_lca(
562
sorted_lca_keys = self.revision_graph.find_merge_order(
564
if self.base_rev_id == _mod_revision.NULL_REVISION:
565
self.base_rev_id = sorted_lca_keys[0]
567
if self.base_rev_id == _mod_revision.NULL_REVISION:
568
raise errors.UnrelatedBranches()
569
if self._is_criss_cross:
570
trace.warning('Warning: criss-cross merge encountered. See bzr'
571
' help criss-cross.')
572
trace.mutter('Criss-cross lcas: %r' % lcas)
573
if self.base_rev_id in lcas:
574
trace.mutter('Unable to find unique lca. '
575
'Fallback %r as best option.'
577
interesting_revision_ids = set(lcas)
578
interesting_revision_ids.add(self.base_rev_id)
579
interesting_trees = dict((t.get_revision_id(), t)
580
for t in self.this_branch.repository.revision_trees(
581
interesting_revision_ids))
582
self._cached_trees.update(interesting_trees)
583
if self.base_rev_id in lcas:
584
self.base_tree = interesting_trees[self.base_rev_id]
586
self.base_tree = interesting_trees.pop(self.base_rev_id)
587
self._lca_trees = [interesting_trees[key]
588
for key in sorted_lca_keys]
590
self.base_tree = self.revision_tree(self.base_rev_id)
354
self.base_rev_id, steps = self.revision_graph.find_unique_lca(
355
revisions[0], revisions[1], count_steps=True)
356
if self.base_rev_id == NULL_REVISION:
357
raise UnrelatedBranches()
359
warning('Warning: criss-cross merge encountered. See bzr'
360
' help criss-cross.')
361
self.base_tree = self.revision_tree(self.base_rev_id)
591
362
self.base_is_ancestor = True
592
363
self.base_is_other_ancestor = True
593
trace.mutter('Base revid: %r' % self.base_rev_id)
595
365
def set_base(self, base_revision):
596
366
"""Set the base revision to use for the merge.
598
368
:param base_revision: A 2-list containing a path and revision number.
600
trace.mutter("doing merge() with no base_revision specified")
370
mutter("doing merge() with no base_revision specified")
601
371
if base_revision == [None, None]:
612
382
self._maybe_fetch(base_branch, self.this_branch, self.base_rev_id)
614
384
def make_merger(self):
615
kwargs = {'working_tree': self.this_tree, 'this_tree': self.this_tree,
385
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
616
386
'other_tree': self.other_tree,
617
387
'interesting_ids': self.interesting_ids,
618
388
'interesting_files': self.interesting_files,
619
'this_branch': self.this_branch,
620
'other_branch': self.other_branch,
621
390
'do_merge': False}
622
391
if self.merge_type.requires_base:
623
392
kwargs['base_tree'] = self.base_tree
624
393
if self.merge_type.supports_reprocess:
625
394
kwargs['reprocess'] = self.reprocess
626
395
elif self.reprocess:
627
raise errors.BzrError(
628
"Conflict reduction is not supported for merge"
629
" type %s." % self.merge_type)
396
raise BzrError("Conflict reduction is not supported for merge"
397
" type %s." % self.merge_type)
630
398
if self.merge_type.supports_show_base:
631
399
kwargs['show_base'] = self.show_base
632
400
elif self.show_base:
633
raise errors.BzrError("Showing base is not supported for this"
634
" merge type. %s" % self.merge_type)
401
raise BzrError("Showing base is not supported for this"
402
" merge type. %s" % self.merge_type)
635
403
if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
636
404
and not self.base_is_other_ancestor):
637
405
raise errors.CannotReverseCherrypick()
638
406
if self.merge_type.supports_cherrypick:
639
407
kwargs['cherrypick'] = (not self.base_is_ancestor or
640
408
not self.base_is_other_ancestor)
641
if self._is_criss_cross and getattr(self.merge_type,
642
'supports_lca_trees', False):
643
kwargs['lca_trees'] = self._lca_trees
644
return self.merge_type(pb=None,
409
return self.merge_type(pb=self._pb,
645
410
change_reporter=self.change_reporter,
648
def _do_merge_to(self):
649
merge = self.make_merger()
650
if self.other_branch is not None:
651
self.other_branch.update_references(self.this_branch)
652
for hook in Merger.hooks['pre_merge']:
655
for hook in Merger.hooks['post_merge']:
657
if self.recurse == 'down':
658
for relpath, file_id in self.this_tree.iter_references():
659
sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
660
other_revision = self.other_tree.get_reference_revision(
662
if other_revision == sub_tree.last_revision():
664
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
665
sub_merge.merge_type = self.merge_type
666
other_branch = self.other_branch.reference_parent(file_id,
668
sub_merge.set_other_revision(other_revision, other_branch)
669
base_revision = self.base_tree.get_reference_revision(file_id)
670
sub_merge.base_tree = \
671
sub_tree.branch.repository.revision_tree(base_revision)
672
sub_merge.base_rev_id = base_revision
676
413
def do_merge(self):
677
operation = cleanup.OperationWithCleanups(self._do_merge_to)
678
414
self.this_tree.lock_tree_write()
679
operation.add_cleanup(self.this_tree.unlock)
680
415
if self.base_tree is not None:
681
416
self.base_tree.lock_read()
682
operation.add_cleanup(self.base_tree.unlock)
683
417
if self.other_tree is not None:
684
418
self.other_tree.lock_read()
685
operation.add_cleanup(self.other_tree.unlock)
686
merge = operation.run_simple()
420
merge = self.make_merger()
422
if self.recurse == 'down':
423
for path, file_id in self.this_tree.iter_references():
424
sub_tree = self.this_tree.get_nested_tree(file_id, path)
425
other_revision = self.other_tree.get_reference_revision(
427
if other_revision == sub_tree.last_revision():
429
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
430
sub_merge.merge_type = self.merge_type
431
relpath = self.this_tree.relpath(path)
432
other_branch = self.other_branch.reference_parent(file_id, relpath)
433
sub_merge.set_other_revision(other_revision, other_branch)
434
base_revision = self.base_tree.get_reference_revision(file_id)
435
sub_merge.base_tree = \
436
sub_tree.branch.repository.revision_tree(base_revision)
437
sub_merge.base_rev_id = base_revision
441
if self.other_tree is not None:
442
self.other_tree.unlock()
443
if self.base_tree is not None:
444
self.base_tree.unlock()
445
self.this_tree.unlock()
687
446
if len(merge.cooked_conflicts) == 0:
688
if not self.ignore_zero and not trace.is_quiet():
689
trace.note(gettext("All changes applied successfully."))
447
if not self.ignore_zero and not is_quiet():
448
note("All changes applied successfully.")
691
trace.note(gettext("%d conflicts encountered.")
692
% len(merge.cooked_conflicts))
450
note("%d conflicts encountered." % len(merge.cooked_conflicts))
694
452
return len(merge.cooked_conflicts)
697
class _InventoryNoneEntry(object):
698
"""This represents an inventory entry which *isn't there*.
700
It simplifies the merging logic if we always have an InventoryEntry, even
701
if it isn't actually present
708
symlink_target = None
711
_none_entry = _InventoryNoneEntry()
714
455
class Merge3Merger(object):
715
456
"""Three-way merger that uses the merge3 text merger"""
716
457
requires_base = True
720
461
supports_cherrypick = True
721
462
supports_reverse_cherrypick = True
722
463
winner_idx = {"this": 2, "other": 1, "conflict": 1}
723
supports_lca_trees = True
725
def __init__(self, working_tree, this_tree, base_tree, other_tree,
465
def __init__(self, working_tree, this_tree, base_tree, other_tree,
726
466
interesting_ids=None, reprocess=False, show_base=False,
727
pb=None, pp=None, change_reporter=None,
467
pb=DummyProgress(), pp=None, change_reporter=None,
728
468
interesting_files=None, do_merge=True,
729
cherrypick=False, lca_trees=None, this_branch=None,
731
470
"""Initialize the merger object and perform the merge.
733
472
:param working_tree: The working tree to apply the merge to
734
473
:param this_tree: The local tree in the merge operation
735
474
:param base_tree: The common tree in the merge operation
736
:param other_tree: The other tree to merge changes from
737
:param this_branch: The branch associated with this_tree. Defaults to
738
this_tree.branch if not supplied.
739
:param other_branch: The branch associated with other_tree, if any.
475
:param other_tree: The other other tree to merge changes from
740
476
:param interesting_ids: The file_ids of files that should be
741
477
participate in the merge. May not be combined with
742
478
interesting_files.
743
479
:param: reprocess If True, perform conflict-reduction processing.
744
480
:param show_base: If True, show the base revision in text conflicts.
745
481
(incompatible with reprocess)
482
:param pb: A Progress bar
747
483
:param pp: A ProgressPhase object
748
484
:param change_reporter: An object that should report changes made
749
485
:param interesting_files: The tree-relative paths of files that should
752
488
be combined with interesting_ids. If neither interesting_files nor
753
489
interesting_ids is specified, all files may participate in the
755
:param lca_trees: Can be set to a dictionary of {revision_id:rev_tree}
756
if the ancestry was found to include a criss-cross merge.
757
Otherwise should be None.
759
492
object.__init__(self)
760
if interesting_files is not None and interesting_ids is not None:
762
'specify either interesting_ids or interesting_files')
763
if this_branch is None:
764
this_branch = this_tree.branch
493
if interesting_files is not None:
494
assert interesting_ids is None
765
495
self.interesting_ids = interesting_ids
766
496
self.interesting_files = interesting_files
767
self.working_tree = working_tree
768
self.this_tree = this_tree
497
self.this_tree = working_tree
769
498
self.base_tree = base_tree
770
499
self.other_tree = other_tree
771
self.this_branch = this_branch
772
self.other_branch = other_branch
773
500
self._raw_conflicts = []
774
501
self.cooked_conflicts = []
775
502
self.reprocess = reprocess
776
503
self.show_base = show_base
777
self._lca_trees = lca_trees
778
# Uncommenting this will change the default algorithm to always use
779
# _entries_lca. This can be useful for running the test suite and
780
# making sure we haven't missed any corner cases.
781
# if lca_trees is None:
782
# self._lca_trees = [self.base_tree]
783
506
self.change_reporter = change_reporter
784
507
self.cherrypick = cherrypick
509
self.pp = ProgressPhase("Merge phase", 3, self.pb)
788
warnings.warn("pp argument to Merge3Merger is deprecated")
790
warnings.warn("pb argument to Merge3Merger is deprecated")
792
513
def do_merge(self):
793
operation = cleanup.OperationWithCleanups(self._do_merge)
794
self.working_tree.lock_tree_write()
795
operation.add_cleanup(self.working_tree.unlock)
796
self.this_tree.lock_read()
797
operation.add_cleanup(self.this_tree.unlock)
514
self.this_tree.lock_tree_write()
798
515
self.base_tree.lock_read()
799
operation.add_cleanup(self.base_tree.unlock)
800
516
self.other_tree.lock_read()
801
operation.add_cleanup(self.other_tree.unlock)
804
def _do_merge(self, operation):
805
self.tt = transform.TreeTransform(self.working_tree, None)
806
operation.add_cleanup(self.tt.finalize)
807
self._compute_transform()
808
results = self.tt.apply(no_conflicts=True)
809
self.write_modified(results)
517
self.tt = TreeTransform(self.this_tree, self.pb)
811
self.working_tree.add_conflicts(self.cooked_conflicts)
812
except errors.UnsupportedOperation:
520
self._compute_transform()
522
results = self.tt.apply(no_conflicts=True)
523
self.write_modified(results)
525
self.this_tree.add_conflicts(self.cooked_conflicts)
526
except UnsupportedOperation:
530
self.other_tree.unlock()
531
self.base_tree.unlock()
532
self.this_tree.unlock()
815
535
def make_preview_transform(self):
816
operation = cleanup.OperationWithCleanups(self._make_preview_transform)
817
536
self.base_tree.lock_read()
818
operation.add_cleanup(self.base_tree.unlock)
819
537
self.other_tree.lock_read()
820
operation.add_cleanup(self.other_tree.unlock)
821
return operation.run_simple()
823
def _make_preview_transform(self):
824
self.tt = transform.TransformPreview(self.working_tree)
825
self._compute_transform()
538
self.tt = TransformPreview(self.this_tree)
541
self._compute_transform()
544
self.other_tree.unlock()
545
self.base_tree.unlock()
828
549
def _compute_transform(self):
829
if self._lca_trees is None:
830
entries = self._entries3()
831
resolver = self._three_way
833
entries = self._entries_lca()
834
resolver = self._lca_multi_way
835
# Prepare merge hooks
836
factories = Merger.hooks['merge_file_content']
837
# One hook for each registered one plus our default merger
838
hooks = [factory(self) for factory in factories] + [self]
839
self.active_hooks = [hook for hook in hooks if hook is not None]
550
entries = self._entries3()
840
551
child_pb = ui.ui_factory.nested_progress_bar()
842
553
for num, (file_id, changed, parents3, names3,
843
554
executable3) in enumerate(entries):
844
# Try merging each entry
845
child_pb.update(gettext('Preparing file merge'),
847
self._merge_names(file_id, parents3, names3, resolver=resolver)
555
child_pb.update('Preparing file merge', num, len(entries))
556
self._merge_names(file_id, parents3, names3)
849
file_status = self._do_merge_contents(file_id)
558
file_status = self.merge_contents(file_id)
851
560
file_status = 'unmodified'
852
561
self._merge_executable(file_id,
853
executable3, file_status, resolver=resolver)
562
executable3, file_status)
855
564
child_pb.finished()
856
self.tt.fixup_new_roots()
857
self._finish_computing_transform()
859
def _finish_computing_transform(self):
860
"""Finalize the transform and report the changes.
862
This is the second half of _compute_transform.
864
567
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))
569
fs_conflicts = resolve_conflicts(self.tt, child_pb,
570
lambda t, c: conflict_pass(t, c, self.other_tree))
869
572
child_pb.finished()
870
573
if self.change_reporter is not None:
911
611
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])
922
:return: [(file_id, changed, parents, names, executable)], where:
924
* file_id: Simple file_id of the entry
925
* changed: Boolean, True if the kind or contents changed else False
926
* parents: ((base, [parent_id, in, lcas]), parent_id_other,
928
* names: ((base, [name, in, lcas]), name_in_other, name_in_this)
929
* executable: ((base, [exec, in, lcas]), exec_in_other,
932
if self.interesting_files is not None:
933
lookup_trees = [self.this_tree, self.base_tree]
934
lookup_trees.extend(self._lca_trees)
935
# I think we should include the lca trees as well
936
interesting_ids = self.other_tree.paths2ids(self.interesting_files,
939
interesting_ids = self.interesting_ids
941
walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
943
base_inventory = self.base_tree.root_inventory
944
this_inventory = self.this_tree.root_inventory
945
for path, file_id, other_ie, lca_values in walker.iter_all():
946
# Is this modified at all from any of the other trees?
948
other_ie = _none_entry
949
if interesting_ids is not None and file_id not in interesting_ids:
952
# If other_revision is found in any of the lcas, that means this
953
# node is uninteresting. This is because when merging, if there are
954
# multiple heads(), we have to create a new node. So if we didn't,
955
# we know that the ancestry is linear, and that OTHER did not
957
# See doc/developers/lca_merge_resolution.txt for details
958
other_revision = other_ie.revision
959
if other_revision is not None:
960
# We can't use this shortcut when other_revision is None,
961
# because it may be None because things are WorkingTrees, and
962
# not because it is *actually* None.
963
is_unmodified = False
964
for lca_path, ie in lca_values:
965
if ie is not None and ie.revision == other_revision:
972
for lca_path, lca_ie in lca_values:
974
lca_entries.append(_none_entry)
976
lca_entries.append(lca_ie)
978
if base_inventory.has_id(file_id):
979
base_ie = base_inventory[file_id]
981
base_ie = _none_entry
983
if this_inventory.has_id(file_id):
984
this_ie = this_inventory[file_id]
986
this_ie = _none_entry
992
for lca_ie in lca_entries:
993
lca_kinds.append(lca_ie.kind)
994
lca_parent_ids.append(lca_ie.parent_id)
995
lca_names.append(lca_ie.name)
996
lca_executable.append(lca_ie.executable)
998
kind_winner = self._lca_multi_way(
999
(base_ie.kind, lca_kinds),
1000
other_ie.kind, this_ie.kind)
1001
parent_id_winner = self._lca_multi_way(
1002
(base_ie.parent_id, lca_parent_ids),
1003
other_ie.parent_id, this_ie.parent_id)
1004
name_winner = self._lca_multi_way(
1005
(base_ie.name, lca_names),
1006
other_ie.name, this_ie.name)
1008
content_changed = True
1009
if kind_winner == 'this':
1010
# No kind change in OTHER, see if there are *any* changes
1011
if other_ie.kind == 'directory':
1012
if parent_id_winner == 'this' and name_winner == 'this':
1013
# No change for this directory in OTHER, skip
1015
content_changed = False
1016
elif other_ie.kind is None or other_ie.kind == 'file':
1017
def get_sha1(ie, tree):
1018
if ie.kind != 'file':
1020
return tree.get_file_sha1(file_id)
1021
base_sha1 = get_sha1(base_ie, self.base_tree)
1022
lca_sha1s = [get_sha1(ie, tree) for ie, tree
1023
in zip(lca_entries, self._lca_trees)]
1024
this_sha1 = get_sha1(this_ie, self.this_tree)
1025
other_sha1 = get_sha1(other_ie, self.other_tree)
1026
sha1_winner = self._lca_multi_way(
1027
(base_sha1, lca_sha1s), other_sha1, this_sha1,
1028
allow_overriding_lca=False)
1029
exec_winner = self._lca_multi_way(
1030
(base_ie.executable, lca_executable),
1031
other_ie.executable, this_ie.executable)
1032
if (parent_id_winner == 'this' and name_winner == 'this'
1033
and sha1_winner == 'this' and exec_winner == 'this'):
1034
# No kind, parent, name, exec, or content change for
1035
# OTHER, so this node is not considered interesting
1037
if sha1_winner == 'this':
1038
content_changed = False
1039
elif other_ie.kind == 'symlink':
1040
def get_target(ie, tree):
1041
if ie.kind != 'symlink':
1043
return tree.get_symlink_target(file_id)
1044
base_target = get_target(base_ie, self.base_tree)
1045
lca_targets = [get_target(ie, tree) for ie, tree
1046
in zip(lca_entries, self._lca_trees)]
1047
this_target = get_target(this_ie, self.this_tree)
1048
other_target = get_target(other_ie, self.other_tree)
1049
target_winner = self._lca_multi_way(
1050
(base_target, lca_targets),
1051
other_target, this_target)
1052
if (parent_id_winner == 'this' and name_winner == 'this'
1053
and target_winner == 'this'):
1054
# No kind, parent, name, or symlink target change
1057
if target_winner == 'this':
1058
content_changed = False
1059
elif other_ie.kind == 'tree-reference':
1060
# The 'changed' information seems to be handled at a higher
1061
# level. At least, _entries3 returns False for content
1062
# changed, even when at a new revision_id.
1063
content_changed = False
1064
if (parent_id_winner == 'this' and name_winner == 'this'):
1065
# Nothing interesting
1068
raise AssertionError('unhandled kind: %s' % other_ie.kind)
1070
# If we have gotten this far, that means something has changed
1071
result.append((file_id, content_changed,
1072
((base_ie.parent_id, lca_parent_ids),
1073
other_ie.parent_id, this_ie.parent_id),
1074
((base_ie.name, lca_names),
1075
other_ie.name, this_ie.name),
1076
((base_ie.executable, lca_executable),
1077
other_ie.executable, this_ie.executable)
616
self.tt.final_kind(self.tt.root)
618
self.tt.cancel_deletion(self.tt.root)
619
if self.tt.final_file_id(self.tt.root) is None:
620
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
622
if self.other_tree.inventory.root is None:
624
other_root_file_id = self.other_tree.get_root_id()
625
other_root = self.tt.trans_id_file_id(other_root_file_id)
626
if other_root == self.tt.root:
629
self.tt.final_kind(other_root)
632
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
633
self.tt.cancel_creation(other_root)
634
self.tt.cancel_versioning(other_root)
636
def reparent_children(self, ie, target):
637
for thing, child in ie.children.iteritems():
638
trans_id = self.tt.trans_id_file_id(child.file_id)
639
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
1081
641
def write_modified(self, results):
1082
642
modified_hashes = {}
1083
643
for path in results.modified_paths:
1084
file_id = self.working_tree.path2id(self.working_tree.relpath(path))
644
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
1085
645
if file_id is None:
1087
hash = self.working_tree.get_file_sha1(file_id)
647
hash = self.this_tree.get_file_sha1(file_id)
1088
648
if hash is None:
1090
650
modified_hashes[file_id] = hash
1091
self.working_tree.set_merge_modified(modified_hashes)
651
self.this_tree.set_merge_modified(modified_hashes)
1094
654
def parent(entry, file_id):
1124
684
def kind(tree, file_id):
1125
685
"""Determine the kind of a file-id (used as a key method)."""
1126
if not tree.has_id(file_id):
686
if file_id not in tree:
1128
688
return tree.kind(file_id)
1131
691
def _three_way(base, other, this):
692
#if base == other, either they all agree, or only THIS has changed.
1132
693
if base == other:
1133
# if 'base == other', either they all agree, or only 'this' has
1136
695
elif this not in (base, other):
1137
# 'this' is neither 'base' nor 'other', so both sides changed
1138
696
return 'conflict'
697
# "Ambiguous clean merge" -- both sides have made the same change.
1139
698
elif this == other:
1140
# "Ambiguous clean merge" -- both sides have made the same change.
700
# this == base: only other has changed.
1143
# this == base: only other has changed.
1147
def _lca_multi_way(bases, other, this, allow_overriding_lca=True):
1148
"""Consider LCAs when determining whether a change has occurred.
1150
If LCAS are all identical, this is the same as a _three_way comparison.
1152
:param bases: value in (BASE, [LCAS])
1153
:param other: value in OTHER
1154
:param this: value in THIS
1155
:param allow_overriding_lca: If there is more than one unique lca
1156
value, allow OTHER to override THIS if it has a new value, and
1157
THIS only has an lca value, or vice versa. This is appropriate for
1158
truly scalar values, not as much for non-scalars.
1159
:return: 'this', 'other', or 'conflict' depending on whether an entry
705
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
706
"""Do a three-way test on a scalar.
707
Return "this", "other" or "conflict", depending whether a value wins.
1162
# See doc/developers/lca_tree_merging.txt for details about this
1165
# Either Ambiguously clean, or nothing was actually changed. We
1168
base_val, lca_vals = bases
1169
# Remove 'base_val' from the lca_vals, because it is not interesting
1170
filtered_lca_vals = [lca_val for lca_val in lca_vals
1171
if lca_val != base_val]
1172
if len(filtered_lca_vals) == 0:
1173
return Merge3Merger._three_way(base_val, other, this)
1175
unique_lca_vals = set(filtered_lca_vals)
1176
if len(unique_lca_vals) == 1:
1177
return Merge3Merger._three_way(unique_lca_vals.pop(), other, this)
1179
if allow_overriding_lca:
1180
if other in unique_lca_vals:
1181
if this in unique_lca_vals:
1182
# Each side picked a different lca, conflict
1185
# This has a value which supersedes both lca values, and
1186
# other only has an lca value
1188
elif this in unique_lca_vals:
1189
# OTHER has a value which supersedes both lca values, and this
1190
# only has an lca value
1193
# At this point, the lcas disagree, and the tip disagree
709
key_base = key(base_tree, file_id)
710
key_other = key(other_tree, file_id)
711
#if base == other, either they all agree, or only THIS has changed.
712
if key_base == key_other:
714
key_this = key(this_tree, file_id)
715
if key_this not in (key_base, key_other):
717
# "Ambiguous clean merge"
718
elif key_this == key_other:
721
assert key_this == key_base
1196
724
def merge_names(self, file_id):
1197
725
def get_entry(tree):
1199
return tree.root_inventory[file_id]
1200
except errors.NoSuchId:
726
if file_id in tree.inventory:
727
return tree.inventory[file_id]
1202
730
this_entry = get_entry(self.this_tree)
1203
731
other_entry = get_entry(self.other_tree)
1230
757
parent_id_winner = "other"
1231
758
if name_winner == "this" and parent_id_winner == "this":
1233
if name_winner == 'conflict' or parent_id_winner == 'conflict':
1234
# Creating helpers (.OTHER or .THIS) here cause problems down the
1235
# road if a ContentConflict needs to be created so we should not do
1237
trans_id = self.tt.trans_id_file_id(file_id)
1238
self._raw_conflicts.append(('path conflict', trans_id, file_id,
1239
this_parent, this_name,
1240
other_parent, other_name))
1241
if not self.other_tree.has_id(file_id):
1242
# it doesn't matter whether the result was 'other' or
1243
# 'conflict'-- if it has no file id, we leave it alone.
760
if name_winner == "conflict":
761
trans_id = self.tt.trans_id_file_id(file_id)
762
self._raw_conflicts.append(('name conflict', trans_id,
763
this_name, other_name))
764
if parent_id_winner == "conflict":
765
trans_id = self.tt.trans_id_file_id(file_id)
766
self._raw_conflicts.append(('parent conflict', trans_id,
767
this_parent, other_parent))
768
if other_name is None:
769
# it doesn't matter whether the result was 'other' or
770
# 'conflict'-- if there's no 'other', we leave it alone.
772
# if we get here, name_winner and parent_winner are set to safe values.
773
trans_id = self.tt.trans_id_file_id(file_id)
1245
774
parent_id = parents[self.winner_idx[parent_id_winner]]
1246
name = names[self.winner_idx[name_winner]]
1247
if parent_id is not None or name is not None:
1248
# if we get here, name_winner and parent_winner are set to safe
1250
if parent_id is None and name is not None:
1251
# if parent_id is None and name is non-None, current file is
1253
if names[self.winner_idx[parent_id_winner]] != '':
1254
raise AssertionError(
1255
'File looks like a root, but named %s' %
1256
names[self.winner_idx[parent_id_winner]])
1257
parent_trans_id = transform.ROOT_PARENT
1259
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1260
self.tt.adjust_path(name, parent_trans_id,
1261
self.tt.trans_id_file_id(file_id))
775
if parent_id is not None:
776
parent_trans_id = self.tt.trans_id_file_id(parent_id)
777
self.tt.adjust_path(names[self.winner_idx[name_winner]],
778
parent_trans_id, trans_id)
1263
def _do_merge_contents(self, file_id):
1264
"""Performs a merge on file_id contents."""
780
def merge_contents(self, file_id):
781
"""Performa a merge on file_id contents."""
1265
782
def contents_pair(tree):
1266
if not tree.has_id(file_id):
783
if file_id not in tree:
1267
784
return (None, None)
1268
785
kind = tree.kind(file_id)
1269
786
if kind == "file":
1275
792
return kind, contents
794
def contents_conflict():
795
trans_id = self.tt.trans_id_file_id(file_id)
796
name = self.tt.final_name(trans_id)
797
parent_id = self.tt.final_parent(trans_id)
798
if file_id in self.this_tree.inventory:
799
self.tt.unversion_file(trans_id)
800
if file_id in self.this_tree:
801
self.tt.delete_contents(trans_id)
802
file_group = self._dump_conflicts(name, parent_id, file_id,
804
self._raw_conflicts.append(('contents conflict', file_group))
1277
806
# See SPOT run. run, SPOT, run.
1278
807
# So we're not QUITE repeating ourselves; we do tricky things with
1280
809
base_pair = contents_pair(self.base_tree)
1281
810
other_pair = contents_pair(self.other_tree)
1283
this_pair = contents_pair(self.this_tree)
1284
lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1285
winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1286
this_pair, allow_overriding_lca=False)
811
if base_pair == other_pair:
812
# OTHER introduced no changes
814
this_pair = contents_pair(self.this_tree)
815
if this_pair == other_pair:
816
# THIS and OTHER introduced the same changes
1288
if base_pair == other_pair:
1291
# We delayed evaluating this_pair as long as we can to avoid
1292
# unnecessary sha1 calculation
1293
this_pair = contents_pair(self.this_tree)
1294
winner = self._three_way(base_pair, other_pair, this_pair)
1295
if winner == 'this':
1296
# No interesting changes introduced by OTHER
1298
# We have a hypothetical conflict, but if we have files, then we
1299
# can try to merge the content
1300
trans_id = self.tt.trans_id_file_id(file_id)
1301
params = MergeFileHookParams(self, file_id, trans_id, this_pair[0],
1302
other_pair[0], winner)
1303
hooks = self.active_hooks
1304
hook_status = 'not_applicable'
1306
hook_status, lines = hook.merge_contents(params)
1307
if hook_status != 'not_applicable':
1308
# Don't try any more hooks, this one applies.
1310
# If the merge ends up replacing the content of the file, we get rid of
1311
# it at the end of this method (this variable is used to track the
1312
# exceptions to this rule).
1315
if hook_status == 'not_applicable':
1316
# No merge hook was able to resolve the situation. Two cases exist:
1317
# a content conflict or a duplicate one.
1319
name = self.tt.final_name(trans_id)
1320
parent_id = self.tt.final_parent(trans_id)
1322
inhibit_content_conflict = False
1323
if params.this_kind is None: # file_id is not in THIS
1324
# Is the name used for a different file_id ?
1325
dupe_path = self.other_tree.id2path(file_id)
1326
this_id = self.this_tree.path2id(dupe_path)
1327
if this_id is not None:
1328
# Two entries for the same path
1330
# versioning the merged file will trigger a duplicate
1332
self.tt.version_file(file_id, trans_id)
1333
transform.create_from_tree(
1334
self.tt, trans_id, self.other_tree, file_id,
1335
filter_tree_path=self._get_filter_tree_path(file_id))
1336
inhibit_content_conflict = True
1337
elif params.other_kind is None: # file_id is not in OTHER
1338
# Is the name used for a different file_id ?
1339
dupe_path = self.this_tree.id2path(file_id)
1340
other_id = self.other_tree.path2id(dupe_path)
1341
if other_id is not None:
1342
# Two entries for the same path again, but here, the other
1343
# entry will also be merged. We simply inhibit the
1344
# 'content' conflict creation because we know OTHER will
1345
# create (or has already created depending on ordering) an
1346
# entry at the same path. This will trigger a 'duplicate'
1349
inhibit_content_conflict = True
1350
if not inhibit_content_conflict:
1351
if params.this_kind is not None:
819
trans_id = self.tt.trans_id_file_id(file_id)
820
if this_pair == base_pair:
821
# only OTHER introduced changes
822
if file_id in self.this_tree:
823
# Remove any existing contents
824
self.tt.delete_contents(trans_id)
825
if file_id in self.other_tree:
826
# OTHER changed the file
827
create_by_entry(self.tt,
828
self.other_tree.inventory[file_id],
829
self.other_tree, trans_id)
830
if file_id not in self.this_tree.inventory:
831
self.tt.version_file(file_id, trans_id)
833
elif file_id in self.this_tree.inventory:
834
# OTHER deleted the file
1352
835
self.tt.unversion_file(trans_id)
1353
# This is a contents conflict, because none of the available
1354
# functions could merge it.
1355
file_group = self._dump_conflicts(name, parent_id, file_id,
1357
self._raw_conflicts.append(('contents conflict', file_group))
1358
elif hook_status == 'success':
1359
self.tt.create_file(lines, trans_id)
1360
elif hook_status == 'conflicted':
1361
# XXX: perhaps the hook should be able to provide
1362
# the BASE/THIS/OTHER files?
1363
self.tt.create_file(lines, trans_id)
1364
self._raw_conflicts.append(('text conflict', trans_id))
1365
name = self.tt.final_name(trans_id)
1366
parent_id = self.tt.final_parent(trans_id)
1367
self._dump_conflicts(name, parent_id, file_id)
1368
elif hook_status == 'delete':
1369
self.tt.unversion_file(trans_id)
1371
elif hook_status == 'done':
1372
# The hook function did whatever it needs to do directly, no
1373
# further action needed here.
1376
raise AssertionError('unknown hook_status: %r' % (hook_status,))
1377
if not self.this_tree.has_id(file_id) and result == "modified":
1378
self.tt.version_file(file_id, trans_id)
1380
# The merge has been performed and produced a new content, so the
1381
# old contents should not be retained.
1382
self.tt.delete_contents(trans_id)
1385
def _default_other_winner_merge(self, merge_hook_params):
1386
"""Replace this contents with other."""
1387
file_id = merge_hook_params.file_id
1388
trans_id = merge_hook_params.trans_id
1389
if self.other_tree.has_id(file_id):
1390
# OTHER changed the file
1391
transform.create_from_tree(
1392
self.tt, trans_id, self.other_tree, file_id,
1393
filter_tree_path=self._get_filter_tree_path(file_id))
1395
elif self.this_tree.has_id(file_id):
1396
# OTHER deleted the file
1397
return 'delete', None
1399
raise AssertionError(
1400
'winner is OTHER, but file_id %r not in THIS or OTHER tree'
1403
def merge_contents(self, merge_hook_params):
1404
"""Fallback merge logic after user installed hooks."""
1405
# This function is used in merge hooks as the fallback instance.
1406
# Perhaps making this function and the functions it calls be a
1407
# a separate class would be better.
1408
if merge_hook_params.winner == 'other':
1409
# OTHER is a straight winner, so replace this contents with other
1410
return self._default_other_winner_merge(merge_hook_params)
1411
elif merge_hook_params.is_file_merge():
1412
# THIS and OTHER are both files, so text merge. Either
1413
# BASE is a file, or both converted to files, so at least we
1414
# have agreement that output should be a file.
1416
self.text_merge(merge_hook_params.file_id,
1417
merge_hook_params.trans_id)
1418
except errors.BinaryFile:
1419
return 'not_applicable', None
1422
return 'not_applicable', None
837
#BOTH THIS and OTHER introduced changes; scalar conflict
838
elif this_pair[0] == "file" and other_pair[0] == "file":
839
# THIS and OTHER are both files, so text merge. Either
840
# BASE is a file, or both converted to files, so at least we
841
# have agreement that output should be a file.
843
self.text_merge(file_id, trans_id)
845
return contents_conflict()
846
if file_id not in self.this_tree.inventory:
847
self.tt.version_file(file_id, trans_id)
849
self.tt.tree_kind(trans_id)
850
self.tt.delete_contents(trans_id)
855
# Scalar conflict, can't text merge. Dump conflicts
856
return contents_conflict()
1424
858
def get_lines(self, tree, file_id):
1425
859
"""Return the lines in a file, or an empty list."""
1426
if tree.has_id(file_id):
1427
return tree.get_file_lines(file_id)
861
return tree.get_file(file_id).readlines()
1494
914
determined automatically. If set_version is true, the .OTHER, .THIS
1495
915
or .BASE (in that order) will be created as versioned files.
1497
data = [('OTHER', self.other_tree, other_lines),
917
data = [('OTHER', self.other_tree, other_lines),
1498
918
('THIS', self.this_tree, this_lines)]
1500
920
data.append(('BASE', self.base_tree, base_lines))
1502
# We need to use the actual path in the working tree of the file here,
1503
# ignoring the conflict suffixes
1505
if wt.supports_content_filtering():
1507
filter_tree_path = wt.id2path(file_id)
1508
except errors.NoSuchId:
1509
# file has been deleted
1510
filter_tree_path = None
1512
# Skip the id2path lookup for older formats
1513
filter_tree_path = None
1515
921
versioned = False
1517
923
for suffix, tree, lines in data:
1518
if tree.has_id(file_id):
1519
925
trans_id = self._conflict_file(name, parent_id, tree, file_id,
1520
suffix, lines, filter_tree_path)
1521
927
file_group.append(trans_id)
1522
928
if set_version and not versioned:
1523
929
self.tt.version_file(file_id, trans_id)
1524
930
versioned = True
1525
931
return file_group
1527
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1528
lines=None, filter_tree_path=None):
933
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1529
935
"""Emit a single conflict file."""
1530
936
name = name + '.' + suffix
1531
937
trans_id = self.tt.create_path(name, parent_id)
1532
transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
938
entry = tree.inventory[file_id]
939
create_by_entry(self.tt, entry, tree, trans_id, lines)
1536
942
def merge_executable(self, file_id, file_status):
1537
943
"""Perform a merge on the execute bit."""
1538
944
executable = [self.executable(t, file_id) for t in (self.base_tree,
1539
945
self.other_tree, self.this_tree)]
1540
self._merge_executable(file_id, executable, file_status,
1541
resolver=self._three_way)
946
self._merge_executable(file_id, executable, file_status)
1543
def _merge_executable(self, file_id, executable, file_status,
948
def _merge_executable(self, file_id, executable, file_status):
1545
949
"""Perform a merge on the execute bit."""
1546
950
base_executable, other_executable, this_executable = executable
1547
951
if file_status == "deleted":
1549
winner = resolver(*executable)
953
winner = self._three_way(*executable)
1550
954
if winner == "conflict":
1551
955
# There must be a None in here, if we have a conflict, but we
1552
956
# need executability since file status was not deleted.
1575
983
def cook_conflicts(self, fs_conflicts):
1576
984
"""Convert all conflicts into a form that doesn't depend on trans_id"""
1577
content_conflict_file_ids = set()
1578
cooked_conflicts = transform.cook_conflicts(fs_conflicts, self.tt)
1579
fp = transform.FinalPaths(self.tt)
985
from conflicts import Conflict
987
self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
988
fp = FinalPaths(self.tt)
1580
989
for conflict in self._raw_conflicts:
1581
990
conflict_type = conflict[0]
1582
if conflict_type == 'path conflict':
1584
this_parent, this_name,
1585
other_parent, other_name) = conflict[1:]
1586
if this_parent is None or this_name is None:
1587
this_path = '<deleted>'
1589
parent_path = fp.get_path(
1590
self.tt.trans_id_file_id(this_parent))
1591
this_path = osutils.pathjoin(parent_path, this_name)
1592
if other_parent is None or other_name is None:
1593
other_path = '<deleted>'
1595
if other_parent == self.other_tree.get_root_id():
1596
# The tree transform doesn't know about the other root,
1597
# so we special case here to avoid a NoFinalPath
1601
parent_path = fp.get_path(
1602
self.tt.trans_id_file_id(other_parent))
1603
other_path = osutils.pathjoin(parent_path, other_name)
1604
c = _mod_conflicts.Conflict.factory(
1605
'path conflict', path=this_path,
1606
conflict_path=other_path,
1608
elif conflict_type == 'contents conflict':
991
if conflict_type in ('name conflict', 'parent conflict'):
992
trans_id = conflict[1]
993
conflict_args = conflict[2:]
994
if trans_id not in name_conflicts:
995
name_conflicts[trans_id] = {}
996
unique_add(name_conflicts[trans_id], conflict_type,
998
if conflict_type == 'contents conflict':
1609
999
for trans_id in conflict[1]:
1610
1000
file_id = self.tt.final_file_id(trans_id)
1611
1001
if file_id is not None:
1612
# Ok we found the relevant file-id
1614
1003
path = fp.get_path(trans_id)
1615
1004
for suffix in ('.BASE', '.THIS', '.OTHER'):
1616
1005
if path.endswith(suffix):
1617
# Here is the raw path
1618
1006
path = path[:-len(suffix)]
1620
c = _mod_conflicts.Conflict.factory(conflict_type,
1621
path=path, file_id=file_id)
1622
content_conflict_file_ids.add(file_id)
1623
elif conflict_type == 'text conflict':
1008
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
1009
self.cooked_conflicts.append(c)
1010
if conflict_type == 'text conflict':
1624
1011
trans_id = conflict[1]
1625
1012
path = fp.get_path(trans_id)
1626
1013
file_id = self.tt.final_file_id(trans_id)
1627
c = _mod_conflicts.Conflict.factory(conflict_type,
1628
path=path, file_id=file_id)
1014
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
1015
self.cooked_conflicts.append(c)
1017
for trans_id, conflicts in name_conflicts.iteritems():
1019
this_parent, other_parent = conflicts['parent conflict']
1020
assert this_parent != other_parent
1022
this_parent = other_parent = \
1023
self.tt.final_file_id(self.tt.final_parent(trans_id))
1025
this_name, other_name = conflicts['name conflict']
1026
assert this_name != other_name
1028
this_name = other_name = self.tt.final_name(trans_id)
1029
other_path = fp.get_path(trans_id)
1030
if this_parent is not None and this_name is not None:
1031
this_parent_path = \
1032
fp.get_path(self.tt.trans_id_file_id(this_parent))
1033
this_path = pathjoin(this_parent_path, this_name)
1630
raise AssertionError('bad conflict type: %r' % (conflict,))
1631
cooked_conflicts.append(c)
1633
self.cooked_conflicts = []
1634
# We want to get rid of path conflicts when a corresponding contents
1635
# conflict exists. This can occur when one branch deletes a file while
1636
# the other renames *and* modifies it. In this case, the content
1637
# conflict is enough.
1638
for c in cooked_conflicts:
1639
if (c.typestring == 'path conflict'
1640
and c.file_id in content_conflict_file_ids):
1035
this_path = "<deleted>"
1036
file_id = self.tt.final_file_id(trans_id)
1037
c = Conflict.factory('path conflict', path=this_path,
1038
conflict_path=other_path, file_id=file_id)
1642
1039
self.cooked_conflicts.append(c)
1643
self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1040
self.cooked_conflicts.sort(key=Conflict.sort_key)
1646
1043
class WeaveMerger(Merge3Merger):
1650
1047
supports_reverse_cherrypick = False
1651
1048
history_based = True
1653
def _generate_merge_plan(self, file_id, base):
1654
return self.this_tree.plan_file_merge(file_id, self.other_tree,
1050
def _merged_lines(self, file_id):
1051
"""Generate the merged lines.
1052
There is no distinction between lines that are meant to contain <<<<<<<
1056
base = self.base_tree
1059
plan = self.this_tree.plan_file_merge(file_id, self.other_tree,
1657
def _merged_lines(self, file_id):
1658
"""Generate the merged lines.
1659
There is no distinction between lines that are meant to contain <<<<<<<
1663
base = self.base_tree
1666
plan = self._generate_merge_plan(file_id, base)
1667
1061
if 'merge' in debug.debug_flags:
1668
1062
plan = list(plan)
1669
1063
trans_id = self.tt.trans_id_file_id(file_id)
1670
1064
name = self.tt.final_name(trans_id) + '.plan'
1671
contents = ('%11s|%s' % l for l in plan)
1065
contents = ('%10s|%s' % l for l in plan)
1672
1066
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1673
textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1674
'>>>>>>> MERGE-SOURCE\n')
1675
lines, conflicts = textmerge.merge_lines(self.reprocess)
1677
base_lines = textmerge.base_from_plan()
1680
return lines, base_lines
1067
textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1068
'>>>>>>> MERGE-SOURCE\n')
1069
return textmerge.merge_lines(self.reprocess)
1682
1071
def text_merge(self, file_id, trans_id):
1683
1072
"""Perform a (weave) text merge for a given file and file-id.
1684
1073
If conflicts are encountered, .THIS and .OTHER files will be emitted,
1685
1074
and a conflict will be noted.
1687
lines, base_lines = self._merged_lines(file_id)
1076
lines, conflicts = self._merged_lines(file_id)
1688
1077
lines = list(lines)
1689
# Note we're checking whether the OUTPUT is binary in this case,
1078
# Note we're checking whether the OUTPUT is binary in this case,
1690
1079
# because we don't want to get into weave merge guts.
1691
textfile.check_text_lines(lines)
1080
check_text_lines(lines)
1692
1081
self.tt.create_file(lines, trans_id)
1693
if base_lines is not None:
1695
1083
self._raw_conflicts.append(('text conflict', trans_id))
1696
1084
name = self.tt.final_name(trans_id)
1697
1085
parent_id = self.tt.final_parent(trans_id)
1698
file_group = self._dump_conflicts(name, parent_id, file_id,
1700
base_lines=base_lines)
1086
file_group = self._dump_conflicts(name, parent_id, file_id,
1701
1088
file_group.append(trans_id)
1704
1091
class LCAMerger(WeaveMerger):
1706
def _generate_merge_plan(self, file_id, base):
1707
return self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1093
def _merged_lines(self, file_id):
1094
"""Generate the merged lines.
1095
There is no distinction between lines that are meant to contain <<<<<<<
1099
base = self.base_tree
1102
plan = self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1104
if 'merge' in debug.debug_flags:
1106
trans_id = self.tt.trans_id_file_id(file_id)
1107
name = self.tt.final_name(trans_id) + '.plan'
1108
contents = ('%10s|%s' % l for l in plan)
1109
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1110
textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1111
'>>>>>>> MERGE-SOURCE\n')
1112
return textmerge.merge_lines(self.reprocess)
1710
1115
class Diff3Merger(Merge3Merger):
1711
1116
"""Three-way merger using external diff3 for text merging"""
1713
1118
def dump_file(self, temp_dir, name, tree, file_id):
1714
out_path = osutils.pathjoin(temp_dir, name)
1119
out_path = pathjoin(temp_dir, name)
1715
1120
out_file = open(out_path, "wb")
1717
1122
in_file = tree.get_file(file_id)
1750
1155
osutils.rmtree(temp_dir)
1753
class PathNotInTree(errors.BzrError):
1755
_fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
1757
def __init__(self, path, tree):
1758
errors.BzrError.__init__(self, path=path, tree=tree)
1761
class MergeIntoMerger(Merger):
1762
"""Merger that understands other_tree will be merged into a subdir.
1764
This also changes the Merger api so that it uses real Branch, revision_id,
1765
and RevisonTree objects, rather than using revision specs.
1768
def __init__(self, this_tree, other_branch, other_tree, target_subdir,
1769
source_subpath, other_rev_id=None):
1770
"""Create a new MergeIntoMerger object.
1772
source_subpath in other_tree will be effectively copied to
1773
target_subdir in this_tree.
1775
:param this_tree: The tree that we will be merging into.
1776
:param other_branch: The Branch we will be merging from.
1777
:param other_tree: The RevisionTree object we want to merge.
1778
:param target_subdir: The relative path where we want to merge
1779
other_tree into this_tree
1780
:param source_subpath: The relative path specifying the subtree of
1781
other_tree to merge into this_tree.
1783
# It is assumed that we are merging a tree that is not in our current
1784
# ancestry, which means we are using the "EmptyTree" as our basis.
1785
null_ancestor_tree = this_tree.branch.repository.revision_tree(
1786
_mod_revision.NULL_REVISION)
1787
super(MergeIntoMerger, self).__init__(
1788
this_branch=this_tree.branch,
1789
this_tree=this_tree,
1790
other_tree=other_tree,
1791
base_tree=null_ancestor_tree,
1793
self._target_subdir = target_subdir
1794
self._source_subpath = source_subpath
1795
self.other_branch = other_branch
1796
if other_rev_id is None:
1797
other_rev_id = other_tree.get_revision_id()
1798
self.other_rev_id = self.other_basis = other_rev_id
1799
self.base_is_ancestor = True
1800
self.backup_files = True
1801
self.merge_type = Merge3Merger
1802
self.show_base = False
1803
self.reprocess = False
1804
self.interesting_ids = None
1805
self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
1806
target_subdir=self._target_subdir,
1807
source_subpath=self._source_subpath)
1808
if self._source_subpath != '':
1809
# If this isn't a partial merge make sure the revisions will be
1811
self._maybe_fetch(self.other_branch, self.this_branch,
1814
def set_pending(self):
1815
if self._source_subpath != '':
1817
Merger.set_pending(self)
1820
class _MergeTypeParameterizer(object):
1821
"""Wrap a merge-type class to provide extra parameters.
1823
This is hack used by MergeIntoMerger to pass some extra parameters to its
1824
merge_type. Merger.do_merge() sets up its own set of parameters to pass to
1825
the 'merge_type' member. It is difficult override do_merge without
1826
re-writing the whole thing, so instead we create a wrapper which will pass
1827
the extra parameters.
1830
def __init__(self, merge_type, **kwargs):
1831
self._extra_kwargs = kwargs
1832
self._merge_type = merge_type
1834
def __call__(self, *args, **kwargs):
1835
kwargs.update(self._extra_kwargs)
1836
return self._merge_type(*args, **kwargs)
1838
def __getattr__(self, name):
1839
return getattr(self._merge_type, name)
1842
class MergeIntoMergeType(Merge3Merger):
1843
"""Merger that incorporates a tree (or part of a tree) into another."""
1845
def __init__(self, *args, **kwargs):
1846
"""Initialize the merger object.
1848
:param args: See Merge3Merger.__init__'s args.
1849
:param kwargs: See Merge3Merger.__init__'s keyword args, except for
1850
source_subpath and target_subdir.
1851
:keyword source_subpath: The relative path specifying the subtree of
1852
other_tree to merge into this_tree.
1853
:keyword target_subdir: The relative path where we want to merge
1854
other_tree into this_tree
1856
# All of the interesting work happens during Merge3Merger.__init__(),
1857
# so we have have to hack in to get our extra parameters set.
1858
self._source_subpath = kwargs.pop('source_subpath')
1859
self._target_subdir = kwargs.pop('target_subdir')
1860
super(MergeIntoMergeType, self).__init__(*args, **kwargs)
1862
def _compute_transform(self):
1863
child_pb = ui.ui_factory.nested_progress_bar()
1865
entries = self._entries_to_incorporate()
1866
entries = list(entries)
1867
for num, (entry, parent_id) in enumerate(entries):
1868
child_pb.update(gettext('Preparing file merge'), num, len(entries))
1869
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1870
trans_id = transform.new_by_entry(self.tt, entry,
1871
parent_trans_id, self.other_tree)
1874
self._finish_computing_transform()
1876
def _entries_to_incorporate(self):
1877
"""Yields pairs of (inventory_entry, new_parent)."""
1878
other_inv = self.other_tree.root_inventory
1879
subdir_id = other_inv.path2id(self._source_subpath)
1880
if subdir_id is None:
1881
# XXX: The error would be clearer if it gave the URL of the source
1882
# branch, but we don't have a reference to that here.
1883
raise PathNotInTree(self._source_subpath, "Source tree")
1884
subdir = other_inv[subdir_id]
1885
parent_in_target = osutils.dirname(self._target_subdir)
1886
target_id = self.this_tree.path2id(parent_in_target)
1887
if target_id is None:
1888
raise PathNotInTree(self._target_subdir, "Target tree")
1889
name_in_target = osutils.basename(self._target_subdir)
1890
merge_into_root = subdir.copy()
1891
merge_into_root.name = name_in_target
1892
if self.this_tree.has_id(merge_into_root.file_id):
1893
# Give the root a new file-id.
1894
# This can happen fairly easily if the directory we are
1895
# incorporating is the root, and both trees have 'TREE_ROOT' as
1896
# their root_id. Users will expect this to Just Work, so we
1897
# change the file-id here.
1898
# Non-root file-ids could potentially conflict too. That's really
1899
# an edge case, so we don't do anything special for those. We let
1900
# them cause conflicts.
1901
merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
1902
yield (merge_into_root, target_id)
1903
if subdir.kind != 'directory':
1904
# No children, so we are done.
1906
for ignored_path, entry in other_inv.iter_entries_by_dir(subdir_id):
1907
parent_id = entry.parent_id
1908
if parent_id == subdir.file_id:
1909
# The root's parent ID has changed, so make sure children of
1910
# the root refer to the new ID.
1911
parent_id = merge_into_root.file_id
1912
yield (entry, parent_id)
1915
1158
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1916
1159
backup_files=False,
1917
1160
merge_type=Merge3Merger,
2002
1231
yield status_a(revision, text)
2003
1232
for revision, text in annotated_b[b_cur:bi]:
2004
1233
yield status_b(revision, text)
2005
1235
# and now the matched section
2008
for text_a in plain_a[ai:a_cur]:
1238
for text_a, text_b in zip(plain_a[ai:a_cur], plain_b[bi:b_cur]):
1239
assert text_a == text_b
2009
1240
yield "unchanged", text_a
2012
1243
class _PlanMergeBase(object):
2014
def __init__(self, a_rev, b_rev, vf, key_prefix):
1245
def __init__(self, a_rev, b_rev, vf):
2017
1248
:param a_rev: Revision-id of one revision to merge
2018
1249
:param b_rev: Revision-id of the other revision to merge
2019
:param vf: A VersionedFiles containing both revisions
2020
:param key_prefix: A prefix for accessing keys in vf, typically
1250
:param vf: A versionedfile containing both revisions
2023
1252
self.a_rev = a_rev
2024
1253
self.b_rev = b_rev
1254
self.lines_a = vf.get_lines(a_rev)
1255
self.lines_b = vf.get_lines(b_rev)
2026
1257
self._last_lines = None
2027
1258
self._last_lines_revision_id = None
2028
1259
self._cached_matching_blocks = {}
2029
self._key_prefix = key_prefix
2030
self._precache_tip_lines()
2032
def _precache_tip_lines(self):
2033
lines = self.get_lines([self.a_rev, self.b_rev])
2034
self.lines_a = lines[self.a_rev]
2035
self.lines_b = lines[self.b_rev]
2037
def get_lines(self, revisions):
2038
"""Get lines for revisions from the backing VersionedFiles.
2040
:raises RevisionNotPresent: on absent texts.
2042
keys = [(self._key_prefix + (rev,)) for rev in revisions]
2044
for record in self.vf.get_record_stream(keys, 'unordered', True):
2045
if record.storage_kind == 'absent':
2046
raise errors.RevisionNotPresent(record.key, self.vf)
2047
result[record.key[-1]] = osutils.chunks_to_lines(
2048
record.get_bytes_as('chunked'))
2051
1261
def plan_merge(self):
2052
1262
"""Generate a 'plan' for merging the two revisions.
2163
1371
class _PlanMerge(_PlanMergeBase):
2164
1372
"""Plan an annotate merge using on-the-fly annotation"""
2166
def __init__(self, a_rev, b_rev, vf, key_prefix):
2167
super(_PlanMerge, self).__init__(a_rev, b_rev, vf, key_prefix)
2168
self.a_key = self._key_prefix + (self.a_rev,)
2169
self.b_key = self._key_prefix + (self.b_rev,)
2170
self.graph = _mod_graph.Graph(self.vf)
2171
heads = self.graph.heads((self.a_key, self.b_key))
2173
# one side dominates, so we can just return its values, yay for
2175
# Ideally we would know that before we get this far
2176
self._head_key = heads.pop()
2177
if self._head_key == self.a_key:
2181
trace.mutter('found dominating revision for %s\n%s > %s', self.vf,
2182
self._head_key[-1], other)
2185
self._head_key = None
2188
def _precache_tip_lines(self):
2189
# Turn this into a no-op, because we will do this later
2192
def _find_recursive_lcas(self):
2193
"""Find all the ancestors back to a unique lca"""
2194
cur_ancestors = (self.a_key, self.b_key)
2195
# graph.find_lca(uncommon, keys) now returns plain NULL_REVISION,
2196
# rather than a key tuple. We will just map that directly to no common
2200
next_lcas = self.graph.find_lca(*cur_ancestors)
2201
# Map a plain NULL_REVISION to a simple no-ancestors
2202
if next_lcas == set([_mod_revision.NULL_REVISION]):
2204
# Order the lca's based on when they were merged into the tip
2205
# While the actual merge portion of weave merge uses a set() of
2206
# active revisions, the order of insertion *does* effect the
2207
# implicit ordering of the texts.
2208
for rev_key in cur_ancestors:
2209
ordered_parents = tuple(self.graph.find_merge_order(rev_key,
2211
parent_map[rev_key] = ordered_parents
2212
if len(next_lcas) == 0:
2214
elif len(next_lcas) == 1:
2215
parent_map[list(next_lcas)[0]] = ()
2217
elif len(next_lcas) > 2:
2218
# More than 2 lca's, fall back to grabbing all nodes between
2219
# this and the unique lca.
2220
trace.mutter('More than 2 LCAs, falling back to all nodes for:'
2222
self.a_key, self.b_key, cur_ancestors)
2223
cur_lcas = next_lcas
2224
while len(cur_lcas) > 1:
2225
cur_lcas = self.graph.find_lca(*cur_lcas)
2226
if len(cur_lcas) == 0:
2227
# No common base to find, use the full ancestry
2230
unique_lca = list(cur_lcas)[0]
2231
if unique_lca == _mod_revision.NULL_REVISION:
2232
# find_lca will return a plain 'NULL_REVISION' rather
2233
# than a key tuple when there is no common ancestor, we
2234
# prefer to just use None, because it doesn't confuse
2235
# _get_interesting_texts()
2237
parent_map.update(self._find_unique_parents(next_lcas,
2240
cur_ancestors = next_lcas
2243
def _find_unique_parents(self, tip_keys, base_key):
2244
"""Find ancestors of tip that aren't ancestors of base.
2246
:param tip_keys: Nodes that are interesting
2247
:param base_key: Cull all ancestors of this node
2248
:return: The parent map for all revisions between tip_keys and
2249
base_key. base_key will be included. References to nodes outside of
2250
the ancestor set will also be removed.
2252
# TODO: this would be simpler if find_unique_ancestors took a list
2253
# instead of a single tip, internally it supports it, but it
2254
# isn't a "backwards compatible" api change.
2255
if base_key is None:
2256
parent_map = dict(self.graph.iter_ancestry(tip_keys))
2257
# We remove NULL_REVISION because it isn't a proper tuple key, and
2258
# thus confuses things like _get_interesting_texts, and our logic
2259
# to add the texts into the memory weave.
2260
if _mod_revision.NULL_REVISION in parent_map:
2261
parent_map.pop(_mod_revision.NULL_REVISION)
2264
for tip in tip_keys:
2266
self.graph.find_unique_ancestors(tip, [base_key]))
2267
parent_map = self.graph.get_parent_map(interesting)
2268
parent_map[base_key] = ()
2269
culled_parent_map, child_map, tails = self._remove_external_references(
2271
# Remove all the tails but base_key
2272
if base_key is not None:
2273
tails.remove(base_key)
2274
self._prune_tails(culled_parent_map, child_map, tails)
2275
# Now remove all the uninteresting 'linear' regions
2276
simple_map = _mod_graph.collapse_linear_regions(culled_parent_map)
2280
def _remove_external_references(parent_map):
2281
"""Remove references that go outside of the parent map.
2283
:param parent_map: Something returned from Graph.get_parent_map(keys)
2284
:return: (filtered_parent_map, child_map, tails)
2285
filtered_parent_map is parent_map without external references
2286
child_map is the {parent_key: [child_keys]} mapping
2287
tails is a list of nodes that do not have any parents in the map
2289
# TODO: The basic effect of this function seems more generic than
2290
# _PlanMerge. But the specific details of building a child_map,
2291
# and computing tails seems very specific to _PlanMerge.
2292
# Still, should this be in Graph land?
2293
filtered_parent_map = {}
2296
for key, parent_keys in parent_map.iteritems():
2297
culled_parent_keys = [p for p in parent_keys if p in parent_map]
2298
if not culled_parent_keys:
2300
for parent_key in culled_parent_keys:
2301
child_map.setdefault(parent_key, []).append(key)
2302
# TODO: Do we want to do this, it adds overhead for every node,
2303
# just to say that the node has no children
2304
child_map.setdefault(key, [])
2305
filtered_parent_map[key] = culled_parent_keys
2306
return filtered_parent_map, child_map, tails
2309
def _prune_tails(parent_map, child_map, tails_to_remove):
2310
"""Remove tails from the parent map.
2312
This will remove the supplied revisions until no more children have 0
2315
:param parent_map: A dict of {child: [parents]}, this dictionary will
2316
be modified in place.
2317
:param tails_to_remove: A list of tips that should be removed,
2318
this list will be consumed
2319
:param child_map: The reverse dict of parent_map ({parent: [children]})
2320
this dict will be modified
2321
:return: None, parent_map will be modified in place.
2323
while tails_to_remove:
2324
next = tails_to_remove.pop()
2325
parent_map.pop(next)
2326
children = child_map.pop(next)
2327
for child in children:
2328
child_parents = parent_map[child]
2329
child_parents.remove(next)
2330
if len(child_parents) == 0:
2331
tails_to_remove.append(child)
2333
def _get_interesting_texts(self, parent_map):
2334
"""Return a dict of texts we are interested in.
2336
Note that the input is in key tuples, but the output is in plain
2339
:param parent_map: The output from _find_recursive_lcas
2340
:return: A dict of {'revision_id':lines} as returned by
2341
_PlanMergeBase.get_lines()
2343
all_revision_keys = set(parent_map)
2344
all_revision_keys.add(self.a_key)
2345
all_revision_keys.add(self.b_key)
2347
# Everything else is in 'keys' but get_lines is in 'revision_ids'
2348
all_texts = self.get_lines([k[-1] for k in all_revision_keys])
2351
def _build_weave(self):
2352
from bzrlib import weave
2353
self._weave = weave.Weave(weave_name='in_memory_weave',
2354
allow_reserved=True)
2355
parent_map = self._find_recursive_lcas()
2357
all_texts = self._get_interesting_texts(parent_map)
2359
# Note: Unfortunately, the order given by topo_sort will effect the
2360
# ordering resolution in the output. Specifically, if you add A then B,
2361
# then in the output text A lines will show up before B lines. And, of
2362
# course, topo_sort doesn't guarantee any real ordering.
2363
# So we use merge_sort, and add a fake node on the tip.
2364
# This ensures that left-hand parents will always be inserted into the
2365
# weave before right-hand parents.
2366
tip_key = self._key_prefix + (_mod_revision.CURRENT_REVISION,)
2367
parent_map[tip_key] = (self.a_key, self.b_key)
2369
for seq_num, key, depth, eom in reversed(tsort.merge_sort(parent_map,
2373
# for key in tsort.topo_sort(parent_map):
2374
parent_keys = parent_map[key]
2375
revision_id = key[-1]
2376
parent_ids = [k[-1] for k in parent_keys]
2377
self._weave.add_lines(revision_id, parent_ids,
2378
all_texts[revision_id])
2380
def plan_merge(self):
2381
"""Generate a 'plan' for merging the two revisions.
2383
This involves comparing their texts and determining the cause of
2384
differences. If text A has a line and text B does not, then either the
2385
line was added to text A, or it was deleted from B. Once the causes
2386
are combined, they are written out in the format described in
2387
VersionedFile.plan_merge
2389
if self._head_key is not None: # There was a single head
2390
if self._head_key == self.a_key:
2393
if self._head_key != self.b_key:
2394
raise AssertionError('There was an invalid head: %s != %s'
2395
% (self.b_key, self._head_key))
2397
head_rev = self._head_key[-1]
2398
lines = self.get_lines([head_rev])[head_rev]
2399
return ((plan, line) for line in lines)
2400
return self._weave.plan_merge(self.a_rev, self.b_rev)
1374
def __init__(self, a_rev, b_rev, vf):
1375
_PlanMergeBase.__init__(self, a_rev, b_rev, vf)
1376
a_ancestry = set(vf.get_ancestry(a_rev, topo_sorted=False))
1377
b_ancestry = set(vf.get_ancestry(b_rev, topo_sorted=False))
1378
self.uncommon = a_ancestry.symmetric_difference(b_ancestry)
1380
def _determine_status(self, revision_id, unique_line_numbers):
1381
"""Determines the status unique lines versus all lcas.
1383
Basically, determines why the line is unique to this revision.
1385
A line may be determined new or killed, but not both.
1387
:param revision_id: The id of the revision in which the lines are
1389
:param unique_line_numbers: The line numbers of unique lines.
1390
:return a tuple of (new_this, killed_other):
1392
new = self._find_new(revision_id)
1393
killed = set(unique_line_numbers).difference(new)
1396
def _find_new(self, version_id):
1397
"""Determine which lines are new in the ancestry of this version.
1399
If a lines is present in this version, and not present in any
1400
common ancestor, it is considered new.
1402
if version_id not in self.uncommon:
1404
parents = self.vf.get_parents(version_id)
1405
if len(parents) == 0:
1406
return set(range(len(self.vf.get_lines(version_id))))
1408
for parent in parents:
1409
blocks = self._get_matching_blocks(version_id, parent)
1410
result, unused = self._unique_lines(blocks)
1411
parent_new = self._find_new(parent)
1412
for i, j, n in blocks:
1413
for ii, jj in [(i+r, j+r) for r in range(n)]:
1414
if jj in parent_new:
1419
new.intersection_update(result)
2403
1423
class _PlanLCAMerge(_PlanMergeBase):
2405
1425
This merge algorithm differs from _PlanMerge in that:
2407
1426
1. comparisons are done against LCAs only
2408
1427
2. cases where a contested line is new versus one LCA but old versus
2409
1428
another are marked as conflicts, by emitting the line as conflicted-a
added
removed
bzrlib/merge.py
