/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-06-01 03:16:18 UTC
  • Revision ID: mbp@sourcefrog.net-20050601031618-07f87942ce0e2c25
- fix locking for RemoteBranch
- add RemoteBranch.revision_store

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