← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Martin Pool
  • Date: 2005-05-12 02:14:35 UTC
  • Revision ID: mbp@sourcefrog.net-20050512021435-87fa19f051842647
- new helper function kind_marker()

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/diff.py
 
1
#! /usr/bin/env python
1
2
# -*- coding: UTF-8 -*-
2
3
 
3
4
# This program is free software; you can redistribute it and/or modify
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.trace import mutter
18
 
from bzrlib.errors import BzrError
19
 
from bzrlib.delta import compare_trees
20
 
 
21
 
# TODO: Rather than building a changeset object, we should probably
22
 
# invoke callbacks on an object.  That object can either accumulate a
23
 
# list, write them out directly, etc etc.
24
 
 
25
 
def internal_diff(old_label, oldlines, new_label, newlines, to_file):
 
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
26
    import difflib
27
27
    
28
28
    # FIXME: difflib is wrong if there is no trailing newline.
41
41
    if not oldlines and not newlines:
42
42
        return
43
43
 
44
 
    ud = difflib.unified_diff(oldlines, newlines,
45
 
                              fromfile=old_label, tofile=new_label)
46
 
 
47
 
    ud = list(ud)
 
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
 
48
55
    # work-around for difflib being too smart for its own good
49
56
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
50
57
    if not oldlines:
 
58
        ud = list(ud)
51
59
        ud[2] = ud[2].replace('-1,0', '-0,0')
52
60
    elif not newlines:
 
61
        ud = list(ud)
53
62
        ud[2] = ud[2].replace('+1,0', '+0,0')
54
 
    # work around for difflib emitting random spaces after the label
55
 
    ud[0] = ud[0][:-2] + '\n'
56
 
    ud[1] = ud[1][:-2] + '\n'
57
63
 
58
 
    for line in ud:
59
 
        to_file.write(line)
60
 
        if not line.endswith('\n'):
61
 
            to_file.write("\n\\ No newline at end of file\n")
 
64
    to_file.writelines(ud)
 
65
    if nonl:
 
66
        print >>to_file, "\\ No newline at end of file"
62
67
    print >>to_file
63
68
 
64
69
 
65
 
 
66
 
 
67
 
def external_diff(old_label, oldlines, new_label, newlines, to_file,
68
 
                  diff_opts):
69
 
    """Display a diff by calling out to the external diff program."""
 
70
def show_diff(b, revision, specific_files):
70
71
    import sys
71
 
    
72
 
    if to_file != sys.stdout:
73
 
        raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
74
 
                                  to_file)
75
 
 
76
 
    # make sure our own output is properly ordered before the diff
77
 
    to_file.flush()
78
 
 
79
 
    from tempfile import NamedTemporaryFile
80
 
    import os
81
 
 
82
 
    oldtmpf = NamedTemporaryFile()
83
 
    newtmpf = NamedTemporaryFile()
84
 
 
85
 
    try:
86
 
        # TODO: perhaps a special case for comparing to or from the empty
87
 
        # sequence; can just use /dev/null on Unix
88
 
 
89
 
        # TODO: if either of the files being compared already exists as a
90
 
        # regular named file (e.g. in the working directory) then we can
91
 
        # compare directly to that, rather than copying it.
92
 
 
93
 
        oldtmpf.writelines(oldlines)
94
 
        newtmpf.writelines(newlines)
95
 
 
96
 
        oldtmpf.flush()
97
 
        newtmpf.flush()
98
 
 
99
 
        if not diff_opts:
100
 
            diff_opts = []
101
 
        diffcmd = ['diff',
102
 
                   '--label', old_label,
103
 
                   oldtmpf.name,
104
 
                   '--label', new_label,
105
 
                   newtmpf.name]
106
 
 
107
 
        # diff only allows one style to be specified; they don't override.
108
 
        # note that some of these take optargs, and the optargs can be
109
 
        # directly appended to the options.
110
 
        # this is only an approximate parser; it doesn't properly understand
111
 
        # the grammar.
112
 
        for s in ['-c', '-u', '-C', '-U',
113
 
                  '-e', '--ed',
114
 
                  '-q', '--brief',
115
 
                  '--normal',
116
 
                  '-n', '--rcs',
117
 
                  '-y', '--side-by-side',
118
 
                  '-D', '--ifdef']:
119
 
            for j in diff_opts:
120
 
                if j.startswith(s):
121
 
                    break
122
 
            else:
123
 
                continue
124
 
            break
125
 
        else:
126
 
            diffcmd.append('-u')
127
 
                  
128
 
        if diff_opts:
129
 
            diffcmd.extend(diff_opts)
130
 
 
131
 
        rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
132
 
        
133
 
        if rc != 0 and rc != 1:
134
 
            # returns 1 if files differ; that's OK
135
 
            if rc < 0:
136
 
                msg = 'signal %d' % (-rc)
137
 
            else:
138
 
                msg = 'exit code %d' % rc
139
 
                
140
 
            raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
141
 
    finally:
142
 
        oldtmpf.close()                 # and delete
143
 
        newtmpf.close()
144
 
    
145
 
 
146
 
 
147
 
def show_diff(b, revision, specific_files, external_diff_options=None,
148
 
              revision2=None, output=None):
149
 
    """Shortcut for showing the diff to the working tree.
150
 
 
151
 
    b
152
 
        Branch.
153
 
 
154
 
    revision
155
 
        None for each, or otherwise the old revision to compare against.
156
 
    
157
 
    The more general form is show_diff_trees(), where the caller
158
 
    supplies any two trees.
159
 
    """
160
 
    if output is None:
161
 
        import sys
162
 
        output = sys.stdout
163
72
 
164
73
    if revision == None:
165
74
        old_tree = b.basis_tree()
166
75
    else:
167
76
        old_tree = b.revision_tree(b.lookup_revision(revision))
168
 
 
169
 
    if revision2 == None:
170
 
        new_tree = b.working_tree()
171
 
    else:
172
 
        new_tree = b.revision_tree(b.lookup_revision(revision2))
173
 
 
174
 
    show_diff_trees(old_tree, new_tree, output, specific_files,
175
 
                    external_diff_options)
176
 
 
177
 
 
178
 
 
179
 
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
180
 
                    external_diff_options=None):
181
 
    """Show in text form the changes from one tree to another.
182
 
 
183
 
    to_files
184
 
        If set, include only changes to these files.
185
 
 
186
 
    external_diff_options
187
 
        If set, use an external GNU diff and pass these options.
188
 
    """
 
77
        
 
78
    new_tree = b.working_tree()
189
79
 
190
80
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
191
81
    old_label = ''
199
89
    # TODO: Generation of pseudo-diffs for added/deleted files could
200
90
    # be usefully made into a much faster special case.
201
91
 
202
 
    if external_diff_options:
203
 
        assert isinstance(external_diff_options, basestring)
204
 
        opts = external_diff_options.split()
205
 
        def diff_file(olab, olines, nlab, nlines, to_file):
206
 
            external_diff(olab, olines, nlab, nlines, to_file, opts)
207
 
    else:
208
 
        diff_file = internal_diff
209
 
    
210
 
 
211
92
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
212
93
                          specific_files=specific_files)
213
94
 
214
95
    for path, file_id, kind in delta.removed:
215
 
        print >>to_file, '=== removed %s %r' % (kind, path)
 
96
        print '*** removed %s %r' % (kind, path)
216
97
        if kind == 'file':
217
 
            diff_file(old_label + path,
218
 
                      old_tree.get_file(file_id).readlines(),
219
 
                      DEVNULL, 
220
 
                      [],
221
 
                      to_file)
 
98
            _diff_one(old_tree.get_file(file_id).readlines(),
 
99
                   [],
 
100
                   sys.stdout,
 
101
                   fromfile=old_label + path,
 
102
                   tofile=DEVNULL)
222
103
 
223
104
    for path, file_id, kind in delta.added:
224
 
        print >>to_file, '=== added %s %r' % (kind, path)
 
105
        print '*** added %s %r' % (kind, path)
225
106
        if kind == 'file':
226
 
            diff_file(DEVNULL,
227
 
                      [],
228
 
                      new_label + path,
229
 
                      new_tree.get_file(file_id).readlines(),
230
 
                      to_file)
 
107
            _diff_one([],
 
108
                   new_tree.get_file(file_id).readlines(),
 
109
                   sys.stdout,
 
110
                   fromfile=DEVNULL,
 
111
                   tofile=new_label + path)
231
112
 
232
113
    for old_path, new_path, file_id, kind, text_modified in delta.renamed:
233
 
        print >>to_file, '=== renamed %s %r => %r' % (kind, old_path, new_path)
 
114
        print '*** renamed %s %r => %r' % (kind, old_path, new_path)
234
115
        if text_modified:
235
 
            diff_file(old_label + old_path,
236
 
                      old_tree.get_file(file_id).readlines(),
237
 
                      new_label + new_path,
238
 
                      new_tree.get_file(file_id).readlines(),
239
 
                      to_file)
 
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)
240
121
 
241
122
    for path, file_id, kind in delta.modified:
242
 
        print >>to_file, '=== modified %s %r' % (kind, path)
 
123
        print '*** modified %s %r' % (kind, path)
243
124
        if kind == 'file':
244
 
            diff_file(old_label + path,
245
 
                      old_tree.get_file(file_id).readlines(),
246
 
                      new_label + path,
247
 
                      new_tree.get_file(file_id).readlines(),
248
 
                      to_file)
249
 
 
250
 
 
251
 
 
252
 
 
253
 
 
 
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