← 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-17 08:23:28 UTC
  • Revision ID: mbp@sourcefrog.net-20050517082328-2187a086f257ac68
- put back support for log on specific files

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 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):
27
26
    import difflib
28
27
    
29
28
    # FIXME: difflib is wrong if there is no trailing newline.
42
41
    if not oldlines and not newlines:
43
42
        return
44
43
 
45
 
    ud = difflib.unified_diff(oldlines, newlines,
46
 
                              fromfile=old_label, tofile=new_label)
 
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)
47
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
54
61
        ud = list(ud)
55
62
        ud[2] = ud[2].replace('+1,0', '+0,0')
56
63
 
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")
 
64
    to_file.writelines(ud)
 
65
    if nonl:
 
66
        print >>to_file, "\\ No newline at end of file"
61
67
    print >>to_file
62
68
 
63
69
 
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
 
    """Shortcut for showing the diff to the working tree.
148
 
 
149
 
    b
150
 
        Branch.
151
 
 
152
 
    revision
153
 
        None for each, or otherwise the old revision to compare against.
154
 
    
155
 
    The more general form is show_diff_trees(), where the caller
156
 
    supplies any two trees.
157
 
    """
 
70
def show_diff(b, revision, specific_files):
158
71
    import sys
159
72
 
160
73
    if revision == None:
164
77
        
165
78
    new_tree = b.working_tree()
166
79
 
167
 
    show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
168
 
                    external_diff_options)
169
 
 
170
 
 
171
 
 
172
 
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
173
 
                    external_diff_options=None):
174
 
    """Show in text form the changes from one tree to another.
175
 
 
176
 
    to_files
177
 
        If set, include only changes to these files.
178
 
 
179
 
    external_diff_options
180
 
        If set, use an external GNU diff and pass these options.
181
 
    """
182
 
 
183
80
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
184
81
    old_label = ''
185
82
    new_label = ''
192
89
    # TODO: Generation of pseudo-diffs for added/deleted files could
193
90
    # be usefully made into a much faster special case.
194
91
 
195
 
    if external_diff_options:
196
 
        assert isinstance(external_diff_options, basestring)
197
 
        opts = external_diff_options.split()
198
 
        def diff_file(olab, olines, nlab, nlines, to_file):
199
 
            external_diff(olab, olines, nlab, nlines, to_file, opts)
200
 
    else:
201
 
        diff_file = internal_diff
202
 
    
203
 
 
204
92
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
205
93
                          specific_files=specific_files)
206
94
 
207
95
    for path, file_id, kind in delta.removed:
208
 
        print >>to_file, '*** removed %s %r' % (kind, path)
 
96
        print '*** removed %s %r' % (kind, path)
209
97
        if kind == 'file':
210
 
            diff_file(old_label + path,
211
 
                      old_tree.get_file(file_id).readlines(),
212
 
                      DEVNULL, 
213
 
                      [],
214
 
                      to_file)
 
98
            _diff_one(old_tree.get_file(file_id).readlines(),
 
99
                   [],
 
100
                   sys.stdout,
 
101
                   fromfile=old_label + path,
 
102
                   tofile=DEVNULL)
215
103
 
216
104
    for path, file_id, kind in delta.added:
217
 
        print >>to_file, '*** added %s %r' % (kind, path)
 
105
        print '*** added %s %r' % (kind, path)
218
106
        if kind == 'file':
219
 
            diff_file(DEVNULL,
220
 
                      [],
221
 
                      new_label + path,
222
 
                      new_tree.get_file(file_id).readlines(),
223
 
                      to_file)
 
107
            _diff_one([],
 
108
                   new_tree.get_file(file_id).readlines(),
 
109
                   sys.stdout,
 
110
                   fromfile=DEVNULL,
 
111
                   tofile=new_label + path)
224
112
 
225
113
    for old_path, new_path, file_id, kind, text_modified in delta.renamed:
226
 
        print >>to_file, '*** renamed %s %r => %r' % (kind, old_path, new_path)
 
114
        print '*** renamed %s %r => %r' % (kind, old_path, new_path)
227
115
        if text_modified:
228
 
            diff_file(old_label + old_path,
229
 
                      old_tree.get_file(file_id).readlines(),
230
 
                      new_label + new_path,
231
 
                      new_tree.get_file(file_id).readlines(),
232
 
                      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)
233
121
 
234
122
    for path, file_id, kind in delta.modified:
235
 
        print >>to_file, '*** modified %s %r' % (kind, path)
 
123
        print '*** modified %s %r' % (kind, path)
236
124
        if kind == 'file':
237
 
            diff_file(old_label + path,
238
 
                      old_tree.get_file(file_id).readlines(),
239
 
                      new_label + path,
240
 
                      new_tree.get_file(file_id).readlines(),
241
 
                      to_file)
242
 
 
243
 
 
244
 
 
245
 
 
246
 
 
 
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
 
 
164
    def touches_file_id(self, file_id):
 
165
        """Return True if file_id is modified by this delta."""
 
166
        for l in self.added, self.removed, self.modified:
 
167
            for v in l:
 
168
                if v[1] == file_id:
 
169
                    return True
 
170
        for v in self.renamed:
 
171
            if v[2] == file_id:
 
172
                return True
 
173
        return False
 
174
            
 
175
 
 
176
    def show(self, to_file, show_ids=False, show_unchanged=False):
 
177
        def show_list(files):
 
178
            for path, fid, kind in files:
 
179
                if kind == 'directory':
 
180
                    path += '/'
 
181
                elif kind == 'symlink':
 
182
                    path += '@'
 
183
                    
 
184
                if show_ids:
 
185
                    print >>to_file, '  %-30s %s' % (path, fid)
 
186
                else:
 
187
                    print >>to_file, ' ', path
 
188
            
 
189
        if self.removed:
 
190
            print >>to_file, 'removed:'
 
191
            show_list(self.removed)
 
192
                
 
193
        if self.added:
 
194
            print >>to_file, 'added:'
 
195
            show_list(self.added)
 
196
 
 
197
        if self.renamed:
 
198
            print >>to_file, 'renamed:'
 
199
            for oldpath, newpath, fid, kind, text_modified in self.renamed:
 
200
                if show_ids:
 
201
                    print >>to_file, '  %s => %s %s' % (oldpath, newpath, fid)
 
202
                else:
 
203
                    print >>to_file, '  %s => %s' % (oldpath, newpath)
 
204
                    
 
205
        if self.modified:
 
206
            print >>to_file, 'modified:'
 
207
            show_list(self.modified)
 
208
            
 
209
        if show_unchanged and self.unchanged:
 
210
            print >>to_file, 'unchanged:'
 
211
            show_list(self.unchanged)
 
212
 
 
213
 
 
214
 
 
215
def compare_trees(old_tree, new_tree, want_unchanged, specific_files=None):
 
216
    """Describe changes from one tree to another.
 
217
 
 
218
    Returns a TreeDelta with details of added, modified, renamed, and
 
219
    deleted entries.
 
220
 
 
221
    The root entry is specifically exempt.
 
222
 
 
223
    This only considers versioned files.
 
224
 
 
225
    want_unchanged
 
226
        If true, also list files unchanged from one version to
 
227
        the next.
 
228
 
 
229
    specific_files
 
230
        If true, only check for changes to specified names or
 
231
        files within them.
 
232
    """
 
233
 
 
234
    from osutils import is_inside_any
 
235
    
 
236
    old_inv = old_tree.inventory
 
237
    new_inv = new_tree.inventory
 
238
    delta = TreeDelta()
 
239
    mutter('start compare_trees')
 
240
 
 
241
    # TODO: match for specific files can be rather smarter by finding
 
242
    # the IDs of those files up front and then considering only that.
 
243
 
 
244
    for file_id in old_tree:
 
245
        if file_id in new_tree:
 
246
            kind = old_inv.get_file_kind(file_id)
 
247
            assert kind == new_inv.get_file_kind(file_id)
 
248
            
 
249
            assert kind in ('file', 'directory', 'symlink', 'root_directory'), \
 
250
                   'invalid file kind %r' % kind
 
251
 
 
252
            if kind == 'root_directory':
 
253
                continue
 
254
            
 
255
            old_path = old_inv.id2path(file_id)
 
256
            new_path = new_inv.id2path(file_id)
 
257
 
 
258
            if specific_files:
 
259
                if (not is_inside_any(specific_files, old_path) 
 
260
                    and not is_inside_any(specific_files, new_path)):
 
261
                    continue
 
262
 
 
263
            if kind == 'file':
 
264
                old_sha1 = old_tree.get_file_sha1(file_id)
 
265
                new_sha1 = new_tree.get_file_sha1(file_id)
 
266
                text_modified = (old_sha1 != new_sha1)
 
267
            else:
 
268
                ## mutter("no text to check for %r %r" % (file_id, kind))
 
269
                text_modified = False
 
270
 
 
271
            # TODO: Can possibly avoid calculating path strings if the
 
272
            # two files are unchanged and their names and parents are
 
273
            # the same and the parents are unchanged all the way up.
 
274
            # May not be worthwhile.
 
275
            
 
276
            if old_path != new_path:
 
277
                delta.renamed.append((old_path, new_path, file_id, kind,
 
278
                                      text_modified))
 
279
            elif text_modified:
 
280
                delta.modified.append((new_path, file_id, kind))
 
281
            elif want_unchanged:
 
282
                delta.unchanged.append((new_path, file_id, kind))
 
283
        else:
 
284
            old_path = old_inv.id2path(file_id)
 
285
            if specific_files:
 
286
                if not is_inside_any(specific_files, old_path):
 
287
                    continue
 
288
            delta.removed.append((old_path, file_id, kind))
 
289
 
 
290
    mutter('start looking for new files')
 
291
    for file_id in new_inv:
 
292
        if file_id in old_inv:
 
293
            continue
 
294
        new_path = new_inv.id2path(file_id)
 
295
        if specific_files:
 
296
            if not is_inside_any(specific_files, new_path):
 
297
                continue
 
298
        kind = new_inv.get_file_kind(file_id)
 
299
        delta.added.append((new_path, file_id, kind))
 
300
            
 
301
    delta.removed.sort()
 
302
    delta.added.sort()
 
303
    delta.renamed.sort()
 
304
    delta.modified.sort()
 
305
    delta.unchanged.sort()
 
306
 
 
307
    return delta