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
23
from bzrlib.lazy_import import lazy_import
24
lazy_import(globals(), """
31
branch as _mod_branch,
42
from bzrlib.symbol_versioning import (
47
from bzrlib.trace import mutter, warning
50
# TODO: Rather than building a changeset object, we should probably
51
# invoke callbacks on an object. That object can either accumulate a
52
# list, write them out directly, etc etc.
55
class _PrematchedMatcher(difflib.SequenceMatcher):
56
"""Allow SequenceMatcher operations to use predetermined blocks"""
58
def __init__(self, matching_blocks):
59
difflib.SequenceMatcher(self, None, None)
60
self.matching_blocks = matching_blocks
64
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
65
allow_binary=False, sequence_matcher=None,
66
path_encoding='utf8'):
67
# FIXME: difflib is wrong if there is no trailing newline.
68
# The syntax used by patch seems to be "\ No newline at
69
# end of file" following the last diff line from that
70
# file. This is not trivial to insert into the
71
# unified_diff output and it might be better to just fix
72
# or replace that function.
74
# In the meantime we at least make sure the patch isn't
78
# Special workaround for Python2.3, where difflib fails if
79
# both sequences are empty.
80
if not oldlines and not newlines:
83
if allow_binary is False:
84
textfile.check_text_lines(oldlines)
85
textfile.check_text_lines(newlines)
87
if sequence_matcher is None:
88
sequence_matcher = patiencediff.PatienceSequenceMatcher
89
ud = patiencediff.unified_diff(oldlines, newlines,
90
fromfile=old_filename.encode(path_encoding),
91
tofile=new_filename.encode(path_encoding),
92
sequencematcher=sequence_matcher)
95
if len(ud) == 0: # Identical contents, nothing to do
97
# work-around for difflib being too smart for its own good
98
# if /dev/null is "1,0", patch won't recognize it as /dev/null
100
ud[2] = ud[2].replace('-1,0', '-0,0')
102
ud[2] = ud[2].replace('+1,0', '+0,0')
103
# work around for difflib emitting random spaces after the label
104
ud[0] = ud[0][:-2] + '\n'
105
ud[1] = ud[1][:-2] + '\n'
109
if not line.endswith('\n'):
110
to_file.write("\n\\ No newline at end of file\n")
114
def _spawn_external_diff(diffcmd, capture_errors=True):
115
"""Spawn the externall diff process, and return the child handle.
117
:param diffcmd: The command list to spawn
118
:param capture_errors: Capture stderr as well as setting LANG=C
119
and LC_ALL=C. This lets us read and understand the output of diff,
120
and respond to any errors.
121
:return: A Popen object.
124
# construct minimal environment
126
path = os.environ.get('PATH')
129
env['LANGUAGE'] = 'C' # on win32 only LANGUAGE has effect
132
stderr = subprocess.PIPE
138
pipe = subprocess.Popen(diffcmd,
139
stdin=subprocess.PIPE,
140
stdout=subprocess.PIPE,
144
if e.errno == errno.ENOENT:
145
raise errors.NoDiff(str(e))
151
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
153
"""Display a diff by calling out to the external diff program."""
154
# make sure our own output is properly ordered before the diff
157
oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='bzr-diff-old-')
158
newtmp_fd, new_abspath = tempfile.mkstemp(prefix='bzr-diff-new-')
159
oldtmpf = os.fdopen(oldtmp_fd, 'wb')
160
newtmpf = os.fdopen(newtmp_fd, 'wb')
163
# TODO: perhaps a special case for comparing to or from the empty
164
# sequence; can just use /dev/null on Unix
166
# TODO: if either of the files being compared already exists as a
167
# regular named file (e.g. in the working directory) then we can
168
# compare directly to that, rather than copying it.
170
oldtmpf.writelines(oldlines)
171
newtmpf.writelines(newlines)
179
'--label', old_filename,
181
'--label', new_filename,
186
# diff only allows one style to be specified; they don't override.
187
# note that some of these take optargs, and the optargs can be
188
# directly appended to the options.
189
# this is only an approximate parser; it doesn't properly understand
191
for s in ['-c', '-u', '-C', '-U',
196
'-y', '--side-by-side',
208
diffcmd.extend(diff_opts)
210
pipe = _spawn_external_diff(diffcmd, capture_errors=True)
211
out,err = pipe.communicate()
214
# internal_diff() adds a trailing newline, add one here for consistency
217
# 'diff' gives retcode == 2 for all sorts of errors
218
# one of those is 'Binary files differ'.
219
# Bad options could also be the problem.
220
# 'Binary files' is not a real error, so we suppress that error.
223
# Since we got here, we want to make sure to give an i18n error
224
pipe = _spawn_external_diff(diffcmd, capture_errors=False)
225
out, err = pipe.communicate()
227
# Write out the new i18n diff response
228
to_file.write(out+'\n')
229
if pipe.returncode != 2:
230
raise errors.BzrError(
231
'external diff failed with exit code 2'
232
' when run with LANG=C and LC_ALL=C,'
233
' but not when run natively: %r' % (diffcmd,))
235
first_line = lang_c_out.split('\n', 1)[0]
236
# Starting with diffutils 2.8.4 the word "binary" was dropped.
237
m = re.match('^(binary )?files.*differ$', first_line, re.I)
239
raise errors.BzrError('external diff failed with exit code 2;'
240
' command: %r' % (diffcmd,))
242
# Binary files differ, just return
245
# If we got to here, we haven't written out the output of diff
249
# returns 1 if files differ; that's OK
251
msg = 'signal %d' % (-rc)
253
msg = 'exit code %d' % rc
255
raise errors.BzrError('external diff failed with %s; command: %r'
260
oldtmpf.close() # and delete
262
# Clean up. Warn in case the files couldn't be deleted
263
# (in case windows still holds the file open, but not
264
# if the files have already been deleted)
266
os.remove(old_abspath)
268
if e.errno not in (errno.ENOENT,):
269
warning('Failed to delete temporary file: %s %s',
272
os.remove(new_abspath)
274
if e.errno not in (errno.ENOENT,):
275
warning('Failed to delete temporary file: %s %s',
279
@deprecated_function(one_zero)
280
def diff_cmd_helper(tree, specific_files, external_diff_options,
281
old_revision_spec=None, new_revision_spec=None,
283
old_label='a/', new_label='b/'):
284
"""Helper for cmd_diff.
289
:param specific_files:
290
The specific files to compare, or None
292
:param external_diff_options:
293
If non-None, run an external diff, and pass it these options
295
:param old_revision_spec:
296
If None, use basis tree as old revision, otherwise use the tree for
297
the specified revision.
299
:param new_revision_spec:
300
If None, use working tree as new revision, otherwise use the tree for
301
the specified revision.
303
:param revision_specs:
304
Zero, one or two RevisionSpecs from the command line, saying what revisions
305
to compare. This can be passed as an alternative to the old_revision_spec
306
and new_revision_spec parameters.
308
The more general form is show_diff_trees(), where the caller
309
supplies any two trees.
312
# TODO: perhaps remove the old parameters old_revision_spec and
313
# new_revision_spec, since this is only really for use from cmd_diff and
314
# it now always passes through a sequence of revision_specs -- mbp
319
revision = spec.in_store(tree.branch)
321
revision = spec.in_store(None)
322
revision_id = revision.rev_id
323
branch = revision.branch
324
return branch.repository.revision_tree(revision_id)
326
if revision_specs is not None:
327
assert (old_revision_spec is None
328
and new_revision_spec is None)
329
if len(revision_specs) > 0:
330
old_revision_spec = revision_specs[0]
331
if len(revision_specs) > 1:
332
new_revision_spec = revision_specs[1]
334
if old_revision_spec is None:
335
old_tree = tree.basis_tree()
337
old_tree = spec_tree(old_revision_spec)
339
if (new_revision_spec is None
340
or new_revision_spec.spec is None):
343
new_tree = spec_tree(new_revision_spec)
345
if new_tree is not tree:
346
extra_trees = (tree,)
350
return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
351
external_diff_options,
352
old_label=old_label, new_label=new_label,
353
extra_trees=extra_trees)
356
def _get_trees_to_diff(path_list, revision_specs, old_url, new_url):
357
"""Get the trees and specific files to diff given a list of paths.
359
This method works out the trees to be diff'ed and the files of
360
interest within those trees.
363
the list of arguments passed to the diff command
364
:param revision_specs:
365
Zero, one or two RevisionSpecs from the diff command line,
366
saying what revisions to compare.
368
The url of the old branch or tree. If None, the tree to use is
369
taken from the first path, if any, or the current working tree.
371
The url of the new branch or tree. If None, the tree to use is
372
taken from the first path, if any, or the current working tree.
374
a tuple of (old_tree, new_tree, specific_files, extra_trees) where
375
extra_trees is a sequence of additional trees to search in for
378
# Get the old and new revision specs
379
old_revision_spec = None
380
new_revision_spec = None
381
if revision_specs is not None:
382
if len(revision_specs) > 0:
383
old_revision_spec = revision_specs[0]
385
old_url = old_revision_spec.get_branch()
386
if len(revision_specs) > 1:
387
new_revision_spec = revision_specs[1]
389
new_url = new_revision_spec.get_branch()
392
make_paths_wt_relative = True
393
consider_relpath = True
394
if path_list is None or len(path_list) == 0:
395
# If no path is given, the current working tree is used
396
default_location = u'.'
397
consider_relpath = False
398
elif old_url is not None and new_url is not None:
399
other_paths = path_list
400
make_paths_wt_relative = False
402
default_location = path_list[0]
403
other_paths = path_list[1:]
405
# Get the old location
408
old_url = default_location
409
working_tree, branch, relpath = \
410
bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
411
if consider_relpath and relpath != '':
412
specific_files.append(relpath)
413
old_tree = _get_tree_to_diff(old_revision_spec, working_tree, branch)
415
# Get the new location
417
new_url = default_location
418
if new_url != old_url:
419
working_tree, branch, relpath = \
420
bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
421
if consider_relpath and relpath != '':
422
specific_files.append(relpath)
423
new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
424
basis_is_default=working_tree is None)
426
# Get the specific files (all files is None, no files is [])
427
if make_paths_wt_relative and working_tree is not None:
428
other_paths = _relative_paths_in_tree(working_tree, other_paths)
429
specific_files.extend(other_paths)
430
if len(specific_files) == 0:
431
specific_files = None
433
# Get extra trees that ought to be searched for file-ids
435
if working_tree is not None and working_tree not in (old_tree, new_tree):
436
extra_trees = (working_tree,)
437
return old_tree, new_tree, specific_files, extra_trees
440
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
441
if branch is None and tree is not None:
443
if spec is None or spec.spec is None:
446
return tree.basis_tree()
448
return branch.basis_tree()
451
if not spec.needs_branch():
452
branch = _mod_branch.Branch.open(spec.get_branch())
453
revision_id = spec.as_revision_id(branch)
454
return branch.repository.revision_tree(revision_id)
457
def _relative_paths_in_tree(tree, paths):
458
"""Get the relative paths within a working tree.
460
Each path may be either an absolute path or a path relative to the
461
current working directory.
464
for filename in paths:
466
result.append(tree.relpath(osutils.dereference_path(filename)))
467
except errors.PathNotChild:
468
raise errors.BzrCommandError("Files are in different branches")
472
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
473
external_diff_options=None,
474
old_label='a/', new_label='b/',
476
path_encoding='utf8',
478
"""Show in text form the changes from one tree to another.
484
Include only changes to these files - None for all changes.
486
external_diff_options
487
If set, use an external GNU diff and pass these options.
490
If set, more Trees to use for looking up file ids
493
If set, the path will be encoded as specified, otherwise is supposed
498
if extra_trees is not None:
499
for tree in extra_trees:
503
differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
505
external_diff_options,
506
old_label, new_label, using)
507
return differ.show_diff(specific_files, extra_trees)
510
if extra_trees is not None:
511
for tree in extra_trees:
517
def _patch_header_date(tree, file_id, path):
518
"""Returns a timestamp suitable for use in a patch header."""
519
mtime = tree.get_file_mtime(file_id, path)
520
assert mtime is not None, \
521
"got an mtime of None for file-id %s, path %s in tree %s" % (
523
return timestamp.format_patch_date(mtime)
526
def _raise_if_nonexistent(paths, old_tree, new_tree):
527
"""Complain if paths are not in either inventory or tree.
529
It's OK with the files exist in either tree's inventory, or
530
if they exist in the tree but are not versioned.
532
This can be used by operations such as bzr status that can accept
533
unknown or ignored files.
535
mutter("check paths: %r", paths)
538
s = old_tree.filter_unversioned_files(paths)
539
s = new_tree.filter_unversioned_files(s)
540
s = [path for path in s if not new_tree.has_filename(path)]
542
raise errors.PathsDoNotExist(sorted(s))
545
@deprecated_function(one_three)
546
def get_prop_change(meta_modified):
548
return " (properties changed)"
552
def get_executable_change(old_is_x, new_is_x):
553
descr = { True:"+x", False:"-x", None:"??" }
554
if old_is_x != new_is_x:
555
return ["%s to %s" % (descr[old_is_x], descr[new_is_x],)]
560
class DiffPath(object):
561
"""Base type for command object that compare files"""
563
# The type or contents of the file were unsuitable for diffing
564
CANNOT_DIFF = 'CANNOT_DIFF'
565
# The file has changed in a semantic way
567
# The file content may have changed, but there is no semantic change
568
UNCHANGED = 'UNCHANGED'
570
def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8'):
573
:param old_tree: The tree to show as the old tree in the comparison
574
:param new_tree: The tree to show as new in the comparison
575
:param to_file: The file to write comparison data to
576
:param path_encoding: The character encoding to write paths in
578
self.old_tree = old_tree
579
self.new_tree = new_tree
580
self.to_file = to_file
581
self.path_encoding = path_encoding
587
def from_diff_tree(klass, diff_tree):
588
return klass(diff_tree.old_tree, diff_tree.new_tree,
589
diff_tree.to_file, diff_tree.path_encoding)
592
def _diff_many(differs, file_id, old_path, new_path, old_kind, new_kind):
593
for file_differ in differs:
594
result = file_differ.diff(file_id, old_path, new_path, old_kind,
596
if result is not DiffPath.CANNOT_DIFF:
599
return DiffPath.CANNOT_DIFF
602
class DiffKindChange(object):
603
"""Special differ for file kind changes.
605
Represents kind change as deletion + creation. Uses the other differs
608
def __init__(self, differs):
609
self.differs = differs
615
def from_diff_tree(klass, diff_tree):
616
return klass(diff_tree.differs)
618
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
619
"""Perform comparison
621
:param file_id: The file_id of the file to compare
622
:param old_path: Path of the file in the old tree
623
:param new_path: Path of the file in the new tree
624
:param old_kind: Old file-kind of the file
625
:param new_kind: New file-kind of the file
627
if None in (old_kind, new_kind):
628
return DiffPath.CANNOT_DIFF
629
result = DiffPath._diff_many(self.differs, file_id, old_path,
630
new_path, old_kind, None)
631
if result is DiffPath.CANNOT_DIFF:
633
return DiffPath._diff_many(self.differs, file_id, old_path, new_path,
637
class DiffDirectory(DiffPath):
639
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
640
"""Perform comparison between two directories. (dummy)
643
if 'directory' not in (old_kind, new_kind):
644
return self.CANNOT_DIFF
645
if old_kind not in ('directory', None):
646
return self.CANNOT_DIFF
647
if new_kind not in ('directory', None):
648
return self.CANNOT_DIFF
652
class DiffSymlink(DiffPath):
654
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
655
"""Perform comparison between two symlinks
657
:param file_id: The file_id of the file to compare
658
:param old_path: Path of the file in the old tree
659
:param new_path: Path of the file in the new tree
660
:param old_kind: Old file-kind of the file
661
:param new_kind: New file-kind of the file
663
if 'symlink' not in (old_kind, new_kind):
664
return self.CANNOT_DIFF
665
if old_kind == 'symlink':
666
old_target = self.old_tree.get_symlink_target(file_id)
667
elif old_kind is None:
670
return self.CANNOT_DIFF
671
if new_kind == 'symlink':
672
new_target = self.new_tree.get_symlink_target(file_id)
673
elif new_kind is None:
676
return self.CANNOT_DIFF
677
return self.diff_symlink(old_target, new_target)
679
def diff_symlink(self, old_target, new_target):
680
if old_target is None:
681
self.to_file.write('=== target is %r\n' % new_target)
682
elif new_target is None:
683
self.to_file.write('=== target was %r\n' % old_target)
685
self.to_file.write('=== target changed %r => %r\n' %
686
(old_target, new_target))
690
class DiffText(DiffPath):
692
# GNU Patch uses the epoch date to detect files that are being added
693
# or removed in a diff.
694
EPOCH_DATE = '1970-01-01 00:00:00 +0000'
696
def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
697
old_label='', new_label='', text_differ=internal_diff):
698
DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
699
self.text_differ = text_differ
700
self.old_label = old_label
701
self.new_label = new_label
702
self.path_encoding = path_encoding
704
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
705
"""Compare two files in unified diff format
707
:param file_id: The file_id of the file to compare
708
:param old_path: Path of the file in the old tree
709
:param new_path: Path of the file in the new tree
710
:param old_kind: Old file-kind of the file
711
:param new_kind: New file-kind of the file
713
if 'file' not in (old_kind, new_kind):
714
return self.CANNOT_DIFF
715
from_file_id = to_file_id = file_id
716
if old_kind == 'file':
717
old_date = _patch_header_date(self.old_tree, file_id, old_path)
718
elif old_kind is None:
719
old_date = self.EPOCH_DATE
722
return self.CANNOT_DIFF
723
if new_kind == 'file':
724
new_date = _patch_header_date(self.new_tree, file_id, new_path)
725
elif new_kind is None:
726
new_date = self.EPOCH_DATE
729
return self.CANNOT_DIFF
730
from_label = '%s%s\t%s' % (self.old_label, old_path, old_date)
731
to_label = '%s%s\t%s' % (self.new_label, new_path, new_date)
732
return self.diff_text(from_file_id, to_file_id, from_label, to_label)
734
def diff_text(self, from_file_id, to_file_id, from_label, to_label):
735
"""Diff the content of given files in two trees
737
:param from_file_id: The id of the file in the from tree. If None,
738
the file is not present in the from tree.
739
:param to_file_id: The id of the file in the to tree. This may refer
740
to a different file from from_file_id. If None,
741
the file is not present in the to tree.
743
def _get_text(tree, file_id):
744
if file_id is not None:
745
return tree.get_file(file_id).readlines()
749
from_text = _get_text(self.old_tree, from_file_id)
750
to_text = _get_text(self.new_tree, to_file_id)
751
self.text_differ(from_label, from_text, to_label, to_text,
753
except errors.BinaryFile:
755
("Binary files %s and %s differ\n" %
756
(from_label, to_label)).encode(self.path_encoding))
760
class DiffFromTool(DiffPath):
762
def __init__(self, command_template, old_tree, new_tree, to_file,
763
path_encoding='utf-8'):
764
DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
765
self.command_template = command_template
766
self._root = tempfile.mkdtemp(prefix='bzr-diff-')
769
def from_string(klass, command_string, old_tree, new_tree, to_file,
770
path_encoding='utf-8'):
771
command_template = commands.shlex_split_unicode(command_string)
772
command_template.extend(['%(old_path)s', '%(new_path)s'])
773
return klass(command_template, old_tree, new_tree, to_file,
777
def make_from_diff_tree(klass, command_string):
778
def from_diff_tree(diff_tree):
779
return klass.from_string(command_string, diff_tree.old_tree,
780
diff_tree.new_tree, diff_tree.to_file)
781
return from_diff_tree
783
def _get_command(self, old_path, new_path):
784
my_map = {'old_path': old_path, 'new_path': new_path}
785
return [t % my_map for t in self.command_template]
787
def _execute(self, old_path, new_path):
788
command = self._get_command(old_path, new_path)
790
proc = subprocess.Popen(command, stdout=subprocess.PIPE,
793
if e.errno == errno.ENOENT:
794
raise errors.ExecutableMissing(command[0])
797
self.to_file.write(proc.stdout.read())
800
def _try_symlink_root(self, tree, prefix):
801
if not (getattr(tree, 'abspath', None) is not None
802
and osutils.has_symlinks()):
805
os.symlink(tree.abspath(''), osutils.pathjoin(self._root, prefix))
807
if e.errno != errno.EEXIST:
811
def _write_file(self, file_id, tree, prefix, relpath):
812
full_path = osutils.pathjoin(self._root, prefix, relpath)
813
if self._try_symlink_root(tree, prefix):
815
parent_dir = osutils.dirname(full_path)
817
os.makedirs(parent_dir)
819
if e.errno != errno.EEXIST:
821
source = tree.get_file(file_id, relpath)
823
target = open(full_path, 'wb')
825
osutils.pumpfile(source, target)
830
osutils.make_readonly(full_path)
831
mtime = tree.get_file_mtime(file_id)
832
os.utime(full_path, (mtime, mtime))
835
def _prepare_files(self, file_id, old_path, new_path):
836
old_disk_path = self._write_file(file_id, self.old_tree, 'old',
838
new_disk_path = self._write_file(file_id, self.new_tree, 'new',
840
return old_disk_path, new_disk_path
843
osutils.rmtree(self._root)
845
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
846
if (old_kind, new_kind) != ('file', 'file'):
847
return DiffPath.CANNOT_DIFF
848
self._prepare_files(file_id, old_path, new_path)
849
self._execute(osutils.pathjoin('old', old_path),
850
osutils.pathjoin('new', new_path))
853
class DiffTree(object):
854
"""Provides textual representations of the difference between two trees.
856
A DiffTree examines two trees and where a file-id has altered
857
between them, generates a textual representation of the difference.
858
DiffTree uses a sequence of DiffPath objects which are each
859
given the opportunity to handle a given altered fileid. The list
860
of DiffPath objects can be extended globally by appending to
861
DiffTree.diff_factories, or for a specific diff operation by
862
supplying the extra_factories option to the appropriate method.
865
# list of factories that can provide instances of DiffPath objects
866
# may be extended by plugins.
867
diff_factories = [DiffSymlink.from_diff_tree,
868
DiffDirectory.from_diff_tree]
870
def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
871
diff_text=None, extra_factories=None):
874
:param old_tree: Tree to show as old in the comparison
875
:param new_tree: Tree to show as new in the comparison
876
:param to_file: File to write comparision to
877
:param path_encoding: Character encoding to write paths in
878
:param diff_text: DiffPath-type object to use as a last resort for
880
:param extra_factories: Factories of DiffPaths to try before any other
882
if diff_text is None:
883
diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
884
'', '', internal_diff)
885
self.old_tree = old_tree
886
self.new_tree = new_tree
887
self.to_file = to_file
888
self.path_encoding = path_encoding
890
if extra_factories is not None:
891
self.differs.extend(f(self) for f in extra_factories)
892
self.differs.extend(f(self) for f in self.diff_factories)
893
self.differs.extend([diff_text, DiffKindChange.from_diff_tree(self)])
896
def from_trees_options(klass, old_tree, new_tree, to_file,
897
path_encoding, external_diff_options, old_label,
899
"""Factory for producing a DiffTree.
901
Designed to accept options used by show_diff_trees.
902
:param old_tree: The tree to show as old in the comparison
903
:param new_tree: The tree to show as new in the comparison
904
:param to_file: File to write comparisons to
905
:param path_encoding: Character encoding to use for writing paths
906
:param external_diff_options: If supplied, use the installed diff
907
binary to perform file comparison, using supplied options.
908
:param old_label: Prefix to use for old file labels
909
:param new_label: Prefix to use for new file labels
910
:param using: Commandline to use to invoke an external diff tool
912
if using is not None:
913
extra_factories = [DiffFromTool.make_from_diff_tree(using)]
916
if external_diff_options:
917
assert isinstance(external_diff_options, basestring)
918
opts = external_diff_options.split()
919
def diff_file(olab, olines, nlab, nlines, to_file):
920
external_diff(olab, olines, nlab, nlines, to_file, opts)
922
diff_file = internal_diff
923
diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
924
old_label, new_label, diff_file)
925
return klass(old_tree, new_tree, to_file, path_encoding, diff_text,
928
def show_diff(self, specific_files, extra_trees=None):
929
"""Write tree diff to self.to_file
931
:param sepecific_files: the specific files to compare (recursive)
932
:param extra_trees: extra trees to use for mapping paths to file_ids
935
return self._show_diff(specific_files, extra_trees)
937
for differ in self.differs:
940
def _show_diff(self, specific_files, extra_trees):
941
# TODO: Generation of pseudo-diffs for added/deleted files could
942
# be usefully made into a much faster special case.
943
iterator = self.new_tree.iter_changes(self.old_tree,
944
specific_files=specific_files,
945
extra_trees=extra_trees,
946
require_versioned=True)
948
def changes_key(change):
949
old_path, new_path = change[1]
954
def get_encoded_path(path):
956
return path.encode(self.path_encoding, "replace")
957
for (file_id, paths, changed_content, versioned, parent, name, kind,
958
executable) in sorted(iterator, key=changes_key):
959
if parent == (None, None):
961
oldpath, newpath = paths
962
oldpath_encoded = get_encoded_path(paths[0])
963
newpath_encoded = get_encoded_path(paths[1])
964
old_present = (kind[0] is not None and versioned[0])
965
new_present = (kind[1] is not None and versioned[1])
966
renamed = (parent[0], name[0]) != (parent[1], name[1])
968
properties_changed = []
969
properties_changed.extend(get_executable_change(executable[0], executable[1]))
971
if properties_changed:
972
prop_str = " (properties changed: %s)" % (", ".join(properties_changed),)
976
if (old_present, new_present) == (True, False):
977
self.to_file.write("=== removed %s '%s'\n" %
978
(kind[0], oldpath_encoded))
980
elif (old_present, new_present) == (False, True):
981
self.to_file.write("=== added %s '%s'\n" %
982
(kind[1], newpath_encoded))
985
self.to_file.write("=== renamed %s '%s' => '%s'%s\n" %
986
(kind[0], oldpath_encoded, newpath_encoded, prop_str))
988
# if it was produced by iter_changes, it must be
989
# modified *somehow*, either content or execute bit.
990
self.to_file.write("=== modified %s '%s'%s\n" % (kind[0],
991
newpath_encoded, prop_str))
993
self.diff(file_id, oldpath, newpath)
999
def diff(self, file_id, old_path, new_path):
1000
"""Perform a diff of a single file
1002
:param file_id: file-id of the file
1003
:param old_path: The path of the file in the old tree
1004
:param new_path: The path of the file in the new tree
1007
old_kind = self.old_tree.kind(file_id)
1008
except (errors.NoSuchId, errors.NoSuchFile):
1011
new_kind = self.new_tree.kind(file_id)
1012
except (errors.NoSuchId, errors.NoSuchFile):
1015
result = DiffPath._diff_many(self.differs, file_id, old_path,
1016
new_path, old_kind, new_kind)
1017
if result is DiffPath.CANNOT_DIFF:
1018
error_path = new_path
1019
if error_path is None:
1020
error_path = old_path
1021
raise errors.NoDiffFound(error_path)
added
removed
bzrlib/diff.py
