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
23
from bzrlib.symbol_versioning import deprecated_function, zero_nine
26
class TreeDelta(object):
27
"""Describes changes from one tree to another.
36
(oldpath, newpath, id, kind, text_modified, meta_modified)
38
(path, id, kind, text_modified, meta_modified)
42
Each id is listed only once.
44
Files that are both modified and renamed are listed only in
45
renamed, with the text_modified flag true. The text_modified
46
applies either to the the content of the file or the target of the
47
symbolic link, depending of the kind of file.
49
Files are only considered renamed if their name has changed or
50
their parent directory has changed. Renaming a directory
51
does not count as renaming all its contents.
53
The lists are normally sorted when the delta is created.
62
def __eq__(self, other):
63
if not isinstance(other, TreeDelta):
65
return self.added == other.added \
66
and self.removed == other.removed \
67
and self.renamed == other.renamed \
68
and self.modified == other.modified \
69
and self.unchanged == other.unchanged
71
def __ne__(self, other):
72
return not (self == other)
75
return "TreeDelta(added=%r, removed=%r, renamed=%r, modified=%r," \
76
" unchanged=%r)" % (self.added, self.removed, self.renamed,
77
self.modified, self.unchanged)
79
def has_changed(self):
80
return bool(self.modified
85
def touches_file_id(self, file_id):
86
"""Return True if file_id is modified by this delta."""
87
for l in self.added, self.removed, self.modified:
91
for v in self.renamed:
97
def show(self, to_file, show_ids=False, show_unchanged=False, short_status=False):
98
"""output this delta in status-like form to to_file."""
99
def show_list(files, short_status_letter=''):
101
path, fid, kind = item[:3]
103
if kind == 'directory':
105
elif kind == 'symlink':
108
if len(item) == 5 and item[4]:
112
print >>to_file, '%s %-30s %s' % (short_status_letter, path, fid)
114
print >>to_file, '%s %s' % (short_status_letter, path)
118
print >>to_file, 'removed:'
119
show_list(self.removed)
121
show_list(self.removed, 'D')
125
print >>to_file, 'added:'
126
show_list(self.added)
128
show_list(self.added, 'A')
133
short_status_letter = 'R'
135
print >>to_file, 'renamed:'
136
short_status_letter = ''
137
for (oldpath, newpath, fid, kind,
138
text_modified, meta_modified) in self.renamed:
139
if text_modified or meta_modified:
140
extra_modified.append((newpath, fid, kind,
141
text_modified, meta_modified))
145
print >>to_file, '%s %s => %s %s' % (short_status_letter,
146
oldpath, newpath, fid)
148
print >>to_file, '%s %s => %s' % (short_status_letter,
151
if self.modified or extra_modified:
152
short_status_letter = 'M'
154
print >>to_file, 'modified:'
155
short_status_letter = ''
156
show_list(self.modified, short_status_letter)
157
show_list(extra_modified, short_status_letter)
159
if show_unchanged and self.unchanged:
161
print >>to_file, 'unchanged:'
162
show_list(self.unchanged)
164
show_list(self.unchanged, 'S')
167
@deprecated_function(zero_nine)
168
def compare_trees(old_tree, new_tree, want_unchanged=False,
169
specific_files=None, extra_trees=None,
170
require_versioned=False):
171
"""compare_trees was deprecated in 0.10. Please see Tree.changes_from."""
172
return new_tree.changes_from(old_tree,
173
want_unchanged=want_unchanged,
174
specific_files=specific_files,
175
extra_trees=extra_trees,
176
require_versioned=require_versioned,
180
def _compare_trees(old_tree, new_tree, want_unchanged, specific_file_ids,
183
# mutter('start compare_trees')
185
for (file_id, path, content_change, versioned, parent_id, name, kind,
186
executable) in new_tree._iter_changes(old_tree, want_unchanged,
188
if not include_root and (None, None) == parent_id:
190
assert kind[0] == kind[1] or None in kind
191
# the only 'kind change' permitted is creation/deletion
192
fully_present = tuple((versioned[x] and kind[x] is not None) for
194
if fully_present[0] != fully_present[1]:
195
if fully_present[1] is True:
196
delta.added.append((path, file_id, kind[1]))
198
assert fully_present[0] is True
199
old_path = old_tree.id2path(file_id)
200
delta.removed.append((old_path, file_id, kind[0]))
201
elif fully_present[0] is False:
203
elif name[0] != name[1] or parent_id[0] != parent_id[1]:
204
# If the name changes, or the parent_id changes, we have a rename
205
# (if we move a parent, that doesn't count as a rename for the
207
old_path = old_tree.id2path(file_id)
208
delta.renamed.append((old_path,
213
(executable[0] != executable[1])))
214
elif content_change is True or executable[0] != executable[1]:
215
delta.modified.append((path, file_id, kind[1],
217
(executable[0] != executable[1])))
219
delta.unchanged.append((path, file_id, kind[1]))
224
# TODO: jam 20060529 These lists shouldn't need to be sorted
225
# since we added them in alphabetical order.
226
delta.modified.sort()
227
delta.unchanged.sort()
232
class ChangeReporter(object):
233
"""Report changes between two trees"""
235
def __init__(self, old_inventory, output=None):
236
self.old_inventory = old_inventory
238
if self.output is None:
239
from bzrlib import trace
240
self.output = trace.note
242
def report(self, file_id, path, versioned, renamed, modified, exe_change,
244
"""Report one change to a file
246
:param file_id: The file_id of the file
247
:param path: The path the file has (or would have) in the tree (as
248
generated by Tree._iter_changes)
249
:param versioned: may be 'added', 'removed', or 'unchanged'
250
:param renamed: may be True or False
251
:param modified: may be 'created', 'deleted', 'kind changed',
252
'modified' or 'unchanged'.
253
:param exe_change: True if the execute bit has changed
254
:param kind: A pair of file kinds, as generated by Tree._iter_changes.
255
None indicates no file present.
257
modified_map = {'kind changed': 'K',
262
versioned_map = {'added': '+',
267
old_path = self.old_inventory.id2path(file_id)
270
rename = versioned_map[versioned]
271
if modified == 'kind changed':
274
if modified == 'deleted':
275
path += osutils.kind_marker(kind[0])
277
path += osutils.kind_marker(kind[1])
279
old_path += "%s => " % osutils.kind_marker(kind[0])
284
self.output("%s%s%s %s%s", rename, modified_map[modified], exe,
288
def report_changes(change_iterator, reporter):
289
"""Report the changes from a change iterator.
291
This is essentially a translation from low-level to medium-level changes.
292
Further processing may be required to produce a human-readable output.
293
Unfortunately, some tree-changing operations are very complex
294
:change_iterator: an iterator or sequence of changes in the format
295
generated by Tree._iter_changes
296
:param reporter: The ChangeReporter that will report the changes.
298
for (file_id, path, content_change, versioned, parent_id, name, kind,
299
executable) in change_iterator:
301
# files are "renamed" if they are moved or if name changes, as long
303
if None not in name and (name[0] != name[1] or
304
parent_id[0] != parent_id[1]):
308
if kind[0] != kind[1]:
311
elif kind[1] is None:
314
modified = "kind changed"
317
modified = "modified"
319
modified = "unchanged"
320
if kind[1] == "file":
321
exe_change = (executable[0] != executable[1])
322
if versioned[0] != versioned[1]:
324
versioned_change = "removed"
326
versioned_change = "added"
328
versioned_change = "unchanged"
329
reporter.report(file_id, path, versioned_change, renamed, modified,
added
removed
bzrlib/delta.py
