/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: Canonical.com Patch Queue Manager
  • Date: 2006-04-20 02:28:21 UTC
  • mfrom: (1666.1.10 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20060420022821-4337b8fa4942d8fe
Make knits the default format.

Show diffs side-by-side

added added

removed removed

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