15
15
# along with this program; if not, write to the Free Software
16
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
18
from trace import mutter
27
def diff_trees(old_tree, new_tree):
28
"""Compute diff between two trees.
30
They may be in different branches and may be working or historical
33
Yields a sequence of (state, id, old_name, new_name, kind).
34
Each filename and each id is listed only once.
37
## TODO: Compare files before diffing; only mention those that have changed
39
## TODO: Set nice names in the headers, maybe include diffstat
41
## TODO: Perhaps make this a generator rather than using
44
## TODO: Allow specifying a list of files to compare, rather than
45
## doing the whole tree? (Not urgent.)
47
## TODO: Allow diffing any two inventories, not just the
48
## current one against one. We mgiht need to specify two
49
## stores to look for the files if diffing two branches. That
50
## might imply this shouldn't be primarily a Branch method.
52
## XXX: This doesn't report on unknown files; that can be done
53
## from a separate method.
55
old_it = old_tree.list_files()
56
new_it = new_tree.list_files()
64
old_item = next(old_it)
65
new_item = next(new_it)
67
# We step through the two sorted iterators in parallel, trying to
70
while (old_item != None) or (new_item != None):
71
# OK, we still have some remaining on both, but they may be
74
old_name, old_class, old_kind, old_id = old_item
79
new_name, new_class, new_kind, new_id = new_item
83
mutter(" diff pairwise %r" % (old_item,))
84
mutter(" %r" % (new_item,))
87
# can't handle the old tree being a WorkingTree
88
assert old_class == 'V'
90
if new_item and (new_class != 'V'):
91
yield new_class, None, None, new_name, new_kind
92
new_item = next(new_it)
93
elif (not new_item) or (old_item and (old_name < new_name)):
94
mutter(" extra entry in old-tree sequence")
95
if new_tree.has_id(old_id):
96
# will be mentioned as renamed under new name
99
yield 'D', old_id, old_name, None, old_kind
100
old_item = next(old_it)
101
elif (not old_item) or (new_item and (new_name < old_name)):
102
mutter(" extra entry in new-tree sequence")
103
if old_tree.has_id(new_id):
104
yield 'R', new_id, old_tree.id2path(new_id), new_name, new_kind
106
yield 'A', new_id, None, new_name, new_kind
107
new_item = next(new_it)
108
elif old_id != new_id:
109
assert old_name == new_name
110
# both trees have a file of this name, but it is not the
111
# same file. in other words, the old filename has been
112
# overwritten by either a newly-added or a renamed file.
113
# (should we return something about the overwritten file?)
114
if old_tree.has_id(new_id):
115
# renaming, overlying a deleted file
116
yield 'R', new_id, old_tree.id2path(new_id), new_name, new_kind
118
yield 'A', new_id, None, new_name, new_kind
120
new_item = next(new_it)
121
old_item = next(old_it)
123
assert old_id == new_id
124
assert old_name == new_name
125
assert old_kind == new_kind
127
if old_kind == 'directory':
128
yield '.', new_id, old_name, new_name, new_kind
129
elif old_tree.get_file_size(old_id) != new_tree.get_file_size(old_id):
130
mutter(" file size has changed, must be different")
131
yield 'M', new_id, old_name, new_name, new_kind
132
elif old_tree.get_file_sha1(old_id) == new_tree.get_file_sha1(old_id):
133
mutter(" SHA1 indicates they're identical")
134
## assert compare_files(old_tree.get_file(i), new_tree.get_file(i))
135
yield '.', new_id, old_name, new_name, new_kind
137
mutter(" quick compare shows different")
138
yield 'M', new_id, old_name, new_name, new_kind
140
new_item = next(new_it)
141
old_item = next(old_it)
19
from errors import BzrError
22
def internal_diff(old_label, oldlines, new_label, newlines, to_file):
25
# FIXME: difflib is wrong if there is no trailing newline.
26
# The syntax used by patch seems to be "\ No newline at
27
# end of file" following the last diff line from that
28
# file. This is not trivial to insert into the
29
# unified_diff output and it might be better to just fix
30
# or replace that function.
32
# In the meantime we at least make sure the patch isn't
36
# Special workaround for Python2.3, where difflib fails if
37
# both sequences are empty.
38
if not oldlines and not newlines:
43
if oldlines and (oldlines[-1][-1] != '\n'):
46
if newlines and (newlines[-1][-1] != '\n'):
50
ud = difflib.unified_diff(oldlines, newlines,
51
fromfile=old_label, tofile=new_label)
53
# work-around for difflib being too smart for its own good
54
# if /dev/null is "1,0", patch won't recognize it as /dev/null
57
ud[2] = ud[2].replace('-1,0', '-0,0')
60
ud[2] = ud[2].replace('+1,0', '+0,0')
62
to_file.writelines(ud)
64
print >>to_file, "\\ No newline at end of file"
70
def external_diff(old_label, oldlines, new_label, newlines, to_file,
72
"""Display a diff by calling out to the external diff program."""
75
if to_file != sys.stdout:
76
raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
79
# make sure our own output is properly ordered before the diff
82
from tempfile import NamedTemporaryFile
85
oldtmpf = NamedTemporaryFile()
86
newtmpf = NamedTemporaryFile()
89
# TODO: perhaps a special case for comparing to or from the empty
90
# sequence; can just use /dev/null on Unix
92
# TODO: if either of the files being compared already exists as a
93
# regular named file (e.g. in the working directory) then we can
94
# compare directly to that, rather than copying it.
96
oldtmpf.writelines(oldlines)
97
newtmpf.writelines(newlines)
105
'--label', old_label,
107
'--label', new_label,
110
# diff only allows one style to be specified; they don't override.
111
# note that some of these take optargs, and the optargs can be
112
# directly appended to the options.
113
# this is only an approximate parser; it doesn't properly understand
115
for s in ['-c', '-u', '-C', '-U',
120
'-y', '--side-by-side',
132
diffcmd.extend(diff_opts)
134
rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
136
if rc != 0 and rc != 1:
137
# returns 1 if files differ; that's OK
139
msg = 'signal %d' % (-rc)
141
msg = 'exit code %d' % rc
143
raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
145
oldtmpf.close() # and delete
150
def show_diff(b, revision, specific_files, external_diff_options=None):
151
"""Shortcut for showing the diff to the working tree.
157
None for each, or otherwise the old revision to compare against.
159
The more general form is show_diff_trees(), where the caller
160
supplies any two trees.
165
old_tree = b.basis_tree()
167
old_tree = b.revision_tree(b.lookup_revision(revision))
169
new_tree = b.working_tree()
171
show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
172
external_diff_options)
176
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
177
external_diff_options=None):
178
"""Show in text form the changes from one tree to another.
181
If set, include only changes to these files.
183
external_diff_options
184
If set, use an external GNU diff and pass these options.
187
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
191
DEVNULL = '/dev/null'
192
# Windows users, don't panic about this filename -- it is a
193
# special signal to GNU patch that the file should be created or
194
# deleted respectively.
196
# TODO: Generation of pseudo-diffs for added/deleted files could
197
# be usefully made into a much faster special case.
199
if external_diff_options:
200
assert isinstance(external_diff_options, basestring)
201
opts = external_diff_options.split()
202
def diff_file(olab, olines, nlab, nlines, to_file):
203
external_diff(olab, olines, nlab, nlines, to_file, opts)
205
diff_file = internal_diff
208
delta = compare_trees(old_tree, new_tree, want_unchanged=False,
209
specific_files=specific_files)
211
for path, file_id, kind in delta.removed:
212
print >>to_file, '*** removed %s %r' % (kind, path)
214
diff_file(old_label + path,
215
old_tree.get_file(file_id).readlines(),
220
for path, file_id, kind in delta.added:
221
print >>to_file, '*** added %s %r' % (kind, path)
226
new_tree.get_file(file_id).readlines(),
229
for old_path, new_path, file_id, kind, text_modified in delta.renamed:
230
print >>to_file, '*** renamed %s %r => %r' % (kind, old_path, new_path)
232
diff_file(old_label + old_path,
233
old_tree.get_file(file_id).readlines(),
234
new_label + new_path,
235
new_tree.get_file(file_id).readlines(),
238
for path, file_id, kind in delta.modified:
239
print >>to_file, '*** modified %s %r' % (kind, path)
241
diff_file(old_label + path,
242
old_tree.get_file(file_id).readlines(),
244
new_tree.get_file(file_id).readlines(),
249
class TreeDelta(object):
250
"""Describes changes from one tree to another.
259
(oldpath, newpath, id, kind, text_modified)
265
Each id is listed only once.
267
Files that are both modified and renamed are listed only in
268
renamed, with the text_modified flag true.
270
The lists are normally sorted when the delta is created.
279
def __eq__(self, other):
280
if not isinstance(other, TreeDelta):
282
return self.added == other.added \
283
and self.removed == other.removed \
284
and self.renamed == other.renamed \
285
and self.modified == other.modified \
286
and self.unchanged == other.unchanged
288
def __ne__(self, other):
289
return not (self == other)
292
return "TreeDelta(added=%r, removed=%r, renamed=%r, modified=%r," \
293
" unchanged=%r)" % (self.added, self.removed, self.renamed,
294
self.modified, self.unchanged)
296
def has_changed(self):
297
changes = len(self.added) + len(self.removed) + len(self.renamed)
298
changes += len(self.modified)
299
return (changes != 0)
301
def touches_file_id(self, file_id):
302
"""Return True if file_id is modified by this delta."""
303
for l in self.added, self.removed, self.modified:
307
for v in self.renamed:
313
def show(self, to_file, show_ids=False, show_unchanged=False):
314
def show_list(files):
315
for path, fid, kind in files:
316
if kind == 'directory':
318
elif kind == 'symlink':
322
print >>to_file, ' %-30s %s' % (path, fid)
324
print >>to_file, ' ', path
327
print >>to_file, 'removed:'
328
show_list(self.removed)
331
print >>to_file, 'added:'
332
show_list(self.added)
335
print >>to_file, 'renamed:'
336
for oldpath, newpath, fid, kind, text_modified in self.renamed:
338
print >>to_file, ' %s => %s %s' % (oldpath, newpath, fid)
340
print >>to_file, ' %s => %s' % (oldpath, newpath)
343
print >>to_file, 'modified:'
344
show_list(self.modified)
346
if show_unchanged and self.unchanged:
347
print >>to_file, 'unchanged:'
348
show_list(self.unchanged)
352
def compare_trees(old_tree, new_tree, want_unchanged=False, specific_files=None):
353
"""Describe changes from one tree to another.
355
Returns a TreeDelta with details of added, modified, renamed, and
358
The root entry is specifically exempt.
360
This only considers versioned files.
363
If true, also list files unchanged from one version to
367
If true, only check for changes to specified names or
371
from osutils import is_inside_any
373
old_inv = old_tree.inventory
374
new_inv = new_tree.inventory
376
mutter('start compare_trees')
378
# TODO: match for specific files can be rather smarter by finding
379
# the IDs of those files up front and then considering only that.
381
for file_id in old_tree:
382
if file_id in new_tree:
383
kind = old_inv.get_file_kind(file_id)
384
assert kind == new_inv.get_file_kind(file_id)
386
assert kind in ('file', 'directory', 'symlink', 'root_directory'), \
387
'invalid file kind %r' % kind
389
if kind == 'root_directory':
392
old_path = old_inv.id2path(file_id)
393
new_path = new_inv.id2path(file_id)
396
if (not is_inside_any(specific_files, old_path)
397
and not is_inside_any(specific_files, new_path)):
401
old_sha1 = old_tree.get_file_sha1(file_id)
402
new_sha1 = new_tree.get_file_sha1(file_id)
403
text_modified = (old_sha1 != new_sha1)
405
## mutter("no text to check for %r %r" % (file_id, kind))
406
text_modified = False
408
# TODO: Can possibly avoid calculating path strings if the
409
# two files are unchanged and their names and parents are
410
# the same and the parents are unchanged all the way up.
411
# May not be worthwhile.
413
if old_path != new_path:
414
delta.renamed.append((old_path, new_path, file_id, kind,
417
delta.modified.append((new_path, file_id, kind))
419
delta.unchanged.append((new_path, file_id, kind))
421
kind = old_inv.get_file_kind(file_id)
422
old_path = old_inv.id2path(file_id)
424
if not is_inside_any(specific_files, old_path):
426
delta.removed.append((old_path, file_id, kind))
428
mutter('start looking for new files')
429
for file_id in new_inv:
430
if file_id in old_inv:
432
new_path = new_inv.id2path(file_id)
434
if not is_inside_any(specific_files, new_path):
436
kind = new_inv.get_file_kind(file_id)
437
delta.added.append((new_path, file_id, kind))
442
delta.modified.sort()
443
delta.unchanged.sort()