1
# Copyright (C) 2004, 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
17
from bzrlib.delta import compare_trees
18
from bzrlib.errors import BzrError
19
import bzrlib.errors as errors
20
from bzrlib.patiencediff import SequenceMatcher, unified_diff
21
from bzrlib.symbol_versioning import *
22
from bzrlib.textfile import check_text_lines
23
from bzrlib.trace import mutter
25
# TODO: Rather than building a changeset object, we should probably
26
# invoke callbacks on an object. That object can either accumulate a
27
# list, write them out directly, etc etc.
29
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
30
allow_binary=False, sequence_matcher=None):
31
# FIXME: difflib is wrong if there is no trailing newline.
32
# The syntax used by patch seems to be "\ No newline at
33
# end of file" following the last diff line from that
34
# file. This is not trivial to insert into the
35
# unified_diff output and it might be better to just fix
36
# or replace that function.
38
# In the meantime we at least make sure the patch isn't
42
# Special workaround for Python2.3, where difflib fails if
43
# both sequences are empty.
44
if not oldlines and not newlines:
47
if allow_binary is False:
48
check_text_lines(oldlines)
49
check_text_lines(newlines)
51
if sequence_matcher is None:
52
sequence_matcher = SequenceMatcher
53
ud = unified_diff(oldlines, newlines,
54
fromfile=old_filename+'\t',
55
tofile=new_filename+'\t',
56
sequencematcher=sequence_matcher)
59
# work-around for difflib being too smart for its own good
60
# if /dev/null is "1,0", patch won't recognize it as /dev/null
62
ud[2] = ud[2].replace('-1,0', '-0,0')
64
ud[2] = ud[2].replace('+1,0', '+0,0')
65
# work around for difflib emitting random spaces after the label
66
ud[0] = ud[0][:-2] + '\n'
67
ud[1] = ud[1][:-2] + '\n'
71
if not line.endswith('\n'):
72
to_file.write("\n\\ No newline at end of file\n")
76
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
78
"""Display a diff by calling out to the external diff program."""
81
if to_file != sys.stdout:
82
raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
85
# make sure our own output is properly ordered before the diff
88
from tempfile import NamedTemporaryFile
91
oldtmpf = NamedTemporaryFile()
92
newtmpf = NamedTemporaryFile()
95
# TODO: perhaps a special case for comparing to or from the empty
96
# sequence; can just use /dev/null on Unix
98
# TODO: if either of the files being compared already exists as a
99
# regular named file (e.g. in the working directory) then we can
100
# compare directly to that, rather than copying it.
102
oldtmpf.writelines(oldlines)
103
newtmpf.writelines(newlines)
111
'--label', old_filename+'\t',
113
'--label', new_filename+'\t',
116
# diff only allows one style to be specified; they don't override.
117
# note that some of these take optargs, and the optargs can be
118
# directly appended to the options.
119
# this is only an approximate parser; it doesn't properly understand
121
for s in ['-c', '-u', '-C', '-U',
126
'-y', '--side-by-side',
138
diffcmd.extend(diff_opts)
140
rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
142
if rc != 0 and rc != 1:
143
# returns 1 if files differ; that's OK
145
msg = 'signal %d' % (-rc)
147
msg = 'exit code %d' % rc
149
raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
151
oldtmpf.close() # and delete
155
@deprecated_function(zero_eight)
156
def show_diff(b, from_spec, specific_files, external_diff_options=None,
157
revision2=None, output=None, b2=None):
158
"""Shortcut for showing the diff to the working tree.
160
Please use show_diff_trees instead.
166
None for 'basis tree', or otherwise the old revision to compare against.
168
The more general form is show_diff_trees(), where the caller
169
supplies any two trees.
175
if from_spec is None:
176
old_tree = b.bzrdir.open_workingtree()
178
old_tree = old_tree = old_tree.basis_tree()
180
old_tree = b.repository.revision_tree(from_spec.in_history(b).rev_id)
182
if revision2 is None:
184
new_tree = b.bzrdir.open_workingtree()
186
new_tree = b2.bzrdir.open_workingtree()
188
new_tree = b.repository.revision_tree(revision2.in_history(b).rev_id)
190
return show_diff_trees(old_tree, new_tree, output, specific_files,
191
external_diff_options)
194
def diff_cmd_helper(tree, specific_files, external_diff_options,
195
old_revision_spec=None, new_revision_spec=None,
196
old_label='a/', new_label='b/'):
197
"""Helper for cmd_diff.
203
The specific files to compare, or None
205
external_diff_options
206
If non-None, run an external diff, and pass it these options
209
If None, use basis tree as old revision, otherwise use the tree for
210
the specified revision.
213
If None, use working tree as new revision, otherwise use the tree for
214
the specified revision.
216
The more general form is show_diff_trees(), where the caller
217
supplies any two trees.
222
revision_id = spec.in_store(tree.branch).rev_id
223
return tree.branch.repository.revision_tree(revision_id)
224
if old_revision_spec is None:
225
old_tree = tree.basis_tree()
227
old_tree = spec_tree(old_revision_spec)
229
if new_revision_spec is None:
232
new_tree = spec_tree(new_revision_spec)
234
return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
235
external_diff_options,
236
old_label=old_label, new_label=new_label)
239
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
240
external_diff_options=None,
241
old_label='a/', new_label='b/'):
242
"""Show in text form the changes from one tree to another.
245
If set, include only changes to these files.
247
external_diff_options
248
If set, use an external GNU diff and pass these options.
254
return _show_diff_trees(old_tree, new_tree, to_file,
255
specific_files, external_diff_options,
256
old_label=old_label, new_label=new_label)
263
def _show_diff_trees(old_tree, new_tree, to_file,
264
specific_files, external_diff_options,
265
old_label='a/', new_label='b/' ):
267
DEVNULL = '/dev/null'
268
# Windows users, don't panic about this filename -- it is a
269
# special signal to GNU patch that the file should be created or
270
# deleted respectively.
272
# TODO: Generation of pseudo-diffs for added/deleted files could
273
# be usefully made into a much faster special case.
275
_raise_if_doubly_unversioned(specific_files, old_tree, new_tree)
277
if external_diff_options:
278
assert isinstance(external_diff_options, basestring)
279
opts = external_diff_options.split()
280
def diff_file(olab, olines, nlab, nlines, to_file):
281
external_diff(olab, olines, nlab, nlines, to_file, opts)
283
diff_file = internal_diff
285
delta = compare_trees(old_tree, new_tree, want_unchanged=False,
286
specific_files=specific_files)
289
for path, file_id, kind in delta.removed:
291
print >>to_file, '=== removed %s %r' % (kind, path)
292
old_tree.inventory[file_id].diff(diff_file, old_label + path, old_tree,
293
DEVNULL, None, None, to_file)
294
for path, file_id, kind in delta.added:
296
print >>to_file, '=== added %s %r' % (kind, path)
297
new_tree.inventory[file_id].diff(diff_file, new_label + path, new_tree,
298
DEVNULL, None, None, to_file,
300
for (old_path, new_path, file_id, kind,
301
text_modified, meta_modified) in delta.renamed:
303
prop_str = get_prop_change(meta_modified)
304
print >>to_file, '=== renamed %s %r => %r%s' % (
305
kind, old_path, new_path, prop_str)
306
_maybe_diff_file_or_symlink(old_label, old_path, old_tree, file_id,
307
new_label, new_path, new_tree,
308
text_modified, kind, to_file, diff_file)
309
for path, file_id, kind, text_modified, meta_modified in delta.modified:
311
prop_str = get_prop_change(meta_modified)
312
print >>to_file, '=== modified %s %r%s' % (kind, path, prop_str)
314
_maybe_diff_file_or_symlink(old_label, path, old_tree, file_id,
315
new_label, path, new_tree,
316
True, kind, to_file, diff_file)
321
def _raise_if_doubly_unversioned(specific_files, old_tree, new_tree):
322
"""Complain if paths are not versioned in either tree."""
323
if not specific_files:
325
old_unversioned = old_tree.filter_unversioned_files(specific_files)
326
new_unversioned = new_tree.filter_unversioned_files(specific_files)
327
unversioned = old_unversioned.intersection(new_unversioned)
329
raise errors.PathsNotVersionedError(sorted(unversioned))
332
def _raise_if_nonexistent(paths, old_tree, new_tree):
333
"""Complain if paths are not in either inventory or tree.
335
It's OK with the files exist in either tree's inventory, or
336
if they exist in the tree but are not versioned.
338
This can be used by operations such as bzr status that can accept
339
unknown or ignored files.
341
mutter("check paths: %r", paths)
344
s = old_tree.filter_unversioned_files(paths)
345
s = new_tree.filter_unversioned_files(s)
346
s = [path for path in s if not new_tree.has_filename(path)]
348
raise errors.PathsDoNotExist(sorted(s))
351
def get_prop_change(meta_modified):
353
return " (properties changed)"
358
def _maybe_diff_file_or_symlink(old_label, old_path, old_tree, file_id,
359
new_label, new_path, new_tree, text_modified,
360
kind, to_file, diff_file):
362
new_entry = new_tree.inventory[file_id]
363
old_tree.inventory[file_id].diff(diff_file,
364
old_label + old_path, old_tree,
365
new_label + new_path, new_entry,
added
removed
bzrlib/diff.py
