1
# Copyright (C) 2005, 2006 Canonical
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
21
class TreeDelta(object):
22
"""Describes changes from one tree to another.
31
(oldpath, newpath, id, kind, text_modified, meta_modified)
33
(path, id, kind, text_modified, meta_modified)
37
Each id is listed only once.
39
Files that are both modified and renamed are listed only in
40
renamed, with the text_modified flag true. The text_modified
41
applies either to the the content of the file or the target of the
42
symbolic link, depending of the kind of file.
44
Files are only considered renamed if their name has changed or
45
their parent directory has changed. Renaming a directory
46
does not count as renaming all its contents.
48
The lists are normally sorted when the delta is created.
57
def __eq__(self, other):
58
if not isinstance(other, TreeDelta):
60
return self.added == other.added \
61
and self.removed == other.removed \
62
and self.renamed == other.renamed \
63
and self.modified == other.modified \
64
and self.unchanged == other.unchanged
66
def __ne__(self, other):
67
return not (self == other)
70
return "TreeDelta(added=%r, removed=%r, renamed=%r, modified=%r," \
71
" unchanged=%r)" % (self.added, self.removed, self.renamed,
72
self.modified, self.unchanged)
74
def has_changed(self):
75
return bool(self.modified
80
def touches_file_id(self, file_id):
81
"""Return True if file_id is modified by this delta."""
82
for l in self.added, self.removed, self.modified:
86
for v in self.renamed:
92
def show(self, to_file, show_ids=False, show_unchanged=False):
95
path, fid, kind = item[:3]
97
if kind == 'directory':
99
elif kind == 'symlink':
102
if len(item) == 5 and item[4]:
106
print >>to_file, ' %-30s %s' % (path, fid)
108
print >>to_file, ' ', path
111
print >>to_file, 'removed:'
112
show_list(self.removed)
115
print >>to_file, 'added:'
116
show_list(self.added)
121
print >>to_file, 'renamed:'
122
for (oldpath, newpath, fid, kind,
123
text_modified, meta_modified) in self.renamed:
124
if text_modified or meta_modified:
125
extra_modified.append((newpath, fid, kind,
126
text_modified, meta_modified))
130
print >>to_file, ' %s => %s %s' % (oldpath, newpath, fid)
132
print >>to_file, ' %s => %s' % (oldpath, newpath)
134
if self.modified or extra_modified:
135
print >>to_file, 'modified:'
136
show_list(self.modified)
137
show_list(extra_modified)
139
if show_unchanged and self.unchanged:
140
print >>to_file, 'unchanged:'
141
show_list(self.unchanged)
145
def compare_trees(old_tree, new_tree, want_unchanged=False,
146
specific_files=None, include_root=False):
147
"""Describe changes from one tree to another.
149
Returns a TreeDelta with details of added, modified, renamed, and
152
The root entry is specifically exempt, unless include_root is specified.
154
This only considers versioned files.
157
If true, also list files unchanged from one version to
161
If true, only check for changes to specified names or
162
files within them. Any unversioned files given have no effect
163
(but this might change in the future).
165
# NB: show_status depends on being able to pass in non-versioned files and
166
# report them as unknown
171
return _compare_trees(old_tree, new_tree, want_unchanged,
172
specific_files, include_root)
179
def _compare_trees(old_tree, new_tree, want_unchanged, specific_files,
182
from osutils import is_inside_any
184
old_inv = old_tree.inventory
185
new_inv = new_tree.inventory
187
mutter('start compare_trees')
189
# TODO: Rather than iterating over the whole tree and then filtering, we
190
# could diff just the specified files (if any) and their subtrees.
191
# Perhaps should take a list of file-ids instead? Need to indicate any
192
# ids or names which were not found in the trees.
194
old_files = old_tree.list_files(include_root)
195
new_files = new_tree.list_files(include_root)
206
except StopIteration:
207
return None, None, None, None, None
208
old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
209
new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
212
def check_matching(old_path, old_entry, new_path, new_entry):
213
"""We have matched up 2 file_ids, check for changes."""
214
assert old_entry.kind == new_entry.kind
217
if (not is_inside_any(specific_files, old_path)
218
and not is_inside_any(specific_files, new_path)):
221
# temporary hack until all entries are populated before clients
223
old_entry._read_tree_state(old_path, old_tree)
224
new_entry._read_tree_state(new_path, new_tree)
225
text_modified, meta_modified = new_entry.detect_changes(old_entry)
227
# If the name changes, or the parent_id changes, we have a rename
228
# (if we move a parent, that doesn't count as a rename for the file)
229
if (old_entry.name != new_entry.name
230
or old_entry.parent_id != new_entry.parent_id):
231
delta.renamed.append((old_path,
233
old_entry.file_id, old_entry.kind,
234
text_modified, meta_modified))
235
elif text_modified or meta_modified:
236
delta.modified.append((new_path, new_entry.file_id, new_entry.kind,
237
text_modified, meta_modified))
239
delta.unchanged.append((new_path, new_entry.file_id, new_entry.kind))
242
def handle_old(path, entry):
243
"""old entry without a new entry match
245
Check to see if a matching new entry was already seen as an
246
added file, and switch the pair into being a rename.
247
Otherwise just mark the old entry being removed.
249
if entry.file_id in added:
250
# Actually this is a rename, we found a new file_id earlier
251
# at a different location, so it is no-longer added
252
x_new_path, x_new_entry = added.pop(entry.file_id)
253
check_matching(path, entry, x_new_path, x_new_entry)
255
# We have an old_file_id which doesn't line up with a new_file_id
256
# So this file looks to be removed
257
assert entry.file_id not in removed
258
removed[entry.file_id] = path, entry
260
def handle_new(path, entry):
261
"""new entry without an old entry match
263
Check to see if a matching old entry was already seen as a
264
removal, and change the pair into a rename.
265
Otherwise just mark the new entry as an added file.
267
if entry.file_id in removed:
268
# We saw this file_id earlier at an old different location
269
# it is no longer removed, just renamed
270
x_old_path, x_old_entry = removed.pop(entry.file_id)
271
check_matching(x_old_path, x_old_entry, path, entry)
273
# We have a new file which does not match an old file
275
assert entry.file_id not in added
276
added[entry.file_id] = path, entry
277
while (old_path is not None or new_path is not None):
278
# list_files() returns files in alphabetical path sorted order
279
if old_path == new_path:
280
if old_file_id == new_file_id:
281
# This is the common case, the files are in the same place
282
# check if there were any content changes
284
if old_file_id is None:
285
# We have 2 unversioned files, no deltas possible???
288
check_matching(old_path, old_entry, new_path, new_entry)
290
# The ids don't match, so we have to handle them both
292
if old_file_id is not None:
293
handle_old(old_path, old_entry)
295
if new_file_id is not None:
296
handle_new(new_path, new_entry)
298
# The two entries were at the same path, so increment both sides
299
old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
300
new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
301
elif new_path is None or (old_path is not None and old_path < new_path):
302
# Assume we don't match, only process old_path
303
if old_file_id is not None:
304
handle_old(old_path, old_entry)
305
# old_path came first, so increment it, trying to match up
306
old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
307
elif new_path is not None:
308
# new_path came first, so increment it, trying to match up
309
if new_file_id is not None:
310
handle_new(new_path, new_entry)
311
new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
313
# Now we have a set of added and removed files, mark them all
314
for old_path, old_entry in removed.itervalues():
316
if not is_inside_any(specific_files, old_path):
318
delta.removed.append((old_path, old_entry.file_id, old_entry.kind))
319
for new_path, new_entry in added.itervalues():
321
if not is_inside_any(specific_files, new_path):
323
delta.added.append((new_path, new_entry.file_id, new_entry.kind))
328
# TODO: jam 20060529 These lists shouldn't need to be sorted
329
# since we added them in alphabetical order.
330
delta.modified.sort()
331
delta.unchanged.sort()
added
removed
bzrlib/delta.py
