← 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-19 08:31:06 UTC
  • Revision ID: mbp@sourcefrog.net-20050519083106-ebe71562d3bda4a7
- fix typo

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