/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Martin Pool
  • Date: 2005-06-27 01:39:26 UTC
  • Revision ID: mbp@sourcefrog.net-20050627013926-49413d5928809350
- import effbot.org http client

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