← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Ian Clatworthy
  • Date: 2007-06-06 14:06:14 UTC
  • mto: This revision was merged to the branch mainline in revision 2520.
  • Revision ID: ian.clatworthy@internode.on.net-20070606140614-yp66v5i1gm5kruqp
https://launchpad.net/bugs/115491
Fixes #115491 - 'branch lp:projname' now creates ./projname as exected

Show diffs side-by-side

added added

removed removed

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