~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Martin Pool
  • Date: 2005-05-17 06:56:16 UTC
  • Revision ID: mbp@sourcefrog.net-20050517065616-6f23381d6184a8aa
- add space for un-merged patches

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, ImmutableSet
 
19
 
 
20
from trace import mutter
 
21
from errors import BzrError
 
22
 
 
23
 
 
24
 
 
25
def _diff_one(oldlines, newlines, to_file, **kw):
 
26
    import difflib
 
27
    
 
28
    # FIXME: difflib is wrong if there is no trailing newline.
 
29
    # The syntax used by patch seems to be "\ No newline at
 
30
    # end of file" following the last diff line from that
 
31
    # file.  This is not trivial to insert into the
 
32
    # unified_diff output and it might be better to just fix
 
33
    # or replace that function.
 
34
 
 
35
    # In the meantime we at least make sure the patch isn't
 
36
    # mangled.
 
37
 
 
38
 
 
39
    # Special workaround for Python2.3, where difflib fails if
 
40
    # both sequences are empty.
 
41
    if not oldlines and not newlines:
 
42
        return
 
43
 
 
44
    nonl = False
 
45
 
 
46
    if oldlines and (oldlines[-1][-1] != '\n'):
 
47
        oldlines[-1] += '\n'
 
48
        nonl = True
 
49
    if newlines and (newlines[-1][-1] != '\n'):
 
50
        newlines[-1] += '\n'
 
51
        nonl = True
 
52
 
 
53
    ud = difflib.unified_diff(oldlines, newlines, **kw)
 
54
 
 
55
    # work-around for difflib being too smart for its own good
 
56
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
 
57
    if not oldlines:
 
58
        ud = list(ud)
 
59
        ud[2] = ud[2].replace('-1,0', '-0,0')
 
60
    elif not newlines:
 
61
        ud = list(ud)
 
62
        ud[2] = ud[2].replace('+1,0', '+0,0')
 
63
 
 
64
    to_file.writelines(ud)
 
65
    if nonl:
 
66
        print >>to_file, "\\ No newline at end of file"
 
67
    print >>to_file
 
68
 
 
69
 
 
70
def show_diff(b, revision, specific_files):
 
71
    import sys
 
72
 
 
73
    if revision == None:
 
74
        old_tree = b.basis_tree()
 
75
    else:
 
76
        old_tree = b.revision_tree(b.lookup_revision(revision))
 
77
        
 
78
    new_tree = b.working_tree()
 
79
 
 
80
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
 
81
    old_label = ''
 
82
    new_label = ''
 
83
 
 
84
    DEVNULL = '/dev/null'
 
85
    # Windows users, don't panic about this filename -- it is a
 
86
    # special signal to GNU patch that the file should be created or
 
87
    # deleted respectively.
 
88
 
 
89
    # TODO: Generation of pseudo-diffs for added/deleted files could
 
90
    # be usefully made into a much faster special case.
 
91
 
 
92
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
 
93
                          specific_files=specific_files)
 
94
 
 
95
    for path, file_id, kind in delta.removed:
 
96
        print '*** removed %s %r' % (kind, path)
 
97
        if kind == 'file':
 
98
            _diff_one(old_tree.get_file(file_id).readlines(),
 
99
                   [],
 
100
                   sys.stdout,
 
101
                   fromfile=old_label + path,
 
102
                   tofile=DEVNULL)
 
103
 
 
104
    for path, file_id, kind in delta.added:
 
105
        print '*** added %s %r' % (kind, path)
 
106
        if kind == 'file':
 
107
            _diff_one([],
 
108
                   new_tree.get_file(file_id).readlines(),
 
109
                   sys.stdout,
 
110
                   fromfile=DEVNULL,
 
111
                   tofile=new_label + path)
 
112
 
 
113
    for old_path, new_path, file_id, kind, text_modified in delta.renamed:
 
114
        print '*** renamed %s %r => %r' % (kind, old_path, new_path)
 
115
        if text_modified:
 
116
            _diff_one(old_tree.get_file(file_id).readlines(),
 
117
                   new_tree.get_file(file_id).readlines(),
 
118
                   sys.stdout,
 
119
                   fromfile=old_label + old_path,
 
120
                   tofile=new_label + new_path)
 
121
 
 
122
    for path, file_id, kind in delta.modified:
 
123
        print '*** modified %s %r' % (kind, path)
 
124
        if kind == 'file':
 
125
            _diff_one(old_tree.get_file(file_id).readlines(),
 
126
                   new_tree.get_file(file_id).readlines(),
 
127
                   sys.stdout,
 
128
                   fromfile=old_label + path,
 
129
                   tofile=new_label + path)
 
130
 
 
131
 
 
132
 
 
133
class TreeDelta:
 
134
    """Describes changes from one tree to another.
 
135
 
 
136
    Contains four lists:
 
137
 
 
138
    added
 
139
        (path, id, kind)
 
140
    removed
 
141
        (path, id, kind)
 
142
    renamed
 
143
        (oldpath, newpath, id, kind, text_modified)
 
144
    modified
 
145
        (path, id, kind)
 
146
    unchanged
 
147
        (path, id, kind)
 
148
 
 
149
    Each id is listed only once.
 
150
 
 
151
    Files that are both modified and renamed are listed only in
 
152
    renamed, with the text_modified flag true.
 
153
 
 
154
    The lists are normally sorted when the delta is created.
 
155
    """
 
156
    def __init__(self):
 
157
        self.added = []
 
158
        self.removed = []
 
159
        self.renamed = []
 
160
        self.modified = []
 
161
        self.unchanged = []
 
162
 
 
163
    def show(self, to_file, show_ids=False, show_unchanged=False):
 
164
        def show_list(files):
 
165
            for path, fid, kind in files:
 
166
                if kind == 'directory':
 
167
                    path += '/'
 
168
                elif kind == 'symlink':
 
169
                    path += '@'
 
170
                    
 
171
                if show_ids:
 
172
                    print >>to_file, '  %-30s %s' % (path, fid)
 
173
                else:
 
174
                    print >>to_file, ' ', path
 
175
            
 
176
        if self.removed:
 
177
            print >>to_file, 'removed:'
 
178
            show_list(self.removed)
 
179
                
 
180
        if self.added:
 
181
            print >>to_file, 'added:'
 
182
            show_list(self.added)
 
183
 
 
184
        if self.renamed:
 
185
            print >>to_file, 'renamed:'
 
186
            for oldpath, newpath, fid, kind, text_modified in self.renamed:
 
187
                if show_ids:
 
188
                    print >>to_file, '  %s => %s %s' % (oldpath, newpath, fid)
 
189
                else:
 
190
                    print >>to_file, '  %s => %s' % (oldpath, newpath)
 
191
                    
 
192
        if self.modified:
 
193
            print >>to_file, 'modified:'
 
194
            show_list(self.modified)
 
195
            
 
196
        if show_unchanged and self.unchanged:
 
197
            print >>to_file, 'unchanged:'
 
198
            show_list(self.unchanged)
 
199
 
 
200
 
 
201
 
 
202
def compare_trees(old_tree, new_tree, want_unchanged, specific_files=None):
 
203
    """Describe changes from one tree to another.
 
204
 
 
205
    Returns a TreeDelta with details of added, modified, renamed, and
 
206
    deleted entries.
 
207
 
 
208
    The root entry is specifically exempt.
 
209
 
 
210
    This only considers versioned files.
 
211
 
 
212
    want_unchanged
 
213
        If true, also list files unchanged from one version to
 
214
        the next.
 
215
 
 
216
    specific_files
 
217
        If true, only check for changes to specified names or
 
218
        files within them.
 
219
    """
 
220
 
 
221
    from osutils import is_inside_any
 
222
    
 
223
    old_inv = old_tree.inventory
 
224
    new_inv = new_tree.inventory
 
225
    delta = TreeDelta()
 
226
    mutter('start compare_trees')
 
227
 
 
228
    # TODO: match for specific files can be rather smarter by finding
 
229
    # the IDs of those files up front and then considering only that.
 
230
 
 
231
    for file_id in old_tree:
 
232
        if file_id in new_tree:
 
233
            kind = old_inv.get_file_kind(file_id)
 
234
            assert kind == new_inv.get_file_kind(file_id)
 
235
            
 
236
            assert kind in ('file', 'directory', 'symlink', 'root_directory'), \
 
237
                   'invalid file kind %r' % kind
 
238
 
 
239
            if kind == 'root_directory':
 
240
                continue
 
241
            
 
242
            old_path = old_inv.id2path(file_id)
 
243
            new_path = new_inv.id2path(file_id)
 
244
 
 
245
            if specific_files:
 
246
                if (not is_inside_any(specific_files, old_path) 
 
247
                    and not is_inside_any(specific_files, new_path)):
 
248
                    continue
 
249
 
 
250
            if kind == 'file':
 
251
                old_sha1 = old_tree.get_file_sha1(file_id)
 
252
                new_sha1 = new_tree.get_file_sha1(file_id)
 
253
                text_modified = (old_sha1 != new_sha1)
 
254
            else:
 
255
                ## mutter("no text to check for %r %r" % (file_id, kind))
 
256
                text_modified = False
 
257
 
 
258
            # TODO: Can possibly avoid calculating path strings if the
 
259
            # two files are unchanged and their names and parents are
 
260
            # the same and the parents are unchanged all the way up.
 
261
            # May not be worthwhile.
 
262
            
 
263
            if old_path != new_path:
 
264
                delta.renamed.append((old_path, new_path, file_id, kind,
 
265
                                      text_modified))
 
266
            elif text_modified:
 
267
                delta.modified.append((new_path, file_id, kind))
 
268
            elif want_unchanged:
 
269
                delta.unchanged.append((new_path, file_id, kind))
 
270
        else:
 
271
            old_path = old_inv.id2path(file_id)
 
272
            if specific_files:
 
273
                if not is_inside_any(specific_files, old_path):
 
274
                    continue
 
275
            delta.removed.append((old_path, file_id, kind))
 
276
 
 
277
    mutter('start looking for new files')
 
278
    for file_id in new_inv:
 
279
        if file_id in old_inv:
 
280
            continue
 
281
        new_path = new_inv.id2path(file_id)
 
282
        if specific_files:
 
283
            if not is_inside_any(specific_files, new_path):
 
284
                continue
 
285
        kind = new_inv.get_file_kind(file_id)
 
286
        delta.added.append((new_path, file_id, kind))
 
287
            
 
288
    delta.removed.sort()
 
289
    delta.added.sort()
 
290
    delta.renamed.sort()
 
291
    delta.modified.sort()
 
292
    delta.unchanged.sort()
 
293
 
 
294
    return delta