13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
22
from bzrlib import (
20
branch as _mod_branch,
21
conflicts as _mod_conflicts,
30
28
revision as _mod_revision,
39
from bzrlib.cleanup import OperationWithCleanups
40
from bzrlib.symbol_versioning import (
30
from bzrlib.branch import Branch
31
from bzrlib.conflicts import ConflictList, Conflict
32
from bzrlib.errors import (BzrCommandError,
42
WorkingTreeNotRevision,
45
from bzrlib.merge3 import Merge3
46
from bzrlib.osutils import rename, pathjoin
47
from progress import DummyProgress, ProgressPhase
48
from bzrlib.revision import (NULL_REVISION, ensure_null)
49
from bzrlib.textfile import check_text_lines
50
from bzrlib.trace import mutter, warning, note, is_quiet
51
from bzrlib.transform import (TransformPreview, TreeTransform,
52
resolve_conflicts, cook_conflicts,
53
conflict_pass, FinalPaths, create_by_entry,
54
unique_add, ROOT_PARENT)
55
from bzrlib.versionedfile import PlanWeaveMerge
44
58
# TODO: Report back as changes are merged in
47
61
def transform_tree(from_tree, to_tree, interesting_ids=None):
48
from_tree.lock_tree_write()
49
operation = OperationWithCleanups(merge_inner)
50
operation.add_cleanup(from_tree.unlock)
51
operation.run_simple(from_tree.branch, to_tree, from_tree,
52
ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
55
class MergeHooks(hooks.Hooks):
58
hooks.Hooks.__init__(self)
59
self.create_hook(hooks.HookPoint('merge_file_content',
60
"Called with a bzrlib.merge.Merger object to create a per file "
61
"merge object when starting a merge. "
62
"Should return either None or a subclass of "
63
"``bzrlib.merge.AbstractPerFileMerger``. "
64
"Such objects will then be called per file "
65
"that needs to be merged (including when one "
66
"side has deleted the file and the other has changed it). "
67
"See the AbstractPerFileMerger API docs for details on how it is "
72
class AbstractPerFileMerger(object):
73
"""PerFileMerger objects are used by plugins extending merge for bzrlib.
75
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
77
:ivar merger: The Merge3Merger performing the merge.
80
def __init__(self, merger):
81
"""Create a PerFileMerger for use with merger."""
84
def merge_contents(self, merge_params):
85
"""Attempt to merge the contents of a single file.
87
:param merge_params: A bzrlib.merge.MergeHookParams
88
:return : A tuple of (status, chunks), where status is one of
89
'not_applicable', 'success', 'conflicted', or 'delete'. If status
90
is 'success' or 'conflicted', then chunks should be an iterable of
91
strings for the new file contents.
93
return ('not applicable', None)
96
class PerFileMerger(AbstractPerFileMerger):
97
"""Merge individual files when self.file_matches returns True.
99
This class is intended to be subclassed. The file_matches and
100
merge_matching methods should be overridden with concrete implementations.
103
def file_matches(self, params):
104
"""Return True if merge_matching should be called on this file.
106
Only called with merges of plain files with no clear winner.
108
Subclasses must override this.
110
raise NotImplementedError(self.file_matches)
112
def get_filename(self, params, tree):
113
"""Lookup the filename (i.e. basename, not path), given a Tree (e.g.
114
self.merger.this_tree) and a MergeHookParams.
116
return osutils.basename(tree.id2path(params.file_id))
118
def get_filepath(self, params, tree):
119
"""Calculate the path to the file in a tree.
121
:param params: A MergeHookParams describing the file to merge
122
:param tree: a Tree, e.g. self.merger.this_tree.
124
return tree.id2path(params.file_id)
126
def merge_contents(self, params):
127
"""Merge the contents of a single file."""
128
# Check whether this custom merge logic should be used.
130
# OTHER is a straight winner, rely on default merge.
131
params.winner == 'other' or
132
# THIS and OTHER aren't both files.
133
not params.is_file_merge() or
134
# The filename doesn't match *.xml
135
not self.file_matches(params)):
136
return 'not_applicable', None
137
return self.merge_matching(params)
139
def merge_matching(self, params):
140
"""Merge the contents of a single file that has matched the criteria
141
in PerFileMerger.merge_contents (is a conflict, is a file,
142
self.file_matches is True).
144
Subclasses must override this.
146
raise NotImplementedError(self.merge_matching)
149
class ConfigurableFileMerger(PerFileMerger):
150
"""Merge individual files when configured via a .conf file.
152
This is a base class for concrete custom file merging logic. Concrete
153
classes should implement ``merge_text``.
155
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
157
:ivar affected_files: The configured file paths to merge.
159
:cvar name_prefix: The prefix to use when looking up configuration
160
details. <name_prefix>_merge_files describes the files targeted by the
163
:cvar default_files: The default file paths to merge when no configuration
170
def __init__(self, merger):
171
super(ConfigurableFileMerger, self).__init__(merger)
172
self.affected_files = None
173
self.default_files = self.__class__.default_files or []
174
self.name_prefix = self.__class__.name_prefix
175
if self.name_prefix is None:
176
raise ValueError("name_prefix must be set.")
178
def file_matches(self, params):
179
"""Check whether the file should call the merge hook.
181
<name_prefix>_merge_files configuration variable is a list of files
182
that should use the hook.
184
affected_files = self.affected_files
185
if affected_files is None:
186
config = self.merger.this_branch.get_config()
187
# Until bzr provides a better policy for caching the config, we
188
# just add the part we're interested in to the params to avoid
189
# reading the config files repeatedly (bazaar.conf, location.conf,
191
config_key = self.name_prefix + '_merge_files'
192
affected_files = config.get_user_option_as_list(config_key)
193
if affected_files is None:
194
# If nothing was specified in the config, use the default.
195
affected_files = self.default_files
196
self.affected_files = affected_files
198
filepath = self.get_filepath(params, self.merger.this_tree)
199
if filepath in affected_files:
203
def merge_matching(self, params):
204
return self.merge_text(params)
206
def merge_text(self, params):
207
"""Merge the byte contents of a single file.
209
This is called after checking that the merge should be performed in
210
merge_contents, and it should behave as per
211
``bzrlib.merge.AbstractPerFileMerger.merge_contents``.
213
raise NotImplementedError(self.merge_text)
216
class MergeHookParams(object):
217
"""Object holding parameters passed to merge_file_content hooks.
219
There are some fields hooks can access:
221
:ivar file_id: the file ID of the file being merged
222
:ivar trans_id: the transform ID for the merge of this file
223
:ivar this_kind: kind of file_id in 'this' tree
224
:ivar other_kind: kind of file_id in 'other' tree
225
:ivar winner: one of 'this', 'other', 'conflict'
228
def __init__(self, merger, file_id, trans_id, this_kind, other_kind,
230
self._merger = merger
231
self.file_id = file_id
232
self.trans_id = trans_id
233
self.this_kind = this_kind
234
self.other_kind = other_kind
237
def is_file_merge(self):
238
"""True if this_kind and other_kind are both 'file'."""
239
return self.this_kind == 'file' and self.other_kind == 'file'
241
@decorators.cachedproperty
242
def base_lines(self):
243
"""The lines of the 'base' version of the file."""
244
return self._merger.get_lines(self._merger.base_tree, self.file_id)
246
@decorators.cachedproperty
247
def this_lines(self):
248
"""The lines of the 'this' version of the file."""
249
return self._merger.get_lines(self._merger.this_tree, self.file_id)
251
@decorators.cachedproperty
252
def other_lines(self):
253
"""The lines of the 'other' version of the file."""
254
return self._merger.get_lines(self._merger.other_tree, self.file_id)
62
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
63
interesting_ids=interesting_ids, this_tree=from_tree)
257
66
class Merger(object):
261
67
def __init__(self, this_branch, other_tree=None, base_tree=None,
262
this_tree=None, pb=None, change_reporter=None,
68
this_tree=None, pb=DummyProgress(), change_reporter=None,
263
69
recurse='down', revision_graph=None):
264
70
object.__init__(self)
71
assert this_tree is not None, "this_tree is required"
265
72
self.this_branch = this_branch
266
73
self.this_basis = _mod_revision.ensure_null(
267
74
this_branch.last_revision())
445
227
if self.other_rev_id is None:
446
228
other_basis_tree = self.revision_tree(self.other_basis)
447
if other_basis_tree.has_changes(self.other_tree):
448
raise errors.WorkingTreeNotRevision(self.this_tree)
229
changes = other_basis_tree.changes_from(self.other_tree)
230
if changes.has_changed():
231
raise WorkingTreeNotRevision(self.this_tree)
449
232
other_rev_id = self.other_basis
450
233
self.other_tree = other_basis_tree
452
@deprecated_method(deprecated_in((2, 1, 0)))
453
235
def file_revisions(self, file_id):
454
236
self.ensure_revision_trees()
455
237
def get_id(tree, file_id):
456
238
revision_id = tree.inventory[file_id].revision
239
assert revision_id is not None
457
240
return revision_id
458
241
if self.this_rev_id is None:
459
242
if self.this_basis_tree.get_file_sha1(file_id) != \
460
243
self.this_tree.get_file_sha1(file_id):
461
raise errors.WorkingTreeNotRevision(self.this_tree)
244
raise WorkingTreeNotRevision(self.this_tree)
463
246
trees = (self.this_basis_tree, self.other_tree)
464
247
return [get_id(tree, file_id) for tree in trees]
466
@deprecated_method(deprecated_in((2, 1, 0)))
467
249
def check_basis(self, check_clean, require_commits=True):
468
250
if self.this_basis is None and require_commits is True:
469
raise errors.BzrCommandError(
470
"This branch has no commits."
471
" (perhaps you would prefer 'bzr pull')")
251
raise BzrCommandError("This branch has no commits."
252
" (perhaps you would prefer 'bzr pull')")
473
254
self.compare_basis()
474
255
if self.this_basis != self.this_rev_id:
475
256
raise errors.UncommittedChanges(self.this_tree)
477
@deprecated_method(deprecated_in((2, 1, 0)))
478
258
def compare_basis(self):
480
260
basis_tree = self.revision_tree(self.this_tree.last_revision())
481
except errors.NoSuchRevision:
261
except errors.RevisionNotPresent:
482
262
basis_tree = self.this_tree.basis_tree()
483
if not self.this_tree.has_changes(basis_tree):
263
changes = self.this_tree.changes_from(basis_tree)
264
if not changes.has_changed():
484
265
self.this_rev_id = self.this_basis
486
267
def set_interesting_files(self, file_list):
487
268
self.interesting_files = file_list
489
270
def set_pending(self):
490
if (not self.base_is_ancestor or not self.base_is_other_ancestor
491
or self.other_rev_id is None):
271
if not self.base_is_ancestor or not self.base_is_other_ancestor or self.other_rev_id is None:
493
273
self._add_parent()
495
275
def _add_parent(self):
496
276
new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
497
277
new_parent_trees = []
498
operation = OperationWithCleanups(self.this_tree.set_parent_trees)
499
278
for revision_id in new_parents:
501
280
tree = self.revision_tree(revision_id)
502
except errors.NoSuchRevision:
281
except errors.RevisionNotPresent:
506
operation.add_cleanup(tree.unlock)
507
285
new_parent_trees.append((revision_id, tree))
508
operation.run_simple(new_parent_trees, allow_leftmost_as_ghost=True)
287
self.this_tree.set_parent_trees(new_parent_trees,
288
allow_leftmost_as_ghost=True)
290
for _revision_id, tree in new_parent_trees:
510
294
def set_other(self, other_revision, possible_transports=None):
511
295
"""Set the revision and tree to merge from.
562
346
target.fetch(source, revision_id)
564
348
def find_base(self):
565
revisions = [_mod_revision.ensure_null(self.this_basis),
566
_mod_revision.ensure_null(self.other_basis)]
567
if _mod_revision.NULL_REVISION in revisions:
568
self.base_rev_id = _mod_revision.NULL_REVISION
569
self.base_tree = self.revision_tree(self.base_rev_id)
570
self._is_criss_cross = False
349
revisions = [ensure_null(self.this_basis),
350
ensure_null(self.other_basis)]
351
if NULL_REVISION in revisions:
352
self.base_rev_id = NULL_REVISION
572
lcas = self.revision_graph.find_lca(revisions[0], revisions[1])
573
self._is_criss_cross = False
575
self.base_rev_id = _mod_revision.NULL_REVISION
577
self.base_rev_id = list(lcas)[0]
578
else: # len(lcas) > 1
580
# find_unique_lca can only handle 2 nodes, so we have to
581
# start back at the beginning. It is a shame to traverse
582
# the graph again, but better than re-implementing
584
self.base_rev_id = self.revision_graph.find_unique_lca(
585
revisions[0], revisions[1])
587
self.base_rev_id = self.revision_graph.find_unique_lca(
589
self._is_criss_cross = True
590
if self.base_rev_id == _mod_revision.NULL_REVISION:
591
raise errors.UnrelatedBranches()
592
if self._is_criss_cross:
593
trace.warning('Warning: criss-cross merge encountered. See bzr'
594
' help criss-cross.')
595
trace.mutter('Criss-cross lcas: %r' % lcas)
596
interesting_revision_ids = [self.base_rev_id]
597
interesting_revision_ids.extend(lcas)
598
interesting_trees = dict((t.get_revision_id(), t)
599
for t in self.this_branch.repository.revision_trees(
600
interesting_revision_ids))
601
self._cached_trees.update(interesting_trees)
602
self.base_tree = interesting_trees.pop(self.base_rev_id)
603
sorted_lca_keys = self.revision_graph.find_merge_order(
605
self._lca_trees = [interesting_trees[key]
606
for key in sorted_lca_keys]
608
self.base_tree = self.revision_tree(self.base_rev_id)
354
self.base_rev_id, steps = self.revision_graph.find_unique_lca(
355
revisions[0], revisions[1], count_steps=True)
356
if self.base_rev_id == NULL_REVISION:
357
raise UnrelatedBranches()
359
warning('Warning: criss-cross merge encountered. See bzr'
360
' help criss-cross.')
361
self.base_tree = self.revision_tree(self.base_rev_id)
609
362
self.base_is_ancestor = True
610
363
self.base_is_other_ancestor = True
611
trace.mutter('Base revid: %r' % self.base_rev_id)
613
365
def set_base(self, base_revision):
614
366
"""Set the base revision to use for the merge.
616
368
:param base_revision: A 2-list containing a path and revision number.
618
trace.mutter("doing merge() with no base_revision specified")
370
mutter("doing merge() with no base_revision specified")
619
371
if base_revision == [None, None]:
634
386
'other_tree': self.other_tree,
635
387
'interesting_ids': self.interesting_ids,
636
388
'interesting_files': self.interesting_files,
637
'this_branch': self.this_branch,
638
390
'do_merge': False}
639
391
if self.merge_type.requires_base:
640
392
kwargs['base_tree'] = self.base_tree
641
393
if self.merge_type.supports_reprocess:
642
394
kwargs['reprocess'] = self.reprocess
643
395
elif self.reprocess:
644
raise errors.BzrError(
645
"Conflict reduction is not supported for merge"
646
" type %s." % self.merge_type)
396
raise BzrError("Conflict reduction is not supported for merge"
397
" type %s." % self.merge_type)
647
398
if self.merge_type.supports_show_base:
648
399
kwargs['show_base'] = self.show_base
649
400
elif self.show_base:
650
raise errors.BzrError("Showing base is not supported for this"
651
" merge type. %s" % self.merge_type)
401
raise BzrError("Showing base is not supported for this"
402
" merge type. %s" % self.merge_type)
652
403
if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
653
404
and not self.base_is_other_ancestor):
654
405
raise errors.CannotReverseCherrypick()
655
406
if self.merge_type.supports_cherrypick:
656
407
kwargs['cherrypick'] = (not self.base_is_ancestor or
657
408
not self.base_is_other_ancestor)
658
if self._is_criss_cross and getattr(self.merge_type,
659
'supports_lca_trees', False):
660
kwargs['lca_trees'] = self._lca_trees
661
return self.merge_type(pb=None,
409
return self.merge_type(pb=self._pb,
662
410
change_reporter=self.change_reporter,
665
def _do_merge_to(self):
666
merge = self.make_merger()
667
if self.other_branch is not None:
668
self.other_branch.update_references(self.this_branch)
670
if self.recurse == 'down':
671
for relpath, file_id in self.this_tree.iter_references():
672
sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
673
other_revision = self.other_tree.get_reference_revision(
675
if other_revision == sub_tree.last_revision():
677
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
678
sub_merge.merge_type = self.merge_type
679
other_branch = self.other_branch.reference_parent(file_id, relpath)
680
sub_merge.set_other_revision(other_revision, other_branch)
681
base_revision = self.base_tree.get_reference_revision(file_id)
682
sub_merge.base_tree = \
683
sub_tree.branch.repository.revision_tree(base_revision)
684
sub_merge.base_rev_id = base_revision
688
413
def do_merge(self):
689
operation = OperationWithCleanups(self._do_merge_to)
690
414
self.this_tree.lock_tree_write()
691
operation.add_cleanup(self.this_tree.unlock)
692
415
if self.base_tree is not None:
693
416
self.base_tree.lock_read()
694
operation.add_cleanup(self.base_tree.unlock)
695
417
if self.other_tree is not None:
696
418
self.other_tree.lock_read()
697
operation.add_cleanup(self.other_tree.unlock)
698
merge = operation.run_simple()
420
merge = self.make_merger()
422
if self.recurse == 'down':
423
for path, file_id in self.this_tree.iter_references():
424
sub_tree = self.this_tree.get_nested_tree(file_id, path)
425
other_revision = self.other_tree.get_reference_revision(
427
if other_revision == sub_tree.last_revision():
429
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
430
sub_merge.merge_type = self.merge_type
431
relpath = self.this_tree.relpath(path)
432
other_branch = self.other_branch.reference_parent(file_id, relpath)
433
sub_merge.set_other_revision(other_revision, other_branch)
434
base_revision = self.base_tree.get_reference_revision(file_id)
435
sub_merge.base_tree = \
436
sub_tree.branch.repository.revision_tree(base_revision)
437
sub_merge.base_rev_id = base_revision
441
if self.other_tree is not None:
442
self.other_tree.unlock()
443
if self.base_tree is not None:
444
self.base_tree.unlock()
445
self.this_tree.unlock()
699
446
if len(merge.cooked_conflicts) == 0:
700
if not self.ignore_zero and not trace.is_quiet():
701
trace.note("All changes applied successfully.")
447
if not self.ignore_zero and not is_quiet():
448
note("All changes applied successfully.")
703
trace.note("%d conflicts encountered."
704
% len(merge.cooked_conflicts))
450
note("%d conflicts encountered." % len(merge.cooked_conflicts))
706
452
return len(merge.cooked_conflicts)
709
class _InventoryNoneEntry(object):
710
"""This represents an inventory entry which *isn't there*.
712
It simplifies the merging logic if we always have an InventoryEntry, even
713
if it isn't actually present
720
symlink_target = None
723
_none_entry = _InventoryNoneEntry()
726
455
class Merge3Merger(object):
727
456
"""Three-way merger that uses the merge3 text merger"""
728
457
requires_base = True
762
488
be combined with interesting_ids. If neither interesting_files nor
763
489
interesting_ids is specified, all files may participate in the
765
:param lca_trees: Can be set to a dictionary of {revision_id:rev_tree}
766
if the ancestry was found to include a criss-cross merge.
767
Otherwise should be None.
769
492
object.__init__(self)
770
if interesting_files is not None and interesting_ids is not None:
772
'specify either interesting_ids or interesting_files')
773
if this_branch is None:
774
this_branch = this_tree.branch
493
if interesting_files is not None:
494
assert interesting_ids is None
775
495
self.interesting_ids = interesting_ids
776
496
self.interesting_files = interesting_files
777
497
self.this_tree = working_tree
778
498
self.base_tree = base_tree
779
499
self.other_tree = other_tree
780
self.this_branch = this_branch
781
500
self._raw_conflicts = []
782
501
self.cooked_conflicts = []
783
502
self.reprocess = reprocess
784
503
self.show_base = show_base
785
self._lca_trees = lca_trees
786
# Uncommenting this will change the default algorithm to always use
787
# _entries_lca. This can be useful for running the test suite and
788
# making sure we haven't missed any corner cases.
789
# if lca_trees is None:
790
# self._lca_trees = [self.base_tree]
791
506
self.change_reporter = change_reporter
792
507
self.cherrypick = cherrypick
509
self.pp = ProgressPhase("Merge phase", 3, self.pb)
796
warnings.warn("pp argument to Merge3Merger is deprecated")
798
warnings.warn("pb argument to Merge3Merger is deprecated")
800
513
def do_merge(self):
801
operation = OperationWithCleanups(self._do_merge)
802
514
self.this_tree.lock_tree_write()
803
operation.add_cleanup(self.this_tree.unlock)
804
515
self.base_tree.lock_read()
805
operation.add_cleanup(self.base_tree.unlock)
806
516
self.other_tree.lock_read()
807
operation.add_cleanup(self.other_tree.unlock)
810
def _do_merge(self, operation):
811
self.tt = transform.TreeTransform(self.this_tree, None)
812
operation.add_cleanup(self.tt.finalize)
813
self._compute_transform()
814
results = self.tt.apply(no_conflicts=True)
815
self.write_modified(results)
517
self.tt = TreeTransform(self.this_tree, self.pb)
817
self.this_tree.add_conflicts(self.cooked_conflicts)
818
except errors.UnsupportedOperation:
520
self._compute_transform()
522
results = self.tt.apply(no_conflicts=True)
523
self.write_modified(results)
525
self.this_tree.add_conflicts(self.cooked_conflicts)
526
except UnsupportedOperation:
530
self.other_tree.unlock()
531
self.base_tree.unlock()
532
self.this_tree.unlock()
821
535
def make_preview_transform(self):
822
operation = OperationWithCleanups(self._make_preview_transform)
823
536
self.base_tree.lock_read()
824
operation.add_cleanup(self.base_tree.unlock)
825
537
self.other_tree.lock_read()
826
operation.add_cleanup(self.other_tree.unlock)
827
return operation.run_simple()
829
def _make_preview_transform(self):
830
self.tt = transform.TransformPreview(self.this_tree)
831
self._compute_transform()
538
self.tt = TransformPreview(self.this_tree)
541
self._compute_transform()
544
self.other_tree.unlock()
545
self.base_tree.unlock()
834
549
def _compute_transform(self):
835
if self._lca_trees is None:
836
entries = self._entries3()
837
resolver = self._three_way
839
entries = self._entries_lca()
840
resolver = self._lca_multi_way
550
entries = self._entries3()
841
551
child_pb = ui.ui_factory.nested_progress_bar()
843
factories = Merger.hooks['merge_file_content']
844
hooks = [factory(self) for factory in factories] + [self]
845
self.active_hooks = [hook for hook in hooks if hook is not None]
846
553
for num, (file_id, changed, parents3, names3,
847
554
executable3) in enumerate(entries):
848
555
child_pb.update('Preparing file merge', num, len(entries))
849
self._merge_names(file_id, parents3, names3, resolver=resolver)
556
self._merge_names(file_id, parents3, names3)
851
file_status = self._do_merge_contents(file_id)
558
file_status = self.merge_contents(file_id)
853
560
file_status = 'unmodified'
854
561
self._merge_executable(file_id,
855
executable3, file_status, resolver=resolver)
562
executable3, file_status)
857
564
child_pb.finished()
859
567
child_pb = ui.ui_factory.nested_progress_bar()
861
fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
862
lambda t, c: transform.conflict_pass(t, c, self.other_tree))
569
fs_conflicts = resolve_conflicts(self.tt, child_pb,
570
lambda t, c: conflict_pass(t, c, self.other_tree))
864
572
child_pb.finished()
865
573
if self.change_reporter is not None:
906
611
result.append((file_id, changed, parents3, names3, executable3))
909
def _entries_lca(self):
910
"""Gather data about files modified between multiple trees.
912
This compares OTHER versus all LCA trees, and for interesting entries,
913
it then compares with THIS and BASE.
915
For the multi-valued entries, the format will be (BASE, [lca1, lca2])
916
:return: [(file_id, changed, parents, names, executable)]
917
file_id Simple file_id of the entry
918
changed Boolean, True if the kind or contents changed
920
parents ((base, [parent_id, in, lcas]), parent_id_other,
922
names ((base, [name, in, lcas]), name_in_other, name_in_this)
923
executable ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
925
if self.interesting_files is not None:
926
lookup_trees = [self.this_tree, self.base_tree]
927
lookup_trees.extend(self._lca_trees)
928
# I think we should include the lca trees as well
929
interesting_ids = self.other_tree.paths2ids(self.interesting_files,
932
interesting_ids = self.interesting_ids
934
walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
936
base_inventory = self.base_tree.inventory
937
this_inventory = self.this_tree.inventory
938
for path, file_id, other_ie, lca_values in walker.iter_all():
939
# Is this modified at all from any of the other trees?
941
other_ie = _none_entry
942
if interesting_ids is not None and file_id not in interesting_ids:
945
# If other_revision is found in any of the lcas, that means this
946
# node is uninteresting. This is because when merging, if there are
947
# multiple heads(), we have to create a new node. So if we didn't,
948
# we know that the ancestry is linear, and that OTHER did not
950
# See doc/developers/lca_merge_resolution.txt for details
951
other_revision = other_ie.revision
952
if other_revision is not None:
953
# We can't use this shortcut when other_revision is None,
954
# because it may be None because things are WorkingTrees, and
955
# not because it is *actually* None.
956
is_unmodified = False
957
for lca_path, ie in lca_values:
958
if ie is not None and ie.revision == other_revision:
965
for lca_path, lca_ie in lca_values:
967
lca_entries.append(_none_entry)
969
lca_entries.append(lca_ie)
971
if file_id in base_inventory:
972
base_ie = base_inventory[file_id]
974
base_ie = _none_entry
976
if file_id in this_inventory:
977
this_ie = this_inventory[file_id]
979
this_ie = _none_entry
985
for lca_ie in lca_entries:
986
lca_kinds.append(lca_ie.kind)
987
lca_parent_ids.append(lca_ie.parent_id)
988
lca_names.append(lca_ie.name)
989
lca_executable.append(lca_ie.executable)
991
kind_winner = self._lca_multi_way(
992
(base_ie.kind, lca_kinds),
993
other_ie.kind, this_ie.kind)
994
parent_id_winner = self._lca_multi_way(
995
(base_ie.parent_id, lca_parent_ids),
996
other_ie.parent_id, this_ie.parent_id)
997
name_winner = self._lca_multi_way(
998
(base_ie.name, lca_names),
999
other_ie.name, this_ie.name)
1001
content_changed = True
1002
if kind_winner == 'this':
1003
# No kind change in OTHER, see if there are *any* changes
1004
if other_ie.kind == 'directory':
1005
if parent_id_winner == 'this' and name_winner == 'this':
1006
# No change for this directory in OTHER, skip
1008
content_changed = False
1009
elif other_ie.kind is None or other_ie.kind == 'file':
1010
def get_sha1(ie, tree):
1011
if ie.kind != 'file':
1013
return tree.get_file_sha1(file_id)
1014
base_sha1 = get_sha1(base_ie, self.base_tree)
1015
lca_sha1s = [get_sha1(ie, tree) for ie, tree
1016
in zip(lca_entries, self._lca_trees)]
1017
this_sha1 = get_sha1(this_ie, self.this_tree)
1018
other_sha1 = get_sha1(other_ie, self.other_tree)
1019
sha1_winner = self._lca_multi_way(
1020
(base_sha1, lca_sha1s), other_sha1, this_sha1,
1021
allow_overriding_lca=False)
1022
exec_winner = self._lca_multi_way(
1023
(base_ie.executable, lca_executable),
1024
other_ie.executable, this_ie.executable)
1025
if (parent_id_winner == 'this' and name_winner == 'this'
1026
and sha1_winner == 'this' and exec_winner == 'this'):
1027
# No kind, parent, name, exec, or content change for
1028
# OTHER, so this node is not considered interesting
1030
if sha1_winner == 'this':
1031
content_changed = False
1032
elif other_ie.kind == 'symlink':
1033
def get_target(ie, tree):
1034
if ie.kind != 'symlink':
1036
return tree.get_symlink_target(file_id)
1037
base_target = get_target(base_ie, self.base_tree)
1038
lca_targets = [get_target(ie, tree) for ie, tree
1039
in zip(lca_entries, self._lca_trees)]
1040
this_target = get_target(this_ie, self.this_tree)
1041
other_target = get_target(other_ie, self.other_tree)
1042
target_winner = self._lca_multi_way(
1043
(base_target, lca_targets),
1044
other_target, this_target)
1045
if (parent_id_winner == 'this' and name_winner == 'this'
1046
and target_winner == 'this'):
1047
# No kind, parent, name, or symlink target change
1050
if target_winner == 'this':
1051
content_changed = False
1052
elif other_ie.kind == 'tree-reference':
1053
# The 'changed' information seems to be handled at a higher
1054
# level. At least, _entries3 returns False for content
1055
# changed, even when at a new revision_id.
1056
content_changed = False
1057
if (parent_id_winner == 'this' and name_winner == 'this'):
1058
# Nothing interesting
1061
raise AssertionError('unhandled kind: %s' % other_ie.kind)
1063
# If we have gotten this far, that means something has changed
1064
result.append((file_id, content_changed,
1065
((base_ie.parent_id, lca_parent_ids),
1066
other_ie.parent_id, this_ie.parent_id),
1067
((base_ie.name, lca_names),
1068
other_ie.name, this_ie.name),
1069
((base_ie.executable, lca_executable),
1070
other_ie.executable, this_ie.executable)
1075
614
def fix_root(self):
1077
616
self.tt.final_kind(self.tt.root)
1078
except errors.NoSuchFile:
1079
618
self.tt.cancel_deletion(self.tt.root)
1080
619
if self.tt.final_file_id(self.tt.root) is None:
1081
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
620
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
622
if self.other_tree.inventory.root is None:
1083
624
other_root_file_id = self.other_tree.get_root_id()
1084
if other_root_file_id is None:
1086
625
other_root = self.tt.trans_id_file_id(other_root_file_id)
1087
626
if other_root == self.tt.root:
1089
if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
1090
# the other tree's root is a non-root in the current tree (as when
1091
# a previously unrelated branch is merged into another)
1094
629
self.tt.final_kind(other_root)
1095
other_root_is_present = True
1096
except errors.NoSuchFile:
1097
# other_root doesn't have a physical representation. We still need
1098
# to move any references to the actual root of the tree.
1099
other_root_is_present = False
1100
# 'other_tree.inventory.root' is not present in this tree. We are
1101
# calling adjust_path for children which *want* to be present with a
1102
# correct place to go.
1103
for thing, child in self.other_tree.inventory.root.children.iteritems():
632
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
633
self.tt.cancel_creation(other_root)
634
self.tt.cancel_versioning(other_root)
636
def reparent_children(self, ie, target):
637
for thing, child in ie.children.iteritems():
1104
638
trans_id = self.tt.trans_id_file_id(child.file_id)
1105
if not other_root_is_present:
1106
# FIXME: Make final_kind returns None instead of raising
1107
# NoSuchFile to avoid the ugly construct below -- vila 20100402
1109
self.tt.final_kind(trans_id)
1110
# The item exist in the final tree and has a defined place
1113
except errors.NoSuchFile, e:
1115
# Move the item into the root
1116
self.tt.adjust_path(self.tt.final_name(trans_id),
1117
self.tt.root, trans_id)
1118
if other_root_is_present:
1119
self.tt.cancel_creation(other_root)
1120
self.tt.cancel_versioning(other_root)
639
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
1122
641
def write_modified(self, results):
1123
642
modified_hashes = {}
1165
684
def kind(tree, file_id):
1166
685
"""Determine the kind of a file-id (used as a key method)."""
1167
if not tree.has_id(file_id):
686
if file_id not in tree:
1169
688
return tree.kind(file_id)
1172
691
def _three_way(base, other, this):
692
#if base == other, either they all agree, or only THIS has changed.
1173
693
if base == other:
1174
# if 'base == other', either they all agree, or only 'this' has
1177
695
elif this not in (base, other):
1178
# 'this' is neither 'base' nor 'other', so both sides changed
1179
696
return 'conflict'
697
# "Ambiguous clean merge" -- both sides have made the same change.
1180
698
elif this == other:
1181
# "Ambiguous clean merge" -- both sides have made the same change.
700
# this == base: only other has changed.
1184
# this == base: only other has changed.
1188
def _lca_multi_way(bases, other, this, allow_overriding_lca=True):
1189
"""Consider LCAs when determining whether a change has occurred.
1191
If LCAS are all identical, this is the same as a _three_way comparison.
1193
:param bases: value in (BASE, [LCAS])
1194
:param other: value in OTHER
1195
:param this: value in THIS
1196
:param allow_overriding_lca: If there is more than one unique lca
1197
value, allow OTHER to override THIS if it has a new value, and
1198
THIS only has an lca value, or vice versa. This is appropriate for
1199
truly scalar values, not as much for non-scalars.
1200
:return: 'this', 'other', or 'conflict' depending on whether an entry
1203
# See doc/developers/lca_tree_merging.txt for details about this
1206
# Either Ambiguously clean, or nothing was actually changed. We
1209
base_val, lca_vals = bases
1210
# Remove 'base_val' from the lca_vals, because it is not interesting
1211
filtered_lca_vals = [lca_val for lca_val in lca_vals
1212
if lca_val != base_val]
1213
if len(filtered_lca_vals) == 0:
1214
return Merge3Merger._three_way(base_val, other, this)
1216
unique_lca_vals = set(filtered_lca_vals)
1217
if len(unique_lca_vals) == 1:
1218
return Merge3Merger._three_way(unique_lca_vals.pop(), other, this)
1220
if allow_overriding_lca:
1221
if other in unique_lca_vals:
1222
if this in unique_lca_vals:
1223
# Each side picked a different lca, conflict
1226
# This has a value which supersedes both lca values, and
1227
# other only has an lca value
1229
elif this in unique_lca_vals:
1230
# OTHER has a value which supersedes both lca values, and this
1231
# only has an lca value
1234
# At this point, the lcas disagree, and the tip disagree
1238
@deprecated_method(deprecated_in((2, 2, 0)))
1239
705
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
1240
706
"""Do a three-way test on a scalar.
1241
707
Return "this", "other" or "conflict", depending whether a value wins.
1326
792
return kind, contents
794
def contents_conflict():
795
trans_id = self.tt.trans_id_file_id(file_id)
796
name = self.tt.final_name(trans_id)
797
parent_id = self.tt.final_parent(trans_id)
798
if file_id in self.this_tree.inventory:
799
self.tt.unversion_file(trans_id)
800
if file_id in self.this_tree:
801
self.tt.delete_contents(trans_id)
802
file_group = self._dump_conflicts(name, parent_id, file_id,
804
self._raw_conflicts.append(('contents conflict', file_group))
1328
806
# See SPOT run. run, SPOT, run.
1329
807
# So we're not QUITE repeating ourselves; we do tricky things with
1331
809
base_pair = contents_pair(self.base_tree)
1332
810
other_pair = contents_pair(self.other_tree)
1334
this_pair = contents_pair(self.this_tree)
1335
lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1336
winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1337
this_pair, allow_overriding_lca=False)
1339
if base_pair == other_pair:
1342
# We delayed evaluating this_pair as long as we can to avoid
1343
# unnecessary sha1 calculation
1344
this_pair = contents_pair(self.this_tree)
1345
winner = self._three_way(base_pair, other_pair, this_pair)
1346
if winner == 'this':
1347
# No interesting changes introduced by OTHER
1349
# We have a hypothetical conflict, but if we have files, then we
1350
# can try to merge the content
1351
trans_id = self.tt.trans_id_file_id(file_id)
1352
params = MergeHookParams(self, file_id, trans_id, this_pair[0],
1353
other_pair[0], winner)
1354
hooks = self.active_hooks
1355
hook_status = 'not_applicable'
1357
hook_status, lines = hook.merge_contents(params)
1358
if hook_status != 'not_applicable':
1359
# Don't try any more hooks, this one applies.
1362
if hook_status == 'not_applicable':
1363
# This is a contents conflict, because none of the available
1364
# functions could merge it.
1366
name = self.tt.final_name(trans_id)
1367
parent_id = self.tt.final_parent(trans_id)
1368
if self.this_tree.has_id(file_id):
1369
self.tt.unversion_file(trans_id)
1370
file_group = self._dump_conflicts(name, parent_id, file_id,
1372
self._raw_conflicts.append(('contents conflict', file_group))
1373
elif hook_status == 'success':
1374
self.tt.create_file(lines, trans_id)
1375
elif hook_status == 'conflicted':
1376
# XXX: perhaps the hook should be able to provide
1377
# the BASE/THIS/OTHER files?
1378
self.tt.create_file(lines, trans_id)
1379
self._raw_conflicts.append(('text conflict', trans_id))
1380
name = self.tt.final_name(trans_id)
1381
parent_id = self.tt.final_parent(trans_id)
1382
self._dump_conflicts(name, parent_id, file_id)
1383
elif hook_status == 'delete':
1384
self.tt.unversion_file(trans_id)
1386
elif hook_status == 'done':
1387
# The hook function did whatever it needs to do directly, no
1388
# further action needed here.
1391
raise AssertionError('unknown hook_status: %r' % (hook_status,))
1392
if not self.this_tree.has_id(file_id) and result == "modified":
1393
self.tt.version_file(file_id, trans_id)
1394
# The merge has been performed, so the old contents should not be
1397
self.tt.delete_contents(trans_id)
1398
except errors.NoSuchFile:
1402
def _default_other_winner_merge(self, merge_hook_params):
1403
"""Replace this contents with other."""
1404
file_id = merge_hook_params.file_id
1405
trans_id = merge_hook_params.trans_id
1406
file_in_this = self.this_tree.has_id(file_id)
1407
if self.other_tree.has_id(file_id):
1408
# OTHER changed the file
1410
if wt.supports_content_filtering():
1411
# We get the path from the working tree if it exists.
1412
# That fails though when OTHER is adding a file, so
1413
# we fall back to the other tree to find the path if
1414
# it doesn't exist locally.
1416
filter_tree_path = wt.id2path(file_id)
1417
except errors.NoSuchId:
1418
filter_tree_path = self.other_tree.id2path(file_id)
1420
# Skip the id2path lookup for older formats
1421
filter_tree_path = None
1422
transform.create_from_tree(self.tt, trans_id,
1423
self.other_tree, file_id,
1424
filter_tree_path=filter_tree_path)
1427
# OTHER deleted the file
1428
return 'delete', None
1430
raise AssertionError(
1431
'winner is OTHER, but file_id %r not in THIS or OTHER tree'
1434
def merge_contents(self, merge_hook_params):
1435
"""Fallback merge logic after user installed hooks."""
1436
# This function is used in merge hooks as the fallback instance.
1437
# Perhaps making this function and the functions it calls be a
1438
# a separate class would be better.
1439
if merge_hook_params.winner == 'other':
1440
# OTHER is a straight winner, so replace this contents with other
1441
return self._default_other_winner_merge(merge_hook_params)
1442
elif merge_hook_params.is_file_merge():
1443
# THIS and OTHER are both files, so text merge. Either
1444
# BASE is a file, or both converted to files, so at least we
1445
# have agreement that output should be a file.
1447
self.text_merge(merge_hook_params.file_id,
1448
merge_hook_params.trans_id)
1449
except errors.BinaryFile:
1450
return 'not_applicable', None
1453
return 'not_applicable', None
811
if base_pair == other_pair:
812
# OTHER introduced no changes
814
this_pair = contents_pair(self.this_tree)
815
if this_pair == other_pair:
816
# THIS and OTHER introduced the same changes
819
trans_id = self.tt.trans_id_file_id(file_id)
820
if this_pair == base_pair:
821
# only OTHER introduced changes
822
if file_id in self.this_tree:
823
# Remove any existing contents
824
self.tt.delete_contents(trans_id)
825
if file_id in self.other_tree:
826
# OTHER changed the file
827
create_by_entry(self.tt,
828
self.other_tree.inventory[file_id],
829
self.other_tree, trans_id)
830
if file_id not in self.this_tree.inventory:
831
self.tt.version_file(file_id, trans_id)
833
elif file_id in self.this_tree.inventory:
834
# OTHER deleted the file
835
self.tt.unversion_file(trans_id)
837
#BOTH THIS and OTHER introduced changes; scalar conflict
838
elif this_pair[0] == "file" and other_pair[0] == "file":
839
# THIS and OTHER are both files, so text merge. Either
840
# BASE is a file, or both converted to files, so at least we
841
# have agreement that output should be a file.
843
self.text_merge(file_id, trans_id)
845
return contents_conflict()
846
if file_id not in self.this_tree.inventory:
847
self.tt.version_file(file_id, trans_id)
849
self.tt.tree_kind(trans_id)
850
self.tt.delete_contents(trans_id)
855
# Scalar conflict, can't text merge. Dump conflicts
856
return contents_conflict()
1455
858
def get_lines(self, tree, file_id):
1456
859
"""Return the lines in a file, or an empty list."""
1457
if tree.has_id(file_id):
1458
861
return tree.get_file(file_id).readlines()
1511
914
determined automatically. If set_version is true, the .OTHER, .THIS
1512
915
or .BASE (in that order) will be created as versioned files.
1514
data = [('OTHER', self.other_tree, other_lines),
917
data = [('OTHER', self.other_tree, other_lines),
1515
918
('THIS', self.this_tree, this_lines)]
1517
920
data.append(('BASE', self.base_tree, base_lines))
1519
# We need to use the actual path in the working tree of the file here,
1520
# ignoring the conflict suffixes
1522
if wt.supports_content_filtering():
1524
filter_tree_path = wt.id2path(file_id)
1525
except errors.NoSuchId:
1526
# file has been deleted
1527
filter_tree_path = None
1529
# Skip the id2path lookup for older formats
1530
filter_tree_path = None
1532
921
versioned = False
1534
923
for suffix, tree, lines in data:
1535
if tree.has_id(file_id):
1536
925
trans_id = self._conflict_file(name, parent_id, tree, file_id,
1537
suffix, lines, filter_tree_path)
1538
927
file_group.append(trans_id)
1539
928
if set_version and not versioned:
1540
929
self.tt.version_file(file_id, trans_id)
1541
930
versioned = True
1542
931
return file_group
1544
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1545
lines=None, filter_tree_path=None):
933
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1546
935
"""Emit a single conflict file."""
1547
936
name = name + '.' + suffix
1548
937
trans_id = self.tt.create_path(name, parent_id)
1549
transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
938
entry = tree.inventory[file_id]
939
create_by_entry(self.tt, entry, tree, trans_id, lines)
1553
942
def merge_executable(self, file_id, file_status):
1554
943
"""Perform a merge on the execute bit."""
1555
944
executable = [self.executable(t, file_id) for t in (self.base_tree,
1556
945
self.other_tree, self.this_tree)]
1557
self._merge_executable(file_id, executable, file_status,
1558
resolver=self._three_way)
946
self._merge_executable(file_id, executable, file_status)
1560
def _merge_executable(self, file_id, executable, file_status,
948
def _merge_executable(self, file_id, executable, file_status):
1562
949
"""Perform a merge on the execute bit."""
1563
950
base_executable, other_executable, this_executable = executable
1564
951
if file_status == "deleted":
1566
winner = resolver(*executable)
953
winner = self._three_way(*executable)
1567
954
if winner == "conflict":
1568
955
# There must be a None in here, if we have a conflict, but we
1569
956
# need executability since file status was not deleted.
1650
1047
supports_reverse_cherrypick = False
1651
1048
history_based = True
1653
def _generate_merge_plan(self, file_id, base):
1654
return self.this_tree.plan_file_merge(file_id, self.other_tree,
1050
def _merged_lines(self, file_id):
1051
"""Generate the merged lines.
1052
There is no distinction between lines that are meant to contain <<<<<<<
1056
base = self.base_tree
1059
plan = self.this_tree.plan_file_merge(file_id, self.other_tree,
1657
def _merged_lines(self, file_id):
1658
"""Generate the merged lines.
1659
There is no distinction between lines that are meant to contain <<<<<<<
1663
base = self.base_tree
1666
plan = self._generate_merge_plan(file_id, base)
1667
1061
if 'merge' in debug.debug_flags:
1668
1062
plan = list(plan)
1669
1063
trans_id = self.tt.trans_id_file_id(file_id)
1670
1064
name = self.tt.final_name(trans_id) + '.plan'
1671
contents = ('%11s|%s' % l for l in plan)
1065
contents = ('%10s|%s' % l for l in plan)
1672
1066
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1673
textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1674
'>>>>>>> MERGE-SOURCE\n')
1675
lines, conflicts = textmerge.merge_lines(self.reprocess)
1677
base_lines = textmerge.base_from_plan()
1680
return lines, base_lines
1067
textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1068
'>>>>>>> MERGE-SOURCE\n')
1069
return textmerge.merge_lines(self.reprocess)
1682
1071
def text_merge(self, file_id, trans_id):
1683
1072
"""Perform a (weave) text merge for a given file and file-id.
1684
1073
If conflicts are encountered, .THIS and .OTHER files will be emitted,
1685
1074
and a conflict will be noted.
1687
lines, base_lines = self._merged_lines(file_id)
1076
lines, conflicts = self._merged_lines(file_id)
1688
1077
lines = list(lines)
1689
# Note we're checking whether the OUTPUT is binary in this case,
1078
# Note we're checking whether the OUTPUT is binary in this case,
1690
1079
# because we don't want to get into weave merge guts.
1691
textfile.check_text_lines(lines)
1080
check_text_lines(lines)
1692
1081
self.tt.create_file(lines, trans_id)
1693
if base_lines is not None:
1695
1083
self._raw_conflicts.append(('text conflict', trans_id))
1696
1084
name = self.tt.final_name(trans_id)
1697
1085
parent_id = self.tt.final_parent(trans_id)
1698
file_group = self._dump_conflicts(name, parent_id, file_id,
1700
base_lines=base_lines)
1086
file_group = self._dump_conflicts(name, parent_id, file_id,
1701
1088
file_group.append(trans_id)
1704
1091
class LCAMerger(WeaveMerger):
1706
def _generate_merge_plan(self, file_id, base):
1707
return self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1093
def _merged_lines(self, file_id):
1094
"""Generate the merged lines.
1095
There is no distinction between lines that are meant to contain <<<<<<<
1099
base = self.base_tree
1102
plan = self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1104
if 'merge' in debug.debug_flags:
1106
trans_id = self.tt.trans_id_file_id(file_id)
1107
name = self.tt.final_name(trans_id) + '.plan'
1108
contents = ('%10s|%s' % l for l in plan)
1109
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1110
textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1111
'>>>>>>> MERGE-SOURCE\n')
1112
return textmerge.merge_lines(self.reprocess)
1710
1115
class Diff3Merger(Merge3Merger):
1711
1116
"""Three-way merger using external diff3 for text merging"""
1713
1118
def dump_file(self, temp_dir, name, tree, file_id):
1714
out_path = osutils.pathjoin(temp_dir, name)
1119
out_path = pathjoin(temp_dir, name)
1715
1120
out_file = open(out_path, "wb")
1717
1122
in_file = tree.get_file(file_id)
1828
1231
yield status_a(revision, text)
1829
1232
for revision, text in annotated_b[b_cur:bi]:
1830
1233
yield status_b(revision, text)
1831
1235
# and now the matched section
1834
for text_a in plain_a[ai:a_cur]:
1238
for text_a, text_b in zip(plain_a[ai:a_cur], plain_b[bi:b_cur]):
1239
assert text_a == text_b
1835
1240
yield "unchanged", text_a
1838
1243
class _PlanMergeBase(object):
1840
def __init__(self, a_rev, b_rev, vf, key_prefix):
1245
def __init__(self, a_rev, b_rev, vf):
1843
1248
:param a_rev: Revision-id of one revision to merge
1844
1249
:param b_rev: Revision-id of the other revision to merge
1845
:param vf: A VersionedFiles containing both revisions
1846
:param key_prefix: A prefix for accessing keys in vf, typically
1250
:param vf: A versionedfile containing both revisions
1849
1252
self.a_rev = a_rev
1850
1253
self.b_rev = b_rev
1254
self.lines_a = vf.get_lines(a_rev)
1255
self.lines_b = vf.get_lines(b_rev)
1852
1257
self._last_lines = None
1853
1258
self._last_lines_revision_id = None
1854
1259
self._cached_matching_blocks = {}
1855
self._key_prefix = key_prefix
1856
self._precache_tip_lines()
1858
def _precache_tip_lines(self):
1859
lines = self.get_lines([self.a_rev, self.b_rev])
1860
self.lines_a = lines[self.a_rev]
1861
self.lines_b = lines[self.b_rev]
1863
def get_lines(self, revisions):
1864
"""Get lines for revisions from the backing VersionedFiles.
1866
:raises RevisionNotPresent: on absent texts.
1868
keys = [(self._key_prefix + (rev,)) for rev in revisions]
1870
for record in self.vf.get_record_stream(keys, 'unordered', True):
1871
if record.storage_kind == 'absent':
1872
raise errors.RevisionNotPresent(record.key, self.vf)
1873
result[record.key[-1]] = osutils.chunks_to_lines(
1874
record.get_bytes_as('chunked'))
1877
1261
def plan_merge(self):
1878
1262
"""Generate a 'plan' for merging the two revisions.
1989
1371
class _PlanMerge(_PlanMergeBase):
1990
1372
"""Plan an annotate merge using on-the-fly annotation"""
1992
def __init__(self, a_rev, b_rev, vf, key_prefix):
1993
super(_PlanMerge, self).__init__(a_rev, b_rev, vf, key_prefix)
1994
self.a_key = self._key_prefix + (self.a_rev,)
1995
self.b_key = self._key_prefix + (self.b_rev,)
1996
self.graph = _mod_graph.Graph(self.vf)
1997
heads = self.graph.heads((self.a_key, self.b_key))
1999
# one side dominates, so we can just return its values, yay for
2001
# Ideally we would know that before we get this far
2002
self._head_key = heads.pop()
2003
if self._head_key == self.a_key:
2007
trace.mutter('found dominating revision for %s\n%s > %s', self.vf,
2008
self._head_key[-1], other)
2011
self._head_key = None
2014
def _precache_tip_lines(self):
2015
# Turn this into a no-op, because we will do this later
2018
def _find_recursive_lcas(self):
2019
"""Find all the ancestors back to a unique lca"""
2020
cur_ancestors = (self.a_key, self.b_key)
2021
# graph.find_lca(uncommon, keys) now returns plain NULL_REVISION,
2022
# rather than a key tuple. We will just map that directly to no common
2026
next_lcas = self.graph.find_lca(*cur_ancestors)
2027
# Map a plain NULL_REVISION to a simple no-ancestors
2028
if next_lcas == set([_mod_revision.NULL_REVISION]):
2030
# Order the lca's based on when they were merged into the tip
2031
# While the actual merge portion of weave merge uses a set() of
2032
# active revisions, the order of insertion *does* effect the
2033
# implicit ordering of the texts.
2034
for rev_key in cur_ancestors:
2035
ordered_parents = tuple(self.graph.find_merge_order(rev_key,
2037
parent_map[rev_key] = ordered_parents
2038
if len(next_lcas) == 0:
2040
elif len(next_lcas) == 1:
2041
parent_map[list(next_lcas)[0]] = ()
2043
elif len(next_lcas) > 2:
2044
# More than 2 lca's, fall back to grabbing all nodes between
2045
# this and the unique lca.
2046
trace.mutter('More than 2 LCAs, falling back to all nodes for:'
2048
self.a_key, self.b_key, cur_ancestors)
2049
cur_lcas = next_lcas
2050
while len(cur_lcas) > 1:
2051
cur_lcas = self.graph.find_lca(*cur_lcas)
2052
if len(cur_lcas) == 0:
2053
# No common base to find, use the full ancestry
2056
unique_lca = list(cur_lcas)[0]
2057
if unique_lca == _mod_revision.NULL_REVISION:
2058
# find_lca will return a plain 'NULL_REVISION' rather
2059
# than a key tuple when there is no common ancestor, we
2060
# prefer to just use None, because it doesn't confuse
2061
# _get_interesting_texts()
2063
parent_map.update(self._find_unique_parents(next_lcas,
2066
cur_ancestors = next_lcas
2069
def _find_unique_parents(self, tip_keys, base_key):
2070
"""Find ancestors of tip that aren't ancestors of base.
2072
:param tip_keys: Nodes that are interesting
2073
:param base_key: Cull all ancestors of this node
2074
:return: The parent map for all revisions between tip_keys and
2075
base_key. base_key will be included. References to nodes outside of
2076
the ancestor set will also be removed.
2078
# TODO: this would be simpler if find_unique_ancestors took a list
2079
# instead of a single tip, internally it supports it, but it
2080
# isn't a "backwards compatible" api change.
2081
if base_key is None:
2082
parent_map = dict(self.graph.iter_ancestry(tip_keys))
2083
# We remove NULL_REVISION because it isn't a proper tuple key, and
2084
# thus confuses things like _get_interesting_texts, and our logic
2085
# to add the texts into the memory weave.
2086
if _mod_revision.NULL_REVISION in parent_map:
2087
parent_map.pop(_mod_revision.NULL_REVISION)
2090
for tip in tip_keys:
2092
self.graph.find_unique_ancestors(tip, [base_key]))
2093
parent_map = self.graph.get_parent_map(interesting)
2094
parent_map[base_key] = ()
2095
culled_parent_map, child_map, tails = self._remove_external_references(
2097
# Remove all the tails but base_key
2098
if base_key is not None:
2099
tails.remove(base_key)
2100
self._prune_tails(culled_parent_map, child_map, tails)
2101
# Now remove all the uninteresting 'linear' regions
2102
simple_map = _mod_graph.collapse_linear_regions(culled_parent_map)
2106
def _remove_external_references(parent_map):
2107
"""Remove references that go outside of the parent map.
2109
:param parent_map: Something returned from Graph.get_parent_map(keys)
2110
:return: (filtered_parent_map, child_map, tails)
2111
filtered_parent_map is parent_map without external references
2112
child_map is the {parent_key: [child_keys]} mapping
2113
tails is a list of nodes that do not have any parents in the map
2115
# TODO: The basic effect of this function seems more generic than
2116
# _PlanMerge. But the specific details of building a child_map,
2117
# and computing tails seems very specific to _PlanMerge.
2118
# Still, should this be in Graph land?
2119
filtered_parent_map = {}
2122
for key, parent_keys in parent_map.iteritems():
2123
culled_parent_keys = [p for p in parent_keys if p in parent_map]
2124
if not culled_parent_keys:
2126
for parent_key in culled_parent_keys:
2127
child_map.setdefault(parent_key, []).append(key)
2128
# TODO: Do we want to do this, it adds overhead for every node,
2129
# just to say that the node has no children
2130
child_map.setdefault(key, [])
2131
filtered_parent_map[key] = culled_parent_keys
2132
return filtered_parent_map, child_map, tails
2135
def _prune_tails(parent_map, child_map, tails_to_remove):
2136
"""Remove tails from the parent map.
2138
This will remove the supplied revisions until no more children have 0
2141
:param parent_map: A dict of {child: [parents]}, this dictionary will
2142
be modified in place.
2143
:param tails_to_remove: A list of tips that should be removed,
2144
this list will be consumed
2145
:param child_map: The reverse dict of parent_map ({parent: [children]})
2146
this dict will be modified
2147
:return: None, parent_map will be modified in place.
2149
while tails_to_remove:
2150
next = tails_to_remove.pop()
2151
parent_map.pop(next)
2152
children = child_map.pop(next)
2153
for child in children:
2154
child_parents = parent_map[child]
2155
child_parents.remove(next)
2156
if len(child_parents) == 0:
2157
tails_to_remove.append(child)
2159
def _get_interesting_texts(self, parent_map):
2160
"""Return a dict of texts we are interested in.
2162
Note that the input is in key tuples, but the output is in plain
2165
:param parent_map: The output from _find_recursive_lcas
2166
:return: A dict of {'revision_id':lines} as returned by
2167
_PlanMergeBase.get_lines()
2169
all_revision_keys = set(parent_map)
2170
all_revision_keys.add(self.a_key)
2171
all_revision_keys.add(self.b_key)
2173
# Everything else is in 'keys' but get_lines is in 'revision_ids'
2174
all_texts = self.get_lines([k[-1] for k in all_revision_keys])
2177
def _build_weave(self):
2178
from bzrlib import weave
2179
self._weave = weave.Weave(weave_name='in_memory_weave',
2180
allow_reserved=True)
2181
parent_map = self._find_recursive_lcas()
2183
all_texts = self._get_interesting_texts(parent_map)
2185
# Note: Unfortunately, the order given by topo_sort will effect the
2186
# ordering resolution in the output. Specifically, if you add A then B,
2187
# then in the output text A lines will show up before B lines. And, of
2188
# course, topo_sort doesn't guarantee any real ordering.
2189
# So we use merge_sort, and add a fake node on the tip.
2190
# This ensures that left-hand parents will always be inserted into the
2191
# weave before right-hand parents.
2192
tip_key = self._key_prefix + (_mod_revision.CURRENT_REVISION,)
2193
parent_map[tip_key] = (self.a_key, self.b_key)
2195
for seq_num, key, depth, eom in reversed(tsort.merge_sort(parent_map,
2199
# for key in tsort.topo_sort(parent_map):
2200
parent_keys = parent_map[key]
2201
revision_id = key[-1]
2202
parent_ids = [k[-1] for k in parent_keys]
2203
self._weave.add_lines(revision_id, parent_ids,
2204
all_texts[revision_id])
2206
def plan_merge(self):
2207
"""Generate a 'plan' for merging the two revisions.
2209
This involves comparing their texts and determining the cause of
2210
differences. If text A has a line and text B does not, then either the
2211
line was added to text A, or it was deleted from B. Once the causes
2212
are combined, they are written out in the format described in
2213
VersionedFile.plan_merge
2215
if self._head_key is not None: # There was a single head
2216
if self._head_key == self.a_key:
2219
if self._head_key != self.b_key:
2220
raise AssertionError('There was an invalid head: %s != %s'
2221
% (self.b_key, self._head_key))
2223
head_rev = self._head_key[-1]
2224
lines = self.get_lines([head_rev])[head_rev]
2225
return ((plan, line) for line in lines)
2226
return self._weave.plan_merge(self.a_rev, self.b_rev)
1374
def __init__(self, a_rev, b_rev, vf):
1375
_PlanMergeBase.__init__(self, a_rev, b_rev, vf)
1376
a_ancestry = set(vf.get_ancestry(a_rev, topo_sorted=False))
1377
b_ancestry = set(vf.get_ancestry(b_rev, topo_sorted=False))
1378
self.uncommon = a_ancestry.symmetric_difference(b_ancestry)
1380
def _determine_status(self, revision_id, unique_line_numbers):
1381
"""Determines the status unique lines versus all lcas.
1383
Basically, determines why the line is unique to this revision.
1385
A line may be determined new or killed, but not both.
1387
:param revision_id: The id of the revision in which the lines are
1389
:param unique_line_numbers: The line numbers of unique lines.
1390
:return a tuple of (new_this, killed_other):
1392
new = self._find_new(revision_id)
1393
killed = set(unique_line_numbers).difference(new)
1396
def _find_new(self, version_id):
1397
"""Determine which lines are new in the ancestry of this version.
1399
If a lines is present in this version, and not present in any
1400
common ancestor, it is considered new.
1402
if version_id not in self.uncommon:
1404
parents = self.vf.get_parent_map([version_id])[version_id]
1405
if len(parents) == 0:
1406
return set(range(len(self.vf.get_lines(version_id))))
1408
for parent in parents:
1409
blocks = self._get_matching_blocks(version_id, parent)
1410
result, unused = self._unique_lines(blocks)
1411
parent_new = self._find_new(parent)
1412
for i, j, n in blocks:
1413
for ii, jj in [(i+r, j+r) for r in range(n)]:
1414
if jj in parent_new:
1419
new.intersection_update(result)
2229
1423
class _PlanLCAMerge(_PlanMergeBase):
added
removed
bzrlib/merge.py
