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 unified_diff
21
import bzrlib.patiencediff
22
from bzrlib.symbol_versioning import *
23
from bzrlib.textfile import check_text_lines
24
from bzrlib.trace import mutter
27
# TODO: Rather than building a changeset object, we should probably
28
# invoke callbacks on an object. That object can either accumulate a
29
# list, write them out directly, etc etc.
31
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
32
allow_binary=False, sequence_matcher=None):
33
# FIXME: difflib is wrong if there is no trailing newline.
34
# The syntax used by patch seems to be "\ No newline at
35
# end of file" following the last diff line from that
36
# file. This is not trivial to insert into the
37
# unified_diff output and it might be better to just fix
38
# or replace that function.
40
# In the meantime we at least make sure the patch isn't
44
# Special workaround for Python2.3, where difflib fails if
45
# both sequences are empty.
46
if not oldlines and not newlines:
49
if allow_binary is False:
50
check_text_lines(oldlines)
51
check_text_lines(newlines)
53
if sequence_matcher is None:
54
sequence_matcher = bzrlib.patiencediff.PatienceSequenceMatcher
55
ud = unified_diff(oldlines, newlines,
56
fromfile=old_filename+'\t',
57
tofile=new_filename+'\t',
58
sequencematcher=sequence_matcher)
61
# work-around for difflib being too smart for its own good
62
# if /dev/null is "1,0", patch won't recognize it as /dev/null
64
ud[2] = ud[2].replace('-1,0', '-0,0')
66
ud[2] = ud[2].replace('+1,0', '+0,0')
67
# work around for difflib emitting random spaces after the label
68
ud[0] = ud[0][:-2] + '\n'
69
ud[1] = ud[1][:-2] + '\n'
73
if not line.endswith('\n'):
74
to_file.write("\n\\ No newline at end of file\n")
78
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
80
"""Display a diff by calling out to the external diff program."""
83
if to_file != sys.stdout:
84
raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
87
# make sure our own output is properly ordered before the diff
90
from tempfile import NamedTemporaryFile
93
oldtmpf = NamedTemporaryFile()
94
newtmpf = NamedTemporaryFile()
97
# TODO: perhaps a special case for comparing to or from the empty
98
# sequence; can just use /dev/null on Unix
100
# TODO: if either of the files being compared already exists as a
101
# regular named file (e.g. in the working directory) then we can
102
# compare directly to that, rather than copying it.
104
oldtmpf.writelines(oldlines)
105
newtmpf.writelines(newlines)
113
'--label', old_filename+'\t',
115
'--label', new_filename+'\t',
118
# diff only allows one style to be specified; they don't override.
119
# note that some of these take optargs, and the optargs can be
120
# directly appended to the options.
121
# this is only an approximate parser; it doesn't properly understand
123
for s in ['-c', '-u', '-C', '-U',
128
'-y', '--side-by-side',
140
diffcmd.extend(diff_opts)
142
rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
144
if rc != 0 and rc != 1:
145
# returns 1 if files differ; that's OK
147
msg = 'signal %d' % (-rc)
149
msg = 'exit code %d' % rc
151
raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
153
oldtmpf.close() # and delete
157
@deprecated_function(zero_eight)
158
def show_diff(b, from_spec, specific_files, external_diff_options=None,
159
revision2=None, output=None, b2=None):
160
"""Shortcut for showing the diff to the working tree.
162
Please use show_diff_trees instead.
168
None for 'basis tree', or otherwise the old revision to compare against.
170
The more general form is show_diff_trees(), where the caller
171
supplies any two trees.
177
if from_spec is None:
178
old_tree = b.bzrdir.open_workingtree()
180
old_tree = old_tree = old_tree.basis_tree()
182
old_tree = b.repository.revision_tree(from_spec.in_history(b).rev_id)
184
if revision2 is None:
186
new_tree = b.bzrdir.open_workingtree()
188
new_tree = b2.bzrdir.open_workingtree()
190
new_tree = b.repository.revision_tree(revision2.in_history(b).rev_id)
192
return show_diff_trees(old_tree, new_tree, output, specific_files,
193
external_diff_options)
196
def diff_cmd_helper(tree, specific_files, external_diff_options,
197
old_revision_spec=None, new_revision_spec=None,
198
old_label='a/', new_label='b/'):
199
"""Helper for cmd_diff.
205
The specific files to compare, or None
207
external_diff_options
208
If non-None, run an external diff, and pass it these options
211
If None, use basis tree as old revision, otherwise use the tree for
212
the specified revision.
215
If None, use working tree as new revision, otherwise use the tree for
216
the specified revision.
218
The more general form is show_diff_trees(), where the caller
219
supplies any two trees.
224
revision_id = spec.in_store(tree.branch).rev_id
225
return tree.branch.repository.revision_tree(revision_id)
226
if old_revision_spec is None:
227
old_tree = tree.basis_tree()
229
old_tree = spec_tree(old_revision_spec)
231
if new_revision_spec is None:
234
new_tree = spec_tree(new_revision_spec)
236
return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
237
external_diff_options,
238
old_label=old_label, new_label=new_label)
241
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
242
external_diff_options=None,
243
old_label='a/', new_label='b/'):
244
"""Show in text form the changes from one tree to another.
247
If set, include only changes to these files.
249
external_diff_options
250
If set, use an external GNU diff and pass these options.
256
return _show_diff_trees(old_tree, new_tree, to_file,
257
specific_files, external_diff_options,
258
old_label=old_label, new_label=new_label)
265
def _show_diff_trees(old_tree, new_tree, to_file,
266
specific_files, external_diff_options,
267
old_label='a/', new_label='b/' ):
269
DEVNULL = '/dev/null'
270
# Windows users, don't panic about this filename -- it is a
271
# special signal to GNU patch that the file should be created or
272
# deleted respectively.
274
# TODO: Generation of pseudo-diffs for added/deleted files could
275
# be usefully made into a much faster special case.
277
_raise_if_doubly_unversioned(specific_files, old_tree, new_tree)
279
if external_diff_options:
280
assert isinstance(external_diff_options, basestring)
281
opts = external_diff_options.split()
282
def diff_file(olab, olines, nlab, nlines, to_file):
283
external_diff(olab, olines, nlab, nlines, to_file, opts)
285
diff_file = internal_diff
287
delta = compare_trees(old_tree, new_tree, want_unchanged=False,
288
specific_files=specific_files)
291
for path, file_id, kind in delta.removed:
293
print >>to_file, '=== removed %s %r' % (kind, path)
294
old_tree.inventory[file_id].diff(diff_file, old_label + path, old_tree,
295
DEVNULL, None, None, to_file)
296
for path, file_id, kind in delta.added:
298
print >>to_file, '=== added %s %r' % (kind, path)
299
new_tree.inventory[file_id].diff(diff_file, new_label + path, new_tree,
300
DEVNULL, None, None, to_file,
302
for (old_path, new_path, file_id, kind,
303
text_modified, meta_modified) in delta.renamed:
305
prop_str = get_prop_change(meta_modified)
306
print >>to_file, '=== renamed %s %r => %r%s' % (
307
kind, old_path, new_path, prop_str)
308
_maybe_diff_file_or_symlink(old_label, old_path, old_tree, file_id,
309
new_label, new_path, new_tree,
310
text_modified, kind, to_file, diff_file)
311
for path, file_id, kind, text_modified, meta_modified in delta.modified:
313
prop_str = get_prop_change(meta_modified)
314
print >>to_file, '=== modified %s %r%s' % (kind, path, prop_str)
316
_maybe_diff_file_or_symlink(old_label, path, old_tree, file_id,
317
new_label, path, new_tree,
318
True, kind, to_file, diff_file)
323
def _raise_if_doubly_unversioned(specific_files, old_tree, new_tree):
324
"""Complain if paths are not versioned in either tree."""
325
if not specific_files:
327
old_unversioned = old_tree.filter_unversioned_files(specific_files)
328
new_unversioned = new_tree.filter_unversioned_files(specific_files)
329
unversioned = old_unversioned.intersection(new_unversioned)
331
raise errors.PathsNotVersionedError(sorted(unversioned))
334
def _raise_if_nonexistent(paths, old_tree, new_tree):
335
"""Complain if paths are not in either inventory or tree.
337
It's OK with the files exist in either tree's inventory, or
338
if they exist in the tree but are not versioned.
340
This can be used by operations such as bzr status that can accept
341
unknown or ignored files.
343
mutter("check paths: %r", paths)
346
s = old_tree.filter_unversioned_files(paths)
347
s = new_tree.filter_unversioned_files(s)
348
s = [path for path in s if not new_tree.has_filename(path)]
350
raise errors.PathsDoNotExist(sorted(s))
353
def get_prop_change(meta_modified):
355
return " (properties changed)"
360
def _maybe_diff_file_or_symlink(old_label, old_path, old_tree, file_id,
361
new_label, new_path, new_tree, text_modified,
362
kind, to_file, diff_file):
364
new_entry = new_tree.inventory[file_id]
365
old_tree.inventory[file_id].diff(diff_file,
366
old_label + old_path, old_tree,
367
new_label + new_path, new_entry,
added
removed
bzrlib/diff.py
