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
path_encoding='utf8'):
34
# FIXME: difflib is wrong if there is no trailing newline.
35
# The syntax used by patch seems to be "\ No newline at
36
# end of file" following the last diff line from that
37
# file. This is not trivial to insert into the
38
# unified_diff output and it might be better to just fix
39
# or replace that function.
41
# In the meantime we at least make sure the patch isn't
45
# Special workaround for Python2.3, where difflib fails if
46
# both sequences are empty.
47
if not oldlines and not newlines:
50
if allow_binary is False:
51
check_text_lines(oldlines)
52
check_text_lines(newlines)
54
if sequence_matcher is None:
55
sequence_matcher = bzrlib.patiencediff.PatienceSequenceMatcher
56
ud = unified_diff(oldlines, newlines,
57
fromfile=old_filename.encode(path_encoding)+'\t',
58
tofile=new_filename.encode(path_encoding)+'\t',
59
sequencematcher=sequence_matcher)
62
# work-around for difflib being too smart for its own good
63
# if /dev/null is "1,0", patch won't recognize it as /dev/null
65
ud[2] = ud[2].replace('-1,0', '-0,0')
67
ud[2] = ud[2].replace('+1,0', '+0,0')
68
# work around for difflib emitting random spaces after the label
69
ud[0] = ud[0][:-2] + '\n'
70
ud[1] = ud[1][:-2] + '\n'
74
if not line.endswith('\n'):
75
to_file.write("\n\\ No newline at end of file\n")
79
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
81
"""Display a diff by calling out to the external diff program."""
84
if to_file != sys.stdout:
85
raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
88
# make sure our own output is properly ordered before the diff
91
from tempfile import NamedTemporaryFile
94
oldtmpf = NamedTemporaryFile()
95
newtmpf = NamedTemporaryFile()
98
# TODO: perhaps a special case for comparing to or from the empty
99
# sequence; can just use /dev/null on Unix
101
# TODO: if either of the files being compared already exists as a
102
# regular named file (e.g. in the working directory) then we can
103
# compare directly to that, rather than copying it.
105
oldtmpf.writelines(oldlines)
106
newtmpf.writelines(newlines)
114
'--label', old_filename+'\t',
116
'--label', new_filename+'\t',
119
# diff only allows one style to be specified; they don't override.
120
# note that some of these take optargs, and the optargs can be
121
# directly appended to the options.
122
# this is only an approximate parser; it doesn't properly understand
124
for s in ['-c', '-u', '-C', '-U',
129
'-y', '--side-by-side',
141
diffcmd.extend(diff_opts)
143
rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
145
if rc != 0 and rc != 1:
146
# returns 1 if files differ; that's OK
148
msg = 'signal %d' % (-rc)
150
msg = 'exit code %d' % rc
152
raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
154
oldtmpf.close() # and delete
158
@deprecated_function(zero_eight)
159
def show_diff(b, from_spec, specific_files, external_diff_options=None,
160
revision2=None, output=None, b2=None):
161
"""Shortcut for showing the diff to the working tree.
163
Please use show_diff_trees instead.
169
None for 'basis tree', or otherwise the old revision to compare against.
171
The more general form is show_diff_trees(), where the caller
172
supplies any two trees.
178
if from_spec is None:
179
old_tree = b.bzrdir.open_workingtree()
181
old_tree = old_tree = old_tree.basis_tree()
183
old_tree = b.repository.revision_tree(from_spec.in_history(b).rev_id)
185
if revision2 is None:
187
new_tree = b.bzrdir.open_workingtree()
189
new_tree = b2.bzrdir.open_workingtree()
191
new_tree = b.repository.revision_tree(revision2.in_history(b).rev_id)
193
return show_diff_trees(old_tree, new_tree, output, specific_files,
194
external_diff_options)
197
def diff_cmd_helper(tree, specific_files, external_diff_options,
198
old_revision_spec=None, new_revision_spec=None,
199
old_label='a/', new_label='b/'):
200
"""Helper for cmd_diff.
206
The specific files to compare, or None
208
external_diff_options
209
If non-None, run an external diff, and pass it these options
212
If None, use basis tree as old revision, otherwise use the tree for
213
the specified revision.
216
If None, use working tree as new revision, otherwise use the tree for
217
the specified revision.
219
The more general form is show_diff_trees(), where the caller
220
supplies any two trees.
225
revision_id = spec.in_store(tree.branch).rev_id
226
return tree.branch.repository.revision_tree(revision_id)
227
if old_revision_spec is None:
228
old_tree = tree.basis_tree()
230
old_tree = spec_tree(old_revision_spec)
232
if new_revision_spec is None:
235
new_tree = spec_tree(new_revision_spec)
237
return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
238
external_diff_options,
239
old_label=old_label, new_label=new_label)
242
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
243
external_diff_options=None,
244
old_label='a/', new_label='b/'):
245
"""Show in text form the changes from one tree to another.
248
If set, include only changes to these files.
250
external_diff_options
251
If set, use an external GNU diff and pass these options.
257
return _show_diff_trees(old_tree, new_tree, to_file,
258
specific_files, external_diff_options,
259
old_label=old_label, new_label=new_label)
266
def _show_diff_trees(old_tree, new_tree, to_file,
267
specific_files, external_diff_options,
268
old_label='a/', new_label='b/' ):
270
DEVNULL = '/dev/null'
271
# Windows users, don't panic about this filename -- it is a
272
# special signal to GNU patch that the file should be created or
273
# deleted respectively.
275
# TODO: Generation of pseudo-diffs for added/deleted files could
276
# be usefully made into a much faster special case.
278
_raise_if_doubly_unversioned(specific_files, old_tree, new_tree)
280
if external_diff_options:
281
assert isinstance(external_diff_options, basestring)
282
opts = external_diff_options.split()
283
def diff_file(olab, olines, nlab, nlines, to_file):
284
external_diff(olab, olines, nlab, nlines, to_file, opts)
286
diff_file = internal_diff
288
delta = compare_trees(old_tree, new_tree, want_unchanged=False,
289
specific_files=specific_files)
292
for path, file_id, kind in delta.removed:
294
print >>to_file, '=== removed %s %r' % (kind, path.encode('utf8'))
295
old_tree.inventory[file_id].diff(diff_file, old_label + path, old_tree,
296
DEVNULL, None, None, to_file)
297
for path, file_id, kind in delta.added:
299
print >>to_file, '=== added %s %r' % (kind, path.encode('utf8'))
300
new_tree.inventory[file_id].diff(diff_file, new_label + path, new_tree,
301
DEVNULL, None, None, to_file,
303
for (old_path, new_path, file_id, kind,
304
text_modified, meta_modified) in delta.renamed:
306
prop_str = get_prop_change(meta_modified)
307
print >>to_file, '=== renamed %s %r => %r%s' % (
308
kind, old_path.encode('utf8'),
309
new_path.encode('utf8'), prop_str)
310
_maybe_diff_file_or_symlink(old_label, old_path, old_tree, file_id,
311
new_label, new_path, new_tree,
312
text_modified, kind, to_file, diff_file)
313
for path, file_id, kind, text_modified, meta_modified in delta.modified:
315
prop_str = get_prop_change(meta_modified)
316
print >>to_file, '=== modified %s %r%s' % (kind, path.encode('utf8'), prop_str)
318
_maybe_diff_file_or_symlink(old_label, path, old_tree, file_id,
319
new_label, path, new_tree,
320
True, kind, to_file, diff_file)
325
def _raise_if_doubly_unversioned(specific_files, old_tree, new_tree):
326
"""Complain if paths are not versioned in either tree."""
327
if not specific_files:
329
old_unversioned = old_tree.filter_unversioned_files(specific_files)
330
new_unversioned = new_tree.filter_unversioned_files(specific_files)
331
unversioned = old_unversioned.intersection(new_unversioned)
333
raise errors.PathsNotVersionedError(sorted(unversioned))
336
def _raise_if_nonexistent(paths, old_tree, new_tree):
337
"""Complain if paths are not in either inventory or tree.
339
It's OK with the files exist in either tree's inventory, or
340
if they exist in the tree but are not versioned.
342
This can be used by operations such as bzr status that can accept
343
unknown or ignored files.
345
mutter("check paths: %r", paths)
348
s = old_tree.filter_unversioned_files(paths)
349
s = new_tree.filter_unversioned_files(s)
350
s = [path for path in s if not new_tree.has_filename(path)]
352
raise errors.PathsDoNotExist(sorted(s))
355
def get_prop_change(meta_modified):
357
return " (properties changed)"
362
def _maybe_diff_file_or_symlink(old_label, old_path, old_tree, file_id,
363
new_label, new_path, new_tree, text_modified,
364
kind, to_file, diff_file):
366
new_entry = new_tree.inventory[file_id]
367
old_tree.inventory[file_id].diff(diff_file,
368
old_label + old_path, old_tree,
369
new_label + new_path, new_entry,
added
removed
bzrlib/diff.py
