/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 01:53:02 UTC
  • Revision ID: mbp@sourcefrog.net-20050527015302-5dbc20a91b0ed48e
doc

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/diff.py
 
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 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
    
 
25
    # FIXME: difflib is wrong if there is no trailing newline.
 
26
    # The syntax used by patch seems to be "\ No newline at
 
27
    # end of file" following the last diff line from that
 
28
    # file.  This is not trivial to insert into the
 
29
    # unified_diff output and it might be better to just fix
 
30
    # or replace that function.
 
31
 
 
32
    # In the meantime we at least make sure the patch isn't
 
33
    # mangled.
 
34
 
 
35
 
 
36
    # Special workaround for Python2.3, where difflib fails if
 
37
    # both sequences are empty.
 
38
    if not oldlines and not newlines:
 
39
        return
 
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
 
 
53
    # work-around for difflib being too smart for its own good
 
54
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
 
55
    if not oldlines:
 
56
        ud = list(ud)
 
57
        ud[2] = ud[2].replace('-1,0', '-0,0')
 
58
    elif not newlines:
 
59
        ud = list(ud)
 
60
        ud[2] = ud[2].replace('+1,0', '+0,0')
 
61
 
 
62
    to_file.writelines(ud)
 
63
    if nonl:
 
64
        print >>to_file, "\\ No newline at end of file"
 
65
    print >>to_file
 
66
 
 
67
 
 
68
 
 
69
 
 
70
def external_diff(old_label, oldlines, new_label, newlines, to_file):
 
71
    """Display a diff by calling out to the external diff program."""
 
72
    import sys
 
73
    
 
74
    if to_file != sys.stdout:
 
75
        raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
 
76
                                  to_file)
 
77
 
 
78
    from tempfile import NamedTemporaryFile
 
79
    from os import system
 
80
 
 
81
    oldtmpf = NamedTemporaryFile()
 
82
    newtmpf = NamedTemporaryFile()
 
83
 
 
84
    try:
 
85
        # TODO: perhaps a special case for comparing to or from the empty
 
86
        # sequence; can just use /dev/null on Unix
 
87
 
 
88
        # TODO: if either of the files being compared already exists as a
 
89
        # regular named file (e.g. in the working directory) then we can
 
90
        # compare directly to that, rather than copying it.
 
91
 
 
92
        oldtmpf.writelines(oldlines)
 
93
        newtmpf.writelines(newlines)
 
94
 
 
95
        oldtmpf.flush()
 
96
        newtmpf.flush()
 
97
 
 
98
        system('diff -u --label %s %s --label %s %s' % (old_label, oldtmpf.name, new_label, newtmpf.name))
 
99
    finally:
 
100
        oldtmpf.close()                 # and delete
 
101
        newtmpf.close()
 
102
    
 
103
 
 
104
 
 
105
def diff_file(old_label, oldlines, new_label, newlines, to_file):
 
106
    if False:
 
107
        differ = external_diff
 
108
    else:
 
109
        differ = internal_diff
 
110
 
 
111
    differ(old_label, oldlines, new_label, newlines, to_file)
 
112
 
 
113
 
 
114
 
 
115
def show_diff(b, revision, specific_files):
 
116
    import sys
 
117
 
 
118
    if revision == None:
 
119
        old_tree = b.basis_tree()
 
120
    else:
 
121
        old_tree = b.revision_tree(b.lookup_revision(revision))
 
122
        
 
123
    new_tree = b.working_tree()
 
124
 
 
125
    show_diff_trees(old_tree, new_tree, sys.stdout, specific_files)
 
126
 
 
127
 
 
128
 
 
129
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None):
 
130
    """Show in text form the changes from one tree to another.
 
131
 
 
132
    to_files
 
133
        If set, include only changes to these files.
 
134
    """
 
135
 
 
136
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
 
137
    old_label = ''
 
138
    new_label = ''
 
139
 
 
140
    DEVNULL = '/dev/null'
 
141
    # Windows users, don't panic about this filename -- it is a
 
142
    # special signal to GNU patch that the file should be created or
 
143
    # deleted respectively.
 
144
 
 
145
    # TODO: Generation of pseudo-diffs for added/deleted files could
 
146
    # be usefully made into a much faster special case.
 
147
 
 
148
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
 
149
                          specific_files=specific_files)
 
150
 
 
151
    for path, file_id, kind in delta.removed:
 
152
        print '*** removed %s %r' % (kind, path)
 
153
        if kind == 'file':
 
154
            diff_file(old_label + path,
 
155
                      old_tree.get_file(file_id).readlines(),
 
156
                      DEVNULL, 
 
157
                      [],
 
158
                      to_file)
 
159
 
 
160
    for path, file_id, kind in delta.added:
 
161
        print '*** added %s %r' % (kind, path)
 
162
        if kind == 'file':
 
163
            diff_file(DEVNULL,
 
164
                      [],
 
165
                      new_label + path,
 
166
                      new_tree.get_file(file_id).readlines(),
 
167
                      to_file)
 
168
 
 
169
    for old_path, new_path, file_id, kind, text_modified in delta.renamed:
 
170
        print '*** renamed %s %r => %r' % (kind, old_path, new_path)
 
171
        if text_modified:
 
172
            diff_file(old_label + old_path,
 
173
                      old_tree.get_file(file_id).readlines(),
 
174
                      new_label + new_path,
 
175
                      new_tree.get_file(file_id).readlines(),
 
176
                      to_file)
 
177
 
 
178
    for path, file_id, kind in delta.modified:
 
179
        print '*** modified %s %r' % (kind, path)
 
180
        if kind == 'file':
 
181
            diff_file(old_label + path,
 
182
                      old_tree.get_file(file_id).readlines(),
 
183
                      new_label + path,
 
184
                      new_tree.get_file(file_id).readlines(),
 
185
                      to_file)
 
186
 
 
187
 
 
188
 
 
189
class TreeDelta(object):
 
190
    """Describes changes from one tree to another.
 
191
 
 
192
    Contains four lists:
 
193
 
 
194
    added
 
195
        (path, id, kind)
 
196
    removed
 
197
        (path, id, kind)
 
198
    renamed
 
199
        (oldpath, newpath, id, kind, text_modified)
 
200
    modified
 
201
        (path, id, kind)
 
202
    unchanged
 
203
        (path, id, kind)
 
204
 
 
205
    Each id is listed only once.
 
206
 
 
207
    Files that are both modified and renamed are listed only in
 
208
    renamed, with the text_modified flag true.
 
209
 
 
210
    The lists are normally sorted when the delta is created.
 
211
    """
 
212
    def __init__(self):
 
213
        self.added = []
 
214
        self.removed = []
 
215
        self.renamed = []
 
216
        self.modified = []
 
217
        self.unchanged = []
 
218
 
 
219
 
 
220
    def touches_file_id(self, file_id):
 
221
        """Return True if file_id is modified by this delta."""
 
222
        for l in self.added, self.removed, self.modified:
 
223
            for v in l:
 
224
                if v[1] == file_id:
 
225
                    return True
 
226
        for v in self.renamed:
 
227
            if v[2] == file_id:
 
228
                return True
 
229
        return False
 
230
            
 
231
 
 
232
    def show(self, to_file, show_ids=False, show_unchanged=False):
 
233
        def show_list(files):
 
234
            for path, fid, kind in files:
 
235
                if kind == 'directory':
 
236
                    path += '/'
 
237
                elif kind == 'symlink':
 
238
                    path += '@'
 
239
                    
 
240
                if show_ids:
 
241
                    print >>to_file, '  %-30s %s' % (path, fid)
 
242
                else:
 
243
                    print >>to_file, ' ', path
 
244
            
 
245
        if self.removed:
 
246
            print >>to_file, 'removed:'
 
247
            show_list(self.removed)
 
248
                
 
249
        if self.added:
 
250
            print >>to_file, 'added:'
 
251
            show_list(self.added)
 
252
 
 
253
        if self.renamed:
 
254
            print >>to_file, 'renamed:'
 
255
            for oldpath, newpath, fid, kind, text_modified in self.renamed:
 
256
                if show_ids:
 
257
                    print >>to_file, '  %s => %s %s' % (oldpath, newpath, fid)
 
258
                else:
 
259
                    print >>to_file, '  %s => %s' % (oldpath, newpath)
 
260
                    
 
261
        if self.modified:
 
262
            print >>to_file, 'modified:'
 
263
            show_list(self.modified)
 
264
            
 
265
        if show_unchanged and self.unchanged:
 
266
            print >>to_file, 'unchanged:'
 
267
            show_list(self.unchanged)
 
268
 
 
269
 
 
270
 
 
271
def compare_trees(old_tree, new_tree, want_unchanged, specific_files=None):
 
272
    """Describe changes from one tree to another.
 
273
 
 
274
    Returns a TreeDelta with details of added, modified, renamed, and
 
275
    deleted entries.
 
276
 
 
277
    The root entry is specifically exempt.
 
278
 
 
279
    This only considers versioned files.
 
280
 
 
281
    want_unchanged
 
282
        If true, also list files unchanged from one version to
 
283
        the next.
 
284
 
 
285
    specific_files
 
286
        If true, only check for changes to specified names or
 
287
        files within them.
 
288
    """
 
289
 
 
290
    from osutils import is_inside_any
 
291
    
 
292
    old_inv = old_tree.inventory
 
293
    new_inv = new_tree.inventory
 
294
    delta = TreeDelta()
 
295
    mutter('start compare_trees')
 
296
 
 
297
    # TODO: match for specific files can be rather smarter by finding
 
298
    # the IDs of those files up front and then considering only that.
 
299
 
 
300
    for file_id in old_tree:
 
301
        if file_id in new_tree:
 
302
            kind = old_inv.get_file_kind(file_id)
 
303
            assert kind == new_inv.get_file_kind(file_id)
 
304
            
 
305
            assert kind in ('file', 'directory', 'symlink', 'root_directory'), \
 
306
                   'invalid file kind %r' % kind
 
307
 
 
308
            if kind == 'root_directory':
 
309
                continue
 
310
            
 
311
            old_path = old_inv.id2path(file_id)
 
312
            new_path = new_inv.id2path(file_id)
 
313
 
 
314
            if specific_files:
 
315
                if (not is_inside_any(specific_files, old_path) 
 
316
                    and not is_inside_any(specific_files, new_path)):
 
317
                    continue
 
318
 
 
319
            if kind == 'file':
 
320
                old_sha1 = old_tree.get_file_sha1(file_id)
 
321
                new_sha1 = new_tree.get_file_sha1(file_id)
 
322
                text_modified = (old_sha1 != new_sha1)
 
323
            else:
 
324
                ## mutter("no text to check for %r %r" % (file_id, kind))
 
325
                text_modified = False
 
326
 
 
327
            # TODO: Can possibly avoid calculating path strings if the
 
328
            # two files are unchanged and their names and parents are
 
329
            # the same and the parents are unchanged all the way up.
 
330
            # May not be worthwhile.
 
331
            
 
332
            if old_path != new_path:
 
333
                delta.renamed.append((old_path, new_path, file_id, kind,
 
334
                                      text_modified))
 
335
            elif text_modified:
 
336
                delta.modified.append((new_path, file_id, kind))
 
337
            elif want_unchanged:
 
338
                delta.unchanged.append((new_path, file_id, kind))
 
339
        else:
 
340
            kind = old_inv.get_file_kind(file_id)
 
341
            old_path = old_inv.id2path(file_id)
 
342
            if specific_files:
 
343
                if not is_inside_any(specific_files, old_path):
 
344
                    continue
 
345
            delta.removed.append((old_path, file_id, kind))
 
346
 
 
347
    mutter('start looking for new files')
 
348
    for file_id in new_inv:
 
349
        if file_id in old_inv:
 
350
            continue
 
351
        new_path = new_inv.id2path(file_id)
 
352
        if specific_files:
 
353
            if not is_inside_any(specific_files, new_path):
 
354
                continue
 
355
        kind = new_inv.get_file_kind(file_id)
 
356
        delta.added.append((new_path, file_id, kind))
 
357
            
 
358
    delta.removed.sort()
 
359
    delta.added.sort()
 
360
    delta.renamed.sort()
 
361
    delta.modified.sort()
 
362
    delta.unchanged.sort()
 
363
 
 
364
    return delta