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,
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, '%s %-30s %s' % (short_status_letter,
128
print >>to_file, '%s %s' % (short_status_letter, path)
132
print >>to_file, 'removed:'
133
show_list(self.removed)
135
show_list(self.removed, 'D')
139
print >>to_file, 'added:'
140
show_list(self.added)
142
show_list(self.added, 'A')
147
short_status_letter = 'R'
149
print >>to_file, '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, '%s %s => %s %s' % (
160
short_status_letter, oldpath, newpath, fid)
162
print >>to_file, '%s %s => %s' % (
163
short_status_letter, oldpath, newpath)
165
if self.kind_changed:
167
short_status_letter = 'K'
169
print >>to_file, 'kind changed:'
170
short_status_letter = ''
171
for (path, fid, old_kind, new_kind) in self.kind_changed:
176
print >>to_file, '%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, '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, 'unchanged:'
190
show_list(self.unchanged)
192
show_list(self.unchanged, 'S')
195
print >>to_file, 'unknown:'
196
show_list(self.unversioned)
199
@deprecated_function(zero_nine)
200
def compare_trees(old_tree, new_tree, want_unchanged=False,
201
specific_files=None, extra_trees=None,
202
require_versioned=False):
203
"""compare_trees was deprecated in 0.10. Please see Tree.changes_from."""
204
return new_tree.changes_from(old_tree,
205
want_unchanged=want_unchanged,
206
specific_files=specific_files,
207
extra_trees=extra_trees,
208
require_versioned=require_versioned,
212
def _compare_trees(old_tree, new_tree, want_unchanged, specific_files,
213
include_root, extra_trees=None,
214
want_unversioned=False):
215
"""Worker function that implements Tree.changes_from."""
217
# mutter('start compare_trees')
219
for (file_id, path, content_change, versioned, parent_id, name, kind,
220
executable) in new_tree._iter_changes(old_tree, want_unchanged,
221
specific_files, extra_trees=extra_trees,
222
want_unversioned=want_unversioned):
223
if versioned == (False, False):
224
delta.unversioned.append((path[1], None, kind[1]))
226
if not include_root and (None, None) == parent_id:
228
fully_present = tuple((versioned[x] and kind[x] is not None) for
230
if fully_present[0] != fully_present[1]:
231
if fully_present[1] is True:
232
delta.added.append((path[1], file_id, kind[1]))
234
assert fully_present[0] is True
235
delta.removed.append((path[0], file_id, kind[0]))
236
elif fully_present[0] is False:
238
elif name[0] != name[1] or parent_id[0] != parent_id[1]:
239
# If the name changes, or the parent_id changes, we have a rename
240
# (if we move a parent, that doesn't count as a rename for the
242
delta.renamed.append((path[0],
247
(executable[0] != executable[1])))
248
elif kind[0] != kind[1]:
249
delta.kind_changed.append((path[1], file_id, kind[0], kind[1]))
250
elif content_change is True or executable[0] != executable[1]:
251
delta.modified.append((path[1], file_id, kind[1],
253
(executable[0] != executable[1])))
255
delta.unchanged.append((path[1], file_id, kind[1]))
260
# TODO: jam 20060529 These lists shouldn't need to be sorted
261
# since we added them in alphabetical order.
262
delta.modified.sort()
263
delta.unchanged.sort()
268
class _ChangeReporter(object):
269
"""Report changes between two trees"""
271
def __init__(self, output=None, suppress_root_add=True,
272
output_file=None, unversioned_filter=None):
275
:param output: a function with the signature of trace.note, i.e.
276
accepts a format and parameters.
277
:param supress_root_add: If true, adding the root will be ignored
278
(i.e. when a tree has just been initted)
279
:param output_file: If supplied, a file-like object to write to.
280
Only one of output and output_file may be supplied.
281
:param unversioned_filter: A filter function to be called on
282
unversioned files. This should return True to ignore a path.
283
By default, no filtering takes place.
285
if output_file is not None:
286
if output is not None:
287
raise BzrError('Cannot specify both output and output_file')
288
def output(fmt, *args):
289
output_file.write((fmt % args) + '\n')
291
if self.output is None:
292
from bzrlib import trace
293
self.output = trace.note
294
self.suppress_root_add = suppress_root_add
295
self.modified_map = {'kind changed': 'K',
300
self.versioned_map = {'added': '+', # versioned target
301
'unchanged': ' ', # versioned in both
302
'removed': '-', # versioned in source
303
'unversioned': '?', # versioned in neither
305
self.unversioned_filter = unversioned_filter
307
def report(self, file_id, paths, versioned, renamed, modified, exe_change,
309
"""Report one change to a file
311
:param file_id: The file_id of the file
312
:param path: The old and new paths as generated by Tree._iter_changes.
313
:param versioned: may be 'added', 'removed', 'unchanged', or
315
:param renamed: may be True or False
316
:param modified: may be 'created', 'deleted', 'kind changed',
317
'modified' or 'unchanged'.
318
:param exe_change: True if the execute bit has changed
319
:param kind: A pair of file kinds, as generated by Tree._iter_changes.
320
None indicates no file present.
322
if paths[1] == '' and versioned == 'added' and self.suppress_root_add:
324
if versioned == 'unversioned':
325
# skip ignored unversioned files if needed.
326
if self.unversioned_filter is not None:
327
if self.unversioned_filter(paths[1]):
329
# dont show a content change in the output.
330
modified = 'unchanged'
331
# we show both paths in the following situations:
332
# the file versioning is unchanged AND
333
# ( the path is different OR
334
# the kind is different)
335
if (versioned == 'unchanged' and
336
(renamed or modified == 'kind changed')):
338
# on a rename, we show old and new
339
old_path, path = paths
341
# if its not renamed, we're showing both for kind changes
342
# so only show the new path
343
old_path, path = paths[1], paths[1]
344
# if the file is not missing in the source, we show its kind
345
# when we show two paths.
346
if kind[0] is not None:
347
old_path += osutils.kind_marker(kind[0])
349
elif versioned == 'removed':
350
# not present in target
359
rename = self.versioned_map[versioned]
360
# we show the old kind on the new path when the content is deleted.
361
if modified == 'deleted':
362
path += osutils.kind_marker(kind[0])
363
# otherwise we always show the current kind when there is one
364
elif kind[1] is not None:
365
path += osutils.kind_marker(kind[1])
370
self.output("%s%s%s %s%s", rename, self.modified_map[modified], exe,
374
def report_changes(change_iterator, reporter):
375
"""Report the changes from a change iterator.
377
This is essentially a translation from low-level to medium-level changes.
378
Further processing may be required to produce a human-readable output.
379
Unfortunately, some tree-changing operations are very complex
380
:change_iterator: an iterator or sequence of changes in the format
381
generated by Tree._iter_changes
382
:param reporter: The _ChangeReporter that will report the changes.
384
versioned_change_map = {
385
(True, True) : 'unchanged',
386
(True, False) : 'removed',
387
(False, True) : 'added',
388
(False, False): 'unversioned',
390
for (file_id, path, content_change, versioned, parent_id, name, kind,
391
executable) in change_iterator:
393
# files are "renamed" if they are moved or if name changes, as long
395
if None not in name and None not in parent_id and\
396
(name[0] != name[1] or parent_id[0] != parent_id[1]):
400
if kind[0] != kind[1]:
403
elif kind[1] is None:
406
modified = "kind changed"
409
modified = "modified"
411
modified = "unchanged"
412
if kind[1] == "file":
413
exe_change = (executable[0] != executable[1])
414
versioned_change = versioned_change_map[versioned]
415
reporter.report(file_id, path, versioned_change, renamed, modified,
added
removed
bzrlib/delta.py
