← 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-09-22 06:28:55 UTC
  • Revision ID: mbp@sourcefrog.net-20050922062855-a29aa53982b752d6
- try to avoid checking texts repeatedly

Show diffs side-by-side

added added

removed removed

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