/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-05-27 05:10:23 UTC
  • Revision ID: mbp@sourcefrog.net-20050527051023-b8a3681b38a2d228
- merge portable lock module from John

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
74
76
        raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
75
77
                                  to_file)
76
78
 
77
 
    # make sure our own output is properly ordered before the diff
78
 
    to_file.flush()
79
 
 
80
79
    from tempfile import NamedTemporaryFile
81
80
    import os
82
81
 
100
99
        if not diff_opts:
101
100
            diff_opts = []
102
101
        diffcmd = ['diff',
103
 
                   '--label', old_filename+'\t',
 
102
                   '--label', old_label,
104
103
                   oldtmpf.name,
105
 
                   '--label', new_filename+'\t',
 
104
                   '--label', new_label,
106
105
                   newtmpf.name]
107
106
 
108
107
        # diff only allows one style to be specified; they don't override.
142
141
    finally:
143
142
        oldtmpf.close()                 # and delete
144
143
        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):
150
 
    """Shortcut for showing the diff to the working tree.
151
 
 
152
 
    Please use show_diff_trees instead.
153
 
 
154
 
    b
155
 
        Branch.
156
 
 
157
 
    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.
206
 
    
207
 
    The more general form is show_diff_trees(), where the caller
208
 
    supplies any two trees.
209
 
    """
 
144
    
 
145
 
 
146
 
 
147
def show_diff(b, revision, specific_files, external_diff_options=None):
210
148
    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)
 
149
 
 
150
    if revision == None:
 
151
        old_tree = b.basis_tree()
 
152
    else:
 
153
        old_tree = b.revision_tree(b.lookup_revision(revision))
 
154
        
 
155
    new_tree = b.working_tree()
 
156
 
 
157
    show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
 
158
                    external_diff_options)
 
159
 
227
160
 
228
161
 
229
162
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
236
169
    external_diff_options
237
170
        If set, use an external GNU diff and pass these options.
238
171
    """
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/'
 
172
 
 
173
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
 
174
    old_label = ''
 
175
    new_label = ''
258
176
 
259
177
    DEVNULL = '/dev/null'
260
178
    # Windows users, don't panic about this filename -- it is a
264
182
    # TODO: Generation of pseudo-diffs for added/deleted files could
265
183
    # be usefully made into a much faster special case.
266
184
 
267
 
    _raise_if_doubly_unversioned(specific_files, old_tree, new_tree)
268
 
 
269
185
    if external_diff_options:
270
186
        assert isinstance(external_diff_options, basestring)
271
187
        opts = external_diff_options.split()
274
190
    else:
275
191
        diff_file = internal_diff
276
192
    
 
193
 
277
194
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
278
195
                          specific_files=specific_files)
279
196
 
280
 
    has_changes = 0
281
197
    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)
 
198
        print '*** removed %s %r' % (kind, path)
 
199
        if kind == 'file':
 
200
            diff_file(old_label + path,
 
201
                      old_tree.get_file(file_id).readlines(),
 
202
                      DEVNULL, 
 
203
                      [],
 
204
                      to_file)
 
205
 
286
206
    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)
 
207
        print '*** added %s %r' % (kind, path)
 
208
        if kind == 'file':
 
209
            diff_file(DEVNULL,
 
210
                      [],
 
211
                      new_label + path,
 
212
                      new_tree.get_file(file_id).readlines(),
 
213
                      to_file)
 
214
 
 
215
    for old_path, new_path, file_id, kind, text_modified in delta.renamed:
 
216
        print '*** renamed %s %r => %r' % (kind, old_path, new_path)
306
217
        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))
 
218
            diff_file(old_label + old_path,
 
219
                      old_tree.get_file(file_id).readlines(),
 
220
                      new_label + new_path,
 
221
                      new_tree.get_file(file_id).readlines(),
 
222
                      to_file)
 
223
 
 
224
    for path, file_id, kind in delta.modified:
 
225
        print '*** modified %s %r' % (kind, path)
 
226
        if kind == 'file':
 
227
            diff_file(old_label + path,
 
228
                      old_tree.get_file(file_id).readlines(),
 
229
                      new_label + path,
 
230
                      new_tree.get_file(file_id).readlines(),
 
231
                      to_file)
 
232
 
 
233
 
 
234
 
 
235
class TreeDelta(object):
 
236
    """Describes changes from one tree to another.
 
237
 
 
238
    Contains four lists:
 
239
 
 
240
    added
 
241
        (path, id, kind)
 
242
    removed
 
243
        (path, id, kind)
 
244
    renamed
 
245
        (oldpath, newpath, id, kind, text_modified)
 
246
    modified
 
247
        (path, id, kind)
 
248
    unchanged
 
249
        (path, id, kind)
 
250
 
 
251
    Each id is listed only once.
 
252
 
 
253
    Files that are both modified and renamed are listed only in
 
254
    renamed, with the text_modified flag true.
 
255
 
 
256
    The lists are normally sorted when the delta is created.
 
257
    """
 
258
    def __init__(self):
 
259
        self.added = []
 
260
        self.removed = []
 
261
        self.renamed = []
 
262
        self.modified = []
 
263
        self.unchanged = []
 
264
 
 
265
 
 
266
    def touches_file_id(self, file_id):
 
267
        """Return True if file_id is modified by this delta."""
 
268
        for l in self.added, self.removed, self.modified:
 
269
            for v in l:
 
270
                if v[1] == file_id:
 
271
                    return True
 
272
        for v in self.renamed:
 
273
            if v[2] == file_id:
 
274
                return True
 
275
        return False
 
276
            
 
277
 
 
278
    def show(self, to_file, show_ids=False, show_unchanged=False):
 
279
        def show_list(files):
 
280
            for path, fid, kind in files:
 
281
                if kind == 'directory':
 
282
                    path += '/'
 
283
                elif kind == 'symlink':
 
284
                    path += '@'
 
285
                    
 
286
                if show_ids:
 
287
                    print >>to_file, '  %-30s %s' % (path, fid)
 
288
                else:
 
289
                    print >>to_file, ' ', path
 
290
            
 
291
        if self.removed:
 
292
            print >>to_file, 'removed:'
 
293
            show_list(self.removed)
 
294
                
 
295
        if self.added:
 
296
            print >>to_file, 'added:'
 
297
            show_list(self.added)
 
298
 
 
299
        if self.renamed:
 
300
            print >>to_file, 'renamed:'
 
301
            for oldpath, newpath, fid, kind, text_modified in self.renamed:
 
302
                if show_ids:
 
303
                    print >>to_file, '  %s => %s %s' % (oldpath, newpath, fid)
 
304
                else:
 
305
                    print >>to_file, '  %s => %s' % (oldpath, newpath)
 
306
                    
 
307
        if self.modified:
 
308
            print >>to_file, 'modified:'
 
309
            show_list(self.modified)
 
310
            
 
311
        if show_unchanged and self.unchanged:
 
312
            print >>to_file, 'unchanged:'
 
313
            show_list(self.unchanged)
 
314
 
 
315
 
 
316
 
 
317
def compare_trees(old_tree, new_tree, want_unchanged, specific_files=None):
 
318
    """Describe changes from one tree to another.
 
319
 
 
320
    Returns a TreeDelta with details of added, modified, renamed, and
 
321
    deleted entries.
 
322
 
 
323
    The root entry is specifically exempt.
 
324
 
 
325
    This only considers versioned files.
 
326
 
 
327
    want_unchanged
 
328
        If true, also list files unchanged from one version to
 
329
        the next.
 
330
 
 
331
    specific_files
 
332
        If true, only check for changes to specified names or
 
333
        files within them.
 
334
    """
 
335
 
 
336
    from osutils import is_inside_any
323
337
    
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)
 
338
    old_inv = old_tree.inventory
 
339
    new_inv = new_tree.inventory
 
340
    delta = TreeDelta()
 
341
    mutter('start compare_trees')
 
342
 
 
343
    # TODO: match for specific files can be rather smarter by finding
 
344
    # the IDs of those files up front and then considering only that.
 
345
 
 
346
    for file_id in old_tree:
 
347
        if file_id in new_tree:
 
348
            kind = old_inv.get_file_kind(file_id)
 
349
            assert kind == new_inv.get_file_kind(file_id)
 
350
            
 
351
            assert kind in ('file', 'directory', 'symlink', 'root_directory'), \
 
352
                   'invalid file kind %r' % kind
 
353
 
 
354
            if kind == 'root_directory':
 
355
                continue
 
356
            
 
357
            old_path = old_inv.id2path(file_id)
 
358
            new_path = new_inv.id2path(file_id)
 
359
 
 
360
            if specific_files:
 
361
                if (not is_inside_any(specific_files, old_path) 
 
362
                    and not is_inside_any(specific_files, new_path)):
 
363
                    continue
 
364
 
 
365
            if kind == 'file':
 
366
                old_sha1 = old_tree.get_file_sha1(file_id)
 
367
                new_sha1 = new_tree.get_file_sha1(file_id)
 
368
                text_modified = (old_sha1 != new_sha1)
 
369
            else:
 
370
                ## mutter("no text to check for %r %r" % (file_id, kind))
 
371
                text_modified = False
 
372
 
 
373
            # TODO: Can possibly avoid calculating path strings if the
 
374
            # two files are unchanged and their names and parents are
 
375
            # the same and the parents are unchanged all the way up.
 
376
            # May not be worthwhile.
 
377
            
 
378
            if old_path != new_path:
 
379
                delta.renamed.append((old_path, new_path, file_id, kind,
 
380
                                      text_modified))
 
381
            elif text_modified:
 
382
                delta.modified.append((new_path, file_id, kind))
 
383
            elif want_unchanged:
 
384
                delta.unchanged.append((new_path, file_id, kind))
 
385
        else:
 
386
            kind = old_inv.get_file_kind(file_id)
 
387
            old_path = old_inv.id2path(file_id)
 
388
            if specific_files:
 
389
                if not is_inside_any(specific_files, old_path):
 
390
                    continue
 
391
            delta.removed.append((old_path, file_id, kind))
 
392
 
 
393
    mutter('start looking for new files')
 
394
    for file_id in new_inv:
 
395
        if file_id in old_inv:
 
396
            continue
 
397
        new_path = new_inv.id2path(file_id)
 
398
        if specific_files:
 
399
            if not is_inside_any(specific_files, new_path):
 
400
                continue
 
401
        kind = new_inv.get_file_kind(file_id)
 
402
        delta.added.append((new_path, file_id, kind))
 
403
            
 
404
    delta.removed.sort()
 
405
    delta.added.sort()
 
406
    delta.renamed.sort()
 
407
    delta.modified.sort()
 
408
    delta.unchanged.sort()
 
409
 
 
410
    return delta