/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Ian Clatworthy
  • Date: 2007-12-04 05:49:37 UTC
  • mto: (3118.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3119.
  • Revision ID: ian.clatworthy@internode.on.net-20071204054937-6v169ypv0lclbyuj
Improved diff based on feedback from abentley

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2004, 2005, 2006 Canonical Ltd.
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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
 
16
 
 
17
import difflib
 
18
import os
 
19
import re
 
20
import sys
 
21
 
 
22
from bzrlib.lazy_import import lazy_import
 
23
lazy_import(globals(), """
 
24
import errno
 
25
import subprocess
 
26
import tempfile
 
27
import time
 
28
 
 
29
from bzrlib import (
 
30
    bzrdir,
 
31
    errors,
 
32
    osutils,
 
33
    patiencediff,
 
34
    textfile,
 
35
    timestamp,
 
36
    )
 
37
""")
 
38
 
 
39
from bzrlib.symbol_versioning import (
 
40
        deprecated_function,
 
41
        zero_ninetythree,
 
42
        )
 
43
from bzrlib.trace import mutter, warning
 
44
 
 
45
 
 
46
# TODO: Rather than building a changeset object, we should probably
 
47
# invoke callbacks on an object.  That object can either accumulate a
 
48
# list, write them out directly, etc etc.
 
49
 
 
50
 
 
51
class _PrematchedMatcher(difflib.SequenceMatcher):
 
52
    """Allow SequenceMatcher operations to use predetermined blocks"""
 
53
 
 
54
    def __init__(self, matching_blocks):
 
55
        difflib.SequenceMatcher(self, None, None)
 
56
        self.matching_blocks = matching_blocks
 
57
        self.opcodes = None
 
58
 
 
59
 
 
60
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
 
61
                  allow_binary=False, sequence_matcher=None,
 
62
                  path_encoding='utf8'):
 
63
    # FIXME: difflib is wrong if there is no trailing newline.
 
64
    # The syntax used by patch seems to be "\ No newline at
 
65
    # end of file" following the last diff line from that
 
66
    # file.  This is not trivial to insert into the
 
67
    # unified_diff output and it might be better to just fix
 
68
    # or replace that function.
 
69
 
 
70
    # In the meantime we at least make sure the patch isn't
 
71
    # mangled.
 
72
 
 
73
 
 
74
    # Special workaround for Python2.3, where difflib fails if
 
75
    # both sequences are empty.
 
76
    if not oldlines and not newlines:
 
77
        return
 
78
    
 
79
    if allow_binary is False:
 
80
        textfile.check_text_lines(oldlines)
 
81
        textfile.check_text_lines(newlines)
 
82
 
 
83
    if sequence_matcher is None:
 
84
        sequence_matcher = patiencediff.PatienceSequenceMatcher
 
85
    ud = patiencediff.unified_diff(oldlines, newlines,
 
86
                      fromfile=old_filename.encode(path_encoding),
 
87
                      tofile=new_filename.encode(path_encoding),
 
88
                      sequencematcher=sequence_matcher)
 
89
 
 
90
    ud = list(ud)
 
91
    # work-around for difflib being too smart for its own good
 
92
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
 
93
    if not oldlines:
 
94
        ud[2] = ud[2].replace('-1,0', '-0,0')
 
95
    elif not newlines:
 
96
        ud[2] = ud[2].replace('+1,0', '+0,0')
 
97
    # work around for difflib emitting random spaces after the label
 
98
    ud[0] = ud[0][:-2] + '\n'
 
99
    ud[1] = ud[1][:-2] + '\n'
 
100
 
 
101
    for line in ud:
 
102
        to_file.write(line)
 
103
        if not line.endswith('\n'):
 
104
            to_file.write("\n\\ No newline at end of file\n")
 
105
    to_file.write('\n')
 
106
 
 
107
 
 
108
def _spawn_external_diff(diffcmd, capture_errors=True):
 
109
    """Spawn the externall diff process, and return the child handle.
 
110
 
 
111
    :param diffcmd: The command list to spawn
 
112
    :param capture_errors: Capture stderr as well as setting LANG=C
 
113
        and LC_ALL=C. This lets us read and understand the output of diff,
 
114
        and respond to any errors.
 
115
    :return: A Popen object.
 
116
    """
 
117
    if capture_errors:
 
118
        # construct minimal environment
 
119
        env = {}
 
120
        path = os.environ.get('PATH')
 
121
        if path is not None:
 
122
            env['PATH'] = path
 
123
        env['LANGUAGE'] = 'C'   # on win32 only LANGUAGE has effect
 
124
        env['LANG'] = 'C'
 
125
        env['LC_ALL'] = 'C'
 
126
        stderr = subprocess.PIPE
 
127
    else:
 
128
        env = None
 
129
        stderr = None
 
130
 
 
131
    try:
 
132
        pipe = subprocess.Popen(diffcmd,
 
133
                                stdin=subprocess.PIPE,
 
134
                                stdout=subprocess.PIPE,
 
135
                                stderr=stderr,
 
136
                                env=env)
 
137
    except OSError, e:
 
138
        if e.errno == errno.ENOENT:
 
139
            raise errors.NoDiff(str(e))
 
140
        raise
 
141
 
 
142
    return pipe
 
143
 
 
144
 
 
145
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
 
146
                  diff_opts):
 
147
    """Display a diff by calling out to the external diff program."""
 
148
    # make sure our own output is properly ordered before the diff
 
149
    to_file.flush()
 
150
 
 
151
    oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='bzr-diff-old-')
 
152
    newtmp_fd, new_abspath = tempfile.mkstemp(prefix='bzr-diff-new-')
 
153
    oldtmpf = os.fdopen(oldtmp_fd, 'wb')
 
154
    newtmpf = os.fdopen(newtmp_fd, 'wb')
 
155
 
 
156
    try:
 
157
        # TODO: perhaps a special case for comparing to or from the empty
 
158
        # sequence; can just use /dev/null on Unix
 
159
 
 
160
        # TODO: if either of the files being compared already exists as a
 
161
        # regular named file (e.g. in the working directory) then we can
 
162
        # compare directly to that, rather than copying it.
 
163
 
 
164
        oldtmpf.writelines(oldlines)
 
165
        newtmpf.writelines(newlines)
 
166
 
 
167
        oldtmpf.close()
 
168
        newtmpf.close()
 
169
 
 
170
        if not diff_opts:
 
171
            diff_opts = []
 
172
        diffcmd = ['diff',
 
173
                   '--label', old_filename,
 
174
                   old_abspath,
 
175
                   '--label', new_filename,
 
176
                   new_abspath,
 
177
                   '--binary',
 
178
                  ]
 
179
 
 
180
        # diff only allows one style to be specified; they don't override.
 
181
        # note that some of these take optargs, and the optargs can be
 
182
        # directly appended to the options.
 
183
        # this is only an approximate parser; it doesn't properly understand
 
184
        # the grammar.
 
185
        for s in ['-c', '-u', '-C', '-U',
 
186
                  '-e', '--ed',
 
187
                  '-q', '--brief',
 
188
                  '--normal',
 
189
                  '-n', '--rcs',
 
190
                  '-y', '--side-by-side',
 
191
                  '-D', '--ifdef']:
 
192
            for j in diff_opts:
 
193
                if j.startswith(s):
 
194
                    break
 
195
            else:
 
196
                continue
 
197
            break
 
198
        else:
 
199
            diffcmd.append('-u')
 
200
                  
 
201
        if diff_opts:
 
202
            diffcmd.extend(diff_opts)
 
203
 
 
204
        pipe = _spawn_external_diff(diffcmd, capture_errors=True)
 
205
        out,err = pipe.communicate()
 
206
        rc = pipe.returncode
 
207
        
 
208
        # internal_diff() adds a trailing newline, add one here for consistency
 
209
        out += '\n'
 
210
        if rc == 2:
 
211
            # 'diff' gives retcode == 2 for all sorts of errors
 
212
            # one of those is 'Binary files differ'.
 
213
            # Bad options could also be the problem.
 
214
            # 'Binary files' is not a real error, so we suppress that error.
 
215
            lang_c_out = out
 
216
 
 
217
            # Since we got here, we want to make sure to give an i18n error
 
218
            pipe = _spawn_external_diff(diffcmd, capture_errors=False)
 
219
            out, err = pipe.communicate()
 
220
 
 
221
            # Write out the new i18n diff response
 
222
            to_file.write(out+'\n')
 
223
            if pipe.returncode != 2:
 
224
                raise errors.BzrError(
 
225
                               'external diff failed with exit code 2'
 
226
                               ' when run with LANG=C and LC_ALL=C,'
 
227
                               ' but not when run natively: %r' % (diffcmd,))
 
228
 
 
229
            first_line = lang_c_out.split('\n', 1)[0]
 
230
            # Starting with diffutils 2.8.4 the word "binary" was dropped.
 
231
            m = re.match('^(binary )?files.*differ$', first_line, re.I)
 
232
            if m is None:
 
233
                raise errors.BzrError('external diff failed with exit code 2;'
 
234
                                      ' command: %r' % (diffcmd,))
 
235
            else:
 
236
                # Binary files differ, just return
 
237
                return
 
238
 
 
239
        # If we got to here, we haven't written out the output of diff
 
240
        # do so now
 
241
        to_file.write(out)
 
242
        if rc not in (0, 1):
 
243
            # returns 1 if files differ; that's OK
 
244
            if rc < 0:
 
245
                msg = 'signal %d' % (-rc)
 
246
            else:
 
247
                msg = 'exit code %d' % rc
 
248
                
 
249
            raise errors.BzrError('external diff failed with %s; command: %r' 
 
250
                                  % (rc, diffcmd))
 
251
 
 
252
 
 
253
    finally:
 
254
        oldtmpf.close()                 # and delete
 
255
        newtmpf.close()
 
256
        # Clean up. Warn in case the files couldn't be deleted
 
257
        # (in case windows still holds the file open, but not
 
258
        # if the files have already been deleted)
 
259
        try:
 
260
            os.remove(old_abspath)
 
261
        except OSError, e:
 
262
            if e.errno not in (errno.ENOENT,):
 
263
                warning('Failed to delete temporary file: %s %s',
 
264
                        old_abspath, e)
 
265
        try:
 
266
            os.remove(new_abspath)
 
267
        except OSError:
 
268
            if e.errno not in (errno.ENOENT,):
 
269
                warning('Failed to delete temporary file: %s %s',
 
270
                        new_abspath, e)
 
271
 
 
272
 
 
273
@deprecated_function(zero_ninetythree)
 
274
def diff_cmd_helper(tree, specific_files, external_diff_options, 
 
275
                    old_revision_spec=None, new_revision_spec=None,
 
276
                    revision_specs=None,
 
277
                    old_label='a/', new_label='b/'):
 
278
    """Helper for cmd_diff.
 
279
 
 
280
    :param tree:
 
281
        A WorkingTree
 
282
 
 
283
    :param specific_files:
 
284
        The specific files to compare, or None
 
285
 
 
286
    :param external_diff_options:
 
287
        If non-None, run an external diff, and pass it these options
 
288
 
 
289
    :param old_revision_spec:
 
290
        If None, use basis tree as old revision, otherwise use the tree for
 
291
        the specified revision. 
 
292
 
 
293
    :param new_revision_spec:
 
294
        If None, use working tree as new revision, otherwise use the tree for
 
295
        the specified revision.
 
296
    
 
297
    :param revision_specs: 
 
298
        Zero, one or two RevisionSpecs from the command line, saying what revisions 
 
299
        to compare.  This can be passed as an alternative to the old_revision_spec 
 
300
        and new_revision_spec parameters.
 
301
 
 
302
    The more general form is show_diff_trees(), where the caller
 
303
    supplies any two trees.
 
304
    """
 
305
 
 
306
    # TODO: perhaps remove the old parameters old_revision_spec and
 
307
    # new_revision_spec, since this is only really for use from cmd_diff and
 
308
    # it now always passes through a sequence of revision_specs -- mbp
 
309
    # 20061221
 
310
 
 
311
    def spec_tree(spec):
 
312
        if tree:
 
313
            revision = spec.in_store(tree.branch)
 
314
        else:
 
315
            revision = spec.in_store(None)
 
316
        revision_id = revision.rev_id
 
317
        branch = revision.branch
 
318
        return branch.repository.revision_tree(revision_id)
 
319
 
 
320
    if revision_specs is not None:
 
321
        assert (old_revision_spec is None
 
322
                and new_revision_spec is None)
 
323
        if len(revision_specs) > 0:
 
324
            old_revision_spec = revision_specs[0]
 
325
        if len(revision_specs) > 1:
 
326
            new_revision_spec = revision_specs[1]
 
327
 
 
328
    if old_revision_spec is None:
 
329
        old_tree = tree.basis_tree()
 
330
    else:
 
331
        old_tree = spec_tree(old_revision_spec)
 
332
 
 
333
    if (new_revision_spec is None
 
334
        or new_revision_spec.spec is None):
 
335
        new_tree = tree
 
336
    else:
 
337
        new_tree = spec_tree(new_revision_spec)
 
338
 
 
339
    if new_tree is not tree:
 
340
        extra_trees = (tree,)
 
341
    else:
 
342
        extra_trees = None
 
343
 
 
344
    return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
 
345
                           external_diff_options,
 
346
                           old_label=old_label, new_label=new_label,
 
347
                           extra_trees=extra_trees)
 
348
 
 
349
 
 
350
def _get_trees_to_diff(path_list, revision_specs, old_url, new_url):
 
351
    """Get the trees and specific files to diff given a list of paths.
 
352
 
 
353
    This method works out the trees to be diff'ed and the files of
 
354
    interest within those trees.
 
355
 
 
356
    :param path_list:
 
357
        the list of arguments passed to the diff command
 
358
    :param revision_specs:
 
359
        Zero, one or two RevisionSpecs from the diff command line,
 
360
        saying what revisions to compare.
 
361
    :param old_url:
 
362
        The url of the old branch or tree. If None, the tree to use is
 
363
        taken from the first path, if any, or the current working tree.
 
364
    :param new_url:
 
365
        The url of the new branch or tree. If None, the tree to use is
 
366
        taken from the first path, if any, or the current working tree.
 
367
    :returns:
 
368
        a tuple of (old_tree, new_tree, specific_files, extra_trees) where
 
369
        extra_trees is a sequence of additional trees to search in for
 
370
        file-ids.
 
371
    """
 
372
    # Get the old and new revision specs
 
373
    old_revision_spec = None
 
374
    new_revision_spec = None
 
375
    if revision_specs is not None:
 
376
        if len(revision_specs) > 0:
 
377
            old_revision_spec = revision_specs[0]
 
378
        if len(revision_specs) > 1:
 
379
            new_revision_spec = revision_specs[1]
 
380
        # If both revision specs include a branch, we can diff them
 
381
        # without needing to look further for the details
 
382
        if (old_revision_spec is not None and
 
383
            new_revision_spec is not None and
 
384
            not old_revision_spec.needs_branch() and
 
385
            not new_revision_spec.needs_branch()):
 
386
            old_tree = _get_tree_to_diff(old_revision_spec)
 
387
            new_tree = _get_tree_to_diff(new_revision_spec)
 
388
            specific_files = path_list or None
 
389
            return old_tree, new_tree, specific_files, None
 
390
 
 
391
    # If no path is given, assume the current directory
 
392
    if path_list is None or len(path_list) == 0:
 
393
        default_location = u'.'
 
394
        other_paths = []
 
395
        check_paths = True
 
396
    elif old_url is not None and new_url is not None:
 
397
        default_location = None  # don't care - not required
 
398
        other_paths = path_list
 
399
        check_paths = False
 
400
    else:
 
401
        default_location = path_list[0]
 
402
        other_paths = path_list[1:]
 
403
        check_paths = True
 
404
 
 
405
    # Get the old location
 
406
    if old_url is None:
 
407
        old_url = default_location
 
408
    working_tree, branch, relpath = \
 
409
        bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
 
410
    old_tree = _get_tree_to_diff(old_revision_spec, working_tree, branch)
 
411
 
 
412
    # Get the new location
 
413
    if new_url is None:
 
414
        new_url = default_location
 
415
    if new_url != old_url:
 
416
        working_tree, branch, relpath = \
 
417
            bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
 
418
    new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
 
419
        basis_is_default=working_tree is None)
 
420
 
 
421
    # Get the specific files and extra trees
 
422
    specific_files = _relative_files_for_diff(working_tree, relpath,
 
423
        other_paths, check_paths)
 
424
    extra_trees = None
 
425
    if new_tree != working_tree and working_tree is not None:
 
426
        extra_trees = (working_tree,)
 
427
    return old_tree, new_tree, specific_files, extra_trees
 
428
 
 
429
 
 
430
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
 
431
    if branch is None and tree is not None:
 
432
        branch = tree.branch
 
433
    if spec is None or spec.spec is None:
 
434
        if basis_is_default:
 
435
            return branch.basis_tree()
 
436
        else:
 
437
            return tree
 
438
    revision = spec.in_store(branch)
 
439
    revision_id = revision.rev_id
 
440
    rev_branch = revision.branch
 
441
    return rev_branch.repository.revision_tree(revision_id)
 
442
 
 
443
 
 
444
def _relative_files_for_diff(tree, first_relpath, other_paths, check_paths):
 
445
    """Get the specific files for diff.
 
446
 
 
447
    This method converts path arguments to relative paths in a tree.
 
448
    If the tree is None or check_paths is False, other_paths are assumed
 
449
    to be relative already. Otherwise, all arguments must be paths in
 
450
    the working tree.
 
451
    """
 
452
    specific_files = []
 
453
    if first_relpath != '':
 
454
        specific_files.append(first_relpath)
 
455
    if not check_paths or tree is None:
 
456
        specific_files.extend(other_paths)
 
457
    else:
 
458
        for filename in other_paths:
 
459
            try:
 
460
                specific_files.append(tree.relpath(osutils.dereference_path(
 
461
                    filename)))
 
462
            except errors.PathNotChild:
 
463
                raise errors.BzrCommandError("Files are in different branches")
 
464
    if len(specific_files) == 0:
 
465
        specific_files = None
 
466
    return specific_files
 
467
 
 
468
 
 
469
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
 
470
                    external_diff_options=None,
 
471
                    old_label='a/', new_label='b/',
 
472
                    extra_trees=None,
 
473
                    path_encoding='utf8'):
 
474
    """Show in text form the changes from one tree to another.
 
475
 
 
476
    to_file
 
477
        The output stream.
 
478
 
 
479
    specific_files
 
480
        Include only changes to these files - None for all changes.
 
481
 
 
482
    external_diff_options
 
483
        If set, use an external GNU diff and pass these options.
 
484
 
 
485
    extra_trees
 
486
        If set, more Trees to use for looking up file ids
 
487
 
 
488
    path_encoding
 
489
        If set, the path will be encoded as specified, otherwise is supposed
 
490
        to be utf8
 
491
    """
 
492
    old_tree.lock_read()
 
493
    try:
 
494
        if extra_trees is not None:
 
495
            for tree in extra_trees:
 
496
                tree.lock_read()
 
497
        new_tree.lock_read()
 
498
        try:
 
499
            differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
 
500
                                                   path_encoding,
 
501
                                                   external_diff_options,
 
502
                                                   old_label, new_label)
 
503
            return differ.show_diff(specific_files, extra_trees)
 
504
        finally:
 
505
            new_tree.unlock()
 
506
            if extra_trees is not None:
 
507
                for tree in extra_trees:
 
508
                    tree.unlock()
 
509
    finally:
 
510
        old_tree.unlock()
 
511
 
 
512
 
 
513
def _patch_header_date(tree, file_id, path):
 
514
    """Returns a timestamp suitable for use in a patch header."""
 
515
    mtime = tree.get_file_mtime(file_id, path)
 
516
    assert mtime is not None, \
 
517
        "got an mtime of None for file-id %s, path %s in tree %s" % (
 
518
                file_id, path, tree)
 
519
    return timestamp.format_patch_date(mtime)
 
520
 
 
521
 
 
522
def _raise_if_nonexistent(paths, old_tree, new_tree):
 
523
    """Complain if paths are not in either inventory or tree.
 
524
 
 
525
    It's OK with the files exist in either tree's inventory, or 
 
526
    if they exist in the tree but are not versioned.
 
527
    
 
528
    This can be used by operations such as bzr status that can accept
 
529
    unknown or ignored files.
 
530
    """
 
531
    mutter("check paths: %r", paths)
 
532
    if not paths:
 
533
        return
 
534
    s = old_tree.filter_unversioned_files(paths)
 
535
    s = new_tree.filter_unversioned_files(s)
 
536
    s = [path for path in s if not new_tree.has_filename(path)]
 
537
    if s:
 
538
        raise errors.PathsDoNotExist(sorted(s))
 
539
 
 
540
 
 
541
def get_prop_change(meta_modified):
 
542
    if meta_modified:
 
543
        return " (properties changed)"
 
544
    else:
 
545
        return  ""
 
546
 
 
547
 
 
548
class DiffPath(object):
 
549
    """Base type for command object that compare files"""
 
550
 
 
551
    # The type or contents of the file were unsuitable for diffing
 
552
    CANNOT_DIFF = 'CANNOT_DIFF'
 
553
    # The file has changed in a semantic way
 
554
    CHANGED = 'CHANGED'
 
555
    # The file content may have changed, but there is no semantic change
 
556
    UNCHANGED = 'UNCHANGED'
 
557
 
 
558
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8'):
 
559
        """Constructor.
 
560
 
 
561
        :param old_tree: The tree to show as the old tree in the comparison
 
562
        :param new_tree: The tree to show as new in the comparison
 
563
        :param to_file: The file to write comparison data to
 
564
        :param path_encoding: The character encoding to write paths in
 
565
        """
 
566
        self.old_tree = old_tree
 
567
        self.new_tree = new_tree
 
568
        self.to_file = to_file
 
569
        self.path_encoding = path_encoding
 
570
 
 
571
    @classmethod
 
572
    def from_diff_tree(klass, diff_tree):
 
573
        return klass(diff_tree.old_tree, diff_tree.new_tree,
 
574
                     diff_tree.to_file, diff_tree.path_encoding)
 
575
 
 
576
    @staticmethod
 
577
    def _diff_many(differs, file_id, old_path, new_path, old_kind, new_kind):
 
578
        for file_differ in differs:
 
579
            result = file_differ.diff(file_id, old_path, new_path, old_kind,
 
580
                                      new_kind)
 
581
            if result is not DiffPath.CANNOT_DIFF:
 
582
                return result
 
583
        else:
 
584
            return DiffPath.CANNOT_DIFF
 
585
 
 
586
 
 
587
class DiffKindChange(object):
 
588
    """Special differ for file kind changes.
 
589
 
 
590
    Represents kind change as deletion + creation.  Uses the other differs
 
591
    to do this.
 
592
    """
 
593
    def __init__(self, differs):
 
594
        self.differs = differs
 
595
 
 
596
    @classmethod
 
597
    def from_diff_tree(klass, diff_tree):
 
598
        return klass(diff_tree.differs)
 
599
 
 
600
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
 
601
        """Perform comparison
 
602
 
 
603
        :param file_id: The file_id of the file to compare
 
604
        :param old_path: Path of the file in the old tree
 
605
        :param new_path: Path of the file in the new tree
 
606
        :param old_kind: Old file-kind of the file
 
607
        :param new_kind: New file-kind of the file
 
608
        """
 
609
        if None in (old_kind, new_kind):
 
610
            return DiffPath.CANNOT_DIFF
 
611
        result = DiffPath._diff_many(self.differs, file_id, old_path,
 
612
                                       new_path, old_kind, None)
 
613
        if result is DiffPath.CANNOT_DIFF:
 
614
            return result
 
615
        return DiffPath._diff_many(self.differs, file_id, old_path, new_path,
 
616
                                     None, new_kind)
 
617
 
 
618
 
 
619
class DiffDirectory(DiffPath):
 
620
 
 
621
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
 
622
        """Perform comparison between two directories.  (dummy)
 
623
 
 
624
        """
 
625
        if 'directory' not in (old_kind, new_kind):
 
626
            return self.CANNOT_DIFF
 
627
        if old_kind not in ('directory', None):
 
628
            return self.CANNOT_DIFF
 
629
        if new_kind not in ('directory', None):
 
630
            return self.CANNOT_DIFF
 
631
        return self.CHANGED
 
632
 
 
633
 
 
634
class DiffSymlink(DiffPath):
 
635
 
 
636
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
 
637
        """Perform comparison between two symlinks
 
638
 
 
639
        :param file_id: The file_id of the file to compare
 
640
        :param old_path: Path of the file in the old tree
 
641
        :param new_path: Path of the file in the new tree
 
642
        :param old_kind: Old file-kind of the file
 
643
        :param new_kind: New file-kind of the file
 
644
        """
 
645
        if 'symlink' not in (old_kind, new_kind):
 
646
            return self.CANNOT_DIFF
 
647
        if old_kind == 'symlink':
 
648
            old_target = self.old_tree.get_symlink_target(file_id)
 
649
        elif old_kind is None:
 
650
            old_target = None
 
651
        else:
 
652
            return self.CANNOT_DIFF
 
653
        if new_kind == 'symlink':
 
654
            new_target = self.new_tree.get_symlink_target(file_id)
 
655
        elif new_kind is None:
 
656
            new_target = None
 
657
        else:
 
658
            return self.CANNOT_DIFF
 
659
        return self.diff_symlink(old_target, new_target)
 
660
 
 
661
    def diff_symlink(self, old_target, new_target):
 
662
        if old_target is None:
 
663
            self.to_file.write('=== target is %r\n' % new_target)
 
664
        elif new_target is None:
 
665
            self.to_file.write('=== target was %r\n' % old_target)
 
666
        else:
 
667
            self.to_file.write('=== target changed %r => %r\n' %
 
668
                              (old_target, new_target))
 
669
        return self.CHANGED
 
670
 
 
671
 
 
672
class DiffText(DiffPath):
 
673
 
 
674
    # GNU Patch uses the epoch date to detect files that are being added
 
675
    # or removed in a diff.
 
676
    EPOCH_DATE = '1970-01-01 00:00:00 +0000'
 
677
 
 
678
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
 
679
                 old_label='', new_label='', text_differ=internal_diff):
 
680
        DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
 
681
        self.text_differ = text_differ
 
682
        self.old_label = old_label
 
683
        self.new_label = new_label
 
684
        self.path_encoding = path_encoding
 
685
 
 
686
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
 
687
        """Compare two files in unified diff format
 
688
 
 
689
        :param file_id: The file_id of the file to compare
 
690
        :param old_path: Path of the file in the old tree
 
691
        :param new_path: Path of the file in the new tree
 
692
        :param old_kind: Old file-kind of the file
 
693
        :param new_kind: New file-kind of the file
 
694
        """
 
695
        if 'file' not in (old_kind, new_kind):
 
696
            return self.CANNOT_DIFF
 
697
        from_file_id = to_file_id = file_id
 
698
        if old_kind == 'file':
 
699
            old_date = _patch_header_date(self.old_tree, file_id, old_path)
 
700
        elif old_kind is None:
 
701
            old_date = self.EPOCH_DATE
 
702
            from_file_id = None
 
703
        else:
 
704
            return self.CANNOT_DIFF
 
705
        if new_kind == 'file':
 
706
            new_date = _patch_header_date(self.new_tree, file_id, new_path)
 
707
        elif new_kind is None:
 
708
            new_date = self.EPOCH_DATE
 
709
            to_file_id = None
 
710
        else:
 
711
            return self.CANNOT_DIFF
 
712
        from_label = '%s%s\t%s' % (self.old_label, old_path, old_date)
 
713
        to_label = '%s%s\t%s' % (self.new_label, new_path, new_date)
 
714
        return self.diff_text(from_file_id, to_file_id, from_label, to_label)
 
715
 
 
716
    def diff_text(self, from_file_id, to_file_id, from_label, to_label):
 
717
        """Diff the content of given files in two trees
 
718
 
 
719
        :param from_file_id: The id of the file in the from tree.  If None,
 
720
            the file is not present in the from tree.
 
721
        :param to_file_id: The id of the file in the to tree.  This may refer
 
722
            to a different file from from_file_id.  If None,
 
723
            the file is not present in the to tree.
 
724
        """
 
725
        def _get_text(tree, file_id):
 
726
            if file_id is not None:
 
727
                return tree.get_file(file_id).readlines()
 
728
            else:
 
729
                return []
 
730
        try:
 
731
            from_text = _get_text(self.old_tree, from_file_id)
 
732
            to_text = _get_text(self.new_tree, to_file_id)
 
733
            self.text_differ(from_label, from_text, to_label, to_text,
 
734
                             self.to_file)
 
735
        except errors.BinaryFile:
 
736
            self.to_file.write(
 
737
                  ("Binary files %s and %s differ\n" %
 
738
                  (from_label, to_label)).encode(self.path_encoding))
 
739
        return self.CHANGED
 
740
 
 
741
 
 
742
class DiffTree(object):
 
743
    """Provides textual representations of the difference between two trees.
 
744
 
 
745
    A DiffTree examines two trees and where a file-id has altered
 
746
    between them, generates a textual representation of the difference.
 
747
    DiffTree uses a sequence of DiffPath objects which are each
 
748
    given the opportunity to handle a given altered fileid. The list
 
749
    of DiffPath objects can be extended globally by appending to
 
750
    DiffTree.diff_factories, or for a specific diff operation by
 
751
    supplying the extra_factories option to the appropriate method.
 
752
    """
 
753
 
 
754
    # list of factories that can provide instances of DiffPath objects
 
755
    # may be extended by plugins.
 
756
    diff_factories = [DiffSymlink.from_diff_tree,
 
757
                      DiffDirectory.from_diff_tree]
 
758
 
 
759
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
 
760
                 diff_text=None, extra_factories=None):
 
761
        """Constructor
 
762
 
 
763
        :param old_tree: Tree to show as old in the comparison
 
764
        :param new_tree: Tree to show as new in the comparison
 
765
        :param to_file: File to write comparision to
 
766
        :param path_encoding: Character encoding to write paths in
 
767
        :param diff_text: DiffPath-type object to use as a last resort for
 
768
            diffing text files.
 
769
        :param extra_factories: Factories of DiffPaths to try before any other
 
770
            DiffPaths"""
 
771
        if diff_text is None:
 
772
            diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
 
773
                                 '', '',  internal_diff)
 
774
        self.old_tree = old_tree
 
775
        self.new_tree = new_tree
 
776
        self.to_file = to_file
 
777
        self.path_encoding = path_encoding
 
778
        self.differs = []
 
779
        if extra_factories is not None:
 
780
            self.differs.extend(f(self) for f in extra_factories)
 
781
        self.differs.extend(f(self) for f in self.diff_factories)
 
782
        self.differs.extend([diff_text, DiffKindChange.from_diff_tree(self)])
 
783
 
 
784
    @classmethod
 
785
    def from_trees_options(klass, old_tree, new_tree, to_file,
 
786
                           path_encoding, external_diff_options, old_label,
 
787
                           new_label):
 
788
        """Factory for producing a DiffTree.
 
789
 
 
790
        Designed to accept options used by show_diff_trees.
 
791
        :param old_tree: The tree to show as old in the comparison
 
792
        :param new_tree: The tree to show as new in the comparison
 
793
        :param to_file: File to write comparisons to
 
794
        :param path_encoding: Character encoding to use for writing paths
 
795
        :param external_diff_options: If supplied, use the installed diff
 
796
            binary to perform file comparison, using supplied options.
 
797
        :param old_label: Prefix to use for old file labels
 
798
        :param new_label: Prefix to use for new file labels
 
799
        """
 
800
        if external_diff_options:
 
801
            assert isinstance(external_diff_options, basestring)
 
802
            opts = external_diff_options.split()
 
803
            def diff_file(olab, olines, nlab, nlines, to_file):
 
804
                external_diff(olab, olines, nlab, nlines, to_file, opts)
 
805
        else:
 
806
            diff_file = internal_diff
 
807
        diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
 
808
                             old_label, new_label, diff_file)
 
809
        return klass(old_tree, new_tree, to_file, path_encoding, diff_text)
 
810
 
 
811
    def show_diff(self, specific_files, extra_trees=None):
 
812
        """Write tree diff to self.to_file
 
813
 
 
814
        :param sepecific_files: the specific files to compare (recursive)
 
815
        :param extra_trees: extra trees to use for mapping paths to file_ids
 
816
        """
 
817
        # TODO: Generation of pseudo-diffs for added/deleted files could
 
818
        # be usefully made into a much faster special case.
 
819
 
 
820
        delta = self.new_tree.changes_from(self.old_tree,
 
821
            specific_files=specific_files,
 
822
            extra_trees=extra_trees, require_versioned=True)
 
823
 
 
824
        has_changes = 0
 
825
        for path, file_id, kind in delta.removed:
 
826
            has_changes = 1
 
827
            path_encoded = path.encode(self.path_encoding, "replace")
 
828
            self.to_file.write("=== removed %s '%s'\n" % (kind, path_encoded))
 
829
            self.diff(file_id, path, path)
 
830
 
 
831
        for path, file_id, kind in delta.added:
 
832
            has_changes = 1
 
833
            path_encoded = path.encode(self.path_encoding, "replace")
 
834
            self.to_file.write("=== added %s '%s'\n" % (kind, path_encoded))
 
835
            self.diff(file_id, path, path)
 
836
        for (old_path, new_path, file_id, kind,
 
837
             text_modified, meta_modified) in delta.renamed:
 
838
            has_changes = 1
 
839
            prop_str = get_prop_change(meta_modified)
 
840
            oldpath_encoded = old_path.encode(self.path_encoding, "replace")
 
841
            newpath_encoded = new_path.encode(self.path_encoding, "replace")
 
842
            self.to_file.write("=== renamed %s '%s' => '%s'%s\n" % (kind,
 
843
                                oldpath_encoded, newpath_encoded, prop_str))
 
844
            if text_modified:
 
845
                self.diff(file_id, old_path, new_path)
 
846
        for path, file_id, kind, text_modified, meta_modified in\
 
847
            delta.modified:
 
848
            has_changes = 1
 
849
            prop_str = get_prop_change(meta_modified)
 
850
            path_encoded = path.encode(self.path_encoding, "replace")
 
851
            self.to_file.write("=== modified %s '%s'%s\n" % (kind,
 
852
                                path_encoded, prop_str))
 
853
            # The file may be in a different location in the old tree (because
 
854
            # the containing dir was renamed, but the file itself was not)
 
855
            if text_modified:
 
856
                old_path = self.old_tree.id2path(file_id)
 
857
                self.diff(file_id, old_path, path)
 
858
        return has_changes
 
859
 
 
860
    def diff(self, file_id, old_path, new_path):
 
861
        """Perform a diff of a single file
 
862
 
 
863
        :param file_id: file-id of the file
 
864
        :param old_path: The path of the file in the old tree
 
865
        :param new_path: The path of the file in the new tree
 
866
        """
 
867
        try:
 
868
            old_kind = self.old_tree.kind(file_id)
 
869
        except errors.NoSuchId:
 
870
            old_kind = None
 
871
        try:
 
872
            new_kind = self.new_tree.kind(file_id)
 
873
        except errors.NoSuchId:
 
874
            new_kind = None
 
875
 
 
876
        result = DiffPath._diff_many(self.differs, file_id, old_path,
 
877
                                       new_path, old_kind, new_kind)
 
878
        if result is DiffPath.CANNOT_DIFF:
 
879
            error_path = new_path
 
880
            if error_path is None:
 
881
                error_path = old_path
 
882
            raise errors.NoDiffFound(error_path)