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, is_quiet
23
from bzrlib.symbol_versioning import deprecated_function
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
to_file.write(indent + '%s %-30s %s\n' % (short_status_letter,
128
to_file.write(indent + '%s %s\n' % (short_status_letter, path))
132
to_file.write(indent + 'removed:\n')
133
show_list(self.removed)
135
show_list(self.removed, 'D')
139
to_file.write(indent + 'added:\n')
140
show_list(self.added)
142
show_list(self.added, 'A')
147
short_status_letter = 'R'
149
to_file.write(indent + 'renamed:\n')
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
to_file.write(indent + '%s %s => %s %s\n' % (
160
short_status_letter, oldpath, newpath, fid))
162
to_file.write(indent + '%s %s => %s\n' % (
163
short_status_letter, oldpath, newpath))
165
if self.kind_changed:
167
short_status_letter = 'K'
169
to_file.write(indent + 'kind changed:\n')
170
short_status_letter = ''
171
for (path, fid, old_kind, new_kind) in self.kind_changed:
176
to_file.write(indent + '%s %s (%s => %s)%s\n' % (
177
short_status_letter, path, old_kind, new_kind, suffix))
179
if self.modified or extra_modified:
180
short_status_letter = 'M'
182
to_file.write(indent + 'modified:\n')
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
to_file.write(indent + 'unchanged:\n')
190
show_list(self.unchanged)
192
show_list(self.unchanged, 'S')
195
to_file.write(indent + 'unknown:\n')
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()
206
def _compare_trees(old_tree, new_tree, want_unchanged, specific_files,
207
include_root, extra_trees=None,
208
require_versioned=False, want_unversioned=False):
209
"""Worker function that implements Tree.changes_from."""
211
# mutter('start compare_trees')
213
for (file_id, path, content_change, versioned, parent_id, name, kind,
214
executable) in new_tree.iter_changes(old_tree, want_unchanged,
215
specific_files, extra_trees=extra_trees,
216
require_versioned=require_versioned,
217
want_unversioned=want_unversioned):
218
if versioned == (False, False):
219
delta.unversioned.append((path[1], None, kind[1]))
221
if not include_root and (None, None) == parent_id:
223
fully_present = tuple((versioned[x] and kind[x] is not None) for
225
if fully_present[0] != fully_present[1]:
226
if fully_present[1] is True:
227
delta.added.append((path[1], file_id, kind[1]))
229
assert fully_present[0] is True
230
delta.removed.append((path[0], file_id, kind[0]))
231
elif fully_present[0] is False:
233
elif name[0] != name[1] or parent_id[0] != parent_id[1]:
234
# If the name changes, or the parent_id changes, we have a rename
235
# (if we move a parent, that doesn't count as a rename for the
237
delta.renamed.append((path[0],
242
(executable[0] != executable[1])))
243
elif kind[0] != kind[1]:
244
delta.kind_changed.append((path[1], file_id, kind[0], kind[1]))
245
elif content_change is True or executable[0] != executable[1]:
246
delta.modified.append((path[1], file_id, kind[1],
248
(executable[0] != executable[1])))
250
delta.unchanged.append((path[1], file_id, kind[1]))
255
# TODO: jam 20060529 These lists shouldn't need to be sorted
256
# since we added them in alphabetical order.
257
delta.modified.sort()
258
delta.unchanged.sort()
263
class _ChangeReporter(object):
264
"""Report changes between two trees"""
266
def __init__(self, output=None, suppress_root_add=True,
267
output_file=None, unversioned_filter=None):
270
:param output: a function with the signature of trace.note, i.e.
271
accepts a format and parameters.
272
:param supress_root_add: If true, adding the root will be ignored
273
(i.e. when a tree has just been initted)
274
:param output_file: If supplied, a file-like object to write to.
275
Only one of output and output_file may be supplied.
276
:param unversioned_filter: A filter function to be called on
277
unversioned files. This should return True to ignore a path.
278
By default, no filtering takes place.
280
if output_file is not None:
281
if output is not None:
282
raise BzrError('Cannot specify both output and output_file')
283
def output(fmt, *args):
284
output_file.write((fmt % args) + '\n')
286
if self.output is None:
287
from bzrlib import trace
288
self.output = trace.note
289
self.suppress_root_add = suppress_root_add
290
self.modified_map = {'kind changed': 'K',
295
self.versioned_map = {'added': '+', # versioned target
296
'unchanged': ' ', # versioned in both
297
'removed': '-', # versioned in source
298
'unversioned': '?', # versioned in neither
300
self.unversioned_filter = unversioned_filter
302
def report(self, file_id, paths, versioned, renamed, modified, exe_change,
304
"""Report one change to a file
306
:param file_id: The file_id of the file
307
:param path: The old and new paths as generated by Tree.iter_changes.
308
:param versioned: may be 'added', 'removed', 'unchanged', or
310
:param renamed: may be True or False
311
:param modified: may be 'created', 'deleted', 'kind changed',
312
'modified' or 'unchanged'.
313
:param exe_change: True if the execute bit has changed
314
:param kind: A pair of file kinds, as generated by Tree.iter_changes.
315
None indicates no file present.
319
if paths[1] == '' and versioned == 'added' and self.suppress_root_add:
321
if versioned == 'unversioned':
322
# skip ignored unversioned files if needed.
323
if self.unversioned_filter is not None:
324
if self.unversioned_filter(paths[1]):
326
# dont show a content change in the output.
327
modified = 'unchanged'
328
# we show both paths in the following situations:
329
# the file versioning is unchanged AND
330
# ( the path is different OR
331
# the kind is different)
332
if (versioned == 'unchanged' and
333
(renamed or modified == 'kind changed')):
335
# on a rename, we show old and new
336
old_path, path = paths
338
# if it's not renamed, we're showing both for kind changes
339
# so only show the new path
340
old_path, path = paths[1], paths[1]
341
# if the file is not missing in the source, we show its kind
342
# when we show two paths.
343
if kind[0] is not None:
344
old_path += osutils.kind_marker(kind[0])
346
elif versioned == 'removed':
347
# not present in target
356
rename = self.versioned_map[versioned]
357
# we show the old kind on the new path when the content is deleted.
358
if modified == 'deleted':
359
path += osutils.kind_marker(kind[0])
360
# otherwise we always show the current kind when there is one
361
elif kind[1] is not None:
362
path += osutils.kind_marker(kind[1])
367
self.output("%s%s%s %s%s", rename, self.modified_map[modified], exe,
371
def report_changes(change_iterator, reporter):
372
"""Report the changes from a change iterator.
374
This is essentially a translation from low-level to medium-level changes.
375
Further processing may be required to produce a human-readable output.
376
Unfortunately, some tree-changing operations are very complex
377
:change_iterator: an iterator or sequence of changes in the format
378
generated by Tree.iter_changes
379
:param reporter: The _ChangeReporter that will report the changes.
381
versioned_change_map = {
382
(True, True) : 'unchanged',
383
(True, False) : 'removed',
384
(False, True) : 'added',
385
(False, False): 'unversioned',
387
for (file_id, path, content_change, versioned, parent_id, name, kind,
388
executable) in change_iterator:
390
# files are "renamed" if they are moved or if name changes, as long
392
if None not in name and None not in parent_id and\
393
(name[0] != name[1] or parent_id[0] != parent_id[1]):
397
if kind[0] != kind[1]:
400
elif kind[1] is None:
403
modified = "kind changed"
406
modified = "modified"
408
modified = "unchanged"
409
if kind[1] == "file":
410
exe_change = (executable[0] != executable[1])
411
versioned_change = versioned_change_map[versioned]
412
reporter.report(file_id, path, versioned_change, renamed, modified,
added
removed
bzrlib/delta.py
