← 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-22 23:32:00 UTC
  • Revision ID: mbp@sourcefrog.net-20050722233200-ccdeca985093a9fb
- now needs python 2.4
- update instructions for running selftest

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/diff.py
1
 
# Copyright (C) 2004, 2005, 2006 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
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
17
 
17
 
import errno
18
 
import os
19
 
import subprocess
20
 
import sys
21
 
import tempfile
22
 
import time
23
 
 
24
 
from bzrlib.delta import compare_trees
25
 
from bzrlib.errors import BzrError
26
 
import bzrlib.errors as errors
27
 
import bzrlib.osutils
28
 
from bzrlib.patiencediff import unified_diff
29
 
import bzrlib.patiencediff
30
 
from bzrlib.symbol_versioning import (deprecated_function,
31
 
        zero_eight)
32
 
from bzrlib.textfile import check_text_lines
33
 
from bzrlib.trace import mutter, warning
 
18
from trace import mutter
 
19
from errors import BzrError
34
20
 
35
21
 
36
22
# TODO: Rather than building a changeset object, we should probably
37
23
# invoke callbacks on an object.  That object can either accumulate a
38
24
# list, write them out directly, etc etc.
39
25
 
40
 
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
41
 
                  allow_binary=False, sequence_matcher=None,
42
 
                  path_encoding='utf8'):
 
26
def internal_diff(old_label, oldlines, new_label, newlines, to_file):
 
27
    import difflib
 
28
    
43
29
    # FIXME: difflib is wrong if there is no trailing newline.
44
30
    # The syntax used by patch seems to be "\ No newline at
45
31
    # end of file" following the last diff line from that
55
41
    # both sequences are empty.
56
42
    if not oldlines and not newlines:
57
43
        return
58
 
    
59
 
    if allow_binary is False:
60
 
        check_text_lines(oldlines)
61
 
        check_text_lines(newlines)
62
 
 
63
 
    if sequence_matcher is None:
64
 
        sequence_matcher = bzrlib.patiencediff.PatienceSequenceMatcher
65
 
    ud = unified_diff(oldlines, newlines,
66
 
                      fromfile=old_filename.encode(path_encoding),
67
 
                      tofile=new_filename.encode(path_encoding),
68
 
                      sequencematcher=sequence_matcher)
69
 
 
70
 
    ud = list(ud)
 
44
 
 
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
 
71
57
    # work-around for difflib being too smart for its own good
72
58
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
73
59
    if not oldlines:
 
60
        ud = list(ud)
74
61
        ud[2] = ud[2].replace('-1,0', '-0,0')
75
62
    elif not newlines:
 
63
        ud = list(ud)
76
64
        ud[2] = ud[2].replace('+1,0', '+0,0')
77
 
    # work around for difflib emitting random spaces after the label
78
 
    ud[0] = ud[0][:-2] + '\n'
79
 
    ud[1] = ud[1][:-2] + '\n'
80
65
 
81
66
    for line in ud:
82
67
        to_file.write(line)
83
 
        if not line.endswith('\n'):
84
 
            to_file.write("\n\\ No newline at end of file\n")
 
68
    if nonl:
 
69
        print >>to_file, "\\ No newline at end of file"
85
70
    print >>to_file
86
71
 
87
72
 
88
 
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
 
73
 
 
74
 
 
75
def external_diff(old_label, oldlines, new_label, newlines, to_file,
89
76
                  diff_opts):
90
77
    """Display a diff by calling out to the external diff program."""
91
 
    if hasattr(to_file, 'fileno'):
92
 
        out_file = to_file
93
 
        have_fileno = True
94
 
    else:
95
 
        out_file = subprocess.PIPE
96
 
        have_fileno = False
 
78
    import sys
97
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
 
98
84
    # make sure our own output is properly ordered before the diff
99
85
    to_file.flush()
100
86
 
101
 
    oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='bzr-diff-old-')
102
 
    newtmp_fd, new_abspath = tempfile.mkstemp(prefix='bzr-diff-new-')
103
 
    oldtmpf = os.fdopen(oldtmp_fd, 'wb')
104
 
    newtmpf = os.fdopen(newtmp_fd, 'wb')
 
87
    from tempfile import NamedTemporaryFile
 
88
    import os
 
89
 
 
90
    oldtmpf = NamedTemporaryFile()
 
91
    newtmpf = NamedTemporaryFile()
105
92
 
106
93
    try:
107
94
        # TODO: perhaps a special case for comparing to or from the empty
114
101
        oldtmpf.writelines(oldlines)
115
102
        newtmpf.writelines(newlines)
116
103
 
117
 
        oldtmpf.close()
118
 
        newtmpf.close()
 
104
        oldtmpf.flush()
 
105
        newtmpf.flush()
119
106
 
120
107
        if not diff_opts:
121
108
            diff_opts = []
122
109
        diffcmd = ['diff',
123
 
                   '--label', old_filename,
124
 
                   old_abspath,
125
 
                   '--label', new_filename,
126
 
                   new_abspath,
127
 
                   '--binary',
128
 
                  ]
 
110
                   '--label', old_label,
 
111
                   oldtmpf.name,
 
112
                   '--label', new_label,
 
113
                   newtmpf.name]
129
114
 
130
115
        # diff only allows one style to be specified; they don't override.
131
116
        # note that some of these take optargs, and the optargs can be
151
136
        if diff_opts:
152
137
            diffcmd.extend(diff_opts)
153
138
 
154
 
        try:
155
 
            pipe = subprocess.Popen(diffcmd,
156
 
                                    stdin=subprocess.PIPE,
157
 
                                    stdout=out_file)
158
 
        except OSError, e:
159
 
            if e.errno == errno.ENOENT:
160
 
                raise errors.NoDiff(str(e))
161
 
            raise
162
 
        pipe.stdin.close()
163
 
 
164
 
        if not have_fileno:
165
 
            bzrlib.osutils.pumpfile(pipe.stdout, to_file)
166
 
        rc = pipe.wait()
 
139
        rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
167
140
        
168
141
        if rc != 0 and rc != 1:
169
142
            # returns 1 if files differ; that's OK
176
149
    finally:
177
150
        oldtmpf.close()                 # and delete
178
151
        newtmpf.close()
179
 
        # Clean up. Warn in case the files couldn't be deleted
180
 
        # (in case windows still holds the file open, but not
181
 
        # if the files have already been deleted)
182
 
        try:
183
 
            os.remove(old_abspath)
184
 
        except OSError, e:
185
 
            if e.errno not in (errno.ENOENT,):
186
 
                warning('Failed to delete temporary file: %s %s',
187
 
                        old_abspath, e)
188
 
        try:
189
 
            os.remove(new_abspath)
190
 
        except OSError:
191
 
            if e.errno not in (errno.ENOENT,):
192
 
                warning('Failed to delete temporary file: %s %s',
193
 
                        new_abspath, e)
194
 
 
195
 
 
196
 
@deprecated_function(zero_eight)
197
 
def show_diff(b, from_spec, specific_files, external_diff_options=None,
198
 
              revision2=None, output=None, b2=None):
 
152
    
 
153
 
 
154
 
 
155
def show_diff(b, revision, specific_files, external_diff_options=None):
199
156
    """Shortcut for showing the diff to the working tree.
200
157
 
201
 
    Please use show_diff_trees instead.
202
 
 
203
158
    b
204
159
        Branch.
205
160
 
206
161
    revision
207
 
        None for 'basis tree', or otherwise the old revision to compare against.
208
 
    
209
 
    The more general form is show_diff_trees(), where the caller
210
 
    supplies any two trees.
211
 
    """
212
 
    if output is None:
213
 
        output = sys.stdout
214
 
 
215
 
    if from_spec is None:
216
 
        old_tree = b.bzrdir.open_workingtree()
217
 
        if b2 is None:
218
 
            old_tree = old_tree = old_tree.basis_tree()
219
 
    else:
220
 
        old_tree = b.repository.revision_tree(from_spec.in_history(b).rev_id)
221
 
 
222
 
    if revision2 is None:
223
 
        if b2 is None:
224
 
            new_tree = b.bzrdir.open_workingtree()
225
 
        else:
226
 
            new_tree = b2.bzrdir.open_workingtree()
227
 
    else:
228
 
        new_tree = b.repository.revision_tree(revision2.in_history(b).rev_id)
229
 
 
230
 
    return show_diff_trees(old_tree, new_tree, output, specific_files,
231
 
                           external_diff_options)
232
 
 
233
 
 
234
 
def diff_cmd_helper(tree, specific_files, external_diff_options, 
235
 
                    old_revision_spec=None, new_revision_spec=None,
236
 
                    old_label='a/', new_label='b/'):
237
 
    """Helper for cmd_diff.
238
 
 
239
 
   tree 
240
 
        A WorkingTree
241
 
 
242
 
    specific_files
243
 
        The specific files to compare, or None
244
 
 
245
 
    external_diff_options
246
 
        If non-None, run an external diff, and pass it these options
247
 
 
248
 
    old_revision_spec
249
 
        If None, use basis tree as old revision, otherwise use the tree for
250
 
        the specified revision. 
251
 
 
252
 
    new_revision_spec
253
 
        If None, use working tree as new revision, otherwise use the tree for
254
 
        the specified revision.
255
 
    
256
 
    The more general form is show_diff_trees(), where the caller
257
 
    supplies any two trees.
258
 
    """
259
 
    output = sys.stdout
260
 
    def spec_tree(spec):
261
 
        revision_id = spec.in_store(tree.branch).rev_id
262
 
        return tree.branch.repository.revision_tree(revision_id)
263
 
    if old_revision_spec is None:
264
 
        old_tree = tree.basis_tree()
265
 
    else:
266
 
        old_tree = spec_tree(old_revision_spec)
267
 
 
268
 
    if new_revision_spec is None:
269
 
        new_tree = tree
270
 
    else:
271
 
        new_tree = spec_tree(new_revision_spec)
272
 
 
273
 
    return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
274
 
                           external_diff_options,
275
 
                           old_label=old_label, new_label=new_label)
 
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.
 
166
    """
 
167
    import sys
 
168
 
 
169
    if revision == None:
 
170
        old_tree = b.basis_tree()
 
171
    else:
 
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
 
276
179
 
277
180
 
278
181
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
279
 
                    external_diff_options=None,
280
 
                    old_label='a/', new_label='b/'):
 
182
                    external_diff_options=None):
281
183
    """Show in text form the changes from one tree to another.
282
184
 
283
185
    to_files
286
188
    external_diff_options
287
189
        If set, use an external GNU diff and pass these options.
288
190
    """
289
 
    old_tree.lock_read()
290
 
    try:
291
 
        new_tree.lock_read()
292
 
        try:
293
 
            return _show_diff_trees(old_tree, new_tree, to_file,
294
 
                                    specific_files, external_diff_options,
295
 
                                    old_label=old_label, new_label=new_label)
296
 
        finally:
297
 
            new_tree.unlock()
298
 
    finally:
299
 
        old_tree.unlock()
300
 
 
301
 
 
302
 
def _show_diff_trees(old_tree, new_tree, to_file,
303
 
                     specific_files, external_diff_options, 
304
 
                     old_label='a/', new_label='b/' ):
305
 
 
306
 
    # GNU Patch uses the epoch date to detect files that are being added
307
 
    # or removed in a diff.
308
 
    EPOCH_DATE = '1970-01-01 00:00:00 +0000'
 
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.
309
200
 
310
201
    # TODO: Generation of pseudo-diffs for added/deleted files could
311
202
    # be usefully made into a much faster special case.
312
203
 
313
 
    _raise_if_doubly_unversioned(specific_files, old_tree, new_tree)
314
 
 
315
204
    if external_diff_options:
316
205
        assert isinstance(external_diff_options, basestring)
317
206
        opts = external_diff_options.split()
320
209
    else:
321
210
        diff_file = internal_diff
322
211
    
 
212
 
323
213
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
324
214
                          specific_files=specific_files)
325
215
 
326
 
    has_changes = 0
327
216
    for path, file_id, kind in delta.removed:
328
 
        has_changes = 1
329
 
        print >>to_file, '=== removed %s %r' % (kind, path.encode('utf8'))
330
 
        old_name = '%s%s\t%s' % (old_label, path,
331
 
                                 _patch_header_date(old_tree, file_id, path))
332
 
        new_name = '%s%s\t%s' % (new_label, path, EPOCH_DATE)
333
 
        old_tree.inventory[file_id].diff(diff_file, old_name, old_tree,
334
 
                                         new_name, None, None, to_file)
 
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
 
335
225
    for path, file_id, kind in delta.added:
336
 
        has_changes = 1
337
 
        print >>to_file, '=== added %s %r' % (kind, path.encode('utf8'))
338
 
        old_name = '%s%s\t%s' % (old_label, path, EPOCH_DATE)
339
 
        new_name = '%s%s\t%s' % (new_label, path,
340
 
                                 _patch_header_date(new_tree, file_id, path))
341
 
        new_tree.inventory[file_id].diff(diff_file, new_name, new_tree,
342
 
                                         old_name, None, None, to_file, 
343
 
                                         reverse=True)
344
 
    for (old_path, new_path, file_id, kind,
345
 
         text_modified, meta_modified) in delta.renamed:
346
 
        has_changes = 1
347
 
        prop_str = get_prop_change(meta_modified)
348
 
        print >>to_file, '=== renamed %s %r => %r%s' % (
349
 
                    kind, old_path.encode('utf8'),
350
 
                    new_path.encode('utf8'), prop_str)
351
 
        old_name = '%s%s\t%s' % (old_label, old_path,
352
 
                                 _patch_header_date(old_tree, file_id,
353
 
                                                    old_path))
354
 
        new_name = '%s%s\t%s' % (new_label, new_path,
355
 
                                 _patch_header_date(new_tree, file_id,
356
 
                                                    new_path))
357
 
        _maybe_diff_file_or_symlink(old_name, old_tree, file_id,
358
 
                                    new_name, new_tree,
359
 
                                    text_modified, kind, to_file, diff_file)
360
 
    for path, file_id, kind, text_modified, meta_modified in delta.modified:
361
 
        has_changes = 1
362
 
        prop_str = get_prop_change(meta_modified)
363
 
        print >>to_file, '=== modified %s %r%s' % (kind, path.encode('utf8'), prop_str)
364
 
        old_name = '%s%s\t%s' % (old_label, path,
365
 
                                 _patch_header_date(old_tree, file_id, path))
366
 
        new_name = '%s%s\t%s' % (new_label, path,
367
 
                                 _patch_header_date(new_tree, file_id, path))
 
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)
368
236
        if text_modified:
369
 
            _maybe_diff_file_or_symlink(old_name, old_tree, file_id,
370
 
                                        new_name, new_tree,
371
 
                                        True, kind, to_file, diff_file)
372
 
 
373
 
    return has_changes
374
 
 
375
 
 
376
 
def _patch_header_date(tree, file_id, path):
377
 
    """Returns a timestamp suitable for use in a patch header."""
378
 
    tm = time.gmtime(tree.get_file_mtime(file_id, path))
379
 
    return time.strftime('%Y-%m-%d %H:%M:%S +0000', tm)
380
 
 
381
 
 
382
 
def _raise_if_doubly_unversioned(specific_files, old_tree, new_tree):
383
 
    """Complain if paths are not versioned in either tree."""
384
 
    if not specific_files:
385
 
        return
386
 
    old_unversioned = old_tree.filter_unversioned_files(specific_files)
387
 
    new_unversioned = new_tree.filter_unversioned_files(specific_files)
388
 
    unversioned = old_unversioned.intersection(new_unversioned)
389
 
    if unversioned:
390
 
        raise errors.PathsNotVersionedError(sorted(unversioned))
391
 
    
392
 
 
393
 
def _raise_if_nonexistent(paths, old_tree, new_tree):
394
 
    """Complain if paths are not in either inventory or tree.
395
 
 
396
 
    It's OK with the files exist in either tree's inventory, or 
397
 
    if they exist in the tree but are not versioned.
398
 
    
399
 
    This can be used by operations such as bzr status that can accept
400
 
    unknown or ignored files.
401
 
    """
402
 
    mutter("check paths: %r", paths)
403
 
    if not paths:
404
 
        return
405
 
    s = old_tree.filter_unversioned_files(paths)
406
 
    s = new_tree.filter_unversioned_files(s)
407
 
    s = [path for path in s if not new_tree.has_filename(path)]
408
 
    if s:
409
 
        raise errors.PathsDoNotExist(sorted(s))
410
 
 
411
 
 
412
 
def get_prop_change(meta_modified):
413
 
    if meta_modified:
414
 
        return " (properties changed)"
415
 
    else:
416
 
        return  ""
417
 
 
418
 
 
419
 
def _maybe_diff_file_or_symlink(old_path, old_tree, file_id,
420
 
                                new_path, new_tree, text_modified,
421
 
                                kind, to_file, diff_file):
422
 
    if text_modified:
423
 
        new_entry = new_tree.inventory[file_id]
424
 
        old_tree.inventory[file_id].diff(diff_file,
425
 
                                         old_path, old_tree,
426
 
                                         new_path, new_entry, 
427
 
                                         new_tree, to_file)
 
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
            old_ie = old_inv[file_id]
 
393
            new_ie = new_inv[file_id]
 
394
 
 
395
            kind = old_ie.kind
 
396
            assert kind == new_ie.kind
 
397
            
 
398
            assert kind in ('file', 'directory', 'symlink', 'root_directory'), \
 
399
                   'invalid file kind %r' % kind
 
400
 
 
401
            if kind == 'root_directory':
 
402
                continue
 
403
            
 
404
            if specific_files:
 
405
                if (not is_inside_any(specific_files, old_inv.id2path(file_id)) 
 
406
                    and not is_inside_any(specific_files, new_inv.id2path(file_id))):
 
407
                    continue
 
408
 
 
409
            if kind == 'file':
 
410
                old_sha1 = old_tree.get_file_sha1(file_id)
 
411
                new_sha1 = new_tree.get_file_sha1(file_id)
 
412
                text_modified = (old_sha1 != new_sha1)
 
413
            else:
 
414
                ## mutter("no text to check for %r %r" % (file_id, kind))
 
415
                text_modified = False
 
416
 
 
417
            # TODO: Can possibly avoid calculating path strings if the
 
418
            # two files are unchanged and their names and parents are
 
419
            # the same and the parents are unchanged all the way up.
 
420
            # May not be worthwhile.
 
421
            
 
422
            if (old_ie.name != new_ie.name
 
423
                or old_ie.parent_id != new_ie.parent_id):
 
424
                delta.renamed.append((old_inv.id2path(file_id),
 
425
                                      new_inv.id2path(file_id),
 
426
                                      file_id, kind,
 
427
                                      text_modified))
 
428
            elif text_modified:
 
429
                delta.modified.append((new_inv.id2path(file_id), file_id, kind))
 
430
            elif want_unchanged:
 
431
                delta.unchanged.append((new_inv.id2path(file_id), file_id, kind))
 
432
        else:
 
433
            kind = old_inv.get_file_kind(file_id)
 
434
            old_path = old_inv.id2path(file_id)
 
435
            if specific_files:
 
436
                if not is_inside_any(specific_files, old_path):
 
437
                    continue
 
438
            delta.removed.append((old_path, file_id, kind))
 
439
 
 
440
    mutter('start looking for new files')
 
441
    for file_id in new_inv:
 
442
        if file_id in old_inv:
 
443
            continue
 
444
        new_path = new_inv.id2path(file_id)
 
445
        if specific_files:
 
446
            if not is_inside_any(specific_files, new_path):
 
447
                continue
 
448
        kind = new_inv.get_file_kind(file_id)
 
449
        delta.added.append((new_path, file_id, kind))
 
450
            
 
451
    delta.removed.sort()
 
452
    delta.added.sort()
 
453
    delta.renamed.sort()
 
454
    delta.modified.sort()
 
455
    delta.unchanged.sort()
 
456
 
 
457
    return delta