/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-28 05:33:40 UTC
  • Revision ID: mbp@sourcefrog.net-20050628053340-ea73b03fbcde9c46
- Remove XMLMixin class in favour of simple pack_xml, unpack_xml functions
  called as needed.  

- Avoid importing xml and ElementTree library unless needed.

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
 
18
from trace import mutter
 
19
from errors import BzrError
 
20
 
22
21
 
23
22
# TODO: Rather than building a changeset object, we should probably
24
23
# invoke callbacks on an object.  That object can either accumulate a
25
24
# list, write them out directly, etc etc.
26
25
 
27
 
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file):
 
26
def internal_diff(old_label, oldlines, new_label, newlines, to_file):
28
27
    import difflib
29
28
    
30
29
    # FIXME: difflib is wrong if there is no trailing newline.
43
42
    if not oldlines and not newlines:
44
43
        return
45
44
 
 
45
    nonl = False
 
46
 
 
47
    if oldlines and (oldlines[-1][-1] != '\n'):
 
48
        oldlines[-1] += '\n'
 
49
        nonl = True
 
50
    if newlines and (newlines[-1][-1] != '\n'):
 
51
        newlines[-1] += '\n'
 
52
        nonl = True
 
53
 
46
54
    ud = difflib.unified_diff(oldlines, newlines,
47
 
                              fromfile=old_filename+'\t', 
48
 
                              tofile=new_filename+'\t')
 
55
                              fromfile=old_label, tofile=new_label)
49
56
 
50
 
    ud = list(ud)
51
57
    # work-around for difflib being too smart for its own good
52
58
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
53
59
    if not oldlines:
 
60
        ud = list(ud)
54
61
        ud[2] = ud[2].replace('-1,0', '-0,0')
55
62
    elif not newlines:
 
63
        ud = list(ud)
56
64
        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
65
 
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")
 
66
    to_file.writelines(ud)
 
67
    if nonl:
 
68
        print >>to_file, "\\ No newline at end of file"
65
69
    print >>to_file
66
70
 
67
71
 
68
 
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
 
72
 
 
73
 
 
74
def external_diff(old_label, oldlines, new_label, newlines, to_file,
69
75
                  diff_opts):
70
76
    """Display a diff by calling out to the external diff program."""
71
77
    import sys
100
106
        if not diff_opts:
101
107
            diff_opts = []
102
108
        diffcmd = ['diff',
103
 
                   '--label', old_filename+'\t',
 
109
                   '--label', old_label,
104
110
                   oldtmpf.name,
105
 
                   '--label', new_filename+'\t',
 
111
                   '--label', new_label,
106
112
                   newtmpf.name]
107
113
 
108
114
        # diff only allows one style to be specified; they don't override.
142
148
    finally:
143
149
        oldtmpf.close()                 # and delete
144
150
        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):
 
151
    
 
152
 
 
153
 
 
154
def show_diff(b, revision, specific_files, external_diff_options=None):
150
155
    """Shortcut for showing the diff to the working tree.
151
156
 
152
 
    Please use show_diff_trees instead.
153
 
 
154
157
    b
155
158
        Branch.
156
159
 
157
160
    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.
 
161
        None for each, or otherwise the old revision to compare against.
206
162
    
207
163
    The more general form is show_diff_trees(), where the caller
208
164
    supplies any two trees.
209
165
    """
210
166
    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)
 
167
 
 
168
    if revision == None:
 
169
        old_tree = b.basis_tree()
 
170
    else:
 
171
        old_tree = b.revision_tree(b.lookup_revision(revision))
 
172
        
 
173
    new_tree = b.working_tree()
 
174
 
 
175
    show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
 
176
                    external_diff_options)
 
177
 
227
178
 
228
179
 
229
180
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
236
187
    external_diff_options
237
188
        If set, use an external GNU diff and pass these options.
238
189
    """
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
 
 
191
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
 
192
    old_label = ''
 
193
    new_label = ''
258
194
 
259
195
    DEVNULL = '/dev/null'
260
196
    # Windows users, don't panic about this filename -- it is a
264
200
    # TODO: Generation of pseudo-diffs for added/deleted files could
265
201
    # be usefully made into a much faster special case.
266
202
 
267
 
    _raise_if_doubly_unversioned(specific_files, old_tree, new_tree)
268
 
 
269
203
    if external_diff_options:
270
204
        assert isinstance(external_diff_options, basestring)
271
205
        opts = external_diff_options.split()
274
208
    else:
275
209
        diff_file = internal_diff
276
210
    
 
211
 
277
212
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
278
213
                          specific_files=specific_files)
279
214
 
280
 
    has_changes = 0
281
215
    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)
 
216
        print >>to_file, '*** removed %s %r' % (kind, path)
 
217
        if kind == 'file':
 
218
            diff_file(old_label + path,
 
219
                      old_tree.get_file(file_id).readlines(),
 
220
                      DEVNULL, 
 
221
                      [],
 
222
                      to_file)
 
223
 
286
224
    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)
 
225
        print >>to_file, '*** added %s %r' % (kind, path)
 
226
        if kind == 'file':
 
227
            diff_file(DEVNULL,
 
228
                      [],
 
229
                      new_label + path,
 
230
                      new_tree.get_file(file_id).readlines(),
 
231
                      to_file)
 
232
 
 
233
    for old_path, new_path, file_id, kind, text_modified in delta.renamed:
 
234
        print >>to_file, '*** renamed %s %r => %r' % (kind, old_path, new_path)
306
235
        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))
 
236
            diff_file(old_label + old_path,
 
237
                      old_tree.get_file(file_id).readlines(),
 
238
                      new_label + new_path,
 
239
                      new_tree.get_file(file_id).readlines(),
 
240
                      to_file)
 
241
 
 
242
    for path, file_id, kind in delta.modified:
 
243
        print >>to_file, '*** modified %s %r' % (kind, path)
 
244
        if kind == 'file':
 
245
            diff_file(old_label + path,
 
246
                      old_tree.get_file(file_id).readlines(),
 
247
                      new_label + path,
 
248
                      new_tree.get_file(file_id).readlines(),
 
249
                      to_file)
 
250
 
 
251
 
 
252
 
 
253
class TreeDelta(object):
 
254
    """Describes changes from one tree to another.
 
255
 
 
256
    Contains four lists:
 
257
 
 
258
    added
 
259
        (path, id, kind)
 
260
    removed
 
261
        (path, id, kind)
 
262
    renamed
 
263
        (oldpath, newpath, id, kind, text_modified)
 
264
    modified
 
265
        (path, id, kind)
 
266
    unchanged
 
267
        (path, id, kind)
 
268
 
 
269
    Each id is listed only once.
 
270
 
 
271
    Files that are both modified and renamed are listed only in
 
272
    renamed, with the text_modified flag true.
 
273
 
 
274
    Files are only considered renamed if their name has changed or
 
275
    their parent directory has changed.  Renaming a directory
 
276
    does not count as renaming all its contents.
 
277
 
 
278
    The lists are normally sorted when the delta is created.
 
279
    """
 
280
    def __init__(self):
 
281
        self.added = []
 
282
        self.removed = []
 
283
        self.renamed = []
 
284
        self.modified = []
 
285
        self.unchanged = []
 
286
 
 
287
    def __eq__(self, other):
 
288
        if not isinstance(other, TreeDelta):
 
289
            return False
 
290
        return self.added == other.added \
 
291
               and self.removed == other.removed \
 
292
               and self.renamed == other.renamed \
 
293
               and self.modified == other.modified \
 
294
               and self.unchanged == other.unchanged
 
295
 
 
296
    def __ne__(self, other):
 
297
        return not (self == other)
 
298
 
 
299
    def __repr__(self):
 
300
        return "TreeDelta(added=%r, removed=%r, renamed=%r, modified=%r," \
 
301
            " unchanged=%r)" % (self.added, self.removed, self.renamed,
 
302
            self.modified, self.unchanged)
 
303
 
 
304
    def has_changed(self):
 
305
        changes = len(self.added) + len(self.removed) + len(self.renamed)
 
306
        changes += len(self.modified) 
 
307
        return (changes != 0)
 
308
 
 
309
    def touches_file_id(self, file_id):
 
310
        """Return True if file_id is modified by this delta."""
 
311
        for l in self.added, self.removed, self.modified:
 
312
            for v in l:
 
313
                if v[1] == file_id:
 
314
                    return True
 
315
        for v in self.renamed:
 
316
            if v[2] == file_id:
 
317
                return True
 
318
        return False
 
319
            
 
320
 
 
321
    def show(self, to_file, show_ids=False, show_unchanged=False):
 
322
        def show_list(files):
 
323
            for path, fid, kind in files:
 
324
                if kind == 'directory':
 
325
                    path += '/'
 
326
                elif kind == 'symlink':
 
327
                    path += '@'
 
328
                    
 
329
                if show_ids:
 
330
                    print >>to_file, '  %-30s %s' % (path, fid)
 
331
                else:
 
332
                    print >>to_file, ' ', path
 
333
            
 
334
        if self.removed:
 
335
            print >>to_file, 'removed:'
 
336
            show_list(self.removed)
 
337
                
 
338
        if self.added:
 
339
            print >>to_file, 'added:'
 
340
            show_list(self.added)
 
341
 
 
342
        if self.renamed:
 
343
            print >>to_file, 'renamed:'
 
344
            for oldpath, newpath, fid, kind, text_modified in self.renamed:
 
345
                if show_ids:
 
346
                    print >>to_file, '  %s => %s %s' % (oldpath, newpath, fid)
 
347
                else:
 
348
                    print >>to_file, '  %s => %s' % (oldpath, newpath)
 
349
                    
 
350
        if self.modified:
 
351
            print >>to_file, 'modified:'
 
352
            show_list(self.modified)
 
353
            
 
354
        if show_unchanged and self.unchanged:
 
355
            print >>to_file, 'unchanged:'
 
356
            show_list(self.unchanged)
 
357
 
 
358
 
 
359
 
 
360
def compare_trees(old_tree, new_tree, want_unchanged=False, specific_files=None):
 
361
    """Describe changes from one tree to another.
 
362
 
 
363
    Returns a TreeDelta with details of added, modified, renamed, and
 
364
    deleted entries.
 
365
 
 
366
    The root entry is specifically exempt.
 
367
 
 
368
    This only considers versioned files.
 
369
 
 
370
    want_unchanged
 
371
        If true, also list files unchanged from one version to
 
372
        the next.
 
373
 
 
374
    specific_files
 
375
        If true, only check for changes to specified names or
 
376
        files within them.
 
377
    """
 
378
 
 
379
    from osutils import is_inside_any
323
380
    
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)
 
381
    old_inv = old_tree.inventory
 
382
    new_inv = new_tree.inventory
 
383
    delta = TreeDelta()
 
384
    mutter('start compare_trees')
 
385
 
 
386
    # TODO: match for specific files can be rather smarter by finding
 
387
    # the IDs of those files up front and then considering only that.
 
388
 
 
389
    for file_id in old_tree:
 
390
        if file_id in new_tree:
 
391
            kind = old_inv.get_file_kind(file_id)
 
392
            assert kind == new_inv.get_file_kind(file_id)
 
393
            
 
394
            assert kind in ('file', 'directory', 'symlink', 'root_directory'), \
 
395
                   'invalid file kind %r' % kind
 
396
 
 
397
            if kind == 'root_directory':
 
398
                continue
 
399
            
 
400
            old_path = old_inv.id2path(file_id)
 
401
            new_path = new_inv.id2path(file_id)
 
402
 
 
403
            old_ie = old_inv[file_id]
 
404
            new_ie = new_inv[file_id]
 
405
 
 
406
            if specific_files:
 
407
                if (not is_inside_any(specific_files, old_path) 
 
408
                    and not is_inside_any(specific_files, new_path)):
 
409
                    continue
 
410
 
 
411
            if kind == 'file':
 
412
                old_sha1 = old_tree.get_file_sha1(file_id)
 
413
                new_sha1 = new_tree.get_file_sha1(file_id)
 
414
                text_modified = (old_sha1 != new_sha1)
 
415
            else:
 
416
                ## mutter("no text to check for %r %r" % (file_id, kind))
 
417
                text_modified = False
 
418
 
 
419
            # TODO: Can possibly avoid calculating path strings if the
 
420
            # two files are unchanged and their names and parents are
 
421
            # the same and the parents are unchanged all the way up.
 
422
            # May not be worthwhile.
 
423
            
 
424
            if (old_ie.name != new_ie.name
 
425
                or old_ie.parent_id != new_ie.parent_id):
 
426
                delta.renamed.append((old_path, new_path, file_id, kind,
 
427
                                      text_modified))
 
428
            elif text_modified:
 
429
                delta.modified.append((new_path, file_id, kind))
 
430
            elif want_unchanged:
 
431
                delta.unchanged.append((new_path, file_id, kind))
 
432
        else:
 
433
            kind = old_inv.get_file_kind(file_id)
 
434
            old_path = old_inv.id2path(file_id)
 
435
            if specific_files:
 
436
                if not is_inside_any(specific_files, old_path):
 
437
                    continue
 
438
            delta.removed.append((old_path, file_id, kind))
 
439
 
 
440
    mutter('start looking for new files')
 
441
    for file_id in new_inv:
 
442
        if file_id in old_inv:
 
443
            continue
 
444
        new_path = new_inv.id2path(file_id)
 
445
        if specific_files:
 
446
            if not is_inside_any(specific_files, new_path):
 
447
                continue
 
448
        kind = new_inv.get_file_kind(file_id)
 
449
        delta.added.append((new_path, file_id, kind))
 
450
            
 
451
    delta.removed.sort()
 
452
    delta.added.sort()
 
453
    delta.renamed.sort()
 
454
    delta.modified.sort()
 
455
    delta.unchanged.sort()
 
456
 
 
457
    return delta