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
19
from bzrlib.delta import compare_trees
20
from bzrlib.errors import BzrError
21
import bzrlib.errors as errors
22
from bzrlib.patiencediff import unified_diff
23
import bzrlib.patiencediff
24
from bzrlib.symbol_versioning import (deprecated_function,
26
from bzrlib.textfile import check_text_lines
27
from bzrlib.trace import mutter
30
# TODO: Rather than building a changeset object, we should probably
31
# invoke callbacks on an object. That object can either accumulate a
32
# list, write them out directly, etc etc.
34
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
35
allow_binary=False, sequence_matcher=None,
36
path_encoding='utf8'):
37
# FIXME: difflib is wrong if there is no trailing newline.
38
# The syntax used by patch seems to be "\ No newline at
39
# end of file" following the last diff line from that
40
# file. This is not trivial to insert into the
41
# unified_diff output and it might be better to just fix
42
# or replace that function.
44
# In the meantime we at least make sure the patch isn't
48
# Special workaround for Python2.3, where difflib fails if
49
# both sequences are empty.
50
if not oldlines and not newlines:
53
if allow_binary is False:
54
check_text_lines(oldlines)
55
check_text_lines(newlines)
57
if sequence_matcher is None:
58
sequence_matcher = bzrlib.patiencediff.PatienceSequenceMatcher
59
ud = unified_diff(oldlines, newlines,
60
fromfile=old_filename.encode(path_encoding),
61
tofile=new_filename.encode(path_encoding),
62
sequencematcher=sequence_matcher)
65
# work-around for difflib being too smart for its own good
66
# if /dev/null is "1,0", patch won't recognize it as /dev/null
68
ud[2] = ud[2].replace('-1,0', '-0,0')
70
ud[2] = ud[2].replace('+1,0', '+0,0')
71
# work around for difflib emitting random spaces after the label
72
ud[0] = ud[0][:-2] + '\n'
73
ud[1] = ud[1][:-2] + '\n'
77
if not line.endswith('\n'):
78
to_file.write("\n\\ No newline at end of file\n")
82
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
84
"""Display a diff by calling out to the external diff program."""
87
if to_file != sys.stdout:
88
raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
91
# make sure our own output is properly ordered before the diff
94
from tempfile import NamedTemporaryFile
97
oldtmpf = NamedTemporaryFile()
98
newtmpf = NamedTemporaryFile()
101
# TODO: perhaps a special case for comparing to or from the empty
102
# sequence; can just use /dev/null on Unix
104
# TODO: if either of the files being compared already exists as a
105
# regular named file (e.g. in the working directory) then we can
106
# compare directly to that, rather than copying it.
108
oldtmpf.writelines(oldlines)
109
newtmpf.writelines(newlines)
117
'--label', old_filename,
119
'--label', new_filename,
122
# diff only allows one style to be specified; they don't override.
123
# note that some of these take optargs, and the optargs can be
124
# directly appended to the options.
125
# this is only an approximate parser; it doesn't properly understand
127
for s in ['-c', '-u', '-C', '-U',
132
'-y', '--side-by-side',
144
diffcmd.extend(diff_opts)
146
rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
148
if rc != 0 and rc != 1:
149
# returns 1 if files differ; that's OK
151
msg = 'signal %d' % (-rc)
153
msg = 'exit code %d' % rc
155
raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
157
oldtmpf.close() # and delete
161
@deprecated_function(zero_eight)
162
def show_diff(b, from_spec, specific_files, external_diff_options=None,
163
revision2=None, output=None, b2=None):
164
"""Shortcut for showing the diff to the working tree.
166
Please use show_diff_trees instead.
172
None for 'basis tree', or otherwise the old revision to compare against.
174
The more general form is show_diff_trees(), where the caller
175
supplies any two trees.
181
if from_spec is None:
182
old_tree = b.bzrdir.open_workingtree()
184
old_tree = old_tree = old_tree.basis_tree()
186
old_tree = b.repository.revision_tree(from_spec.in_history(b).rev_id)
188
if revision2 is None:
190
new_tree = b.bzrdir.open_workingtree()
192
new_tree = b2.bzrdir.open_workingtree()
194
new_tree = b.repository.revision_tree(revision2.in_history(b).rev_id)
196
return show_diff_trees(old_tree, new_tree, output, specific_files,
197
external_diff_options)
200
def diff_cmd_helper(tree, specific_files, external_diff_options,
201
old_revision_spec=None, new_revision_spec=None,
202
old_label='a/', new_label='b/'):
203
"""Helper for cmd_diff.
209
The specific files to compare, or None
211
external_diff_options
212
If non-None, run an external diff, and pass it these options
215
If None, use basis tree as old revision, otherwise use the tree for
216
the specified revision.
219
If None, use working tree as new revision, otherwise use the tree for
220
the specified revision.
222
The more general form is show_diff_trees(), where the caller
223
supplies any two trees.
228
revision_id = spec.in_store(tree.branch).rev_id
229
return tree.branch.repository.revision_tree(revision_id)
230
if old_revision_spec is None:
231
old_tree = tree.basis_tree()
233
old_tree = spec_tree(old_revision_spec)
235
if new_revision_spec is None:
238
new_tree = spec_tree(new_revision_spec)
240
return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
241
external_diff_options,
242
old_label=old_label, new_label=new_label)
245
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
246
external_diff_options=None,
247
old_label='a/', new_label='b/'):
248
"""Show in text form the changes from one tree to another.
251
If set, include only changes to these files.
253
external_diff_options
254
If set, use an external GNU diff and pass these options.
260
return _show_diff_trees(old_tree, new_tree, to_file,
261
specific_files, external_diff_options,
262
old_label=old_label, new_label=new_label)
269
def _show_diff_trees(old_tree, new_tree, to_file,
270
specific_files, external_diff_options,
271
old_label='a/', new_label='b/' ):
273
# GNU Patch uses the epoch date to detect files that are being added
274
# or removed in a diff.
275
EPOCH_DATE = '1970-01-01 00:00:00 +0000'
277
# TODO: Generation of pseudo-diffs for added/deleted files could
278
# be usefully made into a much faster special case.
280
_raise_if_doubly_unversioned(specific_files, old_tree, new_tree)
282
if external_diff_options:
283
assert isinstance(external_diff_options, basestring)
284
opts = external_diff_options.split()
285
def diff_file(olab, olines, nlab, nlines, to_file):
286
external_diff(olab, olines, nlab, nlines, to_file, opts)
288
diff_file = internal_diff
290
delta = compare_trees(old_tree, new_tree, want_unchanged=False,
291
specific_files=specific_files)
294
for path, file_id, kind in delta.removed:
296
print >>to_file, '=== removed %s %r' % (kind, path.encode('utf8'))
297
old_name = '%s%s\t%s' % (old_label, path,
298
_patch_header_date(old_tree, file_id, path))
299
new_name = '%s%s\t%s' % (new_label, path, EPOCH_DATE)
300
old_tree.inventory[file_id].diff(diff_file, old_name, old_tree,
301
new_name, None, None, to_file)
302
for path, file_id, kind in delta.added:
304
print >>to_file, '=== added %s %r' % (kind, path.encode('utf8'))
305
old_name = '%s%s\t%s' % (old_label, path, EPOCH_DATE)
306
new_name = '%s%s\t%s' % (new_label, path,
307
_patch_header_date(new_tree, file_id, path))
308
new_tree.inventory[file_id].diff(diff_file, new_name, new_tree,
309
old_name, None, None, to_file,
311
for (old_path, new_path, file_id, kind,
312
text_modified, meta_modified) in delta.renamed:
314
prop_str = get_prop_change(meta_modified)
315
print >>to_file, '=== renamed %s %r => %r%s' % (
316
kind, old_path.encode('utf8'),
317
new_path.encode('utf8'), prop_str)
318
old_name = '%s%s\t%s' % (old_label, old_path,
319
_patch_header_date(old_tree, file_id,
321
new_name = '%s%s\t%s' % (new_label, new_path,
322
_patch_header_date(new_tree, file_id,
324
_maybe_diff_file_or_symlink(old_name, old_tree, file_id,
326
text_modified, kind, to_file, diff_file)
327
for path, file_id, kind, text_modified, meta_modified in delta.modified:
329
prop_str = get_prop_change(meta_modified)
330
print >>to_file, '=== modified %s %r%s' % (kind, path.encode('utf8'), prop_str)
331
old_name = '%s%s\t%s' % (old_label, path,
332
_patch_header_date(old_tree, file_id, path))
333
new_name = '%s%s\t%s' % (new_label, path,
334
_patch_header_date(new_tree, file_id, path))
336
_maybe_diff_file_or_symlink(old_name, old_tree, file_id,
338
True, kind, to_file, diff_file)
343
def _patch_header_date(tree, file_id, path):
344
"""Returns a timestamp suitable for use in a patch header."""
345
tm = time.gmtime(tree.get_file_mtime(file_id, path))
346
return time.strftime('%Y-%m-%d %H:%M:%S +0000', tm)
349
def _raise_if_doubly_unversioned(specific_files, old_tree, new_tree):
350
"""Complain if paths are not versioned in either tree."""
351
if not specific_files:
353
old_unversioned = old_tree.filter_unversioned_files(specific_files)
354
new_unversioned = new_tree.filter_unversioned_files(specific_files)
355
unversioned = old_unversioned.intersection(new_unversioned)
357
raise errors.PathsNotVersionedError(sorted(unversioned))
360
def _raise_if_nonexistent(paths, old_tree, new_tree):
361
"""Complain if paths are not in either inventory or tree.
363
It's OK with the files exist in either tree's inventory, or
364
if they exist in the tree but are not versioned.
366
This can be used by operations such as bzr status that can accept
367
unknown or ignored files.
369
mutter("check paths: %r", paths)
372
s = old_tree.filter_unversioned_files(paths)
373
s = new_tree.filter_unversioned_files(s)
374
s = [path for path in s if not new_tree.has_filename(path)]
376
raise errors.PathsDoNotExist(sorted(s))
379
def get_prop_change(meta_modified):
381
return " (properties changed)"
386
def _maybe_diff_file_or_symlink(old_path, old_tree, file_id,
387
new_path, new_tree, text_modified,
388
kind, to_file, diff_file):
390
new_entry = new_tree.inventory[file_id]
391
old_tree.inventory[file_id].diff(diff_file,
added
removed
bzrlib/diff.py
