← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

[merge] Erik Bågfors: add --revision to bzr pull

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/diff.py
1
 
#! /usr/bin/env python
2
1
# -*- coding: UTF-8 -*-
3
2
 
4
3
# This program is free software; you can redistribute it and/or modify
15
14
# along with this program; if not, write to the Free Software
16
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
16
 
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):
 
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_filename, oldlines, new_filename, newlines, to_file):
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
 
    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
 
 
 
44
    ud = difflib.unified_diff(oldlines, newlines,
 
45
                              fromfile=old_filename+'\t', 
 
46
                              tofile=new_filename+'\t')
 
47
 
 
48
    ud = list(ud)
55
49
    # work-around for difflib being too smart for its own good
56
50
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
57
51
    if not oldlines:
58
 
        ud = list(ud)
59
52
        ud[2] = ud[2].replace('-1,0', '-0,0')
60
53
    elif not newlines:
61
 
        ud = list(ud)
62
54
        ud[2] = ud[2].replace('+1,0', '+0,0')
 
55
    # work around for difflib emitting random spaces after the label
 
56
    ud[0] = ud[0][:-2] + '\n'
 
57
    ud[1] = ud[1][:-2] + '\n'
63
58
 
64
 
    to_file.writelines(ud)
65
 
    if nonl:
66
 
        print >>to_file, "\\ No newline at end of file"
 
59
    for line in ud:
 
60
        to_file.write(line)
 
61
        if not line.endswith('\n'):
 
62
            to_file.write("\n\\ No newline at end of file\n")
67
63
    print >>to_file
68
64
 
69
65
 
70
 
def show_diff(b, revision, specific_files):
 
66
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
 
67
                  diff_opts):
 
68
    """Display a diff by calling out to the external diff program."""
71
69
    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))
 
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_filename+'\t',
 
102
                   oldtmpf.name,
 
103
                   '--label', new_filename+'\t',
 
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)
77
131
        
78
 
    new_tree = b.working_tree()
 
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
def show_diff(b, from_spec, specific_files, external_diff_options=None,
 
145
              revision2=None, output=None, b2=None):
 
146
    """Shortcut for showing the diff to the working tree.
 
147
 
 
148
    b
 
149
        Branch.
 
150
 
 
151
    revision
 
152
        None for 'basis tree', or otherwise the old revision to compare against.
 
153
    
 
154
    The more general form is show_diff_trees(), where the caller
 
155
    supplies any two trees.
 
156
    """
 
157
    if output is None:
 
158
        import sys
 
159
        output = sys.stdout
 
160
 
 
161
    if from_spec is None:
 
162
        if b2 is None:
 
163
            old_tree = b.basis_tree()
 
164
        else:
 
165
            old_tree = b.working_tree()
 
166
    else:
 
167
        old_tree = b.repository.revision_tree(from_spec.in_history(b).rev_id)
 
168
 
 
169
    if revision2 is None:
 
170
        if b2 is None:
 
171
            new_tree = b.working_tree()
 
172
        else:
 
173
            new_tree = b2.working_tree()
 
174
    else:
 
175
        new_tree = b.repository.revision_tree(revision2.in_history(b).rev_id)
 
176
 
 
177
    return show_diff_trees(old_tree, new_tree, output, specific_files,
 
178
                           external_diff_options)
 
179
 
 
180
 
 
181
 
 
182
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
 
183
                    external_diff_options=None):
 
184
    """Show in text form the changes from one tree to another.
 
185
 
 
186
    to_files
 
187
        If set, include only changes to these files.
 
188
 
 
189
    external_diff_options
 
190
        If set, use an external GNU diff and pass these options.
 
191
    """
 
192
 
 
193
    old_tree.lock_read()
 
194
    try:
 
195
        new_tree.lock_read()
 
196
        try:
 
197
            return _show_diff_trees(old_tree, new_tree, to_file,
 
198
                                    specific_files, external_diff_options)
 
199
        finally:
 
200
            new_tree.unlock()
 
201
    finally:
 
202
        old_tree.unlock()
 
203
 
 
204
 
 
205
def _show_diff_trees(old_tree, new_tree, to_file,
 
206
                     specific_files, external_diff_options):
79
207
 
80
208
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
81
209
    old_label = ''
89
217
    # TODO: Generation of pseudo-diffs for added/deleted files could
90
218
    # be usefully made into a much faster special case.
91
219
 
 
220
    if external_diff_options:
 
221
        assert isinstance(external_diff_options, basestring)
 
222
        opts = external_diff_options.split()
 
223
        def diff_file(olab, olines, nlab, nlines, to_file):
 
224
            external_diff(olab, olines, nlab, nlines, to_file, opts)
 
225
    else:
 
226
        diff_file = internal_diff
 
227
    
 
228
 
92
229
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
93
230
                          specific_files=specific_files)
94
231
 
 
232
    has_changes = 0
95
233
    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
 
 
 
234
        has_changes = 1
 
235
        print >>to_file, '=== removed %s %r' % (kind, path)
 
236
        old_tree.inventory[file_id].diff(diff_file, old_label + path, old_tree,
 
237
                                         DEVNULL, None, None, to_file)
104
238
    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)
 
239
        has_changes = 1
 
240
        print >>to_file, '=== added %s %r' % (kind, path)
 
241
        new_tree.inventory[file_id].diff(diff_file, new_label + path, new_tree,
 
242
                                         DEVNULL, None, None, to_file, 
 
243
                                         reverse=True)
 
244
    for (old_path, new_path, file_id, kind,
 
245
         text_modified, meta_modified) in delta.renamed:
 
246
        has_changes = 1
 
247
        prop_str = get_prop_change(meta_modified)
 
248
        print >>to_file, '=== renamed %s %r => %r%s' % (
 
249
                          kind, old_path, new_path, prop_str)
 
250
        _maybe_diff_file_or_symlink(old_label, old_path, old_tree, file_id,
 
251
                                    new_label, new_path, new_tree,
 
252
                                    text_modified, kind, to_file, diff_file)
 
253
    for path, file_id, kind, text_modified, meta_modified in delta.modified:
 
254
        has_changes = 1
 
255
        prop_str = get_prop_change(meta_modified)
 
256
        print >>to_file, '=== modified %s %r%s' % (kind, path, prop_str)
115
257
        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
 
258
            _maybe_diff_file_or_symlink(old_label, path, old_tree, file_id,
 
259
                                        new_label, path, new_tree,
 
260
                                        True, kind, to_file, diff_file)
 
261
    return has_changes
222
262
    
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
 
263
 
 
264
def get_prop_change(meta_modified):
 
265
    if meta_modified:
 
266
        return " (properties changed)"
 
267
    else:
 
268
        return  ""
 
269
 
 
270
 
 
271
def _maybe_diff_file_or_symlink(old_label, old_path, old_tree, file_id,
 
272
                                new_label, new_path, new_tree, text_modified,
 
273
                                kind, to_file, diff_file):
 
274
    if text_modified:
 
275
        new_entry = new_tree.inventory[file_id]
 
276
        old_tree.inventory[file_id].diff(diff_file,
 
277
                                         old_label + old_path, old_tree,
 
278
                                         new_label + new_path, new_entry, 
 
279
                                         new_tree, to_file)