1
# Copyright (C) 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
from bzrlib.inventory import InventoryEntry
18
from bzrlib.trace import mutter
19
from bzrlib.symbol_versioning import deprecated_function, zero_nine
22
class TreeDelta(object):
23
"""Describes changes from one tree to another.
32
(oldpath, newpath, id, kind, text_modified, meta_modified)
34
(path, id, kind, text_modified, meta_modified)
38
Each id is listed only once.
40
Files that are both modified and renamed are listed only in
41
renamed, with the text_modified flag true. The text_modified
42
applies either to the the content of the file or the target of the
43
symbolic link, depending of the kind of file.
45
Files are only considered renamed if their name has changed or
46
their parent directory has changed. Renaming a directory
47
does not count as renaming all its contents.
49
The lists are normally sorted when the delta is created.
58
def __eq__(self, other):
59
if not isinstance(other, TreeDelta):
61
return self.added == other.added \
62
and self.removed == other.removed \
63
and self.renamed == other.renamed \
64
and self.modified == other.modified \
65
and self.unchanged == other.unchanged
67
def __ne__(self, other):
68
return not (self == other)
71
return "TreeDelta(added=%r, removed=%r, renamed=%r, modified=%r," \
72
" unchanged=%r)" % (self.added, self.removed, self.renamed,
73
self.modified, self.unchanged)
75
def has_changed(self):
76
return bool(self.modified
81
def touches_file_id(self, file_id):
82
"""Return True if file_id is modified by this delta."""
83
for l in self.added, self.removed, self.modified:
87
for v in self.renamed:
93
def show(self, to_file, show_ids=False, show_unchanged=False):
94
"""output this delta in status-like form to to_file."""
97
path, fid, kind = item[:3]
99
if kind == 'directory':
101
elif kind == 'symlink':
104
if len(item) == 5 and item[4]:
108
print >>to_file, ' %-30s %s' % (path, fid)
110
print >>to_file, ' ', path
113
print >>to_file, 'removed:'
114
show_list(self.removed)
117
print >>to_file, 'added:'
118
show_list(self.added)
123
print >>to_file, 'renamed:'
124
for (oldpath, newpath, fid, kind,
125
text_modified, meta_modified) in self.renamed:
126
if text_modified or meta_modified:
127
extra_modified.append((newpath, fid, kind,
128
text_modified, meta_modified))
132
print >>to_file, ' %s => %s %s' % (oldpath, newpath, fid)
134
print >>to_file, ' %s => %s' % (oldpath, newpath)
136
if self.modified or extra_modified:
137
print >>to_file, 'modified:'
138
show_list(self.modified)
139
show_list(extra_modified)
141
if show_unchanged and self.unchanged:
142
print >>to_file, 'unchanged:'
143
show_list(self.unchanged)
146
@deprecated_function(zero_nine)
147
def compare_trees(old_tree, new_tree, want_unchanged=False,
148
specific_files=None, extra_trees=None,
149
require_versioned=False):
150
"""compare_trees was deprecated in 0.10. Please see Tree.changes_from."""
151
return new_tree.changes_from(old_tree,
152
want_unchanged=want_unchanged,
153
specific_files=specific_files,
154
extra_trees=extra_trees,
155
require_versioned=require_versioned,
159
def _compare_trees(old_tree, new_tree, want_unchanged, specific_file_ids,
162
from osutils import is_inside_any
163
old_inv = old_tree.inventory
164
new_inv = new_tree.inventory
166
# mutter('start compare_trees')
168
# TODO: Rather than iterating over the whole tree and then filtering, we
169
# could diff just the specified files (if any) and their subtrees.
171
old_files = old_tree.list_files(include_root)
172
new_files = new_tree.list_files(include_root)
183
except StopIteration:
184
return None, None, None, None, None
185
old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
186
new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
189
def check_matching(old_path, old_entry, new_path, new_entry):
190
"""We have matched up 2 file_ids, check for changes."""
191
assert old_entry.kind == new_entry.kind
193
if specific_file_ids:
194
if (old_entry.file_id not in specific_file_ids and
195
new_entry.file_id not in specific_file_ids):
198
# temporary hack until all entries are populated before clients
200
old_entry._read_tree_state(old_path, old_tree)
201
new_entry._read_tree_state(new_path, new_tree)
202
text_modified, meta_modified = new_entry.detect_changes(old_entry)
204
# If the name changes, or the parent_id changes, we have a rename
205
# (if we move a parent, that doesn't count as a rename for the file)
206
if (old_entry.name != new_entry.name
207
or old_entry.parent_id != new_entry.parent_id):
208
delta.renamed.append((old_path,
210
old_entry.file_id, old_entry.kind,
211
text_modified, meta_modified))
212
elif text_modified or meta_modified:
213
delta.modified.append((new_path, new_entry.file_id, new_entry.kind,
214
text_modified, meta_modified))
216
delta.unchanged.append((new_path, new_entry.file_id, new_entry.kind))
219
def handle_old(path, entry):
220
"""old entry without a new entry match
222
Check to see if a matching new entry was already seen as an
223
added file, and switch the pair into being a rename.
224
Otherwise just mark the old entry being removed.
226
if entry.file_id in added:
227
# Actually this is a rename, we found a new file_id earlier
228
# at a different location, so it is no-longer added
229
x_new_path, x_new_entry = added.pop(entry.file_id)
230
check_matching(path, entry, x_new_path, x_new_entry)
232
# We have an old_file_id which doesn't line up with a new_file_id
233
# So this file looks to be removed
234
assert entry.file_id not in removed
235
removed[entry.file_id] = path, entry
237
def handle_new(path, entry):
238
"""new entry without an old entry match
240
Check to see if a matching old entry was already seen as a
241
removal, and change the pair into a rename.
242
Otherwise just mark the new entry as an added file.
244
if entry.file_id in removed:
245
# We saw this file_id earlier at an old different location
246
# it is no longer removed, just renamed
247
x_old_path, x_old_entry = removed.pop(entry.file_id)
248
check_matching(x_old_path, x_old_entry, path, entry)
250
# We have a new file which does not match an old file
252
assert entry.file_id not in added
253
added[entry.file_id] = path, entry
255
while old_path is not None or new_path is not None:
256
# list_files() returns files in alphabetical path sorted order
257
if old_path == new_path:
258
if old_file_id == new_file_id:
259
# This is the common case, the files are in the same place
260
# check if there were any content changes
262
if old_file_id is None:
263
# We have 2 unversioned files, no deltas possible???
266
check_matching(old_path, old_entry, new_path, new_entry)
268
# The ids don't match, so we have to handle them both
270
if old_file_id is not None:
271
handle_old(old_path, old_entry)
273
if new_file_id is not None:
274
handle_new(new_path, new_entry)
276
# The two entries were at the same path, so increment both sides
277
old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
278
new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
279
elif new_path is None or (old_path is not None and old_path < new_path):
280
# Assume we don't match, only process old_path
281
if old_file_id is not None:
282
handle_old(old_path, old_entry)
283
# old_path came first, so increment it, trying to match up
284
old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
285
elif new_path is not None:
286
# new_path came first, so increment it, trying to match up
287
if new_file_id is not None:
288
handle_new(new_path, new_entry)
289
new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
291
# Now we have a set of added and removed files, mark them all
292
for old_path, old_entry in removed.itervalues():
293
if specific_file_ids:
294
if not old_entry.file_id in specific_file_ids:
296
delta.removed.append((old_path, old_entry.file_id, old_entry.kind))
297
for new_path, new_entry in added.itervalues():
298
if specific_file_ids:
299
if not new_entry.file_id in specific_file_ids:
301
delta.added.append((new_path, new_entry.file_id, new_entry.kind))
306
# TODO: jam 20060529 These lists shouldn't need to be sorted
307
# since we added them in alphabetical order.
308
delta.modified.sort()
309
delta.unchanged.sort()
added
removed
bzrlib/delta.py
