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
18
20
from trace import mutter
19
21
from errors import BzrError
22
# TODO: Rather than building a changeset object, we should probably
23
# invoke callbacks on an object. That object can either accumulate a
24
# list, write them out directly, etc etc.
26
def internal_diff(old_label, oldlines, new_label, newlines, to_file):
29
# FIXME: difflib is wrong if there is no trailing newline.
30
# The syntax used by patch seems to be "\ No newline at
31
# end of file" following the last diff line from that
32
# file. This is not trivial to insert into the
33
# unified_diff output and it might be better to just fix
34
# or replace that function.
36
# In the meantime we at least make sure the patch isn't
40
# Special workaround for Python2.3, where difflib fails if
41
# both sequences are empty.
42
if not oldlines and not newlines:
47
if oldlines and (oldlines[-1][-1] != '\n'):
50
if newlines and (newlines[-1][-1] != '\n'):
54
ud = difflib.unified_diff(oldlines, newlines,
55
fromfile=old_label, tofile=new_label)
57
# work-around for difflib being too smart for its own good
58
# if /dev/null is "1,0", patch won't recognize it as /dev/null
61
ud[2] = ud[2].replace('-1,0', '-0,0')
64
ud[2] = ud[2].replace('+1,0', '+0,0')
69
print >>to_file, "\\ No newline at end of file"
75
def external_diff(old_label, oldlines, new_label, newlines, to_file,
77
"""Display a diff by calling out to the external diff program."""
80
if to_file != sys.stdout:
81
raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
84
# make sure our own output is properly ordered before the diff
87
from tempfile import NamedTemporaryFile
90
oldtmpf = NamedTemporaryFile()
91
newtmpf = NamedTemporaryFile()
94
# TODO: perhaps a special case for comparing to or from the empty
95
# sequence; can just use /dev/null on Unix
97
# TODO: if either of the files being compared already exists as a
98
# regular named file (e.g. in the working directory) then we can
99
# compare directly to that, rather than copying it.
101
oldtmpf.writelines(oldlines)
102
newtmpf.writelines(newlines)
110
'--label', old_label,
112
'--label', new_label,
115
# diff only allows one style to be specified; they don't override.
116
# note that some of these take optargs, and the optargs can be
117
# directly appended to the options.
118
# this is only an approximate parser; it doesn't properly understand
120
for s in ['-c', '-u', '-C', '-U',
125
'-y', '--side-by-side',
137
diffcmd.extend(diff_opts)
139
rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
141
if rc != 0 and rc != 1:
142
# returns 1 if files differ; that's OK
144
msg = 'signal %d' % (-rc)
146
msg = 'exit code %d' % rc
148
raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
150
oldtmpf.close() # and delete
155
def show_diff(b, revision, specific_files, external_diff_options=None):
156
"""Shortcut for showing the diff to the working tree.
162
None for each, or otherwise the old revision to compare against.
164
The more general form is show_diff_trees(), where the caller
165
supplies any two trees.
24
def diff_trees(old_tree, new_tree):
25
"""Compute diff between two trees.
27
They may be in different branches and may be working or historical
30
Yields a sequence of (state, id, old_name, new_name, kind).
31
Each filename and each id is listed only once.
34
## TODO: Compare files before diffing; only mention those that have changed
36
## TODO: Set nice names in the headers, maybe include diffstat
38
## TODO: Perhaps make this a generator rather than using
41
## TODO: Allow specifying a list of files to compare, rather than
42
## doing the whole tree? (Not urgent.)
44
## TODO: Allow diffing any two inventories, not just the
45
## current one against one. We mgiht need to specify two
46
## stores to look for the files if diffing two branches. That
47
## might imply this shouldn't be primarily a Branch method.
49
## XXX: This doesn't report on unknown files; that can be done
50
## from a separate method.
52
old_it = old_tree.list_files()
53
new_it = new_tree.list_files()
61
old_item = next(old_it)
62
new_item = next(new_it)
64
# We step through the two sorted iterators in parallel, trying to
67
while (old_item != None) or (new_item != None):
68
# OK, we still have some remaining on both, but they may be
71
old_name, old_class, old_kind, old_id = old_item
76
new_name, new_class, new_kind, new_id = new_item
80
mutter(" diff pairwise %r" % (old_item,))
81
mutter(" %r" % (new_item,))
84
# can't handle the old tree being a WorkingTree
85
assert old_class == 'V'
87
if new_item and (new_class != 'V'):
88
yield new_class, None, None, new_name, new_kind
89
new_item = next(new_it)
90
elif (not new_item) or (old_item and (old_name < new_name)):
91
mutter(" extra entry in old-tree sequence")
92
if new_tree.has_id(old_id):
93
# will be mentioned as renamed under new name
96
yield 'D', old_id, old_name, None, old_kind
97
old_item = next(old_it)
98
elif (not old_item) or (new_item and (new_name < old_name)):
99
mutter(" extra entry in new-tree sequence")
100
if old_tree.has_id(new_id):
101
yield 'R', new_id, old_tree.id2path(new_id), new_name, new_kind
103
yield 'A', new_id, None, new_name, new_kind
104
new_item = next(new_it)
105
elif old_id != new_id:
106
assert old_name == new_name
107
# both trees have a file of this name, but it is not the
108
# same file. in other words, the old filename has been
109
# overwritten by either a newly-added or a renamed file.
110
# (should we return something about the overwritten file?)
111
if old_tree.has_id(new_id):
112
# renaming, overlying a deleted file
113
yield 'R', new_id, old_tree.id2path(new_id), new_name, new_kind
115
yield 'A', new_id, None, new_name, new_kind
117
new_item = next(new_it)
118
old_item = next(old_it)
120
assert old_id == new_id
121
assert old_id != None
122
assert old_name == new_name
123
assert old_kind == new_kind
125
if old_kind == 'directory':
126
yield '.', new_id, old_name, new_name, new_kind
127
elif old_tree.get_file_size(old_id) != new_tree.get_file_size(old_id):
128
mutter(" file size has changed, must be different")
129
yield 'M', new_id, old_name, new_name, new_kind
130
elif old_tree.get_file_sha1(old_id) == new_tree.get_file_sha1(old_id):
131
mutter(" SHA1 indicates they're identical")
132
## assert compare_files(old_tree.get_file(i), new_tree.get_file(i))
133
yield '.', new_id, old_name, new_name, new_kind
135
mutter(" quick compare shows different")
136
yield 'M', new_id, old_name, new_name, new_kind
138
new_item = next(new_it)
139
old_item = next(old_it)
143
def show_diff(b, revision, file_list):
144
import difflib, sys, types
169
146
if revision == None:
170
147
old_tree = b.basis_tree()
201
162
# TODO: Generation of pseudo-diffs for added/deleted files could
202
163
# be usefully made into a much faster special case.
204
if external_diff_options:
205
assert isinstance(external_diff_options, basestring)
206
opts = external_diff_options.split()
207
def diff_file(olab, olines, nlab, nlines, to_file):
208
external_diff(olab, olines, nlab, nlines, to_file, opts)
210
diff_file = internal_diff
165
# TODO: Better to return them in sorted order I think.
168
file_list = [b.relpath(f) for f in file_list]
170
# FIXME: If given a file list, compare only those files rather
171
# than comparing everything and then throwing stuff away.
213
delta = compare_trees(old_tree, new_tree, want_unchanged=False,
214
specific_files=specific_files)
216
for path, file_id, kind in delta.removed:
217
print >>to_file, '*** removed %s %r' % (kind, path)
219
diff_file(old_label + path,
220
old_tree.get_file(file_id).readlines(),
225
for path, file_id, kind in delta.added:
226
print >>to_file, '*** added %s %r' % (kind, path)
231
new_tree.get_file(file_id).readlines(),
234
for old_path, new_path, file_id, kind, text_modified in delta.renamed:
235
print >>to_file, '*** renamed %s %r => %r' % (kind, old_path, new_path)
237
diff_file(old_label + old_path,
238
old_tree.get_file(file_id).readlines(),
239
new_label + new_path,
240
new_tree.get_file(file_id).readlines(),
243
for path, file_id, kind in delta.modified:
244
print >>to_file, '*** modified %s %r' % (kind, path)
246
diff_file(old_label + path,
247
old_tree.get_file(file_id).readlines(),
249
new_tree.get_file(file_id).readlines(),
254
class TreeDelta(object):
173
for file_state, fid, old_name, new_name, kind in diff_trees(old_tree, new_tree):
175
if file_list and (new_name not in file_list):
178
# Don't show this by default; maybe do it if an option is passed
179
# idlabel = ' {%s}' % fid
182
def diffit(oldlines, newlines, **kw):
184
# FIXME: difflib is wrong if there is no trailing newline.
185
# The syntax used by patch seems to be "\ No newline at
186
# end of file" following the last diff line from that
187
# file. This is not trivial to insert into the
188
# unified_diff output and it might be better to just fix
189
# or replace that function.
191
# In the meantime we at least make sure the patch isn't
195
# Special workaround for Python2.3, where difflib fails if
196
# both sequences are empty.
197
if not oldlines and not newlines:
202
if oldlines and (oldlines[-1][-1] != '\n'):
205
if newlines and (newlines[-1][-1] != '\n'):
209
ud = difflib.unified_diff(oldlines, newlines, **kw)
211
# work-around for difflib being too smart for its own good
212
# if /dev/null is "1,0", patch won't recognize it as /dev/null
215
ud[2] = ud[2].replace('-1,0', '-0,0')
218
ud[2] = ud[2].replace('+1,0', '+0,0')
220
sys.stdout.writelines(ud)
222
print "\\ No newline at end of file"
223
sys.stdout.write('\n')
225
if file_state in ['.', '?', 'I']:
227
elif file_state == 'A':
228
print '*** added %s %r' % (kind, new_name)
231
new_tree.get_file(fid).readlines(),
233
tofile=new_label + new_name + idlabel)
234
elif file_state == 'D':
235
assert isinstance(old_name, types.StringTypes)
236
print '*** deleted %s %r' % (kind, old_name)
238
diffit(old_tree.get_file(fid).readlines(), [],
239
fromfile=old_label + old_name + idlabel,
241
elif file_state in ['M', 'R']:
242
if file_state == 'M':
243
assert kind == 'file'
244
assert old_name == new_name
245
print '*** modified %s %r' % (kind, new_name)
246
elif file_state == 'R':
247
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
250
diffit(old_tree.get_file(fid).readlines(),
251
new_tree.get_file(fid).readlines(),
252
fromfile=old_label + old_name + idlabel,
253
tofile=new_label + new_name)
255
raise BzrError("can't represent state %s {%s}" % (file_state, fid))
255
260
"""Describes changes from one tree to another.
257
262
Contains four lists:
264
(oldpath, newpath, id, kind, text_modified)
269
(oldpath, newpath, id)
270
Each id is listed only once.
272
Files that are both modified and renamed are listed only in
273
renamed, with the text_modified flag true.
275
Files are only considered renamed if their name has changed or
276
their parent directory has changed. Renaming a directory
277
does not count as renaming all its contents.
279
The lists are normally sorted when the delta is created.
273
A path may occur in more than one list if it was e.g. deleted
274
under an old id and renamed into place in a new id.
276
Files are listed in either modified or renamed, not both. In
277
other words, renamed files may also be modified.
281
279
def __init__(self):
283
281
self.removed = []
284
282
self.renamed = []
285
283
self.modified = []
288
def __eq__(self, other):
289
if not isinstance(other, TreeDelta):
291
return self.added == other.added \
292
and self.removed == other.removed \
293
and self.renamed == other.renamed \
294
and self.modified == other.modified \
295
and self.unchanged == other.unchanged
297
def __ne__(self, other):
298
return not (self == other)
301
return "TreeDelta(added=%r, removed=%r, renamed=%r, modified=%r," \
302
" unchanged=%r)" % (self.added, self.removed, self.renamed,
303
self.modified, self.unchanged)
305
def has_changed(self):
306
changes = len(self.added) + len(self.removed) + len(self.renamed)
307
changes += len(self.modified)
308
return (changes != 0)
310
def touches_file_id(self, file_id):
311
"""Return True if file_id is modified by this delta."""
312
for l in self.added, self.removed, self.modified:
316
for v in self.renamed:
322
def show(self, to_file, show_ids=False, show_unchanged=False):
323
def show_list(files):
324
for path, fid, kind in files:
325
if kind == 'directory':
327
elif kind == 'symlink':
331
print >>to_file, ' %-30s %s' % (path, fid)
333
print >>to_file, ' ', path
336
print >>to_file, 'removed:'
337
show_list(self.removed)
340
print >>to_file, 'added:'
341
show_list(self.added)
344
print >>to_file, 'renamed:'
345
for oldpath, newpath, fid, kind, text_modified in self.renamed:
347
print >>to_file, ' %s => %s %s' % (oldpath, newpath, fid)
349
print >>to_file, ' %s => %s' % (oldpath, newpath)
352
print >>to_file, 'modified:'
353
show_list(self.modified)
355
if show_unchanged and self.unchanged:
356
print >>to_file, 'unchanged:'
357
show_list(self.unchanged)
361
def compare_trees(old_tree, new_tree, want_unchanged=False, specific_files=None):
362
"""Describe changes from one tree to another.
364
Returns a TreeDelta with details of added, modified, renamed, and
367
The root entry is specifically exempt.
369
This only considers versioned files.
372
If true, also list files unchanged from one version to
376
If true, only check for changes to specified names or
286
def compare_inventories(old_inv, new_inv):
287
"""Return a TreeDelta object describing changes between inventories.
289
This only describes changes in the shape of the tree, not the
292
This is an alternative to diff_trees() and should probably
293
eventually replace it.
380
from osutils import is_inside_any
382
old_inv = old_tree.inventory
383
new_inv = new_tree.inventory
295
old_ids = old_inv.id_set()
296
new_ids = new_inv.id_set()
384
297
delta = TreeDelta()
385
mutter('start compare_trees')
387
# TODO: match for specific files can be rather smarter by finding
388
# the IDs of those files up front and then considering only that.
390
for file_id in old_tree:
391
if file_id in new_tree:
392
kind = old_inv.get_file_kind(file_id)
393
assert kind == new_inv.get_file_kind(file_id)
395
assert kind in ('file', 'directory', 'symlink', 'root_directory'), \
396
'invalid file kind %r' % kind
398
if kind == 'root_directory':
401
old_path = old_inv.id2path(file_id)
402
new_path = new_inv.id2path(file_id)
404
old_ie = old_inv[file_id]
405
new_ie = new_inv[file_id]
408
if (not is_inside_any(specific_files, old_path)
409
and not is_inside_any(specific_files, new_path)):
413
old_sha1 = old_tree.get_file_sha1(file_id)
414
new_sha1 = new_tree.get_file_sha1(file_id)
415
text_modified = (old_sha1 != new_sha1)
417
## mutter("no text to check for %r %r" % (file_id, kind))
418
text_modified = False
420
# TODO: Can possibly avoid calculating path strings if the
421
# two files are unchanged and their names and parents are
422
# the same and the parents are unchanged all the way up.
423
# May not be worthwhile.
425
if (old_ie.name != new_ie.name
426
or old_ie.parent_id != new_ie.parent_id):
427
delta.renamed.append((old_path, new_path, file_id, kind,
430
delta.modified.append((new_path, file_id, kind))
432
delta.unchanged.append((new_path, file_id, kind))
434
kind = old_inv.get_file_kind(file_id)
435
old_path = old_inv.id2path(file_id)
437
if not is_inside_any(specific_files, old_path):
439
delta.removed.append((old_path, file_id, kind))
441
mutter('start looking for new files')
442
for file_id in new_inv:
443
if file_id in old_inv:
445
new_path = new_inv.id2path(file_id)
447
if not is_inside_any(specific_files, new_path):
449
kind = new_inv.get_file_kind(file_id)
450
delta.added.append((new_path, file_id, kind))
299
delta.removed = [(old_inv.id2path(fid), fid) for fid in (old_ids - new_ids)]
452
300
delta.removed.sort()
302
delta.added = [(new_inv.id2path(fid), fid) for fid in (new_ids - old_ids)]
453
303
delta.added.sort()
305
for fid in old_ids & new_ids:
306
old_ie = old_inv[fid]
307
new_ie = new_inv[fid]
308
old_path = old_inv.id2path(fid)
309
new_path = new_inv.id2path(fid)
311
if old_path != new_path:
312
delta.renamed.append((old_path, new_path, fid))
313
elif old_ie.text_sha1 != new_ie.text_sha1:
314
delta.modified.append((new_path, fid))
455
316
delta.modified.sort()
456
delta.unchanged.sort()