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 = []
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:
108
def get_changes_as_text(self, show_ids=False, show_unchanged=False,
111
output = StringIO.StringIO()
112
report_delta(output, self, short_status, show_ids, show_unchanged)
113
return output.getvalue()
116
def _compare_trees(old_tree, new_tree, want_unchanged, specific_files,
117
include_root, extra_trees=None,
118
require_versioned=False, want_unversioned=False):
119
"""Worker function that implements Tree.changes_from."""
121
# mutter('start compare_trees')
123
for (file_id, path, content_change, versioned, parent_id, name, kind,
124
executable) in new_tree.iter_changes(old_tree, want_unchanged,
125
specific_files, extra_trees=extra_trees,
126
require_versioned=require_versioned,
127
want_unversioned=want_unversioned):
128
if versioned == (False, False):
129
delta.unversioned.append((path[1], None, kind[1]))
131
if not include_root and (None, None) == parent_id:
133
fully_present = tuple((versioned[x] and kind[x] is not None) for
135
if fully_present[0] != fully_present[1]:
136
if fully_present[1] is True:
137
delta.added.append((path[1], file_id, kind[1]))
139
delta.removed.append((path[0], file_id, kind[0]))
140
elif fully_present[0] is False:
141
delta.missing.append((path[1], file_id, kind[1]))
142
elif name[0] != name[1] or parent_id[0] != parent_id[1]:
143
# If the name changes, or the parent_id changes, we have a rename
144
# (if we move a parent, that doesn't count as a rename for the
146
delta.renamed.append((path[0],
151
(executable[0] != executable[1])))
152
elif kind[0] != kind[1]:
153
delta.kind_changed.append((path[1], file_id, kind[0], kind[1]))
154
elif content_change or executable[0] != executable[1]:
155
delta.modified.append((path[1], file_id, kind[1],
157
(executable[0] != executable[1])))
159
delta.unchanged.append((path[1], file_id, kind[1]))
165
# TODO: jam 20060529 These lists shouldn't need to be sorted
166
# since we added them in alphabetical order.
167
delta.modified.sort()
168
delta.unchanged.sort()
173
class _ChangeReporter(object):
174
"""Report changes between two trees"""
176
def __init__(self, output=None, suppress_root_add=True,
177
output_file=None, unversioned_filter=None, view_info=None):
180
:param output: a function with the signature of trace.note, i.e.
181
accepts a format and parameters.
182
:param supress_root_add: If true, adding the root will be ignored
183
(i.e. when a tree has just been initted)
184
:param output_file: If supplied, a file-like object to write to.
185
Only one of output and output_file may be supplied.
186
:param unversioned_filter: A filter function to be called on
187
unversioned files. This should return True to ignore a path.
188
By default, no filtering takes place.
189
:param view_info: A tuple of view_name,view_files if only
190
items inside a view are to be reported on, or None for
193
if output_file is not None:
194
if output is not None:
195
raise BzrError('Cannot specify both output and output_file')
196
def output(fmt, *args):
197
output_file.write((fmt % args) + '\n')
199
if self.output is None:
200
from bzrlib import trace
201
self.output = trace.note
202
self.suppress_root_add = suppress_root_add
203
self.modified_map = {'kind changed': 'K',
210
self.versioned_map = {'added': '+', # versioned target
211
'unchanged': ' ', # versioned in both
212
'removed': '-', # versioned in source
213
'unversioned': '?', # versioned in neither
215
self.unversioned_filter = unversioned_filter
216
if view_info is None:
217
self.view_name = None
220
self.view_name = view_info[0]
221
self.view_files = view_info[1]
222
self.output("Operating on whole tree but only reporting on "
223
"'%s' view." % (self.view_name,))
225
def report(self, file_id, paths, versioned, renamed, modified, exe_change,
227
"""Report one change to a file
229
:param file_id: The file_id of the file
230
:param path: The old and new paths as generated by Tree.iter_changes.
231
:param versioned: may be 'added', 'removed', 'unchanged', or
233
:param renamed: may be True or False
234
:param modified: may be 'created', 'deleted', 'kind changed',
235
'modified' or 'unchanged'.
236
:param exe_change: True if the execute bit has changed
237
:param kind: A pair of file kinds, as generated by Tree.iter_changes.
238
None indicates no file present.
242
if paths[1] == '' and versioned == 'added' and self.suppress_root_add:
244
if self.view_files and not osutils.is_inside_any(self.view_files,
247
if versioned == 'unversioned':
248
# skip ignored unversioned files if needed.
249
if self.unversioned_filter is not None:
250
if self.unversioned_filter(paths[1]):
252
# dont show a content change in the output.
253
modified = 'unchanged'
254
# we show both paths in the following situations:
255
# the file versioning is unchanged AND
256
# ( the path is different OR
257
# the kind is different)
258
if (versioned == 'unchanged' and
259
(renamed or modified == 'kind changed')):
261
# on a rename, we show old and new
262
old_path, path = paths
264
# if it's not renamed, we're showing both for kind changes
265
# so only show the new path
266
old_path, path = paths[1], paths[1]
267
# if the file is not missing in the source, we show its kind
268
# when we show two paths.
269
if kind[0] is not None:
270
old_path += osutils.kind_marker(kind[0])
272
elif versioned == 'removed':
273
# not present in target
282
rename = self.versioned_map[versioned]
283
# we show the old kind on the new path when the content is deleted.
284
if modified == 'deleted':
285
path += osutils.kind_marker(kind[0])
286
# otherwise we always show the current kind when there is one
287
elif kind[1] is not None:
288
path += osutils.kind_marker(kind[1])
293
self.output("%s%s%s %s%s", rename, self.modified_map[modified], exe,
296
def report_changes(change_iterator, reporter):
297
"""Report the changes from a change iterator.
299
This is essentially a translation from low-level to medium-level changes.
300
Further processing may be required to produce a human-readable output.
301
Unfortunately, some tree-changing operations are very complex
302
:change_iterator: an iterator or sequence of changes in the format
303
generated by Tree.iter_changes
304
:param reporter: The _ChangeReporter that will report the changes.
306
versioned_change_map = {
307
(True, True) : 'unchanged',
308
(True, False) : 'removed',
309
(False, True) : 'added',
310
(False, False): 'unversioned',
312
for (file_id, path, content_change, versioned, parent_id, name, kind,
313
executable) in change_iterator:
315
# files are "renamed" if they are moved or if name changes, as long
317
if None not in name and None not in parent_id and\
318
(name[0] != name[1] or parent_id[0] != parent_id[1]):
322
if kind[0] != kind[1]:
325
elif kind[1] is None:
328
modified = "kind changed"
331
modified = "modified"
332
elif kind[0] is None:
335
modified = "unchanged"
336
if kind[1] == "file":
337
exe_change = (executable[0] != executable[1])
338
versioned_change = versioned_change_map[versioned]
339
reporter.report(file_id, path, versioned_change, renamed, modified,
342
def report_delta(to_file, delta, short_status=False, show_ids=False,
343
show_unchanged=False, indent='', filter=None):
344
"""Output this delta in status-like form to to_file.
346
:param to_file: A file-like object where the output is displayed.
348
:param delta: A TreeDelta containing the changes to be displayed
350
:param short_status: Single-line status if True.
352
:param show_ids: Output the file ids if True.
354
:param show_unchanged: Output the unchanged files if True.
356
:param indent: Added at the beginning of all output lines (for merged
359
:param filter: A callable receiving a path and a file id and
360
returning True if the path should be displayed.
363
def decorate_path(path, kind, meta_modified=None):
364
if kind == 'directory':
366
elif kind == 'symlink':
372
def show_more_renamed(item):
373
(oldpath, file_id, kind,
374
text_modified, meta_modified, newpath) = item
375
dec_new_path = decorate_path(newpath, kind, meta_modified)
376
to_file.write(' => %s' % dec_new_path)
377
if text_modified or meta_modified:
378
extra_modified.append((newpath, file_id, kind,
379
text_modified, meta_modified))
381
def show_more_kind_changed(item):
382
(path, file_id, old_kind, new_kind) = item
383
to_file.write(' (%s => %s)' % (old_kind, new_kind))
385
def show_path(path, file_id, kind, meta_modified,
386
default_format, with_file_id_format):
387
dec_path = decorate_path(path, kind, meta_modified)
389
to_file.write(with_file_id_format % dec_path)
391
to_file.write(default_format % dec_path)
393
def show_list(files, long_status_name, short_status_letter,
394
default_format='%s', with_file_id_format='%-30s',
399
prefix = short_status_letter
402
prefix = indent + prefix + ' '
405
path, file_id, kind = item[:3]
406
if (filter is not None and not filter(path, file_id)):
408
if not header_shown and not short_status:
409
to_file.write(indent + long_status_name + ':\n')
413
meta_modified = item[4]
415
to_file.write(prefix)
416
show_path(path, file_id, kind, meta_modified,
417
default_format, with_file_id_format)
418
if show_more is not None:
421
to_file.write(' %s' % file_id)
424
show_list(delta.removed, 'removed', 'D')
425
show_list(delta.added, 'added', 'A')
426
show_list(delta.missing, 'missing', '!')
428
# Reorder delta.renamed tuples so that all lists share the same
429
# order for their 3 first fields and that they also begin like
430
# the delta.modified tuples
431
renamed = [(p, i, k, tm, mm, np)
432
for p, np, i, k, tm, mm in delta.renamed]
433
show_list(renamed, 'renamed', 'R', with_file_id_format='%s',
434
show_more=show_more_renamed)
435
show_list(delta.kind_changed, 'kind changed', 'K',
436
with_file_id_format='%s',
437
show_more=show_more_kind_changed)
438
show_list(delta.modified + extra_modified, 'modified', 'M')
440
show_list(delta.unchanged, 'unchanged', 'S')
442
show_list(delta.unversioned, 'unknown', ' ')
added
removed
bzrlib/delta.py
