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 ConfigurableFileMerger(AbstractPerFileMerger):
97
"""Merge individual files when configured via a .conf file.
99
This is a base class for concrete custom file merging logic. Concrete
100
classes should implement ``merge_text``.
102
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
104
:ivar affected_files: The configured file paths to merge.
106
:cvar name_prefix: The prefix to use when looking up configuration
107
details. <name_prefix>_merge_files describes the files targeted by the
110
:cvar default_files: The default file paths to merge when no configuration
117
def __init__(self, merger):
118
super(ConfigurableFileMerger, self).__init__(merger)
119
self.affected_files = None
120
self.default_files = self.__class__.default_files or []
121
self.name_prefix = self.__class__.name_prefix
122
if self.name_prefix is None:
123
raise ValueError("name_prefix must be set.")
125
def filename_matches_config(self, params):
126
"""Check whether the file should call the merge hook.
128
<name_prefix>_merge_files configuration variable is a list of files
129
that should use the hook.
131
affected_files = self.affected_files
132
if affected_files is None:
133
config = self.merger.this_tree.branch.get_config()
134
# Until bzr provides a better policy for caching the config, we
135
# just add the part we're interested in to the params to avoid
136
# reading the config files repeatedly (bazaar.conf, location.conf,
138
config_key = self.name_prefix + '_merge_files'
139
affected_files = config.get_user_option_as_list(config_key)
140
if affected_files is None:
141
# If nothing was specified in the config, use the default.
142
affected_files = self.default_files
143
self.affected_files = affected_files
145
filename = self.merger.this_tree.id2path(params.file_id)
146
if filename in affected_files:
150
def merge_contents(self, params):
151
"""Merge the contents of a single file."""
152
# First, check whether this custom merge logic should be used. We
153
# expect most files should not be merged by this handler.
155
# OTHER is a straight winner, rely on default merge.
156
params.winner == 'other' or
157
# THIS and OTHER aren't both files.
158
not params.is_file_merge() or
159
# The filename isn't listed in the 'NAME_merge_files' config
161
not self.filename_matches_config(params)):
162
return 'not_applicable', None
163
return self.merge_text(params)
165
def merge_text(self, params):
166
"""Merge the byte contents of a single file.
168
This is called after checking that the merge should be performed in
169
merge_contents, and it should behave as per
170
``bzrlib.merge.AbstractPerFileMerger.merge_contents``.
172
raise NotImplementedError(self.merge_text)
175
class MergeHookParams(object):
176
"""Object holding parameters passed to merge_file_content hooks.
178
There are some fields hooks can access:
180
:ivar file_id: the file ID of the file being merged
181
:ivar trans_id: the transform ID for the merge of this file
182
:ivar this_kind: kind of file_id in 'this' tree
183
:ivar other_kind: kind of file_id in 'other' tree
184
:ivar winner: one of 'this', 'other', 'conflict'
187
def __init__(self, merger, file_id, trans_id, this_kind, other_kind,
189
self._merger = merger
190
self.file_id = file_id
191
self.trans_id = trans_id
192
self.this_kind = this_kind
193
self.other_kind = other_kind
196
def is_file_merge(self):
197
"""True if this_kind and other_kind are both 'file'."""
198
return self.this_kind == 'file' and self.other_kind == 'file'
200
@decorators.cachedproperty
201
def base_lines(self):
202
"""The lines of the 'base' version of the file."""
203
return self._merger.get_lines(self._merger.base_tree, self.file_id)
205
@decorators.cachedproperty
206
def this_lines(self):
207
"""The lines of the 'this' version of the file."""
208
return self._merger.get_lines(self._merger.this_tree, self.file_id)
210
@decorators.cachedproperty
211
def other_lines(self):
212
"""The lines of the 'other' version of the file."""
213
return self._merger.get_lines(self._merger.other_tree, self.file_id)
62
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
63
interesting_ids=interesting_ids, this_tree=from_tree)
216
66
class Merger(object):
220
67
def __init__(self, this_branch, other_tree=None, base_tree=None,
221
this_tree=None, pb=None, change_reporter=None,
68
this_tree=None, pb=DummyProgress(), change_reporter=None,
222
69
recurse='down', revision_graph=None):
223
70
object.__init__(self)
71
assert this_tree is not None, "this_tree is required"
224
72
self.this_branch = this_branch
225
73
self.this_basis = _mod_revision.ensure_null(
226
74
this_branch.last_revision())
321
150
base_revision_id, other_revision_id, verified =\
322
151
mergeable.get_merge_request(tree.branch.repository)
323
152
revision_graph = tree.branch.repository.get_graph()
324
if base_revision_id is not None:
325
if (base_revision_id != _mod_revision.NULL_REVISION and
326
revision_graph.is_ancestor(
327
base_revision_id, tree.branch.last_revision())):
328
base_revision_id = None
330
trace.warning('Performing cherrypick')
153
if (base_revision_id != _mod_revision.NULL_REVISION and
154
revision_graph.is_ancestor(
155
base_revision_id, tree.branch.last_revision())):
156
base_revision_id = None
158
warning('Performing cherrypick')
331
159
merger = klass.from_revision_ids(pb, tree, other_revision_id,
332
160
base_revision_id, revision_graph=
334
162
return merger, verified
337
def from_revision_ids(pb, tree, other, base=None, other_branch=None,
338
base_branch=None, revision_graph=None,
165
def from_revision_ids(pb, this, other, base=None, other_branch=None,
166
base_branch=None, revision_graph=None):
340
167
"""Return a Merger for revision-ids.
342
:param pb: A progress indicator
343
169
:param tree: The tree to merge changes into
344
170
:param other: The revision-id to use as OTHER
345
171
:param base: The revision-id to use as BASE. If not specified, will
346
172
be auto-selected.
347
173
:param other_branch: A branch containing the other revision-id. If
348
not supplied, tree.branch is used.
174
not supplied, this.branch is used.
349
175
:param base_branch: A branch containing the base revision-id. If
350
not supplied, other_branch or tree.branch will be used.
351
:param revision_graph: If you have a revision_graph precomputed, pass
352
it in, otherwise it will be created for you.
353
:param tree_branch: The branch associated with tree. If not supplied,
354
tree.branch will be used.
176
not supplied, other_branch or this.branch will be used.
177
:param pb: A progress indicator
356
if tree_branch is None:
357
tree_branch = tree.branch
358
merger = Merger(tree_branch, this_tree=tree, pb=pb,
179
merger = Merger(this.branch, this_tree=this, pb=pb,
359
180
revision_graph=revision_graph)
360
181
if other_branch is None:
361
other_branch = tree.branch
182
other_branch = this.branch
362
183
merger.set_other_revision(other, other_branch)
364
185
merger.find_base()
404
223
if self.other_rev_id is None:
405
224
other_basis_tree = self.revision_tree(self.other_basis)
406
if other_basis_tree.has_changes(self.other_tree):
407
raise errors.WorkingTreeNotRevision(self.this_tree)
225
changes = other_basis_tree.changes_from(self.other_tree)
226
if changes.has_changed():
227
raise WorkingTreeNotRevision(self.this_tree)
408
228
other_rev_id = self.other_basis
409
229
self.other_tree = other_basis_tree
411
@deprecated_method(deprecated_in((2, 1, 0)))
412
231
def file_revisions(self, file_id):
413
232
self.ensure_revision_trees()
414
233
def get_id(tree, file_id):
415
234
revision_id = tree.inventory[file_id].revision
235
assert revision_id is not None
416
236
return revision_id
417
237
if self.this_rev_id is None:
418
238
if self.this_basis_tree.get_file_sha1(file_id) != \
419
239
self.this_tree.get_file_sha1(file_id):
420
raise errors.WorkingTreeNotRevision(self.this_tree)
240
raise WorkingTreeNotRevision(self.this_tree)
422
242
trees = (self.this_basis_tree, self.other_tree)
423
243
return [get_id(tree, file_id) for tree in trees]
425
@deprecated_method(deprecated_in((2, 1, 0)))
426
245
def check_basis(self, check_clean, require_commits=True):
427
246
if self.this_basis is None and require_commits is True:
428
raise errors.BzrCommandError(
429
"This branch has no commits."
430
" (perhaps you would prefer 'bzr pull')")
247
raise BzrCommandError("This branch has no commits."
248
" (perhaps you would prefer 'bzr pull')")
432
250
self.compare_basis()
433
251
if self.this_basis != self.this_rev_id:
434
252
raise errors.UncommittedChanges(self.this_tree)
436
@deprecated_method(deprecated_in((2, 1, 0)))
437
254
def compare_basis(self):
439
256
basis_tree = self.revision_tree(self.this_tree.last_revision())
440
except errors.NoSuchRevision:
257
except errors.RevisionNotPresent:
441
258
basis_tree = self.this_tree.basis_tree()
442
if not self.this_tree.has_changes(basis_tree):
259
changes = self.this_tree.changes_from(basis_tree)
260
if not changes.has_changed():
443
261
self.this_rev_id = self.this_basis
445
263
def set_interesting_files(self, file_list):
446
264
self.interesting_files = file_list
448
266
def set_pending(self):
449
if (not self.base_is_ancestor or not self.base_is_other_ancestor
450
or self.other_rev_id is None):
267
if not self.base_is_ancestor or not self.base_is_other_ancestor or self.other_rev_id is None:
452
269
self._add_parent()
454
271
def _add_parent(self):
455
272
new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
456
273
new_parent_trees = []
457
operation = OperationWithCleanups(self.this_tree.set_parent_trees)
458
274
for revision_id in new_parents:
460
276
tree = self.revision_tree(revision_id)
461
except errors.NoSuchRevision:
277
except errors.RevisionNotPresent:
465
operation.add_cleanup(tree.unlock)
466
281
new_parent_trees.append((revision_id, tree))
467
operation.run_simple(new_parent_trees, allow_leftmost_as_ghost=True)
283
self.this_tree.set_parent_trees(new_parent_trees,
284
allow_leftmost_as_ghost=True)
286
for _revision_id, tree in new_parent_trees:
469
290
def set_other(self, other_revision, possible_transports=None):
470
291
"""Set the revision and tree to merge from.
521
342
target.fetch(source, revision_id)
523
344
def find_base(self):
524
revisions = [_mod_revision.ensure_null(self.this_basis),
525
_mod_revision.ensure_null(self.other_basis)]
526
if _mod_revision.NULL_REVISION in revisions:
527
self.base_rev_id = _mod_revision.NULL_REVISION
528
self.base_tree = self.revision_tree(self.base_rev_id)
529
self._is_criss_cross = False
345
revisions = [ensure_null(self.this_basis),
346
ensure_null(self.other_basis)]
347
if NULL_REVISION in revisions:
348
self.base_rev_id = NULL_REVISION
531
lcas = self.revision_graph.find_lca(revisions[0], revisions[1])
532
self._is_criss_cross = False
534
self.base_rev_id = _mod_revision.NULL_REVISION
536
self.base_rev_id = list(lcas)[0]
537
else: # len(lcas) > 1
539
# find_unique_lca can only handle 2 nodes, so we have to
540
# start back at the beginning. It is a shame to traverse
541
# the graph again, but better than re-implementing
543
self.base_rev_id = self.revision_graph.find_unique_lca(
544
revisions[0], revisions[1])
546
self.base_rev_id = self.revision_graph.find_unique_lca(
548
self._is_criss_cross = True
549
if self.base_rev_id == _mod_revision.NULL_REVISION:
550
raise errors.UnrelatedBranches()
551
if self._is_criss_cross:
552
trace.warning('Warning: criss-cross merge encountered. See bzr'
553
' help criss-cross.')
554
trace.mutter('Criss-cross lcas: %r' % lcas)
555
interesting_revision_ids = [self.base_rev_id]
556
interesting_revision_ids.extend(lcas)
557
interesting_trees = dict((t.get_revision_id(), t)
558
for t in self.this_branch.repository.revision_trees(
559
interesting_revision_ids))
560
self._cached_trees.update(interesting_trees)
561
self.base_tree = interesting_trees.pop(self.base_rev_id)
562
sorted_lca_keys = self.revision_graph.find_merge_order(
564
self._lca_trees = [interesting_trees[key]
565
for key in sorted_lca_keys]
567
self.base_tree = self.revision_tree(self.base_rev_id)
350
self.base_rev_id, steps = self.revision_graph.find_unique_lca(
351
revisions[0], revisions[1], count_steps=True)
352
if self.base_rev_id == NULL_REVISION:
353
raise UnrelatedBranches()
355
warning('Warning: criss-cross merge encountered. See bzr'
356
' help criss-cross.')
357
self.base_tree = self.revision_tree(self.base_rev_id)
568
358
self.base_is_ancestor = True
569
359
self.base_is_other_ancestor = True
570
trace.mutter('Base revid: %r' % self.base_rev_id)
572
361
def set_base(self, base_revision):
573
362
"""Set the base revision to use for the merge.
575
364
:param base_revision: A 2-list containing a path and revision number.
577
trace.mutter("doing merge() with no base_revision specified")
366
mutter("doing merge() with no base_revision specified")
578
367
if base_revision == [None, None]:
593
382
'other_tree': self.other_tree,
594
383
'interesting_ids': self.interesting_ids,
595
384
'interesting_files': self.interesting_files,
596
'this_branch': self.this_branch,
597
386
'do_merge': False}
598
387
if self.merge_type.requires_base:
599
388
kwargs['base_tree'] = self.base_tree
600
389
if self.merge_type.supports_reprocess:
601
390
kwargs['reprocess'] = self.reprocess
602
391
elif self.reprocess:
603
raise errors.BzrError(
604
"Conflict reduction is not supported for merge"
605
" type %s." % self.merge_type)
392
raise BzrError("Conflict reduction is not supported for merge"
393
" type %s." % self.merge_type)
606
394
if self.merge_type.supports_show_base:
607
395
kwargs['show_base'] = self.show_base
608
396
elif self.show_base:
609
raise errors.BzrError("Showing base is not supported for this"
610
" merge type. %s" % self.merge_type)
397
raise BzrError("Showing base is not supported for this"
398
" merge type. %s" % self.merge_type)
611
399
if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
612
400
and not self.base_is_other_ancestor):
613
401
raise errors.CannotReverseCherrypick()
614
if self.merge_type.supports_cherrypick:
402
if self.merge_type.history_based:
615
403
kwargs['cherrypick'] = (not self.base_is_ancestor or
616
404
not self.base_is_other_ancestor)
617
if self._is_criss_cross and getattr(self.merge_type,
618
'supports_lca_trees', False):
619
kwargs['lca_trees'] = self._lca_trees
620
return self.merge_type(pb=None,
405
return self.merge_type(pb=self._pb,
621
406
change_reporter=self.change_reporter,
624
def _do_merge_to(self):
625
410
merge = self.make_merger()
626
if self.other_branch is not None:
627
self.other_branch.update_references(self.this_branch)
629
if self.recurse == 'down':
630
for relpath, file_id in self.this_tree.iter_references():
631
sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
632
other_revision = self.other_tree.get_reference_revision(
634
if other_revision == sub_tree.last_revision():
636
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
637
sub_merge.merge_type = self.merge_type
638
other_branch = self.other_branch.reference_parent(file_id, relpath)
639
sub_merge.set_other_revision(other_revision, other_branch)
640
base_revision = self.base_tree.get_reference_revision(file_id)
641
sub_merge.base_tree = \
642
sub_tree.branch.repository.revision_tree(base_revision)
643
sub_merge.base_rev_id = base_revision
648
operation = OperationWithCleanups(self._do_merge_to)
649
411
self.this_tree.lock_tree_write()
650
operation.add_cleanup(self.this_tree.unlock)
651
412
if self.base_tree is not None:
652
413
self.base_tree.lock_read()
653
operation.add_cleanup(self.base_tree.unlock)
654
414
if self.other_tree is not None:
655
415
self.other_tree.lock_read()
656
operation.add_cleanup(self.other_tree.unlock)
657
merge = operation.run_simple()
418
if self.recurse == 'down':
419
for path, file_id in self.this_tree.iter_references():
420
sub_tree = self.this_tree.get_nested_tree(file_id, path)
421
other_revision = self.other_tree.get_reference_revision(
423
if other_revision == sub_tree.last_revision():
425
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
426
sub_merge.merge_type = self.merge_type
427
relpath = self.this_tree.relpath(path)
428
other_branch = self.other_branch.reference_parent(file_id, relpath)
429
sub_merge.set_other_revision(other_revision, other_branch)
430
base_revision = self.base_tree.get_reference_revision(file_id)
431
sub_merge.base_tree = \
432
sub_tree.branch.repository.revision_tree(base_revision)
436
if self.other_tree is not None:
437
self.other_tree.unlock()
438
if self.base_tree is not None:
439
self.base_tree.unlock()
440
self.this_tree.unlock()
658
441
if len(merge.cooked_conflicts) == 0:
659
if not self.ignore_zero and not trace.is_quiet():
660
trace.note("All changes applied successfully.")
442
if not self.ignore_zero and not is_quiet():
443
note("All changes applied successfully.")
662
trace.note("%d conflicts encountered."
663
% len(merge.cooked_conflicts))
445
note("%d conflicts encountered." % len(merge.cooked_conflicts))
665
447
return len(merge.cooked_conflicts)
668
class _InventoryNoneEntry(object):
669
"""This represents an inventory entry which *isn't there*.
671
It simplifies the merging logic if we always have an InventoryEntry, even
672
if it isn't actually present
679
symlink_target = None
682
_none_entry = _InventoryNoneEntry()
685
450
class Merge3Merger(object):
686
451
"""Three-way merger that uses the merge3 text merger"""
687
452
requires_base = True
688
453
supports_reprocess = True
689
454
supports_show_base = True
690
455
history_based = False
691
supports_cherrypick = True
692
456
supports_reverse_cherrypick = True
693
457
winner_idx = {"this": 2, "other": 1, "conflict": 1}
694
supports_lca_trees = True
696
def __init__(self, working_tree, this_tree, base_tree, other_tree,
459
def __init__(self, working_tree, this_tree, base_tree, other_tree,
697
460
interesting_ids=None, reprocess=False, show_base=False,
698
pb=None, pp=None, change_reporter=None,
699
interesting_files=None, do_merge=True,
700
cherrypick=False, lca_trees=None, this_branch=None):
461
pb=DummyProgress(), pp=None, change_reporter=None,
462
interesting_files=None, do_merge=True):
701
463
"""Initialize the merger object and perform the merge.
703
465
:param working_tree: The working tree to apply the merge to
704
466
:param this_tree: The local tree in the merge operation
705
467
:param base_tree: The common tree in the merge operation
706
:param other_tree: The other tree to merge changes from
707
:param this_branch: The branch associated with this_tree
468
:param other_tree: The other other tree to merge changes from
708
469
:param interesting_ids: The file_ids of files that should be
709
470
participate in the merge. May not be combined with
710
471
interesting_files.
711
472
:param: reprocess If True, perform conflict-reduction processing.
712
473
:param show_base: If True, show the base revision in text conflicts.
713
474
(incompatible with reprocess)
475
:param pb: A Progress bar
715
476
:param pp: A ProgressPhase object
716
477
:param change_reporter: An object that should report changes made
717
478
:param interesting_files: The tree-relative paths of files that should
720
481
be combined with interesting_ids. If neither interesting_files nor
721
482
interesting_ids is specified, all files may participate in the
723
:param lca_trees: Can be set to a dictionary of {revision_id:rev_tree}
724
if the ancestry was found to include a criss-cross merge.
725
Otherwise should be None.
727
485
object.__init__(self)
728
if interesting_files is not None and interesting_ids is not None:
730
'specify either interesting_ids or interesting_files')
486
if interesting_files is not None:
487
assert interesting_ids is None
731
488
self.interesting_ids = interesting_ids
732
489
self.interesting_files = interesting_files
733
490
self.this_tree = working_tree
734
491
self.base_tree = base_tree
735
492
self.other_tree = other_tree
736
self.this_branch = this_branch
737
493
self._raw_conflicts = []
738
494
self.cooked_conflicts = []
739
495
self.reprocess = reprocess
740
496
self.show_base = show_base
741
self._lca_trees = lca_trees
742
# Uncommenting this will change the default algorithm to always use
743
# _entries_lca. This can be useful for running the test suite and
744
# making sure we haven't missed any corner cases.
745
# if lca_trees is None:
746
# self._lca_trees = [self.base_tree]
747
499
self.change_reporter = change_reporter
748
self.cherrypick = cherrypick
501
self.pp = ProgressPhase("Merge phase", 3, self.pb)
752
warnings.warn("pp argument to Merge3Merger is deprecated")
754
warnings.warn("pb argument to Merge3Merger is deprecated")
756
505
def do_merge(self):
757
operation = OperationWithCleanups(self._do_merge)
758
506
self.this_tree.lock_tree_write()
759
operation.add_cleanup(self.this_tree.unlock)
760
507
self.base_tree.lock_read()
761
operation.add_cleanup(self.base_tree.unlock)
762
508
self.other_tree.lock_read()
763
operation.add_cleanup(self.other_tree.unlock)
766
def _do_merge(self, operation):
767
self.tt = transform.TreeTransform(self.this_tree, None)
768
operation.add_cleanup(self.tt.finalize)
769
self._compute_transform()
770
results = self.tt.apply(no_conflicts=True)
771
self.write_modified(results)
509
self.tt = TreeTransform(self.this_tree, self.pb)
773
self.this_tree.add_conflicts(self.cooked_conflicts)
774
except errors.UnsupportedOperation:
512
self._compute_transform()
514
results = self.tt.apply(no_conflicts=True)
515
self.write_modified(results)
517
self.this_tree.add_conflicts(self.cooked_conflicts)
518
except UnsupportedOperation:
522
self.other_tree.unlock()
523
self.base_tree.unlock()
524
self.this_tree.unlock()
777
527
def make_preview_transform(self):
778
operation = OperationWithCleanups(self._make_preview_transform)
779
528
self.base_tree.lock_read()
780
operation.add_cleanup(self.base_tree.unlock)
781
529
self.other_tree.lock_read()
782
operation.add_cleanup(self.other_tree.unlock)
783
return operation.run_simple()
785
def _make_preview_transform(self):
786
self.tt = transform.TransformPreview(self.this_tree)
787
self._compute_transform()
530
self.tt = TransformPreview(self.this_tree)
533
self._compute_transform()
536
self.other_tree.unlock()
537
self.base_tree.unlock()
790
541
def _compute_transform(self):
791
if self._lca_trees is None:
792
entries = self._entries3()
793
resolver = self._three_way
795
entries = self._entries_lca()
796
resolver = self._lca_multi_way
542
entries = self._entries3()
797
543
child_pb = ui.ui_factory.nested_progress_bar()
799
factories = Merger.hooks['merge_file_content']
800
hooks = [factory(self) for factory in factories] + [self]
801
self.active_hooks = [hook for hook in hooks if hook is not None]
802
545
for num, (file_id, changed, parents3, names3,
803
546
executable3) in enumerate(entries):
804
547
child_pb.update('Preparing file merge', num, len(entries))
805
self._merge_names(file_id, parents3, names3, resolver=resolver)
548
self._merge_names(file_id, parents3, names3)
807
file_status = self._do_merge_contents(file_id)
550
file_status = self.merge_contents(file_id)
809
552
file_status = 'unmodified'
810
553
self._merge_executable(file_id,
811
executable3, file_status, resolver=resolver)
554
executable3, file_status)
813
556
child_pb.finished()
815
559
child_pb = ui.ui_factory.nested_progress_bar()
817
fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
818
lambda t, c: transform.conflict_pass(t, c, self.other_tree))
561
fs_conflicts = resolve_conflicts(self.tt, child_pb,
562
lambda t, c: conflict_pass(t, c, self.other_tree))
820
564
child_pb.finished()
821
565
if self.change_reporter is not None:
822
566
from bzrlib import delta
823
567
delta.report_changes(
824
self.tt.iter_changes(), self.change_reporter)
568
self.tt._iter_changes(), self.change_reporter)
825
569
self.cook_conflicts(fs_conflicts)
826
570
for conflict in self.cooked_conflicts:
827
trace.warning(conflict)
829
573
def _entries3(self):
830
574
"""Gather data about files modified between three trees.
862
603
result.append((file_id, changed, parents3, names3, executable3))
865
def _entries_lca(self):
866
"""Gather data about files modified between multiple trees.
868
This compares OTHER versus all LCA trees, and for interesting entries,
869
it then compares with THIS and BASE.
871
For the multi-valued entries, the format will be (BASE, [lca1, lca2])
872
:return: [(file_id, changed, parents, names, executable)]
873
file_id Simple file_id of the entry
874
changed Boolean, True if the kind or contents changed
876
parents ((base, [parent_id, in, lcas]), parent_id_other,
878
names ((base, [name, in, lcas]), name_in_other, name_in_this)
879
executable ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
881
if self.interesting_files is not None:
882
lookup_trees = [self.this_tree, self.base_tree]
883
lookup_trees.extend(self._lca_trees)
884
# I think we should include the lca trees as well
885
interesting_ids = self.other_tree.paths2ids(self.interesting_files,
888
interesting_ids = self.interesting_ids
890
walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
892
base_inventory = self.base_tree.inventory
893
this_inventory = self.this_tree.inventory
894
for path, file_id, other_ie, lca_values in walker.iter_all():
895
# Is this modified at all from any of the other trees?
897
other_ie = _none_entry
898
if interesting_ids is not None and file_id not in interesting_ids:
901
# If other_revision is found in any of the lcas, that means this
902
# node is uninteresting. This is because when merging, if there are
903
# multiple heads(), we have to create a new node. So if we didn't,
904
# we know that the ancestry is linear, and that OTHER did not
906
# See doc/developers/lca_merge_resolution.txt for details
907
other_revision = other_ie.revision
908
if other_revision is not None:
909
# We can't use this shortcut when other_revision is None,
910
# because it may be None because things are WorkingTrees, and
911
# not because it is *actually* None.
912
is_unmodified = False
913
for lca_path, ie in lca_values:
914
if ie is not None and ie.revision == other_revision:
921
for lca_path, lca_ie in lca_values:
923
lca_entries.append(_none_entry)
925
lca_entries.append(lca_ie)
927
if file_id in base_inventory:
928
base_ie = base_inventory[file_id]
930
base_ie = _none_entry
932
if file_id in this_inventory:
933
this_ie = this_inventory[file_id]
935
this_ie = _none_entry
941
for lca_ie in lca_entries:
942
lca_kinds.append(lca_ie.kind)
943
lca_parent_ids.append(lca_ie.parent_id)
944
lca_names.append(lca_ie.name)
945
lca_executable.append(lca_ie.executable)
947
kind_winner = self._lca_multi_way(
948
(base_ie.kind, lca_kinds),
949
other_ie.kind, this_ie.kind)
950
parent_id_winner = self._lca_multi_way(
951
(base_ie.parent_id, lca_parent_ids),
952
other_ie.parent_id, this_ie.parent_id)
953
name_winner = self._lca_multi_way(
954
(base_ie.name, lca_names),
955
other_ie.name, this_ie.name)
957
content_changed = True
958
if kind_winner == 'this':
959
# No kind change in OTHER, see if there are *any* changes
960
if other_ie.kind == 'directory':
961
if parent_id_winner == 'this' and name_winner == 'this':
962
# No change for this directory in OTHER, skip
964
content_changed = False
965
elif other_ie.kind is None or other_ie.kind == 'file':
966
def get_sha1(ie, tree):
967
if ie.kind != 'file':
969
return tree.get_file_sha1(file_id)
970
base_sha1 = get_sha1(base_ie, self.base_tree)
971
lca_sha1s = [get_sha1(ie, tree) for ie, tree
972
in zip(lca_entries, self._lca_trees)]
973
this_sha1 = get_sha1(this_ie, self.this_tree)
974
other_sha1 = get_sha1(other_ie, self.other_tree)
975
sha1_winner = self._lca_multi_way(
976
(base_sha1, lca_sha1s), other_sha1, this_sha1,
977
allow_overriding_lca=False)
978
exec_winner = self._lca_multi_way(
979
(base_ie.executable, lca_executable),
980
other_ie.executable, this_ie.executable)
981
if (parent_id_winner == 'this' and name_winner == 'this'
982
and sha1_winner == 'this' and exec_winner == 'this'):
983
# No kind, parent, name, exec, or content change for
984
# OTHER, so this node is not considered interesting
986
if sha1_winner == 'this':
987
content_changed = False
988
elif other_ie.kind == 'symlink':
989
def get_target(ie, tree):
990
if ie.kind != 'symlink':
992
return tree.get_symlink_target(file_id)
993
base_target = get_target(base_ie, self.base_tree)
994
lca_targets = [get_target(ie, tree) for ie, tree
995
in zip(lca_entries, self._lca_trees)]
996
this_target = get_target(this_ie, self.this_tree)
997
other_target = get_target(other_ie, self.other_tree)
998
target_winner = self._lca_multi_way(
999
(base_target, lca_targets),
1000
other_target, this_target)
1001
if (parent_id_winner == 'this' and name_winner == 'this'
1002
and target_winner == 'this'):
1003
# No kind, parent, name, or symlink target change
1006
if target_winner == 'this':
1007
content_changed = False
1008
elif other_ie.kind == 'tree-reference':
1009
# The 'changed' information seems to be handled at a higher
1010
# level. At least, _entries3 returns False for content
1011
# changed, even when at a new revision_id.
1012
content_changed = False
1013
if (parent_id_winner == 'this' and name_winner == 'this'):
1014
# Nothing interesting
1017
raise AssertionError('unhandled kind: %s' % other_ie.kind)
1018
# XXX: We need to handle kind == 'symlink'
1020
# If we have gotten this far, that means something has changed
1021
result.append((file_id, content_changed,
1022
((base_ie.parent_id, lca_parent_ids),
1023
other_ie.parent_id, this_ie.parent_id),
1024
((base_ie.name, lca_names),
1025
other_ie.name, this_ie.name),
1026
((base_ie.executable, lca_executable),
1027
other_ie.executable, this_ie.executable)
1032
606
def fix_root(self):
1034
608
self.tt.final_kind(self.tt.root)
1035
except errors.NoSuchFile:
1036
610
self.tt.cancel_deletion(self.tt.root)
1037
611
if self.tt.final_file_id(self.tt.root) is None:
1038
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
612
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
614
if self.other_tree.inventory.root is None:
1040
616
other_root_file_id = self.other_tree.get_root_id()
1041
if other_root_file_id is None:
1043
617
other_root = self.tt.trans_id_file_id(other_root_file_id)
1044
618
if other_root == self.tt.root:
1047
621
self.tt.final_kind(other_root)
1048
except errors.NoSuchFile:
1050
if self.this_tree.has_id(self.other_tree.inventory.root.file_id):
1051
# the other tree's root is a non-root in the current tree
1053
624
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
1054
625
self.tt.cancel_creation(other_root)
1126
def _lca_multi_way(bases, other, this, allow_overriding_lca=True):
1127
"""Consider LCAs when determining whether a change has occurred.
1129
If LCAS are all identical, this is the same as a _three_way comparison.
1131
:param bases: value in (BASE, [LCAS])
1132
:param other: value in OTHER
1133
:param this: value in THIS
1134
:param allow_overriding_lca: If there is more than one unique lca
1135
value, allow OTHER to override THIS if it has a new value, and
1136
THIS only has an lca value, or vice versa. This is appropriate for
1137
truly scalar values, not as much for non-scalars.
1138
:return: 'this', 'other', or 'conflict' depending on whether an entry
1141
# See doc/developers/lca_tree_merging.txt for details about this
1144
# Either Ambiguously clean, or nothing was actually changed. We
1147
base_val, lca_vals = bases
1148
# Remove 'base_val' from the lca_vals, because it is not interesting
1149
filtered_lca_vals = [lca_val for lca_val in lca_vals
1150
if lca_val != base_val]
1151
if len(filtered_lca_vals) == 0:
1152
return Merge3Merger._three_way(base_val, other, this)
1154
unique_lca_vals = set(filtered_lca_vals)
1155
if len(unique_lca_vals) == 1:
1156
return Merge3Merger._three_way(unique_lca_vals.pop(), other, this)
1158
if allow_overriding_lca:
1159
if other in unique_lca_vals:
1160
if this in unique_lca_vals:
1161
# Each side picked a different lca, conflict
1164
# This has a value which supersedes both lca values, and
1165
# other only has an lca value
1167
elif this in unique_lca_vals:
1168
# OTHER has a value which supersedes both lca values, and this
1169
# only has an lca value
1172
# At this point, the lcas disagree, and the tips disagree
1176
697
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
1177
698
"""Do a three-way test on a scalar.
1178
699
Return "this", "other" or "conflict", depending whether a value wins.
1263
784
return kind, contents
786
def contents_conflict():
787
trans_id = self.tt.trans_id_file_id(file_id)
788
name = self.tt.final_name(trans_id)
789
parent_id = self.tt.final_parent(trans_id)
790
if file_id in self.this_tree.inventory:
791
self.tt.unversion_file(trans_id)
792
if file_id in self.this_tree:
793
self.tt.delete_contents(trans_id)
794
file_group = self._dump_conflicts(name, parent_id, file_id,
796
self._raw_conflicts.append(('contents conflict', file_group))
1265
798
# See SPOT run. run, SPOT, run.
1266
799
# So we're not QUITE repeating ourselves; we do tricky things with
1268
801
base_pair = contents_pair(self.base_tree)
1269
802
other_pair = contents_pair(self.other_tree)
1271
this_pair = contents_pair(self.this_tree)
1272
lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1273
winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1274
this_pair, allow_overriding_lca=False)
1276
if base_pair == other_pair:
1279
# We delayed evaluating this_pair as long as we can to avoid
1280
# unnecessary sha1 calculation
1281
this_pair = contents_pair(self.this_tree)
1282
winner = self._three_way(base_pair, other_pair, this_pair)
1283
if winner == 'this':
1284
# No interesting changes introduced by OTHER
1286
# We have a hypothetical conflict, but if we have files, then we
1287
# can try to merge the content
1288
trans_id = self.tt.trans_id_file_id(file_id)
1289
params = MergeHookParams(self, file_id, trans_id, this_pair[0],
1290
other_pair[0], winner)
1291
hooks = self.active_hooks
1292
hook_status = 'not_applicable'
1294
hook_status, lines = hook.merge_contents(params)
1295
if hook_status != 'not_applicable':
1296
# Don't try any more hooks, this one applies.
1299
if hook_status == 'not_applicable':
1300
# This is a contents conflict, because none of the available
1301
# functions could merge it.
1303
name = self.tt.final_name(trans_id)
1304
parent_id = self.tt.final_parent(trans_id)
1305
if self.this_tree.has_id(file_id):
1306
self.tt.unversion_file(trans_id)
1307
file_group = self._dump_conflicts(name, parent_id, file_id,
1309
self._raw_conflicts.append(('contents conflict', file_group))
1310
elif hook_status == 'success':
1311
self.tt.create_file(lines, trans_id)
1312
elif hook_status == 'conflicted':
1313
# XXX: perhaps the hook should be able to provide
1314
# the BASE/THIS/OTHER files?
1315
self.tt.create_file(lines, trans_id)
1316
self._raw_conflicts.append(('text conflict', trans_id))
1317
name = self.tt.final_name(trans_id)
1318
parent_id = self.tt.final_parent(trans_id)
1319
self._dump_conflicts(name, parent_id, file_id)
1320
elif hook_status == 'delete':
1321
self.tt.unversion_file(trans_id)
1323
elif hook_status == 'done':
1324
# The hook function did whatever it needs to do directly, no
1325
# further action needed here.
1328
raise AssertionError('unknown hook_status: %r' % (hook_status,))
1329
if not self.this_tree.has_id(file_id) and result == "modified":
1330
self.tt.version_file(file_id, trans_id)
1331
# The merge has been performed, so the old contents should not be
1334
self.tt.delete_contents(trans_id)
1335
except errors.NoSuchFile:
1339
def _default_other_winner_merge(self, merge_hook_params):
1340
"""Replace this contents with other."""
1341
file_id = merge_hook_params.file_id
1342
trans_id = merge_hook_params.trans_id
1343
file_in_this = self.this_tree.has_id(file_id)
1344
if self.other_tree.has_id(file_id):
1345
# OTHER changed the file
1347
if wt.supports_content_filtering():
1348
# We get the path from the working tree if it exists.
1349
# That fails though when OTHER is adding a file, so
1350
# we fall back to the other tree to find the path if
1351
# it doesn't exist locally.
1353
filter_tree_path = wt.id2path(file_id)
1354
except errors.NoSuchId:
1355
filter_tree_path = self.other_tree.id2path(file_id)
1357
# Skip the id2path lookup for older formats
1358
filter_tree_path = None
1359
transform.create_from_tree(self.tt, trans_id,
1360
self.other_tree, file_id,
1361
filter_tree_path=filter_tree_path)
1364
# OTHER deleted the file
1365
return 'delete', None
1367
raise AssertionError(
1368
'winner is OTHER, but file_id %r not in THIS or OTHER tree'
1371
def merge_contents(self, merge_hook_params):
1372
"""Fallback merge logic after user installed hooks."""
1373
# This function is used in merge hooks as the fallback instance.
1374
# Perhaps making this function and the functions it calls be a
1375
# a separate class would be better.
1376
if merge_hook_params.winner == 'other':
1377
# OTHER is a straight winner, so replace this contents with other
1378
return self._default_other_winner_merge(merge_hook_params)
1379
elif merge_hook_params.is_file_merge():
1380
# THIS and OTHER are both files, so text merge. Either
1381
# BASE is a file, or both converted to files, so at least we
1382
# have agreement that output should be a file.
1384
self.text_merge(merge_hook_params.file_id,
1385
merge_hook_params.trans_id)
1386
except errors.BinaryFile:
1387
return 'not_applicable', None
1390
return 'not_applicable', None
803
if base_pair == other_pair:
804
# OTHER introduced no changes
806
this_pair = contents_pair(self.this_tree)
807
if this_pair == other_pair:
808
# THIS and OTHER introduced the same changes
811
trans_id = self.tt.trans_id_file_id(file_id)
812
if this_pair == base_pair:
813
# only OTHER introduced changes
814
if file_id in self.this_tree:
815
# Remove any existing contents
816
self.tt.delete_contents(trans_id)
817
if file_id in self.other_tree:
818
# OTHER changed the file
819
create_by_entry(self.tt,
820
self.other_tree.inventory[file_id],
821
self.other_tree, trans_id)
822
if file_id not in self.this_tree.inventory:
823
self.tt.version_file(file_id, trans_id)
825
elif file_id in self.this_tree.inventory:
826
# OTHER deleted the file
827
self.tt.unversion_file(trans_id)
829
#BOTH THIS and OTHER introduced changes; scalar conflict
830
elif this_pair[0] == "file" and other_pair[0] == "file":
831
# THIS and OTHER are both files, so text merge. Either
832
# BASE is a file, or both converted to files, so at least we
833
# have agreement that output should be a file.
835
self.text_merge(file_id, trans_id)
837
return contents_conflict()
838
if file_id not in self.this_tree.inventory:
839
self.tt.version_file(file_id, trans_id)
841
self.tt.tree_kind(trans_id)
842
self.tt.delete_contents(trans_id)
847
# Scalar conflict, can't text merge. Dump conflicts
848
return contents_conflict()
1392
850
def get_lines(self, tree, file_id):
1393
851
"""Return the lines in a file, or an empty list."""
1394
if tree.has_id(file_id):
1395
853
return tree.get_file(file_id).readlines()
1448
905
determined automatically. If set_version is true, the .OTHER, .THIS
1449
906
or .BASE (in that order) will be created as versioned files.
1451
data = [('OTHER', self.other_tree, other_lines),
908
data = [('OTHER', self.other_tree, other_lines),
1452
909
('THIS', self.this_tree, this_lines)]
1454
911
data.append(('BASE', self.base_tree, base_lines))
1456
# We need to use the actual path in the working tree of the file here,
1457
# ignoring the conflict suffixes
1459
if wt.supports_content_filtering():
1461
filter_tree_path = wt.id2path(file_id)
1462
except errors.NoSuchId:
1463
# file has been deleted
1464
filter_tree_path = None
1466
# Skip the id2path lookup for older formats
1467
filter_tree_path = None
1469
912
versioned = False
1471
914
for suffix, tree, lines in data:
1472
if tree.has_id(file_id):
1473
916
trans_id = self._conflict_file(name, parent_id, tree, file_id,
1474
suffix, lines, filter_tree_path)
1475
918
file_group.append(trans_id)
1476
919
if set_version and not versioned:
1477
920
self.tt.version_file(file_id, trans_id)
1478
921
versioned = True
1479
922
return file_group
1481
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1482
lines=None, filter_tree_path=None):
924
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1483
926
"""Emit a single conflict file."""
1484
927
name = name + '.' + suffix
1485
928
trans_id = self.tt.create_path(name, parent_id)
1486
transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
929
entry = tree.inventory[file_id]
930
create_by_entry(self.tt, entry, tree, trans_id, lines)
1490
933
def merge_executable(self, file_id, file_status):
1491
934
"""Perform a merge on the execute bit."""
1492
935
executable = [self.executable(t, file_id) for t in (self.base_tree,
1493
936
self.other_tree, self.this_tree)]
1494
self._merge_executable(file_id, executable, file_status,
1495
resolver=self._three_way)
937
self._merge_executable(file_id, executable, file_status)
1497
def _merge_executable(self, file_id, executable, file_status,
939
def _merge_executable(self, file_id, executable, file_status):
1499
940
"""Perform a merge on the execute bit."""
1500
941
base_executable, other_executable, this_executable = executable
1501
942
if file_status == "deleted":
1503
winner = resolver(*executable)
944
trans_id = self.tt.trans_id_file_id(file_id)
946
if self.tt.final_kind(trans_id) != "file":
950
winner = self._three_way(*executable)
1504
951
if winner == "conflict":
1505
952
# There must be a None in here, if we have a conflict, but we
1506
953
# need executability since file status was not deleted.
1554
998
if path.endswith(suffix):
1555
999
path = path[:-len(suffix)]
1557
c = _mod_conflicts.Conflict.factory(conflict_type,
1558
path=path, file_id=file_id)
1001
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
1559
1002
self.cooked_conflicts.append(c)
1560
1003
if conflict_type == 'text conflict':
1561
1004
trans_id = conflict[1]
1562
1005
path = fp.get_path(trans_id)
1563
1006
file_id = self.tt.final_file_id(trans_id)
1564
c = _mod_conflicts.Conflict.factory(conflict_type,
1565
path=path, file_id=file_id)
1007
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
1566
1008
self.cooked_conflicts.append(c)
1568
1010
for trans_id, conflicts in name_conflicts.iteritems():
1570
1012
this_parent, other_parent = conflicts['parent conflict']
1571
if this_parent == other_parent:
1572
raise AssertionError()
1013
assert this_parent != other_parent
1573
1014
except KeyError:
1574
1015
this_parent = other_parent = \
1575
1016
self.tt.final_file_id(self.tt.final_parent(trans_id))
1577
1018
this_name, other_name = conflicts['name conflict']
1578
if this_name == other_name:
1579
raise AssertionError()
1019
assert this_name != other_name
1580
1020
except KeyError:
1581
1021
this_name = other_name = self.tt.final_name(trans_id)
1582
1022
other_path = fp.get_path(trans_id)
1583
1023
if this_parent is not None and this_name is not None:
1584
1024
this_parent_path = \
1585
1025
fp.get_path(self.tt.trans_id_file_id(this_parent))
1586
this_path = osutils.pathjoin(this_parent_path, this_name)
1026
this_path = pathjoin(this_parent_path, this_name)
1588
1028
this_path = "<deleted>"
1589
1029
file_id = self.tt.final_file_id(trans_id)
1590
c = _mod_conflicts.Conflict.factory('path conflict', path=this_path,
1591
conflict_path=other_path,
1030
c = Conflict.factory('path conflict', path=this_path,
1031
conflict_path=other_path, file_id=file_id)
1593
1032
self.cooked_conflicts.append(c)
1594
self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1033
self.cooked_conflicts.sort(key=Conflict.sort_key)
1597
1036
class WeaveMerger(Merge3Merger):
1601
1040
supports_reverse_cherrypick = False
1602
1041
history_based = True
1604
def _generate_merge_plan(self, file_id, base):
1605
return self.this_tree.plan_file_merge(file_id, self.other_tree,
1043
def __init__(self, working_tree, this_tree, base_tree, other_tree,
1044
interesting_ids=None, pb=DummyProgress(), pp=None,
1045
reprocess=False, change_reporter=None,
1046
interesting_files=None, cherrypick=False, do_merge=True):
1047
self.cherrypick = cherrypick
1048
super(WeaveMerger, self).__init__(working_tree, this_tree,
1049
base_tree, other_tree,
1050
interesting_files=interesting_files,
1051
interesting_ids=interesting_ids,
1052
pb=pb, pp=pp, reprocess=reprocess,
1053
change_reporter=change_reporter,
1056
def _merged_lines(self, file_id):
1057
"""Generate the merged lines.
1058
There is no distinction between lines that are meant to contain <<<<<<<
1062
base = self.base_tree
1065
plan = self.this_tree.plan_file_merge(file_id, self.other_tree,
1608
def _merged_lines(self, file_id):
1609
"""Generate the merged lines.
1610
There is no distinction between lines that are meant to contain <<<<<<<
1614
base = self.base_tree
1617
plan = self._generate_merge_plan(file_id, base)
1618
1067
if 'merge' in debug.debug_flags:
1619
1068
plan = list(plan)
1620
1069
trans_id = self.tt.trans_id_file_id(file_id)
1621
1070
name = self.tt.final_name(trans_id) + '.plan'
1622
contents = ('%11s|%s' % l for l in plan)
1071
contents = ('%10s|%s' % l for l in plan)
1623
1072
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1624
textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1625
'>>>>>>> MERGE-SOURCE\n')
1626
lines, conflicts = textmerge.merge_lines(self.reprocess)
1628
base_lines = textmerge.base_from_plan()
1631
return lines, base_lines
1073
textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1074
'>>>>>>> MERGE-SOURCE\n')
1075
return textmerge.merge_lines(self.reprocess)
1633
1077
def text_merge(self, file_id, trans_id):
1634
1078
"""Perform a (weave) text merge for a given file and file-id.
1635
1079
If conflicts are encountered, .THIS and .OTHER files will be emitted,
1636
1080
and a conflict will be noted.
1638
lines, base_lines = self._merged_lines(file_id)
1082
lines, conflicts = self._merged_lines(file_id)
1639
1083
lines = list(lines)
1640
# Note we're checking whether the OUTPUT is binary in this case,
1084
# Note we're checking whether the OUTPUT is binary in this case,
1641
1085
# because we don't want to get into weave merge guts.
1642
textfile.check_text_lines(lines)
1086
check_text_lines(lines)
1643
1087
self.tt.create_file(lines, trans_id)
1644
if base_lines is not None:
1646
1089
self._raw_conflicts.append(('text conflict', trans_id))
1647
1090
name = self.tt.final_name(trans_id)
1648
1091
parent_id = self.tt.final_parent(trans_id)
1649
file_group = self._dump_conflicts(name, parent_id, file_id,
1651
base_lines=base_lines)
1092
file_group = self._dump_conflicts(name, parent_id, file_id,
1652
1094
file_group.append(trans_id)
1655
1097
class LCAMerger(WeaveMerger):
1657
def _generate_merge_plan(self, file_id, base):
1658
return self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1099
def _merged_lines(self, file_id):
1100
"""Generate the merged lines.
1101
There is no distinction between lines that are meant to contain <<<<<<<
1105
base = self.base_tree
1108
plan = self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1110
if 'merge' in debug.debug_flags:
1112
trans_id = self.tt.trans_id_file_id(file_id)
1113
name = self.tt.final_name(trans_id) + '.plan'
1114
contents = ('%10s|%s' % l for l in plan)
1115
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1116
textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1117
'>>>>>>> MERGE-SOURCE\n')
1118
return textmerge.merge_lines(self.reprocess)
1661
1121
class Diff3Merger(Merge3Merger):
1662
1122
"""Three-way merger using external diff3 for text merging"""
1664
1124
def dump_file(self, temp_dir, name, tree, file_id):
1665
out_path = osutils.pathjoin(temp_dir, name)
1125
out_path = pathjoin(temp_dir, name)
1666
1126
out_file = open(out_path, "wb")
1668
1128
in_file = tree.get_file(file_id)
1779
1233
yield status_a(revision, text)
1780
1234
for revision, text in annotated_b[b_cur:bi]:
1781
1235
yield status_b(revision, text)
1782
1237
# and now the matched section
1785
for text_a in plain_a[ai:a_cur]:
1240
for text_a, text_b in zip(plain_a[ai:a_cur], plain_b[bi:b_cur]):
1241
assert text_a == text_b
1786
1242
yield "unchanged", text_a
1789
1245
class _PlanMergeBase(object):
1791
def __init__(self, a_rev, b_rev, vf, key_prefix):
1247
def __init__(self, a_rev, b_rev, vf):
1794
1250
:param a_rev: Revision-id of one revision to merge
1795
1251
:param b_rev: Revision-id of the other revision to merge
1796
:param vf: A VersionedFiles containing both revisions
1797
:param key_prefix: A prefix for accessing keys in vf, typically
1252
:param vf: A versionedfile containing both revisions
1800
1254
self.a_rev = a_rev
1801
1255
self.b_rev = b_rev
1256
self.lines_a = vf.get_lines(a_rev)
1257
self.lines_b = vf.get_lines(b_rev)
1803
1259
self._last_lines = None
1804
1260
self._last_lines_revision_id = None
1805
1261
self._cached_matching_blocks = {}
1806
self._key_prefix = key_prefix
1807
self._precache_tip_lines()
1809
def _precache_tip_lines(self):
1810
lines = self.get_lines([self.a_rev, self.b_rev])
1811
self.lines_a = lines[self.a_rev]
1812
self.lines_b = lines[self.b_rev]
1814
def get_lines(self, revisions):
1815
"""Get lines for revisions from the backing VersionedFiles.
1817
:raises RevisionNotPresent: on absent texts.
1819
keys = [(self._key_prefix + (rev,)) for rev in revisions]
1821
for record in self.vf.get_record_stream(keys, 'unordered', True):
1822
if record.storage_kind == 'absent':
1823
raise errors.RevisionNotPresent(record.key, self.vf)
1824
result[record.key[-1]] = osutils.chunks_to_lines(
1825
record.get_bytes_as('chunked'))
1828
1263
def plan_merge(self):
1829
1264
"""Generate a 'plan' for merging the two revisions.
1940
1373
class _PlanMerge(_PlanMergeBase):
1941
1374
"""Plan an annotate merge using on-the-fly annotation"""
1943
def __init__(self, a_rev, b_rev, vf, key_prefix):
1944
super(_PlanMerge, self).__init__(a_rev, b_rev, vf, key_prefix)
1945
self.a_key = self._key_prefix + (self.a_rev,)
1946
self.b_key = self._key_prefix + (self.b_rev,)
1947
self.graph = _mod_graph.Graph(self.vf)
1948
heads = self.graph.heads((self.a_key, self.b_key))
1950
# one side dominates, so we can just return its values, yay for
1952
# Ideally we would know that before we get this far
1953
self._head_key = heads.pop()
1954
if self._head_key == self.a_key:
1958
trace.mutter('found dominating revision for %s\n%s > %s', self.vf,
1959
self._head_key[-1], other)
1962
self._head_key = None
1965
def _precache_tip_lines(self):
1966
# Turn this into a no-op, because we will do this later
1969
def _find_recursive_lcas(self):
1970
"""Find all the ancestors back to a unique lca"""
1971
cur_ancestors = (self.a_key, self.b_key)
1972
# graph.find_lca(uncommon, keys) now returns plain NULL_REVISION,
1973
# rather than a key tuple. We will just map that directly to no common
1977
next_lcas = self.graph.find_lca(*cur_ancestors)
1978
# Map a plain NULL_REVISION to a simple no-ancestors
1979
if next_lcas == set([_mod_revision.NULL_REVISION]):
1981
# Order the lca's based on when they were merged into the tip
1982
# While the actual merge portion of weave merge uses a set() of
1983
# active revisions, the order of insertion *does* effect the
1984
# implicit ordering of the texts.
1985
for rev_key in cur_ancestors:
1986
ordered_parents = tuple(self.graph.find_merge_order(rev_key,
1988
parent_map[rev_key] = ordered_parents
1989
if len(next_lcas) == 0:
1991
elif len(next_lcas) == 1:
1992
parent_map[list(next_lcas)[0]] = ()
1994
elif len(next_lcas) > 2:
1995
# More than 2 lca's, fall back to grabbing all nodes between
1996
# this and the unique lca.
1997
trace.mutter('More than 2 LCAs, falling back to all nodes for:'
1999
self.a_key, self.b_key, cur_ancestors)
2000
cur_lcas = next_lcas
2001
while len(cur_lcas) > 1:
2002
cur_lcas = self.graph.find_lca(*cur_lcas)
2003
if len(cur_lcas) == 0:
2004
# No common base to find, use the full ancestry
2007
unique_lca = list(cur_lcas)[0]
2008
if unique_lca == _mod_revision.NULL_REVISION:
2009
# find_lca will return a plain 'NULL_REVISION' rather
2010
# than a key tuple when there is no common ancestor, we
2011
# prefer to just use None, because it doesn't confuse
2012
# _get_interesting_texts()
2014
parent_map.update(self._find_unique_parents(next_lcas,
2017
cur_ancestors = next_lcas
2020
def _find_unique_parents(self, tip_keys, base_key):
2021
"""Find ancestors of tip that aren't ancestors of base.
2023
:param tip_keys: Nodes that are interesting
2024
:param base_key: Cull all ancestors of this node
2025
:return: The parent map for all revisions between tip_keys and
2026
base_key. base_key will be included. References to nodes outside of
2027
the ancestor set will also be removed.
2029
# TODO: this would be simpler if find_unique_ancestors took a list
2030
# instead of a single tip, internally it supports it, but it
2031
# isn't a "backwards compatible" api change.
2032
if base_key is None:
2033
parent_map = dict(self.graph.iter_ancestry(tip_keys))
2034
# We remove NULL_REVISION because it isn't a proper tuple key, and
2035
# thus confuses things like _get_interesting_texts, and our logic
2036
# to add the texts into the memory weave.
2037
if _mod_revision.NULL_REVISION in parent_map:
2038
parent_map.pop(_mod_revision.NULL_REVISION)
2041
for tip in tip_keys:
2043
self.graph.find_unique_ancestors(tip, [base_key]))
2044
parent_map = self.graph.get_parent_map(interesting)
2045
parent_map[base_key] = ()
2046
culled_parent_map, child_map, tails = self._remove_external_references(
2048
# Remove all the tails but base_key
2049
if base_key is not None:
2050
tails.remove(base_key)
2051
self._prune_tails(culled_parent_map, child_map, tails)
2052
# Now remove all the uninteresting 'linear' regions
2053
simple_map = _mod_graph.collapse_linear_regions(culled_parent_map)
2057
def _remove_external_references(parent_map):
2058
"""Remove references that go outside of the parent map.
2060
:param parent_map: Something returned from Graph.get_parent_map(keys)
2061
:return: (filtered_parent_map, child_map, tails)
2062
filtered_parent_map is parent_map without external references
2063
child_map is the {parent_key: [child_keys]} mapping
2064
tails is a list of nodes that do not have any parents in the map
2066
# TODO: The basic effect of this function seems more generic than
2067
# _PlanMerge. But the specific details of building a child_map,
2068
# and computing tails seems very specific to _PlanMerge.
2069
# Still, should this be in Graph land?
2070
filtered_parent_map = {}
2073
for key, parent_keys in parent_map.iteritems():
2074
culled_parent_keys = [p for p in parent_keys if p in parent_map]
2075
if not culled_parent_keys:
2077
for parent_key in culled_parent_keys:
2078
child_map.setdefault(parent_key, []).append(key)
2079
# TODO: Do we want to do this, it adds overhead for every node,
2080
# just to say that the node has no children
2081
child_map.setdefault(key, [])
2082
filtered_parent_map[key] = culled_parent_keys
2083
return filtered_parent_map, child_map, tails
2086
def _prune_tails(parent_map, child_map, tails_to_remove):
2087
"""Remove tails from the parent map.
2089
This will remove the supplied revisions until no more children have 0
2092
:param parent_map: A dict of {child: [parents]}, this dictionary will
2093
be modified in place.
2094
:param tails_to_remove: A list of tips that should be removed,
2095
this list will be consumed
2096
:param child_map: The reverse dict of parent_map ({parent: [children]})
2097
this dict will be modified
2098
:return: None, parent_map will be modified in place.
2100
while tails_to_remove:
2101
next = tails_to_remove.pop()
2102
parent_map.pop(next)
2103
children = child_map.pop(next)
2104
for child in children:
2105
child_parents = parent_map[child]
2106
child_parents.remove(next)
2107
if len(child_parents) == 0:
2108
tails_to_remove.append(child)
2110
def _get_interesting_texts(self, parent_map):
2111
"""Return a dict of texts we are interested in.
2113
Note that the input is in key tuples, but the output is in plain
2116
:param parent_map: The output from _find_recursive_lcas
2117
:return: A dict of {'revision_id':lines} as returned by
2118
_PlanMergeBase.get_lines()
2120
all_revision_keys = set(parent_map)
2121
all_revision_keys.add(self.a_key)
2122
all_revision_keys.add(self.b_key)
2124
# Everything else is in 'keys' but get_lines is in 'revision_ids'
2125
all_texts = self.get_lines([k[-1] for k in all_revision_keys])
2128
def _build_weave(self):
2129
from bzrlib import weave
2130
self._weave = weave.Weave(weave_name='in_memory_weave',
2131
allow_reserved=True)
2132
parent_map = self._find_recursive_lcas()
2134
all_texts = self._get_interesting_texts(parent_map)
2136
# Note: Unfortunately, the order given by topo_sort will effect the
2137
# ordering resolution in the output. Specifically, if you add A then B,
2138
# then in the output text A lines will show up before B lines. And, of
2139
# course, topo_sort doesn't guarantee any real ordering.
2140
# So we use merge_sort, and add a fake node on the tip.
2141
# This ensures that left-hand parents will always be inserted into the
2142
# weave before right-hand parents.
2143
tip_key = self._key_prefix + (_mod_revision.CURRENT_REVISION,)
2144
parent_map[tip_key] = (self.a_key, self.b_key)
2146
for seq_num, key, depth, eom in reversed(tsort.merge_sort(parent_map,
2150
# for key in tsort.topo_sort(parent_map):
2151
parent_keys = parent_map[key]
2152
revision_id = key[-1]
2153
parent_ids = [k[-1] for k in parent_keys]
2154
self._weave.add_lines(revision_id, parent_ids,
2155
all_texts[revision_id])
2157
def plan_merge(self):
2158
"""Generate a 'plan' for merging the two revisions.
2160
This involves comparing their texts and determining the cause of
2161
differences. If text A has a line and text B does not, then either the
2162
line was added to text A, or it was deleted from B. Once the causes
2163
are combined, they are written out in the format described in
2164
VersionedFile.plan_merge
2166
if self._head_key is not None: # There was a single head
2167
if self._head_key == self.a_key:
2170
if self._head_key != self.b_key:
2171
raise AssertionError('There was an invalid head: %s != %s'
2172
% (self.b_key, self._head_key))
2174
head_rev = self._head_key[-1]
2175
lines = self.get_lines([head_rev])[head_rev]
2176
return ((plan, line) for line in lines)
2177
return self._weave.plan_merge(self.a_rev, self.b_rev)
1376
def __init__(self, a_rev, b_rev, vf):
1377
_PlanMergeBase.__init__(self, a_rev, b_rev, vf)
1378
a_ancestry = set(vf.get_ancestry(a_rev, topo_sorted=False))
1379
b_ancestry = set(vf.get_ancestry(b_rev, topo_sorted=False))
1380
self.uncommon = a_ancestry.symmetric_difference(b_ancestry)
1382
def _determine_status(self, revision_id, unique_line_numbers):
1383
"""Determines the status unique lines versus all lcas.
1385
Basically, determines why the line is unique to this revision.
1387
A line may be determined new or killed, but not both.
1389
:param revision_id: The id of the revision in which the lines are
1391
:param unique_line_numbers: The line numbers of unique lines.
1392
:return a tuple of (new_this, killed_other):
1394
new = self._find_new(revision_id)
1395
killed = set(unique_line_numbers).difference(new)
1398
def _find_new(self, version_id):
1399
"""Determine which lines are new in the ancestry of this version.
1401
If a lines is present in this version, and not present in any
1402
common ancestor, it is considered new.
1404
if version_id not in self.uncommon:
1406
parents = self.vf.get_parents(version_id)
1407
if len(parents) == 0:
1408
return set(range(len(self.vf.get_lines(version_id))))
1410
for parent in parents:
1411
blocks = self._get_matching_blocks(version_id, parent)
1412
result, unused = self._unique_lines(blocks)
1413
parent_new = self._find_new(parent)
1414
for i, j, n in blocks:
1415
for ii, jj in [(i+r, j+r) for r in range(n)]:
1416
if jj in parent_new:
1421
new.intersection_update(result)
2180
1425
class _PlanLCAMerge(_PlanMergeBase):
added
removed
bzrlib/merge.py
