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)
44
Each id is listed only once.
46
Files that are both modified and renamed are listed only in
47
renamed, with the text_modified flag true. The text_modified
48
applies either to the the content of the file or the target of the
49
symbolic link, depending of the kind of file.
51
Files are only considered renamed if their name has changed or
52
their parent directory has changed. Renaming a directory
53
does not count as renaming all its contents.
55
The lists are normally sorted when the delta is created.
61
self.kind_changed = []
66
def __eq__(self, other):
67
if not isinstance(other, TreeDelta):
69
return self.added == other.added \
70
and self.removed == other.removed \
71
and self.renamed == other.renamed \
72
and self.modified == other.modified \
73
and self.unchanged == other.unchanged \
74
and self.kind_changed == other.kind_changed \
75
and self.unversioned == other.unversioned
77
def __ne__(self, other):
78
return not (self == other)
81
return "TreeDelta(added=%r, removed=%r, renamed=%r," \
82
" kind_changed=%r, modified=%r, unchanged=%r," \
83
" unversioned=%r)" % (self.added,
84
self.removed, self.renamed, self.kind_changed, self.modified,
85
self.unchanged, self.unversioned)
87
def has_changed(self):
88
return bool(self.modified
94
def touches_file_id(self, file_id):
95
"""Return True if file_id is modified by this delta."""
96
for l in self.added, self.removed, self.modified:
100
for v in self.renamed:
103
for v in self.kind_changed:
109
def show(self, to_file, show_ids=False, show_unchanged=False,
110
short_status=False, indent=''):
111
"""output this delta in status-like form to to_file."""
112
def show_list(files, short_status_letter=''):
114
path, fid, kind = item[:3]
116
if kind == 'directory':
118
elif kind == 'symlink':
121
if len(item) == 5 and item[4]:
125
print >>to_file, indent + '%s %-30s %s' % (short_status_letter,
128
print >>to_file, indent + '%s %s' % (short_status_letter, path)
132
print >>to_file, indent + 'removed:'
133
show_list(self.removed)
135
show_list(self.removed, 'D')
139
print >>to_file, indent + 'added:'
140
show_list(self.added)
142
show_list(self.added, 'A')
147
short_status_letter = 'R'
149
print >>to_file, indent + 'renamed:'
150
short_status_letter = ''
151
for (oldpath, newpath, fid, kind,
152
text_modified, meta_modified) in self.renamed:
153
if text_modified or meta_modified:
154
extra_modified.append((newpath, fid, kind,
155
text_modified, meta_modified))
159
print >>to_file, indent + '%s %s => %s %s' % (
160
short_status_letter, oldpath, newpath, fid)
162
print >>to_file, indent + '%s %s => %s' % (
163
short_status_letter, oldpath, newpath)
165
if self.kind_changed:
167
short_status_letter = 'K'
169
print >>to_file, indent + 'kind changed:'
170
short_status_letter = ''
171
for (path, fid, old_kind, new_kind) in self.kind_changed:
176
print >>to_file, indent + '%s %s (%s => %s)%s' % (
177
short_status_letter, path, old_kind, new_kind, suffix)
179
if self.modified or extra_modified:
180
short_status_letter = 'M'
182
print >>to_file, indent + 'modified:'
183
short_status_letter = ''
184
show_list(self.modified, short_status_letter)
185
show_list(extra_modified, short_status_letter)
187
if show_unchanged and self.unchanged:
189
print >>to_file, indent + 'unchanged:'
190
show_list(self.unchanged)
192
show_list(self.unchanged, 'S')
195
print >>to_file, indent + 'unknown:'
196
show_list(self.unversioned)
198
def get_changes_as_text(self, show_ids=False, show_unchanged=False,
201
output = StringIO.StringIO()
202
self.show(output, show_ids, show_unchanged, short_status)
203
return output.getvalue()
205
@deprecated_function(zero_nine)
206
def compare_trees(old_tree, new_tree, want_unchanged=False,
207
specific_files=None, extra_trees=None,
208
require_versioned=False):
209
"""compare_trees was deprecated in 0.10. Please see Tree.changes_from."""
210
return new_tree.changes_from(old_tree,
211
want_unchanged=want_unchanged,
212
specific_files=specific_files,
213
extra_trees=extra_trees,
214
require_versioned=require_versioned,
218
def _compare_trees(old_tree, new_tree, want_unchanged, specific_files,
219
include_root, extra_trees=None,
220
want_unversioned=False):
221
"""Worker function that implements Tree.changes_from."""
223
# mutter('start compare_trees')
225
for (file_id, path, content_change, versioned, parent_id, name, kind,
226
executable) in new_tree._iter_changes(old_tree, want_unchanged,
227
specific_files, extra_trees=extra_trees,
228
want_unversioned=want_unversioned):
229
if versioned == (False, False):
230
delta.unversioned.append((path[1], None, kind[1]))
232
if not include_root and (None, None) == parent_id:
234
fully_present = tuple((versioned[x] and kind[x] is not None) for
236
if fully_present[0] != fully_present[1]:
237
if fully_present[1] is True:
238
delta.added.append((path[1], file_id, kind[1]))
240
assert fully_present[0] is True
241
delta.removed.append((path[0], file_id, kind[0]))
242
elif fully_present[0] is False:
244
elif name[0] != name[1] or parent_id[0] != parent_id[1]:
245
# If the name changes, or the parent_id changes, we have a rename
246
# (if we move a parent, that doesn't count as a rename for the
248
delta.renamed.append((path[0],
253
(executable[0] != executable[1])))
254
elif kind[0] != kind[1]:
255
delta.kind_changed.append((path[1], file_id, kind[0], kind[1]))
256
elif content_change is True or executable[0] != executable[1]:
257
delta.modified.append((path[1], file_id, kind[1],
259
(executable[0] != executable[1])))
261
delta.unchanged.append((path[1], file_id, kind[1]))
266
# TODO: jam 20060529 These lists shouldn't need to be sorted
267
# since we added them in alphabetical order.
268
delta.modified.sort()
269
delta.unchanged.sort()
274
class _ChangeReporter(object):
275
"""Report changes between two trees"""
277
def __init__(self, output=None, suppress_root_add=True,
278
output_file=None, unversioned_filter=None):
281
:param output: a function with the signature of trace.note, i.e.
282
accepts a format and parameters.
283
:param supress_root_add: If true, adding the root will be ignored
284
(i.e. when a tree has just been initted)
285
:param output_file: If supplied, a file-like object to write to.
286
Only one of output and output_file may be supplied.
287
:param unversioned_filter: A filter function to be called on
288
unversioned files. This should return True to ignore a path.
289
By default, no filtering takes place.
291
if output_file is not None:
292
if output is not None:
293
raise BzrError('Cannot specify both output and output_file')
294
def output(fmt, *args):
295
output_file.write((fmt % args) + '\n')
297
if self.output is None:
298
from bzrlib import trace
299
self.output = trace.note
300
self.suppress_root_add = suppress_root_add
301
self.modified_map = {'kind changed': 'K',
306
self.versioned_map = {'added': '+', # versioned target
307
'unchanged': ' ', # versioned in both
308
'removed': '-', # versioned in source
309
'unversioned': '?', # versioned in neither
311
self.unversioned_filter = unversioned_filter
313
def report(self, file_id, paths, versioned, renamed, modified, exe_change,
315
"""Report one change to a file
317
:param file_id: The file_id of the file
318
:param path: The old and new paths as generated by Tree._iter_changes.
319
:param versioned: may be 'added', 'removed', 'unchanged', or
321
:param renamed: may be True or False
322
:param modified: may be 'created', 'deleted', 'kind changed',
323
'modified' or 'unchanged'.
324
:param exe_change: True if the execute bit has changed
325
:param kind: A pair of file kinds, as generated by Tree._iter_changes.
326
None indicates no file present.
328
if paths[1] == '' and versioned == 'added' and self.suppress_root_add:
330
if versioned == 'unversioned':
331
# skip ignored unversioned files if needed.
332
if self.unversioned_filter is not None:
333
if self.unversioned_filter(paths[1]):
335
# dont show a content change in the output.
336
modified = 'unchanged'
337
# we show both paths in the following situations:
338
# the file versioning is unchanged AND
339
# ( the path is different OR
340
# the kind is different)
341
if (versioned == 'unchanged' and
342
(renamed or modified == 'kind changed')):
344
# on a rename, we show old and new
345
old_path, path = paths
347
# if its not renamed, we're showing both for kind changes
348
# so only show the new path
349
old_path, path = paths[1], paths[1]
350
# if the file is not missing in the source, we show its kind
351
# when we show two paths.
352
if kind[0] is not None:
353
old_path += osutils.kind_marker(kind[0])
355
elif versioned == 'removed':
356
# not present in target
365
rename = self.versioned_map[versioned]
366
# we show the old kind on the new path when the content is deleted.
367
if modified == 'deleted':
368
path += osutils.kind_marker(kind[0])
369
# otherwise we always show the current kind when there is one
370
elif kind[1] is not None:
371
path += osutils.kind_marker(kind[1])
376
self.output("%s%s%s %s%s", rename, self.modified_map[modified], exe,
380
def report_changes(change_iterator, reporter):
381
"""Report the changes from a change iterator.
383
This is essentially a translation from low-level to medium-level changes.
384
Further processing may be required to produce a human-readable output.
385
Unfortunately, some tree-changing operations are very complex
386
:change_iterator: an iterator or sequence of changes in the format
387
generated by Tree._iter_changes
388
:param reporter: The _ChangeReporter that will report the changes.
390
versioned_change_map = {
391
(True, True) : 'unchanged',
392
(True, False) : 'removed',
393
(False, True) : 'added',
394
(False, False): 'unversioned',
396
for (file_id, path, content_change, versioned, parent_id, name, kind,
397
executable) in change_iterator:
399
# files are "renamed" if they are moved or if name changes, as long
401
if None not in name and None not in parent_id and\
402
(name[0] != name[1] or parent_id[0] != parent_id[1]):
406
if kind[0] != kind[1]:
409
elif kind[1] is None:
412
modified = "kind changed"
415
modified = "modified"
417
modified = "unchanged"
418
if kind[1] == "file":
419
exe_change = (executable[0] != executable[1])
420
versioned_change = versioned_change_map[versioned]
421
reporter.report(file_id, path, versioned_change, renamed, modified,
added
removed
bzrlib/delta.py
