← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Robert Collins
  • Date: 2006-03-28 11:16:28 UTC
  • mto: (1626.2.1 integration)
  • mto: This revision was merged to the branch mainline in revision 1628.
  • Revision ID: robertc@robertcollins.net-20060328111628-47766b0fdfa443ab
Add MergeSort facility to bzrlib.tsort.

Show diffs side-by-side

added added

removed removed

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