/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 breezy/diff.py

  • Committer: Breezy landing bot
  • Author(s): Jelmer Vernooij
  • Date: 2020-05-06 03:06:18 UTC
  • mfrom: (7500.1.2 trunk-merge-3.1)
  • Revision ID: breezy.the.bot@gmail.com-20200506030618-131sjbc876q7on66
Merge the 3.1 branch.

Merged from https://code.launchpad.net/~jelmer/brz/trunk-merge-3.1/+merge/383481

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/diff.py
1
 
# Copyright (C) 2004, 2005, 2006 Canonical Ltd.
2
 
 
 
1
# Copyright (C) 2005-2014 Canonical Ltd.
 
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
 
 
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
from bzrlib.delta import compare_trees
18
 
from bzrlib.errors import BzrError
19
 
import bzrlib.errors as errors
20
 
from bzrlib.symbol_versioning import *
21
 
from bzrlib.trace import mutter
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
import contextlib
 
18
import difflib
 
19
import os
 
20
import re
 
21
import sys
 
22
 
 
23
from .lazy_import import lazy_import
 
24
lazy_import(globals(), """
 
25
import errno
 
26
import patiencediff
 
27
import subprocess
 
28
import tempfile
 
29
 
 
30
from breezy import (
 
31
    controldir,
 
32
    osutils,
 
33
    textfile,
 
34
    timestamp,
 
35
    views,
 
36
    )
 
37
 
 
38
from breezy.workingtree import WorkingTree
 
39
from breezy.i18n import gettext
 
40
""")
 
41
 
 
42
from . import (
 
43
    errors,
 
44
    )
 
45
from .registry import (
 
46
    Registry,
 
47
    )
 
48
from .trace import mutter, note, warning
 
49
from .tree import FileTimestampUnavailable
 
50
 
 
51
 
 
52
DEFAULT_CONTEXT_AMOUNT = 3
 
53
 
22
54
 
23
55
# TODO: Rather than building a changeset object, we should probably
24
56
# invoke callbacks on an object.  That object can either accumulate a
25
57
# list, write them out directly, etc etc.
26
58
 
27
 
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file):
28
 
    import difflib
29
 
    
 
59
 
 
60
class _PrematchedMatcher(difflib.SequenceMatcher):
 
61
    """Allow SequenceMatcher operations to use predetermined blocks"""
 
62
 
 
63
    def __init__(self, matching_blocks):
 
64
        difflib.SequenceMatcher(self, None, None)
 
65
        self.matching_blocks = matching_blocks
 
66
        self.opcodes = None
 
67
 
 
68
 
 
69
def internal_diff(old_label, oldlines, new_label, newlines, to_file,
 
70
                  allow_binary=False, sequence_matcher=None,
 
71
                  path_encoding='utf8', context_lines=DEFAULT_CONTEXT_AMOUNT):
30
72
    # FIXME: difflib is wrong if there is no trailing newline.
31
73
    # The syntax used by patch seems to be "\ No newline at
32
74
    # end of file" following the last diff line from that
37
79
    # In the meantime we at least make sure the patch isn't
38
80
    # mangled.
39
81
 
40
 
 
41
 
    # Special workaround for Python2.3, where difflib fails if
42
 
    # both sequences are empty.
43
 
    if not oldlines and not newlines:
44
 
        return
45
 
 
46
 
    ud = difflib.unified_diff(oldlines, newlines,
47
 
                              fromfile=old_filename+'\t', 
48
 
                              tofile=new_filename+'\t')
 
82
    if allow_binary is False:
 
83
        textfile.check_text_lines(oldlines)
 
84
        textfile.check_text_lines(newlines)
 
85
 
 
86
    if sequence_matcher is None:
 
87
        sequence_matcher = patiencediff.PatienceSequenceMatcher
 
88
    ud = unified_diff_bytes(
 
89
        oldlines, newlines,
 
90
        fromfile=old_label.encode(path_encoding, 'replace'),
 
91
        tofile=new_label.encode(path_encoding, 'replace'),
 
92
        n=context_lines, sequencematcher=sequence_matcher)
49
93
 
50
94
    ud = list(ud)
 
95
    if len(ud) == 0:  # Identical contents, nothing to do
 
96
        return
51
97
    # work-around for difflib being too smart for its own good
52
98
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
53
99
    if not oldlines:
54
 
        ud[2] = ud[2].replace('-1,0', '-0,0')
 
100
        ud[2] = ud[2].replace(b'-1,0', b'-0,0')
55
101
    elif not newlines:
56
 
        ud[2] = ud[2].replace('+1,0', '+0,0')
57
 
    # work around for difflib emitting random spaces after the label
58
 
    ud[0] = ud[0][:-2] + '\n'
59
 
    ud[1] = ud[1][:-2] + '\n'
 
102
        ud[2] = ud[2].replace(b'+1,0', b'+0,0')
60
103
 
61
104
    for line in ud:
62
105
        to_file.write(line)
63
 
        if not line.endswith('\n'):
64
 
            to_file.write("\n\\ No newline at end of file\n")
65
 
    print >>to_file
66
 
 
67
 
 
68
 
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
 
106
        if not line.endswith(b'\n'):
 
107
            to_file.write(b"\n\\ No newline at end of file\n")
 
108
    to_file.write(b'\n')
 
109
 
 
110
 
 
111
def unified_diff_bytes(a, b, fromfile=b'', tofile=b'', fromfiledate=b'',
 
112
                       tofiledate=b'', n=3, lineterm=b'\n', sequencematcher=None):
 
113
    r"""
 
114
    Compare two sequences of lines; generate the delta as a unified diff.
 
115
 
 
116
    Unified diffs are a compact way of showing line changes and a few
 
117
    lines of context.  The number of context lines is set by 'n' which
 
118
    defaults to three.
 
119
 
 
120
    By default, the diff control lines (those with ---, +++, or @@) are
 
121
    created with a trailing newline.  This is helpful so that inputs
 
122
    created from file.readlines() result in diffs that are suitable for
 
123
    file.writelines() since both the inputs and outputs have trailing
 
124
    newlines.
 
125
 
 
126
    For inputs that do not have trailing newlines, set the lineterm
 
127
    argument to "" so that the output will be uniformly newline free.
 
128
 
 
129
    The unidiff format normally has a header for filenames and modification
 
130
    times.  Any or all of these may be specified using strings for
 
131
    'fromfile', 'tofile', 'fromfiledate', and 'tofiledate'.  The modification
 
132
    times are normally expressed in the format returned by time.ctime().
 
133
 
 
134
    Example:
 
135
 
 
136
    >>> for line in bytes_unified_diff(b'one two three four'.split(),
 
137
    ...             b'zero one tree four'.split(), b'Original', b'Current',
 
138
    ...             b'Sat Jan 26 23:30:50 1991', b'Fri Jun 06 10:20:52 2003',
 
139
    ...             lineterm=b''):
 
140
    ...     print line
 
141
    --- Original Sat Jan 26 23:30:50 1991
 
142
    +++ Current Fri Jun 06 10:20:52 2003
 
143
    @@ -1,4 +1,4 @@
 
144
    +zero
 
145
     one
 
146
    -two
 
147
    -three
 
148
    +tree
 
149
     four
 
150
    """
 
151
    if sequencematcher is None:
 
152
        sequencematcher = difflib.SequenceMatcher
 
153
 
 
154
    if fromfiledate:
 
155
        fromfiledate = b'\t' + bytes(fromfiledate)
 
156
    if tofiledate:
 
157
        tofiledate = b'\t' + bytes(tofiledate)
 
158
 
 
159
    started = False
 
160
    for group in sequencematcher(None, a, b).get_grouped_opcodes(n):
 
161
        if not started:
 
162
            yield b'--- %s%s%s' % (fromfile, fromfiledate, lineterm)
 
163
            yield b'+++ %s%s%s' % (tofile, tofiledate, lineterm)
 
164
            started = True
 
165
        i1, i2, j1, j2 = group[0][1], group[-1][2], group[0][3], group[-1][4]
 
166
        yield b"@@ -%d,%d +%d,%d @@%s" % (i1 + 1, i2 - i1, j1 + 1, j2 - j1, lineterm)
 
167
        for tag, i1, i2, j1, j2 in group:
 
168
            if tag == 'equal':
 
169
                for line in a[i1:i2]:
 
170
                    yield b' ' + line
 
171
                continue
 
172
            if tag == 'replace' or tag == 'delete':
 
173
                for line in a[i1:i2]:
 
174
                    yield b'-' + line
 
175
            if tag == 'replace' or tag == 'insert':
 
176
                for line in b[j1:j2]:
 
177
                    yield b'+' + line
 
178
 
 
179
 
 
180
def _spawn_external_diff(diffcmd, capture_errors=True):
 
181
    """Spawn the external diff process, and return the child handle.
 
182
 
 
183
    :param diffcmd: The command list to spawn
 
184
    :param capture_errors: Capture stderr as well as setting LANG=C
 
185
        and LC_ALL=C. This lets us read and understand the output of diff,
 
186
        and respond to any errors.
 
187
    :return: A Popen object.
 
188
    """
 
189
    if capture_errors:
 
190
        # construct minimal environment
 
191
        env = {}
 
192
        path = os.environ.get('PATH')
 
193
        if path is not None:
 
194
            env['PATH'] = path
 
195
        env['LANGUAGE'] = 'C'   # on win32 only LANGUAGE has effect
 
196
        env['LANG'] = 'C'
 
197
        env['LC_ALL'] = 'C'
 
198
        stderr = subprocess.PIPE
 
199
    else:
 
200
        env = None
 
201
        stderr = None
 
202
 
 
203
    try:
 
204
        pipe = subprocess.Popen(diffcmd,
 
205
                                stdin=subprocess.PIPE,
 
206
                                stdout=subprocess.PIPE,
 
207
                                stderr=stderr,
 
208
                                env=env)
 
209
    except OSError as e:
 
210
        if e.errno == errno.ENOENT:
 
211
            raise errors.NoDiff(str(e))
 
212
        raise
 
213
 
 
214
    return pipe
 
215
 
 
216
 
 
217
# diff style options as of GNU diff v3.2
 
218
style_option_list = ['-c', '-C', '--context',
 
219
                     '-e', '--ed',
 
220
                     '-f', '--forward-ed',
 
221
                     '-q', '--brief',
 
222
                     '--normal',
 
223
                     '-n', '--rcs',
 
224
                     '-u', '-U', '--unified',
 
225
                     '-y', '--side-by-side',
 
226
                     '-D', '--ifdef']
 
227
 
 
228
 
 
229
def default_style_unified(diff_opts):
 
230
    """Default to unified diff style if alternative not specified in diff_opts.
 
231
 
 
232
        diff only allows one style to be specified; they don't override.
 
233
        Note that some of these take optargs, and the optargs can be
 
234
        directly appended to the options.
 
235
        This is only an approximate parser; it doesn't properly understand
 
236
        the grammar.
 
237
 
 
238
    :param diff_opts: List of options for external (GNU) diff.
 
239
    :return: List of options with default style=='unified'.
 
240
    """
 
241
    for s in style_option_list:
 
242
        for j in diff_opts:
 
243
            if j.startswith(s):
 
244
                break
 
245
        else:
 
246
            continue
 
247
        break
 
248
    else:
 
249
        diff_opts.append('-u')
 
250
    return diff_opts
 
251
 
 
252
 
 
253
def external_diff(old_label, oldlines, new_label, newlines, to_file,
69
254
                  diff_opts):
70
255
    """Display a diff by calling out to the external diff program."""
71
 
    import sys
72
 
    
73
 
    if to_file != sys.stdout:
74
 
        raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
75
 
                                  to_file)
76
 
 
77
256
    # make sure our own output is properly ordered before the diff
78
257
    to_file.flush()
79
258
 
80
 
    from tempfile import NamedTemporaryFile
81
 
    import os
82
 
 
83
 
    oldtmpf = NamedTemporaryFile()
84
 
    newtmpf = NamedTemporaryFile()
 
259
    oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='brz-diff-old-')
 
260
    newtmp_fd, new_abspath = tempfile.mkstemp(prefix='brz-diff-new-')
 
261
    oldtmpf = os.fdopen(oldtmp_fd, 'wb')
 
262
    newtmpf = os.fdopen(newtmp_fd, 'wb')
85
263
 
86
264
    try:
87
265
        # TODO: perhaps a special case for comparing to or from the empty
94
272
        oldtmpf.writelines(oldlines)
95
273
        newtmpf.writelines(newlines)
96
274
 
97
 
        oldtmpf.flush()
98
 
        newtmpf.flush()
 
275
        oldtmpf.close()
 
276
        newtmpf.close()
99
277
 
100
278
        if not diff_opts:
101
279
            diff_opts = []
 
280
        if sys.platform == 'win32':
 
281
            # Popen doesn't do the proper encoding for external commands
 
282
            # Since we are dealing with an ANSI api, use mbcs encoding
 
283
            old_label = old_label.encode('mbcs')
 
284
            new_label = new_label.encode('mbcs')
102
285
        diffcmd = ['diff',
103
 
                   '--label', old_filename+'\t',
104
 
                   oldtmpf.name,
105
 
                   '--label', new_filename+'\t',
106
 
                   newtmpf.name]
107
 
 
108
 
        # diff only allows one style to be specified; they don't override.
109
 
        # note that some of these take optargs, and the optargs can be
110
 
        # directly appended to the options.
111
 
        # this is only an approximate parser; it doesn't properly understand
112
 
        # the grammar.
113
 
        for s in ['-c', '-u', '-C', '-U',
114
 
                  '-e', '--ed',
115
 
                  '-q', '--brief',
116
 
                  '--normal',
117
 
                  '-n', '--rcs',
118
 
                  '-y', '--side-by-side',
119
 
                  '-D', '--ifdef']:
120
 
            for j in diff_opts:
121
 
                if j.startswith(s):
122
 
                    break
123
 
            else:
124
 
                continue
125
 
            break
126
 
        else:
127
 
            diffcmd.append('-u')
128
 
                  
 
286
                   '--label', old_label,
 
287
                   old_abspath,
 
288
                   '--label', new_label,
 
289
                   new_abspath,
 
290
                   '--binary',
 
291
                   ]
 
292
 
 
293
        diff_opts = default_style_unified(diff_opts)
 
294
 
129
295
        if diff_opts:
130
296
            diffcmd.extend(diff_opts)
131
297
 
132
 
        rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
133
 
        
134
 
        if rc != 0 and rc != 1:
 
298
        pipe = _spawn_external_diff(diffcmd, capture_errors=True)
 
299
        out, err = pipe.communicate()
 
300
        rc = pipe.returncode
 
301
 
 
302
        # internal_diff() adds a trailing newline, add one here for consistency
 
303
        out += b'\n'
 
304
        if rc == 2:
 
305
            # 'diff' gives retcode == 2 for all sorts of errors
 
306
            # one of those is 'Binary files differ'.
 
307
            # Bad options could also be the problem.
 
308
            # 'Binary files' is not a real error, so we suppress that error.
 
309
            lang_c_out = out
 
310
 
 
311
            # Since we got here, we want to make sure to give an i18n error
 
312
            pipe = _spawn_external_diff(diffcmd, capture_errors=False)
 
313
            out, err = pipe.communicate()
 
314
 
 
315
            # Write out the new i18n diff response
 
316
            to_file.write(out + b'\n')
 
317
            if pipe.returncode != 2:
 
318
                raise errors.BzrError(
 
319
                    'external diff failed with exit code 2'
 
320
                    ' when run with LANG=C and LC_ALL=C,'
 
321
                    ' but not when run natively: %r' % (diffcmd,))
 
322
 
 
323
            first_line = lang_c_out.split(b'\n', 1)[0]
 
324
            # Starting with diffutils 2.8.4 the word "binary" was dropped.
 
325
            m = re.match(b'^(binary )?files.*differ$', first_line, re.I)
 
326
            if m is None:
 
327
                raise errors.BzrError('external diff failed with exit code 2;'
 
328
                                      ' command: %r' % (diffcmd,))
 
329
            else:
 
330
                # Binary files differ, just return
 
331
                return
 
332
 
 
333
        # If we got to here, we haven't written out the output of diff
 
334
        # do so now
 
335
        to_file.write(out)
 
336
        if rc not in (0, 1):
135
337
            # returns 1 if files differ; that's OK
136
338
            if rc < 0:
137
339
                msg = 'signal %d' % (-rc)
138
340
            else:
139
341
                msg = 'exit code %d' % rc
140
 
                
141
 
            raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
 
342
 
 
343
            raise errors.BzrError('external diff failed with %s; command: %r'
 
344
                                  % (msg, diffcmd))
 
345
 
142
346
    finally:
143
347
        oldtmpf.close()                 # and delete
144
348
        newtmpf.close()
145
349
 
146
 
 
147
 
@deprecated_function(zero_eight)
148
 
def show_diff(b, from_spec, specific_files, external_diff_options=None,
149
 
              revision2=None, output=None, b2=None):
150
 
    """Shortcut for showing the diff to the working tree.
151
 
 
152
 
    Please use show_diff_trees instead.
153
 
 
154
 
    b
155
 
        Branch.
156
 
 
157
 
    revision
158
 
        None for 'basis tree', or otherwise the old revision to compare against.
159
 
    
160
 
    The more general form is show_diff_trees(), where the caller
161
 
    supplies any two trees.
 
350
        def cleanup(path):
 
351
            # Warn in case the file couldn't be deleted (in case windows still
 
352
            # holds the file open, but not if the files have already been
 
353
            # deleted)
 
354
            try:
 
355
                os.remove(path)
 
356
            except OSError as e:
 
357
                if e.errno not in (errno.ENOENT,):
 
358
                    warning('Failed to delete temporary file: %s %s', path, e)
 
359
 
 
360
        cleanup(old_abspath)
 
361
        cleanup(new_abspath)
 
362
 
 
363
 
 
364
def get_trees_and_branches_to_diff_locked(
 
365
        path_list, revision_specs, old_url, new_url, exit_stack, apply_view=True):
 
366
    """Get the trees and specific files to diff given a list of paths.
 
367
 
 
368
    This method works out the trees to be diff'ed and the files of
 
369
    interest within those trees.
 
370
 
 
371
    :param path_list:
 
372
        the list of arguments passed to the diff command
 
373
    :param revision_specs:
 
374
        Zero, one or two RevisionSpecs from the diff command line,
 
375
        saying what revisions to compare.
 
376
    :param old_url:
 
377
        The url of the old branch or tree. If None, the tree to use is
 
378
        taken from the first path, if any, or the current working tree.
 
379
    :param new_url:
 
380
        The url of the new branch or tree. If None, the tree to use is
 
381
        taken from the first path, if any, or the current working tree.
 
382
    :param exit_stack:
 
383
        an ExitStack object. get_trees_and_branches_to_diff
 
384
        will register cleanups that must be run to unlock the trees, etc.
 
385
    :param apply_view:
 
386
        if True and a view is set, apply the view or check that the paths
 
387
        are within it
 
388
    :returns:
 
389
        a tuple of (old_tree, new_tree, old_branch, new_branch,
 
390
        specific_files, extra_trees) where extra_trees is a sequence of
 
391
        additional trees to search in for file-ids.  The trees and branches
 
392
        will be read-locked until the cleanups registered via the exit_stack
 
393
        param are run.
162
394
    """
163
 
    if output is None:
164
 
        import sys
165
 
        output = sys.stdout
 
395
    # Get the old and new revision specs
 
396
    old_revision_spec = None
 
397
    new_revision_spec = None
 
398
    if revision_specs is not None:
 
399
        if len(revision_specs) > 0:
 
400
            old_revision_spec = revision_specs[0]
 
401
            if old_url is None:
 
402
                old_url = old_revision_spec.get_branch()
 
403
        if len(revision_specs) > 1:
 
404
            new_revision_spec = revision_specs[1]
 
405
            if new_url is None:
 
406
                new_url = new_revision_spec.get_branch()
166
407
 
167
 
    if from_spec is None:
168
 
        old_tree = b.bzrdir.open_workingtree()
169
 
        if b2 is None:
170
 
            old_tree = old_tree = old_tree.basis_tree()
 
408
    other_paths = []
 
409
    make_paths_wt_relative = True
 
410
    consider_relpath = True
 
411
    if path_list is None or len(path_list) == 0:
 
412
        # If no path is given, the current working tree is used
 
413
        default_location = u'.'
 
414
        consider_relpath = False
 
415
    elif old_url is not None and new_url is not None:
 
416
        other_paths = path_list
 
417
        make_paths_wt_relative = False
171
418
    else:
172
 
        old_tree = b.repository.revision_tree(from_spec.in_history(b).rev_id)
173
 
 
174
 
    if revision2 is None:
175
 
        if b2 is None:
176
 
            new_tree = b.bzrdir.open_workingtree()
 
419
        default_location = path_list[0]
 
420
        other_paths = path_list[1:]
 
421
 
 
422
    def lock_tree_or_branch(wt, br):
 
423
        if wt is not None:
 
424
            exit_stack.enter_context(wt.lock_read())
 
425
        elif br is not None:
 
426
            exit_stack.enter_context(br.lock_read())
 
427
 
 
428
    # Get the old location
 
429
    specific_files = []
 
430
    if old_url is None:
 
431
        old_url = default_location
 
432
    working_tree, branch, relpath = \
 
433
        controldir.ControlDir.open_containing_tree_or_branch(old_url)
 
434
    lock_tree_or_branch(working_tree, branch)
 
435
    if consider_relpath and relpath != '':
 
436
        if working_tree is not None and apply_view:
 
437
            views.check_path_in_view(working_tree, relpath)
 
438
        specific_files.append(relpath)
 
439
    old_tree = _get_tree_to_diff(old_revision_spec, working_tree, branch)
 
440
    old_branch = branch
 
441
 
 
442
    # Get the new location
 
443
    if new_url is None:
 
444
        new_url = default_location
 
445
    if new_url != old_url:
 
446
        working_tree, branch, relpath = \
 
447
            controldir.ControlDir.open_containing_tree_or_branch(new_url)
 
448
        lock_tree_or_branch(working_tree, branch)
 
449
        if consider_relpath and relpath != '':
 
450
            if working_tree is not None and apply_view:
 
451
                views.check_path_in_view(working_tree, relpath)
 
452
            specific_files.append(relpath)
 
453
    new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
 
454
                                 basis_is_default=working_tree is None)
 
455
    new_branch = branch
 
456
 
 
457
    # Get the specific files (all files is None, no files is [])
 
458
    if make_paths_wt_relative and working_tree is not None:
 
459
        other_paths = working_tree.safe_relpath_files(
 
460
            other_paths,
 
461
            apply_view=apply_view)
 
462
    specific_files.extend(other_paths)
 
463
    if len(specific_files) == 0:
 
464
        specific_files = None
 
465
        if (working_tree is not None and working_tree.supports_views() and
 
466
                apply_view):
 
467
            view_files = working_tree.views.lookup_view()
 
468
            if view_files:
 
469
                specific_files = view_files
 
470
                view_str = views.view_display_str(view_files)
 
471
                note(gettext("*** Ignoring files outside view. View is %s") % view_str)
 
472
 
 
473
    # Get extra trees that ought to be searched for file-ids
 
474
    extra_trees = None
 
475
    if working_tree is not None and working_tree not in (old_tree, new_tree):
 
476
        extra_trees = (working_tree,)
 
477
    return (old_tree, new_tree, old_branch, new_branch,
 
478
            specific_files, extra_trees)
 
479
 
 
480
 
 
481
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
 
482
    if branch is None and tree is not None:
 
483
        branch = tree.branch
 
484
    if spec is None or spec.spec is None:
 
485
        if basis_is_default:
 
486
            if tree is not None:
 
487
                return tree.basis_tree()
 
488
            else:
 
489
                return branch.basis_tree()
177
490
        else:
178
 
            new_tree = b2.bzrdir.open_workingtree()
179
 
    else:
180
 
        new_tree = b.repository.revision_tree(revision2.in_history(b).rev_id)
181
 
 
182
 
    return show_diff_trees(old_tree, new_tree, output, specific_files,
183
 
                           external_diff_options)
184
 
 
185
 
 
186
 
def diff_cmd_helper(tree, specific_files, external_diff_options, 
187
 
                    old_revision_spec=None, new_revision_spec=None):
188
 
    """Helper for cmd_diff.
189
 
 
190
 
   tree 
191
 
        A WorkingTree
192
 
 
193
 
    specific_files
194
 
        The specific files to compare, or None
195
 
 
196
 
    external_diff_options
197
 
        If non-None, run an external diff, and pass it these options
198
 
 
199
 
    old_revision_spec
200
 
        If None, use basis tree as old revision, otherwise use the tree for
201
 
        the specified revision. 
202
 
 
203
 
    new_revision_spec
204
 
        If None, use working tree as new revision, otherwise use the tree for
205
 
        the specified revision.
206
 
    
207
 
    The more general form is show_diff_trees(), where the caller
208
 
    supplies any two trees.
209
 
    """
210
 
    import sys
211
 
    output = sys.stdout
212
 
    def spec_tree(spec):
213
 
        revision_id = spec.in_store(tree.branch).rev_id
214
 
        return tree.branch.repository.revision_tree(revision_id)
215
 
    if old_revision_spec is None:
216
 
        old_tree = tree.basis_tree()
217
 
    else:
218
 
        old_tree = spec_tree(old_revision_spec)
219
 
 
220
 
    if new_revision_spec is None:
221
 
        new_tree = tree
222
 
    else:
223
 
        new_tree = spec_tree(new_revision_spec)
224
 
 
225
 
    return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
226
 
                           external_diff_options)
 
491
            return tree
 
492
    return spec.as_tree(branch)
227
493
 
228
494
 
229
495
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
230
 
                    external_diff_options=None):
 
496
                    external_diff_options=None,
 
497
                    old_label='a/', new_label='b/',
 
498
                    extra_trees=None,
 
499
                    path_encoding='utf8',
 
500
                    using=None,
 
501
                    format_cls=None,
 
502
                    context=DEFAULT_CONTEXT_AMOUNT):
231
503
    """Show in text form the changes from one tree to another.
232
504
 
233
 
    to_files
234
 
        If set, include only changes to these files.
235
 
 
236
 
    external_diff_options
237
 
        If set, use an external GNU diff and pass these options.
 
505
    :param to_file: The output stream.
 
506
    :param specific_files: Include only changes to these files - None for all
 
507
        changes.
 
508
    :param external_diff_options: If set, use an external GNU diff and pass
 
509
        these options.
 
510
    :param extra_trees: If set, more Trees to use for looking up file ids
 
511
    :param path_encoding: If set, the path will be encoded as specified,
 
512
        otherwise is supposed to be utf8
 
513
    :param format_cls: Formatter class (DiffTree subclass)
238
514
    """
239
 
    old_tree.lock_read()
 
515
    if context is None:
 
516
        context = DEFAULT_CONTEXT_AMOUNT
 
517
    if format_cls is None:
 
518
        format_cls = DiffTree
 
519
    with contextlib.ExitStack() as exit_stack:
 
520
        exit_stack.enter_context(old_tree.lock_read())
 
521
        if extra_trees is not None:
 
522
            for tree in extra_trees:
 
523
                exit_stack.enter_context(tree.lock_read())
 
524
        exit_stack.enter_context(new_tree.lock_read())
 
525
        differ = format_cls.from_trees_options(old_tree, new_tree, to_file,
 
526
                                               path_encoding,
 
527
                                               external_diff_options,
 
528
                                               old_label, new_label, using,
 
529
                                               context_lines=context)
 
530
        return differ.show_diff(specific_files, extra_trees)
 
531
 
 
532
 
 
533
def _patch_header_date(tree, path):
 
534
    """Returns a timestamp suitable for use in a patch header."""
240
535
    try:
241
 
        new_tree.lock_read()
242
 
        try:
243
 
            return _show_diff_trees(old_tree, new_tree, to_file,
244
 
                                    specific_files, external_diff_options)
 
536
        mtime = tree.get_file_mtime(path)
 
537
    except FileTimestampUnavailable:
 
538
        mtime = 0
 
539
    return timestamp.format_patch_date(mtime)
 
540
 
 
541
 
 
542
def get_executable_change(old_is_x, new_is_x):
 
543
    descr = {True: b"+x", False: b"-x", None: b"??"}
 
544
    if old_is_x != new_is_x:
 
545
        return [b"%s to %s" % (descr[old_is_x], descr[new_is_x],)]
 
546
    else:
 
547
        return []
 
548
 
 
549
 
 
550
class DiffPath(object):
 
551
    """Base type for command object that compare files"""
 
552
 
 
553
    # The type or contents of the file were unsuitable for diffing
 
554
    CANNOT_DIFF = 'CANNOT_DIFF'
 
555
    # The file has changed in a semantic way
 
556
    CHANGED = 'CHANGED'
 
557
    # The file content may have changed, but there is no semantic change
 
558
    UNCHANGED = 'UNCHANGED'
 
559
 
 
560
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8'):
 
561
        """Constructor.
 
562
 
 
563
        :param old_tree: The tree to show as the old tree in the comparison
 
564
        :param new_tree: The tree to show as new in the comparison
 
565
        :param to_file: The file to write comparison data to
 
566
        :param path_encoding: The character encoding to write paths in
 
567
        """
 
568
        self.old_tree = old_tree
 
569
        self.new_tree = new_tree
 
570
        self.to_file = to_file
 
571
        self.path_encoding = path_encoding
 
572
 
 
573
    def finish(self):
 
574
        pass
 
575
 
 
576
    @classmethod
 
577
    def from_diff_tree(klass, diff_tree):
 
578
        return klass(diff_tree.old_tree, diff_tree.new_tree,
 
579
                     diff_tree.to_file, diff_tree.path_encoding)
 
580
 
 
581
    @staticmethod
 
582
    def _diff_many(differs, old_path, new_path, old_kind, new_kind):
 
583
        for file_differ in differs:
 
584
            result = file_differ.diff(old_path, new_path, old_kind, new_kind)
 
585
            if result is not DiffPath.CANNOT_DIFF:
 
586
                return result
 
587
        else:
 
588
            return DiffPath.CANNOT_DIFF
 
589
 
 
590
 
 
591
class DiffKindChange(object):
 
592
    """Special differ for file kind changes.
 
593
 
 
594
    Represents kind change as deletion + creation.  Uses the other differs
 
595
    to do this.
 
596
    """
 
597
 
 
598
    def __init__(self, differs):
 
599
        self.differs = differs
 
600
 
 
601
    def finish(self):
 
602
        pass
 
603
 
 
604
    @classmethod
 
605
    def from_diff_tree(klass, diff_tree):
 
606
        return klass(diff_tree.differs)
 
607
 
 
608
    def diff(self, old_path, new_path, old_kind, new_kind):
 
609
        """Perform comparison
 
610
 
 
611
        :param old_path: Path of the file in the old tree
 
612
        :param new_path: Path of the file in the new tree
 
613
        :param old_kind: Old file-kind of the file
 
614
        :param new_kind: New file-kind of the file
 
615
        """
 
616
        if None in (old_kind, new_kind):
 
617
            return DiffPath.CANNOT_DIFF
 
618
        result = DiffPath._diff_many(
 
619
            self.differs, old_path, new_path, old_kind, None)
 
620
        if result is DiffPath.CANNOT_DIFF:
 
621
            return result
 
622
        return DiffPath._diff_many(
 
623
            self.differs, old_path, new_path, None, new_kind)
 
624
 
 
625
 
 
626
class DiffTreeReference(DiffPath):
 
627
 
 
628
    def diff(self, old_path, new_path, old_kind, new_kind):
 
629
        """Perform comparison between two tree references.  (dummy)
 
630
 
 
631
        """
 
632
        if 'tree-reference' not in (old_kind, new_kind):
 
633
            return self.CANNOT_DIFF
 
634
        if old_kind not in ('tree-reference', None):
 
635
            return self.CANNOT_DIFF
 
636
        if new_kind not in ('tree-reference', None):
 
637
            return self.CANNOT_DIFF
 
638
        return self.CHANGED
 
639
 
 
640
 
 
641
class DiffDirectory(DiffPath):
 
642
 
 
643
    def diff(self, old_path, new_path, old_kind, new_kind):
 
644
        """Perform comparison between two directories.  (dummy)
 
645
 
 
646
        """
 
647
        if 'directory' not in (old_kind, new_kind):
 
648
            return self.CANNOT_DIFF
 
649
        if old_kind not in ('directory', None):
 
650
            return self.CANNOT_DIFF
 
651
        if new_kind not in ('directory', None):
 
652
            return self.CANNOT_DIFF
 
653
        return self.CHANGED
 
654
 
 
655
 
 
656
class DiffSymlink(DiffPath):
 
657
 
 
658
    def diff(self, old_path, new_path, old_kind, new_kind):
 
659
        """Perform comparison between two symlinks
 
660
 
 
661
        :param old_path: Path of the file in the old tree
 
662
        :param new_path: Path of the file in the new tree
 
663
        :param old_kind: Old file-kind of the file
 
664
        :param new_kind: New file-kind of the file
 
665
        """
 
666
        if 'symlink' not in (old_kind, new_kind):
 
667
            return self.CANNOT_DIFF
 
668
        if old_kind == 'symlink':
 
669
            old_target = self.old_tree.get_symlink_target(old_path)
 
670
        elif old_kind is None:
 
671
            old_target = None
 
672
        else:
 
673
            return self.CANNOT_DIFF
 
674
        if new_kind == 'symlink':
 
675
            new_target = self.new_tree.get_symlink_target(new_path)
 
676
        elif new_kind is None:
 
677
            new_target = None
 
678
        else:
 
679
            return self.CANNOT_DIFF
 
680
        return self.diff_symlink(old_target, new_target)
 
681
 
 
682
    def diff_symlink(self, old_target, new_target):
 
683
        if old_target is None:
 
684
            self.to_file.write(b'=== target is \'%s\'\n' %
 
685
                               new_target.encode(self.path_encoding, 'replace'))
 
686
        elif new_target is None:
 
687
            self.to_file.write(b'=== target was \'%s\'\n' %
 
688
                               old_target.encode(self.path_encoding, 'replace'))
 
689
        else:
 
690
            self.to_file.write(b'=== target changed \'%s\' => \'%s\'\n' %
 
691
                               (old_target.encode(self.path_encoding, 'replace'),
 
692
                                new_target.encode(self.path_encoding, 'replace')))
 
693
        return self.CHANGED
 
694
 
 
695
 
 
696
class DiffText(DiffPath):
 
697
 
 
698
    # GNU Patch uses the epoch date to detect files that are being added
 
699
    # or removed in a diff.
 
700
    EPOCH_DATE = '1970-01-01 00:00:00 +0000'
 
701
 
 
702
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
 
703
                 old_label='', new_label='', text_differ=internal_diff,
 
704
                 context_lines=DEFAULT_CONTEXT_AMOUNT):
 
705
        DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
 
706
        self.text_differ = text_differ
 
707
        self.old_label = old_label
 
708
        self.new_label = new_label
 
709
        self.path_encoding = path_encoding
 
710
        self.context_lines = context_lines
 
711
 
 
712
    def diff(self, old_path, new_path, old_kind, new_kind):
 
713
        """Compare two files in unified diff format
 
714
 
 
715
        :param old_path: Path of the file in the old tree
 
716
        :param new_path: Path of the file in the new tree
 
717
        :param old_kind: Old file-kind of the file
 
718
        :param new_kind: New file-kind of the file
 
719
        """
 
720
        if 'file' not in (old_kind, new_kind):
 
721
            return self.CANNOT_DIFF
 
722
        if old_kind == 'file':
 
723
            old_date = _patch_header_date(self.old_tree, old_path)
 
724
        elif old_kind is None:
 
725
            old_date = self.EPOCH_DATE
 
726
        else:
 
727
            return self.CANNOT_DIFF
 
728
        if new_kind == 'file':
 
729
            new_date = _patch_header_date(self.new_tree, new_path)
 
730
        elif new_kind is None:
 
731
            new_date = self.EPOCH_DATE
 
732
        else:
 
733
            return self.CANNOT_DIFF
 
734
        from_label = '%s%s\t%s' % (self.old_label, old_path,
 
735
                                   old_date)
 
736
        to_label = '%s%s\t%s' % (self.new_label, new_path,
 
737
                                 new_date)
 
738
        return self.diff_text(old_path, new_path, from_label, to_label)
 
739
 
 
740
    def diff_text(self, from_path, to_path, from_label, to_label):
 
741
        """Diff the content of given files in two trees
 
742
 
 
743
        :param from_path: The path in the from tree. If None,
 
744
            the file is not present in the from tree.
 
745
        :param to_path: The path in the to tree. This may refer
 
746
            to a different file from from_path.  If None,
 
747
            the file is not present in the to tree.
 
748
        """
 
749
        def _get_text(tree, path):
 
750
            if path is None:
 
751
                return []
 
752
            try:
 
753
                return tree.get_file_lines(path)
 
754
            except errors.NoSuchFile:
 
755
                return []
 
756
        try:
 
757
            from_text = _get_text(self.old_tree, from_path)
 
758
            to_text = _get_text(self.new_tree, to_path)
 
759
            self.text_differ(from_label, from_text, to_label, to_text,
 
760
                             self.to_file, path_encoding=self.path_encoding,
 
761
                             context_lines=self.context_lines)
 
762
        except errors.BinaryFile:
 
763
            self.to_file.write(
 
764
                ("Binary files %s%s and %s%s differ\n" %
 
765
                 (self.old_label, from_path, self.new_label, to_path)).encode(self.path_encoding, 'replace'))
 
766
        return self.CHANGED
 
767
 
 
768
 
 
769
class DiffFromTool(DiffPath):
 
770
 
 
771
    def __init__(self, command_template, old_tree, new_tree, to_file,
 
772
                 path_encoding='utf-8'):
 
773
        DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
 
774
        self.command_template = command_template
 
775
        self._root = osutils.mkdtemp(prefix='brz-diff-')
 
776
 
 
777
    @classmethod
 
778
    def from_string(klass, command_template, old_tree, new_tree, to_file,
 
779
                    path_encoding='utf-8'):
 
780
        return klass(command_template, old_tree, new_tree, to_file,
 
781
                     path_encoding)
 
782
 
 
783
    @classmethod
 
784
    def make_from_diff_tree(klass, command_string, external_diff_options=None):
 
785
        def from_diff_tree(diff_tree):
 
786
            full_command_string = [command_string]
 
787
            if external_diff_options is not None:
 
788
                full_command_string += ' ' + external_diff_options
 
789
            return klass.from_string(full_command_string, diff_tree.old_tree,
 
790
                                     diff_tree.new_tree, diff_tree.to_file)
 
791
        return from_diff_tree
 
792
 
 
793
    def _get_command(self, old_path, new_path):
 
794
        my_map = {'old_path': old_path, 'new_path': new_path}
 
795
        command = [t.format(**my_map) for t in
 
796
                   self.command_template]
 
797
        if command == self.command_template:
 
798
            command += [old_path, new_path]
 
799
        if sys.platform == 'win32':  # Popen doesn't accept unicode on win32
 
800
            command_encoded = []
 
801
            for c in command:
 
802
                if isinstance(c, str):
 
803
                    command_encoded.append(c.encode('mbcs'))
 
804
                else:
 
805
                    command_encoded.append(c)
 
806
            return command_encoded
 
807
        else:
 
808
            return command
 
809
 
 
810
    def _execute(self, old_path, new_path):
 
811
        command = self._get_command(old_path, new_path)
 
812
        try:
 
813
            proc = subprocess.Popen(command, stdout=subprocess.PIPE,
 
814
                                    cwd=self._root)
 
815
        except OSError as e:
 
816
            if e.errno == errno.ENOENT:
 
817
                raise errors.ExecutableMissing(command[0])
 
818
            else:
 
819
                raise
 
820
        self.to_file.write(proc.stdout.read())
 
821
        proc.stdout.close()
 
822
        return proc.wait()
 
823
 
 
824
    def _try_symlink_root(self, tree, prefix):
 
825
        if (getattr(tree, 'abspath', None) is None or
 
826
                not osutils.host_os_dereferences_symlinks()):
 
827
            return False
 
828
        try:
 
829
            os.symlink(tree.abspath(''), osutils.pathjoin(self._root, prefix))
 
830
        except OSError as e:
 
831
            if e.errno != errno.EEXIST:
 
832
                raise
 
833
        return True
 
834
 
 
835
    @staticmethod
 
836
    def _fenc():
 
837
        """Returns safe encoding for passing file path to diff tool"""
 
838
        if sys.platform == 'win32':
 
839
            return 'mbcs'
 
840
        else:
 
841
            # Don't fallback to 'utf-8' because subprocess may not be able to
 
842
            # handle utf-8 correctly when locale is not utf-8.
 
843
            return sys.getfilesystemencoding() or 'ascii'
 
844
 
 
845
    def _is_safepath(self, path):
 
846
        """Return true if `path` may be able to pass to subprocess."""
 
847
        fenc = self._fenc()
 
848
        try:
 
849
            return path == path.encode(fenc).decode(fenc)
 
850
        except UnicodeError:
 
851
            return False
 
852
 
 
853
    def _safe_filename(self, prefix, relpath):
 
854
        """Replace unsafe character in `relpath` then join `self._root`,
 
855
        `prefix` and `relpath`."""
 
856
        fenc = self._fenc()
 
857
        # encoded_str.replace('?', '_') may break multibyte char.
 
858
        # So we should encode, decode, then replace(u'?', u'_')
 
859
        relpath_tmp = relpath.encode(fenc, 'replace').decode(fenc, 'replace')
 
860
        relpath_tmp = relpath_tmp.replace(u'?', u'_')
 
861
        return osutils.pathjoin(self._root, prefix, relpath_tmp)
 
862
 
 
863
    def _write_file(self, relpath, tree, prefix, force_temp=False,
 
864
                    allow_write=False):
 
865
        if not force_temp and isinstance(tree, WorkingTree):
 
866
            full_path = tree.abspath(relpath)
 
867
            if self._is_safepath(full_path):
 
868
                return full_path
 
869
 
 
870
        full_path = self._safe_filename(prefix, relpath)
 
871
        if not force_temp and self._try_symlink_root(tree, prefix):
 
872
            return full_path
 
873
        parent_dir = osutils.dirname(full_path)
 
874
        try:
 
875
            os.makedirs(parent_dir)
 
876
        except OSError as e:
 
877
            if e.errno != errno.EEXIST:
 
878
                raise
 
879
        with tree.get_file(relpath) as source, \
 
880
                open(full_path, 'wb') as target:
 
881
            osutils.pumpfile(source, target)
 
882
        try:
 
883
            mtime = tree.get_file_mtime(relpath)
 
884
        except FileTimestampUnavailable:
 
885
            pass
 
886
        else:
 
887
            os.utime(full_path, (mtime, mtime))
 
888
        if not allow_write:
 
889
            osutils.make_readonly(full_path)
 
890
        return full_path
 
891
 
 
892
    def _prepare_files(self, old_path, new_path, force_temp=False,
 
893
                       allow_write_new=False):
 
894
        old_disk_path = self._write_file(
 
895
            old_path, self.old_tree, 'old', force_temp)
 
896
        new_disk_path = self._write_file(
 
897
            new_path, self.new_tree, 'new', force_temp,
 
898
            allow_write=allow_write_new)
 
899
        return old_disk_path, new_disk_path
 
900
 
 
901
    def finish(self):
 
902
        try:
 
903
            osutils.rmtree(self._root)
 
904
        except OSError as e:
 
905
            if e.errno != errno.ENOENT:
 
906
                mutter("The temporary directory \"%s\" was not "
 
907
                       "cleanly removed: %s." % (self._root, e))
 
908
 
 
909
    def diff(self, old_path, new_path, old_kind, new_kind):
 
910
        if (old_kind, new_kind) != ('file', 'file'):
 
911
            return DiffPath.CANNOT_DIFF
 
912
        (old_disk_path, new_disk_path) = self._prepare_files(
 
913
            old_path, new_path)
 
914
        self._execute(old_disk_path, new_disk_path)
 
915
 
 
916
    def edit_file(self, old_path, new_path):
 
917
        """Use this tool to edit a file.
 
918
 
 
919
        A temporary copy will be edited, and the new contents will be
 
920
        returned.
 
921
 
 
922
        :return: The new contents of the file.
 
923
        """
 
924
        old_abs_path, new_abs_path = self._prepare_files(
 
925
            old_path, new_path, allow_write_new=True, force_temp=True)
 
926
        command = self._get_command(old_abs_path, new_abs_path)
 
927
        subprocess.call(command, cwd=self._root)
 
928
        with open(new_abs_path, 'rb') as new_file:
 
929
            return new_file.read()
 
930
 
 
931
 
 
932
class DiffTree(object):
 
933
    """Provides textual representations of the difference between two trees.
 
934
 
 
935
    A DiffTree examines two trees and where a file-id has altered
 
936
    between them, generates a textual representation of the difference.
 
937
    DiffTree uses a sequence of DiffPath objects which are each
 
938
    given the opportunity to handle a given altered fileid. The list
 
939
    of DiffPath objects can be extended globally by appending to
 
940
    DiffTree.diff_factories, or for a specific diff operation by
 
941
    supplying the extra_factories option to the appropriate method.
 
942
    """
 
943
 
 
944
    # list of factories that can provide instances of DiffPath objects
 
945
    # may be extended by plugins.
 
946
    diff_factories = [DiffSymlink.from_diff_tree,
 
947
                      DiffDirectory.from_diff_tree,
 
948
                      DiffTreeReference.from_diff_tree]
 
949
 
 
950
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
 
951
                 diff_text=None, extra_factories=None):
 
952
        """Constructor
 
953
 
 
954
        :param old_tree: Tree to show as old in the comparison
 
955
        :param new_tree: Tree to show as new in the comparison
 
956
        :param to_file: File to write comparision to
 
957
        :param path_encoding: Character encoding to write paths in
 
958
        :param diff_text: DiffPath-type object to use as a last resort for
 
959
            diffing text files.
 
960
        :param extra_factories: Factories of DiffPaths to try before any other
 
961
            DiffPaths"""
 
962
        if diff_text is None:
 
963
            diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
 
964
                                 '', '', internal_diff)
 
965
        self.old_tree = old_tree
 
966
        self.new_tree = new_tree
 
967
        self.to_file = to_file
 
968
        self.path_encoding = path_encoding
 
969
        self.differs = []
 
970
        if extra_factories is not None:
 
971
            self.differs.extend(f(self) for f in extra_factories)
 
972
        self.differs.extend(f(self) for f in self.diff_factories)
 
973
        self.differs.extend([diff_text, DiffKindChange.from_diff_tree(self)])
 
974
 
 
975
    @classmethod
 
976
    def from_trees_options(klass, old_tree, new_tree, to_file,
 
977
                           path_encoding, external_diff_options, old_label,
 
978
                           new_label, using, context_lines):
 
979
        """Factory for producing a DiffTree.
 
980
 
 
981
        Designed to accept options used by show_diff_trees.
 
982
 
 
983
        :param old_tree: The tree to show as old in the comparison
 
984
        :param new_tree: The tree to show as new in the comparison
 
985
        :param to_file: File to write comparisons to
 
986
        :param path_encoding: Character encoding to use for writing paths
 
987
        :param external_diff_options: If supplied, use the installed diff
 
988
            binary to perform file comparison, using supplied options.
 
989
        :param old_label: Prefix to use for old file labels
 
990
        :param new_label: Prefix to use for new file labels
 
991
        :param using: Commandline to use to invoke an external diff tool
 
992
        """
 
993
        if using is not None:
 
994
            extra_factories = [DiffFromTool.make_from_diff_tree(
 
995
                using, external_diff_options)]
 
996
        else:
 
997
            extra_factories = []
 
998
        if external_diff_options:
 
999
            opts = external_diff_options.split()
 
1000
 
 
1001
            def diff_file(olab, olines, nlab, nlines, to_file, path_encoding=None, context_lines=None):
 
1002
                """:param path_encoding: not used but required
 
1003
                        to match the signature of internal_diff.
 
1004
                """
 
1005
                external_diff(olab, olines, nlab, nlines, to_file, opts)
 
1006
        else:
 
1007
            diff_file = internal_diff
 
1008
        diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
 
1009
                             old_label, new_label, diff_file, context_lines=context_lines)
 
1010
        return klass(old_tree, new_tree, to_file, path_encoding, diff_text,
 
1011
                     extra_factories)
 
1012
 
 
1013
    def show_diff(self, specific_files, extra_trees=None):
 
1014
        """Write tree diff to self.to_file
 
1015
 
 
1016
        :param specific_files: the specific files to compare (recursive)
 
1017
        :param extra_trees: extra trees to use for mapping paths to file_ids
 
1018
        """
 
1019
        try:
 
1020
            return self._show_diff(specific_files, extra_trees)
245
1021
        finally:
246
 
            new_tree.unlock()
247
 
    finally:
248
 
        old_tree.unlock()
249
 
 
250
 
 
251
 
def _show_diff_trees(old_tree, new_tree, to_file,
252
 
                     specific_files, external_diff_options):
253
 
 
254
 
    # TODO: Options to control putting on a prefix or suffix, perhaps
255
 
    # as a format string?
256
 
    old_label = 'a/'
257
 
    new_label = 'b/'
258
 
 
259
 
    DEVNULL = '/dev/null'
260
 
    # Windows users, don't panic about this filename -- it is a
261
 
    # special signal to GNU patch that the file should be created or
262
 
    # deleted respectively.
263
 
 
264
 
    # TODO: Generation of pseudo-diffs for added/deleted files could
265
 
    # be usefully made into a much faster special case.
266
 
 
267
 
    _raise_if_doubly_unversioned(specific_files, old_tree, new_tree)
268
 
 
269
 
    if external_diff_options:
270
 
        assert isinstance(external_diff_options, basestring)
271
 
        opts = external_diff_options.split()
272
 
        def diff_file(olab, olines, nlab, nlines, to_file):
273
 
            external_diff(olab, olines, nlab, nlines, to_file, opts)
274
 
    else:
275
 
        diff_file = internal_diff
276
 
    
277
 
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
278
 
                          specific_files=specific_files)
279
 
 
280
 
    has_changes = 0
281
 
    for path, file_id, kind in delta.removed:
282
 
        has_changes = 1
283
 
        print >>to_file, '=== removed %s %r' % (kind, old_label + path)
284
 
        old_tree.inventory[file_id].diff(diff_file, old_label + path, old_tree,
285
 
                                         DEVNULL, None, None, to_file)
286
 
    for path, file_id, kind in delta.added:
287
 
        has_changes = 1
288
 
        print >>to_file, '=== added %s %r' % (kind, new_label + path)
289
 
        new_tree.inventory[file_id].diff(diff_file, new_label + path, new_tree,
290
 
                                         DEVNULL, None, None, to_file, 
291
 
                                         reverse=True)
292
 
    for (old_path, new_path, file_id, kind,
293
 
         text_modified, meta_modified) in delta.renamed:
294
 
        has_changes = 1
295
 
        prop_str = get_prop_change(meta_modified)
296
 
        print >>to_file, '=== renamed %s %r => %r%s' % (
297
 
                    kind, old_label + old_path, new_label + new_path, prop_str)
298
 
        _maybe_diff_file_or_symlink(old_label, old_path, old_tree, file_id,
299
 
                                    new_label, new_path, new_tree,
300
 
                                    text_modified, kind, to_file, diff_file)
301
 
    for path, file_id, kind, text_modified, meta_modified in delta.modified:
302
 
        has_changes = 1
303
 
        prop_str = get_prop_change(meta_modified)
304
 
        print >>to_file, '=== modified %s %r%s' % (kind, old_label + path,
305
 
                    prop_str)
306
 
        if text_modified:
307
 
            _maybe_diff_file_or_symlink(old_label, path, old_tree, file_id,
308
 
                                        new_label, path, new_tree,
309
 
                                        True, kind, to_file, diff_file)
310
 
 
311
 
    return has_changes
312
 
 
313
 
 
314
 
def _raise_if_doubly_unversioned(specific_files, old_tree, new_tree):
315
 
    """Complain if paths are not versioned in either tree."""
316
 
    if not specific_files:
317
 
        return
318
 
    old_unversioned = old_tree.filter_unversioned_files(specific_files)
319
 
    new_unversioned = new_tree.filter_unversioned_files(specific_files)
320
 
    unversioned = old_unversioned.intersection(new_unversioned)
321
 
    if unversioned:
322
 
        raise errors.PathsNotVersionedError(sorted(unversioned))
323
 
    
324
 
 
325
 
def get_prop_change(meta_modified):
326
 
    if meta_modified:
327
 
        return " (properties changed)"
328
 
    else:
329
 
        return  ""
330
 
 
331
 
 
332
 
def _maybe_diff_file_or_symlink(old_label, old_path, old_tree, file_id,
333
 
                                new_label, new_path, new_tree, text_modified,
334
 
                                kind, to_file, diff_file):
335
 
    if text_modified:
336
 
        new_entry = new_tree.inventory[file_id]
337
 
        old_tree.inventory[file_id].diff(diff_file,
338
 
                                         old_label + old_path, old_tree,
339
 
                                         new_label + new_path, new_entry, 
340
 
                                         new_tree, to_file)
 
1022
            for differ in self.differs:
 
1023
                differ.finish()
 
1024
 
 
1025
    def _show_diff(self, specific_files, extra_trees):
 
1026
        # TODO: Generation of pseudo-diffs for added/deleted files could
 
1027
        # be usefully made into a much faster special case.
 
1028
        iterator = self.new_tree.iter_changes(self.old_tree,
 
1029
                                              specific_files=specific_files,
 
1030
                                              extra_trees=extra_trees,
 
1031
                                              require_versioned=True)
 
1032
        has_changes = 0
 
1033
 
 
1034
        def changes_key(change):
 
1035
            old_path, new_path = change.path
 
1036
            path = new_path
 
1037
            if path is None:
 
1038
                path = old_path
 
1039
            return path
 
1040
 
 
1041
        def get_encoded_path(path):
 
1042
            if path is not None:
 
1043
                return path.encode(self.path_encoding, "replace")
 
1044
        for change in sorted(iterator, key=changes_key):
 
1045
            # The root does not get diffed, and items with no known kind (that
 
1046
            # is, missing) in both trees are skipped as well.
 
1047
            if change.parent_id == (None, None) or change.kind == (None, None):
 
1048
                continue
 
1049
            if change.kind[0] == 'symlink' and not self.new_tree.supports_symlinks():
 
1050
                warning(
 
1051
                    'Ignoring "%s" as symlinks are not '
 
1052
                    'supported on this filesystem.' % (change.path[0],))
 
1053
                continue
 
1054
            oldpath, newpath = change.path
 
1055
            oldpath_encoded = get_encoded_path(change.path[0])
 
1056
            newpath_encoded = get_encoded_path(change.path[1])
 
1057
            old_present = (change.kind[0] is not None and change.versioned[0])
 
1058
            new_present = (change.kind[1] is not None and change.versioned[1])
 
1059
            executable = change.executable
 
1060
            kind = change.kind
 
1061
            renamed = (change.parent_id[0], change.name[0]) != (change.parent_id[1], change.name[1])
 
1062
 
 
1063
            properties_changed = []
 
1064
            properties_changed.extend(
 
1065
                get_executable_change(executable[0], executable[1]))
 
1066
 
 
1067
            if properties_changed:
 
1068
                prop_str = b" (properties changed: %s)" % (
 
1069
                    b", ".join(properties_changed),)
 
1070
            else:
 
1071
                prop_str = b""
 
1072
 
 
1073
            if (old_present, new_present) == (True, False):
 
1074
                self.to_file.write(b"=== removed %s '%s'\n" %
 
1075
                                   (kind[0].encode('ascii'), oldpath_encoded))
 
1076
                newpath = oldpath
 
1077
            elif (old_present, new_present) == (False, True):
 
1078
                self.to_file.write(b"=== added %s '%s'\n" %
 
1079
                                   (kind[1].encode('ascii'), newpath_encoded))
 
1080
                oldpath = newpath
 
1081
            elif renamed:
 
1082
                self.to_file.write(b"=== renamed %s '%s' => '%s'%s\n" %
 
1083
                                   (kind[0].encode('ascii'), oldpath_encoded, newpath_encoded, prop_str))
 
1084
            else:
 
1085
                # if it was produced by iter_changes, it must be
 
1086
                # modified *somehow*, either content or execute bit.
 
1087
                self.to_file.write(b"=== modified %s '%s'%s\n" % (kind[0].encode('ascii'),
 
1088
                                                                  newpath_encoded, prop_str))
 
1089
            if change.changed_content:
 
1090
                self._diff(oldpath, newpath, kind[0], kind[1])
 
1091
                has_changes = 1
 
1092
            if renamed:
 
1093
                has_changes = 1
 
1094
        return has_changes
 
1095
 
 
1096
    def diff(self, old_path, new_path):
 
1097
        """Perform a diff of a single file
 
1098
 
 
1099
        :param old_path: The path of the file in the old tree
 
1100
        :param new_path: The path of the file in the new tree
 
1101
        """
 
1102
        if old_path is None:
 
1103
            old_kind = None
 
1104
        else:
 
1105
            old_kind = self.old_tree.kind(old_path)
 
1106
        if new_path is None:
 
1107
            new_kind = None
 
1108
        else:
 
1109
            new_kind = self.new_tree.kind(new_path)
 
1110
        self._diff(old_path, new_path, old_kind, new_kind)
 
1111
 
 
1112
    def _diff(self, old_path, new_path, old_kind, new_kind):
 
1113
        result = DiffPath._diff_many(
 
1114
            self.differs, old_path, new_path, old_kind, new_kind)
 
1115
        if result is DiffPath.CANNOT_DIFF:
 
1116
            error_path = new_path
 
1117
            if error_path is None:
 
1118
                error_path = old_path
 
1119
            raise errors.NoDiffFound(error_path)
 
1120
 
 
1121
 
 
1122
format_registry = Registry()
 
1123
format_registry.register('default', DiffTree)