1
# Copyright (C) 2005-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
21
from .lazy_import import lazy_import
22
lazy_import(globals(), """
24
branch as _mod_branch,
26
conflicts as _mod_conflicts,
33
revision as _mod_revision,
43
from breezy.i18n import gettext
54
# TODO: Report back as changes are merged in
57
def transform_tree(from_tree, to_tree, interesting_ids=None):
58
from_tree.lock_tree_write()
59
operation = cleanup.OperationWithCleanups(merge_inner)
60
operation.add_cleanup(from_tree.unlock)
61
operation.run_simple(from_tree.branch, to_tree, from_tree,
62
ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
65
class MergeHooks(hooks.Hooks):
68
hooks.Hooks.__init__(self, "breezy.merge", "Merger.hooks")
69
self.add_hook('merge_file_content',
70
"Called with a breezy.merge.Merger object to create a per file "
71
"merge object when starting a merge. "
72
"Should return either None or a subclass of "
73
"``breezy.merge.AbstractPerFileMerger``. "
74
"Such objects will then be called per file "
75
"that needs to be merged (including when one "
76
"side has deleted the file and the other has changed it). "
77
"See the AbstractPerFileMerger API docs for details on how it is "
80
self.add_hook('pre_merge',
81
'Called before a merge. '
82
'Receives a Merger object as the single argument.',
84
self.add_hook('post_merge',
85
'Called after a merge. '
86
'Receives a Merger object as the single argument. '
87
'The return value is ignored.',
91
class AbstractPerFileMerger(object):
92
"""PerFileMerger objects are used by plugins extending merge for breezy.
94
See ``breezy.plugins.news_merge.news_merge`` for an example concrete class.
96
:ivar merger: The Merge3Merger performing the merge.
99
def __init__(self, merger):
100
"""Create a PerFileMerger for use with merger."""
103
def merge_contents(self, merge_params):
104
"""Attempt to merge the contents of a single file.
106
:param merge_params: A breezy.merge.MergeFileHookParams
107
:return: A tuple of (status, chunks), where status is one of
108
'not_applicable', 'success', 'conflicted', or 'delete'. If status
109
is 'success' or 'conflicted', then chunks should be an iterable of
110
strings for the new file contents.
112
return ('not applicable', None)
115
class PerFileMerger(AbstractPerFileMerger):
116
"""Merge individual files when self.file_matches returns True.
118
This class is intended to be subclassed. The file_matches and
119
merge_matching methods should be overridden with concrete implementations.
122
def file_matches(self, params):
123
"""Return True if merge_matching should be called on this file.
125
Only called with merges of plain files with no clear winner.
127
Subclasses must override this.
129
raise NotImplementedError(self.file_matches)
131
def get_filename(self, params, tree):
132
"""Lookup the filename (i.e. basename, not path), given a Tree (e.g.
133
self.merger.this_tree) and a MergeFileHookParams.
135
return osutils.basename(tree.id2path(params.file_id))
137
def get_filepath(self, params, tree):
138
"""Calculate the path to the file in a tree.
140
:param params: A MergeFileHookParams describing the file to merge
141
:param tree: a Tree, e.g. self.merger.this_tree.
143
return tree.id2path(params.file_id)
145
def merge_contents(self, params):
146
"""Merge the contents of a single file."""
147
# Check whether this custom merge logic should be used.
149
# OTHER is a straight winner, rely on default merge.
150
params.winner == 'other' or
151
# THIS and OTHER aren't both files.
152
not params.is_file_merge() or
153
# The filename doesn't match
154
not self.file_matches(params)):
155
return 'not_applicable', None
156
return self.merge_matching(params)
158
def merge_matching(self, params):
159
"""Merge the contents of a single file that has matched the criteria
160
in PerFileMerger.merge_contents (is a conflict, is a file,
161
self.file_matches is True).
163
Subclasses must override this.
165
raise NotImplementedError(self.merge_matching)
168
class ConfigurableFileMerger(PerFileMerger):
169
"""Merge individual files when configured via a .conf file.
171
This is a base class for concrete custom file merging logic. Concrete
172
classes should implement ``merge_text``.
174
See ``breezy.plugins.news_merge.news_merge`` for an example concrete class.
176
:ivar affected_files: The configured file paths to merge.
178
:cvar name_prefix: The prefix to use when looking up configuration
179
details. <name_prefix>_merge_files describes the files targeted by the
182
:cvar default_files: The default file paths to merge when no configuration
189
def __init__(self, merger):
190
super(ConfigurableFileMerger, self).__init__(merger)
191
self.affected_files = None
192
self.default_files = self.__class__.default_files or []
193
self.name_prefix = self.__class__.name_prefix
194
if self.name_prefix is None:
195
raise ValueError("name_prefix must be set.")
197
def file_matches(self, params):
198
"""Check whether the file should call the merge hook.
200
<name_prefix>_merge_files configuration variable is a list of files
201
that should use the hook.
203
affected_files = self.affected_files
204
if affected_files is None:
205
config = self.merger.this_branch.get_config()
206
# Until bzr provides a better policy for caching the config, we
207
# just add the part we're interested in to the params to avoid
208
# reading the config files repeatedly (bazaar.conf, location.conf,
210
config_key = self.name_prefix + '_merge_files'
211
affected_files = config.get_user_option_as_list(config_key)
212
if affected_files is None:
213
# If nothing was specified in the config, use the default.
214
affected_files = self.default_files
215
self.affected_files = affected_files
217
filepath = self.get_filepath(params, self.merger.this_tree)
218
if filepath in affected_files:
222
def merge_matching(self, params):
223
return self.merge_text(params)
225
def merge_text(self, params):
226
"""Merge the byte contents of a single file.
228
This is called after checking that the merge should be performed in
229
merge_contents, and it should behave as per
230
``breezy.merge.AbstractPerFileMerger.merge_contents``.
232
raise NotImplementedError(self.merge_text)
235
class MergeFileHookParams(object):
236
"""Object holding parameters passed to merge_file_content hooks.
238
There are some fields hooks can access:
240
:ivar file_id: the file ID of the file being merged
241
:ivar trans_id: the transform ID for the merge of this file
242
:ivar this_kind: kind of file_id in 'this' tree
243
:ivar other_kind: kind of file_id in 'other' tree
244
:ivar winner: one of 'this', 'other', 'conflict'
247
def __init__(self, merger, file_id, trans_id, this_kind, other_kind,
249
self._merger = merger
250
self.file_id = file_id
251
self.trans_id = trans_id
252
self.this_kind = this_kind
253
self.other_kind = other_kind
256
def is_file_merge(self):
257
"""True if this_kind and other_kind are both 'file'."""
258
return self.this_kind == 'file' and self.other_kind == 'file'
260
@decorators.cachedproperty
261
def base_lines(self):
262
"""The lines of the 'base' version of the file."""
263
return self._merger.get_lines(self._merger.base_tree, self.file_id)
265
@decorators.cachedproperty
266
def this_lines(self):
267
"""The lines of the 'this' version of the file."""
268
return self._merger.get_lines(self._merger.this_tree, self.file_id)
270
@decorators.cachedproperty
271
def other_lines(self):
272
"""The lines of the 'other' version of the file."""
273
return self._merger.get_lines(self._merger.other_tree, self.file_id)
276
class Merger(object):
280
def __init__(self, this_branch, other_tree=None, base_tree=None,
281
this_tree=None, pb=None, change_reporter=None,
282
recurse='down', revision_graph=None):
283
object.__init__(self)
284
self.this_branch = this_branch
285
self.this_basis = _mod_revision.ensure_null(
286
this_branch.last_revision())
287
self.this_rev_id = None
288
self.this_tree = this_tree
289
self.this_revision_tree = None
290
self.this_basis_tree = None
291
self.other_tree = other_tree
292
self.other_branch = None
293
self.base_tree = base_tree
294
self.ignore_zero = False
295
self.backup_files = False
296
self.interesting_ids = None
297
self.interesting_files = None
298
self.show_base = False
299
self.reprocess = False
301
warnings.warn("pb parameter to Merger() is deprecated and ignored")
303
self.recurse = recurse
304
self.change_reporter = change_reporter
305
self._cached_trees = {}
306
self._revision_graph = revision_graph
307
self._base_is_ancestor = None
308
self._base_is_other_ancestor = None
309
self._is_criss_cross = None
310
self._lca_trees = None
312
def cache_trees_with_revision_ids(self, trees):
313
"""Cache any tree in trees if it has a revision_id."""
314
for maybe_tree in trees:
315
if maybe_tree is None:
318
rev_id = maybe_tree.get_revision_id()
319
except AttributeError:
321
self._cached_trees[rev_id] = maybe_tree
324
def revision_graph(self):
325
if self._revision_graph is None:
326
self._revision_graph = self.this_branch.repository.get_graph()
327
return self._revision_graph
329
def _set_base_is_ancestor(self, value):
330
self._base_is_ancestor = value
332
def _get_base_is_ancestor(self):
333
if self._base_is_ancestor is None:
334
self._base_is_ancestor = self.revision_graph.is_ancestor(
335
self.base_rev_id, self.this_basis)
336
return self._base_is_ancestor
338
base_is_ancestor = property(_get_base_is_ancestor, _set_base_is_ancestor)
340
def _set_base_is_other_ancestor(self, value):
341
self._base_is_other_ancestor = value
343
def _get_base_is_other_ancestor(self):
344
if self._base_is_other_ancestor is None:
345
if self.other_basis is None:
347
self._base_is_other_ancestor = self.revision_graph.is_ancestor(
348
self.base_rev_id, self.other_basis)
349
return self._base_is_other_ancestor
351
base_is_other_ancestor = property(_get_base_is_other_ancestor,
352
_set_base_is_other_ancestor)
355
def from_uncommitted(tree, other_tree, pb=None, base_tree=None):
356
"""Return a Merger for uncommitted changes in other_tree.
358
:param tree: The tree to merge into
359
:param other_tree: The tree to get uncommitted changes from
360
:param pb: A progress indicator
361
:param base_tree: The basis to use for the merge. If unspecified,
362
other_tree.basis_tree() will be used.
364
if base_tree is None:
365
base_tree = other_tree.basis_tree()
366
merger = Merger(tree.branch, other_tree, base_tree, tree, pb)
367
merger.base_rev_id = merger.base_tree.get_revision_id()
368
merger.other_rev_id = None
369
merger.other_basis = merger.base_rev_id
373
def from_mergeable(klass, tree, mergeable, pb):
374
"""Return a Merger for a bundle or merge directive.
376
:param tree: The tree to merge changes into
377
:param mergeable: A merge directive or bundle
378
:param pb: A progress indicator
380
mergeable.install_revisions(tree.branch.repository)
381
base_revision_id, other_revision_id, verified =\
382
mergeable.get_merge_request(tree.branch.repository)
383
revision_graph = tree.branch.repository.get_graph()
384
if base_revision_id is not None:
385
if (base_revision_id != _mod_revision.NULL_REVISION and
386
revision_graph.is_ancestor(
387
base_revision_id, tree.branch.last_revision())):
388
base_revision_id = None
390
trace.warning('Performing cherrypick')
391
merger = klass.from_revision_ids(pb, tree, other_revision_id,
392
base_revision_id, revision_graph=
394
return merger, verified
397
def from_revision_ids(pb, tree, other, base=None, other_branch=None,
398
base_branch=None, revision_graph=None,
400
"""Return a Merger for revision-ids.
402
:param pb: A progress indicator
403
:param tree: The tree to merge changes into
404
:param other: The revision-id to use as OTHER
405
:param base: The revision-id to use as BASE. If not specified, will
407
:param other_branch: A branch containing the other revision-id. If
408
not supplied, tree.branch is used.
409
:param base_branch: A branch containing the base revision-id. If
410
not supplied, other_branch or tree.branch will be used.
411
:param revision_graph: If you have a revision_graph precomputed, pass
412
it in, otherwise it will be created for you.
413
:param tree_branch: The branch associated with tree. If not supplied,
414
tree.branch will be used.
416
if tree_branch is None:
417
tree_branch = tree.branch
418
merger = Merger(tree_branch, this_tree=tree, pb=pb,
419
revision_graph=revision_graph)
420
if other_branch is None:
421
other_branch = tree.branch
422
merger.set_other_revision(other, other_branch)
426
if base_branch is None:
427
base_branch = other_branch
428
merger.set_base_revision(base, base_branch)
431
def revision_tree(self, revision_id, branch=None):
432
if revision_id not in self._cached_trees:
434
branch = self.this_branch
436
tree = self.this_tree.revision_tree(revision_id)
437
except errors.NoSuchRevisionInTree:
438
tree = branch.repository.revision_tree(revision_id)
439
self._cached_trees[revision_id] = tree
440
return self._cached_trees[revision_id]
442
def _get_tree(self, treespec, possible_transports=None):
443
location, revno = treespec
445
tree = workingtree.WorkingTree.open_containing(location)[0]
446
return tree.branch, tree
447
branch = _mod_branch.Branch.open_containing(
448
location, possible_transports)[0]
450
revision_id = branch.last_revision()
452
revision_id = branch.get_rev_id(revno)
453
revision_id = _mod_revision.ensure_null(revision_id)
454
return branch, self.revision_tree(revision_id, branch)
456
def set_interesting_files(self, file_list):
457
self.interesting_files = file_list
459
def set_pending(self):
460
if (not self.base_is_ancestor or not self.base_is_other_ancestor
461
or self.other_rev_id is None):
465
def _add_parent(self):
466
new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
467
new_parent_trees = []
468
operation = cleanup.OperationWithCleanups(
469
self.this_tree.set_parent_trees)
470
for revision_id in new_parents:
472
tree = self.revision_tree(revision_id)
473
except errors.NoSuchRevision:
477
operation.add_cleanup(tree.unlock)
478
new_parent_trees.append((revision_id, tree))
479
operation.run_simple(new_parent_trees, allow_leftmost_as_ghost=True)
481
def set_other(self, other_revision, possible_transports=None):
482
"""Set the revision and tree to merge from.
484
This sets the other_tree, other_rev_id, other_basis attributes.
486
:param other_revision: The [path, revision] list to merge from.
488
self.other_branch, self.other_tree = self._get_tree(other_revision,
490
if other_revision[1] == -1:
491
self.other_rev_id = _mod_revision.ensure_null(
492
self.other_branch.last_revision())
493
if _mod_revision.is_null(self.other_rev_id):
494
raise errors.NoCommits(self.other_branch)
495
self.other_basis = self.other_rev_id
496
elif other_revision[1] is not None:
497
self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
498
self.other_basis = self.other_rev_id
500
self.other_rev_id = None
501
self.other_basis = self.other_branch.last_revision()
502
if self.other_basis is None:
503
raise errors.NoCommits(self.other_branch)
504
if self.other_rev_id is not None:
505
self._cached_trees[self.other_rev_id] = self.other_tree
506
self._maybe_fetch(self.other_branch, self.this_branch, self.other_basis)
508
def set_other_revision(self, revision_id, other_branch):
509
"""Set 'other' based on a branch and revision id
511
:param revision_id: The revision to use for a tree
512
:param other_branch: The branch containing this tree
514
self.other_rev_id = revision_id
515
self.other_branch = other_branch
516
self._maybe_fetch(other_branch, self.this_branch, self.other_rev_id)
517
self.other_tree = self.revision_tree(revision_id)
518
self.other_basis = revision_id
520
def set_base_revision(self, revision_id, branch):
521
"""Set 'base' based on a branch and revision id
523
:param revision_id: The revision to use for a tree
524
:param branch: The branch containing this tree
526
self.base_rev_id = revision_id
527
self.base_branch = branch
528
self._maybe_fetch(branch, self.this_branch, revision_id)
529
self.base_tree = self.revision_tree(revision_id)
531
def _maybe_fetch(self, source, target, revision_id):
532
if not source.repository.has_same_location(target.repository):
533
target.fetch(source, revision_id)
536
revisions = [_mod_revision.ensure_null(self.this_basis),
537
_mod_revision.ensure_null(self.other_basis)]
538
if _mod_revision.NULL_REVISION in revisions:
539
self.base_rev_id = _mod_revision.NULL_REVISION
540
self.base_tree = self.revision_tree(self.base_rev_id)
541
self._is_criss_cross = False
543
lcas = self.revision_graph.find_lca(revisions[0], revisions[1])
544
self._is_criss_cross = False
546
self.base_rev_id = _mod_revision.NULL_REVISION
548
self.base_rev_id = list(lcas)[0]
549
else: # len(lcas) > 1
550
self._is_criss_cross = True
552
# find_unique_lca can only handle 2 nodes, so we have to
553
# start back at the beginning. It is a shame to traverse
554
# the graph again, but better than re-implementing
556
self.base_rev_id = self.revision_graph.find_unique_lca(
557
revisions[0], revisions[1])
559
self.base_rev_id = self.revision_graph.find_unique_lca(
561
sorted_lca_keys = self.revision_graph.find_merge_order(
563
if self.base_rev_id == _mod_revision.NULL_REVISION:
564
self.base_rev_id = sorted_lca_keys[0]
566
if self.base_rev_id == _mod_revision.NULL_REVISION:
567
raise errors.UnrelatedBranches()
568
if self._is_criss_cross:
569
trace.warning('Warning: criss-cross merge encountered. See bzr'
570
' help criss-cross.')
571
trace.mutter('Criss-cross lcas: %r' % lcas)
572
if self.base_rev_id in lcas:
573
trace.mutter('Unable to find unique lca. '
574
'Fallback %r as best option.'
576
interesting_revision_ids = set(lcas)
577
interesting_revision_ids.add(self.base_rev_id)
578
interesting_trees = dict((t.get_revision_id(), t)
579
for t in self.this_branch.repository.revision_trees(
580
interesting_revision_ids))
581
self._cached_trees.update(interesting_trees)
582
if self.base_rev_id in lcas:
583
self.base_tree = interesting_trees[self.base_rev_id]
585
self.base_tree = interesting_trees.pop(self.base_rev_id)
586
self._lca_trees = [interesting_trees[key]
587
for key in sorted_lca_keys]
589
self.base_tree = self.revision_tree(self.base_rev_id)
590
self.base_is_ancestor = True
591
self.base_is_other_ancestor = True
592
trace.mutter('Base revid: %r' % self.base_rev_id)
594
def set_base(self, base_revision):
595
"""Set the base revision to use for the merge.
597
:param base_revision: A 2-list containing a path and revision number.
599
trace.mutter("doing merge() with no base_revision specified")
600
if base_revision == [None, None]:
603
base_branch, self.base_tree = self._get_tree(base_revision)
604
if base_revision[1] == -1:
605
self.base_rev_id = base_branch.last_revision()
606
elif base_revision[1] is None:
607
self.base_rev_id = _mod_revision.NULL_REVISION
609
self.base_rev_id = _mod_revision.ensure_null(
610
base_branch.get_rev_id(base_revision[1]))
611
self._maybe_fetch(base_branch, self.this_branch, self.base_rev_id)
613
def make_merger(self):
614
kwargs = {'working_tree': self.this_tree, 'this_tree': self.this_tree,
615
'other_tree': self.other_tree,
616
'interesting_ids': self.interesting_ids,
617
'interesting_files': self.interesting_files,
618
'this_branch': self.this_branch,
619
'other_branch': self.other_branch,
621
if self.merge_type.requires_base:
622
kwargs['base_tree'] = self.base_tree
623
if self.merge_type.supports_reprocess:
624
kwargs['reprocess'] = self.reprocess
626
raise errors.BzrError(
627
"Conflict reduction is not supported for merge"
628
" type %s." % self.merge_type)
629
if self.merge_type.supports_show_base:
630
kwargs['show_base'] = self.show_base
632
raise errors.BzrError("Showing base is not supported for this"
633
" merge type. %s" % self.merge_type)
634
if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
635
and not self.base_is_other_ancestor):
636
raise errors.CannotReverseCherrypick()
637
if self.merge_type.supports_cherrypick:
638
kwargs['cherrypick'] = (not self.base_is_ancestor or
639
not self.base_is_other_ancestor)
640
if self._is_criss_cross and getattr(self.merge_type,
641
'supports_lca_trees', False):
642
kwargs['lca_trees'] = self._lca_trees
643
return self.merge_type(pb=None,
644
change_reporter=self.change_reporter,
647
def _do_merge_to(self):
648
merge = self.make_merger()
649
if self.other_branch is not None:
650
self.other_branch.update_references(self.this_branch)
651
for hook in Merger.hooks['pre_merge']:
654
for hook in Merger.hooks['post_merge']:
656
if self.recurse == 'down':
657
for relpath, file_id in self.this_tree.iter_references():
658
sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
659
other_revision = self.other_tree.get_reference_revision(
661
if other_revision == sub_tree.last_revision():
663
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
664
sub_merge.merge_type = self.merge_type
665
other_branch = self.other_branch.reference_parent(file_id,
667
sub_merge.set_other_revision(other_revision, other_branch)
668
base_revision = self.base_tree.get_reference_revision(file_id)
669
sub_merge.base_tree = \
670
sub_tree.branch.repository.revision_tree(base_revision)
671
sub_merge.base_rev_id = base_revision
676
operation = cleanup.OperationWithCleanups(self._do_merge_to)
677
self.this_tree.lock_tree_write()
678
operation.add_cleanup(self.this_tree.unlock)
679
if self.base_tree is not None:
680
self.base_tree.lock_read()
681
operation.add_cleanup(self.base_tree.unlock)
682
if self.other_tree is not None:
683
self.other_tree.lock_read()
684
operation.add_cleanup(self.other_tree.unlock)
685
merge = operation.run_simple()
686
if len(merge.cooked_conflicts) == 0:
687
if not self.ignore_zero and not trace.is_quiet():
688
trace.note(gettext("All changes applied successfully."))
690
trace.note(gettext("%d conflicts encountered.")
691
% len(merge.cooked_conflicts))
693
return len(merge.cooked_conflicts)
696
class _InventoryNoneEntry(object):
697
"""This represents an inventory entry which *isn't there*.
699
It simplifies the merging logic if we always have an InventoryEntry, even
700
if it isn't actually present
707
symlink_target = None
710
_none_entry = _InventoryNoneEntry()
713
class Merge3Merger(object):
714
"""Three-way merger that uses the merge3 text merger"""
716
supports_reprocess = True
717
supports_show_base = True
718
history_based = False
719
supports_cherrypick = True
720
supports_reverse_cherrypick = True
721
winner_idx = {"this": 2, "other": 1, "conflict": 1}
722
supports_lca_trees = True
724
def __init__(self, working_tree, this_tree, base_tree, other_tree,
725
interesting_ids=None, reprocess=False, show_base=False,
726
pb=None, pp=None, change_reporter=None,
727
interesting_files=None, do_merge=True,
728
cherrypick=False, lca_trees=None, this_branch=None,
730
"""Initialize the merger object and perform the merge.
732
:param working_tree: The working tree to apply the merge to
733
:param this_tree: The local tree in the merge operation
734
:param base_tree: The common tree in the merge operation
735
:param other_tree: The other tree to merge changes from
736
:param this_branch: The branch associated with this_tree. Defaults to
737
this_tree.branch if not supplied.
738
:param other_branch: The branch associated with other_tree, if any.
739
:param interesting_ids: The file_ids of files that should be
740
participate in the merge. May not be combined with
742
:param: reprocess If True, perform conflict-reduction processing.
743
:param show_base: If True, show the base revision in text conflicts.
744
(incompatible with reprocess)
746
:param pp: A ProgressPhase object
747
:param change_reporter: An object that should report changes made
748
:param interesting_files: The tree-relative paths of files that should
749
participate in the merge. If these paths refer to directories,
750
the contents of those directories will also be included. May not
751
be combined with interesting_ids. If neither interesting_files nor
752
interesting_ids is specified, all files may participate in the
754
:param lca_trees: Can be set to a dictionary of {revision_id:rev_tree}
755
if the ancestry was found to include a criss-cross merge.
756
Otherwise should be None.
758
object.__init__(self)
759
if interesting_files is not None and interesting_ids is not None:
761
'specify either interesting_ids or interesting_files')
762
if this_branch is None:
763
this_branch = this_tree.branch
764
self.interesting_ids = interesting_ids
765
self.interesting_files = interesting_files
766
self.working_tree = working_tree
767
self.this_tree = this_tree
768
self.base_tree = base_tree
769
self.other_tree = other_tree
770
self.this_branch = this_branch
771
self.other_branch = other_branch
772
self._raw_conflicts = []
773
self.cooked_conflicts = []
774
self.reprocess = reprocess
775
self.show_base = show_base
776
self._lca_trees = lca_trees
777
# Uncommenting this will change the default algorithm to always use
778
# _entries_lca. This can be useful for running the test suite and
779
# making sure we haven't missed any corner cases.
780
# if lca_trees is None:
781
# self._lca_trees = [self.base_tree]
782
self.change_reporter = change_reporter
783
self.cherrypick = cherrypick
787
warnings.warn("pp argument to Merge3Merger is deprecated")
789
warnings.warn("pb argument to Merge3Merger is deprecated")
792
operation = cleanup.OperationWithCleanups(self._do_merge)
793
self.working_tree.lock_tree_write()
794
operation.add_cleanup(self.working_tree.unlock)
795
self.this_tree.lock_read()
796
operation.add_cleanup(self.this_tree.unlock)
797
self.base_tree.lock_read()
798
operation.add_cleanup(self.base_tree.unlock)
799
self.other_tree.lock_read()
800
operation.add_cleanup(self.other_tree.unlock)
803
def _do_merge(self, operation):
804
self.tt = transform.TreeTransform(self.working_tree, None)
805
operation.add_cleanup(self.tt.finalize)
806
self._compute_transform()
807
results = self.tt.apply(no_conflicts=True)
808
self.write_modified(results)
810
self.working_tree.add_conflicts(self.cooked_conflicts)
811
except errors.UnsupportedOperation:
814
def make_preview_transform(self):
815
operation = cleanup.OperationWithCleanups(self._make_preview_transform)
816
self.base_tree.lock_read()
817
operation.add_cleanup(self.base_tree.unlock)
818
self.other_tree.lock_read()
819
operation.add_cleanup(self.other_tree.unlock)
820
return operation.run_simple()
822
def _make_preview_transform(self):
823
self.tt = transform.TransformPreview(self.working_tree)
824
self._compute_transform()
827
def _compute_transform(self):
828
if self._lca_trees is None:
829
entries = self._entries3()
830
resolver = self._three_way
832
entries = self._entries_lca()
833
resolver = self._lca_multi_way
834
# Prepare merge hooks
835
factories = Merger.hooks['merge_file_content']
836
# One hook for each registered one plus our default merger
837
hooks = [factory(self) for factory in factories] + [self]
838
self.active_hooks = [hook for hook in hooks if hook is not None]
839
child_pb = ui.ui_factory.nested_progress_bar()
841
for num, (file_id, changed, parents3, names3,
842
executable3) in enumerate(entries):
843
# Try merging each entry
844
child_pb.update(gettext('Preparing file merge'),
846
self._merge_names(file_id, parents3, names3, resolver=resolver)
848
file_status = self._do_merge_contents(file_id)
850
file_status = 'unmodified'
851
self._merge_executable(file_id,
852
executable3, file_status, resolver=resolver)
855
self.tt.fixup_new_roots()
856
self._finish_computing_transform()
858
def _finish_computing_transform(self):
859
"""Finalize the transform and report the changes.
861
This is the second half of _compute_transform.
863
child_pb = ui.ui_factory.nested_progress_bar()
865
fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
866
lambda t, c: transform.conflict_pass(t, c, self.other_tree))
869
if self.change_reporter is not None:
870
from breezy import delta
871
delta.report_changes(
872
self.tt.iter_changes(), self.change_reporter)
873
self.cook_conflicts(fs_conflicts)
874
for conflict in self.cooked_conflicts:
875
trace.warning(unicode(conflict))
878
"""Gather data about files modified between three trees.
880
Return a list of tuples of file_id, changed, parents3, names3,
881
executable3. changed is a boolean indicating whether the file contents
882
or kind were changed. parents3 is a tuple of parent ids for base,
883
other and this. names3 is a tuple of names for base, other and this.
884
executable3 is a tuple of execute-bit values for base, other and this.
887
iterator = self.other_tree.iter_changes(self.base_tree,
888
specific_files=self.interesting_files,
889
extra_trees=[self.this_tree])
890
this_entries = dict((e.file_id, e) for p, e in
891
self.this_tree.iter_entries_by_dir(
892
self.interesting_ids))
893
for (file_id, paths, changed, versioned, parents, names, kind,
894
executable) in iterator:
895
if (self.interesting_ids is not None and
896
file_id not in self.interesting_ids):
898
entry = this_entries.get(file_id)
899
if entry is not None:
900
this_name = entry.name
901
this_parent = entry.parent_id
902
this_executable = entry.executable
906
this_executable = None
907
parents3 = parents + (this_parent,)
908
names3 = names + (this_name,)
909
executable3 = executable + (this_executable,)
910
result.append((file_id, changed, parents3, names3, executable3))
913
def _entries_lca(self):
914
"""Gather data about files modified between multiple trees.
916
This compares OTHER versus all LCA trees, and for interesting entries,
917
it then compares with THIS and BASE.
919
For the multi-valued entries, the format will be (BASE, [lca1, lca2])
921
:return: [(file_id, changed, parents, names, executable)], where:
923
* file_id: Simple file_id of the entry
924
* changed: Boolean, True if the kind or contents changed else False
925
* parents: ((base, [parent_id, in, lcas]), parent_id_other,
927
* names: ((base, [name, in, lcas]), name_in_other, name_in_this)
928
* executable: ((base, [exec, in, lcas]), exec_in_other,
931
if self.interesting_files is not None:
932
lookup_trees = [self.this_tree, self.base_tree]
933
lookup_trees.extend(self._lca_trees)
934
# I think we should include the lca trees as well
935
interesting_ids = self.other_tree.paths2ids(self.interesting_files,
938
interesting_ids = self.interesting_ids
940
walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
942
base_inventory = self.base_tree.root_inventory
943
this_inventory = self.this_tree.root_inventory
944
for path, file_id, other_ie, lca_values in walker.iter_all():
945
# Is this modified at all from any of the other trees?
947
other_ie = _none_entry
948
if interesting_ids is not None and file_id not in interesting_ids:
951
# If other_revision is found in any of the lcas, that means this
952
# node is uninteresting. This is because when merging, if there are
953
# multiple heads(), we have to create a new node. So if we didn't,
954
# we know that the ancestry is linear, and that OTHER did not
956
# See doc/developers/lca_merge_resolution.txt for details
957
other_revision = other_ie.revision
958
if other_revision is not None:
959
# We can't use this shortcut when other_revision is None,
960
# because it may be None because things are WorkingTrees, and
961
# not because it is *actually* None.
962
is_unmodified = False
963
for lca_path, ie in lca_values:
964
if ie is not None and ie.revision == other_revision:
971
for lca_path, lca_ie in lca_values:
973
lca_entries.append(_none_entry)
975
lca_entries.append(lca_ie)
977
if base_inventory.has_id(file_id):
978
base_ie = base_inventory[file_id]
980
base_ie = _none_entry
982
if this_inventory.has_id(file_id):
983
this_ie = this_inventory[file_id]
985
this_ie = _none_entry
991
for lca_ie in lca_entries:
992
lca_kinds.append(lca_ie.kind)
993
lca_parent_ids.append(lca_ie.parent_id)
994
lca_names.append(lca_ie.name)
995
lca_executable.append(lca_ie.executable)
997
kind_winner = self._lca_multi_way(
998
(base_ie.kind, lca_kinds),
999
other_ie.kind, this_ie.kind)
1000
parent_id_winner = self._lca_multi_way(
1001
(base_ie.parent_id, lca_parent_ids),
1002
other_ie.parent_id, this_ie.parent_id)
1003
name_winner = self._lca_multi_way(
1004
(base_ie.name, lca_names),
1005
other_ie.name, this_ie.name)
1007
content_changed = True
1008
if kind_winner == 'this':
1009
# No kind change in OTHER, see if there are *any* changes
1010
if other_ie.kind == 'directory':
1011
if parent_id_winner == 'this' and name_winner == 'this':
1012
# No change for this directory in OTHER, skip
1014
content_changed = False
1015
elif other_ie.kind is None or other_ie.kind == 'file':
1016
def get_sha1(ie, tree):
1017
if ie.kind != 'file':
1019
return tree.get_file_sha1(file_id)
1020
base_sha1 = get_sha1(base_ie, self.base_tree)
1021
lca_sha1s = [get_sha1(ie, tree) for ie, tree
1022
in zip(lca_entries, self._lca_trees)]
1023
this_sha1 = get_sha1(this_ie, self.this_tree)
1024
other_sha1 = get_sha1(other_ie, self.other_tree)
1025
sha1_winner = self._lca_multi_way(
1026
(base_sha1, lca_sha1s), other_sha1, this_sha1,
1027
allow_overriding_lca=False)
1028
exec_winner = self._lca_multi_way(
1029
(base_ie.executable, lca_executable),
1030
other_ie.executable, this_ie.executable)
1031
if (parent_id_winner == 'this' and name_winner == 'this'
1032
and sha1_winner == 'this' and exec_winner == 'this'):
1033
# No kind, parent, name, exec, or content change for
1034
# OTHER, so this node is not considered interesting
1036
if sha1_winner == 'this':
1037
content_changed = False
1038
elif other_ie.kind == 'symlink':
1039
def get_target(ie, tree):
1040
if ie.kind != 'symlink':
1042
return tree.get_symlink_target(file_id)
1043
base_target = get_target(base_ie, self.base_tree)
1044
lca_targets = [get_target(ie, tree) for ie, tree
1045
in zip(lca_entries, self._lca_trees)]
1046
this_target = get_target(this_ie, self.this_tree)
1047
other_target = get_target(other_ie, self.other_tree)
1048
target_winner = self._lca_multi_way(
1049
(base_target, lca_targets),
1050
other_target, this_target)
1051
if (parent_id_winner == 'this' and name_winner == 'this'
1052
and target_winner == 'this'):
1053
# No kind, parent, name, or symlink target change
1056
if target_winner == 'this':
1057
content_changed = False
1058
elif other_ie.kind == 'tree-reference':
1059
# The 'changed' information seems to be handled at a higher
1060
# level. At least, _entries3 returns False for content
1061
# changed, even when at a new revision_id.
1062
content_changed = False
1063
if (parent_id_winner == 'this' and name_winner == 'this'):
1064
# Nothing interesting
1067
raise AssertionError('unhandled kind: %s' % other_ie.kind)
1069
# If we have gotten this far, that means something has changed
1070
result.append((file_id, content_changed,
1071
((base_ie.parent_id, lca_parent_ids),
1072
other_ie.parent_id, this_ie.parent_id),
1073
((base_ie.name, lca_names),
1074
other_ie.name, this_ie.name),
1075
((base_ie.executable, lca_executable),
1076
other_ie.executable, this_ie.executable)
1080
def write_modified(self, results):
1081
modified_hashes = {}
1082
for path in results.modified_paths:
1083
file_id = self.working_tree.path2id(self.working_tree.relpath(path))
1086
hash = self.working_tree.get_file_sha1(file_id)
1089
modified_hashes[file_id] = hash
1090
self.working_tree.set_merge_modified(modified_hashes)
1093
def parent(entry, file_id):
1094
"""Determine the parent for a file_id (used as a key method)"""
1097
return entry.parent_id
1100
def name(entry, file_id):
1101
"""Determine the name for a file_id (used as a key method)"""
1107
def contents_sha1(tree, file_id):
1108
"""Determine the sha1 of the file contents (used as a key method)."""
1109
if not tree.has_id(file_id):
1111
return tree.get_file_sha1(file_id)
1114
def executable(tree, file_id):
1115
"""Determine the executability of a file-id (used as a key method)."""
1116
if not tree.has_id(file_id):
1118
if tree.kind(file_id) != "file":
1120
return tree.is_executable(file_id)
1123
def kind(tree, file_id):
1124
"""Determine the kind of a file-id (used as a key method)."""
1125
if not tree.has_id(file_id):
1127
return tree.kind(file_id)
1130
def _three_way(base, other, this):
1132
# if 'base == other', either they all agree, or only 'this' has
1135
elif this not in (base, other):
1136
# 'this' is neither 'base' nor 'other', so both sides changed
1139
# "Ambiguous clean merge" -- both sides have made the same change.
1142
# this == base: only other has changed.
1146
def _lca_multi_way(bases, other, this, allow_overriding_lca=True):
1147
"""Consider LCAs when determining whether a change has occurred.
1149
If LCAS are all identical, this is the same as a _three_way comparison.
1151
:param bases: value in (BASE, [LCAS])
1152
:param other: value in OTHER
1153
:param this: value in THIS
1154
:param allow_overriding_lca: If there is more than one unique lca
1155
value, allow OTHER to override THIS if it has a new value, and
1156
THIS only has an lca value, or vice versa. This is appropriate for
1157
truly scalar values, not as much for non-scalars.
1158
:return: 'this', 'other', or 'conflict' depending on whether an entry
1161
# See doc/developers/lca_tree_merging.txt for details about this
1164
# Either Ambiguously clean, or nothing was actually changed. We
1167
base_val, lca_vals = bases
1168
# Remove 'base_val' from the lca_vals, because it is not interesting
1169
filtered_lca_vals = [lca_val for lca_val in lca_vals
1170
if lca_val != base_val]
1171
if len(filtered_lca_vals) == 0:
1172
return Merge3Merger._three_way(base_val, other, this)
1174
unique_lca_vals = set(filtered_lca_vals)
1175
if len(unique_lca_vals) == 1:
1176
return Merge3Merger._three_way(unique_lca_vals.pop(), other, this)
1178
if allow_overriding_lca:
1179
if other in unique_lca_vals:
1180
if this in unique_lca_vals:
1181
# Each side picked a different lca, conflict
1184
# This has a value which supersedes both lca values, and
1185
# other only has an lca value
1187
elif this in unique_lca_vals:
1188
# OTHER has a value which supersedes both lca values, and this
1189
# only has an lca value
1192
# At this point, the lcas disagree, and the tip disagree
1195
def merge_names(self, file_id):
1196
def get_entry(tree):
1198
return tree.root_inventory[file_id]
1199
except errors.NoSuchId:
1201
this_entry = get_entry(self.this_tree)
1202
other_entry = get_entry(self.other_tree)
1203
base_entry = get_entry(self.base_tree)
1204
entries = (base_entry, other_entry, this_entry)
1207
for entry in entries:
1210
parents.append(None)
1212
names.append(entry.name)
1213
parents.append(entry.parent_id)
1214
return self._merge_names(file_id, parents, names,
1215
resolver=self._three_way)
1217
def _merge_names(self, file_id, parents, names, resolver):
1218
"""Perform a merge on file_id names and parents"""
1219
base_name, other_name, this_name = names
1220
base_parent, other_parent, this_parent = parents
1222
name_winner = resolver(*names)
1224
parent_id_winner = resolver(*parents)
1225
if this_name is None:
1226
if name_winner == "this":
1227
name_winner = "other"
1228
if parent_id_winner == "this":
1229
parent_id_winner = "other"
1230
if name_winner == "this" and parent_id_winner == "this":
1232
if name_winner == 'conflict' or parent_id_winner == 'conflict':
1233
# Creating helpers (.OTHER or .THIS) here cause problems down the
1234
# road if a ContentConflict needs to be created so we should not do
1236
trans_id = self.tt.trans_id_file_id(file_id)
1237
self._raw_conflicts.append(('path conflict', trans_id, file_id,
1238
this_parent, this_name,
1239
other_parent, other_name))
1240
if not self.other_tree.has_id(file_id):
1241
# it doesn't matter whether the result was 'other' or
1242
# 'conflict'-- if it has no file id, we leave it alone.
1244
parent_id = parents[self.winner_idx[parent_id_winner]]
1245
name = names[self.winner_idx[name_winner]]
1246
if parent_id is not None or name is not None:
1247
# if we get here, name_winner and parent_winner are set to safe
1249
if parent_id is None and name is not None:
1250
# if parent_id is None and name is non-None, current file is
1252
if names[self.winner_idx[parent_id_winner]] != '':
1253
raise AssertionError(
1254
'File looks like a root, but named %s' %
1255
names[self.winner_idx[parent_id_winner]])
1256
parent_trans_id = transform.ROOT_PARENT
1258
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1259
self.tt.adjust_path(name, parent_trans_id,
1260
self.tt.trans_id_file_id(file_id))
1262
def _do_merge_contents(self, file_id):
1263
"""Performs a merge on file_id contents."""
1264
def contents_pair(tree):
1265
if not tree.has_id(file_id):
1267
kind = tree.kind(file_id)
1269
contents = tree.get_file_sha1(file_id)
1270
elif kind == "symlink":
1271
contents = tree.get_symlink_target(file_id)
1274
return kind, contents
1276
# See SPOT run. run, SPOT, run.
1277
# So we're not QUITE repeating ourselves; we do tricky things with
1279
base_pair = contents_pair(self.base_tree)
1280
other_pair = contents_pair(self.other_tree)
1282
this_pair = contents_pair(self.this_tree)
1283
lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1284
winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1285
this_pair, allow_overriding_lca=False)
1287
if base_pair == other_pair:
1290
# We delayed evaluating this_pair as long as we can to avoid
1291
# unnecessary sha1 calculation
1292
this_pair = contents_pair(self.this_tree)
1293
winner = self._three_way(base_pair, other_pair, this_pair)
1294
if winner == 'this':
1295
# No interesting changes introduced by OTHER
1297
# We have a hypothetical conflict, but if we have files, then we
1298
# can try to merge the content
1299
trans_id = self.tt.trans_id_file_id(file_id)
1300
params = MergeFileHookParams(self, file_id, trans_id, this_pair[0],
1301
other_pair[0], winner)
1302
hooks = self.active_hooks
1303
hook_status = 'not_applicable'
1305
hook_status, lines = hook.merge_contents(params)
1306
if hook_status != 'not_applicable':
1307
# Don't try any more hooks, this one applies.
1309
# If the merge ends up replacing the content of the file, we get rid of
1310
# it at the end of this method (this variable is used to track the
1311
# exceptions to this rule).
1314
if hook_status == 'not_applicable':
1315
# No merge hook was able to resolve the situation. Two cases exist:
1316
# a content conflict or a duplicate one.
1318
name = self.tt.final_name(trans_id)
1319
parent_id = self.tt.final_parent(trans_id)
1321
inhibit_content_conflict = False
1322
if params.this_kind is None: # file_id is not in THIS
1323
# Is the name used for a different file_id ?
1324
dupe_path = self.other_tree.id2path(file_id)
1325
this_id = self.this_tree.path2id(dupe_path)
1326
if this_id is not None:
1327
# Two entries for the same path
1329
# versioning the merged file will trigger a duplicate
1331
self.tt.version_file(file_id, trans_id)
1332
transform.create_from_tree(
1333
self.tt, trans_id, self.other_tree, file_id,
1334
filter_tree_path=self._get_filter_tree_path(file_id))
1335
inhibit_content_conflict = True
1336
elif params.other_kind is None: # file_id is not in OTHER
1337
# Is the name used for a different file_id ?
1338
dupe_path = self.this_tree.id2path(file_id)
1339
other_id = self.other_tree.path2id(dupe_path)
1340
if other_id is not None:
1341
# Two entries for the same path again, but here, the other
1342
# entry will also be merged. We simply inhibit the
1343
# 'content' conflict creation because we know OTHER will
1344
# create (or has already created depending on ordering) an
1345
# entry at the same path. This will trigger a 'duplicate'
1348
inhibit_content_conflict = True
1349
if not inhibit_content_conflict:
1350
if params.this_kind is not None:
1351
self.tt.unversion_file(trans_id)
1352
# This is a contents conflict, because none of the available
1353
# functions could merge it.
1354
file_group = self._dump_conflicts(name, parent_id, file_id,
1356
self._raw_conflicts.append(('contents conflict', file_group))
1357
elif hook_status == 'success':
1358
self.tt.create_file(lines, trans_id)
1359
elif hook_status == 'conflicted':
1360
# XXX: perhaps the hook should be able to provide
1361
# the BASE/THIS/OTHER files?
1362
self.tt.create_file(lines, trans_id)
1363
self._raw_conflicts.append(('text conflict', trans_id))
1364
name = self.tt.final_name(trans_id)
1365
parent_id = self.tt.final_parent(trans_id)
1366
self._dump_conflicts(name, parent_id, file_id)
1367
elif hook_status == 'delete':
1368
self.tt.unversion_file(trans_id)
1370
elif hook_status == 'done':
1371
# The hook function did whatever it needs to do directly, no
1372
# further action needed here.
1375
raise AssertionError('unknown hook_status: %r' % (hook_status,))
1376
if not self.this_tree.has_id(file_id) and result == "modified":
1377
self.tt.version_file(file_id, trans_id)
1379
# The merge has been performed and produced a new content, so the
1380
# old contents should not be retained.
1381
self.tt.delete_contents(trans_id)
1384
def _default_other_winner_merge(self, merge_hook_params):
1385
"""Replace this contents with other."""
1386
file_id = merge_hook_params.file_id
1387
trans_id = merge_hook_params.trans_id
1388
if self.other_tree.has_id(file_id):
1389
# OTHER changed the file
1390
transform.create_from_tree(
1391
self.tt, trans_id, self.other_tree, file_id,
1392
filter_tree_path=self._get_filter_tree_path(file_id))
1394
elif self.this_tree.has_id(file_id):
1395
# OTHER deleted the file
1396
return 'delete', None
1398
raise AssertionError(
1399
'winner is OTHER, but file_id %r not in THIS or OTHER tree'
1402
def merge_contents(self, merge_hook_params):
1403
"""Fallback merge logic after user installed hooks."""
1404
# This function is used in merge hooks as the fallback instance.
1405
# Perhaps making this function and the functions it calls be a
1406
# a separate class would be better.
1407
if merge_hook_params.winner == 'other':
1408
# OTHER is a straight winner, so replace this contents with other
1409
return self._default_other_winner_merge(merge_hook_params)
1410
elif merge_hook_params.is_file_merge():
1411
# THIS and OTHER are both files, so text merge. Either
1412
# BASE is a file, or both converted to files, so at least we
1413
# have agreement that output should be a file.
1415
self.text_merge(merge_hook_params.file_id,
1416
merge_hook_params.trans_id)
1417
except errors.BinaryFile:
1418
return 'not_applicable', None
1421
return 'not_applicable', None
1423
def get_lines(self, tree, file_id):
1424
"""Return the lines in a file, or an empty list."""
1425
if tree.has_id(file_id):
1426
return tree.get_file_lines(file_id)
1430
def text_merge(self, file_id, trans_id):
1431
"""Perform a three-way text merge on a file_id"""
1432
# it's possible that we got here with base as a different type.
1433
# if so, we just want two-way text conflicts.
1434
if self.base_tree.has_id(file_id) and \
1435
self.base_tree.kind(file_id) == "file":
1436
base_lines = self.get_lines(self.base_tree, file_id)
1439
other_lines = self.get_lines(self.other_tree, file_id)
1440
this_lines = self.get_lines(self.this_tree, file_id)
1441
m3 = merge3.Merge3(base_lines, this_lines, other_lines,
1442
is_cherrypick=self.cherrypick)
1443
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
1444
if self.show_base is True:
1445
base_marker = '|' * 7
1449
def iter_merge3(retval):
1450
retval["text_conflicts"] = False
1451
for line in m3.merge_lines(name_a = "TREE",
1452
name_b = "MERGE-SOURCE",
1453
name_base = "BASE-REVISION",
1454
start_marker=start_marker,
1455
base_marker=base_marker,
1456
reprocess=self.reprocess):
1457
if line.startswith(start_marker):
1458
retval["text_conflicts"] = True
1459
yield line.replace(start_marker, '<' * 7)
1463
merge3_iterator = iter_merge3(retval)
1464
self.tt.create_file(merge3_iterator, trans_id)
1465
if retval["text_conflicts"] is True:
1466
self._raw_conflicts.append(('text conflict', trans_id))
1467
name = self.tt.final_name(trans_id)
1468
parent_id = self.tt.final_parent(trans_id)
1469
file_group = self._dump_conflicts(name, parent_id, file_id,
1470
this_lines, base_lines,
1472
file_group.append(trans_id)
1475
def _get_filter_tree_path(self, file_id):
1476
if self.this_tree.supports_content_filtering():
1477
# We get the path from the working tree if it exists.
1478
# That fails though when OTHER is adding a file, so
1479
# we fall back to the other tree to find the path if
1480
# it doesn't exist locally.
1482
return self.this_tree.id2path(file_id)
1483
except errors.NoSuchId:
1484
return self.other_tree.id2path(file_id)
1485
# Skip the id2path lookup for older formats
1488
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
1489
base_lines=None, other_lines=None, set_version=False,
1491
"""Emit conflict files.
1492
If this_lines, base_lines, or other_lines are omitted, they will be
1493
determined automatically. If set_version is true, the .OTHER, .THIS
1494
or .BASE (in that order) will be created as versioned files.
1496
data = [('OTHER', self.other_tree, other_lines),
1497
('THIS', self.this_tree, this_lines)]
1499
data.append(('BASE', self.base_tree, base_lines))
1501
# We need to use the actual path in the working tree of the file here,
1502
# ignoring the conflict suffixes
1504
if wt.supports_content_filtering():
1506
filter_tree_path = wt.id2path(file_id)
1507
except errors.NoSuchId:
1508
# file has been deleted
1509
filter_tree_path = None
1511
# Skip the id2path lookup for older formats
1512
filter_tree_path = None
1516
for suffix, tree, lines in data:
1517
if tree.has_id(file_id):
1518
trans_id = self._conflict_file(name, parent_id, tree, file_id,
1519
suffix, lines, filter_tree_path)
1520
file_group.append(trans_id)
1521
if set_version and not versioned:
1522
self.tt.version_file(file_id, trans_id)
1526
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1527
lines=None, filter_tree_path=None):
1528
"""Emit a single conflict file."""
1529
name = name + '.' + suffix
1530
trans_id = self.tt.create_path(name, parent_id)
1531
transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
1535
def merge_executable(self, file_id, file_status):
1536
"""Perform a merge on the execute bit."""
1537
executable = [self.executable(t, file_id) for t in (self.base_tree,
1538
self.other_tree, self.this_tree)]
1539
self._merge_executable(file_id, executable, file_status,
1540
resolver=self._three_way)
1542
def _merge_executable(self, file_id, executable, file_status,
1544
"""Perform a merge on the execute bit."""
1545
base_executable, other_executable, this_executable = executable
1546
if file_status == "deleted":
1548
winner = resolver(*executable)
1549
if winner == "conflict":
1550
# There must be a None in here, if we have a conflict, but we
1551
# need executability since file status was not deleted.
1552
if self.executable(self.other_tree, file_id) is None:
1556
if winner == 'this' and file_status != "modified":
1558
trans_id = self.tt.trans_id_file_id(file_id)
1559
if self.tt.final_kind(trans_id) != "file":
1561
if winner == "this":
1562
executability = this_executable
1564
if self.other_tree.has_id(file_id):
1565
executability = other_executable
1566
elif self.this_tree.has_id(file_id):
1567
executability = this_executable
1568
elif self.base_tree_has_id(file_id):
1569
executability = base_executable
1570
if executability is not None:
1571
trans_id = self.tt.trans_id_file_id(file_id)
1572
self.tt.set_executability(executability, trans_id)
1574
def cook_conflicts(self, fs_conflicts):
1575
"""Convert all conflicts into a form that doesn't depend on trans_id"""
1576
content_conflict_file_ids = set()
1577
cooked_conflicts = transform.cook_conflicts(fs_conflicts, self.tt)
1578
fp = transform.FinalPaths(self.tt)
1579
for conflict in self._raw_conflicts:
1580
conflict_type = conflict[0]
1581
if conflict_type == 'path conflict':
1583
this_parent, this_name,
1584
other_parent, other_name) = conflict[1:]
1585
if this_parent is None or this_name is None:
1586
this_path = '<deleted>'
1588
parent_path = fp.get_path(
1589
self.tt.trans_id_file_id(this_parent))
1590
this_path = osutils.pathjoin(parent_path, this_name)
1591
if other_parent is None or other_name is None:
1592
other_path = '<deleted>'
1594
if other_parent == self.other_tree.get_root_id():
1595
# The tree transform doesn't know about the other root,
1596
# so we special case here to avoid a NoFinalPath
1600
parent_path = fp.get_path(
1601
self.tt.trans_id_file_id(other_parent))
1602
other_path = osutils.pathjoin(parent_path, other_name)
1603
c = _mod_conflicts.Conflict.factory(
1604
'path conflict', path=this_path,
1605
conflict_path=other_path,
1607
elif conflict_type == 'contents conflict':
1608
for trans_id in conflict[1]:
1609
file_id = self.tt.final_file_id(trans_id)
1610
if file_id is not None:
1611
# Ok we found the relevant file-id
1613
path = fp.get_path(trans_id)
1614
for suffix in ('.BASE', '.THIS', '.OTHER'):
1615
if path.endswith(suffix):
1616
# Here is the raw path
1617
path = path[:-len(suffix)]
1619
c = _mod_conflicts.Conflict.factory(conflict_type,
1620
path=path, file_id=file_id)
1621
content_conflict_file_ids.add(file_id)
1622
elif conflict_type == 'text conflict':
1623
trans_id = conflict[1]
1624
path = fp.get_path(trans_id)
1625
file_id = self.tt.final_file_id(trans_id)
1626
c = _mod_conflicts.Conflict.factory(conflict_type,
1627
path=path, file_id=file_id)
1629
raise AssertionError('bad conflict type: %r' % (conflict,))
1630
cooked_conflicts.append(c)
1632
self.cooked_conflicts = []
1633
# We want to get rid of path conflicts when a corresponding contents
1634
# conflict exists. This can occur when one branch deletes a file while
1635
# the other renames *and* modifies it. In this case, the content
1636
# conflict is enough.
1637
for c in cooked_conflicts:
1638
if (c.typestring == 'path conflict'
1639
and c.file_id in content_conflict_file_ids):
1641
self.cooked_conflicts.append(c)
1642
self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1645
class WeaveMerger(Merge3Merger):
1646
"""Three-way tree merger, text weave merger."""
1647
supports_reprocess = True
1648
supports_show_base = False
1649
supports_reverse_cherrypick = False
1650
history_based = True
1652
def _generate_merge_plan(self, file_id, base):
1653
return self.this_tree.plan_file_merge(file_id, self.other_tree,
1656
def _merged_lines(self, file_id):
1657
"""Generate the merged lines.
1658
There is no distinction between lines that are meant to contain <<<<<<<
1662
base = self.base_tree
1665
plan = self._generate_merge_plan(file_id, base)
1666
if 'merge' in debug.debug_flags:
1668
trans_id = self.tt.trans_id_file_id(file_id)
1669
name = self.tt.final_name(trans_id) + '.plan'
1670
contents = ('%11s|%s' % l for l in plan)
1671
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1672
textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1673
'>>>>>>> MERGE-SOURCE\n')
1674
lines, conflicts = textmerge.merge_lines(self.reprocess)
1676
base_lines = textmerge.base_from_plan()
1679
return lines, base_lines
1681
def text_merge(self, file_id, trans_id):
1682
"""Perform a (weave) text merge for a given file and file-id.
1683
If conflicts are encountered, .THIS and .OTHER files will be emitted,
1684
and a conflict will be noted.
1686
lines, base_lines = self._merged_lines(file_id)
1688
# Note we're checking whether the OUTPUT is binary in this case,
1689
# because we don't want to get into weave merge guts.
1690
textfile.check_text_lines(lines)
1691
self.tt.create_file(lines, trans_id)
1692
if base_lines is not None:
1694
self._raw_conflicts.append(('text conflict', trans_id))
1695
name = self.tt.final_name(trans_id)
1696
parent_id = self.tt.final_parent(trans_id)
1697
file_group = self._dump_conflicts(name, parent_id, file_id,
1699
base_lines=base_lines)
1700
file_group.append(trans_id)
1703
class LCAMerger(WeaveMerger):
1705
def _generate_merge_plan(self, file_id, base):
1706
return self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1709
class Diff3Merger(Merge3Merger):
1710
"""Three-way merger using external diff3 for text merging"""
1712
def dump_file(self, temp_dir, name, tree, file_id):
1713
out_path = osutils.pathjoin(temp_dir, name)
1714
out_file = open(out_path, "wb")
1716
in_file = tree.get_file(file_id)
1717
for line in in_file:
1718
out_file.write(line)
1723
def text_merge(self, file_id, trans_id):
1724
"""Perform a diff3 merge using a specified file-id and trans-id.
1725
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
1726
will be dumped, and a will be conflict noted.
1729
temp_dir = osutils.mkdtemp(prefix="bzr-")
1731
new_file = osutils.pathjoin(temp_dir, "new")
1732
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
1733
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
1734
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
1735
status = breezy.patch.diff3(new_file, this, base, other)
1736
if status not in (0, 1):
1737
raise errors.BzrError("Unhandled diff3 exit code")
1738
f = open(new_file, 'rb')
1740
self.tt.create_file(f, trans_id)
1744
name = self.tt.final_name(trans_id)
1745
parent_id = self.tt.final_parent(trans_id)
1746
self._dump_conflicts(name, parent_id, file_id)
1747
self._raw_conflicts.append(('text conflict', trans_id))
1749
osutils.rmtree(temp_dir)
1752
class PathNotInTree(errors.BzrError):
1754
_fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
1756
def __init__(self, path, tree):
1757
errors.BzrError.__init__(self, path=path, tree=tree)
1760
class MergeIntoMerger(Merger):
1761
"""Merger that understands other_tree will be merged into a subdir.
1763
This also changes the Merger api so that it uses real Branch, revision_id,
1764
and RevisonTree objects, rather than using revision specs.
1767
def __init__(self, this_tree, other_branch, other_tree, target_subdir,
1768
source_subpath, other_rev_id=None):
1769
"""Create a new MergeIntoMerger object.
1771
source_subpath in other_tree will be effectively copied to
1772
target_subdir in this_tree.
1774
:param this_tree: The tree that we will be merging into.
1775
:param other_branch: The Branch we will be merging from.
1776
:param other_tree: The RevisionTree object we want to merge.
1777
:param target_subdir: The relative path where we want to merge
1778
other_tree into this_tree
1779
:param source_subpath: The relative path specifying the subtree of
1780
other_tree to merge into this_tree.
1782
# It is assumed that we are merging a tree that is not in our current
1783
# ancestry, which means we are using the "EmptyTree" as our basis.
1784
null_ancestor_tree = this_tree.branch.repository.revision_tree(
1785
_mod_revision.NULL_REVISION)
1786
super(MergeIntoMerger, self).__init__(
1787
this_branch=this_tree.branch,
1788
this_tree=this_tree,
1789
other_tree=other_tree,
1790
base_tree=null_ancestor_tree,
1792
self._target_subdir = target_subdir
1793
self._source_subpath = source_subpath
1794
self.other_branch = other_branch
1795
if other_rev_id is None:
1796
other_rev_id = other_tree.get_revision_id()
1797
self.other_rev_id = self.other_basis = other_rev_id
1798
self.base_is_ancestor = True
1799
self.backup_files = True
1800
self.merge_type = Merge3Merger
1801
self.show_base = False
1802
self.reprocess = False
1803
self.interesting_ids = None
1804
self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
1805
target_subdir=self._target_subdir,
1806
source_subpath=self._source_subpath)
1807
if self._source_subpath != '':
1808
# If this isn't a partial merge make sure the revisions will be
1810
self._maybe_fetch(self.other_branch, self.this_branch,
1813
def set_pending(self):
1814
if self._source_subpath != '':
1816
Merger.set_pending(self)
1819
class _MergeTypeParameterizer(object):
1820
"""Wrap a merge-type class to provide extra parameters.
1822
This is hack used by MergeIntoMerger to pass some extra parameters to its
1823
merge_type. Merger.do_merge() sets up its own set of parameters to pass to
1824
the 'merge_type' member. It is difficult override do_merge without
1825
re-writing the whole thing, so instead we create a wrapper which will pass
1826
the extra parameters.
1829
def __init__(self, merge_type, **kwargs):
1830
self._extra_kwargs = kwargs
1831
self._merge_type = merge_type
1833
def __call__(self, *args, **kwargs):
1834
kwargs.update(self._extra_kwargs)
1835
return self._merge_type(*args, **kwargs)
1837
def __getattr__(self, name):
1838
return getattr(self._merge_type, name)
1841
class MergeIntoMergeType(Merge3Merger):
1842
"""Merger that incorporates a tree (or part of a tree) into another."""
1844
def __init__(self, *args, **kwargs):
1845
"""Initialize the merger object.
1847
:param args: See Merge3Merger.__init__'s args.
1848
:param kwargs: See Merge3Merger.__init__'s keyword args, except for
1849
source_subpath and target_subdir.
1850
:keyword source_subpath: The relative path specifying the subtree of
1851
other_tree to merge into this_tree.
1852
:keyword target_subdir: The relative path where we want to merge
1853
other_tree into this_tree
1855
# All of the interesting work happens during Merge3Merger.__init__(),
1856
# so we have have to hack in to get our extra parameters set.
1857
self._source_subpath = kwargs.pop('source_subpath')
1858
self._target_subdir = kwargs.pop('target_subdir')
1859
super(MergeIntoMergeType, self).__init__(*args, **kwargs)
1861
def _compute_transform(self):
1862
child_pb = ui.ui_factory.nested_progress_bar()
1864
entries = self._entries_to_incorporate()
1865
entries = list(entries)
1866
for num, (entry, parent_id) in enumerate(entries):
1867
child_pb.update(gettext('Preparing file merge'), num, len(entries))
1868
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1869
trans_id = transform.new_by_entry(self.tt, entry,
1870
parent_trans_id, self.other_tree)
1873
self._finish_computing_transform()
1875
def _entries_to_incorporate(self):
1876
"""Yields pairs of (inventory_entry, new_parent)."""
1877
other_inv = self.other_tree.root_inventory
1878
subdir_id = other_inv.path2id(self._source_subpath)
1879
if subdir_id is None:
1880
# XXX: The error would be clearer if it gave the URL of the source
1881
# branch, but we don't have a reference to that here.
1882
raise PathNotInTree(self._source_subpath, "Source tree")
1883
subdir = other_inv[subdir_id]
1884
parent_in_target = osutils.dirname(self._target_subdir)
1885
target_id = self.this_tree.path2id(parent_in_target)
1886
if target_id is None:
1887
raise PathNotInTree(self._target_subdir, "Target tree")
1888
name_in_target = osutils.basename(self._target_subdir)
1889
merge_into_root = subdir.copy()
1890
merge_into_root.name = name_in_target
1891
if self.this_tree.has_id(merge_into_root.file_id):
1892
# Give the root a new file-id.
1893
# This can happen fairly easily if the directory we are
1894
# incorporating is the root, and both trees have 'TREE_ROOT' as
1895
# their root_id. Users will expect this to Just Work, so we
1896
# change the file-id here.
1897
# Non-root file-ids could potentially conflict too. That's really
1898
# an edge case, so we don't do anything special for those. We let
1899
# them cause conflicts.
1900
merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
1901
yield (merge_into_root, target_id)
1902
if subdir.kind != 'directory':
1903
# No children, so we are done.
1905
for ignored_path, entry in other_inv.iter_entries_by_dir(subdir_id):
1906
parent_id = entry.parent_id
1907
if parent_id == subdir.file_id:
1908
# The root's parent ID has changed, so make sure children of
1909
# the root refer to the new ID.
1910
parent_id = merge_into_root.file_id
1911
yield (entry, parent_id)
1914
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1916
merge_type=Merge3Merger,
1917
interesting_ids=None,
1921
interesting_files=None,
1924
change_reporter=None):
1925
"""Primary interface for merging.
1927
Typical use is probably::
1929
merge_inner(branch, branch.get_revision_tree(other_revision),
1930
branch.get_revision_tree(base_revision))
1932
if this_tree is None:
1933
raise errors.BzrError("breezy.merge.merge_inner requires a this_tree "
1935
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1936
pb=pb, change_reporter=change_reporter)
1937
merger.backup_files = backup_files
1938
merger.merge_type = merge_type
1939
merger.interesting_ids = interesting_ids
1940
merger.ignore_zero = ignore_zero
1941
if interesting_files:
1943
raise ValueError('Only supply interesting_ids'
1944
' or interesting_files')
1945
merger.interesting_files = interesting_files
1946
merger.show_base = show_base
1947
merger.reprocess = reprocess
1948
merger.other_rev_id = other_rev_id
1949
merger.other_basis = other_rev_id
1950
get_revision_id = getattr(base_tree, 'get_revision_id', None)
1951
if get_revision_id is None:
1952
get_revision_id = base_tree.last_revision
1953
merger.cache_trees_with_revision_ids([other_tree, base_tree, this_tree])
1954
merger.set_base_revision(get_revision_id(), this_branch)
1955
return merger.do_merge()
1958
merge_type_registry = registry.Registry()
1959
merge_type_registry.register('diff3', Diff3Merger,
1960
"Merge using external diff3.")
1961
merge_type_registry.register('lca', LCAMerger,
1962
"LCA-newness merge.")
1963
merge_type_registry.register('merge3', Merge3Merger,
1964
"Native diff3-style merge.")
1965
merge_type_registry.register('weave', WeaveMerger,
1966
"Weave-based merge.")
1969
def get_merge_type_registry():
1970
"""Merge type registry was previously in breezy.option
1972
This method provides a backwards compatible way to retrieve it.
1974
return merge_type_registry
1977
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
1978
def status_a(revision, text):
1979
if revision in ancestors_b:
1980
return 'killed-b', text
1982
return 'new-a', text
1984
def status_b(revision, text):
1985
if revision in ancestors_a:
1986
return 'killed-a', text
1988
return 'new-b', text
1990
plain_a = [t for (a, t) in annotated_a]
1991
plain_b = [t for (a, t) in annotated_b]
1992
matcher = patiencediff.PatienceSequenceMatcher(None, plain_a, plain_b)
1993
blocks = matcher.get_matching_blocks()
1996
for ai, bi, l in blocks:
1997
# process all mismatched sections
1998
# (last mismatched section is handled because blocks always
1999
# includes a 0-length last block)
2000
for revision, text in annotated_a[a_cur:ai]:
2001
yield status_a(revision, text)
2002
for revision, text in annotated_b[b_cur:bi]:
2003
yield status_b(revision, text)
2004
# and now the matched section
2007
for text_a in plain_a[ai:a_cur]:
2008
yield "unchanged", text_a
2011
class _PlanMergeBase(object):
2013
def __init__(self, a_rev, b_rev, vf, key_prefix):
2016
:param a_rev: Revision-id of one revision to merge
2017
:param b_rev: Revision-id of the other revision to merge
2018
:param vf: A VersionedFiles containing both revisions
2019
:param key_prefix: A prefix for accessing keys in vf, typically
2025
self._last_lines = None
2026
self._last_lines_revision_id = None
2027
self._cached_matching_blocks = {}
2028
self._key_prefix = key_prefix
2029
self._precache_tip_lines()
2031
def _precache_tip_lines(self):
2032
lines = self.get_lines([self.a_rev, self.b_rev])
2033
self.lines_a = lines[self.a_rev]
2034
self.lines_b = lines[self.b_rev]
2036
def get_lines(self, revisions):
2037
"""Get lines for revisions from the backing VersionedFiles.
2039
:raises RevisionNotPresent: on absent texts.
2041
keys = [(self._key_prefix + (rev,)) for rev in revisions]
2043
for record in self.vf.get_record_stream(keys, 'unordered', True):
2044
if record.storage_kind == 'absent':
2045
raise errors.RevisionNotPresent(record.key, self.vf)
2046
result[record.key[-1]] = osutils.chunks_to_lines(
2047
record.get_bytes_as('chunked'))
2050
def plan_merge(self):
2051
"""Generate a 'plan' for merging the two revisions.
2053
This involves comparing their texts and determining the cause of
2054
differences. If text A has a line and text B does not, then either the
2055
line was added to text A, or it was deleted from B. Once the causes
2056
are combined, they are written out in the format described in
2057
VersionedFile.plan_merge
2059
blocks = self._get_matching_blocks(self.a_rev, self.b_rev)
2060
unique_a, unique_b = self._unique_lines(blocks)
2061
new_a, killed_b = self._determine_status(self.a_rev, unique_a)
2062
new_b, killed_a = self._determine_status(self.b_rev, unique_b)
2063
return self._iter_plan(blocks, new_a, killed_b, new_b, killed_a)
2065
def _iter_plan(self, blocks, new_a, killed_b, new_b, killed_a):
2068
for i, j, n in blocks:
2069
for a_index in range(last_i, i):
2070
if a_index in new_a:
2071
if a_index in killed_b:
2072
yield 'conflicted-a', self.lines_a[a_index]
2074
yield 'new-a', self.lines_a[a_index]
2076
yield 'killed-b', self.lines_a[a_index]
2077
for b_index in range(last_j, j):
2078
if b_index in new_b:
2079
if b_index in killed_a:
2080
yield 'conflicted-b', self.lines_b[b_index]
2082
yield 'new-b', self.lines_b[b_index]
2084
yield 'killed-a', self.lines_b[b_index]
2085
# handle common lines
2086
for a_index in range(i, i+n):
2087
yield 'unchanged', self.lines_a[a_index]
2091
def _get_matching_blocks(self, left_revision, right_revision):
2092
"""Return a description of which sections of two revisions match.
2094
See SequenceMatcher.get_matching_blocks
2096
cached = self._cached_matching_blocks.get((left_revision,
2098
if cached is not None:
2100
if self._last_lines_revision_id == left_revision:
2101
left_lines = self._last_lines
2102
right_lines = self.get_lines([right_revision])[right_revision]
2104
lines = self.get_lines([left_revision, right_revision])
2105
left_lines = lines[left_revision]
2106
right_lines = lines[right_revision]
2107
self._last_lines = right_lines
2108
self._last_lines_revision_id = right_revision
2109
matcher = patiencediff.PatienceSequenceMatcher(None, left_lines,
2111
return matcher.get_matching_blocks()
2113
def _unique_lines(self, matching_blocks):
2114
"""Analyse matching_blocks to determine which lines are unique
2116
:return: a tuple of (unique_left, unique_right), where the values are
2117
sets of line numbers of unique lines.
2123
for i, j, n in matching_blocks:
2124
unique_left.extend(range(last_i, i))
2125
unique_right.extend(range(last_j, j))
2128
return unique_left, unique_right
2131
def _subtract_plans(old_plan, new_plan):
2132
"""Remove changes from new_plan that came from old_plan.
2134
It is assumed that the difference between the old_plan and new_plan
2135
is their choice of 'b' text.
2137
All lines from new_plan that differ from old_plan are emitted
2138
verbatim. All lines from new_plan that match old_plan but are
2139
not about the 'b' revision are emitted verbatim.
2141
Lines that match and are about the 'b' revision are the lines we
2142
don't want, so we convert 'killed-b' -> 'unchanged', and 'new-b'
2143
is skipped entirely.
2145
matcher = patiencediff.PatienceSequenceMatcher(None, old_plan,
2148
for i, j, n in matcher.get_matching_blocks():
2149
for jj in range(last_j, j):
2151
for jj in range(j, j+n):
2152
plan_line = new_plan[jj]
2153
if plan_line[0] == 'new-b':
2155
elif plan_line[0] == 'killed-b':
2156
yield 'unchanged', plan_line[1]
2162
class _PlanMerge(_PlanMergeBase):
2163
"""Plan an annotate merge using on-the-fly annotation"""
2165
def __init__(self, a_rev, b_rev, vf, key_prefix):
2166
super(_PlanMerge, self).__init__(a_rev, b_rev, vf, key_prefix)
2167
self.a_key = self._key_prefix + (self.a_rev,)
2168
self.b_key = self._key_prefix + (self.b_rev,)
2169
self.graph = _mod_graph.Graph(self.vf)
2170
heads = self.graph.heads((self.a_key, self.b_key))
2172
# one side dominates, so we can just return its values, yay for
2174
# Ideally we would know that before we get this far
2175
self._head_key = heads.pop()
2176
if self._head_key == self.a_key:
2180
trace.mutter('found dominating revision for %s\n%s > %s', self.vf,
2181
self._head_key[-1], other)
2184
self._head_key = None
2187
def _precache_tip_lines(self):
2188
# Turn this into a no-op, because we will do this later
2191
def _find_recursive_lcas(self):
2192
"""Find all the ancestors back to a unique lca"""
2193
cur_ancestors = (self.a_key, self.b_key)
2194
# graph.find_lca(uncommon, keys) now returns plain NULL_REVISION,
2195
# rather than a key tuple. We will just map that directly to no common
2199
next_lcas = self.graph.find_lca(*cur_ancestors)
2200
# Map a plain NULL_REVISION to a simple no-ancestors
2201
if next_lcas == {_mod_revision.NULL_REVISION}:
2203
# Order the lca's based on when they were merged into the tip
2204
# While the actual merge portion of weave merge uses a set() of
2205
# active revisions, the order of insertion *does* effect the
2206
# implicit ordering of the texts.
2207
for rev_key in cur_ancestors:
2208
ordered_parents = tuple(self.graph.find_merge_order(rev_key,
2210
parent_map[rev_key] = ordered_parents
2211
if len(next_lcas) == 0:
2213
elif len(next_lcas) == 1:
2214
parent_map[list(next_lcas)[0]] = ()
2216
elif len(next_lcas) > 2:
2217
# More than 2 lca's, fall back to grabbing all nodes between
2218
# this and the unique lca.
2219
trace.mutter('More than 2 LCAs, falling back to all nodes for:'
2221
self.a_key, self.b_key, cur_ancestors)
2222
cur_lcas = next_lcas
2223
while len(cur_lcas) > 1:
2224
cur_lcas = self.graph.find_lca(*cur_lcas)
2225
if len(cur_lcas) == 0:
2226
# No common base to find, use the full ancestry
2229
unique_lca = list(cur_lcas)[0]
2230
if unique_lca == _mod_revision.NULL_REVISION:
2231
# find_lca will return a plain 'NULL_REVISION' rather
2232
# than a key tuple when there is no common ancestor, we
2233
# prefer to just use None, because it doesn't confuse
2234
# _get_interesting_texts()
2236
parent_map.update(self._find_unique_parents(next_lcas,
2239
cur_ancestors = next_lcas
2242
def _find_unique_parents(self, tip_keys, base_key):
2243
"""Find ancestors of tip that aren't ancestors of base.
2245
:param tip_keys: Nodes that are interesting
2246
:param base_key: Cull all ancestors of this node
2247
:return: The parent map for all revisions between tip_keys and
2248
base_key. base_key will be included. References to nodes outside of
2249
the ancestor set will also be removed.
2251
# TODO: this would be simpler if find_unique_ancestors took a list
2252
# instead of a single tip, internally it supports it, but it
2253
# isn't a "backwards compatible" api change.
2254
if base_key is None:
2255
parent_map = dict(self.graph.iter_ancestry(tip_keys))
2256
# We remove NULL_REVISION because it isn't a proper tuple key, and
2257
# thus confuses things like _get_interesting_texts, and our logic
2258
# to add the texts into the memory weave.
2259
if _mod_revision.NULL_REVISION in parent_map:
2260
parent_map.pop(_mod_revision.NULL_REVISION)
2263
for tip in tip_keys:
2265
self.graph.find_unique_ancestors(tip, [base_key]))
2266
parent_map = self.graph.get_parent_map(interesting)
2267
parent_map[base_key] = ()
2268
culled_parent_map, child_map, tails = self._remove_external_references(
2270
# Remove all the tails but base_key
2271
if base_key is not None:
2272
tails.remove(base_key)
2273
self._prune_tails(culled_parent_map, child_map, tails)
2274
# Now remove all the uninteresting 'linear' regions
2275
simple_map = _mod_graph.collapse_linear_regions(culled_parent_map)
2279
def _remove_external_references(parent_map):
2280
"""Remove references that go outside of the parent map.
2282
:param parent_map: Something returned from Graph.get_parent_map(keys)
2283
:return: (filtered_parent_map, child_map, tails)
2284
filtered_parent_map is parent_map without external references
2285
child_map is the {parent_key: [child_keys]} mapping
2286
tails is a list of nodes that do not have any parents in the map
2288
# TODO: The basic effect of this function seems more generic than
2289
# _PlanMerge. But the specific details of building a child_map,
2290
# and computing tails seems very specific to _PlanMerge.
2291
# Still, should this be in Graph land?
2292
filtered_parent_map = {}
2295
for key, parent_keys in viewitems(parent_map):
2296
culled_parent_keys = [p for p in parent_keys if p in parent_map]
2297
if not culled_parent_keys:
2299
for parent_key in culled_parent_keys:
2300
child_map.setdefault(parent_key, []).append(key)
2301
# TODO: Do we want to do this, it adds overhead for every node,
2302
# just to say that the node has no children
2303
child_map.setdefault(key, [])
2304
filtered_parent_map[key] = culled_parent_keys
2305
return filtered_parent_map, child_map, tails
2308
def _prune_tails(parent_map, child_map, tails_to_remove):
2309
"""Remove tails from the parent map.
2311
This will remove the supplied revisions until no more children have 0
2314
:param parent_map: A dict of {child: [parents]}, this dictionary will
2315
be modified in place.
2316
:param tails_to_remove: A list of tips that should be removed,
2317
this list will be consumed
2318
:param child_map: The reverse dict of parent_map ({parent: [children]})
2319
this dict will be modified
2320
:return: None, parent_map will be modified in place.
2322
while tails_to_remove:
2323
next = tails_to_remove.pop()
2324
parent_map.pop(next)
2325
children = child_map.pop(next)
2326
for child in children:
2327
child_parents = parent_map[child]
2328
child_parents.remove(next)
2329
if len(child_parents) == 0:
2330
tails_to_remove.append(child)
2332
def _get_interesting_texts(self, parent_map):
2333
"""Return a dict of texts we are interested in.
2335
Note that the input is in key tuples, but the output is in plain
2338
:param parent_map: The output from _find_recursive_lcas
2339
:return: A dict of {'revision_id':lines} as returned by
2340
_PlanMergeBase.get_lines()
2342
all_revision_keys = set(parent_map)
2343
all_revision_keys.add(self.a_key)
2344
all_revision_keys.add(self.b_key)
2346
# Everything else is in 'keys' but get_lines is in 'revision_ids'
2347
all_texts = self.get_lines([k[-1] for k in all_revision_keys])
2350
def _build_weave(self):
2351
from breezy import weave
2352
self._weave = weave.Weave(weave_name='in_memory_weave',
2353
allow_reserved=True)
2354
parent_map = self._find_recursive_lcas()
2356
all_texts = self._get_interesting_texts(parent_map)
2358
# Note: Unfortunately, the order given by topo_sort will effect the
2359
# ordering resolution in the output. Specifically, if you add A then B,
2360
# then in the output text A lines will show up before B lines. And, of
2361
# course, topo_sort doesn't guarantee any real ordering.
2362
# So we use merge_sort, and add a fake node on the tip.
2363
# This ensures that left-hand parents will always be inserted into the
2364
# weave before right-hand parents.
2365
tip_key = self._key_prefix + (_mod_revision.CURRENT_REVISION,)
2366
parent_map[tip_key] = (self.a_key, self.b_key)
2368
for seq_num, key, depth, eom in reversed(tsort.merge_sort(parent_map,
2372
# for key in tsort.topo_sort(parent_map):
2373
parent_keys = parent_map[key]
2374
revision_id = key[-1]
2375
parent_ids = [k[-1] for k in parent_keys]
2376
self._weave.add_lines(revision_id, parent_ids,
2377
all_texts[revision_id])
2379
def plan_merge(self):
2380
"""Generate a 'plan' for merging the two revisions.
2382
This involves comparing their texts and determining the cause of
2383
differences. If text A has a line and text B does not, then either the
2384
line was added to text A, or it was deleted from B. Once the causes
2385
are combined, they are written out in the format described in
2386
VersionedFile.plan_merge
2388
if self._head_key is not None: # There was a single head
2389
if self._head_key == self.a_key:
2392
if self._head_key != self.b_key:
2393
raise AssertionError('There was an invalid head: %s != %s'
2394
% (self.b_key, self._head_key))
2396
head_rev = self._head_key[-1]
2397
lines = self.get_lines([head_rev])[head_rev]
2398
return ((plan, line) for line in lines)
2399
return self._weave.plan_merge(self.a_rev, self.b_rev)
2402
class _PlanLCAMerge(_PlanMergeBase):
2404
This merge algorithm differs from _PlanMerge in that:
2406
1. comparisons are done against LCAs only
2407
2. cases where a contested line is new versus one LCA but old versus
2408
another are marked as conflicts, by emitting the line as conflicted-a
2411
This is faster, and hopefully produces more useful output.
2414
def __init__(self, a_rev, b_rev, vf, key_prefix, graph):
2415
_PlanMergeBase.__init__(self, a_rev, b_rev, vf, key_prefix)
2416
lcas = graph.find_lca(key_prefix + (a_rev,), key_prefix + (b_rev,))
2419
if lca == _mod_revision.NULL_REVISION:
2422
self.lcas.add(lca[-1])
2423
for lca in self.lcas:
2424
if _mod_revision.is_null(lca):
2427
lca_lines = self.get_lines([lca])[lca]
2428
matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_a,
2430
blocks = list(matcher.get_matching_blocks())
2431
self._cached_matching_blocks[(a_rev, lca)] = blocks
2432
matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_b,
2434
blocks = list(matcher.get_matching_blocks())
2435
self._cached_matching_blocks[(b_rev, lca)] = blocks
2437
def _determine_status(self, revision_id, unique_line_numbers):
2438
"""Determines the status unique lines versus all lcas.
2440
Basically, determines why the line is unique to this revision.
2442
A line may be determined new, killed, or both.
2444
If a line is determined new, that means it was not present in at least
2445
one LCA, and is not present in the other merge revision.
2447
If a line is determined killed, that means the line was present in
2450
If a line is killed and new, this indicates that the two merge
2451
revisions contain differing conflict resolutions.
2453
:param revision_id: The id of the revision in which the lines are
2455
:param unique_line_numbers: The line numbers of unique lines.
2456
:return: a tuple of (new_this, killed_other)
2460
unique_line_numbers = set(unique_line_numbers)
2461
for lca in self.lcas:
2462
blocks = self._get_matching_blocks(revision_id, lca)
2463
unique_vs_lca, _ignored = self._unique_lines(blocks)
2464
new.update(unique_line_numbers.intersection(unique_vs_lca))
2465
killed.update(unique_line_numbers.difference(unique_vs_lca))
added
removed
breezy/merge.py
