/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-22 08:07:30 UTC
  • Revision ID: mbp@sourcefrog.net-20050622080730-b5d1f2f51af71245
- new TestBase.build_tree helper method

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/diff.py
1
 
# Copyright (C) 2004, 2005, 2006 Canonical Ltd.
 
1
#! /usr/bin/env python
 
2
# -*- coding: UTF-8 -*-
2
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
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
 
from bzrlib.delta import compare_trees
18
 
from bzrlib.errors import BzrError
19
 
import bzrlib.errors as errors
20
 
from bzrlib.symbol_versioning import *
21
 
from bzrlib.trace import mutter
22
 
 
23
 
# TODO: Rather than building a changeset object, we should probably
24
 
# invoke callbacks on an object.  That object can either accumulate a
25
 
# list, write them out directly, etc etc.
26
 
 
27
 
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file):
 
18
from trace import mutter
 
19
from errors import BzrError
 
20
 
 
21
 
 
22
def internal_diff(old_label, oldlines, new_label, newlines, to_file):
28
23
    import difflib
29
24
    
30
25
    # FIXME: difflib is wrong if there is no trailing newline.
43
38
    if not oldlines and not newlines:
44
39
        return
45
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
 
46
50
    ud = difflib.unified_diff(oldlines, newlines,
47
 
                              fromfile=old_filename+'\t', 
48
 
                              tofile=new_filename+'\t')
 
51
                              fromfile=old_label, tofile=new_label)
49
52
 
50
 
    ud = list(ud)
51
53
    # work-around for difflib being too smart for its own good
52
54
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
53
55
    if not oldlines:
 
56
        ud = list(ud)
54
57
        ud[2] = ud[2].replace('-1,0', '-0,0')
55
58
    elif not newlines:
 
59
        ud = list(ud)
56
60
        ud[2] = ud[2].replace('+1,0', '+0,0')
57
 
    # work around for difflib emitting random spaces after the label
58
 
    ud[0] = ud[0][:-2] + '\n'
59
 
    ud[1] = ud[1][:-2] + '\n'
60
61
 
61
 
    for line in ud:
62
 
        to_file.write(line)
63
 
        if not line.endswith('\n'):
64
 
            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"
65
65
    print >>to_file
66
66
 
67
67
 
68
 
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,
69
71
                  diff_opts):
70
72
    """Display a diff by calling out to the external diff program."""
71
73
    import sys
100
102
        if not diff_opts:
101
103
            diff_opts = []
102
104
        diffcmd = ['diff',
103
 
                   '--label', old_filename+'\t',
 
105
                   '--label', old_label,
104
106
                   oldtmpf.name,
105
 
                   '--label', new_filename+'\t',
 
107
                   '--label', new_label,
106
108
                   newtmpf.name]
107
109
 
108
110
        # diff only allows one style to be specified; they don't override.
142
144
    finally:
143
145
        oldtmpf.close()                 # and delete
144
146
        newtmpf.close()
145
 
 
146
 
 
147
 
@deprecated_function(zero_eight)
148
 
def show_diff(b, from_spec, specific_files, external_diff_options=None,
149
 
              revision2=None, output=None, b2=None):
 
147
    
 
148
 
 
149
 
 
150
def show_diff(b, revision, specific_files, external_diff_options=None):
150
151
    """Shortcut for showing the diff to the working tree.
151
152
 
152
 
    Please use show_diff_trees instead.
153
 
 
154
153
    b
155
154
        Branch.
156
155
 
157
156
    revision
158
 
        None for 'basis tree', or otherwise the old revision to compare against.
159
 
    
160
 
    The more general form is show_diff_trees(), where the caller
161
 
    supplies any two trees.
162
 
    """
163
 
    if output is None:
164
 
        import sys
165
 
        output = sys.stdout
166
 
 
167
 
    if from_spec is None:
168
 
        old_tree = b.bzrdir.open_workingtree()
169
 
        if b2 is None:
170
 
            old_tree = old_tree = old_tree.basis_tree()
171
 
    else:
172
 
        old_tree = b.repository.revision_tree(from_spec.in_history(b).rev_id)
173
 
 
174
 
    if revision2 is None:
175
 
        if b2 is None:
176
 
            new_tree = b.bzrdir.open_workingtree()
177
 
        else:
178
 
            new_tree = b2.bzrdir.open_workingtree()
179
 
    else:
180
 
        new_tree = b.repository.revision_tree(revision2.in_history(b).rev_id)
181
 
 
182
 
    return show_diff_trees(old_tree, new_tree, output, specific_files,
183
 
                           external_diff_options)
184
 
 
185
 
 
186
 
def diff_cmd_helper(tree, specific_files, external_diff_options, 
187
 
                    old_revision_spec=None, new_revision_spec=None):
188
 
    """Helper for cmd_diff.
189
 
 
190
 
   tree 
191
 
        A WorkingTree
192
 
 
193
 
    specific_files
194
 
        The specific files to compare, or None
195
 
 
196
 
    external_diff_options
197
 
        If non-None, run an external diff, and pass it these options
198
 
 
199
 
    old_revision_spec
200
 
        If None, use basis tree as old revision, otherwise use the tree for
201
 
        the specified revision. 
202
 
 
203
 
    new_revision_spec
204
 
        If None, use working tree as new revision, otherwise use the tree for
205
 
        the specified revision.
 
157
        None for each, or otherwise the old revision to compare against.
206
158
    
207
159
    The more general form is show_diff_trees(), where the caller
208
160
    supplies any two trees.
209
161
    """
210
162
    import sys
211
 
    output = sys.stdout
212
 
    def spec_tree(spec):
213
 
        revision_id = spec.in_store(tree.branch).rev_id
214
 
        return tree.branch.repository.revision_tree(revision_id)
215
 
    if old_revision_spec is None:
216
 
        old_tree = tree.basis_tree()
217
 
    else:
218
 
        old_tree = spec_tree(old_revision_spec)
219
 
 
220
 
    if new_revision_spec is None:
221
 
        new_tree = tree
222
 
    else:
223
 
        new_tree = spec_tree(new_revision_spec)
224
 
 
225
 
    return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
226
 
                           external_diff_options)
 
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
 
227
174
 
228
175
 
229
176
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
236
183
    external_diff_options
237
184
        If set, use an external GNU diff and pass these options.
238
185
    """
239
 
    old_tree.lock_read()
240
 
    try:
241
 
        new_tree.lock_read()
242
 
        try:
243
 
            return _show_diff_trees(old_tree, new_tree, to_file,
244
 
                                    specific_files, external_diff_options)
245
 
        finally:
246
 
            new_tree.unlock()
247
 
    finally:
248
 
        old_tree.unlock()
249
 
 
250
 
 
251
 
def _show_diff_trees(old_tree, new_tree, to_file,
252
 
                     specific_files, external_diff_options):
253
 
 
254
 
    # TODO: Options to control putting on a prefix or suffix, perhaps
255
 
    # as a format string?
256
 
    old_label = 'a/'
257
 
    new_label = 'b/'
 
186
 
 
187
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
 
188
    old_label = ''
 
189
    new_label = ''
258
190
 
259
191
    DEVNULL = '/dev/null'
260
192
    # Windows users, don't panic about this filename -- it is a
264
196
    # TODO: Generation of pseudo-diffs for added/deleted files could
265
197
    # be usefully made into a much faster special case.
266
198
 
267
 
    _raise_if_doubly_unversioned(specific_files, old_tree, new_tree)
268
 
 
269
199
    if external_diff_options:
270
200
        assert isinstance(external_diff_options, basestring)
271
201
        opts = external_diff_options.split()
274
204
    else:
275
205
        diff_file = internal_diff
276
206
    
 
207
 
277
208
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
278
209
                          specific_files=specific_files)
279
210
 
280
 
    has_changes = 0
281
211
    for path, file_id, kind in delta.removed:
282
 
        has_changes = 1
283
 
        print >>to_file, '=== removed %s %r' % (kind, old_label + path)
284
 
        old_tree.inventory[file_id].diff(diff_file, old_label + path, old_tree,
285
 
                                         DEVNULL, None, None, to_file)
 
212
        print >>to_file, '*** 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
 
286
220
    for path, file_id, kind in delta.added:
287
 
        has_changes = 1
288
 
        print >>to_file, '=== added %s %r' % (kind, new_label + path)
289
 
        new_tree.inventory[file_id].diff(diff_file, new_label + path, new_tree,
290
 
                                         DEVNULL, None, None, to_file, 
291
 
                                         reverse=True)
292
 
    for (old_path, new_path, file_id, kind,
293
 
         text_modified, meta_modified) in delta.renamed:
294
 
        has_changes = 1
295
 
        prop_str = get_prop_change(meta_modified)
296
 
        print >>to_file, '=== renamed %s %r => %r%s' % (
297
 
                    kind, old_label + old_path, new_label + new_path, prop_str)
298
 
        _maybe_diff_file_or_symlink(old_label, old_path, old_tree, file_id,
299
 
                                    new_label, new_path, new_tree,
300
 
                                    text_modified, kind, to_file, diff_file)
301
 
    for path, file_id, kind, text_modified, meta_modified in delta.modified:
302
 
        has_changes = 1
303
 
        prop_str = get_prop_change(meta_modified)
304
 
        print >>to_file, '=== modified %s %r%s' % (kind, old_label + path,
305
 
                    prop_str)
 
221
        print >>to_file, '*** 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 >>to_file, '*** renamed %s %r => %r' % (kind, old_path, new_path)
306
231
        if text_modified:
307
 
            _maybe_diff_file_or_symlink(old_label, path, old_tree, file_id,
308
 
                                        new_label, path, new_tree,
309
 
                                        True, kind, to_file, diff_file)
310
 
 
311
 
    return has_changes
312
 
 
313
 
 
314
 
def _raise_if_doubly_unversioned(specific_files, old_tree, new_tree):
315
 
    """Complain if paths are not versioned in either tree."""
316
 
    if not specific_files:
317
 
        return
318
 
    old_unversioned = old_tree.filter_unversioned_files(specific_files)
319
 
    new_unversioned = new_tree.filter_unversioned_files(specific_files)
320
 
    unversioned = old_unversioned.intersection(new_unversioned)
321
 
    if unversioned:
322
 
        raise errors.PathsNotVersionedError(sorted(unversioned))
 
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 >>to_file, '*** 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 __eq__(self, other):
 
280
        if not isinstance(other, TreeDelta):
 
281
            return False
 
282
        return self.added == other.added \
 
283
               and self.removed == other.removed \
 
284
               and self.renamed == other.renamed \
 
285
               and self.modified == other.modified \
 
286
               and self.unchanged == other.unchanged
 
287
 
 
288
    def __ne__(self, other):
 
289
        return not (self == other)
 
290
 
 
291
    def __repr__(self):
 
292
        return "TreeDelta(added=%r, removed=%r, renamed=%r, modified=%r," \
 
293
            " unchanged=%r)" % (self.added, self.removed, self.renamed,
 
294
            self.modified, self.unchanged)
 
295
 
 
296
    def has_changed(self):
 
297
        changes = len(self.added) + len(self.removed) + len(self.renamed)
 
298
        changes += len(self.modified) 
 
299
        return (changes != 0)
 
300
 
 
301
    def touches_file_id(self, file_id):
 
302
        """Return True if file_id is modified by this delta."""
 
303
        for l in self.added, self.removed, self.modified:
 
304
            for v in l:
 
305
                if v[1] == file_id:
 
306
                    return True
 
307
        for v in self.renamed:
 
308
            if v[2] == file_id:
 
309
                return True
 
310
        return False
 
311
            
 
312
 
 
313
    def show(self, to_file, show_ids=False, show_unchanged=False):
 
314
        def show_list(files):
 
315
            for path, fid, kind in files:
 
316
                if kind == 'directory':
 
317
                    path += '/'
 
318
                elif kind == 'symlink':
 
319
                    path += '@'
 
320
                    
 
321
                if show_ids:
 
322
                    print >>to_file, '  %-30s %s' % (path, fid)
 
323
                else:
 
324
                    print >>to_file, ' ', path
 
325
            
 
326
        if self.removed:
 
327
            print >>to_file, 'removed:'
 
328
            show_list(self.removed)
 
329
                
 
330
        if self.added:
 
331
            print >>to_file, 'added:'
 
332
            show_list(self.added)
 
333
 
 
334
        if self.renamed:
 
335
            print >>to_file, 'renamed:'
 
336
            for oldpath, newpath, fid, kind, text_modified in self.renamed:
 
337
                if show_ids:
 
338
                    print >>to_file, '  %s => %s %s' % (oldpath, newpath, fid)
 
339
                else:
 
340
                    print >>to_file, '  %s => %s' % (oldpath, newpath)
 
341
                    
 
342
        if self.modified:
 
343
            print >>to_file, 'modified:'
 
344
            show_list(self.modified)
 
345
            
 
346
        if show_unchanged and self.unchanged:
 
347
            print >>to_file, 'unchanged:'
 
348
            show_list(self.unchanged)
 
349
 
 
350
 
 
351
 
 
352
def compare_trees(old_tree, new_tree, want_unchanged=False, specific_files=None):
 
353
    """Describe changes from one tree to another.
 
354
 
 
355
    Returns a TreeDelta with details of added, modified, renamed, and
 
356
    deleted entries.
 
357
 
 
358
    The root entry is specifically exempt.
 
359
 
 
360
    This only considers versioned files.
 
361
 
 
362
    want_unchanged
 
363
        If true, also list files unchanged from one version to
 
364
        the next.
 
365
 
 
366
    specific_files
 
367
        If true, only check for changes to specified names or
 
368
        files within them.
 
369
    """
 
370
 
 
371
    from osutils import is_inside_any
323
372
    
324
 
 
325
 
def get_prop_change(meta_modified):
326
 
    if meta_modified:
327
 
        return " (properties changed)"
328
 
    else:
329
 
        return  ""
330
 
 
331
 
 
332
 
def _maybe_diff_file_or_symlink(old_label, old_path, old_tree, file_id,
333
 
                                new_label, new_path, new_tree, text_modified,
334
 
                                kind, to_file, diff_file):
335
 
    if text_modified:
336
 
        new_entry = new_tree.inventory[file_id]
337
 
        old_tree.inventory[file_id].diff(diff_file,
338
 
                                         old_label + old_path, old_tree,
339
 
                                         new_label + new_path, new_entry, 
340
 
                                         new_tree, to_file)
 
373
    old_inv = old_tree.inventory
 
374
    new_inv = new_tree.inventory
 
375
    delta = TreeDelta()
 
376
    mutter('start compare_trees')
 
377
 
 
378
    # TODO: match for specific files can be rather smarter by finding
 
379
    # the IDs of those files up front and then considering only that.
 
380
 
 
381
    for file_id in old_tree:
 
382
        if file_id in new_tree:
 
383
            kind = old_inv.get_file_kind(file_id)
 
384
            assert kind == new_inv.get_file_kind(file_id)
 
385
            
 
386
            assert kind in ('file', 'directory', 'symlink', 'root_directory'), \
 
387
                   'invalid file kind %r' % kind
 
388
 
 
389
            if kind == 'root_directory':
 
390
                continue
 
391
            
 
392
            old_path = old_inv.id2path(file_id)
 
393
            new_path = new_inv.id2path(file_id)
 
394
 
 
395
            if specific_files:
 
396
                if (not is_inside_any(specific_files, old_path) 
 
397
                    and not is_inside_any(specific_files, new_path)):
 
398
                    continue
 
399
 
 
400
            if kind == 'file':
 
401
                old_sha1 = old_tree.get_file_sha1(file_id)
 
402
                new_sha1 = new_tree.get_file_sha1(file_id)
 
403
                text_modified = (old_sha1 != new_sha1)
 
404
            else:
 
405
                ## mutter("no text to check for %r %r" % (file_id, kind))
 
406
                text_modified = False
 
407
 
 
408
            # TODO: Can possibly avoid calculating path strings if the
 
409
            # two files are unchanged and their names and parents are
 
410
            # the same and the parents are unchanged all the way up.
 
411
            # May not be worthwhile.
 
412
            
 
413
            if old_path != new_path:
 
414
                delta.renamed.append((old_path, new_path, file_id, kind,
 
415
                                      text_modified))
 
416
            elif text_modified:
 
417
                delta.modified.append((new_path, file_id, kind))
 
418
            elif want_unchanged:
 
419
                delta.unchanged.append((new_path, file_id, kind))
 
420
        else:
 
421
            kind = old_inv.get_file_kind(file_id)
 
422
            old_path = old_inv.id2path(file_id)
 
423
            if specific_files:
 
424
                if not is_inside_any(specific_files, old_path):
 
425
                    continue
 
426
            delta.removed.append((old_path, file_id, kind))
 
427
 
 
428
    mutter('start looking for new files')
 
429
    for file_id in new_inv:
 
430
        if file_id in old_inv:
 
431
            continue
 
432
        new_path = new_inv.id2path(file_id)
 
433
        if specific_files:
 
434
            if not is_inside_any(specific_files, new_path):
 
435
                continue
 
436
        kind = new_inv.get_file_kind(file_id)
 
437
        delta.added.append((new_path, file_id, kind))
 
438
            
 
439
    delta.removed.sort()
 
440
    delta.added.sort()
 
441
    delta.renamed.sort()
 
442
    delta.modified.sort()
 
443
    delta.unchanged.sort()
 
444
 
 
445
    return delta