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
21
from bzrlib.inventory import InventoryEntry
22
from bzrlib.trace import mutter
23
from bzrlib.symbol_versioning import deprecated_function, zero_nine
26
class TreeDelta(object):
27
"""Describes changes from one tree to another.
36
(oldpath, newpath, id, kind, text_modified, meta_modified)
38
(path, id, kind, text_modified, meta_modified)
42
Each id is listed only once.
44
Files that are both modified and renamed are listed only in
45
renamed, with the text_modified flag true. The text_modified
46
applies either to the the content of the file or the target of the
47
symbolic link, depending of the kind of file.
49
Files are only considered renamed if their name has changed or
50
their parent directory has changed. Renaming a directory
51
does not count as renaming all its contents.
53
The lists are normally sorted when the delta is created.
59
self.kind_changed = []
63
def __eq__(self, other):
64
if not isinstance(other, TreeDelta):
66
return self.added == other.added \
67
and self.removed == other.removed \
68
and self.renamed == other.renamed \
69
and self.modified == other.modified \
70
and self.unchanged == other.unchanged \
71
and self.kind_changed == other.kind_changed
73
def __ne__(self, other):
74
return not (self == other)
77
return "TreeDelta(added=%r, removed=%r, renamed=%r," \
78
" kind_changed=%r, modified=%r, unchanged=%r)" % (self.added,
79
self.removed, self.renamed, self.kind_changed, self.modified,
82
def has_changed(self):
83
return bool(self.modified
89
def touches_file_id(self, file_id):
90
"""Return True if file_id is modified by this delta."""
91
for l in self.added, self.removed, self.modified:
95
for v in self.renamed:
98
for v in self.kind_changed:
104
def show(self, to_file, show_ids=False, show_unchanged=False,
106
"""output this delta in status-like form to to_file."""
107
def show_list(files, short_status_letter=''):
109
path, fid, kind = item[:3]
111
if kind == 'directory':
113
elif kind == 'symlink':
116
if len(item) == 5 and item[4]:
120
print >>to_file, '%s %-30s %s' % (short_status_letter,
123
print >>to_file, '%s %s' % (short_status_letter, path)
127
print >>to_file, 'removed:'
128
show_list(self.removed)
130
show_list(self.removed, 'D')
134
print >>to_file, 'added:'
135
show_list(self.added)
137
show_list(self.added, 'A')
142
short_status_letter = 'R'
144
print >>to_file, 'renamed:'
145
short_status_letter = ''
146
for (oldpath, newpath, fid, kind,
147
text_modified, meta_modified) in self.renamed:
148
if text_modified or meta_modified:
149
extra_modified.append((newpath, fid, kind,
150
text_modified, meta_modified))
154
print >>to_file, '%s %s => %s %s' % (
155
short_status_letter, oldpath, newpath, fid)
157
print >>to_file, '%s %s => %s' % (
158
short_status_letter, oldpath, newpath)
160
if self.kind_changed:
162
short_status_letter = 'K'
164
print >>to_file, 'kind changed:'
165
short_status_letter = ''
166
for (path, fid, old_kind, new_kind) in self.kind_changed:
171
print >>to_file, '%s %s (%s => %s)%s' % (
172
short_status_letter, path, old_kind, new_kind, suffix)
174
if self.modified or extra_modified:
175
short_status_letter = 'M'
177
print >>to_file, 'modified:'
178
short_status_letter = ''
179
show_list(self.modified, short_status_letter)
180
show_list(extra_modified, short_status_letter)
182
if show_unchanged and self.unchanged:
184
print >>to_file, 'unchanged:'
185
show_list(self.unchanged)
187
show_list(self.unchanged, 'S')
190
@deprecated_function(zero_nine)
191
def compare_trees(old_tree, new_tree, want_unchanged=False,
192
specific_files=None, extra_trees=None,
193
require_versioned=False):
194
"""compare_trees was deprecated in 0.10. Please see Tree.changes_from."""
195
return new_tree.changes_from(old_tree,
196
want_unchanged=want_unchanged,
197
specific_files=specific_files,
198
extra_trees=extra_trees,
199
require_versioned=require_versioned,
203
def _compare_trees(old_tree, new_tree, want_unchanged, specific_file_ids,
206
# mutter('start compare_trees')
208
for (file_id, path, content_change, versioned, parent_id, name, kind,
209
executable) in new_tree._iter_changes(old_tree, want_unchanged,
211
if not include_root and (None, None) == parent_id:
213
fully_present = tuple((versioned[x] and kind[x] is not None) for
215
if fully_present[0] != fully_present[1]:
216
if fully_present[1] is True:
217
delta.added.append((path, file_id, kind[1]))
219
assert fully_present[0] is True
220
old_path = old_tree.id2path(file_id)
221
delta.removed.append((old_path, file_id, kind[0]))
222
elif fully_present[0] is False:
224
elif name[0] != name[1] or parent_id[0] != parent_id[1]:
225
# If the name changes, or the parent_id changes, we have a rename
226
# (if we move a parent, that doesn't count as a rename for the
228
old_path = old_tree.id2path(file_id)
229
delta.renamed.append((old_path,
234
(executable[0] != executable[1])))
235
elif kind[0] != kind[1]:
236
delta.kind_changed.append((path, file_id, kind[0], kind[1]))
237
elif content_change is True or executable[0] != executable[1]:
238
delta.modified.append((path, file_id, kind[1],
240
(executable[0] != executable[1])))
242
delta.unchanged.append((path, file_id, kind[1]))
247
# TODO: jam 20060529 These lists shouldn't need to be sorted
248
# since we added them in alphabetical order.
249
delta.modified.sort()
250
delta.unchanged.sort()
255
class ChangeReporter(object):
256
"""Report changes between two trees"""
258
def __init__(self, old_inventory, output=None, suppress_root_add=True,
262
:param old_inventory: The inventory of the old tree
263
:param output: a function with the signature of trace.note, i.e.
264
accepts a format and parameters.
265
:param supress_root_add: If true, adding the root will be ignored
266
(i.e. when a tree has just been initted)
267
:param output_file: If supplied, a file-like object to write to.
268
Only one of output and output_file may be supplied.
270
self.old_inventory = old_inventory
271
if output_file is not None:
272
if output is not None:
273
raise BzrError('Cannot specify both output and output_file')
274
def output(fmt, *args):
275
output_file.write((fmt % args) + '\n')
277
if self.output is None:
278
from bzrlib import trace
279
self.output = trace.note
280
self.suppress_root_add = suppress_root_add
282
def report(self, file_id, path, versioned, renamed, modified, exe_change,
284
"""Report one change to a file
286
:param file_id: The file_id of the file
287
:param path: The path the file has (or would have) in the tree (as
288
generated by Tree._iter_changes)
289
:param versioned: may be 'added', 'removed', or 'unchanged'
290
:param renamed: may be True or False
291
:param modified: may be 'created', 'deleted', 'kind changed',
292
'modified' or 'unchanged'.
293
:param exe_change: True if the execute bit has changed
294
:param kind: A pair of file kinds, as generated by Tree._iter_changes.
295
None indicates no file present.
297
if path == '' and versioned == 'added' and self.suppress_root_add:
299
modified_map = {'kind changed': 'K',
304
versioned_map = {'added': '+',
309
old_path = self.old_inventory.id2path(file_id)
312
rename = versioned_map[versioned]
313
if modified == 'kind changed':
316
if modified == 'deleted':
317
path += osutils.kind_marker(kind[0])
318
elif kind[1] is not None:
319
path += osutils.kind_marker(kind[1])
321
if kind[0] is not None:
322
old_path += osutils.kind_marker(kind[0])
328
self.output("%s%s%s %s%s", rename, modified_map[modified], exe,
332
def report_changes(change_iterator, reporter):
333
"""Report the changes from a change iterator.
335
This is essentially a translation from low-level to medium-level changes.
336
Further processing may be required to produce a human-readable output.
337
Unfortunately, some tree-changing operations are very complex
338
:change_iterator: an iterator or sequence of changes in the format
339
generated by Tree._iter_changes
340
:param reporter: The ChangeReporter that will report the changes.
342
for (file_id, path, content_change, versioned, parent_id, name, kind,
343
executable) in change_iterator:
345
# files are "renamed" if they are moved or if name changes, as long
347
if None not in name and (name[0] != name[1] or
348
parent_id[0] != parent_id[1]):
352
if kind[0] != kind[1]:
355
elif kind[1] is None:
358
modified = "kind changed"
361
modified = "modified"
363
modified = "unchanged"
364
if kind[1] == "file":
365
exe_change = (executable[0] != executable[1])
366
if versioned[0] != versioned[1]:
368
versioned_change = "removed"
370
versioned_change = "added"
372
versioned_change = "unchanged"
373
reporter.report(file_id, path, versioned_change, renamed, modified,
added
removed
bzrlib/delta.py
