14
15
# along with this program; if not, write to the Free Software
15
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
from bzrlib.delta import compare_trees
18
from bzrlib.errors import BzrError
19
import bzrlib.errors as errors
20
from bzrlib.symbol_versioning import *
21
from bzrlib.trace import mutter
23
# TODO: Rather than building a changeset object, we should probably
24
# invoke callbacks on an object. That object can either accumulate a
25
# list, write them out directly, etc etc.
27
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file):
30
# FIXME: difflib is wrong if there is no trailing newline.
31
# The syntax used by patch seems to be "\ No newline at
32
# end of file" following the last diff line from that
33
# file. This is not trivial to insert into the
34
# unified_diff output and it might be better to just fix
35
# or replace that function.
37
# In the meantime we at least make sure the patch isn't
41
# Special workaround for Python2.3, where difflib fails if
42
# both sequences are empty.
43
if not oldlines and not newlines:
46
ud = difflib.unified_diff(oldlines, newlines,
47
fromfile=old_filename+'\t',
48
tofile=new_filename+'\t')
51
# work-around for difflib being too smart for its own good
52
# if /dev/null is "1,0", patch won't recognize it as /dev/null
54
ud[2] = ud[2].replace('-1,0', '-0,0')
56
ud[2] = ud[2].replace('+1,0', '+0,0')
57
# work around for difflib emitting random spaces after the label
58
ud[0] = ud[0][:-2] + '\n'
59
ud[1] = ud[1][:-2] + '\n'
63
if not line.endswith('\n'):
64
to_file.write("\n\\ No newline at end of file\n")
68
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
70
"""Display a diff by calling out to the external diff program."""
73
if to_file != sys.stdout:
74
raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
77
# make sure our own output is properly ordered before the diff
80
from tempfile import NamedTemporaryFile
83
oldtmpf = NamedTemporaryFile()
84
newtmpf = NamedTemporaryFile()
87
# TODO: perhaps a special case for comparing to or from the empty
88
# sequence; can just use /dev/null on Unix
90
# TODO: if either of the files being compared already exists as a
91
# regular named file (e.g. in the working directory) then we can
92
# compare directly to that, rather than copying it.
94
oldtmpf.writelines(oldlines)
95
newtmpf.writelines(newlines)
103
'--label', old_filename+'\t',
105
'--label', new_filename+'\t',
108
# diff only allows one style to be specified; they don't override.
109
# note that some of these take optargs, and the optargs can be
110
# directly appended to the options.
111
# this is only an approximate parser; it doesn't properly understand
113
for s in ['-c', '-u', '-C', '-U',
118
'-y', '--side-by-side',
130
diffcmd.extend(diff_opts)
132
rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
134
if rc != 0 and rc != 1:
135
# returns 1 if files differ; that's OK
137
msg = 'signal %d' % (-rc)
139
msg = 'exit code %d' % rc
141
raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
143
oldtmpf.close() # and delete
147
@deprecated_function(zero_eight)
148
def show_diff(b, from_spec, specific_files, external_diff_options=None,
149
revision2=None, output=None, b2=None):
150
"""Shortcut for showing the diff to the working tree.
152
Please use show_diff_trees instead.
158
None for 'basis tree', or otherwise the old revision to compare against.
160
The more general form is show_diff_trees(), where the caller
161
supplies any two trees.
167
if from_spec is None:
168
old_tree = b.bzrdir.open_workingtree()
170
old_tree = old_tree = old_tree.basis_tree()
172
old_tree = b.repository.revision_tree(from_spec.in_history(b).rev_id)
174
if revision2 is None:
176
new_tree = b.bzrdir.open_workingtree()
178
new_tree = b2.bzrdir.open_workingtree()
180
new_tree = b.repository.revision_tree(revision2.in_history(b).rev_id)
182
return show_diff_trees(old_tree, new_tree, output, specific_files,
183
external_diff_options)
186
def diff_cmd_helper(tree, specific_files, external_diff_options,
187
old_revision_spec=None, new_revision_spec=None):
188
"""Helper for cmd_diff.
194
The specific files to compare, or None
196
external_diff_options
197
If non-None, run an external diff, and pass it these options
200
If None, use basis tree as old revision, otherwise use the tree for
201
the specified revision.
204
If None, use working tree as new revision, otherwise use the tree for
205
the specified revision.
207
The more general form is show_diff_trees(), where the caller
208
supplies any two trees.
213
revision_id = spec.in_store(tree.branch).rev_id
214
return tree.branch.repository.revision_tree(revision_id)
215
if old_revision_spec is None:
216
old_tree = tree.basis_tree()
218
old_tree = spec_tree(old_revision_spec)
220
if new_revision_spec is None:
223
new_tree = spec_tree(new_revision_spec)
225
return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
226
external_diff_options)
229
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
230
external_diff_options=None):
231
"""Show in text form the changes from one tree to another.
234
If set, include only changes to these files.
236
external_diff_options
237
If set, use an external GNU diff and pass these options.
20
from trace import mutter
21
from errors import BzrError
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
This only compares the versioned files, paying no attention to
31
files which are ignored or unknown. Those can only be present in
32
working trees and can be reported on separately.
34
Yields a sequence of (state, id, old_name, new_name, kind).
35
Each filename and each id is listed only once.
37
## TODO: Allow specifying a list of files to compare, rather than
38
## doing the whole tree? (Not urgent.)
40
## TODO: Allow diffing any two inventories, not just the
41
## current one against one. We mgiht need to specify two
42
## stores to look for the files if diffing two branches. That
43
## might imply this shouldn't be primarily a Branch method.
45
sha_match_cnt = modified_cnt = 0
47
old_it = old_tree.list_files()
48
new_it = new_tree.list_files()
243
return _show_diff_trees(old_tree, new_tree, to_file,
244
specific_files, external_diff_options)
251
def _show_diff_trees(old_tree, new_tree, to_file,
252
specific_files, external_diff_options):
254
# TODO: Options to control putting on a prefix or suffix, perhaps
255
# as a format string?
56
old_item = next(old_it)
57
new_item = next(new_it)
59
# We step through the two sorted iterators in parallel, trying to
62
while (old_item != None) or (new_item != None):
63
# OK, we still have some remaining on both, but they may be
66
old_name, old_class, old_kind, old_id = old_item
71
new_name, new_class, new_kind, new_id = new_item
76
# can't handle the old tree being a WorkingTree
77
assert old_class == 'V'
79
if new_item and (new_class != 'V'):
80
yield new_class, None, None, new_name, new_kind
81
new_item = next(new_it)
82
elif (not new_item) or (old_item and (old_name < new_name)):
83
if new_tree.has_id(old_id):
84
# will be mentioned as renamed under new name
87
yield 'D', old_id, old_name, None, old_kind
88
old_item = next(old_it)
89
elif (not old_item) or (new_item and (new_name < old_name)):
90
if old_tree.has_id(new_id):
91
yield 'R', new_id, old_tree.id2path(new_id), new_name, new_kind
93
yield 'A', new_id, None, new_name, new_kind
94
new_item = next(new_it)
95
elif old_id != new_id:
96
assert old_name == new_name
97
# both trees have a file of this name, but it is not the
98
# same file. in other words, the old filename has been
99
# overwritten by either a newly-added or a renamed file.
100
# (should we return something about the overwritten file?)
101
if old_tree.has_id(new_id):
102
# renaming, overlying a deleted file
103
yield 'R', new_id, old_tree.id2path(new_id), new_name, new_kind
105
yield 'A', new_id, None, new_name, new_kind
107
new_item = next(new_it)
108
old_item = next(old_it)
110
assert old_id == new_id
111
assert old_id != None
112
assert old_name == new_name
113
assert old_kind == new_kind
115
if old_kind == 'directory':
116
yield '.', new_id, old_name, new_name, new_kind
117
elif old_tree.get_file_sha1(old_id) == new_tree.get_file_sha1(old_id):
119
yield '.', new_id, old_name, new_name, new_kind
122
yield 'M', new_id, old_name, new_name, new_kind
124
new_item = next(new_it)
125
old_item = next(old_it)
128
mutter("diff finished: %d SHA matches, %d modified"
129
% (sha_match_cnt, modified_cnt))
133
def show_diff(b, revision, file_list):
134
import difflib, sys, types
137
old_tree = b.basis_tree()
139
old_tree = b.revision_tree(b.lookup_revision(revision))
141
new_tree = b.working_tree()
143
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
259
147
DEVNULL = '/dev/null'
260
148
# Windows users, don't panic about this filename -- it is a
264
152
# TODO: Generation of pseudo-diffs for added/deleted files could
265
153
# be usefully made into a much faster special case.
267
_raise_if_doubly_unversioned(specific_files, old_tree, new_tree)
269
if external_diff_options:
270
assert isinstance(external_diff_options, basestring)
271
opts = external_diff_options.split()
272
def diff_file(olab, olines, nlab, nlines, to_file):
273
external_diff(olab, olines, nlab, nlines, to_file, opts)
275
diff_file = internal_diff
277
delta = compare_trees(old_tree, new_tree, want_unchanged=False,
278
specific_files=specific_files)
281
for path, file_id, kind in delta.removed:
283
print >>to_file, '=== removed %s %r' % (kind, old_label + path)
284
old_tree.inventory[file_id].diff(diff_file, old_label + path, old_tree,
285
DEVNULL, None, None, to_file)
286
for path, file_id, kind in delta.added:
288
print >>to_file, '=== added %s %r' % (kind, new_label + path)
289
new_tree.inventory[file_id].diff(diff_file, new_label + path, new_tree,
290
DEVNULL, None, None, to_file,
292
for (old_path, new_path, file_id, kind,
293
text_modified, meta_modified) in delta.renamed:
295
prop_str = get_prop_change(meta_modified)
296
print >>to_file, '=== renamed %s %r => %r%s' % (
297
kind, old_label + old_path, new_label + new_path, prop_str)
298
_maybe_diff_file_or_symlink(old_label, old_path, old_tree, file_id,
299
new_label, new_path, new_tree,
300
text_modified, kind, to_file, diff_file)
301
for path, file_id, kind, text_modified, meta_modified in delta.modified:
303
prop_str = get_prop_change(meta_modified)
304
print >>to_file, '=== modified %s %r%s' % (kind, old_label + path,
307
_maybe_diff_file_or_symlink(old_label, path, old_tree, file_id,
308
new_label, path, new_tree,
309
True, kind, to_file, diff_file)
314
def _raise_if_doubly_unversioned(specific_files, old_tree, new_tree):
315
"""Complain if paths are not versioned in either tree."""
316
if not specific_files:
318
old_unversioned = old_tree.filter_unversioned_files(specific_files)
319
new_unversioned = new_tree.filter_unversioned_files(specific_files)
320
unversioned = old_unversioned.intersection(new_unversioned)
322
raise errors.PathsNotVersionedError(sorted(unversioned))
325
def get_prop_change(meta_modified):
327
return " (properties changed)"
332
def _maybe_diff_file_or_symlink(old_label, old_path, old_tree, file_id,
333
new_label, new_path, new_tree, text_modified,
334
kind, to_file, diff_file):
336
new_entry = new_tree.inventory[file_id]
337
old_tree.inventory[file_id].diff(diff_file,
338
old_label + old_path, old_tree,
339
new_label + new_path, new_entry,
155
# TODO: Better to return them in sorted order I think.
158
file_list = [b.relpath(f) for f in file_list]
160
# FIXME: If given a file list, compare only those files rather
161
# than comparing everything and then throwing stuff away.
163
for file_state, fid, old_name, new_name, kind in diff_trees(old_tree, new_tree):
165
if file_list and (new_name not in file_list):
168
# Don't show this by default; maybe do it if an option is passed
169
# idlabel = ' {%s}' % fid
172
def diffit(oldlines, newlines, **kw):
174
# FIXME: difflib is wrong if there is no trailing newline.
175
# The syntax used by patch seems to be "\ No newline at
176
# end of file" following the last diff line from that
177
# file. This is not trivial to insert into the
178
# unified_diff output and it might be better to just fix
179
# or replace that function.
181
# In the meantime we at least make sure the patch isn't
185
# Special workaround for Python2.3, where difflib fails if
186
# both sequences are empty.
187
if not oldlines and not newlines:
192
if oldlines and (oldlines[-1][-1] != '\n'):
195
if newlines and (newlines[-1][-1] != '\n'):
199
ud = difflib.unified_diff(oldlines, newlines, **kw)
201
# work-around for difflib being too smart for its own good
202
# if /dev/null is "1,0", patch won't recognize it as /dev/null
205
ud[2] = ud[2].replace('-1,0', '-0,0')
208
ud[2] = ud[2].replace('+1,0', '+0,0')
210
sys.stdout.writelines(ud)
212
print "\\ No newline at end of file"
213
sys.stdout.write('\n')
215
if file_state in ['.', '?', 'I']:
217
elif file_state == 'A':
218
print '*** added %s %r' % (kind, new_name)
221
new_tree.get_file(fid).readlines(),
223
tofile=new_label + new_name + idlabel)
224
elif file_state == 'D':
225
assert isinstance(old_name, types.StringTypes)
226
print '*** deleted %s %r' % (kind, old_name)
228
diffit(old_tree.get_file(fid).readlines(), [],
229
fromfile=old_label + old_name + idlabel,
231
elif file_state in ['M', 'R']:
232
if file_state == 'M':
233
assert kind == 'file'
234
assert old_name == new_name
235
print '*** modified %s %r' % (kind, new_name)
236
elif file_state == 'R':
237
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
240
diffit(old_tree.get_file(fid).readlines(),
241
new_tree.get_file(fid).readlines(),
242
fromfile=old_label + old_name + idlabel,
243
tofile=new_label + new_name)
245
raise BzrError("can't represent state %s {%s}" % (file_state, fid))
250
"""Describes changes from one tree to another.
259
(oldpath, newpath, id, text_modified)
263
Each id is listed only once.
265
Files that are both modified and renamed are listed only in
266
renamed, with the text_modified flag true.
274
def show(self, to_file, show_ids):
276
print >>to_file, 'removed files:'
277
for path, fid in self.removed:
279
print >>to_file, ' %-30s %s' % (path, fid)
281
print >>to_file, ' ', path
283
print >>to_file, 'added files:'
284
for path, fid in self.added:
286
print >>to_file, ' %-30s %s' % (path, fid)
288
print >>to_file, ' ' + path
290
print >>to_file, 'renamed files:'
291
for oldpath, newpath, fid, text_modified in self.renamed:
293
print >>to_file, ' %s => %s %s' % (oldpath, newpath, fid)
295
print >>to_file, ' %s => %s' % (oldpath, newpath)
297
print >>to_file, 'modified files:'
298
for path, fid in self.modified:
300
print >>to_file, ' %-30s %s' % (path, fid)
302
print >>to_file, ' ' + path
306
def compare_trees(old_tree, new_tree):
307
old_inv = old_tree.inventory
308
new_inv = new_tree.inventory
310
for file_id in old_inv:
311
if file_id in new_inv:
312
old_path = old_inv.id2path(file_id)
313
new_path = new_inv.id2path(file_id)
315
kind = old_inv.get_file_kind(file_id)
316
assert kind in ('file', 'directory', 'symlink', 'root_directory'), \
317
'invalid file kind %r' % kind
319
old_sha1 = old_tree.get_file_sha1(file_id)
320
new_sha1 = new_tree.get_file_sha1(file_id)
321
text_modified = (old_sha1 != new_sha1)
323
## mutter("no text to check for %r %r" % (file_id, kind))
324
text_modified = False
326
if old_path != new_path:
327
delta.renamed.append((old_path, new_path, file_id, text_modified))
329
delta.modified.append((new_path, file_id))
331
delta.removed.append((old_inv.id2path(file_id), file_id))
332
for file_id in new_inv:
333
if file_id in old_inv:
335
delta.added.append((new_inv.id2path(file_id), file_id))
340
delta.modified.sort()
added
removed
bzrlib/diff.py
