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, 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 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):
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.
292
if output_file is not None:
293
if output is not None:
294
raise BzrError('Cannot specify both output and output_file')
295
def output(fmt, *args):
296
output_file.write((fmt % args) + '\n')
298
if self.output is None:
299
from bzrlib import trace
300
self.output = trace.note
301
self.suppress_root_add = suppress_root_add
302
self.modified_map = {'kind changed': 'K',
307
self.versioned_map = {'added': '+', # versioned target
308
'unchanged': ' ', # versioned in both
309
'removed': '-', # versioned in source
310
'unversioned': '?', # versioned in neither
312
self.unversioned_filter = unversioned_filter
314
def report(self, file_id, paths, versioned, renamed, modified, exe_change,
316
"""Report one change to a file
318
:param file_id: The file_id of the file
319
:param path: The old and new paths as generated by Tree.iter_changes.
320
:param versioned: may be 'added', 'removed', 'unchanged', or
322
:param renamed: may be True or False
323
:param modified: may be 'created', 'deleted', 'kind changed',
324
'modified' or 'unchanged'.
325
:param exe_change: True if the execute bit has changed
326
:param kind: A pair of file kinds, as generated by Tree.iter_changes.
327
None indicates no file present.
331
if paths[1] == '' and versioned == 'added' and self.suppress_root_add:
333
if versioned == 'unversioned':
334
# skip ignored unversioned files if needed.
335
if self.unversioned_filter is not None:
336
if self.unversioned_filter(paths[1]):
338
# dont show a content change in the output.
339
modified = 'unchanged'
340
# we show both paths in the following situations:
341
# the file versioning is unchanged AND
342
# ( the path is different OR
343
# the kind is different)
344
if (versioned == 'unchanged' and
345
(renamed or modified == 'kind changed')):
347
# on a rename, we show old and new
348
old_path, path = paths
350
# if it's not renamed, we're showing both for kind changes
351
# so only show the new path
352
old_path, path = paths[1], paths[1]
353
# if the file is not missing in the source, we show its kind
354
# when we show two paths.
355
if kind[0] is not None:
356
old_path += osutils.kind_marker(kind[0])
358
elif versioned == 'removed':
359
# not present in target
368
rename = self.versioned_map[versioned]
369
# we show the old kind on the new path when the content is deleted.
370
if modified == 'deleted':
371
path += osutils.kind_marker(kind[0])
372
# otherwise we always show the current kind when there is one
373
elif kind[1] is not None:
374
path += osutils.kind_marker(kind[1])
379
self.output("%s%s%s %s%s", rename, self.modified_map[modified], exe,
383
def report_changes(change_iterator, reporter):
384
"""Report the changes from a change iterator.
386
This is essentially a translation from low-level to medium-level changes.
387
Further processing may be required to produce a human-readable output.
388
Unfortunately, some tree-changing operations are very complex
389
:change_iterator: an iterator or sequence of changes in the format
390
generated by Tree.iter_changes
391
:param reporter: The _ChangeReporter that will report the changes.
393
versioned_change_map = {
394
(True, True) : 'unchanged',
395
(True, False) : 'removed',
396
(False, True) : 'added',
397
(False, False): 'unversioned',
399
for (file_id, path, content_change, versioned, parent_id, name, kind,
400
executable) in change_iterator:
402
# files are "renamed" if they are moved or if name changes, as long
404
if None not in name and None not in parent_id and\
405
(name[0] != name[1] or parent_id[0] != parent_id[1]):
409
if kind[0] != kind[1]:
412
elif kind[1] is None:
415
modified = "kind changed"
418
modified = "modified"
420
modified = "unchanged"
421
if kind[1] == "file":
422
exe_change = (executable[0] != executable[1])
423
versioned_change = versioned_change_map[versioned]
424
reporter.report(file_id, path, versioned_change, renamed, modified,
added
removed
bzrlib/delta.py
