← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Martin Pool
  • Date: 2005-07-05 08:09:30 UTC
  • Revision ID: mbp@sourcefrog.net-20050705080929-f44361a66a8b2e29
- Merge3.find_sync_regions always returns a zero-length sentinal at the end to
  ease matching.

- Merge3.merge partially done.

Show diffs side-by-side

added added

removed removed

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