39
from bzrlib.cleanup import OperationWithCleanups
40
from bzrlib.symbol_versioning import (
42
from breezy.bzr import (
45
from breezy.i18n import gettext
44
56
# TODO: Report back as changes are merged in
47
def transform_tree(from_tree, to_tree, interesting_ids=None):
59
def transform_tree(from_tree, to_tree, interesting_files=None):
48
60
from_tree.lock_tree_write()
49
operation = OperationWithCleanups(merge_inner)
61
operation = cleanup.OperationWithCleanups(merge_inner)
50
62
operation.add_cleanup(from_tree.unlock)
51
63
operation.run_simple(from_tree.branch, to_tree, from_tree,
52
ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
64
ignore_zero=True, this_tree=from_tree,
65
interesting_files=interesting_files)
55
68
class MergeHooks(hooks.Hooks):
57
70
def __init__(self):
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 "
71
hooks.Hooks.__init__(self, "breezy.merge", "Merger.hooks")
72
self.add_hook('merge_file_content',
73
"Called with a breezy.merge.Merger object to create a per file "
61
74
"merge object when starting a merge. "
62
75
"Should return either None or a subclass of "
63
"``bzrlib.merge.AbstractPerFileMerger``. "
76
"``breezy.merge.AbstractPerFileMerger``. "
64
77
"Such objects will then be called per file "
65
78
"that needs to be merged (including when one "
66
79
"side has deleted the file and the other has changed it). "
67
80
"See the AbstractPerFileMerger API docs for details on how it is "
83
self.add_hook('pre_merge',
84
'Called before a merge. '
85
'Receives a Merger object as the single argument.',
87
self.add_hook('post_merge',
88
'Called after a merge. '
89
'Receives a Merger object as the single argument. '
90
'The return value is ignored.',
72
94
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.
95
"""PerFileMerger objects are used by plugins extending merge for breezy.
97
See ``breezy.plugins.news_merge.news_merge`` for an example concrete class.
77
99
:ivar merger: The Merge3Merger performing the merge.
435
441
revision_id = _mod_revision.ensure_null(revision_id)
436
442
return branch, self.revision_tree(revision_id, branch)
438
@deprecated_method(deprecated_in((2, 1, 0)))
439
def ensure_revision_trees(self):
440
if self.this_revision_tree is None:
441
self.this_basis_tree = self.revision_tree(self.this_basis)
442
if self.this_basis == self.this_rev_id:
443
self.this_revision_tree = self.this_basis_tree
445
if self.other_rev_id is None:
446
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)
449
other_rev_id = self.other_basis
450
self.other_tree = other_basis_tree
452
@deprecated_method(deprecated_in((2, 1, 0)))
453
def file_revisions(self, file_id):
454
self.ensure_revision_trees()
455
def get_id(tree, file_id):
456
revision_id = tree.inventory[file_id].revision
458
if self.this_rev_id is None:
459
if self.this_basis_tree.get_file_sha1(file_id) != \
460
self.this_tree.get_file_sha1(file_id):
461
raise errors.WorkingTreeNotRevision(self.this_tree)
463
trees = (self.this_basis_tree, self.other_tree)
464
return [get_id(tree, file_id) for tree in trees]
466
@deprecated_method(deprecated_in((2, 1, 0)))
467
def check_basis(self, check_clean, require_commits=True):
468
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')")
474
if self.this_basis != self.this_rev_id:
475
raise errors.UncommittedChanges(self.this_tree)
477
@deprecated_method(deprecated_in((2, 1, 0)))
478
def compare_basis(self):
480
basis_tree = self.revision_tree(self.this_tree.last_revision())
481
except errors.NoSuchRevision:
482
basis_tree = self.this_tree.basis_tree()
483
if not self.this_tree.has_changes(basis_tree):
484
self.this_rev_id = self.this_basis
486
444
def set_interesting_files(self, file_list):
487
445
self.interesting_files = file_list
839
807
entries = self._entries_lca()
840
808
resolver = self._lca_multi_way
841
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
for num, (file_id, changed, parents3, names3,
809
# Prepare merge hooks
810
factories = Merger.hooks['merge_file_content']
811
# One hook for each registered one plus our default merger
812
hooks = [factory(self) for factory in factories] + [self]
813
self.active_hooks = [hook for hook in hooks if hook is not None]
814
with ui.ui_factory.nested_progress_bar() as child_pb:
815
for num, (file_id, changed, paths3, parents3, names3,
847
816
executable3) in enumerate(entries):
848
child_pb.update('Preparing file merge', num, len(entries))
849
self._merge_names(file_id, parents3, names3, resolver=resolver)
817
# Try merging each entry
818
child_pb.update(gettext('Preparing file merge'),
820
self._merge_names(file_id, paths3, parents3, names3, resolver=resolver)
851
file_status = self._do_merge_contents(file_id)
822
file_status = self._do_merge_contents(paths3, file_id)
853
824
file_status = 'unmodified'
854
self._merge_executable(file_id,
855
executable3, file_status, resolver=resolver)
859
child_pb = ui.ui_factory.nested_progress_bar()
825
self._merge_executable(paths3, file_id, executable3,
826
file_status, resolver=resolver)
827
self.tt.fixup_new_roots()
828
self._finish_computing_transform()
830
def _finish_computing_transform(self):
831
"""Finalize the transform and report the changes.
833
This is the second half of _compute_transform.
835
with ui.ui_factory.nested_progress_bar() as child_pb:
861
836
fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
862
837
lambda t, c: transform.conflict_pass(t, c, self.other_tree))
865
838
if self.change_reporter is not None:
866
from bzrlib import delta
839
from breezy import delta
867
840
delta.report_changes(
868
841
self.tt.iter_changes(), self.change_reporter)
869
842
self.cook_conflicts(fs_conflicts)
870
843
for conflict in self.cooked_conflicts:
871
trace.warning(conflict)
844
trace.warning(unicode(conflict))
873
846
def _entries3(self):
874
847
"""Gather data about files modified between three trees.
883
856
iterator = self.other_tree.iter_changes(self.base_tree,
884
include_unchanged=True, specific_files=self.interesting_files,
857
specific_files=self.interesting_files,
885
858
extra_trees=[self.this_tree])
886
this_entries = dict((e.file_id, e) for p, e in
887
self.this_tree.iter_entries_by_dir(
888
self.interesting_ids))
859
this_interesting_files = self.this_tree.find_related_paths_across_trees(
860
self.interesting_files, trees=[self.other_tree])
861
this_entries = dict(self.this_tree.iter_entries_by_dir(
862
specific_files=this_interesting_files))
889
863
for (file_id, paths, changed, versioned, parents, names, kind,
890
864
executable) in iterator:
891
if (self.interesting_ids is not None and
892
file_id not in self.interesting_ids):
894
entry = this_entries.get(file_id)
895
if entry is not None:
896
this_name = entry.name
897
this_parent = entry.parent_id
898
this_executable = entry.executable
865
if paths[0] is not None:
866
this_path = _mod_tree.find_previous_path(
867
self.base_tree, self.this_tree, paths[0])
869
this_path = _mod_tree.find_previous_path(
870
self.other_tree, self.this_tree, paths[1])
871
this_entry = this_entries.get(this_path)
872
if this_entry is not None:
873
this_name = this_entry.name
874
this_parent = this_entry.parent_id
875
this_executable = this_entry.executable
901
878
this_parent = None
902
879
this_executable = None
903
880
parents3 = parents + (this_parent,)
904
881
names3 = names + (this_name,)
882
paths3 = paths + (this_path, )
905
883
executable3 = executable + (this_executable,)
906
result.append((file_id, changed, parents3, names3, executable3))
884
result.append((file_id, changed, paths3, parents3, names3, executable3))
909
887
def _entries_lca(self):
913
891
it then compares with THIS and BASE.
915
893
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)
895
:return: [(file_id, changed, paths, parents, names, executable)], where:
897
* file_id: Simple file_id of the entry
898
* changed: Boolean, True if the kind or contents changed else False
899
* paths: ((base, [path, in, lcas]), path_other, path_this)
900
* parents: ((base, [parent_id, in, lcas]), parent_id_other,
902
* names: ((base, [name, in, lcas]), name_in_other, name_in_this)
903
* executable: ((base, [exec, in, lcas]), exec_in_other,
925
906
if self.interesting_files is not None:
926
907
lookup_trees = [self.this_tree, self.base_tree]
927
908
lookup_trees.extend(self._lca_trees)
928
909
# I think we should include the lca trees as well
929
interesting_ids = self.other_tree.paths2ids(self.interesting_files,
910
interesting_files = self.other_tree.find_related_paths_across_trees(
911
self.interesting_files, lookup_trees)
932
interesting_ids = self.interesting_ids
913
interesting_files = None
934
915
walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
936
base_inventory = self.base_tree.inventory
937
this_inventory = self.this_tree.inventory
917
base_inventory = self.base_tree.root_inventory
918
this_inventory = self.this_tree.root_inventory
938
919
for path, file_id, other_ie, lca_values in walker.iter_all():
939
920
# Is this modified at all from any of the other trees?
940
921
if other_ie is None:
941
922
other_ie = _none_entry
942
if interesting_ids is not None and file_id not in interesting_ids:
925
other_path = self.other_tree.id2path(file_id)
926
if interesting_files is not None and other_path not in interesting_files:
945
929
# If other_revision is found in any of the lcas, that means this
1077
self.tt.final_kind(self.tt.root)
1078
except errors.NoSuchFile:
1079
self.tt.cancel_deletion(self.tt.root)
1080
if self.tt.final_file_id(self.tt.root) is None:
1081
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
1083
other_root_file_id = self.other_tree.get_root_id()
1084
if other_root_file_id is None:
1086
other_root = self.tt.trans_id_file_id(other_root_file_id)
1087
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
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():
1104
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)
1122
1073
def write_modified(self, results):
1074
if not self.working_tree.supports_merge_modified():
1123
1076
modified_hashes = {}
1124
1077
for path in results.modified_paths:
1125
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
1078
wt_relpath = self.working_tree.relpath(path)
1079
file_id = self.working_tree.path2id(wt_relpath)
1126
1080
if file_id is None:
1128
hash = self.this_tree.get_file_sha1(file_id)
1082
hash = self.working_tree.get_file_sha1(wt_relpath, file_id)
1129
1083
if hash is None:
1131
1085
modified_hashes[file_id] = hash
1132
self.this_tree.set_merge_modified(modified_hashes)
1086
self.working_tree.set_merge_modified(modified_hashes)
1135
1089
def parent(entry, file_id):
1299
1238
self._raw_conflicts.append(('path conflict', trans_id, file_id,
1300
1239
this_parent, this_name,
1301
1240
other_parent, other_name))
1302
if other_name is None:
1241
if other_path is None:
1303
1242
# it doesn't matter whether the result was 'other' or
1304
# 'conflict'-- if there's no 'other', we leave it alone.
1243
# 'conflict'-- if it has no file id, we leave it alone.
1306
1245
parent_id = parents[self.winner_idx[parent_id_winner]]
1307
if parent_id is not None:
1246
name = names[self.winner_idx[name_winner]]
1247
if parent_id is not None or name is not None:
1308
1248
# if we get here, name_winner and parent_winner are set to safe
1310
self.tt.adjust_path(names[self.winner_idx[name_winner]],
1311
self.tt.trans_id_file_id(parent_id),
1250
if parent_id is None and name is not None:
1251
# if parent_id is None and name is non-None, current file is
1253
if names[self.winner_idx[parent_id_winner]] != '':
1254
raise AssertionError(
1255
'File looks like a root, but named %s' %
1256
names[self.winner_idx[parent_id_winner]])
1257
parent_trans_id = transform.ROOT_PARENT
1259
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1260
self.tt.adjust_path(name, parent_trans_id,
1312
1261
self.tt.trans_id_file_id(file_id))
1314
def _do_merge_contents(self, file_id):
1263
def _do_merge_contents(self, paths, file_id):
1315
1264
"""Performs a merge on file_id contents."""
1316
def contents_pair(tree):
1317
if file_id not in tree:
1319
kind = tree.kind(file_id)
1265
def contents_pair(tree, path):
1269
kind = tree.kind(path, file_id)
1270
except errors.NoSuchFile:
1320
1272
if kind == "file":
1321
contents = tree.get_file_sha1(file_id)
1273
contents = tree.get_file_sha1(path, file_id)
1322
1274
elif kind == "symlink":
1323
contents = tree.get_symlink_target(file_id)
1275
contents = tree.get_symlink_target(path, file_id)
1325
1277
contents = None
1326
1278
return kind, contents
1280
base_path, other_path, this_path = paths
1328
1281
# See SPOT run. run, SPOT, run.
1329
1282
# So we're not QUITE repeating ourselves; we do tricky things with
1331
base_pair = contents_pair(self.base_tree)
1332
other_pair = contents_pair(self.other_tree)
1284
other_pair = contents_pair(self.other_tree, other_path)
1285
this_pair = contents_pair(self.this_tree, this_path)
1333
1286
if self._lca_trees:
1334
this_pair = contents_pair(self.this_tree)
1335
lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1287
(base_path, lca_paths) = base_path
1288
base_pair = contents_pair(self.base_tree, base_path)
1289
lca_pairs = [contents_pair(tree, path)
1290
for tree, path in zip(self._lca_trees, lca_paths)]
1336
1291
winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1337
1292
this_pair, allow_overriding_lca=False)
1294
base_pair = contents_pair(self.base_tree, base_path)
1339
1295
if base_pair == other_pair:
1340
1296
winner = 'this'
1342
1298
# We delayed evaluating this_pair as long as we can to avoid
1343
1299
# unnecessary sha1 calculation
1344
this_pair = contents_pair(self.this_tree)
1300
this_pair = contents_pair(self.this_tree, this_path)
1345
1301
winner = self._three_way(base_pair, other_pair, this_pair)
1346
1302
if winner == 'this':
1347
1303
# No interesting changes introduced by OTHER
1358
1316
if hook_status != 'not_applicable':
1359
1317
# Don't try any more hooks, this one applies.
1319
# If the merge ends up replacing the content of the file, we get rid of
1320
# it at the end of this method (this variable is used to track the
1321
# exceptions to this rule).
1361
1323
result = "modified"
1362
1324
if hook_status == 'not_applicable':
1363
# This is a contents conflict, because none of the available
1364
# functions could merge it.
1325
# No merge hook was able to resolve the situation. Two cases exist:
1326
# a content conflict or a duplicate one.
1366
1328
name = self.tt.final_name(trans_id)
1367
1329
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))
1331
inhibit_content_conflict = False
1332
if params.this_kind is None: # file_id is not in THIS
1333
# Is the name used for a different file_id ?
1334
if self.this_tree.is_versioned(other_path):
1335
# Two entries for the same path
1337
# versioning the merged file will trigger a duplicate
1339
self.tt.version_file(file_id, trans_id)
1340
transform.create_from_tree(
1341
self.tt, trans_id, self.other_tree,
1342
other_path, file_id=file_id,
1343
filter_tree_path=self._get_filter_tree_path(file_id))
1344
inhibit_content_conflict = True
1345
elif params.other_kind is None: # file_id is not in OTHER
1346
# Is the name used for a different file_id ?
1347
if self.other_tree.is_versioned(this_path):
1348
# Two entries for the same path again, but here, the other
1349
# entry will also be merged. We simply inhibit the
1350
# 'content' conflict creation because we know OTHER will
1351
# create (or has already created depending on ordering) an
1352
# entry at the same path. This will trigger a 'duplicate'
1355
inhibit_content_conflict = True
1356
if not inhibit_content_conflict:
1357
if params.this_kind is not None:
1358
self.tt.unversion_file(trans_id)
1359
# This is a contents conflict, because none of the available
1360
# functions could merge it.
1361
file_group = self._dump_conflicts(
1362
name, (base_path, other_path, this_path), parent_id,
1363
file_id, set_version=True)
1364
self._raw_conflicts.append(('contents conflict', file_group))
1373
1365
elif hook_status == 'success':
1374
1366
self.tt.create_file(lines, trans_id)
1375
1367
elif hook_status == 'conflicted':
1444
1422
# BASE is a file, or both converted to files, so at least we
1445
1423
# have agreement that output should be a file.
1447
self.text_merge(merge_hook_params.file_id,
1448
merge_hook_params.trans_id)
1425
self.text_merge(merge_hook_params.trans_id,
1426
merge_hook_params.paths, merge_hook_params.file_id)
1449
1427
except errors.BinaryFile:
1450
1428
return 'not_applicable', None
1451
1429
return 'done', None
1453
1431
return 'not_applicable', None
1455
def get_lines(self, tree, file_id):
1433
def get_lines(self, tree, path, file_id=None):
1456
1434
"""Return the lines in a file, or an empty list."""
1457
if tree.has_id(file_id):
1458
return tree.get_file(file_id).readlines()
1438
kind = tree.kind(path, file_id)
1439
except errors.NoSuchFile:
1444
return tree.get_file_lines(path, file_id)
1462
def text_merge(self, file_id, trans_id):
1446
def text_merge(self, trans_id, paths, file_id):
1463
1447
"""Perform a three-way text merge on a file_id"""
1464
1448
# it's possible that we got here with base as a different type.
1465
1449
# if so, we just want two-way text conflicts.
1466
if self.base_tree.has_id(file_id) and \
1467
self.base_tree.kind(file_id) == "file":
1468
base_lines = self.get_lines(self.base_tree, file_id)
1471
other_lines = self.get_lines(self.other_tree, file_id)
1472
this_lines = self.get_lines(self.this_tree, file_id)
1450
base_path, other_path, this_path = paths
1451
base_lines = self.get_lines(self.base_tree, base_path, file_id)
1452
other_lines = self.get_lines(self.other_tree, other_path, file_id)
1453
this_lines = self.get_lines(self.this_tree, this_path, file_id)
1473
1454
m3 = merge3.Merge3(base_lines, this_lines, other_lines,
1474
1455
is_cherrypick=self.cherrypick)
1475
1456
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
1532
1527
versioned = False
1533
1528
file_group = []
1534
for suffix, tree, lines in data:
1535
if tree.has_id(file_id):
1536
trans_id = self._conflict_file(name, parent_id, tree, file_id,
1537
suffix, lines, filter_tree_path)
1529
for suffix, tree, path, lines in data:
1530
if path is not None:
1531
trans_id = self._conflict_file(
1532
name, parent_id, path, tree, file_id, suffix, lines,
1538
1534
file_group.append(trans_id)
1539
1535
if set_version and not versioned:
1540
1536
self.tt.version_file(file_id, trans_id)
1541
1537
versioned = True
1542
1538
return file_group
1544
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1540
def _conflict_file(self, name, parent_id, path, tree, file_id, suffix,
1545
1541
lines=None, filter_tree_path=None):
1546
1542
"""Emit a single conflict file."""
1547
1543
name = name + '.' + suffix
1548
1544
trans_id = self.tt.create_path(name, parent_id)
1549
transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
1545
transform.create_from_tree(
1546
self.tt, trans_id, tree, path,
1547
file_id=file_id, bytes=lines,
1548
filter_tree_path=filter_tree_path)
1551
1549
return trans_id
1553
def merge_executable(self, file_id, file_status):
1551
def merge_executable(self, paths, file_id, file_status):
1554
1552
"""Perform a merge on the execute bit."""
1555
executable = [self.executable(t, file_id) for t in (self.base_tree,
1556
self.other_tree, self.this_tree)]
1557
self._merge_executable(file_id, executable, file_status,
1553
executable = [self.executable(t, p, file_id) for t, p in zip([self.base_tree,
1554
self.other_tree, self.this_tree], paths)]
1555
self._merge_executable(paths, file_id, executable, file_status,
1558
1556
resolver=self._three_way)
1560
def _merge_executable(self, file_id, executable, file_status,
1558
def _merge_executable(self, paths, file_id, executable, file_status,
1562
1560
"""Perform a merge on the execute bit."""
1563
1561
base_executable, other_executable, this_executable = executable
1562
base_path, other_path, this_path = paths
1564
1563
if file_status == "deleted":
1566
1565
winner = resolver(*executable)
1567
1566
if winner == "conflict":
1568
1567
# There must be a None in here, if we have a conflict, but we
1569
1568
# need executability since file status was not deleted.
1570
if self.executable(self.other_tree, file_id) is None:
1569
if other_path is None:
1571
1570
winner = "this"
1573
1572
winner = "other"
1574
1573
if winner == 'this' and file_status != "modified":
1576
1575
trans_id = self.tt.trans_id_file_id(file_id)
1578
if self.tt.final_kind(trans_id) != "file":
1580
except errors.NoSuchFile:
1576
if self.tt.final_kind(trans_id) != "file":
1582
1578
if winner == "this":
1583
1579
executability = this_executable
1585
if self.other_tree.has_id(file_id):
1581
if other_path is not None:
1586
1582
executability = other_executable
1587
elif self.this_tree.has_id(file_id):
1583
elif this_path is not None:
1588
1584
executability = this_executable
1589
elif self.base_tree_has_id(file_id):
1585
elif base_path is not None:
1590
1586
executability = base_executable
1591
1587
if executability is not None:
1592
1588
trans_id = self.tt.trans_id_file_id(file_id)
1710
1730
class Diff3Merger(Merge3Merger):
1711
1731
"""Three-way merger using external diff3 for text merging"""
1713
def dump_file(self, temp_dir, name, tree, file_id):
1733
requires_file_merge_plan = False
1735
def dump_file(self, temp_dir, name, tree, path, file_id=None):
1714
1736
out_path = osutils.pathjoin(temp_dir, name)
1715
out_file = open(out_path, "wb")
1717
in_file = tree.get_file(file_id)
1737
with open(out_path, "wb") as out_file:
1738
in_file = tree.get_file(path, file_id=None)
1718
1739
for line in in_file:
1719
1740
out_file.write(line)
1722
1741
return out_path
1724
def text_merge(self, file_id, trans_id):
1743
def text_merge(self, trans_id, paths, file_id):
1725
1744
"""Perform a diff3 merge using a specified file-id and trans-id.
1726
1745
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
1727
1746
will be dumped, and a will be conflict noted.
1749
base_path, other_path, this_path = paths
1730
1750
temp_dir = osutils.mkdtemp(prefix="bzr-")
1732
1752
new_file = osutils.pathjoin(temp_dir, "new")
1733
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
1734
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
1735
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
1736
status = bzrlib.patch.diff3(new_file, this, base, other)
1753
this = self.dump_file(temp_dir, "this", self.this_tree, this_path, file_id)
1754
base = self.dump_file(temp_dir, "base", self.base_tree, base_path, file_id)
1755
other = self.dump_file(temp_dir, "other", self.other_tree, other_path, file_id)
1756
status = breezy.patch.diff3(new_file, this, base, other)
1737
1757
if status not in (0, 1):
1738
1758
raise errors.BzrError("Unhandled diff3 exit code")
1739
f = open(new_file, 'rb')
1759
with open(new_file, 'rb') as f:
1741
1760
self.tt.create_file(f, trans_id)
1744
1761
if status == 1:
1745
1762
name = self.tt.final_name(trans_id)
1746
1763
parent_id = self.tt.final_parent(trans_id)
1747
self._dump_conflicts(name, parent_id, file_id)
1764
self._dump_conflicts(name, paths, parent_id, file_id)
1748
1765
self._raw_conflicts.append(('text conflict', trans_id))
1750
1767
osutils.rmtree(temp_dir)
1770
class PathNotInTree(errors.BzrError):
1772
_fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
1774
def __init__(self, path, tree):
1775
errors.BzrError.__init__(self, path=path, tree=tree)
1778
class MergeIntoMerger(Merger):
1779
"""Merger that understands other_tree will be merged into a subdir.
1781
This also changes the Merger api so that it uses real Branch, revision_id,
1782
and RevisonTree objects, rather than using revision specs.
1785
def __init__(self, this_tree, other_branch, other_tree, target_subdir,
1786
source_subpath, other_rev_id=None):
1787
"""Create a new MergeIntoMerger object.
1789
source_subpath in other_tree will be effectively copied to
1790
target_subdir in this_tree.
1792
:param this_tree: The tree that we will be merging into.
1793
:param other_branch: The Branch we will be merging from.
1794
:param other_tree: The RevisionTree object we want to merge.
1795
:param target_subdir: The relative path where we want to merge
1796
other_tree into this_tree
1797
:param source_subpath: The relative path specifying the subtree of
1798
other_tree to merge into this_tree.
1800
# It is assumed that we are merging a tree that is not in our current
1801
# ancestry, which means we are using the "EmptyTree" as our basis.
1802
null_ancestor_tree = this_tree.branch.repository.revision_tree(
1803
_mod_revision.NULL_REVISION)
1804
super(MergeIntoMerger, self).__init__(
1805
this_branch=this_tree.branch,
1806
this_tree=this_tree,
1807
other_tree=other_tree,
1808
base_tree=null_ancestor_tree,
1810
self._target_subdir = target_subdir
1811
self._source_subpath = source_subpath
1812
self.other_branch = other_branch
1813
if other_rev_id is None:
1814
other_rev_id = other_tree.get_revision_id()
1815
self.other_rev_id = self.other_basis = other_rev_id
1816
self.base_is_ancestor = True
1817
self.backup_files = True
1818
self.merge_type = Merge3Merger
1819
self.show_base = False
1820
self.reprocess = False
1821
self.interesting_files = None
1822
self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
1823
target_subdir=self._target_subdir,
1824
source_subpath=self._source_subpath)
1825
if self._source_subpath != '':
1826
# If this isn't a partial merge make sure the revisions will be
1828
self._maybe_fetch(self.other_branch, self.this_branch,
1831
def set_pending(self):
1832
if self._source_subpath != '':
1834
Merger.set_pending(self)
1837
class _MergeTypeParameterizer(object):
1838
"""Wrap a merge-type class to provide extra parameters.
1840
This is hack used by MergeIntoMerger to pass some extra parameters to its
1841
merge_type. Merger.do_merge() sets up its own set of parameters to pass to
1842
the 'merge_type' member. It is difficult override do_merge without
1843
re-writing the whole thing, so instead we create a wrapper which will pass
1844
the extra parameters.
1847
def __init__(self, merge_type, **kwargs):
1848
self._extra_kwargs = kwargs
1849
self._merge_type = merge_type
1851
def __call__(self, *args, **kwargs):
1852
kwargs.update(self._extra_kwargs)
1853
return self._merge_type(*args, **kwargs)
1855
def __getattr__(self, name):
1856
return getattr(self._merge_type, name)
1859
class MergeIntoMergeType(Merge3Merger):
1860
"""Merger that incorporates a tree (or part of a tree) into another."""
1862
def __init__(self, *args, **kwargs):
1863
"""Initialize the merger object.
1865
:param args: See Merge3Merger.__init__'s args.
1866
:param kwargs: See Merge3Merger.__init__'s keyword args, except for
1867
source_subpath and target_subdir.
1868
:keyword source_subpath: The relative path specifying the subtree of
1869
other_tree to merge into this_tree.
1870
:keyword target_subdir: The relative path where we want to merge
1871
other_tree into this_tree
1873
# All of the interesting work happens during Merge3Merger.__init__(),
1874
# so we have have to hack in to get our extra parameters set.
1875
self._source_subpath = kwargs.pop('source_subpath')
1876
self._target_subdir = kwargs.pop('target_subdir')
1877
super(MergeIntoMergeType, self).__init__(*args, **kwargs)
1879
def _compute_transform(self):
1880
with ui.ui_factory.nested_progress_bar() as child_pb:
1881
entries = self._entries_to_incorporate()
1882
entries = list(entries)
1883
for num, (entry, parent_id, relpath) in enumerate(entries):
1884
child_pb.update(gettext('Preparing file merge'), num, len(entries))
1885
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1886
path = osutils.pathjoin(self._source_subpath, relpath)
1887
trans_id = transform.new_by_entry(path, self.tt, entry,
1888
parent_trans_id, self.other_tree)
1889
self._finish_computing_transform()
1891
def _entries_to_incorporate(self):
1892
"""Yields pairs of (inventory_entry, new_parent)."""
1893
other_inv = self.other_tree.root_inventory
1894
subdir_id = other_inv.path2id(self._source_subpath)
1895
if subdir_id is None:
1896
# XXX: The error would be clearer if it gave the URL of the source
1897
# branch, but we don't have a reference to that here.
1898
raise PathNotInTree(self._source_subpath, "Source tree")
1899
subdir = other_inv.get_entry(subdir_id)
1900
parent_in_target = osutils.dirname(self._target_subdir)
1901
target_id = self.this_tree.path2id(parent_in_target)
1902
if target_id is None:
1903
raise PathNotInTree(self._target_subdir, "Target tree")
1904
name_in_target = osutils.basename(self._target_subdir)
1905
merge_into_root = subdir.copy()
1906
merge_into_root.name = name_in_target
1907
if self.this_tree.has_id(merge_into_root.file_id):
1908
# Give the root a new file-id.
1909
# This can happen fairly easily if the directory we are
1910
# incorporating is the root, and both trees have 'TREE_ROOT' as
1911
# their root_id. Users will expect this to Just Work, so we
1912
# change the file-id here.
1913
# Non-root file-ids could potentially conflict too. That's really
1914
# an edge case, so we don't do anything special for those. We let
1915
# them cause conflicts.
1916
merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
1917
yield (merge_into_root, target_id, '')
1918
if subdir.kind != 'directory':
1919
# No children, so we are done.
1921
for path, entry in other_inv.iter_entries_by_dir(subdir_id):
1922
parent_id = entry.parent_id
1923
if parent_id == subdir.file_id:
1924
# The root's parent ID has changed, so make sure children of
1925
# the root refer to the new ID.
1926
parent_id = merge_into_root.file_id
1927
yield (entry, parent_id, path)
1753
1930
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1754
1931
backup_files=False,
1755
1932
merge_type=Merge3Merger,
1756
interesting_ids=None,
1757
1933
show_base=False,
1758
1934
reprocess=False,
1759
1935
other_rev_id=None,
1760
1936
interesting_files=None,
1761
1937
this_tree=None,
1763
1938
change_reporter=None):
1764
1939
"""Primary interface for merging.
1766
typical use is probably
1767
'merge_inner(branch, branch.get_revision_tree(other_revision),
1768
branch.get_revision_tree(base_revision))'
1941
Typical use is probably::
1943
merge_inner(branch, branch.get_revision_tree(other_revision),
1944
branch.get_revision_tree(base_revision))
1770
1946
if this_tree is None:
1771
raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
1772
"parameter as of bzrlib version 0.8.")
1947
raise errors.BzrError("breezy.merge.merge_inner requires a this_tree "
1773
1949
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1774
pb=pb, change_reporter=change_reporter)
1950
change_reporter=change_reporter)
1775
1951
merger.backup_files = backup_files
1776
1952
merger.merge_type = merge_type
1777
merger.interesting_ids = interesting_ids
1778
1953
merger.ignore_zero = ignore_zero
1779
if interesting_files:
1781
raise ValueError('Only supply interesting_ids'
1782
' or interesting_files')
1783
merger.interesting_files = interesting_files
1954
merger.interesting_files = interesting_files
1784
1955
merger.show_base = show_base
1785
1956
merger.reprocess = reprocess
1786
1957
merger.other_rev_id = other_rev_id
added
removed
breezy/merge.py
