/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Martin Pool
  • Date: 2005-08-04 22:04:40 UTC
  • Revision ID: mbp@sourcefrog.net-20050804220440-99562df8151d1ac5
- add pending merge from aaron

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