1
# -*- coding: UTF-8 -*-
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
from bzrlib.symbol_versioning import *
20
from bzrlib.textfile import check_text_lines
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
check_text_lines(oldlines)
47
check_text_lines(newlines)
49
ud = difflib.unified_diff(oldlines, newlines,
50
fromfile=old_filename+'\t',
51
tofile=new_filename+'\t')
54
# work-around for difflib being too smart for its own good
55
# if /dev/null is "1,0", patch won't recognize it as /dev/null
57
ud[2] = ud[2].replace('-1,0', '-0,0')
59
ud[2] = ud[2].replace('+1,0', '+0,0')
60
# work around for difflib emitting random spaces after the label
61
ud[0] = ud[0][:-2] + '\n'
62
ud[1] = ud[1][:-2] + '\n'
66
if not line.endswith('\n'):
67
to_file.write("\n\\ No newline at end of file\n")
71
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
73
"""Display a diff by calling out to the external diff program."""
76
if to_file != sys.stdout:
77
raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
80
# make sure our own output is properly ordered before the diff
83
from tempfile import NamedTemporaryFile
86
oldtmpf = NamedTemporaryFile()
87
newtmpf = NamedTemporaryFile()
90
# TODO: perhaps a special case for comparing to or from the empty
91
# sequence; can just use /dev/null on Unix
93
# TODO: if either of the files being compared already exists as a
94
# regular named file (e.g. in the working directory) then we can
95
# compare directly to that, rather than copying it.
97
oldtmpf.writelines(oldlines)
98
newtmpf.writelines(newlines)
106
'--label', old_filename+'\t',
108
'--label', new_filename+'\t',
111
# diff only allows one style to be specified; they don't override.
112
# note that some of these take optargs, and the optargs can be
113
# directly appended to the options.
114
# this is only an approximate parser; it doesn't properly understand
116
for s in ['-c', '-u', '-C', '-U',
121
'-y', '--side-by-side',
133
diffcmd.extend(diff_opts)
135
rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
137
if rc != 0 and rc != 1:
138
# returns 1 if files differ; that's OK
140
msg = 'signal %d' % (-rc)
142
msg = 'exit code %d' % rc
144
raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
146
oldtmpf.close() # and delete
150
@deprecated_function(zero_eight)
151
def show_diff(b, from_spec, specific_files, external_diff_options=None,
152
revision2=None, output=None, b2=None):
153
"""Shortcut for showing the diff to the working tree.
155
Please use show_diff_trees instead.
161
None for 'basis tree', or otherwise the old revision to compare against.
163
The more general form is show_diff_trees(), where the caller
164
supplies any two trees.
170
if from_spec is None:
171
old_tree = b.bzrdir.open_workingtree()
173
old_tree = old_tree = old_tree.basis_tree()
175
old_tree = b.repository.revision_tree(from_spec.in_history(b).rev_id)
177
if revision2 is None:
179
new_tree = b.bzrdir.open_workingtree()
181
new_tree = b2.bzrdir.open_workingtree()
183
new_tree = b.repository.revision_tree(revision2.in_history(b).rev_id)
185
return show_diff_trees(old_tree, new_tree, output, specific_files,
186
external_diff_options)
189
def diff_cmd_helper(tree, specific_files, external_diff_options,
190
old_revision_spec=None, new_revision_spec=None):
191
"""Helper for cmd_diff.
197
The specific files to compare, or None
199
external_diff_options
200
If non-None, run an external diff, and pass it these options
203
If None, use basis tree as old revision, otherwise use the tree for
204
the specified revision.
207
If None, use working tree as new revision, otherwise use the tree for
208
the specified revision.
210
The more general form is show_diff_trees(), where the caller
211
supplies any two trees.
216
revision_id = spec.in_store(tree.branch).rev_id
217
return tree.branch.repository.revision_tree(revision_id)
218
if old_revision_spec is None:
219
old_tree = tree.basis_tree()
221
old_tree = spec_tree(old_revision_spec)
223
if new_revision_spec is None:
226
new_tree = spec_tree(new_revision_spec)
228
return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
229
external_diff_options)
232
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
233
external_diff_options=None):
234
"""Show in text form the changes from one tree to another.
237
If set, include only changes to these files.
239
external_diff_options
240
If set, use an external GNU diff and pass these options.
247
return _show_diff_trees(old_tree, new_tree, to_file,
248
specific_files, external_diff_options)
255
def _show_diff_trees(old_tree, new_tree, to_file,
256
specific_files, external_diff_options):
258
# TODO: Options to control putting on a prefix or suffix, perhaps
259
# as a format string?
263
DEVNULL = '/dev/null'
264
# Windows users, don't panic about this filename -- it is a
265
# special signal to GNU patch that the file should be created or
266
# deleted respectively.
268
# TODO: Generation of pseudo-diffs for added/deleted files could
269
# be usefully made into a much faster special case.
271
if external_diff_options:
272
assert isinstance(external_diff_options, basestring)
273
opts = external_diff_options.split()
274
def diff_file(olab, olines, nlab, nlines, to_file):
275
external_diff(olab, olines, nlab, nlines, to_file, opts)
277
diff_file = internal_diff
280
delta = compare_trees(old_tree, new_tree, want_unchanged=False,
281
specific_files=specific_files)
284
for path, file_id, kind in delta.removed:
286
print >>to_file, '=== removed %s %r' % (kind, old_label + path)
287
old_tree.inventory[file_id].diff(diff_file, old_label + path, old_tree,
288
DEVNULL, None, None, to_file)
289
for path, file_id, kind in delta.added:
291
print >>to_file, '=== added %s %r' % (kind, new_label + path)
292
new_tree.inventory[file_id].diff(diff_file, new_label + path, new_tree,
293
DEVNULL, None, None, to_file,
295
for (old_path, new_path, file_id, kind,
296
text_modified, meta_modified) in delta.renamed:
298
prop_str = get_prop_change(meta_modified)
299
print >>to_file, '=== renamed %s %r => %r%s' % (
300
kind, old_label + old_path, new_label + new_path, prop_str)
301
_maybe_diff_file_or_symlink(old_label, old_path, old_tree, file_id,
302
new_label, new_path, new_tree,
303
text_modified, kind, to_file, diff_file)
304
for path, file_id, kind, text_modified, meta_modified in delta.modified:
306
prop_str = get_prop_change(meta_modified)
307
print >>to_file, '=== modified %s %r%s' % (kind, old_label + path,
310
_maybe_diff_file_or_symlink(old_label, path, old_tree, file_id,
311
new_label, path, new_tree,
312
True, kind, to_file, diff_file)
316
def get_prop_change(meta_modified):
318
return " (properties changed)"
323
def _maybe_diff_file_or_symlink(old_label, old_path, old_tree, file_id,
324
new_label, new_path, new_tree, text_modified,
325
kind, to_file, diff_file):
327
new_entry = new_tree.inventory[file_id]
328
old_tree.inventory[file_id].diff(diff_file,
329
old_label + old_path, old_tree,
330
new_label + new_path, new_entry,