93
93
return ('not applicable', None)
96
class PerFileMerger(AbstractPerFileMerger):
97
"""Merge individual files when self.file_matches returns True.
99
This class is intended to be subclassed. The file_matches and
100
merge_matching methods should be overridden with concrete implementations.
103
def file_matches(self, params):
104
"""Return True if merge_matching should be called on this file.
106
Only called with merges of plain files with no clear winner.
108
Subclasses must override this.
110
raise NotImplementedError(self.file_matches)
112
def get_filename(self, params, tree):
113
"""Lookup the filename (i.e. basename, not path), given a Tree (e.g.
114
self.merger.this_tree) and a MergeHookParams.
116
return osutils.basename(tree.id2path(params.file_id))
118
def get_filepath(self, params, tree):
119
"""Calculate the path to the file in a tree.
121
:param params: A MergeHookParams describing the file to merge
122
:param tree: a Tree, e.g. self.merger.this_tree.
124
return tree.id2path(params.file_id)
126
def merge_contents(self, params):
127
"""Merge the contents of a single file."""
128
# Check whether this custom merge logic should be used.
130
# OTHER is a straight winner, rely on default merge.
131
params.winner == 'other' or
132
# THIS and OTHER aren't both files.
133
not params.is_file_merge() or
134
# The filename doesn't match *.xml
135
not self.file_matches(params)):
136
return 'not_applicable', None
137
return self.merge_matching(params)
139
def merge_matching(self, params):
140
"""Merge the contents of a single file that has matched the criteria
141
in PerFileMerger.merge_contents (is a conflict, is a file,
142
self.file_matches is True).
144
Subclasses must override this.
146
raise NotImplementedError(self.merge_matching)
149
class ConfigurableFileMerger(PerFileMerger):
96
class ConfigurableFileMerger(AbstractPerFileMerger):
150
97
"""Merge individual files when configured via a .conf file.
152
99
This is a base class for concrete custom file merging logic. Concrete
175
122
if self.name_prefix is None:
176
123
raise ValueError("name_prefix must be set.")
178
def file_matches(self, params):
125
def filename_matches_config(self, params):
179
126
"""Check whether the file should call the merge hook.
181
128
<name_prefix>_merge_files configuration variable is a list of files
184
131
affected_files = self.affected_files
185
132
if affected_files is None:
186
config = self.merger.this_branch.get_config()
133
config = self.merger.this_tree.branch.get_config()
187
134
# Until bzr provides a better policy for caching the config, we
188
135
# just add the part we're interested in to the params to avoid
189
136
# reading the config files repeatedly (bazaar.conf, location.conf,
195
142
affected_files = self.default_files
196
143
self.affected_files = affected_files
197
144
if affected_files:
198
filepath = self.get_filepath(params, self.merger.this_tree)
199
if filepath in affected_files:
145
filename = self.merger.this_tree.id2path(params.file_id)
146
if filename in affected_files:
203
def merge_matching(self, params):
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
204
163
return self.merge_text(params)
206
165
def merge_text(self, params):
634
594
'other_tree': self.other_tree,
635
595
'interesting_ids': self.interesting_ids,
636
596
'interesting_files': self.interesting_files,
637
'this_branch': self.this_branch,
597
'pp': self.pp, 'this_branch': self.this_branch,
638
598
'do_merge': False}
639
599
if self.merge_type.requires_base:
640
600
kwargs['base_tree'] = self.base_tree
658
618
if self._is_criss_cross and getattr(self.merge_type,
659
619
'supports_lca_trees', False):
660
620
kwargs['lca_trees'] = self._lca_trees
661
return self.merge_type(pb=None,
621
return self.merge_type(pb=self._pb,
662
622
change_reporter=self.change_reporter,
737
697
def __init__(self, working_tree, this_tree, base_tree, other_tree,
738
698
interesting_ids=None, reprocess=False, show_base=False,
739
pb=None, pp=None, change_reporter=None,
699
pb=progress.DummyProgress(), pp=None, change_reporter=None,
740
700
interesting_files=None, do_merge=True,
741
701
cherrypick=False, lca_trees=None, this_branch=None):
742
702
"""Initialize the merger object and perform the merge.
745
705
:param this_tree: The local tree in the merge operation
746
706
:param base_tree: The common tree in the merge operation
747
707
:param other_tree: The other tree to merge changes from
748
:param this_branch: The branch associated with this_tree. Defaults to
749
this_tree.branch if not supplied.
708
:param this_branch: The branch associated with this_tree
750
709
:param interesting_ids: The file_ids of files that should be
751
710
participate in the merge. May not be combined with
752
711
interesting_files.
753
712
:param: reprocess If True, perform conflict-reduction processing.
754
713
:param show_base: If True, show the base revision in text conflicts.
755
714
(incompatible with reprocess)
715
:param pb: A Progress bar
757
716
:param pp: A ProgressPhase object
758
717
:param change_reporter: An object that should report changes made
759
718
:param interesting_files: The tree-relative paths of files that should
788
745
# making sure we haven't missed any corner cases.
789
746
# if lca_trees is None:
790
747
# self._lca_trees = [self.base_tree]
791
750
self.change_reporter = change_reporter
792
751
self.cherrypick = cherrypick
753
self.pp = progress.ProgressPhase("Merge phase", 3, self.pb)
796
warnings.warn("pp argument to Merge3Merger is deprecated")
798
warnings.warn("pb argument to Merge3Merger is deprecated")
800
757
def do_merge(self):
801
758
operation = OperationWithCleanups(self._do_merge)
759
operation.add_cleanup(self.pb.clear)
802
760
self.this_tree.lock_tree_write()
803
761
operation.add_cleanup(self.this_tree.unlock)
804
762
self.base_tree.lock_read()
810
768
def _do_merge(self, operation):
811
self.tt = transform.TreeTransform(self.this_tree, None)
769
self.tt = transform.TreeTransform(self.this_tree, self.pb)
812
770
operation.add_cleanup(self.tt.finalize)
813
772
self._compute_transform()
814
774
results = self.tt.apply(no_conflicts=True)
815
775
self.write_modified(results)
1086
1051
other_root = self.tt.trans_id_file_id(other_root_file_id)
1087
1052
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
1055
self.tt.final_kind(other_root)
1095
other_root_is_present = True
1096
1056
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():
1058
if self.this_tree.has_id(self.other_tree.inventory.root.file_id):
1059
# the other tree's root is a non-root in the current tree
1061
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
1062
self.tt.cancel_creation(other_root)
1063
self.tt.cancel_versioning(other_root)
1065
def reparent_children(self, ie, target):
1066
for thing, child in ie.children.iteritems():
1104
1067
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)
1068
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
1122
1070
def write_modified(self, results):
1123
1071
modified_hashes = {}
1172
1120
def _three_way(base, other, this):
1121
#if base == other, either they all agree, or only THIS has changed.
1173
1122
if base == other:
1174
# if 'base == other', either they all agree, or only 'this' has
1177
1124
elif this not in (base, other):
1178
# 'this' is neither 'base' nor 'other', so both sides changed
1179
1125
return 'conflict'
1126
# "Ambiguous clean merge" -- both sides have made the same change.
1180
1127
elif this == other:
1181
# "Ambiguous clean merge" -- both sides have made the same change.
1129
# this == base: only other has changed.
1184
# this == base: only other has changed.
1231
1177
# only has an lca value
1234
# At this point, the lcas disagree, and the tip disagree
1180
# At this point, the lcas disagree, and the tips disagree
1235
1181
return 'conflict'
1238
@deprecated_method(deprecated_in((2, 2, 0)))
1239
1184
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
1240
1185
"""Do a three-way test on a scalar.
1241
1186
Return "this", "other" or "conflict", depending whether a value wins.
1291
1236
parent_id_winner = "other"
1292
1237
if name_winner == "this" and parent_id_winner == "this":
1294
if name_winner == 'conflict' or parent_id_winner == 'conflict':
1295
# Creating helpers (.OTHER or .THIS) here cause problems down the
1296
# road if a ContentConflict needs to be created so we should not do
1298
trans_id = self.tt.trans_id_file_id(file_id)
1299
self._raw_conflicts.append(('path conflict', trans_id, file_id,
1300
this_parent, this_name,
1301
other_parent, other_name))
1239
if name_winner == "conflict":
1240
trans_id = self.tt.trans_id_file_id(file_id)
1241
self._raw_conflicts.append(('name conflict', trans_id,
1242
this_name, other_name))
1243
if parent_id_winner == "conflict":
1244
trans_id = self.tt.trans_id_file_id(file_id)
1245
self._raw_conflicts.append(('parent conflict', trans_id,
1246
this_parent, other_parent))
1302
1247
if other_name is None:
1303
1248
# it doesn't matter whether the result was 'other' or
1304
1249
# 'conflict'-- if there's no 'other', we leave it alone.
1251
# if we get here, name_winner and parent_winner are set to safe values.
1252
trans_id = self.tt.trans_id_file_id(file_id)
1306
1253
parent_id = parents[self.winner_idx[parent_id_winner]]
1307
1254
if parent_id is not None:
1308
# if we get here, name_winner and parent_winner are set to safe
1255
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1310
1256
self.tt.adjust_path(names[self.winner_idx[name_winner]],
1311
self.tt.trans_id_file_id(parent_id),
1312
self.tt.trans_id_file_id(file_id))
1257
parent_trans_id, trans_id)
1314
1259
def _do_merge_contents(self, file_id):
1315
1260
"""Performs a merge on file_id contents."""
1595
1540
def cook_conflicts(self, fs_conflicts):
1596
1541
"""Convert all conflicts into a form that doesn't depend on trans_id"""
1597
1543
self.cooked_conflicts.extend(transform.cook_conflicts(
1598
1544
fs_conflicts, self.tt))
1599
1545
fp = transform.FinalPaths(self.tt)
1600
1546
for conflict in self._raw_conflicts:
1601
1547
conflict_type = conflict[0]
1602
if conflict_type == 'path conflict':
1604
this_parent, this_name,
1605
other_parent, other_name) = conflict[1:]
1606
if this_parent is None or this_name is None:
1607
this_path = '<deleted>'
1609
parent_path = fp.get_path(
1610
self.tt.trans_id_file_id(this_parent))
1611
this_path = osutils.pathjoin(parent_path, this_name)
1612
if other_parent is None or other_name is None:
1613
other_path = '<deleted>'
1615
parent_path = fp.get_path(
1616
self.tt.trans_id_file_id(other_parent))
1617
other_path = osutils.pathjoin(parent_path, other_name)
1618
c = _mod_conflicts.Conflict.factory(
1619
'path conflict', path=this_path,
1620
conflict_path=other_path,
1622
elif conflict_type == 'contents conflict':
1548
if conflict_type in ('name conflict', 'parent conflict'):
1549
trans_id = conflict[1]
1550
conflict_args = conflict[2:]
1551
if trans_id not in name_conflicts:
1552
name_conflicts[trans_id] = {}
1553
transform.unique_add(name_conflicts[trans_id], conflict_type,
1555
if conflict_type == 'contents conflict':
1623
1556
for trans_id in conflict[1]:
1624
1557
file_id = self.tt.final_file_id(trans_id)
1625
1558
if file_id is not None:
1632
1565
c = _mod_conflicts.Conflict.factory(conflict_type,
1633
1566
path=path, file_id=file_id)
1634
elif conflict_type == 'text conflict':
1567
self.cooked_conflicts.append(c)
1568
if conflict_type == 'text conflict':
1635
1569
trans_id = conflict[1]
1636
1570
path = fp.get_path(trans_id)
1637
1571
file_id = self.tt.final_file_id(trans_id)
1638
1572
c = _mod_conflicts.Conflict.factory(conflict_type,
1639
1573
path=path, file_id=file_id)
1574
self.cooked_conflicts.append(c)
1576
for trans_id, conflicts in name_conflicts.iteritems():
1578
this_parent, other_parent = conflicts['parent conflict']
1579
if this_parent == other_parent:
1580
raise AssertionError()
1582
this_parent = other_parent = \
1583
self.tt.final_file_id(self.tt.final_parent(trans_id))
1585
this_name, other_name = conflicts['name conflict']
1586
if this_name == other_name:
1587
raise AssertionError()
1589
this_name = other_name = self.tt.final_name(trans_id)
1590
other_path = fp.get_path(trans_id)
1591
if this_parent is not None and this_name is not None:
1592
this_parent_path = \
1593
fp.get_path(self.tt.trans_id_file_id(this_parent))
1594
this_path = osutils.pathjoin(this_parent_path, this_name)
1641
raise AssertionError('bad conflict type: %r' % (conflict,))
1596
this_path = "<deleted>"
1597
file_id = self.tt.final_file_id(trans_id)
1598
c = _mod_conflicts.Conflict.factory('path conflict', path=this_path,
1599
conflict_path=other_path,
1642
1601
self.cooked_conflicts.append(c)
1643
1602
self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
added
removed
bzrlib/merge.py
