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):
93
"""output this delta in status-like form to to_file."""
96
path, fid, kind = item[:3]
98
if kind == 'directory':
100
elif kind == 'symlink':
103
if len(item) == 5 and item[4]:
107
print >>to_file, ' %-30s %s' % (path, fid)
109
print >>to_file, ' ', path
112
print >>to_file, 'removed:'
113
show_list(self.removed)
116
print >>to_file, 'added:'
117
show_list(self.added)
122
print >>to_file, 'renamed:'
123
for (oldpath, newpath, fid, kind,
124
text_modified, meta_modified) in self.renamed:
125
if text_modified or meta_modified:
126
extra_modified.append((newpath, fid, kind,
127
text_modified, meta_modified))
131
print >>to_file, ' %s => %s %s' % (oldpath, newpath, fid)
133
print >>to_file, ' %s => %s' % (oldpath, newpath)
135
if self.modified or extra_modified:
136
print >>to_file, 'modified:'
137
show_list(self.modified)
138
show_list(extra_modified)
140
if show_unchanged and self.unchanged:
141
print >>to_file, 'unchanged:'
142
show_list(self.unchanged)
145
def compare_trees(old_tree, new_tree, want_unchanged=False, specific_files=None):
146
"""Describe changes from one tree to another.
148
Returns a TreeDelta with details of added, modified, renamed, and
151
The root entry is specifically exempt.
153
This only considers versioned files.
156
If true, also list files unchanged from one version to
160
If true, only check for changes to specified names or
161
files within them. Any unversioned files given have no effect
162
(but this might change in the future).
164
# NB: show_status depends on being able to pass in non-versioned files and
165
# report them as unknown
170
return _compare_trees(old_tree, new_tree, want_unchanged,
178
def _compare_trees(old_tree, new_tree, want_unchanged, specific_files):
180
from osutils import is_inside_any
182
old_inv = old_tree.inventory
183
new_inv = new_tree.inventory
185
mutter('start compare_trees')
187
# TODO: Rather than iterating over the whole tree and then filtering, we
188
# could diff just the specified files (if any) and their subtrees.
189
# Perhaps should take a list of file-ids instead? Need to indicate any
190
# ids or names which were not found in the trees.
192
old_files = old_tree.list_files()
193
new_files = new_tree.list_files()
204
except StopIteration:
205
return None, None, None, None, None
206
old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
207
new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
210
def check_matching(old_path, old_entry, new_path, new_entry):
211
"""We have matched up 2 file_ids, check for changes."""
212
assert old_entry.kind == new_entry.kind
214
if old_entry.kind == 'root_directory':
218
if (not is_inside_any(specific_files, old_path)
219
and not is_inside_any(specific_files, new_path)):
222
# temporary hack until all entries are populated before clients
224
old_entry._read_tree_state(old_path, old_tree)
225
new_entry._read_tree_state(new_path, new_tree)
226
text_modified, meta_modified = new_entry.detect_changes(old_entry)
228
# If the name changes, or the parent_id changes, we have a rename
229
# (if we move a parent, that doesn't count as a rename for the file)
230
if (old_entry.name != new_entry.name
231
or old_entry.parent_id != new_entry.parent_id):
232
delta.renamed.append((old_path,
234
old_entry.file_id, old_entry.kind,
235
text_modified, meta_modified))
236
elif text_modified or meta_modified:
237
delta.modified.append((new_path, new_entry.file_id, new_entry.kind,
238
text_modified, meta_modified))
240
delta.unchanged.append((new_path, new_entry.file_id, new_entry.kind))
243
def handle_old(path, entry):
244
"""old entry without a new entry match
246
Check to see if a matching new entry was already seen as an
247
added file, and switch the pair into being a rename.
248
Otherwise just mark the old entry being removed.
250
if entry.file_id in added:
251
# Actually this is a rename, we found a new file_id earlier
252
# at a different location, so it is no-longer added
253
x_new_path, x_new_entry = added.pop(entry.file_id)
254
check_matching(path, entry, x_new_path, x_new_entry)
256
# We have an old_file_id which doesn't line up with a new_file_id
257
# So this file looks to be removed
258
assert entry.file_id not in removed
259
removed[entry.file_id] = path, entry
261
def handle_new(path, entry):
262
"""new entry without an old entry match
264
Check to see if a matching old entry was already seen as a
265
removal, and change the pair into a rename.
266
Otherwise just mark the new entry as an added file.
268
if entry.file_id in removed:
269
# We saw this file_id earlier at an old different location
270
# it is no longer removed, just renamed
271
x_old_path, x_old_entry = removed.pop(entry.file_id)
272
check_matching(x_old_path, x_old_entry, path, entry)
274
# We have a new file which does not match an old file
276
assert entry.file_id not in added
277
added[entry.file_id] = path, entry
279
while old_path or new_path:
280
# list_files() returns files in alphabetical path sorted order
281
if old_path == new_path:
282
if old_file_id == new_file_id:
283
# This is the common case, the files are in the same place
284
# check if there were any content changes
286
if old_file_id is None:
287
# We have 2 unversioned files, no deltas possible???
290
check_matching(old_path, old_entry, new_path, new_entry)
292
# The ids don't match, so we have to handle them both
294
if old_file_id is not None:
295
handle_old(old_path, old_entry)
297
if new_file_id is not None:
298
handle_new(new_path, new_entry)
300
# The two entries were at the same path, so increment both sides
301
old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
302
new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
303
elif new_path is None or (old_path is not None and old_path < new_path):
304
# Assume we don't match, only process old_path
305
if old_file_id is not None:
306
handle_old(old_path, old_entry)
307
# old_path came first, so increment it, trying to match up
308
old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
309
elif new_path is not None:
310
# new_path came first, so increment it, trying to match up
311
if new_file_id is not None:
312
handle_new(new_path, new_entry)
313
new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
315
# Now we have a set of added and removed files, mark them all
316
for old_path, old_entry in removed.itervalues():
318
if not is_inside_any(specific_files, old_path):
320
delta.removed.append((old_path, old_entry.file_id, old_entry.kind))
321
for new_path, new_entry in added.itervalues():
323
if not is_inside_any(specific_files, new_path):
325
delta.added.append((new_path, new_entry.file_id, new_entry.kind))
330
# TODO: jam 20060529 These lists shouldn't need to be sorted
331
# since we added them in alphabetical order.
332
delta.modified.sort()
333
delta.unchanged.sort()
added
removed
bzrlib/delta.py
