/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-05-19 11:11:53 UTC
  • Revision ID: mbp@sourcefrog.net-20050519111153-7f799c5987a540c7
- --forward option for log

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2004, 2005, 2006 Canonical Ltd.
 
1
#! /usr/bin/env python
 
2
# -*- coding: UTF-8 -*-
2
3
 
3
4
# This program is free software; you can redistribute it and/or modify
4
5
# it under the terms of the GNU General Public License as published by
14
15
# along with this program; if not, write to the Free Software
15
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
17
 
17
 
from bzrlib.delta import compare_trees
18
 
from bzrlib.errors import BzrError
19
 
import bzrlib.errors as errors
20
 
from bzrlib.symbol_versioning import *
21
 
from bzrlib.trace import mutter
22
 
 
23
 
# TODO: Rather than building a changeset object, we should probably
24
 
# invoke callbacks on an object.  That object can either accumulate a
25
 
# list, write them out directly, etc etc.
26
 
 
27
 
def internal_diff(old_filename, oldlines, new_filename, 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):
28
24
    import difflib
29
25
    
30
26
    # FIXME: difflib is wrong if there is no trailing newline.
43
39
    if not oldlines and not newlines:
44
40
        return
45
41
 
46
 
    ud = difflib.unified_diff(oldlines, newlines,
47
 
                              fromfile=old_filename+'\t', 
48
 
                              tofile=new_filename+'\t')
49
 
 
50
 
    ud = list(ud)
 
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)
 
52
 
51
53
    # work-around for difflib being too smart for its own good
52
54
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
53
55
    if not oldlines:
 
56
        ud = list(ud)
54
57
        ud[2] = ud[2].replace('-1,0', '-0,0')
55
58
    elif not newlines:
 
59
        ud = list(ud)
56
60
        ud[2] = ud[2].replace('+1,0', '+0,0')
57
 
    # work around for difflib emitting random spaces after the label
58
 
    ud[0] = ud[0][:-2] + '\n'
59
 
    ud[1] = ud[1][:-2] + '\n'
60
61
 
61
 
    for line in ud:
62
 
        to_file.write(line)
63
 
        if not line.endswith('\n'):
64
 
            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"
65
65
    print >>to_file
66
66
 
67
67
 
68
 
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
69
 
                  diff_opts):
70
 
    """Display a diff by calling out to the external diff program."""
 
68
def show_diff(b, revision, specific_files):
71
69
    import sys
72
 
    
73
 
    if to_file != sys.stdout:
74
 
        raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
75
 
                                  to_file)
76
 
 
77
 
    # make sure our own output is properly ordered before the diff
78
 
    to_file.flush()
79
 
 
80
 
    from tempfile import NamedTemporaryFile
81
 
    import os
82
 
 
83
 
    oldtmpf = NamedTemporaryFile()
84
 
    newtmpf = NamedTemporaryFile()
85
 
 
86
 
    try:
87
 
        # TODO: perhaps a special case for comparing to or from the empty
88
 
        # sequence; can just use /dev/null on Unix
89
 
 
90
 
        # TODO: if either of the files being compared already exists as a
91
 
        # regular named file (e.g. in the working directory) then we can
92
 
        # compare directly to that, rather than copying it.
93
 
 
94
 
        oldtmpf.writelines(oldlines)
95
 
        newtmpf.writelines(newlines)
96
 
 
97
 
        oldtmpf.flush()
98
 
        newtmpf.flush()
99
 
 
100
 
        if not diff_opts:
101
 
            diff_opts = []
102
 
        diffcmd = ['diff',
103
 
                   '--label', old_filename+'\t',
104
 
                   oldtmpf.name,
105
 
                   '--label', new_filename+'\t',
106
 
                   newtmpf.name]
107
 
 
108
 
        # diff only allows one style to be specified; they don't override.
109
 
        # note that some of these take optargs, and the optargs can be
110
 
        # directly appended to the options.
111
 
        # this is only an approximate parser; it doesn't properly understand
112
 
        # the grammar.
113
 
        for s in ['-c', '-u', '-C', '-U',
114
 
                  '-e', '--ed',
115
 
                  '-q', '--brief',
116
 
                  '--normal',
117
 
                  '-n', '--rcs',
118
 
                  '-y', '--side-by-side',
119
 
                  '-D', '--ifdef']:
120
 
            for j in diff_opts:
121
 
                if j.startswith(s):
122
 
                    break
123
 
            else:
124
 
                continue
125
 
            break
126
 
        else:
127
 
            diffcmd.append('-u')
128
 
                  
129
 
        if diff_opts:
130
 
            diffcmd.extend(diff_opts)
131
 
 
132
 
        rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
 
70
 
 
71
    if revision == None:
 
72
        old_tree = b.basis_tree()
 
73
    else:
 
74
        old_tree = b.revision_tree(b.lookup_revision(revision))
133
75
        
134
 
        if rc != 0 and rc != 1:
135
 
            # returns 1 if files differ; that's OK
136
 
            if rc < 0:
137
 
                msg = 'signal %d' % (-rc)
138
 
            else:
139
 
                msg = 'exit code %d' % rc
140
 
                
141
 
            raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
142
 
    finally:
143
 
        oldtmpf.close()                 # and delete
144
 
        newtmpf.close()
145
 
 
146
 
 
147
 
@deprecated_function(zero_eight)
148
 
def show_diff(b, from_spec, specific_files, external_diff_options=None,
149
 
              revision2=None, output=None, b2=None):
150
 
    """Shortcut for showing the diff to the working tree.
151
 
 
152
 
    Please use show_diff_trees instead.
153
 
 
154
 
    b
155
 
        Branch.
156
 
 
157
 
    revision
158
 
        None for 'basis tree', or otherwise the old revision to compare against.
159
 
    
160
 
    The more general form is show_diff_trees(), where the caller
161
 
    supplies any two trees.
162
 
    """
163
 
    if output is None:
164
 
        import sys
165
 
        output = sys.stdout
166
 
 
167
 
    if from_spec is None:
168
 
        old_tree = b.bzrdir.open_workingtree()
169
 
        if b2 is None:
170
 
            old_tree = old_tree = old_tree.basis_tree()
171
 
    else:
172
 
        old_tree = b.repository.revision_tree(from_spec.in_history(b).rev_id)
173
 
 
174
 
    if revision2 is None:
175
 
        if b2 is None:
176
 
            new_tree = b.bzrdir.open_workingtree()
177
 
        else:
178
 
            new_tree = b2.bzrdir.open_workingtree()
179
 
    else:
180
 
        new_tree = b.repository.revision_tree(revision2.in_history(b).rev_id)
181
 
 
182
 
    return show_diff_trees(old_tree, new_tree, output, specific_files,
183
 
                           external_diff_options)
184
 
 
185
 
 
186
 
def diff_cmd_helper(tree, specific_files, external_diff_options, 
187
 
                    old_revision_spec=None, new_revision_spec=None):
188
 
    """Helper for cmd_diff.
189
 
 
190
 
   tree 
191
 
        A WorkingTree
192
 
 
193
 
    specific_files
194
 
        The specific files to compare, or None
195
 
 
196
 
    external_diff_options
197
 
        If non-None, run an external diff, and pass it these options
198
 
 
199
 
    old_revision_spec
200
 
        If None, use basis tree as old revision, otherwise use the tree for
201
 
        the specified revision. 
202
 
 
203
 
    new_revision_spec
204
 
        If None, use working tree as new revision, otherwise use the tree for
205
 
        the specified revision.
206
 
    
207
 
    The more general form is show_diff_trees(), where the caller
208
 
    supplies any two trees.
209
 
    """
210
 
    import sys
211
 
    output = sys.stdout
212
 
    def spec_tree(spec):
213
 
        revision_id = spec.in_store(tree.branch).rev_id
214
 
        return tree.branch.repository.revision_tree(revision_id)
215
 
    if old_revision_spec is None:
216
 
        old_tree = tree.basis_tree()
217
 
    else:
218
 
        old_tree = spec_tree(old_revision_spec)
219
 
 
220
 
    if new_revision_spec is None:
221
 
        new_tree = tree
222
 
    else:
223
 
        new_tree = spec_tree(new_revision_spec)
224
 
 
225
 
    return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
226
 
                           external_diff_options)
227
 
 
228
 
 
229
 
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
230
 
                    external_diff_options=None):
231
 
    """Show in text form the changes from one tree to another.
232
 
 
233
 
    to_files
234
 
        If set, include only changes to these files.
235
 
 
236
 
    external_diff_options
237
 
        If set, use an external GNU diff and pass these options.
238
 
    """
239
 
    old_tree.lock_read()
240
 
    try:
241
 
        new_tree.lock_read()
242
 
        try:
243
 
            return _show_diff_trees(old_tree, new_tree, to_file,
244
 
                                    specific_files, external_diff_options)
245
 
        finally:
246
 
            new_tree.unlock()
247
 
    finally:
248
 
        old_tree.unlock()
249
 
 
250
 
 
251
 
def _show_diff_trees(old_tree, new_tree, to_file,
252
 
                     specific_files, external_diff_options):
253
 
 
254
 
    # TODO: Options to control putting on a prefix or suffix, perhaps
255
 
    # as a format string?
256
 
    old_label = 'a/'
257
 
    new_label = 'b/'
 
76
    new_tree = b.working_tree()
 
77
 
 
78
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
 
79
    old_label = ''
 
80
    new_label = ''
258
81
 
259
82
    DEVNULL = '/dev/null'
260
83
    # Windows users, don't panic about this filename -- it is a
264
87
    # TODO: Generation of pseudo-diffs for added/deleted files could
265
88
    # be usefully made into a much faster special case.
266
89
 
267
 
    _raise_if_doubly_unversioned(specific_files, old_tree, new_tree)
268
 
 
269
 
    if external_diff_options:
270
 
        assert isinstance(external_diff_options, basestring)
271
 
        opts = external_diff_options.split()
272
 
        def diff_file(olab, olines, nlab, nlines, to_file):
273
 
            external_diff(olab, olines, nlab, nlines, to_file, opts)
274
 
    else:
275
 
        diff_file = internal_diff
276
 
    
277
90
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
278
91
                          specific_files=specific_files)
279
92
 
280
 
    has_changes = 0
281
93
    for path, file_id, kind in delta.removed:
282
 
        has_changes = 1
283
 
        print >>to_file, '=== removed %s %r' % (kind, old_label + path)
284
 
        old_tree.inventory[file_id].diff(diff_file, old_label + path, old_tree,
285
 
                                         DEVNULL, None, None, to_file)
 
94
        print '*** removed %s %r' % (kind, path)
 
95
        if kind == 'file':
 
96
            _diff_one(old_tree.get_file(file_id).readlines(),
 
97
                   [],
 
98
                   sys.stdout,
 
99
                   fromfile=old_label + path,
 
100
                   tofile=DEVNULL)
 
101
 
286
102
    for path, file_id, kind in delta.added:
287
 
        has_changes = 1
288
 
        print >>to_file, '=== added %s %r' % (kind, new_label + path)
289
 
        new_tree.inventory[file_id].diff(diff_file, new_label + path, new_tree,
290
 
                                         DEVNULL, None, None, to_file, 
291
 
                                         reverse=True)
292
 
    for (old_path, new_path, file_id, kind,
293
 
         text_modified, meta_modified) in delta.renamed:
294
 
        has_changes = 1
295
 
        prop_str = get_prop_change(meta_modified)
296
 
        print >>to_file, '=== renamed %s %r => %r%s' % (
297
 
                    kind, old_label + old_path, new_label + new_path, prop_str)
298
 
        _maybe_diff_file_or_symlink(old_label, old_path, old_tree, file_id,
299
 
                                    new_label, new_path, new_tree,
300
 
                                    text_modified, kind, to_file, diff_file)
301
 
    for path, file_id, kind, text_modified, meta_modified in delta.modified:
302
 
        has_changes = 1
303
 
        prop_str = get_prop_change(meta_modified)
304
 
        print >>to_file, '=== modified %s %r%s' % (kind, old_label + path,
305
 
                    prop_str)
 
103
        print '*** added %s %r' % (kind, path)
 
104
        if kind == 'file':
 
105
            _diff_one([],
 
106
                   new_tree.get_file(file_id).readlines(),
 
107
                   sys.stdout,
 
108
                   fromfile=DEVNULL,
 
109
                   tofile=new_label + path)
 
110
 
 
111
    for old_path, new_path, file_id, kind, text_modified in delta.renamed:
 
112
        print '*** renamed %s %r => %r' % (kind, old_path, new_path)
306
113
        if text_modified:
307
 
            _maybe_diff_file_or_symlink(old_label, path, old_tree, file_id,
308
 
                                        new_label, path, new_tree,
309
 
                                        True, kind, to_file, diff_file)
310
 
 
311
 
    return has_changes
312
 
 
313
 
 
314
 
def _raise_if_doubly_unversioned(specific_files, old_tree, new_tree):
315
 
    """Complain if paths are not versioned in either tree."""
316
 
    if not specific_files:
317
 
        return
318
 
    old_unversioned = old_tree.filter_unversioned_files(specific_files)
319
 
    new_unversioned = new_tree.filter_unversioned_files(specific_files)
320
 
    unversioned = old_unversioned.intersection(new_unversioned)
321
 
    if unversioned:
322
 
        raise errors.PathsNotVersionedError(sorted(unversioned))
 
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)
 
119
 
 
120
    for path, file_id, kind in delta.modified:
 
121
        print '*** modified %s %r' % (kind, path)
 
122
        if kind == 'file':
 
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
323
233
    
324
 
 
325
 
def get_prop_change(meta_modified):
326
 
    if meta_modified:
327
 
        return " (properties changed)"
328
 
    else:
329
 
        return  ""
330
 
 
331
 
 
332
 
def _maybe_diff_file_or_symlink(old_label, old_path, old_tree, file_id,
333
 
                                new_label, new_path, new_tree, text_modified,
334
 
                                kind, to_file, diff_file):
335
 
    if text_modified:
336
 
        new_entry = new_tree.inventory[file_id]
337
 
        old_tree.inventory[file_id].diff(diff_file,
338
 
                                         old_label + old_path, old_tree,
339
 
                                         new_label + new_path, new_entry, 
340
 
                                         new_tree, to_file)
 
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