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
from tempfile import NamedTemporaryFile
82
oldtmpf = NamedTemporaryFile()
83
newtmpf = NamedTemporaryFile()
86
# TODO: perhaps a special case for comparing to or from the empty
87
# sequence; can just use /dev/null on Unix
89
# TODO: if either of the files being compared already exists as a
90
# regular named file (e.g. in the working directory) then we can
91
# compare directly to that, rather than copying it.
93
oldtmpf.writelines(oldlines)
94
newtmpf.writelines(newlines)
102
'--label', old_label,
104
'--label', new_label,
107
# diff only allows one style to be specified; they don't override.
108
# note that some of these take optargs, and the optargs can be
109
# directly appended to the options.
110
# this is only an approximate parser; it doesn't properly understand
112
for s in ['-c', '-u', '-C', '-U',
117
'-y', '--side-by-side',
129
diffcmd.extend(diff_opts)
131
rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
133
if rc != 0 and rc != 1:
134
# returns 1 if files differ; that's OK
136
msg = 'signal %d' % (-rc)
138
msg = 'exit code %d' % rc
140
raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
142
oldtmpf.close() # and delete
147
def show_diff(b, revision, specific_files, external_diff_options=None):
151
old_tree = b.basis_tree()
153
old_tree = b.revision_tree(b.lookup_revision(revision))
155
new_tree = b.working_tree()
157
show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
158
external_diff_options)
162
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
163
external_diff_options=None):
164
"""Show in text form the changes from one tree to another.
167
If set, include only changes to these files.
169
external_diff_options
170
If set, use an external GNU diff and pass these options.
173
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
177
DEVNULL = '/dev/null'
178
# Windows users, don't panic about this filename -- it is a
179
# special signal to GNU patch that the file should be created or
180
# deleted respectively.
182
# TODO: Generation of pseudo-diffs for added/deleted files could
183
# be usefully made into a much faster special case.
185
if external_diff_options:
186
assert isinstance(external_diff_options, basestring)
187
opts = external_diff_options.split()
188
def diff_file(olab, olines, nlab, nlines, to_file):
189
external_diff(olab, olines, nlab, nlines, to_file, opts)
191
diff_file = internal_diff
194
delta = compare_trees(old_tree, new_tree, want_unchanged=False,
195
specific_files=specific_files)
197
for path, file_id, kind in delta.removed:
198
print '*** removed %s %r' % (kind, path)
200
diff_file(old_label + path,
201
old_tree.get_file(file_id).readlines(),
206
for path, file_id, kind in delta.added:
207
print '*** added %s %r' % (kind, path)
212
new_tree.get_file(file_id).readlines(),
215
for old_path, new_path, file_id, kind, text_modified in delta.renamed:
216
print '*** renamed %s %r => %r' % (kind, old_path, new_path)
218
diff_file(old_label + old_path,
219
old_tree.get_file(file_id).readlines(),
220
new_label + new_path,
221
new_tree.get_file(file_id).readlines(),
224
for path, file_id, kind in delta.modified:
225
print '*** modified %s %r' % (kind, path)
227
diff_file(old_label + path,
228
old_tree.get_file(file_id).readlines(),
230
new_tree.get_file(file_id).readlines(),
235
class TreeDelta(object):
236
"""Describes changes from one tree to another.
245
(oldpath, newpath, id, kind, text_modified)
251
Each id is listed only once.
253
Files that are both modified and renamed are listed only in
254
renamed, with the text_modified flag true.
256
The lists are normally sorted when the delta is created.
266
def touches_file_id(self, file_id):
267
"""Return True if file_id is modified by this delta."""
268
for l in self.added, self.removed, self.modified:
272
for v in self.renamed:
278
def show(self, to_file, show_ids=False, show_unchanged=False):
279
def show_list(files):
280
for path, fid, kind in files:
281
if kind == 'directory':
283
elif kind == 'symlink':
287
print >>to_file, ' %-30s %s' % (path, fid)
289
print >>to_file, ' ', path
292
print >>to_file, 'removed:'
293
show_list(self.removed)
296
print >>to_file, 'added:'
297
show_list(self.added)
300
print >>to_file, 'renamed:'
301
for oldpath, newpath, fid, kind, text_modified in self.renamed:
303
print >>to_file, ' %s => %s %s' % (oldpath, newpath, fid)
305
print >>to_file, ' %s => %s' % (oldpath, newpath)
308
print >>to_file, 'modified:'
309
show_list(self.modified)
311
if show_unchanged and self.unchanged:
312
print >>to_file, 'unchanged:'
313
show_list(self.unchanged)
317
def compare_trees(old_tree, new_tree, want_unchanged, specific_files=None):
318
"""Describe changes from one tree to another.
320
Returns a TreeDelta with details of added, modified, renamed, and
323
The root entry is specifically exempt.
325
This only considers versioned files.
328
If true, also list files unchanged from one version to
332
If true, only check for changes to specified names or
336
from osutils import is_inside_any
338
old_inv = old_tree.inventory
339
new_inv = new_tree.inventory
341
mutter('start compare_trees')
343
# TODO: match for specific files can be rather smarter by finding
344
# the IDs of those files up front and then considering only that.
346
for file_id in old_tree:
347
if file_id in new_tree:
348
kind = old_inv.get_file_kind(file_id)
349
assert kind == new_inv.get_file_kind(file_id)
351
assert kind in ('file', 'directory', 'symlink', 'root_directory'), \
352
'invalid file kind %r' % kind
354
if kind == 'root_directory':
357
old_path = old_inv.id2path(file_id)
358
new_path = new_inv.id2path(file_id)
361
if (not is_inside_any(specific_files, old_path)
362
and not is_inside_any(specific_files, new_path)):
366
old_sha1 = old_tree.get_file_sha1(file_id)
367
new_sha1 = new_tree.get_file_sha1(file_id)
368
text_modified = (old_sha1 != new_sha1)
370
## mutter("no text to check for %r %r" % (file_id, kind))
371
text_modified = False
373
# TODO: Can possibly avoid calculating path strings if the
374
# two files are unchanged and their names and parents are
375
# the same and the parents are unchanged all the way up.
376
# May not be worthwhile.
378
if old_path != new_path:
379
delta.renamed.append((old_path, new_path, file_id, kind,
382
delta.modified.append((new_path, file_id, kind))
384
delta.unchanged.append((new_path, file_id, kind))
386
kind = old_inv.get_file_kind(file_id)
387
old_path = old_inv.id2path(file_id)
389
if not is_inside_any(specific_files, old_path):
391
delta.removed.append((old_path, file_id, kind))
393
mutter('start looking for new files')
394
for file_id in new_inv:
395
if file_id in old_inv:
397
new_path = new_inv.id2path(file_id)
399
if not is_inside_any(specific_files, new_path):
401
kind = new_inv.get_file_kind(file_id)
402
delta.added.append((new_path, file_id, kind))
407
delta.modified.sort()
408
delta.unchanged.sort()