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., 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:
111
def show(self, to_file, show_ids=False, show_unchanged=False,
112
short_status=False, indent='',
114
"""Output this delta in status-like form to to_file.
116
:param to_file: A file-like object where the output is displayed.
118
:param show_ids: Output the file ids if True.
120
:param show_unchanged: Output the unchanged files if True.
122
:param short_status: Single-line status if True.
124
:param indent: Added at the beginning of all output lines (for merged
127
:param filter: A callable receiving a path and a file id and
128
returning True if the path should be displayed.
131
def decorate_path(path, kind, meta_modified=None):
132
if kind == 'directory':
134
elif kind == 'symlink':
140
def show_more_renamed(item):
141
(oldpath, file_id, kind,
142
text_modified, meta_modified, newpath) = item
143
dec_new_path = decorate_path(newpath, kind, meta_modified)
144
to_file.write(' => %s' % dec_new_path)
145
if text_modified or meta_modified:
146
extra_modified.append((newpath, file_id, kind,
147
text_modified, meta_modified))
149
def show_more_kind_changed(item):
150
(path, file_id, old_kind, new_kind) = item
151
to_file.write(' (%s => %s)' % (old_kind, new_kind))
153
def show_path(path, file_id, kind, meta_modified,
154
default_format, with_file_id_format):
155
dec_path = decorate_path(path, kind, meta_modified)
157
to_file.write(with_file_id_format % dec_path)
159
to_file.write(default_format % dec_path)
161
def show_list(files, long_status_name, short_status_letter,
162
default_format='%s', with_file_id_format='%-30s',
167
prefix = short_status_letter
170
prefix = indent + prefix + ' '
173
path, file_id, kind = item[:3]
174
if (filter is not None and not filter(path, file_id)):
176
if not header_shown and not short_status:
177
to_file.write(indent + long_status_name + ':\n')
181
meta_modified = item[4]
183
to_file.write(prefix)
184
show_path(path, file_id, kind, meta_modified,
185
default_format, with_file_id_format)
186
if show_more is not None:
189
to_file.write(' %s' % file_id)
192
show_list(self.removed, 'removed', 'D')#
193
show_list(self.added, 'added', 'A')
195
# Reorder self.renamed tuples so that all lists share the same
196
# order for their 3 first fields and that they also begin like
197
# the self.modified tuples
198
renamed = [(p, i, k, tm, mm, np)
199
for p, np, i, k, tm, mm in self.renamed]
200
show_list(renamed, 'renamed', 'R', with_file_id_format='%s',
201
show_more=show_more_renamed)
202
show_list(self.kind_changed, 'kind changed', 'K',
203
with_file_id_format='%s',
204
show_more=show_more_kind_changed)
205
show_list(self.modified + extra_modified, 'modified', 'M')
207
show_list(self.unchanged, 'unchanged', 'S')
209
show_list(self.unversioned, 'unknown', ' ')
211
def get_changes_as_text(self, show_ids=False, show_unchanged=False,
214
output = StringIO.StringIO()
215
self.show(output, show_ids, show_unchanged, short_status)
216
return output.getvalue()
219
def _compare_trees(old_tree, new_tree, want_unchanged, specific_files,
220
include_root, extra_trees=None,
221
require_versioned=False, want_unversioned=False):
222
"""Worker function that implements Tree.changes_from."""
224
# mutter('start compare_trees')
226
for (file_id, path, content_change, versioned, parent_id, name, kind,
227
executable) in new_tree.iter_changes(old_tree, want_unchanged,
228
specific_files, extra_trees=extra_trees,
229
require_versioned=require_versioned,
230
want_unversioned=want_unversioned):
231
if versioned == (False, False):
232
delta.unversioned.append((path[1], None, kind[1]))
234
if not include_root and (None, None) == parent_id:
236
fully_present = tuple((versioned[x] and kind[x] is not None) for
238
if fully_present[0] != fully_present[1]:
239
if fully_present[1] is True:
240
delta.added.append((path[1], file_id, kind[1]))
242
delta.removed.append((path[0], file_id, kind[0]))
243
elif fully_present[0] is False:
245
elif name[0] != name[1] or parent_id[0] != parent_id[1]:
246
# If the name changes, or the parent_id changes, we have a rename
247
# (if we move a parent, that doesn't count as a rename for the
249
delta.renamed.append((path[0],
254
(executable[0] != executable[1])))
255
elif kind[0] != kind[1]:
256
delta.kind_changed.append((path[1], file_id, kind[0], kind[1]))
257
elif content_change or executable[0] != executable[1]:
258
delta.modified.append((path[1], file_id, kind[1],
260
(executable[0] != executable[1])))
262
delta.unchanged.append((path[1], file_id, kind[1]))
267
# TODO: jam 20060529 These lists shouldn't need to be sorted
268
# since we added them in alphabetical order.
269
delta.modified.sort()
270
delta.unchanged.sort()
275
class _ChangeReporter(object):
276
"""Report changes between two trees"""
278
def __init__(self, output=None, suppress_root_add=True,
279
output_file=None, unversioned_filter=None, view_info=None):
282
:param output: a function with the signature of trace.note, i.e.
283
accepts a format and parameters.
284
:param supress_root_add: If true, adding the root will be ignored
285
(i.e. when a tree has just been initted)
286
:param output_file: If supplied, a file-like object to write to.
287
Only one of output and output_file may be supplied.
288
:param unversioned_filter: A filter function to be called on
289
unversioned files. This should return True to ignore a path.
290
By default, no filtering takes place.
291
:param view_info: A tuple of view_name,view_files if only
292
items inside a view are to be reported on, or None for
295
if output_file is not None:
296
if output is not None:
297
raise BzrError('Cannot specify both output and output_file')
298
def output(fmt, *args):
299
output_file.write((fmt % args) + '\n')
301
if self.output is None:
302
from bzrlib import trace
303
self.output = trace.note
304
self.suppress_root_add = suppress_root_add
305
self.modified_map = {'kind changed': 'K',
310
self.versioned_map = {'added': '+', # versioned target
311
'unchanged': ' ', # versioned in both
312
'removed': '-', # versioned in source
313
'unversioned': '?', # versioned in neither
315
self.unversioned_filter = unversioned_filter
316
if view_info is None:
317
self.view_name = None
320
self.view_name = view_info[0]
321
self.view_files = view_info[1]
322
self.output("Operating on whole tree but only reporting on "
323
"'%s' view." % (self.view_name,))
325
def report(self, file_id, paths, versioned, renamed, modified, exe_change,
327
"""Report one change to a file
329
:param file_id: The file_id of the file
330
:param path: The old and new paths as generated by Tree.iter_changes.
331
:param versioned: may be 'added', 'removed', 'unchanged', or
333
:param renamed: may be True or False
334
:param modified: may be 'created', 'deleted', 'kind changed',
335
'modified' or 'unchanged'.
336
:param exe_change: True if the execute bit has changed
337
:param kind: A pair of file kinds, as generated by Tree.iter_changes.
338
None indicates no file present.
342
if paths[1] == '' and versioned == 'added' and self.suppress_root_add:
344
if self.view_files and not osutils.is_inside_any(self.view_files,
347
if versioned == 'unversioned':
348
# skip ignored unversioned files if needed.
349
if self.unversioned_filter is not None:
350
if self.unversioned_filter(paths[1]):
352
# dont show a content change in the output.
353
modified = 'unchanged'
354
# we show both paths in the following situations:
355
# the file versioning is unchanged AND
356
# ( the path is different OR
357
# the kind is different)
358
if (versioned == 'unchanged' and
359
(renamed or modified == 'kind changed')):
361
# on a rename, we show old and new
362
old_path, path = paths
364
# if it's not renamed, we're showing both for kind changes
365
# so only show the new path
366
old_path, path = paths[1], paths[1]
367
# if the file is not missing in the source, we show its kind
368
# when we show two paths.
369
if kind[0] is not None:
370
old_path += osutils.kind_marker(kind[0])
372
elif versioned == 'removed':
373
# not present in target
382
rename = self.versioned_map[versioned]
383
# we show the old kind on the new path when the content is deleted.
384
if modified == 'deleted':
385
path += osutils.kind_marker(kind[0])
386
# otherwise we always show the current kind when there is one
387
elif kind[1] is not None:
388
path += osutils.kind_marker(kind[1])
393
self.output("%s%s%s %s%s", rename, self.modified_map[modified], exe,
397
def report_changes(change_iterator, reporter):
398
"""Report the changes from a change iterator.
400
This is essentially a translation from low-level to medium-level changes.
401
Further processing may be required to produce a human-readable output.
402
Unfortunately, some tree-changing operations are very complex
403
:change_iterator: an iterator or sequence of changes in the format
404
generated by Tree.iter_changes
405
:param reporter: The _ChangeReporter that will report the changes.
407
versioned_change_map = {
408
(True, True) : 'unchanged',
409
(True, False) : 'removed',
410
(False, True) : 'added',
411
(False, False): 'unversioned',
413
for (file_id, path, content_change, versioned, parent_id, name, kind,
414
executable) in change_iterator:
416
# files are "renamed" if they are moved or if name changes, as long
418
if None not in name and None not in parent_id and\
419
(name[0] != name[1] or parent_id[0] != parent_id[1]):
423
if kind[0] != kind[1]:
426
elif kind[1] is None:
429
modified = "kind changed"
432
modified = "modified"
434
modified = "unchanged"
435
if kind[1] == "file":
436
exe_change = (executable[0] != executable[1])
437
versioned_change = versioned_change_map[versioned]
438
reporter.report(file_id, path, versioned_change, renamed, modified,
added
removed
bzrlib/delta.py
