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
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, old_kind, new_kind)
40
(path, id, kind, text_modified, meta_modified)
46
Each id is listed only once.
48
Files that are both modified and renamed are listed only in
49
renamed, with the text_modified flag true. The text_modified
50
applies either to the content of the file or the target of the
51
symbolic link, depending of the kind of file.
53
Files are only considered renamed if their name has changed or
54
their parent directory has changed. Renaming a directory
55
does not count as renaming all its contents.
57
The lists are normally sorted when the delta is created.
63
self.kind_changed = []
68
def __eq__(self, other):
69
if not isinstance(other, TreeDelta):
71
return self.added == other.added \
72
and self.removed == other.removed \
73
and self.renamed == other.renamed \
74
and self.modified == other.modified \
75
and self.unchanged == other.unchanged \
76
and self.kind_changed == other.kind_changed \
77
and self.unversioned == other.unversioned
79
def __ne__(self, other):
80
return not (self == other)
83
return "TreeDelta(added=%r, removed=%r, renamed=%r," \
84
" kind_changed=%r, modified=%r, unchanged=%r," \
85
" unversioned=%r)" % (self.added,
86
self.removed, self.renamed, self.kind_changed, self.modified,
87
self.unchanged, self.unversioned)
89
def has_changed(self):
90
return bool(self.modified
96
def touches_file_id(self, file_id):
97
"""Return True if file_id is modified by this delta."""
98
for l in self.added, self.removed, self.modified:
102
for v in self.renamed:
105
for v in self.kind_changed:
110
def get_changes_as_text(self, show_ids=False, show_unchanged=False,
113
output = StringIO.StringIO()
114
report_delta(output, self, short_status, show_ids, show_unchanged)
115
return output.getvalue()
118
def _compare_trees(old_tree, new_tree, want_unchanged, specific_files,
119
include_root, extra_trees=None,
120
require_versioned=False, want_unversioned=False):
121
"""Worker function that implements Tree.changes_from."""
123
# mutter('start compare_trees')
125
for (file_id, path, content_change, versioned, parent_id, name, kind,
126
executable) in new_tree.iter_changes(old_tree, want_unchanged,
127
specific_files, extra_trees=extra_trees,
128
require_versioned=require_versioned,
129
want_unversioned=want_unversioned):
130
if versioned == (False, False):
131
delta.unversioned.append((path[1], None, kind[1]))
133
if not include_root and (None, None) == parent_id:
135
fully_present = tuple((versioned[x] and kind[x] is not None) for
137
if fully_present[0] != fully_present[1]:
138
if fully_present[1] is True:
139
delta.added.append((path[1], file_id, kind[1]))
141
delta.removed.append((path[0], file_id, kind[0]))
142
elif fully_present[0] is False:
144
elif name[0] != name[1] or parent_id[0] != parent_id[1]:
145
# If the name changes, or the parent_id changes, we have a rename
146
# (if we move a parent, that doesn't count as a rename for the
148
delta.renamed.append((path[0],
153
(executable[0] != executable[1])))
154
elif kind[0] != kind[1]:
155
delta.kind_changed.append((path[1], file_id, kind[0], kind[1]))
156
elif content_change or executable[0] != executable[1]:
157
delta.modified.append((path[1], file_id, kind[1],
159
(executable[0] != executable[1])))
161
delta.unchanged.append((path[1], file_id, kind[1]))
166
# TODO: jam 20060529 These lists shouldn't need to be sorted
167
# since we added them in alphabetical order.
168
delta.modified.sort()
169
delta.unchanged.sort()
174
class _ChangeReporter(object):
175
"""Report changes between two trees"""
177
def __init__(self, output=None, suppress_root_add=True,
178
output_file=None, unversioned_filter=None, view_info=None):
181
:param output: a function with the signature of trace.note, i.e.
182
accepts a format and parameters.
183
:param supress_root_add: If true, adding the root will be ignored
184
(i.e. when a tree has just been initted)
185
:param output_file: If supplied, a file-like object to write to.
186
Only one of output and output_file may be supplied.
187
:param unversioned_filter: A filter function to be called on
188
unversioned files. This should return True to ignore a path.
189
By default, no filtering takes place.
190
:param view_info: A tuple of view_name,view_files if only
191
items inside a view are to be reported on, or None for
194
if output_file is not None:
195
if output is not None:
196
raise BzrError('Cannot specify both output and output_file')
197
def output(fmt, *args):
198
output_file.write((fmt % args) + '\n')
200
if self.output is None:
201
from bzrlib import trace
202
self.output = trace.note
203
self.suppress_root_add = suppress_root_add
204
self.modified_map = {'kind changed': 'K',
209
self.versioned_map = {'added': '+', # versioned target
210
'unchanged': ' ', # versioned in both
211
'removed': '-', # versioned in source
212
'unversioned': '?', # versioned in neither
214
self.unversioned_filter = unversioned_filter
215
if view_info is None:
216
self.view_name = None
219
self.view_name = view_info[0]
220
self.view_files = view_info[1]
221
self.output("Operating on whole tree but only reporting on "
222
"'%s' view." % (self.view_name,))
224
def report(self, file_id, paths, versioned, renamed, modified, exe_change,
226
"""Report one change to a file
228
:param file_id: The file_id of the file
229
:param path: The old and new paths as generated by Tree.iter_changes.
230
:param versioned: may be 'added', 'removed', 'unchanged', or
232
:param renamed: may be True or False
233
:param modified: may be 'created', 'deleted', 'kind changed',
234
'modified' or 'unchanged'.
235
:param exe_change: True if the execute bit has changed
236
:param kind: A pair of file kinds, as generated by Tree.iter_changes.
237
None indicates no file present.
241
if paths[1] == '' and versioned == 'added' and self.suppress_root_add:
243
if self.view_files and not osutils.is_inside_any(self.view_files,
246
if versioned == 'unversioned':
247
# skip ignored unversioned files if needed.
248
if self.unversioned_filter is not None:
249
if self.unversioned_filter(paths[1]):
251
# dont show a content change in the output.
252
modified = 'unchanged'
253
# we show both paths in the following situations:
254
# the file versioning is unchanged AND
255
# ( the path is different OR
256
# the kind is different)
257
if (versioned == 'unchanged' and
258
(renamed or modified == 'kind changed')):
260
# on a rename, we show old and new
261
old_path, path = paths
263
# if it's not renamed, we're showing both for kind changes
264
# so only show the new path
265
old_path, path = paths[1], paths[1]
266
# if the file is not missing in the source, we show its kind
267
# when we show two paths.
268
if kind[0] is not None:
269
old_path += osutils.kind_marker(kind[0])
271
elif versioned == 'removed':
272
# not present in target
281
rename = self.versioned_map[versioned]
282
# we show the old kind on the new path when the content is deleted.
283
if modified == 'deleted':
284
path += osutils.kind_marker(kind[0])
285
# otherwise we always show the current kind when there is one
286
elif kind[1] is not None:
287
path += osutils.kind_marker(kind[1])
292
self.output("%s%s%s %s%s", rename, self.modified_map[modified], exe,
295
def report_changes(change_iterator, reporter):
296
"""Report the changes from a change iterator.
298
This is essentially a translation from low-level to medium-level changes.
299
Further processing may be required to produce a human-readable output.
300
Unfortunately, some tree-changing operations are very complex
301
:change_iterator: an iterator or sequence of changes in the format
302
generated by Tree.iter_changes
303
:param reporter: The _ChangeReporter that will report the changes.
305
versioned_change_map = {
306
(True, True) : 'unchanged',
307
(True, False) : 'removed',
308
(False, True) : 'added',
309
(False, False): 'unversioned',
311
for (file_id, path, content_change, versioned, parent_id, name, kind,
312
executable) in change_iterator:
314
# files are "renamed" if they are moved or if name changes, as long
316
if None not in name and None not in parent_id and\
317
(name[0] != name[1] or parent_id[0] != parent_id[1]):
321
if kind[0] != kind[1]:
324
elif kind[1] is None:
327
modified = "kind changed"
330
modified = "modified"
332
modified = "unchanged"
333
if kind[1] == "file":
334
exe_change = (executable[0] != executable[1])
335
versioned_change = versioned_change_map[versioned]
336
reporter.report(file_id, path, versioned_change, renamed, modified,
339
def report_delta(to_file, delta, short_status=False, show_ids=False,
340
show_unchanged=False, indent='', filter=None):
341
"""Output this delta in status-like form to to_file.
343
:param to_file: A file-like object where the output is displayed.
345
:param delta: A TreeDelta containing the changes to be displayed
347
:param short_status: Single-line status if True.
349
:param show_ids: Output the file ids if True.
351
:param show_unchanged: Output the unchanged files if True.
353
:param indent: Added at the beginning of all output lines (for merged
356
:param filter: A callable receiving a path and a file id and
357
returning True if the path should be displayed.
360
def decorate_path(path, kind, meta_modified=None):
361
if kind == 'directory':
363
elif kind == 'symlink':
369
def show_more_renamed(item):
370
(oldpath, file_id, kind,
371
text_modified, meta_modified, newpath) = item
372
dec_new_path = decorate_path(newpath, kind, meta_modified)
373
to_file.write(' => %s' % dec_new_path)
374
if text_modified or meta_modified:
375
extra_modified.append((newpath, file_id, kind,
376
text_modified, meta_modified))
378
def show_more_kind_changed(item):
379
(path, file_id, old_kind, new_kind) = item
380
to_file.write(' (%s => %s)' % (old_kind, new_kind))
382
def show_path(path, file_id, kind, meta_modified,
383
default_format, with_file_id_format):
384
dec_path = decorate_path(path, kind, meta_modified)
386
to_file.write(with_file_id_format % dec_path)
388
to_file.write(default_format % dec_path)
390
def show_list(files, long_status_name, short_status_letter,
391
default_format='%s', with_file_id_format='%-30s',
396
prefix = short_status_letter
399
prefix = indent + prefix + ' '
402
path, file_id, kind = item[:3]
403
if (filter is not None and not filter(path, file_id)):
405
if not header_shown and not short_status:
406
to_file.write(indent + long_status_name + ':\n')
410
meta_modified = item[4]
412
to_file.write(prefix)
413
show_path(path, file_id, kind, meta_modified,
414
default_format, with_file_id_format)
415
if show_more is not None:
418
to_file.write(' %s' % file_id)
421
show_list(delta.removed, 'removed', 'D')
422
show_list(delta.added, 'added', 'A')
424
# Reorder delta.renamed tuples so that all lists share the same
425
# order for their 3 first fields and that they also begin like
426
# the delta.modified tuples
427
renamed = [(p, i, k, tm, mm, np)
428
for p, np, i, k, tm, mm in delta.renamed]
429
show_list(renamed, 'renamed', 'R', with_file_id_format='%s',
430
show_more=show_more_renamed)
431
show_list(delta.kind_changed, 'kind changed', 'K',
432
with_file_id_format='%s',
433
show_more=show_more_kind_changed)
434
show_list(delta.modified + extra_modified, 'modified', 'M')
436
show_list(delta.unchanged, 'unchanged', 'S')
438
show_list(delta.unversioned, 'unknown', ' ')
added
removed
bzrlib/delta.py
