1
# Copyright (C) 2005-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20
branch as _mod_branch,
21
conflicts as _mod_conflicts,
30
revision as _mod_revision,
39
from bzrlib.cleanup import OperationWithCleanups
40
from bzrlib.symbol_versioning import (
44
# TODO: Report back as changes are merged in
47
def transform_tree(from_tree, to_tree, interesting_ids=None):
48
from_tree.lock_tree_write()
49
operation = OperationWithCleanups(merge_inner)
50
operation.add_cleanup(from_tree.unlock)
51
operation.run_simple(from_tree.branch, to_tree, from_tree,
52
ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
55
class MergeHooks(hooks.Hooks):
58
hooks.Hooks.__init__(self)
59
self.create_hook(hooks.HookPoint('merge_file_content',
60
"Called with a bzrlib.merge.Merger object to create a per file "
61
"merge object when starting a merge. "
62
"Should return either None or a subclass of "
63
"``bzrlib.merge.AbstractPerFileMerger``. "
64
"Such objects will then be called per file "
65
"that needs to be merged (including when one "
66
"side has deleted the file and the other has changed it). "
67
"See the AbstractPerFileMerger API docs for details on how it is "
72
class AbstractPerFileMerger(object):
73
"""PerFileMerger objects are used by plugins extending merge for bzrlib.
75
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
77
:ivar merger: The Merge3Merger performing the merge.
80
def __init__(self, merger):
81
"""Create a PerFileMerger for use with merger."""
84
def merge_contents(self, merge_params):
85
"""Attempt to merge the contents of a single file.
87
:param merge_params: A bzrlib.merge.MergeHookParams
88
:return : A tuple of (status, chunks), where status is one of
89
'not_applicable', 'success', 'conflicted', or 'delete'. If status
90
is 'success' or 'conflicted', then chunks should be an iterable of
91
strings for the new file contents.
93
return ('not applicable', None)
96
class ConfigurableFileMerger(AbstractPerFileMerger):
97
"""Merge individual files when configured via a .conf file.
99
This is a base class for concrete custom file merging logic. Concrete
100
classes should implement ``merge_text``.
102
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
104
:ivar affected_files: The configured file paths to merge.
106
:cvar name_prefix: The prefix to use when looking up configuration
107
details. <name_prefix>_merge_files describes the files targeted by the
110
:cvar default_files: The default file paths to merge when no configuration
117
def __init__(self, merger):
118
super(ConfigurableFileMerger, self).__init__(merger)
119
self.affected_files = None
120
self.default_files = self.__class__.default_files or []
121
self.name_prefix = self.__class__.name_prefix
122
if self.name_prefix is None:
123
raise ValueError("name_prefix must be set.")
125
def filename_matches_config(self, params):
126
"""Check whether the file should call the merge hook.
128
<name_prefix>_merge_files configuration variable is a list of files
129
that should use the hook.
131
affected_files = self.affected_files
132
if affected_files is None:
133
config = self.merger.this_branch.get_config()
134
# Until bzr provides a better policy for caching the config, we
135
# just add the part we're interested in to the params to avoid
136
# reading the config files repeatedly (bazaar.conf, location.conf,
138
config_key = self.name_prefix + '_merge_files'
139
affected_files = config.get_user_option_as_list(config_key)
140
if affected_files is None:
141
# If nothing was specified in the config, use the default.
142
affected_files = self.default_files
143
self.affected_files = affected_files
145
filename = self.merger.this_tree.id2path(params.file_id)
146
if filename in affected_files:
150
def merge_contents(self, params):
151
"""Merge the contents of a single file."""
152
# First, check whether this custom merge logic should be used. We
153
# expect most files should not be merged by this handler.
155
# OTHER is a straight winner, rely on default merge.
156
params.winner == 'other' or
157
# THIS and OTHER aren't both files.
158
not params.is_file_merge() or
159
# The filename isn't listed in the 'NAME_merge_files' config
161
not self.filename_matches_config(params)):
162
return 'not_applicable', None
163
return self.merge_text(params)
165
def merge_text(self, params):
166
"""Merge the byte contents of a single file.
168
This is called after checking that the merge should be performed in
169
merge_contents, and it should behave as per
170
``bzrlib.merge.AbstractPerFileMerger.merge_contents``.
172
raise NotImplementedError(self.merge_text)
175
class MergeHookParams(object):
176
"""Object holding parameters passed to merge_file_content hooks.
178
There are some fields hooks can access:
180
:ivar file_id: the file ID of the file being merged
181
:ivar trans_id: the transform ID for the merge of this file
182
:ivar this_kind: kind of file_id in 'this' tree
183
:ivar other_kind: kind of file_id in 'other' tree
184
:ivar winner: one of 'this', 'other', 'conflict'
187
def __init__(self, merger, file_id, trans_id, this_kind, other_kind,
189
self._merger = merger
190
self.file_id = file_id
191
self.trans_id = trans_id
192
self.this_kind = this_kind
193
self.other_kind = other_kind
196
def is_file_merge(self):
197
"""True if this_kind and other_kind are both 'file'."""
198
return self.this_kind == 'file' and self.other_kind == 'file'
200
@decorators.cachedproperty
201
def base_lines(self):
202
"""The lines of the 'base' version of the file."""
203
return self._merger.get_lines(self._merger.base_tree, self.file_id)
205
@decorators.cachedproperty
206
def this_lines(self):
207
"""The lines of the 'this' version of the file."""
208
return self._merger.get_lines(self._merger.this_tree, self.file_id)
210
@decorators.cachedproperty
211
def other_lines(self):
212
"""The lines of the 'other' version of the file."""
213
return self._merger.get_lines(self._merger.other_tree, self.file_id)
216
class Merger(object):
220
def __init__(self, this_branch, other_tree=None, base_tree=None,
221
this_tree=None, pb=None, change_reporter=None,
222
recurse='down', revision_graph=None):
223
object.__init__(self)
224
self.this_branch = this_branch
225
self.this_basis = _mod_revision.ensure_null(
226
this_branch.last_revision())
227
self.this_rev_id = None
228
self.this_tree = this_tree
229
self.this_revision_tree = None
230
self.this_basis_tree = None
231
self.other_tree = other_tree
232
self.other_branch = None
233
self.base_tree = base_tree
234
self.ignore_zero = False
235
self.backup_files = False
236
self.interesting_ids = None
237
self.interesting_files = None
238
self.show_base = False
239
self.reprocess = False
241
warnings.warn("pb parameter to Merger() is deprecated and ignored")
243
self.recurse = recurse
244
self.change_reporter = change_reporter
245
self._cached_trees = {}
246
self._revision_graph = revision_graph
247
self._base_is_ancestor = None
248
self._base_is_other_ancestor = None
249
self._is_criss_cross = None
250
self._lca_trees = None
252
def cache_trees_with_revision_ids(self, trees):
253
"""Cache any tree in trees if it has a revision_id."""
254
for maybe_tree in trees:
255
if maybe_tree is None:
258
rev_id = maybe_tree.get_revision_id()
259
except AttributeError:
261
self._cached_trees[rev_id] = maybe_tree
264
def revision_graph(self):
265
if self._revision_graph is None:
266
self._revision_graph = self.this_branch.repository.get_graph()
267
return self._revision_graph
269
def _set_base_is_ancestor(self, value):
270
self._base_is_ancestor = value
272
def _get_base_is_ancestor(self):
273
if self._base_is_ancestor is None:
274
self._base_is_ancestor = self.revision_graph.is_ancestor(
275
self.base_rev_id, self.this_basis)
276
return self._base_is_ancestor
278
base_is_ancestor = property(_get_base_is_ancestor, _set_base_is_ancestor)
280
def _set_base_is_other_ancestor(self, value):
281
self._base_is_other_ancestor = value
283
def _get_base_is_other_ancestor(self):
284
if self._base_is_other_ancestor is None:
285
if self.other_basis is None:
287
self._base_is_other_ancestor = self.revision_graph.is_ancestor(
288
self.base_rev_id, self.other_basis)
289
return self._base_is_other_ancestor
291
base_is_other_ancestor = property(_get_base_is_other_ancestor,
292
_set_base_is_other_ancestor)
295
def from_uncommitted(tree, other_tree, pb=None, base_tree=None):
296
"""Return a Merger for uncommitted changes in other_tree.
298
:param tree: The tree to merge into
299
:param other_tree: The tree to get uncommitted changes from
300
:param pb: A progress indicator
301
:param base_tree: The basis to use for the merge. If unspecified,
302
other_tree.basis_tree() will be used.
304
if base_tree is None:
305
base_tree = other_tree.basis_tree()
306
merger = Merger(tree.branch, other_tree, base_tree, tree, pb)
307
merger.base_rev_id = merger.base_tree.get_revision_id()
308
merger.other_rev_id = None
309
merger.other_basis = merger.base_rev_id
313
def from_mergeable(klass, tree, mergeable, pb):
314
"""Return a Merger for a bundle or merge directive.
316
:param tree: The tree to merge changes into
317
:param mergeable: A merge directive or bundle
318
:param pb: A progress indicator
320
mergeable.install_revisions(tree.branch.repository)
321
base_revision_id, other_revision_id, verified =\
322
mergeable.get_merge_request(tree.branch.repository)
323
revision_graph = tree.branch.repository.get_graph()
324
if base_revision_id is not None:
325
if (base_revision_id != _mod_revision.NULL_REVISION and
326
revision_graph.is_ancestor(
327
base_revision_id, tree.branch.last_revision())):
328
base_revision_id = None
330
trace.warning('Performing cherrypick')
331
merger = klass.from_revision_ids(pb, tree, other_revision_id,
332
base_revision_id, revision_graph=
334
return merger, verified
337
def from_revision_ids(pb, tree, other, base=None, other_branch=None,
338
base_branch=None, revision_graph=None,
340
"""Return a Merger for revision-ids.
342
:param pb: A progress indicator
343
:param tree: The tree to merge changes into
344
:param other: The revision-id to use as OTHER
345
:param base: The revision-id to use as BASE. If not specified, will
347
:param other_branch: A branch containing the other revision-id. If
348
not supplied, tree.branch is used.
349
:param base_branch: A branch containing the base revision-id. If
350
not supplied, other_branch or tree.branch will be used.
351
:param revision_graph: If you have a revision_graph precomputed, pass
352
it in, otherwise it will be created for you.
353
:param tree_branch: The branch associated with tree. If not supplied,
354
tree.branch will be used.
356
if tree_branch is None:
357
tree_branch = tree.branch
358
merger = Merger(tree_branch, this_tree=tree, pb=pb,
359
revision_graph=revision_graph)
360
if other_branch is None:
361
other_branch = tree.branch
362
merger.set_other_revision(other, other_branch)
366
if base_branch is None:
367
base_branch = other_branch
368
merger.set_base_revision(base, base_branch)
371
def revision_tree(self, revision_id, branch=None):
372
if revision_id not in self._cached_trees:
374
branch = self.this_branch
376
tree = self.this_tree.revision_tree(revision_id)
377
except errors.NoSuchRevisionInTree:
378
tree = branch.repository.revision_tree(revision_id)
379
self._cached_trees[revision_id] = tree
380
return self._cached_trees[revision_id]
382
def _get_tree(self, treespec, possible_transports=None):
383
from bzrlib import workingtree
384
location, revno = treespec
386
tree = workingtree.WorkingTree.open_containing(location)[0]
387
return tree.branch, tree
388
branch = _mod_branch.Branch.open_containing(
389
location, possible_transports)[0]
391
revision_id = branch.last_revision()
393
revision_id = branch.get_rev_id(revno)
394
revision_id = _mod_revision.ensure_null(revision_id)
395
return branch, self.revision_tree(revision_id, branch)
397
@deprecated_method(deprecated_in((2, 1, 0)))
398
def ensure_revision_trees(self):
399
if self.this_revision_tree is None:
400
self.this_basis_tree = self.revision_tree(self.this_basis)
401
if self.this_basis == self.this_rev_id:
402
self.this_revision_tree = self.this_basis_tree
404
if self.other_rev_id is None:
405
other_basis_tree = self.revision_tree(self.other_basis)
406
if other_basis_tree.has_changes(self.other_tree):
407
raise errors.WorkingTreeNotRevision(self.this_tree)
408
other_rev_id = self.other_basis
409
self.other_tree = other_basis_tree
411
@deprecated_method(deprecated_in((2, 1, 0)))
412
def file_revisions(self, file_id):
413
self.ensure_revision_trees()
414
def get_id(tree, file_id):
415
revision_id = tree.inventory[file_id].revision
417
if self.this_rev_id is None:
418
if self.this_basis_tree.get_file_sha1(file_id) != \
419
self.this_tree.get_file_sha1(file_id):
420
raise errors.WorkingTreeNotRevision(self.this_tree)
422
trees = (self.this_basis_tree, self.other_tree)
423
return [get_id(tree, file_id) for tree in trees]
425
@deprecated_method(deprecated_in((2, 1, 0)))
426
def check_basis(self, check_clean, require_commits=True):
427
if self.this_basis is None and require_commits is True:
428
raise errors.BzrCommandError(
429
"This branch has no commits."
430
" (perhaps you would prefer 'bzr pull')")
433
if self.this_basis != self.this_rev_id:
434
raise errors.UncommittedChanges(self.this_tree)
436
@deprecated_method(deprecated_in((2, 1, 0)))
437
def compare_basis(self):
439
basis_tree = self.revision_tree(self.this_tree.last_revision())
440
except errors.NoSuchRevision:
441
basis_tree = self.this_tree.basis_tree()
442
if not self.this_tree.has_changes(basis_tree):
443
self.this_rev_id = self.this_basis
445
def set_interesting_files(self, file_list):
446
self.interesting_files = file_list
448
def set_pending(self):
449
if (not self.base_is_ancestor or not self.base_is_other_ancestor
450
or self.other_rev_id is None):
454
def _add_parent(self):
455
new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
456
new_parent_trees = []
457
operation = OperationWithCleanups(self.this_tree.set_parent_trees)
458
for revision_id in new_parents:
460
tree = self.revision_tree(revision_id)
461
except errors.NoSuchRevision:
465
operation.add_cleanup(tree.unlock)
466
new_parent_trees.append((revision_id, tree))
467
operation.run_simple(new_parent_trees, allow_leftmost_as_ghost=True)
469
def set_other(self, other_revision, possible_transports=None):
470
"""Set the revision and tree to merge from.
472
This sets the other_tree, other_rev_id, other_basis attributes.
474
:param other_revision: The [path, revision] list to merge from.
476
self.other_branch, self.other_tree = self._get_tree(other_revision,
478
if other_revision[1] == -1:
479
self.other_rev_id = _mod_revision.ensure_null(
480
self.other_branch.last_revision())
481
if _mod_revision.is_null(self.other_rev_id):
482
raise errors.NoCommits(self.other_branch)
483
self.other_basis = self.other_rev_id
484
elif other_revision[1] is not None:
485
self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
486
self.other_basis = self.other_rev_id
488
self.other_rev_id = None
489
self.other_basis = self.other_branch.last_revision()
490
if self.other_basis is None:
491
raise errors.NoCommits(self.other_branch)
492
if self.other_rev_id is not None:
493
self._cached_trees[self.other_rev_id] = self.other_tree
494
self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
496
def set_other_revision(self, revision_id, other_branch):
497
"""Set 'other' based on a branch and revision id
499
:param revision_id: The revision to use for a tree
500
:param other_branch: The branch containing this tree
502
self.other_rev_id = revision_id
503
self.other_branch = other_branch
504
self._maybe_fetch(other_branch, self.this_branch, self.other_rev_id)
505
self.other_tree = self.revision_tree(revision_id)
506
self.other_basis = revision_id
508
def set_base_revision(self, revision_id, branch):
509
"""Set 'base' based on a branch and revision id
511
:param revision_id: The revision to use for a tree
512
:param branch: The branch containing this tree
514
self.base_rev_id = revision_id
515
self.base_branch = branch
516
self._maybe_fetch(branch, self.this_branch, revision_id)
517
self.base_tree = self.revision_tree(revision_id)
519
def _maybe_fetch(self, source, target, revision_id):
520
if not source.repository.has_same_location(target.repository):
521
target.fetch(source, revision_id)
524
revisions = [_mod_revision.ensure_null(self.this_basis),
525
_mod_revision.ensure_null(self.other_basis)]
526
if _mod_revision.NULL_REVISION in revisions:
527
self.base_rev_id = _mod_revision.NULL_REVISION
528
self.base_tree = self.revision_tree(self.base_rev_id)
529
self._is_criss_cross = False
531
lcas = self.revision_graph.find_lca(revisions[0], revisions[1])
532
self._is_criss_cross = False
534
self.base_rev_id = _mod_revision.NULL_REVISION
536
self.base_rev_id = list(lcas)[0]
537
else: # len(lcas) > 1
539
# find_unique_lca can only handle 2 nodes, so we have to
540
# start back at the beginning. It is a shame to traverse
541
# the graph again, but better than re-implementing
543
self.base_rev_id = self.revision_graph.find_unique_lca(
544
revisions[0], revisions[1])
546
self.base_rev_id = self.revision_graph.find_unique_lca(
548
self._is_criss_cross = True
549
if self.base_rev_id == _mod_revision.NULL_REVISION:
550
raise errors.UnrelatedBranches()
551
if self._is_criss_cross:
552
trace.warning('Warning: criss-cross merge encountered. See bzr'
553
' help criss-cross.')
554
trace.mutter('Criss-cross lcas: %r' % lcas)
555
interesting_revision_ids = [self.base_rev_id]
556
interesting_revision_ids.extend(lcas)
557
interesting_trees = dict((t.get_revision_id(), t)
558
for t in self.this_branch.repository.revision_trees(
559
interesting_revision_ids))
560
self._cached_trees.update(interesting_trees)
561
self.base_tree = interesting_trees.pop(self.base_rev_id)
562
sorted_lca_keys = self.revision_graph.find_merge_order(
564
self._lca_trees = [interesting_trees[key]
565
for key in sorted_lca_keys]
567
self.base_tree = self.revision_tree(self.base_rev_id)
568
self.base_is_ancestor = True
569
self.base_is_other_ancestor = True
570
trace.mutter('Base revid: %r' % self.base_rev_id)
572
def set_base(self, base_revision):
573
"""Set the base revision to use for the merge.
575
:param base_revision: A 2-list containing a path and revision number.
577
trace.mutter("doing merge() with no base_revision specified")
578
if base_revision == [None, None]:
581
base_branch, self.base_tree = self._get_tree(base_revision)
582
if base_revision[1] == -1:
583
self.base_rev_id = base_branch.last_revision()
584
elif base_revision[1] is None:
585
self.base_rev_id = _mod_revision.NULL_REVISION
587
self.base_rev_id = _mod_revision.ensure_null(
588
base_branch.get_rev_id(base_revision[1]))
589
self._maybe_fetch(base_branch, self.this_branch, self.base_rev_id)
591
def make_merger(self):
592
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
593
'other_tree': self.other_tree,
594
'interesting_ids': self.interesting_ids,
595
'interesting_files': self.interesting_files,
596
'this_branch': self.this_branch,
598
if self.merge_type.requires_base:
599
kwargs['base_tree'] = self.base_tree
600
if self.merge_type.supports_reprocess:
601
kwargs['reprocess'] = self.reprocess
603
raise errors.BzrError(
604
"Conflict reduction is not supported for merge"
605
" type %s." % self.merge_type)
606
if self.merge_type.supports_show_base:
607
kwargs['show_base'] = self.show_base
609
raise errors.BzrError("Showing base is not supported for this"
610
" merge type. %s" % self.merge_type)
611
if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
612
and not self.base_is_other_ancestor):
613
raise errors.CannotReverseCherrypick()
614
if self.merge_type.supports_cherrypick:
615
kwargs['cherrypick'] = (not self.base_is_ancestor or
616
not self.base_is_other_ancestor)
617
if self._is_criss_cross and getattr(self.merge_type,
618
'supports_lca_trees', False):
619
kwargs['lca_trees'] = self._lca_trees
620
return self.merge_type(pb=None,
621
change_reporter=self.change_reporter,
624
def _do_merge_to(self):
625
merge = self.make_merger()
626
if self.other_branch is not None:
627
self.other_branch.update_references(self.this_branch)
629
if self.recurse == 'down':
630
for relpath, file_id in self.this_tree.iter_references():
631
sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
632
other_revision = self.other_tree.get_reference_revision(
634
if other_revision == sub_tree.last_revision():
636
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
637
sub_merge.merge_type = self.merge_type
638
other_branch = self.other_branch.reference_parent(file_id, relpath)
639
sub_merge.set_other_revision(other_revision, other_branch)
640
base_revision = self.base_tree.get_reference_revision(file_id)
641
sub_merge.base_tree = \
642
sub_tree.branch.repository.revision_tree(base_revision)
643
sub_merge.base_rev_id = base_revision
648
operation = OperationWithCleanups(self._do_merge_to)
649
self.this_tree.lock_tree_write()
650
operation.add_cleanup(self.this_tree.unlock)
651
if self.base_tree is not None:
652
self.base_tree.lock_read()
653
operation.add_cleanup(self.base_tree.unlock)
654
if self.other_tree is not None:
655
self.other_tree.lock_read()
656
operation.add_cleanup(self.other_tree.unlock)
657
merge = operation.run_simple()
658
if len(merge.cooked_conflicts) == 0:
659
if not self.ignore_zero and not trace.is_quiet():
660
trace.note("All changes applied successfully.")
662
trace.note("%d conflicts encountered."
663
% len(merge.cooked_conflicts))
665
return len(merge.cooked_conflicts)
668
class _InventoryNoneEntry(object):
669
"""This represents an inventory entry which *isn't there*.
671
It simplifies the merging logic if we always have an InventoryEntry, even
672
if it isn't actually present
679
symlink_target = None
682
_none_entry = _InventoryNoneEntry()
685
class Merge3Merger(object):
686
"""Three-way merger that uses the merge3 text merger"""
688
supports_reprocess = True
689
supports_show_base = True
690
history_based = False
691
supports_cherrypick = True
692
supports_reverse_cherrypick = True
693
winner_idx = {"this": 2, "other": 1, "conflict": 1}
694
supports_lca_trees = True
696
def __init__(self, working_tree, this_tree, base_tree, other_tree,
697
interesting_ids=None, reprocess=False, show_base=False,
698
pb=None, pp=None, change_reporter=None,
699
interesting_files=None, do_merge=True,
700
cherrypick=False, lca_trees=None, this_branch=None):
701
"""Initialize the merger object and perform the merge.
703
:param working_tree: The working tree to apply the merge to
704
:param this_tree: The local tree in the merge operation
705
:param base_tree: The common tree in the merge operation
706
:param other_tree: The other tree to merge changes from
707
:param this_branch: The branch associated with this_tree. Defaults to
708
this_tree.branch if not supplied.
709
:param interesting_ids: The file_ids of files that should be
710
participate in the merge. May not be combined with
712
:param: reprocess If True, perform conflict-reduction processing.
713
:param show_base: If True, show the base revision in text conflicts.
714
(incompatible with reprocess)
716
:param pp: A ProgressPhase object
717
:param change_reporter: An object that should report changes made
718
:param interesting_files: The tree-relative paths of files that should
719
participate in the merge. If these paths refer to directories,
720
the contents of those directories will also be included. May not
721
be combined with interesting_ids. If neither interesting_files nor
722
interesting_ids is specified, all files may participate in the
724
:param lca_trees: Can be set to a dictionary of {revision_id:rev_tree}
725
if the ancestry was found to include a criss-cross merge.
726
Otherwise should be None.
728
object.__init__(self)
729
if interesting_files is not None and interesting_ids is not None:
731
'specify either interesting_ids or interesting_files')
732
if this_branch is None:
733
this_branch = this_tree.branch
734
self.interesting_ids = interesting_ids
735
self.interesting_files = interesting_files
736
self.this_tree = working_tree
737
self.base_tree = base_tree
738
self.other_tree = other_tree
739
self.this_branch = this_branch
740
self._raw_conflicts = []
741
self.cooked_conflicts = []
742
self.reprocess = reprocess
743
self.show_base = show_base
744
self._lca_trees = lca_trees
745
# Uncommenting this will change the default algorithm to always use
746
# _entries_lca. This can be useful for running the test suite and
747
# making sure we haven't missed any corner cases.
748
# if lca_trees is None:
749
# self._lca_trees = [self.base_tree]
750
self.change_reporter = change_reporter
751
self.cherrypick = cherrypick
755
warnings.warn("pp argument to Merge3Merger is deprecated")
757
warnings.warn("pb argument to Merge3Merger is deprecated")
760
operation = OperationWithCleanups(self._do_merge)
761
self.this_tree.lock_tree_write()
762
operation.add_cleanup(self.this_tree.unlock)
763
self.base_tree.lock_read()
764
operation.add_cleanup(self.base_tree.unlock)
765
self.other_tree.lock_read()
766
operation.add_cleanup(self.other_tree.unlock)
769
def _do_merge(self, operation):
770
self.tt = transform.TreeTransform(self.this_tree, None)
771
operation.add_cleanup(self.tt.finalize)
772
self._compute_transform()
773
results = self.tt.apply(no_conflicts=True)
774
self.write_modified(results)
776
self.this_tree.add_conflicts(self.cooked_conflicts)
777
except errors.UnsupportedOperation:
780
def make_preview_transform(self):
781
operation = OperationWithCleanups(self._make_preview_transform)
782
self.base_tree.lock_read()
783
operation.add_cleanup(self.base_tree.unlock)
784
self.other_tree.lock_read()
785
operation.add_cleanup(self.other_tree.unlock)
786
return operation.run_simple()
788
def _make_preview_transform(self):
789
self.tt = transform.TransformPreview(self.this_tree)
790
self._compute_transform()
793
def _compute_transform(self):
794
if self._lca_trees is None:
795
entries = self._entries3()
796
resolver = self._three_way
798
entries = self._entries_lca()
799
resolver = self._lca_multi_way
800
child_pb = ui.ui_factory.nested_progress_bar()
802
factories = Merger.hooks['merge_file_content']
803
hooks = [factory(self) for factory in factories] + [self]
804
self.active_hooks = [hook for hook in hooks if hook is not None]
805
for num, (file_id, changed, parents3, names3,
806
executable3) in enumerate(entries):
807
child_pb.update('Preparing file merge', num, len(entries))
808
self._merge_names(file_id, parents3, names3, resolver=resolver)
810
file_status = self._do_merge_contents(file_id)
812
file_status = 'unmodified'
813
self._merge_executable(file_id,
814
executable3, file_status, resolver=resolver)
818
child_pb = ui.ui_factory.nested_progress_bar()
820
fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
821
lambda t, c: transform.conflict_pass(t, c, self.other_tree))
824
if self.change_reporter is not None:
825
from bzrlib import delta
826
delta.report_changes(
827
self.tt.iter_changes(), self.change_reporter)
828
self.cook_conflicts(fs_conflicts)
829
for conflict in self.cooked_conflicts:
830
trace.warning(conflict)
833
"""Gather data about files modified between three trees.
835
Return a list of tuples of file_id, changed, parents3, names3,
836
executable3. changed is a boolean indicating whether the file contents
837
or kind were changed. parents3 is a tuple of parent ids for base,
838
other and this. names3 is a tuple of names for base, other and this.
839
executable3 is a tuple of execute-bit values for base, other and this.
842
iterator = self.other_tree.iter_changes(self.base_tree,
843
include_unchanged=True, specific_files=self.interesting_files,
844
extra_trees=[self.this_tree])
845
this_entries = dict((e.file_id, e) for p, e in
846
self.this_tree.iter_entries_by_dir(
847
self.interesting_ids))
848
for (file_id, paths, changed, versioned, parents, names, kind,
849
executable) in iterator:
850
if (self.interesting_ids is not None and
851
file_id not in self.interesting_ids):
853
entry = this_entries.get(file_id)
854
if entry is not None:
855
this_name = entry.name
856
this_parent = entry.parent_id
857
this_executable = entry.executable
861
this_executable = None
862
parents3 = parents + (this_parent,)
863
names3 = names + (this_name,)
864
executable3 = executable + (this_executable,)
865
result.append((file_id, changed, parents3, names3, executable3))
868
def _entries_lca(self):
869
"""Gather data about files modified between multiple trees.
871
This compares OTHER versus all LCA trees, and for interesting entries,
872
it then compares with THIS and BASE.
874
For the multi-valued entries, the format will be (BASE, [lca1, lca2])
875
:return: [(file_id, changed, parents, names, executable)]
876
file_id Simple file_id of the entry
877
changed Boolean, True if the kind or contents changed
879
parents ((base, [parent_id, in, lcas]), parent_id_other,
881
names ((base, [name, in, lcas]), name_in_other, name_in_this)
882
executable ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
884
if self.interesting_files is not None:
885
lookup_trees = [self.this_tree, self.base_tree]
886
lookup_trees.extend(self._lca_trees)
887
# I think we should include the lca trees as well
888
interesting_ids = self.other_tree.paths2ids(self.interesting_files,
891
interesting_ids = self.interesting_ids
893
walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
895
base_inventory = self.base_tree.inventory
896
this_inventory = self.this_tree.inventory
897
for path, file_id, other_ie, lca_values in walker.iter_all():
898
# Is this modified at all from any of the other trees?
900
other_ie = _none_entry
901
if interesting_ids is not None and file_id not in interesting_ids:
904
# If other_revision is found in any of the lcas, that means this
905
# node is uninteresting. This is because when merging, if there are
906
# multiple heads(), we have to create a new node. So if we didn't,
907
# we know that the ancestry is linear, and that OTHER did not
909
# See doc/developers/lca_merge_resolution.txt for details
910
other_revision = other_ie.revision
911
if other_revision is not None:
912
# We can't use this shortcut when other_revision is None,
913
# because it may be None because things are WorkingTrees, and
914
# not because it is *actually* None.
915
is_unmodified = False
916
for lca_path, ie in lca_values:
917
if ie is not None and ie.revision == other_revision:
924
for lca_path, lca_ie in lca_values:
926
lca_entries.append(_none_entry)
928
lca_entries.append(lca_ie)
930
if file_id in base_inventory:
931
base_ie = base_inventory[file_id]
933
base_ie = _none_entry
935
if file_id in this_inventory:
936
this_ie = this_inventory[file_id]
938
this_ie = _none_entry
944
for lca_ie in lca_entries:
945
lca_kinds.append(lca_ie.kind)
946
lca_parent_ids.append(lca_ie.parent_id)
947
lca_names.append(lca_ie.name)
948
lca_executable.append(lca_ie.executable)
950
kind_winner = self._lca_multi_way(
951
(base_ie.kind, lca_kinds),
952
other_ie.kind, this_ie.kind)
953
parent_id_winner = self._lca_multi_way(
954
(base_ie.parent_id, lca_parent_ids),
955
other_ie.parent_id, this_ie.parent_id)
956
name_winner = self._lca_multi_way(
957
(base_ie.name, lca_names),
958
other_ie.name, this_ie.name)
960
content_changed = True
961
if kind_winner == 'this':
962
# No kind change in OTHER, see if there are *any* changes
963
if other_ie.kind == 'directory':
964
if parent_id_winner == 'this' and name_winner == 'this':
965
# No change for this directory in OTHER, skip
967
content_changed = False
968
elif other_ie.kind is None or other_ie.kind == 'file':
969
def get_sha1(ie, tree):
970
if ie.kind != 'file':
972
return tree.get_file_sha1(file_id)
973
base_sha1 = get_sha1(base_ie, self.base_tree)
974
lca_sha1s = [get_sha1(ie, tree) for ie, tree
975
in zip(lca_entries, self._lca_trees)]
976
this_sha1 = get_sha1(this_ie, self.this_tree)
977
other_sha1 = get_sha1(other_ie, self.other_tree)
978
sha1_winner = self._lca_multi_way(
979
(base_sha1, lca_sha1s), other_sha1, this_sha1,
980
allow_overriding_lca=False)
981
exec_winner = self._lca_multi_way(
982
(base_ie.executable, lca_executable),
983
other_ie.executable, this_ie.executable)
984
if (parent_id_winner == 'this' and name_winner == 'this'
985
and sha1_winner == 'this' and exec_winner == 'this'):
986
# No kind, parent, name, exec, or content change for
987
# OTHER, so this node is not considered interesting
989
if sha1_winner == 'this':
990
content_changed = False
991
elif other_ie.kind == 'symlink':
992
def get_target(ie, tree):
993
if ie.kind != 'symlink':
995
return tree.get_symlink_target(file_id)
996
base_target = get_target(base_ie, self.base_tree)
997
lca_targets = [get_target(ie, tree) for ie, tree
998
in zip(lca_entries, self._lca_trees)]
999
this_target = get_target(this_ie, self.this_tree)
1000
other_target = get_target(other_ie, self.other_tree)
1001
target_winner = self._lca_multi_way(
1002
(base_target, lca_targets),
1003
other_target, this_target)
1004
if (parent_id_winner == 'this' and name_winner == 'this'
1005
and target_winner == 'this'):
1006
# No kind, parent, name, or symlink target change
1009
if target_winner == 'this':
1010
content_changed = False
1011
elif other_ie.kind == 'tree-reference':
1012
# The 'changed' information seems to be handled at a higher
1013
# level. At least, _entries3 returns False for content
1014
# changed, even when at a new revision_id.
1015
content_changed = False
1016
if (parent_id_winner == 'this' and name_winner == 'this'):
1017
# Nothing interesting
1020
raise AssertionError('unhandled kind: %s' % other_ie.kind)
1022
# If we have gotten this far, that means something has changed
1023
result.append((file_id, content_changed,
1024
((base_ie.parent_id, lca_parent_ids),
1025
other_ie.parent_id, this_ie.parent_id),
1026
((base_ie.name, lca_names),
1027
other_ie.name, this_ie.name),
1028
((base_ie.executable, lca_executable),
1029
other_ie.executable, this_ie.executable)
1036
self.tt.final_kind(self.tt.root)
1037
except errors.NoSuchFile:
1038
self.tt.cancel_deletion(self.tt.root)
1039
if self.tt.final_file_id(self.tt.root) is None:
1040
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
1042
other_root_file_id = self.other_tree.get_root_id()
1043
if other_root_file_id is None:
1045
other_root = self.tt.trans_id_file_id(other_root_file_id)
1046
if other_root == self.tt.root:
1048
if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
1049
# the other tree's root is a non-root in the current tree (as when
1050
# a previously unrelated branch is merged into another)
1053
self.tt.final_kind(other_root)
1054
other_root_is_present = True
1055
except errors.NoSuchFile:
1056
# other_root doesn't have a physical representation. We still need
1057
# to move any references to the actual root of the tree.
1058
other_root_is_present = False
1059
# 'other_tree.inventory.root' is not present in this tree. We are
1060
# calling adjust_path for children which *want* to be present with a
1061
# correct place to go.
1062
for thing, child in self.other_tree.inventory.root.children.iteritems():
1063
trans_id = self.tt.trans_id_file_id(child.file_id)
1064
if not other_root_is_present:
1065
# FIXME: Make final_kind returns None instead of raising
1066
# NoSuchFile to avoid the ugly construct below -- vila 20100402
1068
self.tt.final_kind(trans_id)
1069
# The item exist in the final tree and has a defined place
1072
except errors.NoSuchFile, e:
1074
# Move the item into the root
1075
self.tt.adjust_path(self.tt.final_name(trans_id),
1076
self.tt.root, trans_id)
1077
if other_root_is_present:
1078
self.tt.cancel_creation(other_root)
1079
self.tt.cancel_versioning(other_root)
1081
def write_modified(self, results):
1082
modified_hashes = {}
1083
for path in results.modified_paths:
1084
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
1087
hash = self.this_tree.get_file_sha1(file_id)
1090
modified_hashes[file_id] = hash
1091
self.this_tree.set_merge_modified(modified_hashes)
1094
def parent(entry, file_id):
1095
"""Determine the parent for a file_id (used as a key method)"""
1098
return entry.parent_id
1101
def name(entry, file_id):
1102
"""Determine the name for a file_id (used as a key method)"""
1108
def contents_sha1(tree, file_id):
1109
"""Determine the sha1 of the file contents (used as a key method)."""
1110
if file_id not in tree:
1112
return tree.get_file_sha1(file_id)
1115
def executable(tree, file_id):
1116
"""Determine the executability of a file-id (used as a key method)."""
1117
if not tree.has_id(file_id):
1119
if tree.kind(file_id) != "file":
1121
return tree.is_executable(file_id)
1124
def kind(tree, file_id):
1125
"""Determine the kind of a file-id (used as a key method)."""
1126
if not tree.has_id(file_id):
1128
return tree.kind(file_id)
1131
def _three_way(base, other, this):
1133
# if 'base == other', either they all agree, or only 'this' has
1136
elif this not in (base, other):
1137
# 'this' is neither 'base' nor 'other', so both sides changed
1140
# "Ambiguous clean merge" -- both sides have made the same change.
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
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
1197
@deprecated_method(deprecated_in((2, 2, 0)))
1198
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
1199
"""Do a three-way test on a scalar.
1200
Return "this", "other" or "conflict", depending whether a value wins.
1202
key_base = key(base_tree, file_id)
1203
key_other = key(other_tree, file_id)
1204
#if base == other, either they all agree, or only THIS has changed.
1205
if key_base == key_other:
1207
key_this = key(this_tree, file_id)
1208
# "Ambiguous clean merge"
1209
if key_this == key_other:
1211
elif key_this == key_base:
1216
def merge_names(self, file_id):
1217
def get_entry(tree):
1218
if tree.has_id(file_id):
1219
return tree.inventory[file_id]
1222
this_entry = get_entry(self.this_tree)
1223
other_entry = get_entry(self.other_tree)
1224
base_entry = get_entry(self.base_tree)
1225
entries = (base_entry, other_entry, this_entry)
1228
for entry in entries:
1231
parents.append(None)
1233
names.append(entry.name)
1234
parents.append(entry.parent_id)
1235
return self._merge_names(file_id, parents, names,
1236
resolver=self._three_way)
1238
def _merge_names(self, file_id, parents, names, resolver):
1239
"""Perform a merge on file_id names and parents"""
1240
base_name, other_name, this_name = names
1241
base_parent, other_parent, this_parent = parents
1243
name_winner = resolver(*names)
1245
parent_id_winner = resolver(*parents)
1246
if this_name is None:
1247
if name_winner == "this":
1248
name_winner = "other"
1249
if parent_id_winner == "this":
1250
parent_id_winner = "other"
1251
if name_winner == "this" and parent_id_winner == "this":
1253
if name_winner == 'conflict' or parent_id_winner == 'conflict':
1254
# Creating helpers (.OTHER or .THIS) here cause problems down the
1255
# road if a ContentConflict needs to be created so we should not do
1257
trans_id = self.tt.trans_id_file_id(file_id)
1258
self._raw_conflicts.append(('path conflict', trans_id, file_id,
1259
this_parent, this_name,
1260
other_parent, other_name))
1261
if other_name is None:
1262
# it doesn't matter whether the result was 'other' or
1263
# 'conflict'-- if there's no 'other', we leave it alone.
1265
parent_id = parents[self.winner_idx[parent_id_winner]]
1266
if parent_id is not None:
1267
# if we get here, name_winner and parent_winner are set to safe
1269
self.tt.adjust_path(names[self.winner_idx[name_winner]],
1270
self.tt.trans_id_file_id(parent_id),
1271
self.tt.trans_id_file_id(file_id))
1273
def _do_merge_contents(self, file_id):
1274
"""Performs a merge on file_id contents."""
1275
def contents_pair(tree):
1276
if file_id not in tree:
1278
kind = tree.kind(file_id)
1280
contents = tree.get_file_sha1(file_id)
1281
elif kind == "symlink":
1282
contents = tree.get_symlink_target(file_id)
1285
return kind, contents
1287
# See SPOT run. run, SPOT, run.
1288
# So we're not QUITE repeating ourselves; we do tricky things with
1290
base_pair = contents_pair(self.base_tree)
1291
other_pair = contents_pair(self.other_tree)
1293
this_pair = contents_pair(self.this_tree)
1294
lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1295
winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1296
this_pair, allow_overriding_lca=False)
1298
if base_pair == other_pair:
1301
# We delayed evaluating this_pair as long as we can to avoid
1302
# unnecessary sha1 calculation
1303
this_pair = contents_pair(self.this_tree)
1304
winner = self._three_way(base_pair, other_pair, this_pair)
1305
if winner == 'this':
1306
# No interesting changes introduced by OTHER
1308
# We have a hypothetical conflict, but if we have files, then we
1309
# can try to merge the content
1310
trans_id = self.tt.trans_id_file_id(file_id)
1311
params = MergeHookParams(self, file_id, trans_id, this_pair[0],
1312
other_pair[0], winner)
1313
hooks = self.active_hooks
1314
hook_status = 'not_applicable'
1316
hook_status, lines = hook.merge_contents(params)
1317
if hook_status != 'not_applicable':
1318
# Don't try any more hooks, this one applies.
1321
if hook_status == 'not_applicable':
1322
# This is a contents conflict, because none of the available
1323
# functions could merge it.
1325
name = self.tt.final_name(trans_id)
1326
parent_id = self.tt.final_parent(trans_id)
1327
if self.this_tree.has_id(file_id):
1328
self.tt.unversion_file(trans_id)
1329
file_group = self._dump_conflicts(name, parent_id, file_id,
1331
self._raw_conflicts.append(('contents conflict', file_group))
1332
elif hook_status == 'success':
1333
self.tt.create_file(lines, trans_id)
1334
elif hook_status == 'conflicted':
1335
# XXX: perhaps the hook should be able to provide
1336
# the BASE/THIS/OTHER files?
1337
self.tt.create_file(lines, trans_id)
1338
self._raw_conflicts.append(('text conflict', trans_id))
1339
name = self.tt.final_name(trans_id)
1340
parent_id = self.tt.final_parent(trans_id)
1341
self._dump_conflicts(name, parent_id, file_id)
1342
elif hook_status == 'delete':
1343
self.tt.unversion_file(trans_id)
1345
elif hook_status == 'done':
1346
# The hook function did whatever it needs to do directly, no
1347
# further action needed here.
1350
raise AssertionError('unknown hook_status: %r' % (hook_status,))
1351
if not self.this_tree.has_id(file_id) and result == "modified":
1352
self.tt.version_file(file_id, trans_id)
1353
# The merge has been performed, so the old contents should not be
1356
self.tt.delete_contents(trans_id)
1357
except errors.NoSuchFile:
1361
def _default_other_winner_merge(self, merge_hook_params):
1362
"""Replace this contents with other."""
1363
file_id = merge_hook_params.file_id
1364
trans_id = merge_hook_params.trans_id
1365
file_in_this = self.this_tree.has_id(file_id)
1366
if self.other_tree.has_id(file_id):
1367
# OTHER changed the file
1369
if wt.supports_content_filtering():
1370
# We get the path from the working tree if it exists.
1371
# That fails though when OTHER is adding a file, so
1372
# we fall back to the other tree to find the path if
1373
# it doesn't exist locally.
1375
filter_tree_path = wt.id2path(file_id)
1376
except errors.NoSuchId:
1377
filter_tree_path = self.other_tree.id2path(file_id)
1379
# Skip the id2path lookup for older formats
1380
filter_tree_path = None
1381
transform.create_from_tree(self.tt, trans_id,
1382
self.other_tree, file_id,
1383
filter_tree_path=filter_tree_path)
1386
# OTHER deleted the file
1387
return 'delete', None
1389
raise AssertionError(
1390
'winner is OTHER, but file_id %r not in THIS or OTHER tree'
1393
def merge_contents(self, merge_hook_params):
1394
"""Fallback merge logic after user installed hooks."""
1395
# This function is used in merge hooks as the fallback instance.
1396
# Perhaps making this function and the functions it calls be a
1397
# a separate class would be better.
1398
if merge_hook_params.winner == 'other':
1399
# OTHER is a straight winner, so replace this contents with other
1400
return self._default_other_winner_merge(merge_hook_params)
1401
elif merge_hook_params.is_file_merge():
1402
# THIS and OTHER are both files, so text merge. Either
1403
# BASE is a file, or both converted to files, so at least we
1404
# have agreement that output should be a file.
1406
self.text_merge(merge_hook_params.file_id,
1407
merge_hook_params.trans_id)
1408
except errors.BinaryFile:
1409
return 'not_applicable', None
1412
return 'not_applicable', None
1414
def get_lines(self, tree, file_id):
1415
"""Return the lines in a file, or an empty list."""
1416
if tree.has_id(file_id):
1417
return tree.get_file(file_id).readlines()
1421
def text_merge(self, file_id, trans_id):
1422
"""Perform a three-way text merge on a file_id"""
1423
# it's possible that we got here with base as a different type.
1424
# if so, we just want two-way text conflicts.
1425
if self.base_tree.has_id(file_id) and \
1426
self.base_tree.kind(file_id) == "file":
1427
base_lines = self.get_lines(self.base_tree, file_id)
1430
other_lines = self.get_lines(self.other_tree, file_id)
1431
this_lines = self.get_lines(self.this_tree, file_id)
1432
m3 = merge3.Merge3(base_lines, this_lines, other_lines,
1433
is_cherrypick=self.cherrypick)
1434
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
1435
if self.show_base is True:
1436
base_marker = '|' * 7
1440
def iter_merge3(retval):
1441
retval["text_conflicts"] = False
1442
for line in m3.merge_lines(name_a = "TREE",
1443
name_b = "MERGE-SOURCE",
1444
name_base = "BASE-REVISION",
1445
start_marker=start_marker,
1446
base_marker=base_marker,
1447
reprocess=self.reprocess):
1448
if line.startswith(start_marker):
1449
retval["text_conflicts"] = True
1450
yield line.replace(start_marker, '<' * 7)
1454
merge3_iterator = iter_merge3(retval)
1455
self.tt.create_file(merge3_iterator, trans_id)
1456
if retval["text_conflicts"] is True:
1457
self._raw_conflicts.append(('text conflict', trans_id))
1458
name = self.tt.final_name(trans_id)
1459
parent_id = self.tt.final_parent(trans_id)
1460
file_group = self._dump_conflicts(name, parent_id, file_id,
1461
this_lines, base_lines,
1463
file_group.append(trans_id)
1465
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
1466
base_lines=None, other_lines=None, set_version=False,
1468
"""Emit conflict files.
1469
If this_lines, base_lines, or other_lines are omitted, they will be
1470
determined automatically. If set_version is true, the .OTHER, .THIS
1471
or .BASE (in that order) will be created as versioned files.
1473
data = [('OTHER', self.other_tree, other_lines),
1474
('THIS', self.this_tree, this_lines)]
1476
data.append(('BASE', self.base_tree, base_lines))
1478
# We need to use the actual path in the working tree of the file here,
1479
# ignoring the conflict suffixes
1481
if wt.supports_content_filtering():
1483
filter_tree_path = wt.id2path(file_id)
1484
except errors.NoSuchId:
1485
# file has been deleted
1486
filter_tree_path = None
1488
# Skip the id2path lookup for older formats
1489
filter_tree_path = None
1493
for suffix, tree, lines in data:
1494
if tree.has_id(file_id):
1495
trans_id = self._conflict_file(name, parent_id, tree, file_id,
1496
suffix, lines, filter_tree_path)
1497
file_group.append(trans_id)
1498
if set_version and not versioned:
1499
self.tt.version_file(file_id, trans_id)
1503
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1504
lines=None, filter_tree_path=None):
1505
"""Emit a single conflict file."""
1506
name = name + '.' + suffix
1507
trans_id = self.tt.create_path(name, parent_id)
1508
transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
1512
def merge_executable(self, file_id, file_status):
1513
"""Perform a merge on the execute bit."""
1514
executable = [self.executable(t, file_id) for t in (self.base_tree,
1515
self.other_tree, self.this_tree)]
1516
self._merge_executable(file_id, executable, file_status,
1517
resolver=self._three_way)
1519
def _merge_executable(self, file_id, executable, file_status,
1521
"""Perform a merge on the execute bit."""
1522
base_executable, other_executable, this_executable = executable
1523
if file_status == "deleted":
1525
winner = resolver(*executable)
1526
if winner == "conflict":
1527
# There must be a None in here, if we have a conflict, but we
1528
# need executability since file status was not deleted.
1529
if self.executable(self.other_tree, file_id) is None:
1533
if winner == 'this' and file_status != "modified":
1535
trans_id = self.tt.trans_id_file_id(file_id)
1537
if self.tt.final_kind(trans_id) != "file":
1539
except errors.NoSuchFile:
1541
if winner == "this":
1542
executability = this_executable
1544
if self.other_tree.has_id(file_id):
1545
executability = other_executable
1546
elif self.this_tree.has_id(file_id):
1547
executability = this_executable
1548
elif self.base_tree_has_id(file_id):
1549
executability = base_executable
1550
if executability is not None:
1551
trans_id = self.tt.trans_id_file_id(file_id)
1552
self.tt.set_executability(executability, trans_id)
1554
def cook_conflicts(self, fs_conflicts):
1555
"""Convert all conflicts into a form that doesn't depend on trans_id"""
1556
self.cooked_conflicts.extend(transform.cook_conflicts(
1557
fs_conflicts, self.tt))
1558
fp = transform.FinalPaths(self.tt)
1559
for conflict in self._raw_conflicts:
1560
conflict_type = conflict[0]
1561
if conflict_type == 'path conflict':
1563
this_parent, this_name,
1564
other_parent, other_name) = conflict[1:]
1565
if this_parent is None or this_name is None:
1566
this_path = '<deleted>'
1568
parent_path = fp.get_path(
1569
self.tt.trans_id_file_id(this_parent))
1570
this_path = osutils.pathjoin(parent_path, this_name)
1571
if other_parent is None or other_name is None:
1572
other_path = '<deleted>'
1574
parent_path = fp.get_path(
1575
self.tt.trans_id_file_id(other_parent))
1576
other_path = osutils.pathjoin(parent_path, other_name)
1577
c = _mod_conflicts.Conflict.factory(
1578
'path conflict', path=this_path,
1579
conflict_path=other_path,
1581
elif conflict_type == 'contents conflict':
1582
for trans_id in conflict[1]:
1583
file_id = self.tt.final_file_id(trans_id)
1584
if file_id is not None:
1586
path = fp.get_path(trans_id)
1587
for suffix in ('.BASE', '.THIS', '.OTHER'):
1588
if path.endswith(suffix):
1589
path = path[:-len(suffix)]
1591
c = _mod_conflicts.Conflict.factory(conflict_type,
1592
path=path, file_id=file_id)
1593
elif conflict_type == 'text conflict':
1594
trans_id = conflict[1]
1595
path = fp.get_path(trans_id)
1596
file_id = self.tt.final_file_id(trans_id)
1597
c = _mod_conflicts.Conflict.factory(conflict_type,
1598
path=path, file_id=file_id)
1600
raise AssertionError('bad conflict type: %r' % (conflict,))
1601
self.cooked_conflicts.append(c)
1602
self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1605
class WeaveMerger(Merge3Merger):
1606
"""Three-way tree merger, text weave merger."""
1607
supports_reprocess = True
1608
supports_show_base = False
1609
supports_reverse_cherrypick = False
1610
history_based = True
1612
def _generate_merge_plan(self, file_id, base):
1613
return self.this_tree.plan_file_merge(file_id, self.other_tree,
1616
def _merged_lines(self, file_id):
1617
"""Generate the merged lines.
1618
There is no distinction between lines that are meant to contain <<<<<<<
1622
base = self.base_tree
1625
plan = self._generate_merge_plan(file_id, base)
1626
if 'merge' in debug.debug_flags:
1628
trans_id = self.tt.trans_id_file_id(file_id)
1629
name = self.tt.final_name(trans_id) + '.plan'
1630
contents = ('%11s|%s' % l for l in plan)
1631
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1632
textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1633
'>>>>>>> MERGE-SOURCE\n')
1634
lines, conflicts = textmerge.merge_lines(self.reprocess)
1636
base_lines = textmerge.base_from_plan()
1639
return lines, base_lines
1641
def text_merge(self, file_id, trans_id):
1642
"""Perform a (weave) text merge for a given file and file-id.
1643
If conflicts are encountered, .THIS and .OTHER files will be emitted,
1644
and a conflict will be noted.
1646
lines, base_lines = self._merged_lines(file_id)
1648
# Note we're checking whether the OUTPUT is binary in this case,
1649
# because we don't want to get into weave merge guts.
1650
textfile.check_text_lines(lines)
1651
self.tt.create_file(lines, trans_id)
1652
if base_lines is not None:
1654
self._raw_conflicts.append(('text conflict', trans_id))
1655
name = self.tt.final_name(trans_id)
1656
parent_id = self.tt.final_parent(trans_id)
1657
file_group = self._dump_conflicts(name, parent_id, file_id,
1659
base_lines=base_lines)
1660
file_group.append(trans_id)
1663
class LCAMerger(WeaveMerger):
1665
def _generate_merge_plan(self, file_id, base):
1666
return self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1669
class Diff3Merger(Merge3Merger):
1670
"""Three-way merger using external diff3 for text merging"""
1672
def dump_file(self, temp_dir, name, tree, file_id):
1673
out_path = osutils.pathjoin(temp_dir, name)
1674
out_file = open(out_path, "wb")
1676
in_file = tree.get_file(file_id)
1677
for line in in_file:
1678
out_file.write(line)
1683
def text_merge(self, file_id, trans_id):
1684
"""Perform a diff3 merge using a specified file-id and trans-id.
1685
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
1686
will be dumped, and a will be conflict noted.
1689
temp_dir = osutils.mkdtemp(prefix="bzr-")
1691
new_file = osutils.pathjoin(temp_dir, "new")
1692
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
1693
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
1694
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
1695
status = bzrlib.patch.diff3(new_file, this, base, other)
1696
if status not in (0, 1):
1697
raise errors.BzrError("Unhandled diff3 exit code")
1698
f = open(new_file, 'rb')
1700
self.tt.create_file(f, trans_id)
1704
name = self.tt.final_name(trans_id)
1705
parent_id = self.tt.final_parent(trans_id)
1706
self._dump_conflicts(name, parent_id, file_id)
1707
self._raw_conflicts.append(('text conflict', trans_id))
1709
osutils.rmtree(temp_dir)
1712
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1714
merge_type=Merge3Merger,
1715
interesting_ids=None,
1719
interesting_files=None,
1722
change_reporter=None):
1723
"""Primary interface for merging.
1725
typical use is probably
1726
'merge_inner(branch, branch.get_revision_tree(other_revision),
1727
branch.get_revision_tree(base_revision))'
1729
if this_tree is None:
1730
raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
1731
"parameter as of bzrlib version 0.8.")
1732
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1733
pb=pb, change_reporter=change_reporter)
1734
merger.backup_files = backup_files
1735
merger.merge_type = merge_type
1736
merger.interesting_ids = interesting_ids
1737
merger.ignore_zero = ignore_zero
1738
if interesting_files:
1740
raise ValueError('Only supply interesting_ids'
1741
' or interesting_files')
1742
merger.interesting_files = interesting_files
1743
merger.show_base = show_base
1744
merger.reprocess = reprocess
1745
merger.other_rev_id = other_rev_id
1746
merger.other_basis = other_rev_id
1747
get_revision_id = getattr(base_tree, 'get_revision_id', None)
1748
if get_revision_id is None:
1749
get_revision_id = base_tree.last_revision
1750
merger.cache_trees_with_revision_ids([other_tree, base_tree, this_tree])
1751
merger.set_base_revision(get_revision_id(), this_branch)
1752
return merger.do_merge()
1754
def get_merge_type_registry():
1755
"""Merge type registry is in bzrlib.option to avoid circular imports.
1757
This method provides a sanctioned way to retrieve it.
1759
from bzrlib import option
1760
return option._merge_type_registry
1763
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
1764
def status_a(revision, text):
1765
if revision in ancestors_b:
1766
return 'killed-b', text
1768
return 'new-a', text
1770
def status_b(revision, text):
1771
if revision in ancestors_a:
1772
return 'killed-a', text
1774
return 'new-b', text
1776
plain_a = [t for (a, t) in annotated_a]
1777
plain_b = [t for (a, t) in annotated_b]
1778
matcher = patiencediff.PatienceSequenceMatcher(None, plain_a, plain_b)
1779
blocks = matcher.get_matching_blocks()
1782
for ai, bi, l in blocks:
1783
# process all mismatched sections
1784
# (last mismatched section is handled because blocks always
1785
# includes a 0-length last block)
1786
for revision, text in annotated_a[a_cur:ai]:
1787
yield status_a(revision, text)
1788
for revision, text in annotated_b[b_cur:bi]:
1789
yield status_b(revision, text)
1790
# and now the matched section
1793
for text_a in plain_a[ai:a_cur]:
1794
yield "unchanged", text_a
1797
class _PlanMergeBase(object):
1799
def __init__(self, a_rev, b_rev, vf, key_prefix):
1802
:param a_rev: Revision-id of one revision to merge
1803
:param b_rev: Revision-id of the other revision to merge
1804
:param vf: A VersionedFiles containing both revisions
1805
:param key_prefix: A prefix for accessing keys in vf, typically
1811
self._last_lines = None
1812
self._last_lines_revision_id = None
1813
self._cached_matching_blocks = {}
1814
self._key_prefix = key_prefix
1815
self._precache_tip_lines()
1817
def _precache_tip_lines(self):
1818
lines = self.get_lines([self.a_rev, self.b_rev])
1819
self.lines_a = lines[self.a_rev]
1820
self.lines_b = lines[self.b_rev]
1822
def get_lines(self, revisions):
1823
"""Get lines for revisions from the backing VersionedFiles.
1825
:raises RevisionNotPresent: on absent texts.
1827
keys = [(self._key_prefix + (rev,)) for rev in revisions]
1829
for record in self.vf.get_record_stream(keys, 'unordered', True):
1830
if record.storage_kind == 'absent':
1831
raise errors.RevisionNotPresent(record.key, self.vf)
1832
result[record.key[-1]] = osutils.chunks_to_lines(
1833
record.get_bytes_as('chunked'))
1836
def plan_merge(self):
1837
"""Generate a 'plan' for merging the two revisions.
1839
This involves comparing their texts and determining the cause of
1840
differences. If text A has a line and text B does not, then either the
1841
line was added to text A, or it was deleted from B. Once the causes
1842
are combined, they are written out in the format described in
1843
VersionedFile.plan_merge
1845
blocks = self._get_matching_blocks(self.a_rev, self.b_rev)
1846
unique_a, unique_b = self._unique_lines(blocks)
1847
new_a, killed_b = self._determine_status(self.a_rev, unique_a)
1848
new_b, killed_a = self._determine_status(self.b_rev, unique_b)
1849
return self._iter_plan(blocks, new_a, killed_b, new_b, killed_a)
1851
def _iter_plan(self, blocks, new_a, killed_b, new_b, killed_a):
1854
for i, j, n in blocks:
1855
for a_index in range(last_i, i):
1856
if a_index in new_a:
1857
if a_index in killed_b:
1858
yield 'conflicted-a', self.lines_a[a_index]
1860
yield 'new-a', self.lines_a[a_index]
1862
yield 'killed-b', self.lines_a[a_index]
1863
for b_index in range(last_j, j):
1864
if b_index in new_b:
1865
if b_index in killed_a:
1866
yield 'conflicted-b', self.lines_b[b_index]
1868
yield 'new-b', self.lines_b[b_index]
1870
yield 'killed-a', self.lines_b[b_index]
1871
# handle common lines
1872
for a_index in range(i, i+n):
1873
yield 'unchanged', self.lines_a[a_index]
1877
def _get_matching_blocks(self, left_revision, right_revision):
1878
"""Return a description of which sections of two revisions match.
1880
See SequenceMatcher.get_matching_blocks
1882
cached = self._cached_matching_blocks.get((left_revision,
1884
if cached is not None:
1886
if self._last_lines_revision_id == left_revision:
1887
left_lines = self._last_lines
1888
right_lines = self.get_lines([right_revision])[right_revision]
1890
lines = self.get_lines([left_revision, right_revision])
1891
left_lines = lines[left_revision]
1892
right_lines = lines[right_revision]
1893
self._last_lines = right_lines
1894
self._last_lines_revision_id = right_revision
1895
matcher = patiencediff.PatienceSequenceMatcher(None, left_lines,
1897
return matcher.get_matching_blocks()
1899
def _unique_lines(self, matching_blocks):
1900
"""Analyse matching_blocks to determine which lines are unique
1902
:return: a tuple of (unique_left, unique_right), where the values are
1903
sets of line numbers of unique lines.
1909
for i, j, n in matching_blocks:
1910
unique_left.extend(range(last_i, i))
1911
unique_right.extend(range(last_j, j))
1914
return unique_left, unique_right
1917
def _subtract_plans(old_plan, new_plan):
1918
"""Remove changes from new_plan that came from old_plan.
1920
It is assumed that the difference between the old_plan and new_plan
1921
is their choice of 'b' text.
1923
All lines from new_plan that differ from old_plan are emitted
1924
verbatim. All lines from new_plan that match old_plan but are
1925
not about the 'b' revision are emitted verbatim.
1927
Lines that match and are about the 'b' revision are the lines we
1928
don't want, so we convert 'killed-b' -> 'unchanged', and 'new-b'
1929
is skipped entirely.
1931
matcher = patiencediff.PatienceSequenceMatcher(None, old_plan,
1934
for i, j, n in matcher.get_matching_blocks():
1935
for jj in range(last_j, j):
1937
for jj in range(j, j+n):
1938
plan_line = new_plan[jj]
1939
if plan_line[0] == 'new-b':
1941
elif plan_line[0] == 'killed-b':
1942
yield 'unchanged', plan_line[1]
1948
class _PlanMerge(_PlanMergeBase):
1949
"""Plan an annotate merge using on-the-fly annotation"""
1951
def __init__(self, a_rev, b_rev, vf, key_prefix):
1952
super(_PlanMerge, self).__init__(a_rev, b_rev, vf, key_prefix)
1953
self.a_key = self._key_prefix + (self.a_rev,)
1954
self.b_key = self._key_prefix + (self.b_rev,)
1955
self.graph = _mod_graph.Graph(self.vf)
1956
heads = self.graph.heads((self.a_key, self.b_key))
1958
# one side dominates, so we can just return its values, yay for
1960
# Ideally we would know that before we get this far
1961
self._head_key = heads.pop()
1962
if self._head_key == self.a_key:
1966
trace.mutter('found dominating revision for %s\n%s > %s', self.vf,
1967
self._head_key[-1], other)
1970
self._head_key = None
1973
def _precache_tip_lines(self):
1974
# Turn this into a no-op, because we will do this later
1977
def _find_recursive_lcas(self):
1978
"""Find all the ancestors back to a unique lca"""
1979
cur_ancestors = (self.a_key, self.b_key)
1980
# graph.find_lca(uncommon, keys) now returns plain NULL_REVISION,
1981
# rather than a key tuple. We will just map that directly to no common
1985
next_lcas = self.graph.find_lca(*cur_ancestors)
1986
# Map a plain NULL_REVISION to a simple no-ancestors
1987
if next_lcas == set([_mod_revision.NULL_REVISION]):
1989
# Order the lca's based on when they were merged into the tip
1990
# While the actual merge portion of weave merge uses a set() of
1991
# active revisions, the order of insertion *does* effect the
1992
# implicit ordering of the texts.
1993
for rev_key in cur_ancestors:
1994
ordered_parents = tuple(self.graph.find_merge_order(rev_key,
1996
parent_map[rev_key] = ordered_parents
1997
if len(next_lcas) == 0:
1999
elif len(next_lcas) == 1:
2000
parent_map[list(next_lcas)[0]] = ()
2002
elif len(next_lcas) > 2:
2003
# More than 2 lca's, fall back to grabbing all nodes between
2004
# this and the unique lca.
2005
trace.mutter('More than 2 LCAs, falling back to all nodes for:'
2007
self.a_key, self.b_key, cur_ancestors)
2008
cur_lcas = next_lcas
2009
while len(cur_lcas) > 1:
2010
cur_lcas = self.graph.find_lca(*cur_lcas)
2011
if len(cur_lcas) == 0:
2012
# No common base to find, use the full ancestry
2015
unique_lca = list(cur_lcas)[0]
2016
if unique_lca == _mod_revision.NULL_REVISION:
2017
# find_lca will return a plain 'NULL_REVISION' rather
2018
# than a key tuple when there is no common ancestor, we
2019
# prefer to just use None, because it doesn't confuse
2020
# _get_interesting_texts()
2022
parent_map.update(self._find_unique_parents(next_lcas,
2025
cur_ancestors = next_lcas
2028
def _find_unique_parents(self, tip_keys, base_key):
2029
"""Find ancestors of tip that aren't ancestors of base.
2031
:param tip_keys: Nodes that are interesting
2032
:param base_key: Cull all ancestors of this node
2033
:return: The parent map for all revisions between tip_keys and
2034
base_key. base_key will be included. References to nodes outside of
2035
the ancestor set will also be removed.
2037
# TODO: this would be simpler if find_unique_ancestors took a list
2038
# instead of a single tip, internally it supports it, but it
2039
# isn't a "backwards compatible" api change.
2040
if base_key is None:
2041
parent_map = dict(self.graph.iter_ancestry(tip_keys))
2042
# We remove NULL_REVISION because it isn't a proper tuple key, and
2043
# thus confuses things like _get_interesting_texts, and our logic
2044
# to add the texts into the memory weave.
2045
if _mod_revision.NULL_REVISION in parent_map:
2046
parent_map.pop(_mod_revision.NULL_REVISION)
2049
for tip in tip_keys:
2051
self.graph.find_unique_ancestors(tip, [base_key]))
2052
parent_map = self.graph.get_parent_map(interesting)
2053
parent_map[base_key] = ()
2054
culled_parent_map, child_map, tails = self._remove_external_references(
2056
# Remove all the tails but base_key
2057
if base_key is not None:
2058
tails.remove(base_key)
2059
self._prune_tails(culled_parent_map, child_map, tails)
2060
# Now remove all the uninteresting 'linear' regions
2061
simple_map = _mod_graph.collapse_linear_regions(culled_parent_map)
2065
def _remove_external_references(parent_map):
2066
"""Remove references that go outside of the parent map.
2068
:param parent_map: Something returned from Graph.get_parent_map(keys)
2069
:return: (filtered_parent_map, child_map, tails)
2070
filtered_parent_map is parent_map without external references
2071
child_map is the {parent_key: [child_keys]} mapping
2072
tails is a list of nodes that do not have any parents in the map
2074
# TODO: The basic effect of this function seems more generic than
2075
# _PlanMerge. But the specific details of building a child_map,
2076
# and computing tails seems very specific to _PlanMerge.
2077
# Still, should this be in Graph land?
2078
filtered_parent_map = {}
2081
for key, parent_keys in parent_map.iteritems():
2082
culled_parent_keys = [p for p in parent_keys if p in parent_map]
2083
if not culled_parent_keys:
2085
for parent_key in culled_parent_keys:
2086
child_map.setdefault(parent_key, []).append(key)
2087
# TODO: Do we want to do this, it adds overhead for every node,
2088
# just to say that the node has no children
2089
child_map.setdefault(key, [])
2090
filtered_parent_map[key] = culled_parent_keys
2091
return filtered_parent_map, child_map, tails
2094
def _prune_tails(parent_map, child_map, tails_to_remove):
2095
"""Remove tails from the parent map.
2097
This will remove the supplied revisions until no more children have 0
2100
:param parent_map: A dict of {child: [parents]}, this dictionary will
2101
be modified in place.
2102
:param tails_to_remove: A list of tips that should be removed,
2103
this list will be consumed
2104
:param child_map: The reverse dict of parent_map ({parent: [children]})
2105
this dict will be modified
2106
:return: None, parent_map will be modified in place.
2108
while tails_to_remove:
2109
next = tails_to_remove.pop()
2110
parent_map.pop(next)
2111
children = child_map.pop(next)
2112
for child in children:
2113
child_parents = parent_map[child]
2114
child_parents.remove(next)
2115
if len(child_parents) == 0:
2116
tails_to_remove.append(child)
2118
def _get_interesting_texts(self, parent_map):
2119
"""Return a dict of texts we are interested in.
2121
Note that the input is in key tuples, but the output is in plain
2124
:param parent_map: The output from _find_recursive_lcas
2125
:return: A dict of {'revision_id':lines} as returned by
2126
_PlanMergeBase.get_lines()
2128
all_revision_keys = set(parent_map)
2129
all_revision_keys.add(self.a_key)
2130
all_revision_keys.add(self.b_key)
2132
# Everything else is in 'keys' but get_lines is in 'revision_ids'
2133
all_texts = self.get_lines([k[-1] for k in all_revision_keys])
2136
def _build_weave(self):
2137
from bzrlib import weave
2138
self._weave = weave.Weave(weave_name='in_memory_weave',
2139
allow_reserved=True)
2140
parent_map = self._find_recursive_lcas()
2142
all_texts = self._get_interesting_texts(parent_map)
2144
# Note: Unfortunately, the order given by topo_sort will effect the
2145
# ordering resolution in the output. Specifically, if you add A then B,
2146
# then in the output text A lines will show up before B lines. And, of
2147
# course, topo_sort doesn't guarantee any real ordering.
2148
# So we use merge_sort, and add a fake node on the tip.
2149
# This ensures that left-hand parents will always be inserted into the
2150
# weave before right-hand parents.
2151
tip_key = self._key_prefix + (_mod_revision.CURRENT_REVISION,)
2152
parent_map[tip_key] = (self.a_key, self.b_key)
2154
for seq_num, key, depth, eom in reversed(tsort.merge_sort(parent_map,
2158
# for key in tsort.topo_sort(parent_map):
2159
parent_keys = parent_map[key]
2160
revision_id = key[-1]
2161
parent_ids = [k[-1] for k in parent_keys]
2162
self._weave.add_lines(revision_id, parent_ids,
2163
all_texts[revision_id])
2165
def plan_merge(self):
2166
"""Generate a 'plan' for merging the two revisions.
2168
This involves comparing their texts and determining the cause of
2169
differences. If text A has a line and text B does not, then either the
2170
line was added to text A, or it was deleted from B. Once the causes
2171
are combined, they are written out in the format described in
2172
VersionedFile.plan_merge
2174
if self._head_key is not None: # There was a single head
2175
if self._head_key == self.a_key:
2178
if self._head_key != self.b_key:
2179
raise AssertionError('There was an invalid head: %s != %s'
2180
% (self.b_key, self._head_key))
2182
head_rev = self._head_key[-1]
2183
lines = self.get_lines([head_rev])[head_rev]
2184
return ((plan, line) for line in lines)
2185
return self._weave.plan_merge(self.a_rev, self.b_rev)
2188
class _PlanLCAMerge(_PlanMergeBase):
2190
This merge algorithm differs from _PlanMerge in that:
2191
1. comparisons are done against LCAs only
2192
2. cases where a contested line is new versus one LCA but old versus
2193
another are marked as conflicts, by emitting the line as conflicted-a
2196
This is faster, and hopefully produces more useful output.
2199
def __init__(self, a_rev, b_rev, vf, key_prefix, graph):
2200
_PlanMergeBase.__init__(self, a_rev, b_rev, vf, key_prefix)
2201
lcas = graph.find_lca(key_prefix + (a_rev,), key_prefix + (b_rev,))
2204
if lca == _mod_revision.NULL_REVISION:
2207
self.lcas.add(lca[-1])
2208
for lca in self.lcas:
2209
if _mod_revision.is_null(lca):
2212
lca_lines = self.get_lines([lca])[lca]
2213
matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_a,
2215
blocks = list(matcher.get_matching_blocks())
2216
self._cached_matching_blocks[(a_rev, lca)] = blocks
2217
matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_b,
2219
blocks = list(matcher.get_matching_blocks())
2220
self._cached_matching_blocks[(b_rev, lca)] = blocks
2222
def _determine_status(self, revision_id, unique_line_numbers):
2223
"""Determines the status unique lines versus all lcas.
2225
Basically, determines why the line is unique to this revision.
2227
A line may be determined new, killed, or both.
2229
If a line is determined new, that means it was not present in at least
2230
one LCA, and is not present in the other merge revision.
2232
If a line is determined killed, that means the line was present in
2235
If a line is killed and new, this indicates that the two merge
2236
revisions contain differing conflict resolutions.
2237
:param revision_id: The id of the revision in which the lines are
2239
:param unique_line_numbers: The line numbers of unique lines.
2240
:return a tuple of (new_this, killed_other):
2244
unique_line_numbers = set(unique_line_numbers)
2245
for lca in self.lcas:
2246
blocks = self._get_matching_blocks(revision_id, lca)
2247
unique_vs_lca, _ignored = self._unique_lines(blocks)
2248
new.update(unique_line_numbers.intersection(unique_vs_lca))
2249
killed.update(unique_line_numbers.difference(unique_vs_lca))
added
removed
bzrlib/merge.py
