1
# Copyright (C) 2005-2010 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20
from bzrlib.trace import is_quiet
23
class TreeDelta(object):
24
"""Describes changes from one tree to another.
33
(oldpath, newpath, id, kind, text_modified, meta_modified)
35
(path, id, old_kind, new_kind)
37
(path, id, kind, text_modified, meta_modified)
43
Each id is listed only once.
45
Files that are both modified and renamed are listed only in
46
renamed, with the text_modified flag true. The text_modified
47
applies either to the content of the file or the target of the
48
symbolic link, depending of the kind of file.
50
Files are only considered renamed if their name has changed or
51
their parent directory has changed. Renaming a directory
52
does not count as renaming all its contents.
54
The lists are normally sorted when the delta is created.
60
self.kind_changed = []
65
def __eq__(self, other):
66
if not isinstance(other, TreeDelta):
68
return self.added == other.added \
69
and self.removed == other.removed \
70
and self.renamed == other.renamed \
71
and self.modified == other.modified \
72
and self.unchanged == other.unchanged \
73
and self.kind_changed == other.kind_changed \
74
and self.unversioned == other.unversioned
76
def __ne__(self, other):
77
return not (self == other)
80
return "TreeDelta(added=%r, removed=%r, renamed=%r," \
81
" kind_changed=%r, modified=%r, unchanged=%r," \
82
" unversioned=%r)" % (self.added,
83
self.removed, self.renamed, self.kind_changed, self.modified,
84
self.unchanged, self.unversioned)
86
def has_changed(self):
87
return bool(self.modified
93
def touches_file_id(self, file_id):
94
"""Return True if file_id is modified by this delta."""
95
for l in self.added, self.removed, self.modified:
99
for v in self.renamed:
102
for v in self.kind_changed:
107
def get_changes_as_text(self, show_ids=False, show_unchanged=False,
110
output = StringIO.StringIO()
111
report_delta(output, self, short_status, show_ids, show_unchanged)
112
return output.getvalue()
115
def _compare_trees(old_tree, new_tree, want_unchanged, specific_files,
116
include_root, extra_trees=None,
117
require_versioned=False, want_unversioned=False):
118
"""Worker function that implements Tree.changes_from."""
120
# mutter('start compare_trees')
122
for (file_id, path, content_change, versioned, parent_id, name, kind,
123
executable) in new_tree.iter_changes(old_tree, want_unchanged,
124
specific_files, extra_trees=extra_trees,
125
require_versioned=require_versioned,
126
want_unversioned=want_unversioned):
127
if versioned == (False, False):
128
delta.unversioned.append((path[1], None, kind[1]))
130
if not include_root and (None, None) == parent_id:
132
fully_present = tuple((versioned[x] and kind[x] is not None) for
134
if fully_present[0] != fully_present[1]:
135
if fully_present[1] is True:
136
delta.added.append((path[1], file_id, kind[1]))
138
delta.removed.append((path[0], file_id, kind[0]))
139
elif fully_present[0] is False:
141
elif name[0] != name[1] or parent_id[0] != parent_id[1]:
142
# If the name changes, or the parent_id changes, we have a rename
143
# (if we move a parent, that doesn't count as a rename for the
145
delta.renamed.append((path[0],
150
(executable[0] != executable[1])))
151
elif kind[0] != kind[1]:
152
delta.kind_changed.append((path[1], file_id, kind[0], kind[1]))
153
elif content_change or executable[0] != executable[1]:
154
delta.modified.append((path[1], file_id, kind[1],
156
(executable[0] != executable[1])))
158
delta.unchanged.append((path[1], file_id, kind[1]))
163
# TODO: jam 20060529 These lists shouldn't need to be sorted
164
# since we added them in alphabetical order.
165
delta.modified.sort()
166
delta.unchanged.sort()
171
class _ChangeReporter(object):
172
"""Report changes between two trees"""
174
def __init__(self, output=None, suppress_root_add=True,
175
output_file=None, unversioned_filter=None, view_info=None):
178
:param output: a function with the signature of trace.note, i.e.
179
accepts a format and parameters.
180
:param supress_root_add: If true, adding the root will be ignored
181
(i.e. when a tree has just been initted)
182
:param output_file: If supplied, a file-like object to write to.
183
Only one of output and output_file may be supplied.
184
:param unversioned_filter: A filter function to be called on
185
unversioned files. This should return True to ignore a path.
186
By default, no filtering takes place.
187
:param view_info: A tuple of view_name,view_files if only
188
items inside a view are to be reported on, or None for
191
if output_file is not None:
192
if output is not None:
193
raise BzrError('Cannot specify both output and output_file')
194
def output(fmt, *args):
195
output_file.write((fmt % args) + '\n')
197
if self.output is None:
198
from bzrlib import trace
199
self.output = trace.note
200
self.suppress_root_add = suppress_root_add
201
self.modified_map = {'kind changed': 'K',
206
self.versioned_map = {'added': '+', # versioned target
207
'unchanged': ' ', # versioned in both
208
'removed': '-', # versioned in source
209
'unversioned': '?', # versioned in neither
211
self.unversioned_filter = unversioned_filter
212
if view_info is None:
213
self.view_name = None
216
self.view_name = view_info[0]
217
self.view_files = view_info[1]
218
self.output("Operating on whole tree but only reporting on "
219
"'%s' view." % (self.view_name,))
221
def report(self, file_id, paths, versioned, renamed, modified, exe_change,
223
"""Report one change to a file
225
:param file_id: The file_id of the file
226
:param path: The old and new paths as generated by Tree.iter_changes.
227
:param versioned: may be 'added', 'removed', 'unchanged', or
229
:param renamed: may be True or False
230
:param modified: may be 'created', 'deleted', 'kind changed',
231
'modified' or 'unchanged'.
232
:param exe_change: True if the execute bit has changed
233
:param kind: A pair of file kinds, as generated by Tree.iter_changes.
234
None indicates no file present.
238
if paths[1] == '' and versioned == 'added' and self.suppress_root_add:
240
if self.view_files and not osutils.is_inside_any(self.view_files,
243
if versioned == 'unversioned':
244
# skip ignored unversioned files if needed.
245
if self.unversioned_filter is not None:
246
if self.unversioned_filter(paths[1]):
248
# dont show a content change in the output.
249
modified = 'unchanged'
250
# we show both paths in the following situations:
251
# the file versioning is unchanged AND
252
# ( the path is different OR
253
# the kind is different)
254
if (versioned == 'unchanged' and
255
(renamed or modified == 'kind changed')):
257
# on a rename, we show old and new
258
old_path, path = paths
260
# if it's not renamed, we're showing both for kind changes
261
# so only show the new path
262
old_path, path = paths[1], paths[1]
263
# if the file is not missing in the source, we show its kind
264
# when we show two paths.
265
if kind[0] is not None:
266
old_path += osutils.kind_marker(kind[0])
268
elif versioned == 'removed':
269
# not present in target
278
rename = self.versioned_map[versioned]
279
# we show the old kind on the new path when the content is deleted.
280
if modified == 'deleted':
281
path += osutils.kind_marker(kind[0])
282
# otherwise we always show the current kind when there is one
283
elif kind[1] is not None:
284
path += osutils.kind_marker(kind[1])
289
self.output("%s%s%s %s%s", rename, self.modified_map[modified], exe,
292
def report_changes(change_iterator, reporter):
293
"""Report the changes from a change iterator.
295
This is essentially a translation from low-level to medium-level changes.
296
Further processing may be required to produce a human-readable output.
297
Unfortunately, some tree-changing operations are very complex
298
:change_iterator: an iterator or sequence of changes in the format
299
generated by Tree.iter_changes
300
:param reporter: The _ChangeReporter that will report the changes.
302
versioned_change_map = {
303
(True, True) : 'unchanged',
304
(True, False) : 'removed',
305
(False, True) : 'added',
306
(False, False): 'unversioned',
308
for (file_id, path, content_change, versioned, parent_id, name, kind,
309
executable) in change_iterator:
311
# files are "renamed" if they are moved or if name changes, as long
313
if None not in name and None not in parent_id and\
314
(name[0] != name[1] or parent_id[0] != parent_id[1]):
318
if kind[0] != kind[1]:
321
elif kind[1] is None:
324
modified = "kind changed"
327
modified = "modified"
329
modified = "unchanged"
330
if kind[1] == "file":
331
exe_change = (executable[0] != executable[1])
332
versioned_change = versioned_change_map[versioned]
333
reporter.report(file_id, path, versioned_change, renamed, modified,
336
def report_delta(to_file, delta, short_status=False, show_ids=False,
337
show_unchanged=False, indent='', filter=None):
338
"""Output this delta in status-like form to to_file.
340
:param to_file: A file-like object where the output is displayed.
342
:param delta: A TreeDelta containing the changes to be displayed
344
:param short_status: Single-line status if True.
346
:param show_ids: Output the file ids if True.
348
:param show_unchanged: Output the unchanged files if True.
350
:param indent: Added at the beginning of all output lines (for merged
353
:param filter: A callable receiving a path and a file id and
354
returning True if the path should be displayed.
357
def decorate_path(path, kind, meta_modified=None):
358
if kind == 'directory':
360
elif kind == 'symlink':
366
def show_more_renamed(item):
367
(oldpath, file_id, kind,
368
text_modified, meta_modified, newpath) = item
369
dec_new_path = decorate_path(newpath, kind, meta_modified)
370
to_file.write(' => %s' % dec_new_path)
371
if text_modified or meta_modified:
372
extra_modified.append((newpath, file_id, kind,
373
text_modified, meta_modified))
375
def show_more_kind_changed(item):
376
(path, file_id, old_kind, new_kind) = item
377
to_file.write(' (%s => %s)' % (old_kind, new_kind))
379
def show_path(path, file_id, kind, meta_modified,
380
default_format, with_file_id_format):
381
dec_path = decorate_path(path, kind, meta_modified)
383
to_file.write(with_file_id_format % dec_path)
385
to_file.write(default_format % dec_path)
387
def show_list(files, long_status_name, short_status_letter,
388
default_format='%s', with_file_id_format='%-30s',
393
prefix = short_status_letter
396
prefix = indent + prefix + ' '
399
path, file_id, kind = item[:3]
400
if (filter is not None and not filter(path, file_id)):
402
if not header_shown and not short_status:
403
to_file.write(indent + long_status_name + ':\n')
407
meta_modified = item[4]
409
to_file.write(prefix)
410
show_path(path, file_id, kind, meta_modified,
411
default_format, with_file_id_format)
412
if show_more is not None:
415
to_file.write(' %s' % file_id)
418
show_list(delta.removed, 'removed', 'D')
419
show_list(delta.added, 'added', 'A')
421
# Reorder delta.renamed tuples so that all lists share the same
422
# order for their 3 first fields and that they also begin like
423
# the delta.modified tuples
424
renamed = [(p, i, k, tm, mm, np)
425
for p, np, i, k, tm, mm in delta.renamed]
426
show_list(renamed, 'renamed', 'R', with_file_id_format='%s',
427
show_more=show_more_renamed)
428
show_list(delta.kind_changed, 'kind changed', 'K',
429
with_file_id_format='%s',
430
show_more=show_more_kind_changed)
431
show_list(delta.modified + extra_modified, 'modified', 'M')
433
show_list(delta.unchanged, 'unchanged', 'S')
435
show_list(delta.unversioned, 'unknown', ' ')
added
removed
bzrlib/delta.py
