/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

 * The internal storage of history, and logical branch identity have now
   been split into Branch, and Repository. The common locking and file 
   management routines are now in bzrlib.lockablefiles. 
   (Aaron Bentley, Robert Collins, Martin Pool)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/diff.py
 
1
# -*- coding: UTF-8 -*-
 
2
 
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
 
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
 
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
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
    import difflib
 
27
    
 
28
    # FIXME: difflib is wrong if there is no trailing newline.
 
29
    # The syntax used by patch seems to be "\ No newline at
 
30
    # end of file" following the last diff line from that
 
31
    # file.  This is not trivial to insert into the
 
32
    # unified_diff output and it might be better to just fix
 
33
    # or replace that function.
 
34
 
 
35
    # In the meantime we at least make sure the patch isn't
 
36
    # mangled.
 
37
 
 
38
 
 
39
    # Special workaround for Python2.3, where difflib fails if
 
40
    # both sequences are empty.
 
41
    if not oldlines and not newlines:
 
42
        return
 
43
 
 
44
    ud = difflib.unified_diff(oldlines, newlines,
 
45
                              fromfile=old_filename+'\t', 
 
46
                              tofile=new_filename+'\t')
 
47
 
 
48
    ud = list(ud)
 
49
    # work-around for difflib being too smart for its own good
 
50
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
 
51
    if not oldlines:
 
52
        ud[2] = ud[2].replace('-1,0', '-0,0')
 
53
    elif not newlines:
 
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'
 
58
 
 
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")
 
63
    print >>to_file
 
64
 
 
65
 
 
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."""
 
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_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)
 
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
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):
 
207
 
 
208
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
 
209
    old_label = ''
 
210
    new_label = ''
 
211
 
 
212
    DEVNULL = '/dev/null'
 
213
    # Windows users, don't panic about this filename -- it is a
 
214
    # special signal to GNU patch that the file should be created or
 
215
    # deleted respectively.
 
216
 
 
217
    # TODO: Generation of pseudo-diffs for added/deleted files could
 
218
    # be usefully made into a much faster special case.
 
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
 
 
229
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
 
230
                          specific_files=specific_files)
 
231
 
 
232
    has_changes = 0
 
233
    for path, file_id, kind in delta.removed:
 
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)
 
238
    for path, file_id, kind in delta.added:
 
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)
 
257
        if text_modified:
 
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
 
262
    
 
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)