← 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-10 09:08:09 UTC
  • Revision ID: mbp@sourcefrog.net-20050610090809-648401fe0bde7b7a
doc

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.patiencediff import SequenceMatcher, unified_diff
21
 
from bzrlib.symbol_versioning import *
22
 
from bzrlib.textfile import check_text_lines
23
 
from bzrlib.trace import mutter
24
 
 
25
 
# TODO: Rather than building a changeset object, we should probably
26
 
# invoke callbacks on an object.  That object can either accumulate a
27
 
# list, write them out directly, etc etc.
28
 
 
29
 
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
30
 
                  allow_binary=False, sequence_matcher=None):
 
18
from trace import mutter
 
19
from errors import BzrError
 
20
 
 
21
 
 
22
def internal_diff(old_label, oldlines, new_label, newlines, to_file):
 
23
    import difflib
 
24
    
31
25
    # FIXME: difflib is wrong if there is no trailing newline.
32
26
    # The syntax used by patch seems to be "\ No newline at
33
27
    # end of file" following the last diff line from that
43
37
    # both sequences are empty.
44
38
    if not oldlines and not newlines:
45
39
        return
46
 
    
47
 
    if allow_binary is False:
48
 
        check_text_lines(oldlines)
49
 
        check_text_lines(newlines)
50
 
 
51
 
    if sequence_matcher is None:
52
 
        sequence_matcher = SequenceMatcher
53
 
    ud = unified_diff(oldlines, newlines,
54
 
                      fromfile=old_filename+'\t', 
55
 
                      tofile=new_filename+'\t',
56
 
                      sequencematcher=sequence_matcher)
57
 
 
58
 
    ud = list(ud)
 
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
 
 
50
    ud = difflib.unified_diff(oldlines, newlines,
 
51
                              fromfile=old_label, tofile=new_label)
 
52
 
59
53
    # work-around for difflib being too smart for its own good
60
54
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
61
55
    if not oldlines:
 
56
        ud = list(ud)
62
57
        ud[2] = ud[2].replace('-1,0', '-0,0')
63
58
    elif not newlines:
 
59
        ud = list(ud)
64
60
        ud[2] = ud[2].replace('+1,0', '+0,0')
65
 
    # work around for difflib emitting random spaces after the label
66
 
    ud[0] = ud[0][:-2] + '\n'
67
 
    ud[1] = ud[1][:-2] + '\n'
68
61
 
69
 
    for line in ud:
70
 
        to_file.write(line)
71
 
        if not line.endswith('\n'):
72
 
            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"
73
65
    print >>to_file
74
66
 
75
67
 
76
 
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,
77
71
                  diff_opts):
78
72
    """Display a diff by calling out to the external diff program."""
79
73
    import sys
108
102
        if not diff_opts:
109
103
            diff_opts = []
110
104
        diffcmd = ['diff',
111
 
                   '--label', old_filename+'\t',
 
105
                   '--label', old_label,
112
106
                   oldtmpf.name,
113
 
                   '--label', new_filename+'\t',
 
107
                   '--label', new_label,
114
108
                   newtmpf.name]
115
109
 
116
110
        # diff only allows one style to be specified; they don't override.
150
144
    finally:
151
145
        oldtmpf.close()                 # and delete
152
146
        newtmpf.close()
153
 
 
154
 
 
155
 
@deprecated_function(zero_eight)
156
 
def show_diff(b, from_spec, specific_files, external_diff_options=None,
157
 
              revision2=None, output=None, b2=None):
 
147
    
 
148
 
 
149
 
 
150
def show_diff(b, revision, specific_files, external_diff_options=None):
158
151
    """Shortcut for showing the diff to the working tree.
159
152
 
160
 
    Please use show_diff_trees instead.
161
 
 
162
153
    b
163
154
        Branch.
164
155
 
165
156
    revision
166
 
        None for 'basis tree', or otherwise the old revision to compare against.
167
 
    
168
 
    The more general form is show_diff_trees(), where the caller
169
 
    supplies any two trees.
170
 
    """
171
 
    if output is None:
172
 
        import sys
173
 
        output = sys.stdout
174
 
 
175
 
    if from_spec is None:
176
 
        old_tree = b.bzrdir.open_workingtree()
177
 
        if b2 is None:
178
 
            old_tree = old_tree = old_tree.basis_tree()
179
 
    else:
180
 
        old_tree = b.repository.revision_tree(from_spec.in_history(b).rev_id)
181
 
 
182
 
    if revision2 is None:
183
 
        if b2 is None:
184
 
            new_tree = b.bzrdir.open_workingtree()
185
 
        else:
186
 
            new_tree = b2.bzrdir.open_workingtree()
187
 
    else:
188
 
        new_tree = b.repository.revision_tree(revision2.in_history(b).rev_id)
189
 
 
190
 
    return show_diff_trees(old_tree, new_tree, output, specific_files,
191
 
                           external_diff_options)
192
 
 
193
 
 
194
 
def diff_cmd_helper(tree, specific_files, external_diff_options, 
195
 
                    old_revision_spec=None, new_revision_spec=None,
196
 
                    old_label='a/', new_label='b/'):
197
 
    """Helper for cmd_diff.
198
 
 
199
 
   tree 
200
 
        A WorkingTree
201
 
 
202
 
    specific_files
203
 
        The specific files to compare, or None
204
 
 
205
 
    external_diff_options
206
 
        If non-None, run an external diff, and pass it these options
207
 
 
208
 
    old_revision_spec
209
 
        If None, use basis tree as old revision, otherwise use the tree for
210
 
        the specified revision. 
211
 
 
212
 
    new_revision_spec
213
 
        If None, use working tree as new revision, otherwise use the tree for
214
 
        the specified revision.
 
157
        None for each, or otherwise the old revision to compare against.
215
158
    
216
159
    The more general form is show_diff_trees(), where the caller
217
160
    supplies any two trees.
218
161
    """
219
162
    import sys
220
 
    output = sys.stdout
221
 
    def spec_tree(spec):
222
 
        revision_id = spec.in_store(tree.branch).rev_id
223
 
        return tree.branch.repository.revision_tree(revision_id)
224
 
    if old_revision_spec is None:
225
 
        old_tree = tree.basis_tree()
226
 
    else:
227
 
        old_tree = spec_tree(old_revision_spec)
228
 
 
229
 
    if new_revision_spec is None:
230
 
        new_tree = tree
231
 
    else:
232
 
        new_tree = spec_tree(new_revision_spec)
233
 
 
234
 
    return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
235
 
                           external_diff_options,
236
 
                           old_label=old_label, new_label=new_label)
 
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
 
237
174
 
238
175
 
239
176
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
240
 
                    external_diff_options=None,
241
 
                    old_label='a/', new_label='b/'):
 
177
                    external_diff_options=None):
242
178
    """Show in text form the changes from one tree to another.
243
179
 
244
180
    to_files
247
183
    external_diff_options
248
184
        If set, use an external GNU diff and pass these options.
249
185
    """
250
 
    old_tree.lock_read()
251
 
    try:
252
 
        new_tree.lock_read()
253
 
        try:
254
 
            return _show_diff_trees(old_tree, new_tree, to_file,
255
 
                                    specific_files, external_diff_options,
256
 
                                    old_label=old_label, new_label=new_label)
257
 
        finally:
258
 
            new_tree.unlock()
259
 
    finally:
260
 
        old_tree.unlock()
261
 
 
262
 
 
263
 
def _show_diff_trees(old_tree, new_tree, to_file,
264
 
                     specific_files, external_diff_options, 
265
 
                     old_label='a/', 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 = ''
266
190
 
267
191
    DEVNULL = '/dev/null'
268
192
    # Windows users, don't panic about this filename -- it is a
272
196
    # TODO: Generation of pseudo-diffs for added/deleted files could
273
197
    # be usefully made into a much faster special case.
274
198
 
275
 
    _raise_if_doubly_unversioned(specific_files, old_tree, new_tree)
276
 
 
277
199
    if external_diff_options:
278
200
        assert isinstance(external_diff_options, basestring)
279
201
        opts = external_diff_options.split()
282
204
    else:
283
205
        diff_file = internal_diff
284
206
    
 
207
 
285
208
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
286
209
                          specific_files=specific_files)
287
210
 
288
 
    has_changes = 0
289
211
    for path, file_id, kind in delta.removed:
290
 
        has_changes = 1
291
 
        print >>to_file, '=== removed %s %r' % (kind, path)
292
 
        old_tree.inventory[file_id].diff(diff_file, old_label + path, old_tree,
293
 
                                         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
 
294
220
    for path, file_id, kind in delta.added:
295
 
        has_changes = 1
296
 
        print >>to_file, '=== added %s %r' % (kind, path)
297
 
        new_tree.inventory[file_id].diff(diff_file, new_label + path, new_tree,
298
 
                                         DEVNULL, None, None, to_file, 
299
 
                                         reverse=True)
300
 
    for (old_path, new_path, file_id, kind,
301
 
         text_modified, meta_modified) in delta.renamed:
302
 
        has_changes = 1
303
 
        prop_str = get_prop_change(meta_modified)
304
 
        print >>to_file, '=== renamed %s %r => %r%s' % (
305
 
                    kind, old_path, new_path, prop_str)
306
 
        _maybe_diff_file_or_symlink(old_label, old_path, old_tree, file_id,
307
 
                                    new_label, new_path, new_tree,
308
 
                                    text_modified, kind, to_file, diff_file)
309
 
    for path, file_id, kind, text_modified, meta_modified in delta.modified:
310
 
        has_changes = 1
311
 
        prop_str = get_prop_change(meta_modified)
312
 
        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)
313
231
        if text_modified:
314
 
            _maybe_diff_file_or_symlink(old_label, path, old_tree, file_id,
315
 
                                        new_label, path, new_tree,
316
 
                                        True, kind, to_file, diff_file)
317
 
 
318
 
    return has_changes
319
 
 
320
 
 
321
 
def _raise_if_doubly_unversioned(specific_files, old_tree, new_tree):
322
 
    """Complain if paths are not versioned in either tree."""
323
 
    if not specific_files:
324
 
        return
325
 
    old_unversioned = old_tree.filter_unversioned_files(specific_files)
326
 
    new_unversioned = new_tree.filter_unversioned_files(specific_files)
327
 
    unversioned = old_unversioned.intersection(new_unversioned)
328
 
    if unversioned:
329
 
        raise errors.PathsNotVersionedError(sorted(unversioned))
330
 
    
331
 
 
332
 
def _raise_if_nonexistent(paths, old_tree, new_tree):
333
 
    """Complain if paths are not in either inventory or tree.
334
 
 
335
 
    It's OK with the files exist in either tree's inventory, or 
336
 
    if they exist in the tree but are not versioned.
337
 
    
338
 
    This can be used by operations such as bzr status that can accept
339
 
    unknown or ignored files.
340
 
    """
341
 
    mutter("check paths: %r", paths)
342
 
    if not paths:
343
 
        return
344
 
    s = old_tree.filter_unversioned_files(paths)
345
 
    s = new_tree.filter_unversioned_files(s)
346
 
    s = [path for path in s if not new_tree.has_filename(path)]
347
 
    if s:
348
 
        raise errors.PathsDoNotExist(sorted(s))
349
 
 
350
 
 
351
 
def get_prop_change(meta_modified):
352
 
    if meta_modified:
353
 
        return " (properties changed)"
354
 
    else:
355
 
        return  ""
356
 
 
357
 
 
358
 
def _maybe_diff_file_or_symlink(old_label, old_path, old_tree, file_id,
359
 
                                new_label, new_path, new_tree, text_modified,
360
 
                                kind, to_file, diff_file):
361
 
    if text_modified:
362
 
        new_entry = new_tree.inventory[file_id]
363
 
        old_tree.inventory[file_id].diff(diff_file,
364
 
                                         old_label + old_path, old_tree,
365
 
                                         new_label + new_path, new_entry, 
366
 
                                         new_tree, to_file)
 
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
 
360
    
 
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