← 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-22 09:08:43 UTC
  • Revision ID: mbp@sourcefrog.net-20050622090843-78fe9c62da9ed167
- add john's changeset plugin

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/diff.py
 
1
#! /usr/bin/env python
1
2
# -*- coding: UTF-8 -*-
2
3
 
3
4
# This program is free software; you can redistribute it and/or modify
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.trace import mutter
18
 
from bzrlib.errors import BzrError
19
 
from bzrlib.delta import compare_trees
20
 
 
21
 
# TODO: Rather than building a changeset object, we should probably
22
 
# invoke callbacks on an object.  That object can either accumulate a
23
 
# list, write them out directly, etc etc.
24
 
 
25
 
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):
26
23
    import difflib
27
24
    
28
25
    # FIXME: difflib is wrong if there is no trailing newline.
41
38
    if not oldlines and not newlines:
42
39
        return
43
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
 
44
50
    ud = difflib.unified_diff(oldlines, newlines,
45
 
                              fromfile=old_filename+'\t', 
46
 
                              tofile=new_filename+'\t')
 
51
                              fromfile=old_label, tofile=new_label)
47
52
 
48
 
    ud = list(ud)
49
53
    # work-around for difflib being too smart for its own good
50
54
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
51
55
    if not oldlines:
 
56
        ud = list(ud)
52
57
        ud[2] = ud[2].replace('-1,0', '-0,0')
53
58
    elif not newlines:
 
59
        ud = list(ud)
54
60
        ud[2] = ud[2].replace('+1,0', '+0,0')
55
 
    # work around for difflib emitting random spaces after the label
56
 
    ud[0] = ud[0][:-2] + '\n'
57
 
    ud[1] = ud[1][:-2] + '\n'
58
61
 
59
 
    for line in ud:
60
 
        to_file.write(line)
61
 
        if not line.endswith('\n'):
62
 
            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"
63
65
    print >>to_file
64
66
 
65
67
 
66
 
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,
67
71
                  diff_opts):
68
72
    """Display a diff by calling out to the external diff program."""
69
73
    import sys
98
102
        if not diff_opts:
99
103
            diff_opts = []
100
104
        diffcmd = ['diff',
101
 
                   '--label', old_filename+'\t',
 
105
                   '--label', old_label,
102
106
                   oldtmpf.name,
103
 
                   '--label', new_filename+'\t',
 
107
                   '--label', new_label,
104
108
                   newtmpf.name]
105
109
 
106
110
        # diff only allows one style to be specified; they don't override.
140
144
    finally:
141
145
        oldtmpf.close()                 # and delete
142
146
        newtmpf.close()
143
 
 
144
 
def show_diff(b, from_spec, specific_files, external_diff_options=None,
145
 
              revision2=None, output=None, b2=None):
 
147
    
 
148
 
 
149
 
 
150
def show_diff(b, revision, specific_files, external_diff_options=None):
146
151
    """Shortcut for showing the diff to the working tree.
147
152
 
148
153
    b
149
154
        Branch.
150
155
 
151
156
    revision
152
 
        None for 'basis tree', or otherwise the old revision to compare against.
 
157
        None for each, or otherwise the old revision to compare against.
153
158
    
154
159
    The more general form is show_diff_trees(), where the caller
155
160
    supplies any two trees.
156
161
    """
157
 
    if output is None:
158
 
        import sys
159
 
        output = sys.stdout
160
 
 
161
 
    if from_spec is None:
162
 
        if b2 is None:
163
 
            old_tree = b.basis_tree()
164
 
        else:
165
 
            old_tree = b.working_tree()
166
 
    else:
167
 
        old_tree = b.revision_tree(from_spec.in_history(b).rev_id)
168
 
 
169
 
    if revision2 is None:
170
 
        if b2 is None:
171
 
            new_tree = b.working_tree()
172
 
        else:
173
 
            new_tree = b2.working_tree()
174
 
    else:
175
 
        new_tree = b.revision_tree(revision2.in_history(b).rev_id)
176
 
 
177
 
    return show_diff_trees(old_tree, new_tree, output, specific_files,
178
 
                           external_diff_options)
 
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)
179
173
 
180
174
 
181
175
 
214
208
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
215
209
                          specific_files=specific_files)
216
210
 
217
 
    has_changes = 0
218
211
    for path, file_id, kind in delta.removed:
219
 
        has_changes = 1
220
 
        print >>to_file, '=== removed %s %r' % (kind, path)
221
 
        old_tree.inventory[file_id].diff(diff_file, old_label + path, old_tree,
222
 
                                         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
 
223
220
    for path, file_id, kind in delta.added:
224
 
        has_changes = 1
225
 
        print >>to_file, '=== added %s %r' % (kind, path)
226
 
        new_tree.inventory[file_id].diff(diff_file, new_label + path, new_tree,
227
 
                                         DEVNULL, None, None, to_file, 
228
 
                                         reverse=True)
229
 
    for (old_path, new_path, file_id, kind,
230
 
         text_modified, meta_modified) in delta.renamed:
231
 
        has_changes = 1
232
 
        prop_str = get_prop_change(meta_modified)
233
 
        print >>to_file, '=== renamed %s %r => %r%s' % (
234
 
                          kind, old_path, new_path, prop_str)
235
 
        _maybe_diff_file_or_symlink(old_label, old_path, old_tree, file_id,
236
 
                                    new_label, new_path, new_tree,
237
 
                                    text_modified, kind, to_file, diff_file)
238
 
    for path, file_id, kind, text_modified, meta_modified in delta.modified:
239
 
        has_changes = 1
240
 
        prop_str = get_prop_change(meta_modified)
241
 
        print >>to_file, '=== modified %s %r%s' % (kind, path, 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)
242
231
        if text_modified:
243
 
            _maybe_diff_file_or_symlink(old_label, path, old_tree, file_id,
244
 
                                        new_label, path, new_tree,
245
 
                                        True, kind, to_file, diff_file)
246
 
    return has_changes
 
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
247
372
    
248
 
 
249
 
def get_prop_change(meta_modified):
250
 
    if meta_modified:
251
 
        return " (properties changed)"
252
 
    else:
253
 
        return  ""
254
 
 
255
 
 
256
 
def _maybe_diff_file_or_symlink(old_label, old_path, old_tree, file_id,
257
 
                                new_label, new_path, new_tree, text_modified,
258
 
                                kind, to_file, diff_file):
259
 
    if text_modified:
260
 
        new_entry = new_tree.inventory[file_id]
261
 
        old_tree.inventory[file_id].diff(diff_file,
262
 
                                         old_label + old_path, old_tree,
263
 
                                         new_label + new_path, new_entry, 
264
 
                                         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