← 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-06-06 13:24:18 UTC
  • Revision ID: mbp@sourcefrog.net-20050606132418-1082c87e2473e266
- manpage generator by Hans Ulrich Niedermann

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 os
18
 
import re
19
 
import sys
20
 
 
21
 
from bzrlib.lazy_import import lazy_import
22
 
lazy_import(globals(), """
23
 
import errno
24
 
import subprocess
25
 
import tempfile
26
 
import time
27
 
 
28
 
from bzrlib import (
29
 
    errors,
30
 
    osutils,
31
 
    patiencediff,
32
 
    textfile,
33
 
    )
34
 
""")
35
 
 
36
 
# compatability - plugins import compare_trees from diff!!!
37
 
# deprecated as of 0.10
38
 
from bzrlib.delta import compare_trees
39
 
from bzrlib.symbol_versioning import (
40
 
        deprecated_function,
41
 
        zero_eight,
42
 
        )
43
 
from bzrlib.trace import mutter, warning
44
 
 
45
 
 
46
 
# TODO: Rather than building a changeset object, we should probably
47
 
# invoke callbacks on an object.  That object can either accumulate a
48
 
# list, write them out directly, etc etc.
49
 
 
50
 
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
51
 
                  allow_binary=False, sequence_matcher=None,
52
 
                  path_encoding='utf8'):
 
18
from trace import mutter
 
19
from errors import BzrError
 
20
 
 
21
 
 
22
def internal_diff(old_label, oldlines, new_label, newlines, to_file):
 
23
    import difflib
 
24
    
53
25
    # FIXME: difflib is wrong if there is no trailing newline.
54
26
    # The syntax used by patch seems to be "\ No newline at
55
27
    # end of file" following the last diff line from that
65
37
    # both sequences are empty.
66
38
    if not oldlines and not newlines:
67
39
        return
68
 
    
69
 
    if allow_binary is False:
70
 
        textfile.check_text_lines(oldlines)
71
 
        textfile.check_text_lines(newlines)
72
 
 
73
 
    if sequence_matcher is None:
74
 
        sequence_matcher = patiencediff.PatienceSequenceMatcher
75
 
    ud = patiencediff.unified_diff(oldlines, newlines,
76
 
                      fromfile=old_filename.encode(path_encoding),
77
 
                      tofile=new_filename.encode(path_encoding),
78
 
                      sequencematcher=sequence_matcher)
79
 
 
80
 
    ud = list(ud)
 
40
 
 
41
    nonl = False
 
42
 
 
43
    if oldlines and (oldlines[-1][-1] != '\n'):
 
44
        oldlines[-1] += '\n'
 
45
        nonl = True
 
46
    if newlines and (newlines[-1][-1] != '\n'):
 
47
        newlines[-1] += '\n'
 
48
        nonl = True
 
49
 
 
50
    ud = difflib.unified_diff(oldlines, newlines,
 
51
                              fromfile=old_label, tofile=new_label)
 
52
 
81
53
    # work-around for difflib being too smart for its own good
82
54
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
83
55
    if not oldlines:
 
56
        ud = list(ud)
84
57
        ud[2] = ud[2].replace('-1,0', '-0,0')
85
58
    elif not newlines:
 
59
        ud = list(ud)
86
60
        ud[2] = ud[2].replace('+1,0', '+0,0')
87
 
    # work around for difflib emitting random spaces after the label
88
 
    ud[0] = ud[0][:-2] + '\n'
89
 
    ud[1] = ud[1][:-2] + '\n'
90
61
 
91
 
    for line in ud:
92
 
        to_file.write(line)
93
 
        if not line.endswith('\n'):
94
 
            to_file.write("\n\\ No newline at end of file\n")
 
62
    to_file.writelines(ud)
 
63
    if nonl:
 
64
        print >>to_file, "\\ No newline at end of file"
95
65
    print >>to_file
96
66
 
97
67
 
98
 
def _set_lang_C():
99
 
    """Set the env vars LANG=C and LC_ALL=C."""
100
 
    osutils.set_or_unset_env('LANG', 'C')
101
 
    osutils.set_or_unset_env('LC_ALL', 'C')
102
 
    osutils.set_or_unset_env('LC_CTYPE', None)
103
 
    osutils.set_or_unset_env('LANGUAGE', None)
104
 
 
105
 
 
106
 
def _spawn_external_diff(diffcmd, capture_errors=True):
107
 
    """Spawn the externall diff process, and return the child handle.
108
 
 
109
 
    :param diffcmd: The command list to spawn
110
 
    :param capture_errors: Capture stderr as well as setting LANG=C
111
 
        and LC_ALL=C. This lets us read and understand the output of diff,
112
 
        and respond to any errors.
113
 
    :return: A Popen object.
114
 
    """
115
 
    if capture_errors:
116
 
        if sys.platform == 'win32':
117
 
            # Win32 doesn't support preexec_fn, but that is
118
 
            # okay, because it doesn't support LANG and LC_ALL either.
119
 
            preexec_fn = None
120
 
        else:
121
 
            preexec_fn = _set_lang_C
122
 
        stderr = subprocess.PIPE
123
 
    else:
124
 
        preexec_fn = None
125
 
        stderr = None
126
 
 
127
 
    try:
128
 
        pipe = subprocess.Popen(diffcmd,
129
 
                                stdin=subprocess.PIPE,
130
 
                                stdout=subprocess.PIPE,
131
 
                                stderr=stderr,
132
 
                                preexec_fn=preexec_fn)
133
 
    except OSError, e:
134
 
        if e.errno == errno.ENOENT:
135
 
            raise errors.NoDiff(str(e))
136
 
        raise
137
 
 
138
 
    return pipe
139
 
 
140
 
 
141
 
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
 
68
 
 
69
 
 
70
def external_diff(old_label, oldlines, new_label, newlines, to_file,
142
71
                  diff_opts):
143
72
    """Display a diff by calling out to the external diff program."""
 
73
    import sys
 
74
    
 
75
    if to_file != sys.stdout:
 
76
        raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
 
77
                                  to_file)
 
78
 
144
79
    # make sure our own output is properly ordered before the diff
145
80
    to_file.flush()
146
81
 
147
 
    oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='bzr-diff-old-')
148
 
    newtmp_fd, new_abspath = tempfile.mkstemp(prefix='bzr-diff-new-')
149
 
    oldtmpf = os.fdopen(oldtmp_fd, 'wb')
150
 
    newtmpf = os.fdopen(newtmp_fd, 'wb')
 
82
    from tempfile import NamedTemporaryFile
 
83
    import os
 
84
 
 
85
    oldtmpf = NamedTemporaryFile()
 
86
    newtmpf = NamedTemporaryFile()
151
87
 
152
88
    try:
153
89
        # TODO: perhaps a special case for comparing to or from the empty
160
96
        oldtmpf.writelines(oldlines)
161
97
        newtmpf.writelines(newlines)
162
98
 
163
 
        oldtmpf.close()
164
 
        newtmpf.close()
 
99
        oldtmpf.flush()
 
100
        newtmpf.flush()
165
101
 
166
102
        if not diff_opts:
167
103
            diff_opts = []
168
104
        diffcmd = ['diff',
169
 
                   '--label', old_filename,
170
 
                   old_abspath,
171
 
                   '--label', new_filename,
172
 
                   new_abspath,
173
 
                   '--binary',
174
 
                  ]
 
105
                   '--label', old_label,
 
106
                   oldtmpf.name,
 
107
                   '--label', new_label,
 
108
                   newtmpf.name]
175
109
 
176
110
        # diff only allows one style to be specified; they don't override.
177
111
        # note that some of these take optargs, and the optargs can be
197
131
        if diff_opts:
198
132
            diffcmd.extend(diff_opts)
199
133
 
200
 
        pipe = _spawn_external_diff(diffcmd, capture_errors=True)
201
 
        out,err = pipe.communicate()
202
 
        rc = pipe.returncode
 
134
        rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
203
135
        
204
 
        # internal_diff() adds a trailing newline, add one here for consistency
205
 
        out += '\n'
206
 
        if rc == 2:
207
 
            # 'diff' gives retcode == 2 for all sorts of errors
208
 
            # one of those is 'Binary files differ'.
209
 
            # Bad options could also be the problem.
210
 
            # 'Binary files' is not a real error, so we suppress that error.
211
 
            lang_c_out = out
212
 
 
213
 
            # Since we got here, we want to make sure to give an i18n error
214
 
            pipe = _spawn_external_diff(diffcmd, capture_errors=False)
215
 
            out, err = pipe.communicate()
216
 
 
217
 
            # Write out the new i18n diff response
218
 
            to_file.write(out+'\n')
219
 
            if pipe.returncode != 2:
220
 
                raise errors.BzrError(
221
 
                               'external diff failed with exit code 2'
222
 
                               ' when run with LANG=C and LC_ALL=C,'
223
 
                               ' but not when run natively: %r' % (diffcmd,))
224
 
 
225
 
            first_line = lang_c_out.split('\n', 1)[0]
226
 
            # Starting with diffutils 2.8.4 the word "binary" was dropped.
227
 
            m = re.match('^(binary )?files.*differ$', first_line, re.I)
228
 
            if m is None:
229
 
                raise errors.BzrError('external diff failed with exit code 2;'
230
 
                                      ' command: %r' % (diffcmd,))
231
 
            else:
232
 
                # Binary files differ, just return
233
 
                return
234
 
 
235
 
        # If we got to here, we haven't written out the output of diff
236
 
        # do so now
237
 
        to_file.write(out)
238
 
        if rc not in (0, 1):
 
136
        if rc != 0 and rc != 1:
239
137
            # returns 1 if files differ; that's OK
240
138
            if rc < 0:
241
139
                msg = 'signal %d' % (-rc)
242
140
            else:
243
141
                msg = 'exit code %d' % rc
244
142
                
245
 
            raise errors.BzrError('external diff failed with %s; command: %r' 
246
 
                                  % (rc, diffcmd))
247
 
 
248
 
 
 
143
            raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
249
144
    finally:
250
145
        oldtmpf.close()                 # and delete
251
146
        newtmpf.close()
252
 
        # Clean up. Warn in case the files couldn't be deleted
253
 
        # (in case windows still holds the file open, but not
254
 
        # if the files have already been deleted)
255
 
        try:
256
 
            os.remove(old_abspath)
257
 
        except OSError, e:
258
 
            if e.errno not in (errno.ENOENT,):
259
 
                warning('Failed to delete temporary file: %s %s',
260
 
                        old_abspath, e)
261
 
        try:
262
 
            os.remove(new_abspath)
263
 
        except OSError:
264
 
            if e.errno not in (errno.ENOENT,):
265
 
                warning('Failed to delete temporary file: %s %s',
266
 
                        new_abspath, e)
267
 
 
268
 
 
269
 
@deprecated_function(zero_eight)
270
 
def show_diff(b, from_spec, specific_files, external_diff_options=None,
271
 
              revision2=None, output=None, b2=None):
 
147
    
 
148
 
 
149
 
 
150
def show_diff(b, revision, specific_files, external_diff_options=None):
272
151
    """Shortcut for showing the diff to the working tree.
273
152
 
274
 
    Please use show_diff_trees instead.
275
 
 
276
153
    b
277
154
        Branch.
278
155
 
279
156
    revision
280
 
        None for 'basis tree', or otherwise the old revision to compare against.
281
 
    
282
 
    The more general form is show_diff_trees(), where the caller
283
 
    supplies any two trees.
284
 
    """
285
 
    if output is None:
286
 
        output = sys.stdout
287
 
 
288
 
    if from_spec is None:
289
 
        old_tree = b.bzrdir.open_workingtree()
290
 
        if b2 is None:
291
 
            old_tree = old_tree = old_tree.basis_tree()
292
 
    else:
293
 
        old_tree = b.repository.revision_tree(from_spec.in_history(b).rev_id)
294
 
 
295
 
    if revision2 is None:
296
 
        if b2 is None:
297
 
            new_tree = b.bzrdir.open_workingtree()
298
 
        else:
299
 
            new_tree = b2.bzrdir.open_workingtree()
300
 
    else:
301
 
        new_tree = b.repository.revision_tree(revision2.in_history(b).rev_id)
302
 
 
303
 
    return show_diff_trees(old_tree, new_tree, output, specific_files,
304
 
                           external_diff_options)
305
 
 
306
 
 
307
 
def diff_cmd_helper(tree, specific_files, external_diff_options, 
308
 
                    old_revision_spec=None, new_revision_spec=None,
309
 
                    revision_specs=None,
310
 
                    old_label='a/', new_label='b/'):
311
 
    """Helper for cmd_diff.
312
 
 
313
 
    :param tree:
314
 
        A WorkingTree
315
 
 
316
 
    :param specific_files:
317
 
        The specific files to compare, or None
318
 
 
319
 
    :param external_diff_options:
320
 
        If non-None, run an external diff, and pass it these options
321
 
 
322
 
    :param old_revision_spec:
323
 
        If None, use basis tree as old revision, otherwise use the tree for
324
 
        the specified revision. 
325
 
 
326
 
    :param new_revision_spec:
327
 
        If None, use working tree as new revision, otherwise use the tree for
328
 
        the specified revision.
329
 
    
330
 
    :param revision_specs: 
331
 
        Zero, one or two RevisionSpecs from the command line, saying what revisions 
332
 
        to compare.  This can be passed as an alternative to the old_revision_spec 
333
 
        and new_revision_spec parameters.
334
 
 
335
 
    The more general form is show_diff_trees(), where the caller
336
 
    supplies any two trees.
337
 
    """
338
 
 
339
 
    # TODO: perhaps remove the old parameters old_revision_spec and
340
 
    # new_revision_spec, since this is only really for use from cmd_diff and
341
 
    # it now always passes through a sequence of revision_specs -- mbp
342
 
    # 20061221
343
 
 
344
 
    def spec_tree(spec):
345
 
        if tree:
346
 
            revision = spec.in_store(tree.branch)
347
 
        else:
348
 
            revision = spec.in_store(None)
349
 
        revision_id = revision.rev_id
350
 
        branch = revision.branch
351
 
        return branch.repository.revision_tree(revision_id)
352
 
 
353
 
    if revision_specs is not None:
354
 
        assert (old_revision_spec is None
355
 
                and new_revision_spec is None)
356
 
        if len(revision_specs) > 0:
357
 
            old_revision_spec = revision_specs[0]
358
 
        if len(revision_specs) > 1:
359
 
            new_revision_spec = revision_specs[1]
360
 
 
361
 
    if old_revision_spec is None:
362
 
        old_tree = tree.basis_tree()
363
 
    else:
364
 
        old_tree = spec_tree(old_revision_spec)
365
 
 
366
 
    if (new_revision_spec is None
367
 
        or new_revision_spec.spec is None):
368
 
        new_tree = tree
369
 
    else:
370
 
        new_tree = spec_tree(new_revision_spec)
371
 
 
372
 
    if new_tree is not tree:
373
 
        extra_trees = (tree,)
374
 
    else:
375
 
        extra_trees = None
376
 
 
377
 
    return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
378
 
                           external_diff_options,
379
 
                           old_label=old_label, new_label=new_label,
380
 
                           extra_trees=extra_trees)
 
157
        None for each, or otherwise the old revision to compare against.
 
158
    
 
159
    The more general form is show_diff_trees(), where the caller
 
160
    supplies any two trees.
 
161
    """
 
162
    import sys
 
163
 
 
164
    if revision == None:
 
165
        old_tree = b.basis_tree()
 
166
    else:
 
167
        old_tree = b.revision_tree(b.lookup_revision(revision))
 
168
        
 
169
    new_tree = b.working_tree()
 
170
 
 
171
    show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
 
172
                    external_diff_options)
 
173
 
381
174
 
382
175
 
383
176
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
384
 
                    external_diff_options=None,
385
 
                    old_label='a/', new_label='b/',
386
 
                    extra_trees=None):
 
177
                    external_diff_options=None):
387
178
    """Show in text form the changes from one tree to another.
388
179
 
389
180
    to_files
391
182
 
392
183
    external_diff_options
393
184
        If set, use an external GNU diff and pass these options.
394
 
 
395
 
    extra_trees
396
 
        If set, more Trees to use for looking up file ids
397
185
    """
398
 
    old_tree.lock_read()
399
 
    try:
400
 
        new_tree.lock_read()
401
 
        try:
402
 
            return _show_diff_trees(old_tree, new_tree, to_file,
403
 
                                    specific_files, external_diff_options,
404
 
                                    old_label=old_label, new_label=new_label,
405
 
                                    extra_trees=extra_trees)
406
 
        finally:
407
 
            new_tree.unlock()
408
 
    finally:
409
 
        old_tree.unlock()
410
 
 
411
 
 
412
 
def _show_diff_trees(old_tree, new_tree, to_file,
413
 
                     specific_files, external_diff_options, 
414
 
                     old_label='a/', new_label='b/', extra_trees=None):
415
 
 
416
 
    # GNU Patch uses the epoch date to detect files that are being added
417
 
    # or removed in a diff.
418
 
    EPOCH_DATE = '1970-01-01 00:00:00 +0000'
 
186
 
 
187
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
 
188
    old_label = ''
 
189
    new_label = ''
 
190
 
 
191
    DEVNULL = '/dev/null'
 
192
    # Windows users, don't panic about this filename -- it is a
 
193
    # special signal to GNU patch that the file should be created or
 
194
    # deleted respectively.
419
195
 
420
196
    # TODO: Generation of pseudo-diffs for added/deleted files could
421
197
    # be usefully made into a much faster special case.
428
204
    else:
429
205
        diff_file = internal_diff
430
206
    
431
 
    delta = new_tree.changes_from(old_tree,
432
 
        specific_files=specific_files,
433
 
        extra_trees=extra_trees, require_versioned=True)
434
 
 
435
 
    has_changes = 0
 
207
 
 
208
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
 
209
                          specific_files=specific_files)
 
210
 
436
211
    for path, file_id, kind in delta.removed:
437
 
        has_changes = 1
438
 
        print >>to_file, '=== removed %s %r' % (kind, path.encode('utf8'))
439
 
        old_name = '%s%s\t%s' % (old_label, path,
440
 
                                 _patch_header_date(old_tree, file_id, path))
441
 
        new_name = '%s%s\t%s' % (new_label, path, EPOCH_DATE)
442
 
        old_tree.inventory[file_id].diff(diff_file, old_name, old_tree,
443
 
                                         new_name, None, None, to_file)
 
212
        print '*** removed %s %r' % (kind, path)
 
213
        if kind == 'file':
 
214
            diff_file(old_label + path,
 
215
                      old_tree.get_file(file_id).readlines(),
 
216
                      DEVNULL, 
 
217
                      [],
 
218
                      to_file)
 
219
 
444
220
    for path, file_id, kind in delta.added:
445
 
        has_changes = 1
446
 
        print >>to_file, '=== added %s %r' % (kind, path.encode('utf8'))
447
 
        old_name = '%s%s\t%s' % (old_label, path, EPOCH_DATE)
448
 
        new_name = '%s%s\t%s' % (new_label, path,
449
 
                                 _patch_header_date(new_tree, file_id, path))
450
 
        new_tree.inventory[file_id].diff(diff_file, new_name, new_tree,
451
 
                                         old_name, None, None, to_file, 
452
 
                                         reverse=True)
453
 
    for (old_path, new_path, file_id, kind,
454
 
         text_modified, meta_modified) in delta.renamed:
455
 
        has_changes = 1
456
 
        prop_str = get_prop_change(meta_modified)
457
 
        print >>to_file, '=== renamed %s %r => %r%s' % (
458
 
                    kind, old_path.encode('utf8'),
459
 
                    new_path.encode('utf8'), prop_str)
460
 
        old_name = '%s%s\t%s' % (old_label, old_path,
461
 
                                 _patch_header_date(old_tree, file_id,
462
 
                                                    old_path))
463
 
        new_name = '%s%s\t%s' % (new_label, new_path,
464
 
                                 _patch_header_date(new_tree, file_id,
465
 
                                                    new_path))
466
 
        _maybe_diff_file_or_symlink(old_name, old_tree, file_id,
467
 
                                    new_name, new_tree,
468
 
                                    text_modified, kind, to_file, diff_file)
469
 
    for path, file_id, kind, text_modified, meta_modified in delta.modified:
470
 
        has_changes = 1
471
 
        prop_str = get_prop_change(meta_modified)
472
 
        print >>to_file, '=== modified %s %r%s' % (kind, path.encode('utf8'), prop_str)
473
 
        old_name = '%s%s\t%s' % (old_label, path,
474
 
                                 _patch_header_date(old_tree, file_id, path))
475
 
        new_name = '%s%s\t%s' % (new_label, path,
476
 
                                 _patch_header_date(new_tree, file_id, path))
 
221
        print '*** added %s %r' % (kind, path)
 
222
        if kind == 'file':
 
223
            diff_file(DEVNULL,
 
224
                      [],
 
225
                      new_label + path,
 
226
                      new_tree.get_file(file_id).readlines(),
 
227
                      to_file)
 
228
 
 
229
    for old_path, new_path, file_id, kind, text_modified in delta.renamed:
 
230
        print '*** renamed %s %r => %r' % (kind, old_path, new_path)
477
231
        if text_modified:
478
 
            _maybe_diff_file_or_symlink(old_name, old_tree, file_id,
479
 
                                        new_name, new_tree,
480
 
                                        True, kind, to_file, diff_file)
481
 
 
482
 
    return has_changes
483
 
 
484
 
 
485
 
def _patch_header_date(tree, file_id, path):
486
 
    """Returns a timestamp suitable for use in a patch header."""
487
 
    tm = time.gmtime(tree.get_file_mtime(file_id, path))
488
 
    return time.strftime('%Y-%m-%d %H:%M:%S +0000', tm)
489
 
 
490
 
 
491
 
def _raise_if_nonexistent(paths, old_tree, new_tree):
492
 
    """Complain if paths are not in either inventory or tree.
493
 
 
494
 
    It's OK with the files exist in either tree's inventory, or 
495
 
    if they exist in the tree but are not versioned.
 
232
            diff_file(old_label + old_path,
 
233
                      old_tree.get_file(file_id).readlines(),
 
234
                      new_label + new_path,
 
235
                      new_tree.get_file(file_id).readlines(),
 
236
                      to_file)
 
237
 
 
238
    for path, file_id, kind in delta.modified:
 
239
        print '*** modified %s %r' % (kind, path)
 
240
        if kind == 'file':
 
241
            diff_file(old_label + path,
 
242
                      old_tree.get_file(file_id).readlines(),
 
243
                      new_label + path,
 
244
                      new_tree.get_file(file_id).readlines(),
 
245
                      to_file)
 
246
 
 
247
 
 
248
 
 
249
class TreeDelta(object):
 
250
    """Describes changes from one tree to another.
 
251
 
 
252
    Contains four lists:
 
253
 
 
254
    added
 
255
        (path, id, kind)
 
256
    removed
 
257
        (path, id, kind)
 
258
    renamed
 
259
        (oldpath, newpath, id, kind, text_modified)
 
260
    modified
 
261
        (path, id, kind)
 
262
    unchanged
 
263
        (path, id, kind)
 
264
 
 
265
    Each id is listed only once.
 
266
 
 
267
    Files that are both modified and renamed are listed only in
 
268
    renamed, with the text_modified flag true.
 
269
 
 
270
    The lists are normally sorted when the delta is created.
 
271
    """
 
272
    def __init__(self):
 
273
        self.added = []
 
274
        self.removed = []
 
275
        self.renamed = []
 
276
        self.modified = []
 
277
        self.unchanged = []
 
278
 
 
279
    def has_changed(self):
 
280
        changes = len(self.added) + len(self.removed) + len(self.renamed)
 
281
        changes += len(self.modified) 
 
282
        return (changes != 0)
 
283
 
 
284
    def touches_file_id(self, file_id):
 
285
        """Return True if file_id is modified by this delta."""
 
286
        for l in self.added, self.removed, self.modified:
 
287
            for v in l:
 
288
                if v[1] == file_id:
 
289
                    return True
 
290
        for v in self.renamed:
 
291
            if v[2] == file_id:
 
292
                return True
 
293
        return False
 
294
            
 
295
 
 
296
    def show(self, to_file, show_ids=False, show_unchanged=False):
 
297
        def show_list(files):
 
298
            for path, fid, kind in files:
 
299
                if kind == 'directory':
 
300
                    path += '/'
 
301
                elif kind == 'symlink':
 
302
                    path += '@'
 
303
                    
 
304
                if show_ids:
 
305
                    print >>to_file, '  %-30s %s' % (path, fid)
 
306
                else:
 
307
                    print >>to_file, ' ', path
 
308
            
 
309
        if self.removed:
 
310
            print >>to_file, 'removed:'
 
311
            show_list(self.removed)
 
312
                
 
313
        if self.added:
 
314
            print >>to_file, 'added:'
 
315
            show_list(self.added)
 
316
 
 
317
        if self.renamed:
 
318
            print >>to_file, 'renamed:'
 
319
            for oldpath, newpath, fid, kind, text_modified in self.renamed:
 
320
                if show_ids:
 
321
                    print >>to_file, '  %s => %s %s' % (oldpath, newpath, fid)
 
322
                else:
 
323
                    print >>to_file, '  %s => %s' % (oldpath, newpath)
 
324
                    
 
325
        if self.modified:
 
326
            print >>to_file, 'modified:'
 
327
            show_list(self.modified)
 
328
            
 
329
        if show_unchanged and self.unchanged:
 
330
            print >>to_file, 'unchanged:'
 
331
            show_list(self.unchanged)
 
332
 
 
333
 
 
334
 
 
335
def compare_trees(old_tree, new_tree, want_unchanged, specific_files=None):
 
336
    """Describe changes from one tree to another.
 
337
 
 
338
    Returns a TreeDelta with details of added, modified, renamed, and
 
339
    deleted entries.
 
340
 
 
341
    The root entry is specifically exempt.
 
342
 
 
343
    This only considers versioned files.
 
344
 
 
345
    want_unchanged
 
346
        If true, also list files unchanged from one version to
 
347
        the next.
 
348
 
 
349
    specific_files
 
350
        If true, only check for changes to specified names or
 
351
        files within them.
 
352
    """
 
353
 
 
354
    from osutils import is_inside_any
496
355
    
497
 
    This can be used by operations such as bzr status that can accept
498
 
    unknown or ignored files.
499
 
    """
500
 
    mutter("check paths: %r", paths)
501
 
    if not paths:
502
 
        return
503
 
    s = old_tree.filter_unversioned_files(paths)
504
 
    s = new_tree.filter_unversioned_files(s)
505
 
    s = [path for path in s if not new_tree.has_filename(path)]
506
 
    if s:
507
 
        raise errors.PathsDoNotExist(sorted(s))
508
 
 
509
 
 
510
 
def get_prop_change(meta_modified):
511
 
    if meta_modified:
512
 
        return " (properties changed)"
513
 
    else:
514
 
        return  ""
515
 
 
516
 
 
517
 
def _maybe_diff_file_or_symlink(old_path, old_tree, file_id,
518
 
                                new_path, new_tree, text_modified,
519
 
                                kind, to_file, diff_file):
520
 
    if text_modified:
521
 
        new_entry = new_tree.inventory[file_id]
522
 
        old_tree.inventory[file_id].diff(diff_file,
523
 
                                         old_path, old_tree,
524
 
                                         new_path, new_entry, 
525
 
                                         new_tree, to_file)
 
356
    old_inv = old_tree.inventory
 
357
    new_inv = new_tree.inventory
 
358
    delta = TreeDelta()
 
359
    mutter('start compare_trees')
 
360
 
 
361
    # TODO: match for specific files can be rather smarter by finding
 
362
    # the IDs of those files up front and then considering only that.
 
363
 
 
364
    for file_id in old_tree:
 
365
        if file_id in new_tree:
 
366
            kind = old_inv.get_file_kind(file_id)
 
367
            assert kind == new_inv.get_file_kind(file_id)
 
368
            
 
369
            assert kind in ('file', 'directory', 'symlink', 'root_directory'), \
 
370
                   'invalid file kind %r' % kind
 
371
 
 
372
            if kind == 'root_directory':
 
373
                continue
 
374
            
 
375
            old_path = old_inv.id2path(file_id)
 
376
            new_path = new_inv.id2path(file_id)
 
377
 
 
378
            if specific_files:
 
379
                if (not is_inside_any(specific_files, old_path) 
 
380
                    and not is_inside_any(specific_files, new_path)):
 
381
                    continue
 
382
 
 
383
            if kind == 'file':
 
384
                old_sha1 = old_tree.get_file_sha1(file_id)
 
385
                new_sha1 = new_tree.get_file_sha1(file_id)
 
386
                text_modified = (old_sha1 != new_sha1)
 
387
            else:
 
388
                ## mutter("no text to check for %r %r" % (file_id, kind))
 
389
                text_modified = False
 
390
 
 
391
            # TODO: Can possibly avoid calculating path strings if the
 
392
            # two files are unchanged and their names and parents are
 
393
            # the same and the parents are unchanged all the way up.
 
394
            # May not be worthwhile.
 
395
            
 
396
            if old_path != new_path:
 
397
                delta.renamed.append((old_path, new_path, file_id, kind,
 
398
                                      text_modified))
 
399
            elif text_modified:
 
400
                delta.modified.append((new_path, file_id, kind))
 
401
            elif want_unchanged:
 
402
                delta.unchanged.append((new_path, file_id, kind))
 
403
        else:
 
404
            kind = old_inv.get_file_kind(file_id)
 
405
            old_path = old_inv.id2path(file_id)
 
406
            if specific_files:
 
407
                if not is_inside_any(specific_files, old_path):
 
408
                    continue
 
409
            delta.removed.append((old_path, file_id, kind))
 
410
 
 
411
    mutter('start looking for new files')
 
412
    for file_id in new_inv:
 
413
        if file_id in old_inv:
 
414
            continue
 
415
        new_path = new_inv.id2path(file_id)
 
416
        if specific_files:
 
417
            if not is_inside_any(specific_files, new_path):
 
418
                continue
 
419
        kind = new_inv.get_file_kind(file_id)
 
420
        delta.added.append((new_path, file_id, kind))
 
421
            
 
422
    delta.removed.sort()
 
423
    delta.added.sort()
 
424
    delta.renamed.sort()
 
425
    delta.modified.sort()
 
426
    delta.unchanged.sort()
 
427
 
 
428
    return delta