← 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-20 04:24:35 UTC
  • Revision ID: mbp@sourcefrog.net-20050620042435-7c315b5a93001b89
- add jk's patchwork client

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