/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-11 07:45:56 UTC
  • Revision ID: mbp@sourcefrog.net-20050511074556-88739f06c90aed43
- rewrite diff using compare_trees()
- include entry kind in TreeDelta

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
#! /usr/bin/env python
 
2
# -*- coding: UTF-8 -*-
 
3
 
 
4
# This program is free software; you can redistribute it and/or modify
 
5
# it under the terms of the GNU General Public License as published by
 
6
# the Free Software Foundation; either version 2 of the License, or
 
7
# (at your option) any later version.
 
8
 
 
9
# This program is distributed in the hope that it will be useful,
 
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
12
# GNU General Public License for more details.
 
13
 
 
14
# You should have received a copy of the GNU General Public License
 
15
# along with this program; if not, write to the Free Software
 
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
17
 
 
18
from sets import Set
 
19
 
 
20
from trace import mutter
 
21
from errors import BzrError
 
22
 
 
23
 
 
24
def diff_trees(old_tree, new_tree):
 
25
    """Compute diff between two trees.
 
26
 
 
27
    They may be in different branches and may be working or historical
 
28
    trees.
 
29
 
 
30
    This only compares the versioned files, paying no attention to
 
31
    files which are ignored or unknown.  Those can only be present in
 
32
    working trees and can be reported on separately.
 
33
 
 
34
    Yields a sequence of (state, id, old_name, new_name, kind).
 
35
    Each filename and each id is listed only once.
 
36
    """
 
37
    ## TODO: Allow specifying a list of files to compare, rather than
 
38
    ## doing the whole tree?  (Not urgent.)
 
39
 
 
40
    ## TODO: Allow diffing any two inventories, not just the
 
41
    ## current one against one.  We mgiht need to specify two
 
42
    ## stores to look for the files if diffing two branches.  That
 
43
    ## might imply this shouldn't be primarily a Branch method.
 
44
 
 
45
    sha_match_cnt = modified_cnt = 0
 
46
 
 
47
    old_it = old_tree.list_files()
 
48
    new_it = new_tree.list_files()
 
49
 
 
50
    def next(it):
 
51
        try:
 
52
            return it.next()
 
53
        except StopIteration:
 
54
            return None
 
55
 
 
56
    old_item = next(old_it)
 
57
    new_item = next(new_it)
 
58
 
 
59
    # We step through the two sorted iterators in parallel, trying to
 
60
    # keep them lined up.
 
61
 
 
62
    while (old_item != None) or (new_item != None):
 
63
        # OK, we still have some remaining on both, but they may be
 
64
        # out of step.        
 
65
        if old_item != None:
 
66
            old_name, old_class, old_kind, old_id = old_item
 
67
        else:
 
68
            old_name = None
 
69
            
 
70
        if new_item != None:
 
71
            new_name, new_class, new_kind, new_id = new_item
 
72
        else:
 
73
            new_name = None
 
74
 
 
75
        if old_item:
 
76
            # can't handle the old tree being a WorkingTree
 
77
            assert old_class == 'V'
 
78
 
 
79
        if new_item and (new_class != 'V'):
 
80
            yield new_class, None, None, new_name, new_kind
 
81
            new_item = next(new_it)
 
82
        elif (not new_item) or (old_item and (old_name < new_name)):
 
83
            if new_tree.has_id(old_id):
 
84
                # will be mentioned as renamed under new name
 
85
                pass
 
86
            else:
 
87
                yield 'D', old_id, old_name, None, old_kind
 
88
            old_item = next(old_it)
 
89
        elif (not old_item) or (new_item and (new_name < old_name)):
 
90
            if old_tree.has_id(new_id):
 
91
                yield 'R', new_id, old_tree.id2path(new_id), new_name, new_kind
 
92
            else:
 
93
                yield 'A', new_id, None, new_name, new_kind
 
94
            new_item = next(new_it)
 
95
        elif old_id != new_id:
 
96
            assert old_name == new_name
 
97
            # both trees have a file of this name, but it is not the
 
98
            # same file.  in other words, the old filename has been
 
99
            # overwritten by either a newly-added or a renamed file.
 
100
            # (should we return something about the overwritten file?)
 
101
            if old_tree.has_id(new_id):
 
102
                # renaming, overlying a deleted file
 
103
                yield 'R', new_id, old_tree.id2path(new_id), new_name, new_kind
 
104
            else:
 
105
                yield 'A', new_id, None, new_name, new_kind
 
106
 
 
107
            new_item = next(new_it)
 
108
            old_item = next(old_it)
 
109
        else:
 
110
            assert old_id == new_id
 
111
            assert old_id != None
 
112
            assert old_name == new_name
 
113
            assert old_kind == new_kind
 
114
 
 
115
            if old_kind == 'directory':
 
116
                yield '.', new_id, old_name, new_name, new_kind
 
117
            elif old_tree.get_file_sha1(old_id) == new_tree.get_file_sha1(old_id):
 
118
                sha_match_cnt += 1
 
119
                yield '.', new_id, old_name, new_name, new_kind
 
120
            else:
 
121
                modified_cnt += 1
 
122
                yield 'M', new_id, old_name, new_name, new_kind
 
123
 
 
124
            new_item = next(new_it)
 
125
            old_item = next(old_it)
 
126
 
 
127
 
 
128
    mutter("diff finished: %d SHA matches, %d modified"
 
129
           % (sha_match_cnt, modified_cnt))
 
130
 
 
131
 
 
132
 
 
133
def _diff_one(oldlines, newlines, to_file, **kw):
 
134
    import difflib
 
135
    
 
136
    # FIXME: difflib is wrong if there is no trailing newline.
 
137
    # The syntax used by patch seems to be "\ No newline at
 
138
    # end of file" following the last diff line from that
 
139
    # file.  This is not trivial to insert into the
 
140
    # unified_diff output and it might be better to just fix
 
141
    # or replace that function.
 
142
 
 
143
    # In the meantime we at least make sure the patch isn't
 
144
    # mangled.
 
145
 
 
146
 
 
147
    # Special workaround for Python2.3, where difflib fails if
 
148
    # both sequences are empty.
 
149
    if not oldlines and not newlines:
 
150
        return
 
151
 
 
152
    nonl = False
 
153
 
 
154
    if oldlines and (oldlines[-1][-1] != '\n'):
 
155
        oldlines[-1] += '\n'
 
156
        nonl = True
 
157
    if newlines and (newlines[-1][-1] != '\n'):
 
158
        newlines[-1] += '\n'
 
159
        nonl = True
 
160
 
 
161
    ud = difflib.unified_diff(oldlines, newlines, **kw)
 
162
 
 
163
    # work-around for difflib being too smart for its own good
 
164
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
 
165
    if not oldlines:
 
166
        ud = list(ud)
 
167
        ud[2] = ud[2].replace('-1,0', '-0,0')
 
168
    elif not newlines:
 
169
        ud = list(ud)
 
170
        ud[2] = ud[2].replace('+1,0', '+0,0')
 
171
 
 
172
    to_file.writelines(ud)
 
173
    if nonl:
 
174
        print >>to_file, "\\ No newline at end of file"
 
175
    print >>to_file
 
176
 
 
177
 
 
178
def show_diff(b, revision, file_list):
 
179
    import sys
 
180
 
 
181
    if file_list:
 
182
        raise NotImplementedError('diff on restricted files broken at the moment')
 
183
    
 
184
    if revision == None:
 
185
        old_tree = b.basis_tree()
 
186
    else:
 
187
        old_tree = b.revision_tree(b.lookup_revision(revision))
 
188
        
 
189
    new_tree = b.working_tree()
 
190
 
 
191
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
 
192
    old_label = ''
 
193
    new_label = ''
 
194
 
 
195
    DEVNULL = '/dev/null'
 
196
    # Windows users, don't panic about this filename -- it is a
 
197
    # special signal to GNU patch that the file should be created or
 
198
    # deleted respectively.
 
199
 
 
200
    # TODO: Generation of pseudo-diffs for added/deleted files could
 
201
    # be usefully made into a much faster special case.
 
202
 
 
203
    delta = compare_trees(old_tree, new_tree, want_unchanged=False)
 
204
 
 
205
    for path, file_id, kind in delta.removed:
 
206
        print '*** removed %s %r' % (kind, path)
 
207
        if kind == 'file':
 
208
            _diff_one(old_tree.get_file(file_id).readlines(),
 
209
                   [],
 
210
                   sys.stdout,
 
211
                   fromfile=old_label + path,
 
212
                   tofile=DEVNULL)
 
213
 
 
214
    for path, file_id, kind in delta.added:
 
215
        print '*** added %s %r' % (kind, path)
 
216
        if kind == 'file':
 
217
            _diff_one([],
 
218
                   new_tree.get_file(file_id).readlines(),
 
219
                   sys.stdout,
 
220
                   fromfile=DEVNULL,
 
221
                   tofile=new_label + path)
 
222
 
 
223
    for old_path, new_path, file_id, kind, text_modified in delta.renamed:
 
224
        print '*** renamed %s %r => %r' % (kind, old_path, new_path)
 
225
        if text_modified:
 
226
            _diff_one(old_tree.get_file(file_id).readlines(),
 
227
                   new_tree.get_file(file_id).readlines(),
 
228
                   sys.stdout,
 
229
                   fromfile=old_label + old_path,
 
230
                   tofile=new_label + new_path)
 
231
 
 
232
    for path, file_id, kind in delta.modified:
 
233
        print '*** modified %s %r' % (kind, path)
 
234
        if kind == 'file':
 
235
            _diff_one(old_tree.get_file(file_id).readlines(),
 
236
                   new_tree.get_file(file_id).readlines(),
 
237
                   sys.stdout,
 
238
                   fromfile=old_label + path,
 
239
                   tofile=new_label + path)
 
240
 
 
241
 
 
242
 
 
243
class TreeDelta:
 
244
    """Describes changes from one tree to another.
 
245
 
 
246
    Contains four lists:
 
247
 
 
248
    added
 
249
        (path, id, kind)
 
250
    removed
 
251
        (path, id, kind)
 
252
    renamed
 
253
        (oldpath, newpath, id, kind, text_modified)
 
254
    modified
 
255
        (path, id, kind)
 
256
    unchanged
 
257
        (path, id, kind)
 
258
 
 
259
    Each id is listed only once.
 
260
 
 
261
    Files that are both modified and renamed are listed only in
 
262
    renamed, with the text_modified flag true.
 
263
 
 
264
    The lists are normally sorted when the delta is created.
 
265
    """
 
266
    def __init__(self):
 
267
        self.added = []
 
268
        self.removed = []
 
269
        self.renamed = []
 
270
        self.modified = []
 
271
        self.unchanged = []
 
272
 
 
273
    def show(self, to_file, show_ids=False, show_unchanged=False):
 
274
        def show_list(files):
 
275
            for path, fid, kind in files:
 
276
                if kind == 'directory':
 
277
                    path += '/'
 
278
                elif kind == 'symlink':
 
279
                    path += '@'
 
280
                    
 
281
                if show_ids:
 
282
                    print >>to_file, '  %-30s %s' % (path, fid)
 
283
                else:
 
284
                    print >>to_file, ' ', path
 
285
            
 
286
        if self.removed:
 
287
            print >>to_file, 'removed:'
 
288
            show_list(self.removed)
 
289
                
 
290
        if self.added:
 
291
            print >>to_file, 'added:'
 
292
            show_list(self.added)
 
293
 
 
294
        if self.renamed:
 
295
            print >>to_file, 'renamed:'
 
296
            for oldpath, newpath, fid, kind, text_modified in self.renamed:
 
297
                if show_ids:
 
298
                    print >>to_file, '  %s => %s %s' % (oldpath, newpath, fid)
 
299
                else:
 
300
                    print >>to_file, '  %s => %s' % (oldpath, newpath)
 
301
                    
 
302
        if self.modified:
 
303
            print >>to_file, 'modified:'
 
304
            show_list(self.modified)
 
305
            
 
306
        if show_unchanged and self.unchanged:
 
307
            print >>to_file, 'unchanged:'
 
308
            show_list(self.unchanged)
 
309
 
 
310
 
 
311
 
 
312
def compare_trees(old_tree, new_tree, want_unchanged):
 
313
    old_inv = old_tree.inventory
 
314
    new_inv = new_tree.inventory
 
315
    delta = TreeDelta()
 
316
    mutter('start compare_trees')
 
317
    for file_id in old_tree:
 
318
        if file_id in new_tree:
 
319
            old_path = old_inv.id2path(file_id)
 
320
            new_path = new_inv.id2path(file_id)
 
321
 
 
322
            kind = old_inv.get_file_kind(file_id)
 
323
            assert kind == new_inv.get_file_kind(file_id)
 
324
            
 
325
            assert kind in ('file', 'directory', 'symlink', 'root_directory'), \
 
326
                   'invalid file kind %r' % kind
 
327
            if kind == 'file':
 
328
                old_sha1 = old_tree.get_file_sha1(file_id)
 
329
                new_sha1 = new_tree.get_file_sha1(file_id)
 
330
                text_modified = (old_sha1 != new_sha1)
 
331
            else:
 
332
                ## mutter("no text to check for %r %r" % (file_id, kind))
 
333
                text_modified = False
 
334
 
 
335
            # TODO: Can possibly avoid calculating path strings if the
 
336
            # two files are unchanged and their names and parents are
 
337
            # the same and the parents are unchanged all the way up.
 
338
            # May not be worthwhile.
 
339
            
 
340
            if old_path != new_path:
 
341
                delta.renamed.append((old_path, new_path, file_id, kind,
 
342
                                      text_modified))
 
343
            elif text_modified:
 
344
                delta.modified.append((new_path, file_id, kind))
 
345
            elif want_unchanged:
 
346
                delta.unchanged.append((new_path, file_id, kind))
 
347
        else:
 
348
            delta.removed.append((old_inv.id2path(file_id), file_id, kind))
 
349
 
 
350
    mutter('start looking for new files')
 
351
    for file_id in new_inv:
 
352
        if file_id in old_inv:
 
353
            continue
 
354
        kind = new_inv.get_file_kind(file_id)
 
355
        delta.added.append((new_inv.id2path(file_id), file_id, kind))
 
356
            
 
357
    delta.removed.sort()
 
358
    delta.added.sort()
 
359
    delta.renamed.sort()
 
360
    delta.modified.sort()
 
361
    delta.unchanged.sort()
 
362
 
 
363
    return delta