14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
19
21
from bzrlib.lazy_import import lazy_import
74
78
"See the AbstractPerFileMerger API docs for details on how it is "
81
self.add_hook('pre_merge',
82
'Called before a merge. '
83
'Receives a Merger object as the single argument.',
85
self.add_hook('post_merge',
86
'Called after a merge. '
87
'Receives a Merger object as the single argument. '
88
'The return value is ignored.',
79
92
class AbstractPerFileMerger(object):
91
104
def merge_contents(self, merge_params):
92
105
"""Attempt to merge the contents of a single file.
94
:param merge_params: A bzrlib.merge.MergeHookParams
107
:param merge_params: A bzrlib.merge.MergeFileHookParams
95
108
:return: A tuple of (status, chunks), where status is one of
96
109
'not_applicable', 'success', 'conflicted', or 'delete'. If status
97
110
is 'success' or 'conflicted', then chunks should be an iterable of
119
132
def get_filename(self, params, tree):
120
133
"""Lookup the filename (i.e. basename, not path), given a Tree (e.g.
121
self.merger.this_tree) and a MergeHookParams.
134
self.merger.this_tree) and a MergeFileHookParams.
123
136
return osutils.basename(tree.id2path(params.file_id))
125
138
def get_filepath(self, params, tree):
126
139
"""Calculate the path to the file in a tree.
128
:param params: A MergeHookParams describing the file to merge
141
:param params: A MergeFileHookParams describing the file to merge
129
142
:param tree: a Tree, e.g. self.merger.this_tree.
131
144
return tree.id2path(params.file_id)
138
151
params.winner == 'other' or
139
152
# THIS and OTHER aren't both files.
140
153
not params.is_file_merge() or
141
# The filename doesn't match *.xml
154
# The filename doesn't match
142
155
not self.file_matches(params)):
143
156
return 'not_applicable', None
144
157
return self.merge_matching(params)
441
454
revision_id = _mod_revision.ensure_null(revision_id)
442
455
return branch, self.revision_tree(revision_id, branch)
444
@deprecated_method(deprecated_in((2, 1, 0)))
445
def ensure_revision_trees(self):
446
if self.this_revision_tree is None:
447
self.this_basis_tree = self.revision_tree(self.this_basis)
448
if self.this_basis == self.this_rev_id:
449
self.this_revision_tree = self.this_basis_tree
451
if self.other_rev_id is None:
452
other_basis_tree = self.revision_tree(self.other_basis)
453
if other_basis_tree.has_changes(self.other_tree):
454
raise errors.WorkingTreeNotRevision(self.this_tree)
455
other_rev_id = self.other_basis
456
self.other_tree = other_basis_tree
458
@deprecated_method(deprecated_in((2, 1, 0)))
459
def file_revisions(self, file_id):
460
self.ensure_revision_trees()
461
if self.this_rev_id is None:
462
if self.this_basis_tree.get_file_sha1(file_id) != \
463
self.this_tree.get_file_sha1(file_id):
464
raise errors.WorkingTreeNotRevision(self.this_tree)
466
trees = (self.this_basis_tree, self.other_tree)
467
return [tree.get_file_revision(file_id) for tree in trees]
469
@deprecated_method(deprecated_in((2, 1, 0)))
470
def check_basis(self, check_clean, require_commits=True):
471
if self.this_basis is None and require_commits is True:
472
raise errors.BzrCommandError(
473
"This branch has no commits."
474
" (perhaps you would prefer 'bzr pull')")
477
if self.this_basis != self.this_rev_id:
478
raise errors.UncommittedChanges(self.this_tree)
480
@deprecated_method(deprecated_in((2, 1, 0)))
481
def compare_basis(self):
483
basis_tree = self.revision_tree(self.this_tree.last_revision())
484
except errors.NoSuchRevision:
485
basis_tree = self.this_tree.basis_tree()
486
if not self.this_tree.has_changes(basis_tree):
487
self.this_rev_id = self.this_basis
489
457
def set_interesting_files(self, file_list):
490
458
self.interesting_files = file_list
536
504
raise errors.NoCommits(self.other_branch)
537
505
if self.other_rev_id is not None:
538
506
self._cached_trees[self.other_rev_id] = self.other_tree
539
self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
507
self._maybe_fetch(self.other_branch, self.this_branch, self.other_basis)
541
509
def set_other_revision(self, revision_id, other_branch):
542
510
"""Set 'other' based on a branch and revision id
644
612
self._maybe_fetch(base_branch, self.this_branch, self.base_rev_id)
646
614
def make_merger(self):
647
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
615
kwargs = {'working_tree': self.this_tree, 'this_tree': self.this_tree,
648
616
'other_tree': self.other_tree,
649
617
'interesting_ids': self.interesting_ids,
650
618
'interesting_files': self.interesting_files,
651
619
'this_branch': self.this_branch,
620
'other_branch': self.other_branch,
652
621
'do_merge': False}
653
622
if self.merge_type.requires_base:
654
623
kwargs['base_tree'] = self.base_tree
680
649
merge = self.make_merger()
681
650
if self.other_branch is not None:
682
651
self.other_branch.update_references(self.this_branch)
652
for hook in Merger.hooks['pre_merge']:
655
for hook in Merger.hooks['post_merge']:
684
657
if self.recurse == 'down':
685
658
for relpath, file_id in self.this_tree.iter_references():
686
659
sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
713
686
merge = operation.run_simple()
714
687
if len(merge.cooked_conflicts) == 0:
715
688
if not self.ignore_zero and not trace.is_quiet():
716
trace.note("All changes applied successfully.")
689
trace.note(gettext("All changes applied successfully."))
718
trace.note("%d conflicts encountered."
691
trace.note(gettext("%d conflicts encountered.")
719
692
% len(merge.cooked_conflicts))
721
694
return len(merge.cooked_conflicts)
753
726
interesting_ids=None, reprocess=False, show_base=False,
754
727
pb=None, pp=None, change_reporter=None,
755
728
interesting_files=None, do_merge=True,
756
cherrypick=False, lca_trees=None, this_branch=None):
729
cherrypick=False, lca_trees=None, this_branch=None,
757
731
"""Initialize the merger object and perform the merge.
759
733
:param working_tree: The working tree to apply the merge to
762
736
:param other_tree: The other tree to merge changes from
763
737
:param this_branch: The branch associated with this_tree. Defaults to
764
738
this_tree.branch if not supplied.
739
:param other_branch: The branch associated with other_tree, if any.
765
740
:param interesting_ids: The file_ids of files that should be
766
741
participate in the merge. May not be combined with
767
742
interesting_files.
789
764
this_branch = this_tree.branch
790
765
self.interesting_ids = interesting_ids
791
766
self.interesting_files = interesting_files
792
self.this_tree = working_tree
767
self.working_tree = working_tree
768
self.this_tree = this_tree
793
769
self.base_tree = base_tree
794
770
self.other_tree = other_tree
795
771
self.this_branch = this_branch
772
self.other_branch = other_branch
796
773
self._raw_conflicts = []
797
774
self.cooked_conflicts = []
798
775
self.reprocess = reprocess
815
792
def do_merge(self):
816
793
operation = cleanup.OperationWithCleanups(self._do_merge)
817
self.this_tree.lock_tree_write()
794
self.working_tree.lock_tree_write()
795
operation.add_cleanup(self.working_tree.unlock)
796
self.this_tree.lock_read()
818
797
operation.add_cleanup(self.this_tree.unlock)
819
798
self.base_tree.lock_read()
820
799
operation.add_cleanup(self.base_tree.unlock)
825
804
def _do_merge(self, operation):
826
self.tt = transform.TreeTransform(self.this_tree, None)
805
self.tt = transform.TreeTransform(self.working_tree, None)
827
806
operation.add_cleanup(self.tt.finalize)
828
807
self._compute_transform()
829
808
results = self.tt.apply(no_conflicts=True)
830
809
self.write_modified(results)
832
self.this_tree.add_conflicts(self.cooked_conflicts)
811
self.working_tree.add_conflicts(self.cooked_conflicts)
833
812
except errors.UnsupportedOperation:
854
833
entries = self._entries_lca()
855
834
resolver = self._lca_multi_way
835
# Prepare merge hooks
836
factories = Merger.hooks['merge_file_content']
837
# One hook for each registered one plus our default merger
838
hooks = [factory(self) for factory in factories] + [self]
839
self.active_hooks = [hook for hook in hooks if hook is not None]
856
840
child_pb = ui.ui_factory.nested_progress_bar()
858
factories = Merger.hooks['merge_file_content']
859
hooks = [factory(self) for factory in factories] + [self]
860
self.active_hooks = [hook for hook in hooks if hook is not None]
861
842
for num, (file_id, changed, parents3, names3,
862
843
executable3) in enumerate(entries):
863
child_pb.update('Preparing file merge', num, len(entries))
844
# Try merging each entry
845
child_pb.update(gettext('Preparing file merge'),
864
847
self._merge_names(file_id, parents3, names3, resolver=resolver)
866
849
file_status = self._do_merge_contents(file_id)
958
941
walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
960
base_inventory = self.base_tree.inventory
961
this_inventory = self.this_tree.inventory
943
base_inventory = self.base_tree.root_inventory
944
this_inventory = self.this_tree.root_inventory
962
945
for path, file_id, other_ie, lca_values in walker.iter_all():
963
946
# Is this modified at all from any of the other trees?
964
947
if other_ie is None:
1098
@deprecated_method(deprecated_in((2, 4, 0)))
1100
if self.tt.final_kind(self.tt.root) is None:
1101
self.tt.cancel_deletion(self.tt.root)
1102
if self.tt.final_file_id(self.tt.root) is None:
1103
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
1105
other_root_file_id = self.other_tree.get_root_id()
1106
if other_root_file_id is None:
1108
other_root = self.tt.trans_id_file_id(other_root_file_id)
1109
if other_root == self.tt.root:
1111
if self.this_tree.inventory.has_id(
1112
self.other_tree.inventory.root.file_id):
1113
# the other tree's root is a non-root in the current tree (as
1114
# when a previously unrelated branch is merged into another)
1116
if self.tt.final_kind(other_root) is not None:
1117
other_root_is_present = True
1119
# other_root doesn't have a physical representation. We still need
1120
# to move any references to the actual root of the tree.
1121
other_root_is_present = False
1122
# 'other_tree.inventory.root' is not present in this tree. We are
1123
# calling adjust_path for children which *want* to be present with a
1124
# correct place to go.
1125
for _, child in self.other_tree.inventory.root.children.iteritems():
1126
trans_id = self.tt.trans_id_file_id(child.file_id)
1127
if not other_root_is_present:
1128
if self.tt.final_kind(trans_id) is not None:
1129
# The item exist in the final tree and has a defined place
1132
# Move the item into the root
1134
final_name = self.tt.final_name(trans_id)
1135
except errors.NoFinalPath:
1136
# This file is not present anymore, ignore it.
1138
self.tt.adjust_path(final_name, self.tt.root, trans_id)
1139
if other_root_is_present:
1140
self.tt.cancel_creation(other_root)
1141
self.tt.cancel_versioning(other_root)
1143
1081
def write_modified(self, results):
1144
1082
modified_hashes = {}
1145
1083
for path in results.modified_paths:
1146
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
1084
file_id = self.working_tree.path2id(self.working_tree.relpath(path))
1147
1085
if file_id is None:
1149
hash = self.this_tree.get_file_sha1(file_id)
1087
hash = self.working_tree.get_file_sha1(file_id)
1150
1088
if hash is None:
1152
1090
modified_hashes[file_id] = hash
1153
self.this_tree.set_merge_modified(modified_hashes)
1091
self.working_tree.set_merge_modified(modified_hashes)
1156
1094
def parent(entry, file_id):
1255
1193
# At this point, the lcas disagree, and the tip disagree
1256
1194
return 'conflict'
1259
@deprecated_method(deprecated_in((2, 2, 0)))
1260
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
1261
"""Do a three-way test on a scalar.
1262
Return "this", "other" or "conflict", depending whether a value wins.
1264
key_base = key(base_tree, file_id)
1265
key_other = key(other_tree, file_id)
1266
#if base == other, either they all agree, or only THIS has changed.
1267
if key_base == key_other:
1269
key_this = key(this_tree, file_id)
1270
# "Ambiguous clean merge"
1271
if key_this == key_other:
1273
elif key_this == key_base:
1278
1196
def merge_names(self, file_id):
1279
1197
def get_entry(tree):
1280
if tree.has_id(file_id):
1281
return tree.inventory[file_id]
1199
return tree.root_inventory[file_id]
1200
except errors.NoSuchId:
1284
1202
this_entry = get_entry(self.this_tree)
1285
1203
other_entry = get_entry(self.other_tree)
1380
1298
# We have a hypothetical conflict, but if we have files, then we
1381
1299
# can try to merge the content
1382
1300
trans_id = self.tt.trans_id_file_id(file_id)
1383
params = MergeHookParams(self, file_id, trans_id, this_pair[0],
1301
params = MergeFileHookParams(self, file_id, trans_id, this_pair[0],
1384
1302
other_pair[0], winner)
1385
1303
hooks = self.active_hooks
1386
1304
hook_status = 'not_applicable'
1947
1865
entries = self._entries_to_incorporate()
1948
1866
entries = list(entries)
1949
1867
for num, (entry, parent_id) in enumerate(entries):
1950
child_pb.update('Preparing file merge', num, len(entries))
1868
child_pb.update(gettext('Preparing file merge'), num, len(entries))
1951
1869
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1952
1870
trans_id = transform.new_by_entry(self.tt, entry,
1953
1871
parent_trans_id, self.other_tree)
1958
1876
def _entries_to_incorporate(self):
1959
1877
"""Yields pairs of (inventory_entry, new_parent)."""
1960
other_inv = self.other_tree.inventory
1878
other_inv = self.other_tree.root_inventory
1961
1879
subdir_id = other_inv.path2id(self._source_subpath)
1962
1880
if subdir_id is None:
1963
1881
# XXX: The error would be clearer if it gave the URL of the source
1965
1883
raise PathNotInTree(self._source_subpath, "Source tree")
1966
1884
subdir = other_inv[subdir_id]
1967
1885
parent_in_target = osutils.dirname(self._target_subdir)
1968
target_id = self.this_tree.inventory.path2id(parent_in_target)
1886
target_id = self.this_tree.path2id(parent_in_target)
1969
1887
if target_id is None:
1970
1888
raise PathNotInTree(self._target_subdir, "Target tree")
1971
1889
name_in_target = osutils.basename(self._target_subdir)
1972
1890
merge_into_root = subdir.copy()
1973
1891
merge_into_root.name = name_in_target
1974
if self.this_tree.inventory.has_id(merge_into_root.file_id):
1892
if self.this_tree.has_id(merge_into_root.file_id):
1975
1893
# Give the root a new file-id.
1976
1894
# This can happen fairly easily if the directory we are
1977
1895
# incorporating is the root, and both trees have 'TREE_ROOT' as
2037
1955
merger.set_base_revision(get_revision_id(), this_branch)
2038
1956
return merger.do_merge()
1959
merge_type_registry = registry.Registry()
1960
merge_type_registry.register('diff3', Diff3Merger,
1961
"Merge using external diff3.")
1962
merge_type_registry.register('lca', LCAMerger,
1963
"LCA-newness merge.")
1964
merge_type_registry.register('merge3', Merge3Merger,
1965
"Native diff3-style merge.")
1966
merge_type_registry.register('weave', WeaveMerger,
1967
"Weave-based merge.")
2040
1970
def get_merge_type_registry():
2041
"""Merge type registry is in bzrlib.option to avoid circular imports.
1971
"""Merge type registry was previously in bzrlib.option
2043
This method provides a sanctioned way to retrieve it.
1973
This method provides a backwards compatible way to retrieve it.
2045
from bzrlib import option
2046
return option._merge_type_registry
1975
return merge_type_registry
2049
1978
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
added
removed
bzrlib/merge.py
