1091
1092
InterTree.register_optimiser(InterTree)
1094
class MultiWalker(object):
1095
"""Walk multiple trees simultaneously, getting combined results."""
1097
# Note: This could be written to not assume you can do out-of-order
1098
# lookups. Instead any nodes that don't match in all trees could be
1099
# marked as 'deferred', and then returned in the final cleanup loop.
1100
# For now, I think it is "nicer" to return things as close to the
1101
# "master_tree" order as we can.
1103
def __init__(self, master_tree, other_trees):
1104
"""Create a new MultiWalker.
1106
All trees being walked must implement "iter_entries_by_dir()", such
1107
that they yield (path, object) tuples, where that object will have a
1108
'.file_id' member, that can be used to check equality.
1110
:param master_tree: All trees will be 'slaved' to the master_tree such
1111
that nodes in master_tree will be used as 'first-pass' sync points.
1112
Any nodes that aren't in master_tree will be merged in a second
1114
:param other_trees: A list of other trees to walk simultaneously.
1116
self._master_tree = master_tree
1117
self._other_trees = other_trees
1119
# Keep track of any nodes that were properly processed just out of
1120
# order, that way we don't return them at the end, we don't have to
1121
# track *all* processed file_ids, just the out-of-order ones
1122
self._out_of_order_processed = set()
1125
def _step_one(iterator):
1126
"""Step an iter_entries_by_dir iterator.
1128
:return: (has_more, path, ie)
1129
If has_more is False, path and ie will be None.
1132
path, ie = next(iterator)
1133
except StopIteration:
1134
return False, None, None
1136
return True, path, ie
1139
def _lt_path_by_dirblock(path1, path2):
1140
"""Compare two paths based on what directory they are in.
1142
This generates a sort order, such that all children of a directory are
1143
sorted together, and grandchildren are in the same order as the
1144
children appear. But all grandchildren come after all children.
1146
:param path1: first path
1147
:param path2: the second path
1148
:return: negative number if ``path1`` comes first,
1149
0 if paths are equal
1150
and a positive number if ``path2`` sorts first
1152
# Shortcut this special case
1155
# This is stolen from _dirstate_helpers_py.py, only switching it to
1156
# Unicode objects. Consider using encode_utf8() and then using the
1157
# optimized versions, or maybe writing optimized unicode versions.
1158
if not isinstance(path1, text_type):
1159
raise TypeError("'path1' must be a unicode string, not %s: %r"
1160
% (type(path1), path1))
1161
if not isinstance(path2, text_type):
1162
raise TypeError("'path2' must be a unicode string, not %s: %r"
1163
% (type(path2), path2))
1164
return (MultiWalker._path_to_key(path1) <
1165
MultiWalker._path_to_key(path2))
1168
def _path_to_key(path):
1169
dirname, basename = osutils.split(path)
1170
return (dirname.split(u'/'), basename)
1172
def _lookup_by_file_id(self, extra_entries, other_tree, file_id):
1173
"""Lookup an inventory entry by file_id.
1175
This is called when an entry is missing in the normal order.
1176
Generally this is because a file was either renamed, or it was
1177
deleted/added. If the entry was found in the inventory and not in
1178
extra_entries, it will be added to self._out_of_order_processed
1180
:param extra_entries: A dictionary of {file_id: (path, ie)}. This
1181
should be filled with entries that were found before they were
1182
used. If file_id is present, it will be removed from the
1184
:param other_tree: The Tree to search, in case we didn't find the entry
1186
:param file_id: The file_id to look for
1187
:return: (path, ie) if found or (None, None) if not present.
1189
if file_id in extra_entries:
1190
return extra_entries.pop(file_id)
1191
# TODO: Is id2path better as the first call, or is
1192
# inventory[file_id] better as a first check?
1194
cur_path = other_tree.id2path(file_id)
1195
except errors.NoSuchId:
1197
if cur_path is None:
1200
self._out_of_order_processed.add(file_id)
1201
cur_ie = other_tree.root_inventory.get_entry(file_id)
1202
return (cur_path, cur_ie)
1205
"""Match up the values in the different trees."""
1206
for result in self._walk_master_tree():
1208
self._finish_others()
1209
for result in self._walk_others():
1212
def _walk_master_tree(self):
1213
"""First pass, walk all trees in lock-step.
1215
When we are done, all nodes in the master_tree will have been
1216
processed. _other_walkers, _other_entries, and _others_extra will be
1217
set on 'self' for future processing.
1219
# This iterator has the most "inlining" done, because it tends to touch
1220
# every file in the tree, while the others only hit nodes that don't
1222
master_iterator = self._master_tree.iter_entries_by_dir()
1224
other_walkers = [other.iter_entries_by_dir()
1225
for other in self._other_trees]
1226
other_entries = [self._step_one(walker) for walker in other_walkers]
1227
# Track extra nodes in the other trees
1228
others_extra = [{} for _ in range(len(self._other_trees))]
1230
master_has_more = True
1231
step_one = self._step_one
1232
lookup_by_file_id = self._lookup_by_file_id
1233
out_of_order_processed = self._out_of_order_processed
1235
while master_has_more:
1236
(master_has_more, path, master_ie) = step_one(master_iterator)
1237
if not master_has_more:
1240
file_id = master_ie.file_id
1242
other_values_append = other_values.append
1243
next_other_entries = []
1244
next_other_entries_append = next_other_entries.append
1245
for idx, (other_has_more, other_path, other_ie) in enumerate(other_entries):
1246
if not other_has_more:
1247
other_values_append(lookup_by_file_id(
1248
others_extra[idx], self._other_trees[idx], file_id))
1249
next_other_entries_append((False, None, None))
1250
elif file_id == other_ie.file_id:
1251
# This is the critical code path, as most of the entries
1252
# should match between most trees.
1253
other_values_append((other_path, other_ie))
1254
next_other_entries_append(step_one(other_walkers[idx]))
1256
# This walker did not match, step it until it either
1257
# matches, or we know we are past the current walker.
1258
other_walker = other_walkers[idx]
1259
other_extra = others_extra[idx]
1260
while (other_has_more and
1261
self._lt_path_by_dirblock(other_path, path)):
1262
other_file_id = other_ie.file_id
1263
if other_file_id not in out_of_order_processed:
1264
other_extra[other_file_id] = (other_path, other_ie)
1265
other_has_more, other_path, other_ie = \
1266
step_one(other_walker)
1267
if other_has_more and other_ie.file_id == file_id:
1268
# We ended up walking to this point, match and step
1270
other_values_append((other_path, other_ie))
1271
other_has_more, other_path, other_ie = \
1272
step_one(other_walker)
1274
# This record isn't in the normal order, see if it
1276
other_values_append(lookup_by_file_id(
1277
other_extra, self._other_trees[idx], file_id))
1278
next_other_entries_append((other_has_more, other_path,
1280
other_entries = next_other_entries
1282
# We've matched all the walkers, yield this datapoint
1283
yield path, file_id, master_ie, other_values
1284
self._other_walkers = other_walkers
1285
self._other_entries = other_entries
1286
self._others_extra = others_extra
1288
def _finish_others(self):
1289
"""Finish walking the other iterators, so we get all entries."""
1290
for idx, info in enumerate(self._other_entries):
1291
other_extra = self._others_extra[idx]
1292
(other_has_more, other_path, other_ie) = info
1293
while other_has_more:
1294
other_file_id = other_ie.file_id
1295
if other_file_id not in self._out_of_order_processed:
1296
other_extra[other_file_id] = (other_path, other_ie)
1297
other_has_more, other_path, other_ie = \
1298
self._step_one(self._other_walkers[idx])
1299
del self._other_entries
1301
def _walk_others(self):
1302
"""Finish up by walking all the 'deferred' nodes."""
1303
# TODO: One alternative would be to grab all possible unprocessed
1304
# file_ids, and then sort by path, and then yield them. That
1305
# might ensure better ordering, in case a caller strictly
1306
# requires parents before children.
1307
for idx, other_extra in enumerate(self._others_extra):
1308
others = sorted(viewvalues(other_extra),
1309
key=lambda x: self._path_to_key(x[0]))
1310
for other_path, other_ie in others:
1311
file_id = other_ie.file_id
1312
# We don't need to check out_of_order_processed here, because
1313
# the lookup_by_file_id will be removing anything processed
1314
# from the extras cache
1315
other_extra.pop(file_id)
1316
other_values = [(None, None)] * idx
1317
other_values.append((other_path, other_ie))
1318
for alt_idx, alt_extra in enumerate(self._others_extra[idx + 1:]):
1319
alt_idx = alt_idx + idx + 1
1320
alt_extra = self._others_extra[alt_idx]
1321
alt_tree = self._other_trees[alt_idx]
1322
other_values.append(self._lookup_by_file_id(
1323
alt_extra, alt_tree, file_id))
1324
yield other_path, file_id, None, other_values
1327
1095
def find_previous_paths(from_tree, to_tree, paths):
1328
1096
"""Find previous tree paths.