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,
42
from breezy.bzr import (
45
from breezy.i18n import gettext
56
# TODO: Report back as changes are merged in
59
def transform_tree(from_tree, to_tree, interesting_ids=None):
60
from_tree.lock_tree_write()
61
operation = cleanup.OperationWithCleanups(merge_inner)
62
operation.add_cleanup(from_tree.unlock)
63
operation.run_simple(from_tree.branch, to_tree, from_tree,
64
ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
67
class MergeHooks(hooks.Hooks):
70
hooks.Hooks.__init__(self, "breezy.merge", "Merger.hooks")
71
self.add_hook('merge_file_content',
72
"Called with a breezy.merge.Merger object to create a per file "
73
"merge object when starting a merge. "
74
"Should return either None or a subclass of "
75
"``breezy.merge.AbstractPerFileMerger``. "
76
"Such objects will then be called per file "
77
"that needs to be merged (including when one "
78
"side has deleted the file and the other has changed it). "
79
"See the AbstractPerFileMerger API docs for details on how it is "
82
self.add_hook('pre_merge',
83
'Called before a merge. '
84
'Receives a Merger object as the single argument.',
86
self.add_hook('post_merge',
87
'Called after a merge. '
88
'Receives a Merger object as the single argument. '
89
'The return value is ignored.',
93
class AbstractPerFileMerger(object):
94
"""PerFileMerger objects are used by plugins extending merge for breezy.
96
See ``breezy.plugins.news_merge.news_merge`` for an example concrete class.
98
:ivar merger: The Merge3Merger performing the merge.
101
def __init__(self, merger):
102
"""Create a PerFileMerger for use with merger."""
105
def merge_contents(self, merge_params):
106
"""Attempt to merge the contents of a single file.
108
:param merge_params: A breezy.merge.MergeFileHookParams
109
:return: A tuple of (status, chunks), where status is one of
110
'not_applicable', 'success', 'conflicted', or 'delete'. If status
111
is 'success' or 'conflicted', then chunks should be an iterable of
112
strings for the new file contents.
114
return ('not applicable', None)
117
class PerFileMerger(AbstractPerFileMerger):
118
"""Merge individual files when self.file_matches returns True.
120
This class is intended to be subclassed. The file_matches and
121
merge_matching methods should be overridden with concrete implementations.
124
def file_matches(self, params):
125
"""Return True if merge_matching should be called on this file.
127
Only called with merges of plain files with no clear winner.
129
Subclasses must override this.
131
raise NotImplementedError(self.file_matches)
133
def get_filename(self, params, tree):
134
"""Lookup the filename (i.e. basename, not path), given a Tree (e.g.
135
self.merger.this_tree) and a MergeFileHookParams.
137
return osutils.basename(tree.id2path(params.file_id))
139
def get_filepath(self, params, tree):
140
"""Calculate the path to the file in a tree.
142
:param params: A MergeFileHookParams describing the file to merge
143
:param tree: a Tree, e.g. self.merger.this_tree.
145
return tree.id2path(params.file_id)
147
def merge_contents(self, params):
148
"""Merge the contents of a single file."""
149
# Check whether this custom merge logic should be used.
151
# OTHER is a straight winner, rely on default merge.
152
params.winner == 'other' or
153
# THIS and OTHER aren't both files.
154
not params.is_file_merge() or
155
# The filename doesn't match
156
not self.file_matches(params)):
157
return 'not_applicable', None
158
return self.merge_matching(params)
160
def merge_matching(self, params):
161
"""Merge the contents of a single file that has matched the criteria
162
in PerFileMerger.merge_contents (is a conflict, is a file,
163
self.file_matches is True).
165
Subclasses must override this.
167
raise NotImplementedError(self.merge_matching)
170
class ConfigurableFileMerger(PerFileMerger):
171
"""Merge individual files when configured via a .conf file.
173
This is a base class for concrete custom file merging logic. Concrete
174
classes should implement ``merge_text``.
176
See ``breezy.plugins.news_merge.news_merge`` for an example concrete class.
178
:ivar affected_files: The configured file paths to merge.
180
:cvar name_prefix: The prefix to use when looking up configuration
181
details. <name_prefix>_merge_files describes the files targeted by the
184
:cvar default_files: The default file paths to merge when no configuration
191
def __init__(self, merger):
192
super(ConfigurableFileMerger, self).__init__(merger)
193
self.affected_files = None
194
self.default_files = self.__class__.default_files or []
195
self.name_prefix = self.__class__.name_prefix
196
if self.name_prefix is None:
197
raise ValueError("name_prefix must be set.")
199
def file_matches(self, params):
200
"""Check whether the file should call the merge hook.
202
<name_prefix>_merge_files configuration variable is a list of files
203
that should use the hook.
205
affected_files = self.affected_files
206
if affected_files is None:
207
config = self.merger.this_branch.get_config()
208
# Until bzr provides a better policy for caching the config, we
209
# just add the part we're interested in to the params to avoid
210
# reading the config files repeatedly (bazaar.conf, location.conf,
212
config_key = self.name_prefix + '_merge_files'
213
affected_files = config.get_user_option_as_list(config_key)
214
if affected_files is None:
215
# If nothing was specified in the config, use the default.
216
affected_files = self.default_files
217
self.affected_files = affected_files
219
filepath = self.get_filepath(params, self.merger.this_tree)
220
if filepath in affected_files:
224
def merge_matching(self, params):
225
return self.merge_text(params)
227
def merge_text(self, params):
228
"""Merge the byte contents of a single file.
230
This is called after checking that the merge should be performed in
231
merge_contents, and it should behave as per
232
``breezy.merge.AbstractPerFileMerger.merge_contents``.
234
raise NotImplementedError(self.merge_text)
237
class MergeFileHookParams(object):
238
"""Object holding parameters passed to merge_file_content hooks.
240
There are some fields hooks can access:
242
:ivar file_id: the file ID of the file being merged
243
:ivar trans_id: the transform ID for the merge of this file
244
:ivar this_kind: kind of file_id in 'this' tree
245
:ivar other_kind: kind of file_id in 'other' tree
246
:ivar winner: one of 'this', 'other', 'conflict'
249
def __init__(self, merger, file_id, trans_id, this_kind, other_kind,
251
self._merger = merger
252
self.file_id = file_id
253
self.trans_id = trans_id
254
self.this_kind = this_kind
255
self.other_kind = other_kind
258
def is_file_merge(self):
259
"""True if this_kind and other_kind are both 'file'."""
260
return self.this_kind == 'file' and self.other_kind == 'file'
262
@decorators.cachedproperty
263
def base_lines(self):
264
"""The lines of the 'base' version of the file."""
265
return self._merger.get_lines(self._merger.base_tree, self.file_id)
267
@decorators.cachedproperty
268
def this_lines(self):
269
"""The lines of the 'this' version of the file."""
270
return self._merger.get_lines(self._merger.this_tree, self.file_id)
272
@decorators.cachedproperty
273
def other_lines(self):
274
"""The lines of the 'other' version of the file."""
275
return self._merger.get_lines(self._merger.other_tree, self.file_id)
278
class Merger(object):
282
def __init__(self, this_branch, other_tree=None, base_tree=None,
283
this_tree=None, pb=None, change_reporter=None,
284
recurse='down', revision_graph=None):
285
object.__init__(self)
286
self.this_branch = this_branch
287
self.this_basis = _mod_revision.ensure_null(
288
this_branch.last_revision())
289
self.this_rev_id = None
290
self.this_tree = this_tree
291
self.this_revision_tree = None
292
self.this_basis_tree = None
293
self.other_tree = other_tree
294
self.other_branch = None
295
self.base_tree = base_tree
296
self.ignore_zero = False
297
self.backup_files = False
298
self.interesting_ids = None
299
self.interesting_files = None
300
self.show_base = False
301
self.reprocess = False
303
warnings.warn("pb parameter to Merger() is deprecated and ignored")
305
self.recurse = recurse
306
self.change_reporter = change_reporter
307
self._cached_trees = {}
308
self._revision_graph = revision_graph
309
self._base_is_ancestor = None
310
self._base_is_other_ancestor = None
311
self._is_criss_cross = None
312
self._lca_trees = None
314
def cache_trees_with_revision_ids(self, trees):
315
"""Cache any tree in trees if it has a revision_id."""
316
for maybe_tree in trees:
317
if maybe_tree is None:
320
rev_id = maybe_tree.get_revision_id()
321
except AttributeError:
323
self._cached_trees[rev_id] = maybe_tree
326
def revision_graph(self):
327
if self._revision_graph is None:
328
self._revision_graph = self.this_branch.repository.get_graph()
329
return self._revision_graph
331
def _set_base_is_ancestor(self, value):
332
self._base_is_ancestor = value
334
def _get_base_is_ancestor(self):
335
if self._base_is_ancestor is None:
336
self._base_is_ancestor = self.revision_graph.is_ancestor(
337
self.base_rev_id, self.this_basis)
338
return self._base_is_ancestor
340
base_is_ancestor = property(_get_base_is_ancestor, _set_base_is_ancestor)
342
def _set_base_is_other_ancestor(self, value):
343
self._base_is_other_ancestor = value
345
def _get_base_is_other_ancestor(self):
346
if self._base_is_other_ancestor is None:
347
if self.other_basis is None:
349
self._base_is_other_ancestor = self.revision_graph.is_ancestor(
350
self.base_rev_id, self.other_basis)
351
return self._base_is_other_ancestor
353
base_is_other_ancestor = property(_get_base_is_other_ancestor,
354
_set_base_is_other_ancestor)
357
def from_uncommitted(tree, other_tree, pb=None, base_tree=None):
358
"""Return a Merger for uncommitted changes in other_tree.
360
:param tree: The tree to merge into
361
:param other_tree: The tree to get uncommitted changes from
362
:param pb: A progress indicator
363
:param base_tree: The basis to use for the merge. If unspecified,
364
other_tree.basis_tree() will be used.
366
if base_tree is None:
367
base_tree = other_tree.basis_tree()
368
merger = Merger(tree.branch, other_tree, base_tree, tree, pb)
369
merger.base_rev_id = merger.base_tree.get_revision_id()
370
merger.other_rev_id = None
371
merger.other_basis = merger.base_rev_id
375
def from_mergeable(klass, tree, mergeable, pb):
376
"""Return a Merger for a bundle or merge directive.
378
:param tree: The tree to merge changes into
379
:param mergeable: A merge directive or bundle
380
:param pb: A progress indicator
382
mergeable.install_revisions(tree.branch.repository)
383
base_revision_id, other_revision_id, verified =\
384
mergeable.get_merge_request(tree.branch.repository)
385
revision_graph = tree.branch.repository.get_graph()
386
if base_revision_id is not None:
387
if (base_revision_id != _mod_revision.NULL_REVISION and
388
revision_graph.is_ancestor(
389
base_revision_id, tree.branch.last_revision())):
390
base_revision_id = None
392
trace.warning('Performing cherrypick')
393
merger = klass.from_revision_ids(pb, tree, other_revision_id,
394
base_revision_id, revision_graph=
396
return merger, verified
399
def from_revision_ids(pb, tree, other, base=None, other_branch=None,
400
base_branch=None, revision_graph=None,
402
"""Return a Merger for revision-ids.
404
:param pb: A progress indicator
405
:param tree: The tree to merge changes into
406
:param other: The revision-id to use as OTHER
407
:param base: The revision-id to use as BASE. If not specified, will
409
:param other_branch: A branch containing the other revision-id. If
410
not supplied, tree.branch is used.
411
:param base_branch: A branch containing the base revision-id. If
412
not supplied, other_branch or tree.branch will be used.
413
:param revision_graph: If you have a revision_graph precomputed, pass
414
it in, otherwise it will be created for you.
415
:param tree_branch: The branch associated with tree. If not supplied,
416
tree.branch will be used.
418
if tree_branch is None:
419
tree_branch = tree.branch
420
merger = Merger(tree_branch, this_tree=tree, pb=pb,
421
revision_graph=revision_graph)
422
if other_branch is None:
423
other_branch = tree.branch
424
merger.set_other_revision(other, other_branch)
428
if base_branch is None:
429
base_branch = other_branch
430
merger.set_base_revision(base, base_branch)
433
def revision_tree(self, revision_id, branch=None):
434
if revision_id not in self._cached_trees:
436
branch = self.this_branch
438
tree = self.this_tree.revision_tree(revision_id)
439
except errors.NoSuchRevisionInTree:
440
tree = branch.repository.revision_tree(revision_id)
441
self._cached_trees[revision_id] = tree
442
return self._cached_trees[revision_id]
444
def _get_tree(self, treespec, possible_transports=None):
445
location, revno = treespec
447
tree = workingtree.WorkingTree.open_containing(location)[0]
448
return tree.branch, tree
449
branch = _mod_branch.Branch.open_containing(
450
location, possible_transports)[0]
452
revision_id = branch.last_revision()
454
revision_id = branch.get_rev_id(revno)
455
revision_id = _mod_revision.ensure_null(revision_id)
456
return branch, self.revision_tree(revision_id, branch)
458
def set_interesting_files(self, file_list):
459
self.interesting_files = file_list
461
def set_pending(self):
462
if (not self.base_is_ancestor or not self.base_is_other_ancestor
463
or self.other_rev_id is None):
467
def _add_parent(self):
468
new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
469
new_parent_trees = []
470
operation = cleanup.OperationWithCleanups(
471
self.this_tree.set_parent_trees)
472
for revision_id in new_parents:
474
tree = self.revision_tree(revision_id)
475
except errors.NoSuchRevision:
479
operation.add_cleanup(tree.unlock)
480
new_parent_trees.append((revision_id, tree))
481
operation.run_simple(new_parent_trees, allow_leftmost_as_ghost=True)
483
def set_other(self, other_revision, possible_transports=None):
484
"""Set the revision and tree to merge from.
486
This sets the other_tree, other_rev_id, other_basis attributes.
488
:param other_revision: The [path, revision] list to merge from.
490
self.other_branch, self.other_tree = self._get_tree(other_revision,
492
if other_revision[1] == -1:
493
self.other_rev_id = _mod_revision.ensure_null(
494
self.other_branch.last_revision())
495
if _mod_revision.is_null(self.other_rev_id):
496
raise errors.NoCommits(self.other_branch)
497
self.other_basis = self.other_rev_id
498
elif other_revision[1] is not None:
499
self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
500
self.other_basis = self.other_rev_id
502
self.other_rev_id = None
503
self.other_basis = self.other_branch.last_revision()
504
if self.other_basis is None:
505
raise errors.NoCommits(self.other_branch)
506
if self.other_rev_id is not None:
507
self._cached_trees[self.other_rev_id] = self.other_tree
508
self._maybe_fetch(self.other_branch, self.this_branch, self.other_basis)
510
def set_other_revision(self, revision_id, other_branch):
511
"""Set 'other' based on a branch and revision id
513
:param revision_id: The revision to use for a tree
514
:param other_branch: The branch containing this tree
516
self.other_rev_id = revision_id
517
self.other_branch = other_branch
518
self._maybe_fetch(other_branch, self.this_branch, self.other_rev_id)
519
self.other_tree = self.revision_tree(revision_id)
520
self.other_basis = revision_id
522
def set_base_revision(self, revision_id, branch):
523
"""Set 'base' based on a branch and revision id
525
:param revision_id: The revision to use for a tree
526
:param branch: The branch containing this tree
528
self.base_rev_id = revision_id
529
self.base_branch = branch
530
self._maybe_fetch(branch, self.this_branch, revision_id)
531
self.base_tree = self.revision_tree(revision_id)
533
def _maybe_fetch(self, source, target, revision_id):
534
if not source.repository.has_same_location(target.repository):
535
target.fetch(source, revision_id)
538
revisions = [_mod_revision.ensure_null(self.this_basis),
539
_mod_revision.ensure_null(self.other_basis)]
540
if _mod_revision.NULL_REVISION in revisions:
541
self.base_rev_id = _mod_revision.NULL_REVISION
542
self.base_tree = self.revision_tree(self.base_rev_id)
543
self._is_criss_cross = False
545
lcas = self.revision_graph.find_lca(revisions[0], revisions[1])
546
self._is_criss_cross = False
548
self.base_rev_id = _mod_revision.NULL_REVISION
550
self.base_rev_id = list(lcas)[0]
551
else: # len(lcas) > 1
552
self._is_criss_cross = True
554
# find_unique_lca can only handle 2 nodes, so we have to
555
# start back at the beginning. It is a shame to traverse
556
# the graph again, but better than re-implementing
558
self.base_rev_id = self.revision_graph.find_unique_lca(
559
revisions[0], revisions[1])
561
self.base_rev_id = self.revision_graph.find_unique_lca(
563
sorted_lca_keys = self.revision_graph.find_merge_order(
565
if self.base_rev_id == _mod_revision.NULL_REVISION:
566
self.base_rev_id = sorted_lca_keys[0]
568
if self.base_rev_id == _mod_revision.NULL_REVISION:
569
raise errors.UnrelatedBranches()
570
if self._is_criss_cross:
571
trace.warning('Warning: criss-cross merge encountered. See bzr'
572
' help criss-cross.')
573
trace.mutter('Criss-cross lcas: %r' % lcas)
574
if self.base_rev_id in lcas:
575
trace.mutter('Unable to find unique lca. '
576
'Fallback %r as best option.'
578
interesting_revision_ids = set(lcas)
579
interesting_revision_ids.add(self.base_rev_id)
580
interesting_trees = dict((t.get_revision_id(), t)
581
for t in self.this_branch.repository.revision_trees(
582
interesting_revision_ids))
583
self._cached_trees.update(interesting_trees)
584
if self.base_rev_id in lcas:
585
self.base_tree = interesting_trees[self.base_rev_id]
587
self.base_tree = interesting_trees.pop(self.base_rev_id)
588
self._lca_trees = [interesting_trees[key]
589
for key in sorted_lca_keys]
591
self.base_tree = self.revision_tree(self.base_rev_id)
592
self.base_is_ancestor = True
593
self.base_is_other_ancestor = True
594
trace.mutter('Base revid: %r' % self.base_rev_id)
596
def set_base(self, base_revision):
597
"""Set the base revision to use for the merge.
599
:param base_revision: A 2-list containing a path and revision number.
601
trace.mutter("doing merge() with no base_revision specified")
602
if base_revision == [None, None]:
605
base_branch, self.base_tree = self._get_tree(base_revision)
606
if base_revision[1] == -1:
607
self.base_rev_id = base_branch.last_revision()
608
elif base_revision[1] is None:
609
self.base_rev_id = _mod_revision.NULL_REVISION
611
self.base_rev_id = _mod_revision.ensure_null(
612
base_branch.get_rev_id(base_revision[1]))
613
self._maybe_fetch(base_branch, self.this_branch, self.base_rev_id)
615
def make_merger(self):
616
kwargs = {'working_tree': self.this_tree, 'this_tree': self.this_tree,
617
'other_tree': self.other_tree,
618
'interesting_ids': self.interesting_ids,
619
'interesting_files': self.interesting_files,
620
'this_branch': self.this_branch,
621
'other_branch': self.other_branch,
623
if self.merge_type.requires_base:
624
kwargs['base_tree'] = self.base_tree
625
if self.merge_type.supports_reprocess:
626
kwargs['reprocess'] = self.reprocess
628
raise errors.BzrError(
629
"Conflict reduction is not supported for merge"
630
" type %s." % self.merge_type)
631
if self.merge_type.supports_show_base:
632
kwargs['show_base'] = self.show_base
634
raise errors.BzrError("Showing base is not supported for this"
635
" merge type. %s" % self.merge_type)
636
if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
637
and not self.base_is_other_ancestor):
638
raise errors.CannotReverseCherrypick()
639
if self.merge_type.supports_cherrypick:
640
kwargs['cherrypick'] = (not self.base_is_ancestor or
641
not self.base_is_other_ancestor)
642
if self._is_criss_cross and getattr(self.merge_type,
643
'supports_lca_trees', False):
644
kwargs['lca_trees'] = self._lca_trees
645
return self.merge_type(pb=None,
646
change_reporter=self.change_reporter,
649
def _do_merge_to(self):
650
merge = self.make_merger()
651
if self.other_branch is not None:
652
self.other_branch.update_references(self.this_branch)
653
for hook in Merger.hooks['pre_merge']:
656
for hook in Merger.hooks['post_merge']:
658
if self.recurse == 'down':
659
for relpath, file_id in self.this_tree.iter_references():
660
sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
661
other_revision = self.other_tree.get_reference_revision(
663
if other_revision == sub_tree.last_revision():
665
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
666
sub_merge.merge_type = self.merge_type
667
other_branch = self.other_branch.reference_parent(file_id,
669
sub_merge.set_other_revision(other_revision, other_branch)
670
base_revision = self.base_tree.get_reference_revision(file_id)
671
sub_merge.base_tree = \
672
sub_tree.branch.repository.revision_tree(base_revision)
673
sub_merge.base_rev_id = base_revision
678
operation = cleanup.OperationWithCleanups(self._do_merge_to)
679
self.this_tree.lock_tree_write()
680
operation.add_cleanup(self.this_tree.unlock)
681
if self.base_tree is not None:
682
self.base_tree.lock_read()
683
operation.add_cleanup(self.base_tree.unlock)
684
if self.other_tree is not None:
685
self.other_tree.lock_read()
686
operation.add_cleanup(self.other_tree.unlock)
687
merge = operation.run_simple()
688
if len(merge.cooked_conflicts) == 0:
689
if not self.ignore_zero and not trace.is_quiet():
690
trace.note(gettext("All changes applied successfully."))
692
trace.note(gettext("%d conflicts encountered.")
693
% len(merge.cooked_conflicts))
695
return len(merge.cooked_conflicts)
698
class _InventoryNoneEntry(object):
699
"""This represents an inventory entry which *isn't there*.
701
It simplifies the merging logic if we always have an InventoryEntry, even
702
if it isn't actually present
709
symlink_target = None
712
_none_entry = _InventoryNoneEntry()
715
class Merge3Merger(object):
716
"""Three-way merger that uses the merge3 text merger"""
718
supports_reprocess = True
719
supports_show_base = True
720
history_based = False
721
supports_cherrypick = True
722
supports_reverse_cherrypick = True
723
winner_idx = {"this": 2, "other": 1, "conflict": 1}
724
supports_lca_trees = True
726
def __init__(self, working_tree, this_tree, base_tree, other_tree,
727
interesting_ids=None, reprocess=False, show_base=False,
728
pb=None, pp=None, change_reporter=None,
729
interesting_files=None, do_merge=True,
730
cherrypick=False, lca_trees=None, this_branch=None,
732
"""Initialize the merger object and perform the merge.
734
:param working_tree: The working tree to apply the merge to
735
:param this_tree: The local tree in the merge operation
736
:param base_tree: The common tree in the merge operation
737
:param other_tree: The other tree to merge changes from
738
:param this_branch: The branch associated with this_tree. Defaults to
739
this_tree.branch if not supplied.
740
:param other_branch: The branch associated with other_tree, if any.
741
:param interesting_ids: The file_ids of files that should be
742
participate in the merge. May not be combined with
744
:param: reprocess If True, perform conflict-reduction processing.
745
:param show_base: If True, show the base revision in text conflicts.
746
(incompatible with reprocess)
748
:param pp: A ProgressPhase object
749
:param change_reporter: An object that should report changes made
750
:param interesting_files: The tree-relative paths of files that should
751
participate in the merge. If these paths refer to directories,
752
the contents of those directories will also be included. May not
753
be combined with interesting_ids. If neither interesting_files nor
754
interesting_ids is specified, all files may participate in the
756
:param lca_trees: Can be set to a dictionary of {revision_id:rev_tree}
757
if the ancestry was found to include a criss-cross merge.
758
Otherwise should be None.
760
object.__init__(self)
761
if interesting_files is not None and interesting_ids is not None:
763
'specify either interesting_ids or interesting_files')
764
if this_branch is None:
765
this_branch = this_tree.branch
766
self.interesting_ids = interesting_ids
767
self.interesting_files = interesting_files
768
self.working_tree = working_tree
769
self.this_tree = this_tree
770
self.base_tree = base_tree
771
self.other_tree = other_tree
772
self.this_branch = this_branch
773
self.other_branch = other_branch
774
self._raw_conflicts = []
775
self.cooked_conflicts = []
776
self.reprocess = reprocess
777
self.show_base = show_base
778
self._lca_trees = lca_trees
779
# Uncommenting this will change the default algorithm to always use
780
# _entries_lca. This can be useful for running the test suite and
781
# making sure we haven't missed any corner cases.
782
# if lca_trees is None:
783
# self._lca_trees = [self.base_tree]
784
self.change_reporter = change_reporter
785
self.cherrypick = cherrypick
789
warnings.warn("pp argument to Merge3Merger is deprecated")
791
warnings.warn("pb argument to Merge3Merger is deprecated")
794
operation = cleanup.OperationWithCleanups(self._do_merge)
795
self.working_tree.lock_tree_write()
796
operation.add_cleanup(self.working_tree.unlock)
797
self.this_tree.lock_read()
798
operation.add_cleanup(self.this_tree.unlock)
799
self.base_tree.lock_read()
800
operation.add_cleanup(self.base_tree.unlock)
801
self.other_tree.lock_read()
802
operation.add_cleanup(self.other_tree.unlock)
805
def _do_merge(self, operation):
806
self.tt = transform.TreeTransform(self.working_tree, None)
807
operation.add_cleanup(self.tt.finalize)
808
self._compute_transform()
809
results = self.tt.apply(no_conflicts=True)
810
self.write_modified(results)
812
self.working_tree.add_conflicts(self.cooked_conflicts)
813
except errors.UnsupportedOperation:
816
def make_preview_transform(self):
817
operation = cleanup.OperationWithCleanups(self._make_preview_transform)
818
self.base_tree.lock_read()
819
operation.add_cleanup(self.base_tree.unlock)
820
self.other_tree.lock_read()
821
operation.add_cleanup(self.other_tree.unlock)
822
return operation.run_simple()
824
def _make_preview_transform(self):
825
self.tt = transform.TransformPreview(self.working_tree)
826
self._compute_transform()
829
def _compute_transform(self):
830
if self._lca_trees is None:
831
entries = self._entries3()
832
resolver = self._three_way
834
entries = self._entries_lca()
835
resolver = self._lca_multi_way
836
# Prepare merge hooks
837
factories = Merger.hooks['merge_file_content']
838
# One hook for each registered one plus our default merger
839
hooks = [factory(self) for factory in factories] + [self]
840
self.active_hooks = [hook for hook in hooks if hook is not None]
841
child_pb = ui.ui_factory.nested_progress_bar()
843
for num, (file_id, changed, parents3, names3,
844
executable3) in enumerate(entries):
845
# Try merging each entry
846
child_pb.update(gettext('Preparing file merge'),
848
self._merge_names(file_id, parents3, names3, resolver=resolver)
850
file_status = self._do_merge_contents(file_id)
852
file_status = 'unmodified'
853
self._merge_executable(file_id,
854
executable3, file_status, resolver=resolver)
857
self.tt.fixup_new_roots()
858
self._finish_computing_transform()
860
def _finish_computing_transform(self):
861
"""Finalize the transform and report the changes.
863
This is the second half of _compute_transform.
865
child_pb = ui.ui_factory.nested_progress_bar()
867
fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
868
lambda t, c: transform.conflict_pass(t, c, self.other_tree))
871
if self.change_reporter is not None:
872
from breezy import delta
873
delta.report_changes(
874
self.tt.iter_changes(), self.change_reporter)
875
self.cook_conflicts(fs_conflicts)
876
for conflict in self.cooked_conflicts:
877
trace.warning(unicode(conflict))
880
"""Gather data about files modified between three trees.
882
Return a list of tuples of file_id, changed, parents3, names3,
883
executable3. changed is a boolean indicating whether the file contents
884
or kind were changed. parents3 is a tuple of parent ids for base,
885
other and this. names3 is a tuple of names for base, other and this.
886
executable3 is a tuple of execute-bit values for base, other and this.
889
iterator = self.other_tree.iter_changes(self.base_tree,
890
specific_files=self.interesting_files,
891
extra_trees=[self.this_tree])
892
this_entries = dict((e.file_id, e) for p, e in
893
self.this_tree.iter_entries_by_dir(
894
self.interesting_ids))
895
for (file_id, paths, changed, versioned, parents, names, kind,
896
executable) in iterator:
897
if (self.interesting_ids is not None and
898
file_id not in self.interesting_ids):
900
entry = this_entries.get(file_id)
901
if entry is not None:
902
this_name = entry.name
903
this_parent = entry.parent_id
904
this_executable = entry.executable
908
this_executable = None
909
parents3 = parents + (this_parent,)
910
names3 = names + (this_name,)
911
executable3 = executable + (this_executable,)
912
result.append((file_id, changed, parents3, names3, executable3))
915
def _entries_lca(self):
916
"""Gather data about files modified between multiple trees.
918
This compares OTHER versus all LCA trees, and for interesting entries,
919
it then compares with THIS and BASE.
921
For the multi-valued entries, the format will be (BASE, [lca1, lca2])
923
:return: [(file_id, changed, parents, names, executable)], where:
925
* file_id: Simple file_id of the entry
926
* changed: Boolean, True if the kind or contents changed else False
927
* parents: ((base, [parent_id, in, lcas]), parent_id_other,
929
* names: ((base, [name, in, lcas]), name_in_other, name_in_this)
930
* executable: ((base, [exec, in, lcas]), exec_in_other,
933
if self.interesting_files is not None:
934
lookup_trees = [self.this_tree, self.base_tree]
935
lookup_trees.extend(self._lca_trees)
936
# I think we should include the lca trees as well
937
interesting_ids = self.other_tree.paths2ids(self.interesting_files,
940
interesting_ids = self.interesting_ids
942
walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
944
base_inventory = self.base_tree.root_inventory
945
this_inventory = self.this_tree.root_inventory
946
for path, file_id, other_ie, lca_values in walker.iter_all():
947
# Is this modified at all from any of the other trees?
949
other_ie = _none_entry
950
if interesting_ids is not None and file_id not in interesting_ids:
953
# If other_revision is found in any of the lcas, that means this
954
# node is uninteresting. This is because when merging, if there are
955
# multiple heads(), we have to create a new node. So if we didn't,
956
# we know that the ancestry is linear, and that OTHER did not
958
# See doc/developers/lca_merge_resolution.txt for details
959
other_revision = other_ie.revision
960
if other_revision is not None:
961
# We can't use this shortcut when other_revision is None,
962
# because it may be None because things are WorkingTrees, and
963
# not because it is *actually* None.
964
is_unmodified = False
965
for lca_path, ie in lca_values:
966
if ie is not None and ie.revision == other_revision:
973
for lca_path, lca_ie in lca_values:
975
lca_entries.append(_none_entry)
977
lca_entries.append(lca_ie)
979
if base_inventory.has_id(file_id):
980
base_ie = base_inventory[file_id]
982
base_ie = _none_entry
984
if this_inventory.has_id(file_id):
985
this_ie = this_inventory[file_id]
987
this_ie = _none_entry
993
for lca_ie in lca_entries:
994
lca_kinds.append(lca_ie.kind)
995
lca_parent_ids.append(lca_ie.parent_id)
996
lca_names.append(lca_ie.name)
997
lca_executable.append(lca_ie.executable)
999
kind_winner = self._lca_multi_way(
1000
(base_ie.kind, lca_kinds),
1001
other_ie.kind, this_ie.kind)
1002
parent_id_winner = self._lca_multi_way(
1003
(base_ie.parent_id, lca_parent_ids),
1004
other_ie.parent_id, this_ie.parent_id)
1005
name_winner = self._lca_multi_way(
1006
(base_ie.name, lca_names),
1007
other_ie.name, this_ie.name)
1009
content_changed = True
1010
if kind_winner == 'this':
1011
# No kind change in OTHER, see if there are *any* changes
1012
if other_ie.kind == 'directory':
1013
if parent_id_winner == 'this' and name_winner == 'this':
1014
# No change for this directory in OTHER, skip
1016
content_changed = False
1017
elif other_ie.kind is None or other_ie.kind == 'file':
1018
def get_sha1(ie, tree):
1019
if ie.kind != 'file':
1021
return tree.get_file_sha1(file_id)
1022
base_sha1 = get_sha1(base_ie, self.base_tree)
1023
lca_sha1s = [get_sha1(ie, tree) for ie, tree
1024
in zip(lca_entries, self._lca_trees)]
1025
this_sha1 = get_sha1(this_ie, self.this_tree)
1026
other_sha1 = get_sha1(other_ie, self.other_tree)
1027
sha1_winner = self._lca_multi_way(
1028
(base_sha1, lca_sha1s), other_sha1, this_sha1,
1029
allow_overriding_lca=False)
1030
exec_winner = self._lca_multi_way(
1031
(base_ie.executable, lca_executable),
1032
other_ie.executable, this_ie.executable)
1033
if (parent_id_winner == 'this' and name_winner == 'this'
1034
and sha1_winner == 'this' and exec_winner == 'this'):
1035
# No kind, parent, name, exec, or content change for
1036
# OTHER, so this node is not considered interesting
1038
if sha1_winner == 'this':
1039
content_changed = False
1040
elif other_ie.kind == 'symlink':
1041
def get_target(ie, tree):
1042
if ie.kind != 'symlink':
1044
return tree.get_symlink_target(file_id)
1045
base_target = get_target(base_ie, self.base_tree)
1046
lca_targets = [get_target(ie, tree) for ie, tree
1047
in zip(lca_entries, self._lca_trees)]
1048
this_target = get_target(this_ie, self.this_tree)
1049
other_target = get_target(other_ie, self.other_tree)
1050
target_winner = self._lca_multi_way(
1051
(base_target, lca_targets),
1052
other_target, this_target)
1053
if (parent_id_winner == 'this' and name_winner == 'this'
1054
and target_winner == 'this'):
1055
# No kind, parent, name, or symlink target change
1058
if target_winner == 'this':
1059
content_changed = False
1060
elif other_ie.kind == 'tree-reference':
1061
# The 'changed' information seems to be handled at a higher
1062
# level. At least, _entries3 returns False for content
1063
# changed, even when at a new revision_id.
1064
content_changed = False
1065
if (parent_id_winner == 'this' and name_winner == 'this'):
1066
# Nothing interesting
1069
raise AssertionError('unhandled kind: %s' % other_ie.kind)
1071
# If we have gotten this far, that means something has changed
1072
result.append((file_id, content_changed,
1073
((base_ie.parent_id, lca_parent_ids),
1074
other_ie.parent_id, this_ie.parent_id),
1075
((base_ie.name, lca_names),
1076
other_ie.name, this_ie.name),
1077
((base_ie.executable, lca_executable),
1078
other_ie.executable, this_ie.executable)
1082
def write_modified(self, results):
1083
modified_hashes = {}
1084
for path in results.modified_paths:
1085
file_id = self.working_tree.path2id(self.working_tree.relpath(path))
1088
hash = self.working_tree.get_file_sha1(file_id)
1091
modified_hashes[file_id] = hash
1092
self.working_tree.set_merge_modified(modified_hashes)
1095
def parent(entry, file_id):
1096
"""Determine the parent for a file_id (used as a key method)"""
1099
return entry.parent_id
1102
def name(entry, file_id):
1103
"""Determine the name for a file_id (used as a key method)"""
1109
def contents_sha1(tree, file_id):
1110
"""Determine the sha1 of the file contents (used as a key method)."""
1111
if not tree.has_id(file_id):
1113
return tree.get_file_sha1(file_id)
1116
def executable(tree, file_id):
1117
"""Determine the executability of a file-id (used as a key method)."""
1118
if not tree.has_id(file_id):
1120
if tree.kind(file_id) != "file":
1122
return tree.is_executable(file_id)
1125
def kind(tree, file_id):
1126
"""Determine the kind of a file-id (used as a key method)."""
1127
if not tree.has_id(file_id):
1129
return tree.kind(file_id)
1132
def _three_way(base, other, this):
1134
# if 'base == other', either they all agree, or only 'this' has
1137
elif this not in (base, other):
1138
# 'this' is neither 'base' nor 'other', so both sides changed
1141
# "Ambiguous clean merge" -- both sides have made the same change.
1144
# this == base: only other has changed.
1148
def _lca_multi_way(bases, other, this, allow_overriding_lca=True):
1149
"""Consider LCAs when determining whether a change has occurred.
1151
If LCAS are all identical, this is the same as a _three_way comparison.
1153
:param bases: value in (BASE, [LCAS])
1154
:param other: value in OTHER
1155
:param this: value in THIS
1156
:param allow_overriding_lca: If there is more than one unique lca
1157
value, allow OTHER to override THIS if it has a new value, and
1158
THIS only has an lca value, or vice versa. This is appropriate for
1159
truly scalar values, not as much for non-scalars.
1160
:return: 'this', 'other', or 'conflict' depending on whether an entry
1163
# See doc/developers/lca_tree_merging.txt for details about this
1166
# Either Ambiguously clean, or nothing was actually changed. We
1169
base_val, lca_vals = bases
1170
# Remove 'base_val' from the lca_vals, because it is not interesting
1171
filtered_lca_vals = [lca_val for lca_val in lca_vals
1172
if lca_val != base_val]
1173
if len(filtered_lca_vals) == 0:
1174
return Merge3Merger._three_way(base_val, other, this)
1176
unique_lca_vals = set(filtered_lca_vals)
1177
if len(unique_lca_vals) == 1:
1178
return Merge3Merger._three_way(unique_lca_vals.pop(), other, this)
1180
if allow_overriding_lca:
1181
if other in unique_lca_vals:
1182
if this in unique_lca_vals:
1183
# Each side picked a different lca, conflict
1186
# This has a value which supersedes both lca values, and
1187
# other only has an lca value
1189
elif this in unique_lca_vals:
1190
# OTHER has a value which supersedes both lca values, and this
1191
# only has an lca value
1194
# At this point, the lcas disagree, and the tip disagree
1197
def merge_names(self, file_id):
1198
def get_entry(tree):
1200
return tree.root_inventory[file_id]
1201
except errors.NoSuchId:
1203
this_entry = get_entry(self.this_tree)
1204
other_entry = get_entry(self.other_tree)
1205
base_entry = get_entry(self.base_tree)
1206
entries = (base_entry, other_entry, this_entry)
1209
for entry in entries:
1212
parents.append(None)
1214
names.append(entry.name)
1215
parents.append(entry.parent_id)
1216
return self._merge_names(file_id, parents, names,
1217
resolver=self._three_way)
1219
def _merge_names(self, file_id, parents, names, resolver):
1220
"""Perform a merge on file_id names and parents"""
1221
base_name, other_name, this_name = names
1222
base_parent, other_parent, this_parent = parents
1224
name_winner = resolver(*names)
1226
parent_id_winner = resolver(*parents)
1227
if this_name is None:
1228
if name_winner == "this":
1229
name_winner = "other"
1230
if parent_id_winner == "this":
1231
parent_id_winner = "other"
1232
if name_winner == "this" and parent_id_winner == "this":
1234
if name_winner == 'conflict' or parent_id_winner == 'conflict':
1235
# Creating helpers (.OTHER or .THIS) here cause problems down the
1236
# road if a ContentConflict needs to be created so we should not do
1238
trans_id = self.tt.trans_id_file_id(file_id)
1239
self._raw_conflicts.append(('path conflict', trans_id, file_id,
1240
this_parent, this_name,
1241
other_parent, other_name))
1242
if not self.other_tree.has_id(file_id):
1243
# it doesn't matter whether the result was 'other' or
1244
# 'conflict'-- if it has no file id, we leave it alone.
1246
parent_id = parents[self.winner_idx[parent_id_winner]]
1247
name = names[self.winner_idx[name_winner]]
1248
if parent_id is not None or name is not None:
1249
# if we get here, name_winner and parent_winner are set to safe
1251
if parent_id is None and name is not None:
1252
# if parent_id is None and name is non-None, current file is
1254
if names[self.winner_idx[parent_id_winner]] != '':
1255
raise AssertionError(
1256
'File looks like a root, but named %s' %
1257
names[self.winner_idx[parent_id_winner]])
1258
parent_trans_id = transform.ROOT_PARENT
1260
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1261
self.tt.adjust_path(name, parent_trans_id,
1262
self.tt.trans_id_file_id(file_id))
1264
def _do_merge_contents(self, file_id):
1265
"""Performs a merge on file_id contents."""
1266
def contents_pair(tree):
1267
if not tree.has_id(file_id):
1269
kind = tree.kind(file_id)
1271
contents = tree.get_file_sha1(file_id)
1272
elif kind == "symlink":
1273
contents = tree.get_symlink_target(file_id)
1276
return kind, contents
1278
# See SPOT run. run, SPOT, run.
1279
# So we're not QUITE repeating ourselves; we do tricky things with
1281
base_pair = contents_pair(self.base_tree)
1282
other_pair = contents_pair(self.other_tree)
1284
this_pair = contents_pair(self.this_tree)
1285
lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1286
winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1287
this_pair, allow_overriding_lca=False)
1289
if base_pair == other_pair:
1292
# We delayed evaluating this_pair as long as we can to avoid
1293
# unnecessary sha1 calculation
1294
this_pair = contents_pair(self.this_tree)
1295
winner = self._three_way(base_pair, other_pair, this_pair)
1296
if winner == 'this':
1297
# No interesting changes introduced by OTHER
1299
# We have a hypothetical conflict, but if we have files, then we
1300
# can try to merge the content
1301
trans_id = self.tt.trans_id_file_id(file_id)
1302
params = MergeFileHookParams(self, file_id, trans_id, this_pair[0],
1303
other_pair[0], winner)
1304
hooks = self.active_hooks
1305
hook_status = 'not_applicable'
1307
hook_status, lines = hook.merge_contents(params)
1308
if hook_status != 'not_applicable':
1309
# Don't try any more hooks, this one applies.
1311
# If the merge ends up replacing the content of the file, we get rid of
1312
# it at the end of this method (this variable is used to track the
1313
# exceptions to this rule).
1316
if hook_status == 'not_applicable':
1317
# No merge hook was able to resolve the situation. Two cases exist:
1318
# a content conflict or a duplicate one.
1320
name = self.tt.final_name(trans_id)
1321
parent_id = self.tt.final_parent(trans_id)
1323
inhibit_content_conflict = False
1324
if params.this_kind is None: # file_id is not in THIS
1325
# Is the name used for a different file_id ?
1326
dupe_path = self.other_tree.id2path(file_id)
1327
this_id = self.this_tree.path2id(dupe_path)
1328
if this_id is not None:
1329
# Two entries for the same path
1331
# versioning the merged file will trigger a duplicate
1333
self.tt.version_file(file_id, trans_id)
1334
transform.create_from_tree(
1335
self.tt, trans_id, self.other_tree, file_id,
1336
filter_tree_path=self._get_filter_tree_path(file_id))
1337
inhibit_content_conflict = True
1338
elif params.other_kind is None: # file_id is not in OTHER
1339
# Is the name used for a different file_id ?
1340
dupe_path = self.this_tree.id2path(file_id)
1341
other_id = self.other_tree.path2id(dupe_path)
1342
if other_id is not None:
1343
# Two entries for the same path again, but here, the other
1344
# entry will also be merged. We simply inhibit the
1345
# 'content' conflict creation because we know OTHER will
1346
# create (or has already created depending on ordering) an
1347
# entry at the same path. This will trigger a 'duplicate'
1350
inhibit_content_conflict = True
1351
if not inhibit_content_conflict:
1352
if params.this_kind is not None:
1353
self.tt.unversion_file(trans_id)
1354
# This is a contents conflict, because none of the available
1355
# functions could merge it.
1356
file_group = self._dump_conflicts(name, parent_id, file_id,
1358
self._raw_conflicts.append(('contents conflict', file_group))
1359
elif hook_status == 'success':
1360
self.tt.create_file(lines, trans_id)
1361
elif hook_status == 'conflicted':
1362
# XXX: perhaps the hook should be able to provide
1363
# the BASE/THIS/OTHER files?
1364
self.tt.create_file(lines, trans_id)
1365
self._raw_conflicts.append(('text conflict', trans_id))
1366
name = self.tt.final_name(trans_id)
1367
parent_id = self.tt.final_parent(trans_id)
1368
self._dump_conflicts(name, parent_id, file_id)
1369
elif hook_status == 'delete':
1370
self.tt.unversion_file(trans_id)
1372
elif hook_status == 'done':
1373
# The hook function did whatever it needs to do directly, no
1374
# further action needed here.
1377
raise AssertionError('unknown hook_status: %r' % (hook_status,))
1378
if not self.this_tree.has_id(file_id) and result == "modified":
1379
self.tt.version_file(file_id, trans_id)
1381
# The merge has been performed and produced a new content, so the
1382
# old contents should not be retained.
1383
self.tt.delete_contents(trans_id)
1386
def _default_other_winner_merge(self, merge_hook_params):
1387
"""Replace this contents with other."""
1388
file_id = merge_hook_params.file_id
1389
trans_id = merge_hook_params.trans_id
1390
if self.other_tree.has_id(file_id):
1391
# OTHER changed the file
1392
transform.create_from_tree(
1393
self.tt, trans_id, self.other_tree, file_id,
1394
filter_tree_path=self._get_filter_tree_path(file_id))
1396
elif self.this_tree.has_id(file_id):
1397
# OTHER deleted the file
1398
return 'delete', None
1400
raise AssertionError(
1401
'winner is OTHER, but file_id %r not in THIS or OTHER tree'
1404
def merge_contents(self, merge_hook_params):
1405
"""Fallback merge logic after user installed hooks."""
1406
# This function is used in merge hooks as the fallback instance.
1407
# Perhaps making this function and the functions it calls be a
1408
# a separate class would be better.
1409
if merge_hook_params.winner == 'other':
1410
# OTHER is a straight winner, so replace this contents with other
1411
return self._default_other_winner_merge(merge_hook_params)
1412
elif merge_hook_params.is_file_merge():
1413
# THIS and OTHER are both files, so text merge. Either
1414
# BASE is a file, or both converted to files, so at least we
1415
# have agreement that output should be a file.
1417
self.text_merge(merge_hook_params.file_id,
1418
merge_hook_params.trans_id)
1419
except errors.BinaryFile:
1420
return 'not_applicable', None
1423
return 'not_applicable', None
1425
def get_lines(self, tree, file_id):
1426
"""Return the lines in a file, or an empty list."""
1427
if tree.has_id(file_id):
1428
return tree.get_file_lines(file_id)
1432
def text_merge(self, file_id, trans_id):
1433
"""Perform a three-way text merge on a file_id"""
1434
# it's possible that we got here with base as a different type.
1435
# if so, we just want two-way text conflicts.
1436
if self.base_tree.has_id(file_id) and \
1437
self.base_tree.kind(file_id) == "file":
1438
base_lines = self.get_lines(self.base_tree, file_id)
1441
other_lines = self.get_lines(self.other_tree, file_id)
1442
this_lines = self.get_lines(self.this_tree, file_id)
1443
m3 = merge3.Merge3(base_lines, this_lines, other_lines,
1444
is_cherrypick=self.cherrypick)
1445
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
1446
if self.show_base is True:
1447
base_marker = '|' * 7
1451
def iter_merge3(retval):
1452
retval["text_conflicts"] = False
1453
for line in m3.merge_lines(name_a = "TREE",
1454
name_b = "MERGE-SOURCE",
1455
name_base = "BASE-REVISION",
1456
start_marker=start_marker,
1457
base_marker=base_marker,
1458
reprocess=self.reprocess):
1459
if line.startswith(start_marker):
1460
retval["text_conflicts"] = True
1461
yield line.replace(start_marker, '<' * 7)
1465
merge3_iterator = iter_merge3(retval)
1466
self.tt.create_file(merge3_iterator, trans_id)
1467
if retval["text_conflicts"] is True:
1468
self._raw_conflicts.append(('text conflict', trans_id))
1469
name = self.tt.final_name(trans_id)
1470
parent_id = self.tt.final_parent(trans_id)
1471
file_group = self._dump_conflicts(name, parent_id, file_id,
1472
this_lines, base_lines,
1474
file_group.append(trans_id)
1477
def _get_filter_tree_path(self, file_id):
1478
if self.this_tree.supports_content_filtering():
1479
# We get the path from the working tree if it exists.
1480
# That fails though when OTHER is adding a file, so
1481
# we fall back to the other tree to find the path if
1482
# it doesn't exist locally.
1484
return self.this_tree.id2path(file_id)
1485
except errors.NoSuchId:
1486
return self.other_tree.id2path(file_id)
1487
# Skip the id2path lookup for older formats
1490
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
1491
base_lines=None, other_lines=None, set_version=False,
1493
"""Emit conflict files.
1494
If this_lines, base_lines, or other_lines are omitted, they will be
1495
determined automatically. If set_version is true, the .OTHER, .THIS
1496
or .BASE (in that order) will be created as versioned files.
1498
data = [('OTHER', self.other_tree, other_lines),
1499
('THIS', self.this_tree, this_lines)]
1501
data.append(('BASE', self.base_tree, base_lines))
1503
# We need to use the actual path in the working tree of the file here,
1504
# ignoring the conflict suffixes
1506
if wt.supports_content_filtering():
1508
filter_tree_path = wt.id2path(file_id)
1509
except errors.NoSuchId:
1510
# file has been deleted
1511
filter_tree_path = None
1513
# Skip the id2path lookup for older formats
1514
filter_tree_path = None
1518
for suffix, tree, lines in data:
1519
if tree.has_id(file_id):
1520
trans_id = self._conflict_file(name, parent_id, tree, file_id,
1521
suffix, lines, filter_tree_path)
1522
file_group.append(trans_id)
1523
if set_version and not versioned:
1524
self.tt.version_file(file_id, trans_id)
1528
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1529
lines=None, filter_tree_path=None):
1530
"""Emit a single conflict file."""
1531
name = name + '.' + suffix
1532
trans_id = self.tt.create_path(name, parent_id)
1533
transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
1537
def merge_executable(self, file_id, file_status):
1538
"""Perform a merge on the execute bit."""
1539
executable = [self.executable(t, file_id) for t in (self.base_tree,
1540
self.other_tree, self.this_tree)]
1541
self._merge_executable(file_id, executable, file_status,
1542
resolver=self._three_way)
1544
def _merge_executable(self, file_id, executable, file_status,
1546
"""Perform a merge on the execute bit."""
1547
base_executable, other_executable, this_executable = executable
1548
if file_status == "deleted":
1550
winner = resolver(*executable)
1551
if winner == "conflict":
1552
# There must be a None in here, if we have a conflict, but we
1553
# need executability since file status was not deleted.
1554
if self.executable(self.other_tree, file_id) is None:
1558
if winner == 'this' and file_status != "modified":
1560
trans_id = self.tt.trans_id_file_id(file_id)
1561
if self.tt.final_kind(trans_id) != "file":
1563
if winner == "this":
1564
executability = this_executable
1566
if self.other_tree.has_id(file_id):
1567
executability = other_executable
1568
elif self.this_tree.has_id(file_id):
1569
executability = this_executable
1570
elif self.base_tree_has_id(file_id):
1571
executability = base_executable
1572
if executability is not None:
1573
trans_id = self.tt.trans_id_file_id(file_id)
1574
self.tt.set_executability(executability, trans_id)
1576
def cook_conflicts(self, fs_conflicts):
1577
"""Convert all conflicts into a form that doesn't depend on trans_id"""
1578
content_conflict_file_ids = set()
1579
cooked_conflicts = transform.cook_conflicts(fs_conflicts, self.tt)
1580
fp = transform.FinalPaths(self.tt)
1581
for conflict in self._raw_conflicts:
1582
conflict_type = conflict[0]
1583
if conflict_type == 'path conflict':
1585
this_parent, this_name,
1586
other_parent, other_name) = conflict[1:]
1587
if this_parent is None or this_name is None:
1588
this_path = '<deleted>'
1590
parent_path = fp.get_path(
1591
self.tt.trans_id_file_id(this_parent))
1592
this_path = osutils.pathjoin(parent_path, this_name)
1593
if other_parent is None or other_name is None:
1594
other_path = '<deleted>'
1596
if other_parent == self.other_tree.get_root_id():
1597
# The tree transform doesn't know about the other root,
1598
# so we special case here to avoid a NoFinalPath
1602
parent_path = fp.get_path(
1603
self.tt.trans_id_file_id(other_parent))
1604
other_path = osutils.pathjoin(parent_path, other_name)
1605
c = _mod_conflicts.Conflict.factory(
1606
'path conflict', path=this_path,
1607
conflict_path=other_path,
1609
elif conflict_type == 'contents conflict':
1610
for trans_id in conflict[1]:
1611
file_id = self.tt.final_file_id(trans_id)
1612
if file_id is not None:
1613
# Ok we found the relevant file-id
1615
path = fp.get_path(trans_id)
1616
for suffix in ('.BASE', '.THIS', '.OTHER'):
1617
if path.endswith(suffix):
1618
# Here is the raw path
1619
path = path[:-len(suffix)]
1621
c = _mod_conflicts.Conflict.factory(conflict_type,
1622
path=path, file_id=file_id)
1623
content_conflict_file_ids.add(file_id)
1624
elif conflict_type == 'text conflict':
1625
trans_id = conflict[1]
1626
path = fp.get_path(trans_id)
1627
file_id = self.tt.final_file_id(trans_id)
1628
c = _mod_conflicts.Conflict.factory(conflict_type,
1629
path=path, file_id=file_id)
1631
raise AssertionError('bad conflict type: %r' % (conflict,))
1632
cooked_conflicts.append(c)
1634
self.cooked_conflicts = []
1635
# We want to get rid of path conflicts when a corresponding contents
1636
# conflict exists. This can occur when one branch deletes a file while
1637
# the other renames *and* modifies it. In this case, the content
1638
# conflict is enough.
1639
for c in cooked_conflicts:
1640
if (c.typestring == 'path conflict'
1641
and c.file_id in content_conflict_file_ids):
1643
self.cooked_conflicts.append(c)
1644
self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1647
class WeaveMerger(Merge3Merger):
1648
"""Three-way tree merger, text weave merger."""
1649
supports_reprocess = True
1650
supports_show_base = False
1651
supports_reverse_cherrypick = False
1652
history_based = True
1654
def _generate_merge_plan(self, file_id, base):
1655
return self.this_tree.plan_file_merge(file_id, self.other_tree,
1658
def _merged_lines(self, file_id):
1659
"""Generate the merged lines.
1660
There is no distinction between lines that are meant to contain <<<<<<<
1664
base = self.base_tree
1667
plan = self._generate_merge_plan(file_id, base)
1668
if 'merge' in debug.debug_flags:
1670
trans_id = self.tt.trans_id_file_id(file_id)
1671
name = self.tt.final_name(trans_id) + '.plan'
1672
contents = ('%11s|%s' % l for l in plan)
1673
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1674
textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1675
'>>>>>>> MERGE-SOURCE\n')
1676
lines, conflicts = textmerge.merge_lines(self.reprocess)
1678
base_lines = textmerge.base_from_plan()
1681
return lines, base_lines
1683
def text_merge(self, file_id, trans_id):
1684
"""Perform a (weave) text merge for a given file and file-id.
1685
If conflicts are encountered, .THIS and .OTHER files will be emitted,
1686
and a conflict will be noted.
1688
lines, base_lines = self._merged_lines(file_id)
1690
# Note we're checking whether the OUTPUT is binary in this case,
1691
# because we don't want to get into weave merge guts.
1692
textfile.check_text_lines(lines)
1693
self.tt.create_file(lines, trans_id)
1694
if base_lines is not None:
1696
self._raw_conflicts.append(('text conflict', trans_id))
1697
name = self.tt.final_name(trans_id)
1698
parent_id = self.tt.final_parent(trans_id)
1699
file_group = self._dump_conflicts(name, parent_id, file_id,
1701
base_lines=base_lines)
1702
file_group.append(trans_id)
1705
class LCAMerger(WeaveMerger):
1707
def _generate_merge_plan(self, file_id, base):
1708
return self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1711
class Diff3Merger(Merge3Merger):
1712
"""Three-way merger using external diff3 for text merging"""
1714
def dump_file(self, temp_dir, name, tree, file_id):
1715
out_path = osutils.pathjoin(temp_dir, name)
1716
out_file = open(out_path, "wb")
1718
in_file = tree.get_file(file_id)
1719
for line in in_file:
1720
out_file.write(line)
1725
def text_merge(self, file_id, trans_id):
1726
"""Perform a diff3 merge using a specified file-id and trans-id.
1727
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
1728
will be dumped, and a will be conflict noted.
1731
temp_dir = osutils.mkdtemp(prefix="bzr-")
1733
new_file = osutils.pathjoin(temp_dir, "new")
1734
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
1735
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
1736
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
1737
status = breezy.patch.diff3(new_file, this, base, other)
1738
if status not in (0, 1):
1739
raise errors.BzrError("Unhandled diff3 exit code")
1740
f = open(new_file, 'rb')
1742
self.tt.create_file(f, trans_id)
1746
name = self.tt.final_name(trans_id)
1747
parent_id = self.tt.final_parent(trans_id)
1748
self._dump_conflicts(name, parent_id, file_id)
1749
self._raw_conflicts.append(('text conflict', trans_id))
1751
osutils.rmtree(temp_dir)
1754
class PathNotInTree(errors.BzrError):
1756
_fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
1758
def __init__(self, path, tree):
1759
errors.BzrError.__init__(self, path=path, tree=tree)
1762
class MergeIntoMerger(Merger):
1763
"""Merger that understands other_tree will be merged into a subdir.
1765
This also changes the Merger api so that it uses real Branch, revision_id,
1766
and RevisonTree objects, rather than using revision specs.
1769
def __init__(self, this_tree, other_branch, other_tree, target_subdir,
1770
source_subpath, other_rev_id=None):
1771
"""Create a new MergeIntoMerger object.
1773
source_subpath in other_tree will be effectively copied to
1774
target_subdir in this_tree.
1776
:param this_tree: The tree that we will be merging into.
1777
:param other_branch: The Branch we will be merging from.
1778
:param other_tree: The RevisionTree object we want to merge.
1779
:param target_subdir: The relative path where we want to merge
1780
other_tree into this_tree
1781
:param source_subpath: The relative path specifying the subtree of
1782
other_tree to merge into this_tree.
1784
# It is assumed that we are merging a tree that is not in our current
1785
# ancestry, which means we are using the "EmptyTree" as our basis.
1786
null_ancestor_tree = this_tree.branch.repository.revision_tree(
1787
_mod_revision.NULL_REVISION)
1788
super(MergeIntoMerger, self).__init__(
1789
this_branch=this_tree.branch,
1790
this_tree=this_tree,
1791
other_tree=other_tree,
1792
base_tree=null_ancestor_tree,
1794
self._target_subdir = target_subdir
1795
self._source_subpath = source_subpath
1796
self.other_branch = other_branch
1797
if other_rev_id is None:
1798
other_rev_id = other_tree.get_revision_id()
1799
self.other_rev_id = self.other_basis = other_rev_id
1800
self.base_is_ancestor = True
1801
self.backup_files = True
1802
self.merge_type = Merge3Merger
1803
self.show_base = False
1804
self.reprocess = False
1805
self.interesting_ids = None
1806
self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
1807
target_subdir=self._target_subdir,
1808
source_subpath=self._source_subpath)
1809
if self._source_subpath != '':
1810
# If this isn't a partial merge make sure the revisions will be
1812
self._maybe_fetch(self.other_branch, self.this_branch,
1815
def set_pending(self):
1816
if self._source_subpath != '':
1818
Merger.set_pending(self)
1821
class _MergeTypeParameterizer(object):
1822
"""Wrap a merge-type class to provide extra parameters.
1824
This is hack used by MergeIntoMerger to pass some extra parameters to its
1825
merge_type. Merger.do_merge() sets up its own set of parameters to pass to
1826
the 'merge_type' member. It is difficult override do_merge without
1827
re-writing the whole thing, so instead we create a wrapper which will pass
1828
the extra parameters.
1831
def __init__(self, merge_type, **kwargs):
1832
self._extra_kwargs = kwargs
1833
self._merge_type = merge_type
1835
def __call__(self, *args, **kwargs):
1836
kwargs.update(self._extra_kwargs)
1837
return self._merge_type(*args, **kwargs)
1839
def __getattr__(self, name):
1840
return getattr(self._merge_type, name)
1843
class MergeIntoMergeType(Merge3Merger):
1844
"""Merger that incorporates a tree (or part of a tree) into another."""
1846
def __init__(self, *args, **kwargs):
1847
"""Initialize the merger object.
1849
:param args: See Merge3Merger.__init__'s args.
1850
:param kwargs: See Merge3Merger.__init__'s keyword args, except for
1851
source_subpath and target_subdir.
1852
:keyword source_subpath: The relative path specifying the subtree of
1853
other_tree to merge into this_tree.
1854
:keyword target_subdir: The relative path where we want to merge
1855
other_tree into this_tree
1857
# All of the interesting work happens during Merge3Merger.__init__(),
1858
# so we have have to hack in to get our extra parameters set.
1859
self._source_subpath = kwargs.pop('source_subpath')
1860
self._target_subdir = kwargs.pop('target_subdir')
1861
super(MergeIntoMergeType, self).__init__(*args, **kwargs)
1863
def _compute_transform(self):
1864
child_pb = ui.ui_factory.nested_progress_bar()
1866
entries = self._entries_to_incorporate()
1867
entries = list(entries)
1868
for num, (entry, parent_id) in enumerate(entries):
1869
child_pb.update(gettext('Preparing file merge'), num, len(entries))
1870
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1871
trans_id = transform.new_by_entry(self.tt, entry,
1872
parent_trans_id, self.other_tree)
1875
self._finish_computing_transform()
1877
def _entries_to_incorporate(self):
1878
"""Yields pairs of (inventory_entry, new_parent)."""
1879
other_inv = self.other_tree.root_inventory
1880
subdir_id = other_inv.path2id(self._source_subpath)
1881
if subdir_id is None:
1882
# XXX: The error would be clearer if it gave the URL of the source
1883
# branch, but we don't have a reference to that here.
1884
raise PathNotInTree(self._source_subpath, "Source tree")
1885
subdir = other_inv[subdir_id]
1886
parent_in_target = osutils.dirname(self._target_subdir)
1887
target_id = self.this_tree.path2id(parent_in_target)
1888
if target_id is None:
1889
raise PathNotInTree(self._target_subdir, "Target tree")
1890
name_in_target = osutils.basename(self._target_subdir)
1891
merge_into_root = subdir.copy()
1892
merge_into_root.name = name_in_target
1893
if self.this_tree.has_id(merge_into_root.file_id):
1894
# Give the root a new file-id.
1895
# This can happen fairly easily if the directory we are
1896
# incorporating is the root, and both trees have 'TREE_ROOT' as
1897
# their root_id. Users will expect this to Just Work, so we
1898
# change the file-id here.
1899
# Non-root file-ids could potentially conflict too. That's really
1900
# an edge case, so we don't do anything special for those. We let
1901
# them cause conflicts.
1902
merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
1903
yield (merge_into_root, target_id)
1904
if subdir.kind != 'directory':
1905
# No children, so we are done.
1907
for ignored_path, entry in other_inv.iter_entries_by_dir(subdir_id):
1908
parent_id = entry.parent_id
1909
if parent_id == subdir.file_id:
1910
# The root's parent ID has changed, so make sure children of
1911
# the root refer to the new ID.
1912
parent_id = merge_into_root.file_id
1913
yield (entry, parent_id)
1916
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1918
merge_type=Merge3Merger,
1919
interesting_ids=None,
1923
interesting_files=None,
1926
change_reporter=None):
1927
"""Primary interface for merging.
1929
Typical use is probably::
1931
merge_inner(branch, branch.get_revision_tree(other_revision),
1932
branch.get_revision_tree(base_revision))
1934
if this_tree is None:
1935
raise errors.BzrError("breezy.merge.merge_inner requires a this_tree "
1937
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1938
pb=pb, change_reporter=change_reporter)
1939
merger.backup_files = backup_files
1940
merger.merge_type = merge_type
1941
merger.interesting_ids = interesting_ids
1942
merger.ignore_zero = ignore_zero
1943
if interesting_files:
1945
raise ValueError('Only supply interesting_ids'
1946
' or interesting_files')
1947
merger.interesting_files = interesting_files
1948
merger.show_base = show_base
1949
merger.reprocess = reprocess
1950
merger.other_rev_id = other_rev_id
1951
merger.other_basis = other_rev_id
1952
get_revision_id = getattr(base_tree, 'get_revision_id', None)
1953
if get_revision_id is None:
1954
get_revision_id = base_tree.last_revision
1955
merger.cache_trees_with_revision_ids([other_tree, base_tree, this_tree])
1956
merger.set_base_revision(get_revision_id(), this_branch)
1957
return merger.do_merge()
1960
merge_type_registry = registry.Registry()
1961
merge_type_registry.register('diff3', Diff3Merger,
1962
"Merge using external diff3.")
1963
merge_type_registry.register('lca', LCAMerger,
1964
"LCA-newness merge.")
1965
merge_type_registry.register('merge3', Merge3Merger,
1966
"Native diff3-style merge.")
1967
merge_type_registry.register('weave', WeaveMerger,
1968
"Weave-based merge.")
1971
def get_merge_type_registry():
1972
"""Merge type registry was previously in breezy.option
1974
This method provides a backwards compatible way to retrieve it.
1976
return merge_type_registry
1979
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
1980
def status_a(revision, text):
1981
if revision in ancestors_b:
1982
return 'killed-b', text
1984
return 'new-a', text
1986
def status_b(revision, text):
1987
if revision in ancestors_a:
1988
return 'killed-a', text
1990
return 'new-b', text
1992
plain_a = [t for (a, t) in annotated_a]
1993
plain_b = [t for (a, t) in annotated_b]
1994
matcher = patiencediff.PatienceSequenceMatcher(None, plain_a, plain_b)
1995
blocks = matcher.get_matching_blocks()
1998
for ai, bi, l in blocks:
1999
# process all mismatched sections
2000
# (last mismatched section is handled because blocks always
2001
# includes a 0-length last block)
2002
for revision, text in annotated_a[a_cur:ai]:
2003
yield status_a(revision, text)
2004
for revision, text in annotated_b[b_cur:bi]:
2005
yield status_b(revision, text)
2006
# and now the matched section
2009
for text_a in plain_a[ai:a_cur]:
2010
yield "unchanged", text_a
2013
class _PlanMergeBase(object):
2015
def __init__(self, a_rev, b_rev, vf, key_prefix):
2018
:param a_rev: Revision-id of one revision to merge
2019
:param b_rev: Revision-id of the other revision to merge
2020
:param vf: A VersionedFiles containing both revisions
2021
:param key_prefix: A prefix for accessing keys in vf, typically
2027
self._last_lines = None
2028
self._last_lines_revision_id = None
2029
self._cached_matching_blocks = {}
2030
self._key_prefix = key_prefix
2031
self._precache_tip_lines()
2033
def _precache_tip_lines(self):
2034
lines = self.get_lines([self.a_rev, self.b_rev])
2035
self.lines_a = lines[self.a_rev]
2036
self.lines_b = lines[self.b_rev]
2038
def get_lines(self, revisions):
2039
"""Get lines for revisions from the backing VersionedFiles.
2041
:raises RevisionNotPresent: on absent texts.
2043
keys = [(self._key_prefix + (rev,)) for rev in revisions]
2045
for record in self.vf.get_record_stream(keys, 'unordered', True):
2046
if record.storage_kind == 'absent':
2047
raise errors.RevisionNotPresent(record.key, self.vf)
2048
result[record.key[-1]] = osutils.chunks_to_lines(
2049
record.get_bytes_as('chunked'))
2052
def plan_merge(self):
2053
"""Generate a 'plan' for merging the two revisions.
2055
This involves comparing their texts and determining the cause of
2056
differences. If text A has a line and text B does not, then either the
2057
line was added to text A, or it was deleted from B. Once the causes
2058
are combined, they are written out in the format described in
2059
VersionedFile.plan_merge
2061
blocks = self._get_matching_blocks(self.a_rev, self.b_rev)
2062
unique_a, unique_b = self._unique_lines(blocks)
2063
new_a, killed_b = self._determine_status(self.a_rev, unique_a)
2064
new_b, killed_a = self._determine_status(self.b_rev, unique_b)
2065
return self._iter_plan(blocks, new_a, killed_b, new_b, killed_a)
2067
def _iter_plan(self, blocks, new_a, killed_b, new_b, killed_a):
2070
for i, j, n in blocks:
2071
for a_index in range(last_i, i):
2072
if a_index in new_a:
2073
if a_index in killed_b:
2074
yield 'conflicted-a', self.lines_a[a_index]
2076
yield 'new-a', self.lines_a[a_index]
2078
yield 'killed-b', self.lines_a[a_index]
2079
for b_index in range(last_j, j):
2080
if b_index in new_b:
2081
if b_index in killed_a:
2082
yield 'conflicted-b', self.lines_b[b_index]
2084
yield 'new-b', self.lines_b[b_index]
2086
yield 'killed-a', self.lines_b[b_index]
2087
# handle common lines
2088
for a_index in range(i, i+n):
2089
yield 'unchanged', self.lines_a[a_index]
2093
def _get_matching_blocks(self, left_revision, right_revision):
2094
"""Return a description of which sections of two revisions match.
2096
See SequenceMatcher.get_matching_blocks
2098
cached = self._cached_matching_blocks.get((left_revision,
2100
if cached is not None:
2102
if self._last_lines_revision_id == left_revision:
2103
left_lines = self._last_lines
2104
right_lines = self.get_lines([right_revision])[right_revision]
2106
lines = self.get_lines([left_revision, right_revision])
2107
left_lines = lines[left_revision]
2108
right_lines = lines[right_revision]
2109
self._last_lines = right_lines
2110
self._last_lines_revision_id = right_revision
2111
matcher = patiencediff.PatienceSequenceMatcher(None, left_lines,
2113
return matcher.get_matching_blocks()
2115
def _unique_lines(self, matching_blocks):
2116
"""Analyse matching_blocks to determine which lines are unique
2118
:return: a tuple of (unique_left, unique_right), where the values are
2119
sets of line numbers of unique lines.
2125
for i, j, n in matching_blocks:
2126
unique_left.extend(range(last_i, i))
2127
unique_right.extend(range(last_j, j))
2130
return unique_left, unique_right
2133
def _subtract_plans(old_plan, new_plan):
2134
"""Remove changes from new_plan that came from old_plan.
2136
It is assumed that the difference between the old_plan and new_plan
2137
is their choice of 'b' text.
2139
All lines from new_plan that differ from old_plan are emitted
2140
verbatim. All lines from new_plan that match old_plan but are
2141
not about the 'b' revision are emitted verbatim.
2143
Lines that match and are about the 'b' revision are the lines we
2144
don't want, so we convert 'killed-b' -> 'unchanged', and 'new-b'
2145
is skipped entirely.
2147
matcher = patiencediff.PatienceSequenceMatcher(None, old_plan,
2150
for i, j, n in matcher.get_matching_blocks():
2151
for jj in range(last_j, j):
2153
for jj in range(j, j+n):
2154
plan_line = new_plan[jj]
2155
if plan_line[0] == 'new-b':
2157
elif plan_line[0] == 'killed-b':
2158
yield 'unchanged', plan_line[1]
2164
class _PlanMerge(_PlanMergeBase):
2165
"""Plan an annotate merge using on-the-fly annotation"""
2167
def __init__(self, a_rev, b_rev, vf, key_prefix):
2168
super(_PlanMerge, self).__init__(a_rev, b_rev, vf, key_prefix)
2169
self.a_key = self._key_prefix + (self.a_rev,)
2170
self.b_key = self._key_prefix + (self.b_rev,)
2171
self.graph = _mod_graph.Graph(self.vf)
2172
heads = self.graph.heads((self.a_key, self.b_key))
2174
# one side dominates, so we can just return its values, yay for
2176
# Ideally we would know that before we get this far
2177
self._head_key = heads.pop()
2178
if self._head_key == self.a_key:
2182
trace.mutter('found dominating revision for %s\n%s > %s', self.vf,
2183
self._head_key[-1], other)
2186
self._head_key = None
2189
def _precache_tip_lines(self):
2190
# Turn this into a no-op, because we will do this later
2193
def _find_recursive_lcas(self):
2194
"""Find all the ancestors back to a unique lca"""
2195
cur_ancestors = (self.a_key, self.b_key)
2196
# graph.find_lca(uncommon, keys) now returns plain NULL_REVISION,
2197
# rather than a key tuple. We will just map that directly to no common
2201
next_lcas = self.graph.find_lca(*cur_ancestors)
2202
# Map a plain NULL_REVISION to a simple no-ancestors
2203
if next_lcas == {_mod_revision.NULL_REVISION}:
2205
# Order the lca's based on when they were merged into the tip
2206
# While the actual merge portion of weave merge uses a set() of
2207
# active revisions, the order of insertion *does* effect the
2208
# implicit ordering of the texts.
2209
for rev_key in cur_ancestors:
2210
ordered_parents = tuple(self.graph.find_merge_order(rev_key,
2212
parent_map[rev_key] = ordered_parents
2213
if len(next_lcas) == 0:
2215
elif len(next_lcas) == 1:
2216
parent_map[list(next_lcas)[0]] = ()
2218
elif len(next_lcas) > 2:
2219
# More than 2 lca's, fall back to grabbing all nodes between
2220
# this and the unique lca.
2221
trace.mutter('More than 2 LCAs, falling back to all nodes for:'
2223
self.a_key, self.b_key, cur_ancestors)
2224
cur_lcas = next_lcas
2225
while len(cur_lcas) > 1:
2226
cur_lcas = self.graph.find_lca(*cur_lcas)
2227
if len(cur_lcas) == 0:
2228
# No common base to find, use the full ancestry
2231
unique_lca = list(cur_lcas)[0]
2232
if unique_lca == _mod_revision.NULL_REVISION:
2233
# find_lca will return a plain 'NULL_REVISION' rather
2234
# than a key tuple when there is no common ancestor, we
2235
# prefer to just use None, because it doesn't confuse
2236
# _get_interesting_texts()
2238
parent_map.update(self._find_unique_parents(next_lcas,
2241
cur_ancestors = next_lcas
2244
def _find_unique_parents(self, tip_keys, base_key):
2245
"""Find ancestors of tip that aren't ancestors of base.
2247
:param tip_keys: Nodes that are interesting
2248
:param base_key: Cull all ancestors of this node
2249
:return: The parent map for all revisions between tip_keys and
2250
base_key. base_key will be included. References to nodes outside of
2251
the ancestor set will also be removed.
2253
# TODO: this would be simpler if find_unique_ancestors took a list
2254
# instead of a single tip, internally it supports it, but it
2255
# isn't a "backwards compatible" api change.
2256
if base_key is None:
2257
parent_map = dict(self.graph.iter_ancestry(tip_keys))
2258
# We remove NULL_REVISION because it isn't a proper tuple key, and
2259
# thus confuses things like _get_interesting_texts, and our logic
2260
# to add the texts into the memory weave.
2261
if _mod_revision.NULL_REVISION in parent_map:
2262
parent_map.pop(_mod_revision.NULL_REVISION)
2265
for tip in tip_keys:
2267
self.graph.find_unique_ancestors(tip, [base_key]))
2268
parent_map = self.graph.get_parent_map(interesting)
2269
parent_map[base_key] = ()
2270
culled_parent_map, child_map, tails = self._remove_external_references(
2272
# Remove all the tails but base_key
2273
if base_key is not None:
2274
tails.remove(base_key)
2275
self._prune_tails(culled_parent_map, child_map, tails)
2276
# Now remove all the uninteresting 'linear' regions
2277
simple_map = _mod_graph.collapse_linear_regions(culled_parent_map)
2281
def _remove_external_references(parent_map):
2282
"""Remove references that go outside of the parent map.
2284
:param parent_map: Something returned from Graph.get_parent_map(keys)
2285
:return: (filtered_parent_map, child_map, tails)
2286
filtered_parent_map is parent_map without external references
2287
child_map is the {parent_key: [child_keys]} mapping
2288
tails is a list of nodes that do not have any parents in the map
2290
# TODO: The basic effect of this function seems more generic than
2291
# _PlanMerge. But the specific details of building a child_map,
2292
# and computing tails seems very specific to _PlanMerge.
2293
# Still, should this be in Graph land?
2294
filtered_parent_map = {}
2297
for key, parent_keys in viewitems(parent_map):
2298
culled_parent_keys = [p for p in parent_keys if p in parent_map]
2299
if not culled_parent_keys:
2301
for parent_key in culled_parent_keys:
2302
child_map.setdefault(parent_key, []).append(key)
2303
# TODO: Do we want to do this, it adds overhead for every node,
2304
# just to say that the node has no children
2305
child_map.setdefault(key, [])
2306
filtered_parent_map[key] = culled_parent_keys
2307
return filtered_parent_map, child_map, tails
2310
def _prune_tails(parent_map, child_map, tails_to_remove):
2311
"""Remove tails from the parent map.
2313
This will remove the supplied revisions until no more children have 0
2316
:param parent_map: A dict of {child: [parents]}, this dictionary will
2317
be modified in place.
2318
:param tails_to_remove: A list of tips that should be removed,
2319
this list will be consumed
2320
:param child_map: The reverse dict of parent_map ({parent: [children]})
2321
this dict will be modified
2322
:return: None, parent_map will be modified in place.
2324
while tails_to_remove:
2325
next = tails_to_remove.pop()
2326
parent_map.pop(next)
2327
children = child_map.pop(next)
2328
for child in children:
2329
child_parents = parent_map[child]
2330
child_parents.remove(next)
2331
if len(child_parents) == 0:
2332
tails_to_remove.append(child)
2334
def _get_interesting_texts(self, parent_map):
2335
"""Return a dict of texts we are interested in.
2337
Note that the input is in key tuples, but the output is in plain
2340
:param parent_map: The output from _find_recursive_lcas
2341
:return: A dict of {'revision_id':lines} as returned by
2342
_PlanMergeBase.get_lines()
2344
all_revision_keys = set(parent_map)
2345
all_revision_keys.add(self.a_key)
2346
all_revision_keys.add(self.b_key)
2348
# Everything else is in 'keys' but get_lines is in 'revision_ids'
2349
all_texts = self.get_lines([k[-1] for k in all_revision_keys])
2352
def _build_weave(self):
2353
from .bzr import weave
2354
self._weave = weave.Weave(weave_name='in_memory_weave',
2355
allow_reserved=True)
2356
parent_map = self._find_recursive_lcas()
2358
all_texts = self._get_interesting_texts(parent_map)
2360
# Note: Unfortunately, the order given by topo_sort will effect the
2361
# ordering resolution in the output. Specifically, if you add A then B,
2362
# then in the output text A lines will show up before B lines. And, of
2363
# course, topo_sort doesn't guarantee any real ordering.
2364
# So we use merge_sort, and add a fake node on the tip.
2365
# This ensures that left-hand parents will always be inserted into the
2366
# weave before right-hand parents.
2367
tip_key = self._key_prefix + (_mod_revision.CURRENT_REVISION,)
2368
parent_map[tip_key] = (self.a_key, self.b_key)
2370
for seq_num, key, depth, eom in reversed(tsort.merge_sort(parent_map,
2374
# for key in tsort.topo_sort(parent_map):
2375
parent_keys = parent_map[key]
2376
revision_id = key[-1]
2377
parent_ids = [k[-1] for k in parent_keys]
2378
self._weave.add_lines(revision_id, parent_ids,
2379
all_texts[revision_id])
2381
def plan_merge(self):
2382
"""Generate a 'plan' for merging the two revisions.
2384
This involves comparing their texts and determining the cause of
2385
differences. If text A has a line and text B does not, then either the
2386
line was added to text A, or it was deleted from B. Once the causes
2387
are combined, they are written out in the format described in
2388
VersionedFile.plan_merge
2390
if self._head_key is not None: # There was a single head
2391
if self._head_key == self.a_key:
2394
if self._head_key != self.b_key:
2395
raise AssertionError('There was an invalid head: %s != %s'
2396
% (self.b_key, self._head_key))
2398
head_rev = self._head_key[-1]
2399
lines = self.get_lines([head_rev])[head_rev]
2400
return ((plan, line) for line in lines)
2401
return self._weave.plan_merge(self.a_rev, self.b_rev)
2404
class _PlanLCAMerge(_PlanMergeBase):
2406
This merge algorithm differs from _PlanMerge in that:
2408
1. comparisons are done against LCAs only
2409
2. cases where a contested line is new versus one LCA but old versus
2410
another are marked as conflicts, by emitting the line as conflicted-a
2413
This is faster, and hopefully produces more useful output.
2416
def __init__(self, a_rev, b_rev, vf, key_prefix, graph):
2417
_PlanMergeBase.__init__(self, a_rev, b_rev, vf, key_prefix)
2418
lcas = graph.find_lca(key_prefix + (a_rev,), key_prefix + (b_rev,))
2421
if lca == _mod_revision.NULL_REVISION:
2424
self.lcas.add(lca[-1])
2425
for lca in self.lcas:
2426
if _mod_revision.is_null(lca):
2429
lca_lines = self.get_lines([lca])[lca]
2430
matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_a,
2432
blocks = list(matcher.get_matching_blocks())
2433
self._cached_matching_blocks[(a_rev, lca)] = blocks
2434
matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_b,
2436
blocks = list(matcher.get_matching_blocks())
2437
self._cached_matching_blocks[(b_rev, lca)] = blocks
2439
def _determine_status(self, revision_id, unique_line_numbers):
2440
"""Determines the status unique lines versus all lcas.
2442
Basically, determines why the line is unique to this revision.
2444
A line may be determined new, killed, or both.
2446
If a line is determined new, that means it was not present in at least
2447
one LCA, and is not present in the other merge revision.
2449
If a line is determined killed, that means the line was present in
2452
If a line is killed and new, this indicates that the two merge
2453
revisions contain differing conflict resolutions.
2455
:param revision_id: The id of the revision in which the lines are
2457
:param unique_line_numbers: The line numbers of unique lines.
2458
:return: a tuple of (new_this, killed_other)
2462
unique_line_numbers = set(unique_line_numbers)
2463
for lca in self.lcas:
2464
blocks = self._get_matching_blocks(revision_id, lca)
2465
unique_vs_lca, _ignored = self._unique_lines(blocks)
2466
new.update(unique_line_numbers.intersection(unique_vs_lca))
2467
killed.update(unique_line_numbers.difference(unique_vs_lca))
added
removed
breezy/merge.py
