~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Martin Pool
  • Date: 2005-09-16 08:23:10 UTC
  • Revision ID: mbp@sourcefrog.net-20050916082310-ecb5a25c40253839
- wrap wide strings when showing exceptions

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
 
 
18
from bzrlib.trace import mutter
 
19
from bzrlib.errors import BzrError
17
20
from bzrlib.delta import compare_trees
18
 
from bzrlib.errors import BzrError
19
 
import bzrlib.errors as errors
20
 
from bzrlib.patiencediff import SequenceMatcher, unified_diff
21
 
from bzrlib.symbol_versioning import *
22
 
from bzrlib.textfile import check_text_lines
23
 
from bzrlib.trace import mutter
24
21
 
25
22
# TODO: Rather than building a changeset object, we should probably
26
23
# invoke callbacks on an object.  That object can either accumulate a
27
24
# list, write them out directly, etc etc.
28
25
 
29
 
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
30
 
                  allow_binary=False, sequence_matcher=None):
 
26
def internal_diff(old_label, oldlines, new_label, newlines, to_file):
 
27
    import difflib
 
28
    
31
29
    # FIXME: difflib is wrong if there is no trailing newline.
32
30
    # The syntax used by patch seems to be "\ No newline at
33
31
    # end of file" following the last diff line from that
43
41
    # both sequences are empty.
44
42
    if not oldlines and not newlines:
45
43
        return
46
 
    
47
 
    if allow_binary is False:
48
 
        check_text_lines(oldlines)
49
 
        check_text_lines(newlines)
50
 
 
51
 
    if sequence_matcher is None:
52
 
        sequence_matcher = SequenceMatcher
53
 
    ud = unified_diff(oldlines, newlines,
54
 
                      fromfile=old_filename+'\t', 
55
 
                      tofile=new_filename+'\t',
56
 
                      sequencematcher=sequence_matcher)
57
 
 
58
 
    ud = list(ud)
 
44
 
 
45
    ud = difflib.unified_diff(oldlines, newlines,
 
46
                              fromfile=old_label, tofile=new_label)
 
47
 
59
48
    # work-around for difflib being too smart for its own good
60
49
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
61
50
    if not oldlines:
 
51
        ud = list(ud)
62
52
        ud[2] = ud[2].replace('-1,0', '-0,0')
63
53
    elif not newlines:
 
54
        ud = list(ud)
64
55
        ud[2] = ud[2].replace('+1,0', '+0,0')
65
 
    # work around for difflib emitting random spaces after the label
66
 
    ud[0] = ud[0][:-2] + '\n'
67
 
    ud[1] = ud[1][:-2] + '\n'
68
56
 
69
57
    for line in ud:
70
58
        to_file.write(line)
73
61
    print >>to_file
74
62
 
75
63
 
76
 
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
 
64
 
 
65
 
 
66
def external_diff(old_label, oldlines, new_label, newlines, to_file,
77
67
                  diff_opts):
78
68
    """Display a diff by calling out to the external diff program."""
79
69
    import sys
108
98
        if not diff_opts:
109
99
            diff_opts = []
110
100
        diffcmd = ['diff',
111
 
                   '--label', old_filename+'\t',
 
101
                   '--label', old_label,
112
102
                   oldtmpf.name,
113
 
                   '--label', new_filename+'\t',
 
103
                   '--label', new_label,
114
104
                   newtmpf.name]
115
105
 
116
106
        # diff only allows one style to be specified; they don't override.
150
140
    finally:
151
141
        oldtmpf.close()                 # and delete
152
142
        newtmpf.close()
153
 
 
154
 
 
155
 
@deprecated_function(zero_eight)
156
 
def show_diff(b, from_spec, specific_files, external_diff_options=None,
157
 
              revision2=None, output=None, b2=None):
 
143
    
 
144
 
 
145
 
 
146
def show_diff(b, revision, specific_files, external_diff_options=None,
 
147
              revision2=None):
158
148
    """Shortcut for showing the diff to the working tree.
159
149
 
160
 
    Please use show_diff_trees instead.
161
 
 
162
150
    b
163
151
        Branch.
164
152
 
165
153
    revision
166
 
        None for 'basis tree', or otherwise the old revision to compare against.
167
 
    
168
 
    The more general form is show_diff_trees(), where the caller
169
 
    supplies any two trees.
170
 
    """
171
 
    if output is None:
172
 
        import sys
173
 
        output = sys.stdout
174
 
 
175
 
    if from_spec is None:
176
 
        old_tree = b.bzrdir.open_workingtree()
177
 
        if b2 is None:
178
 
            old_tree = old_tree = old_tree.basis_tree()
179
 
    else:
180
 
        old_tree = b.repository.revision_tree(from_spec.in_history(b).rev_id)
181
 
 
182
 
    if revision2 is None:
183
 
        if b2 is None:
184
 
            new_tree = b.bzrdir.open_workingtree()
185
 
        else:
186
 
            new_tree = b2.bzrdir.open_workingtree()
187
 
    else:
188
 
        new_tree = b.repository.revision_tree(revision2.in_history(b).rev_id)
189
 
 
190
 
    return show_diff_trees(old_tree, new_tree, output, specific_files,
191
 
                           external_diff_options)
192
 
 
193
 
 
194
 
def diff_cmd_helper(tree, specific_files, external_diff_options, 
195
 
                    old_revision_spec=None, new_revision_spec=None,
196
 
                    old_label='a/', new_label='b/'):
197
 
    """Helper for cmd_diff.
198
 
 
199
 
   tree 
200
 
        A WorkingTree
201
 
 
202
 
    specific_files
203
 
        The specific files to compare, or None
204
 
 
205
 
    external_diff_options
206
 
        If non-None, run an external diff, and pass it these options
207
 
 
208
 
    old_revision_spec
209
 
        If None, use basis tree as old revision, otherwise use the tree for
210
 
        the specified revision. 
211
 
 
212
 
    new_revision_spec
213
 
        If None, use working tree as new revision, otherwise use the tree for
214
 
        the specified revision.
 
154
        None for each, or otherwise the old revision to compare against.
215
155
    
216
156
    The more general form is show_diff_trees(), where the caller
217
157
    supplies any two trees.
218
158
    """
219
159
    import sys
220
 
    output = sys.stdout
221
 
    def spec_tree(spec):
222
 
        revision_id = spec.in_store(tree.branch).rev_id
223
 
        return tree.branch.repository.revision_tree(revision_id)
224
 
    if old_revision_spec is None:
225
 
        old_tree = tree.basis_tree()
226
 
    else:
227
 
        old_tree = spec_tree(old_revision_spec)
228
 
 
229
 
    if new_revision_spec is None:
230
 
        new_tree = tree
231
 
    else:
232
 
        new_tree = spec_tree(new_revision_spec)
233
 
 
234
 
    return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
235
 
                           external_diff_options,
236
 
                           old_label=old_label, new_label=new_label)
 
160
 
 
161
    if revision == None:
 
162
        old_tree = b.basis_tree()
 
163
    else:
 
164
        old_tree = b.revision_tree(b.lookup_revision(revision))
 
165
 
 
166
    if revision2 == None:
 
167
        new_tree = b.working_tree()
 
168
    else:
 
169
        new_tree = b.revision_tree(b.lookup_revision(revision2))
 
170
 
 
171
    show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
 
172
                    external_diff_options)
 
173
 
237
174
 
238
175
 
239
176
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
240
 
                    external_diff_options=None,
241
 
                    old_label='a/', new_label='b/'):
 
177
                    external_diff_options=None):
242
178
    """Show in text form the changes from one tree to another.
243
179
 
244
180
    to_files
247
183
    external_diff_options
248
184
        If set, use an external GNU diff and pass these options.
249
185
    """
250
 
    old_tree.lock_read()
251
 
    try:
252
 
        new_tree.lock_read()
253
 
        try:
254
 
            return _show_diff_trees(old_tree, new_tree, to_file,
255
 
                                    specific_files, external_diff_options,
256
 
                                    old_label=old_label, new_label=new_label)
257
 
        finally:
258
 
            new_tree.unlock()
259
 
    finally:
260
 
        old_tree.unlock()
261
 
 
262
 
 
263
 
def _show_diff_trees(old_tree, new_tree, to_file,
264
 
                     specific_files, external_diff_options, 
265
 
                     old_label='a/', new_label='b/' ):
 
186
 
 
187
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
 
188
    old_label = ''
 
189
    new_label = ''
266
190
 
267
191
    DEVNULL = '/dev/null'
268
192
    # Windows users, don't panic about this filename -- it is a
272
196
    # TODO: Generation of pseudo-diffs for added/deleted files could
273
197
    # be usefully made into a much faster special case.
274
198
 
275
 
    _raise_if_doubly_unversioned(specific_files, old_tree, new_tree)
276
 
 
277
199
    if external_diff_options:
278
200
        assert isinstance(external_diff_options, basestring)
279
201
        opts = external_diff_options.split()
282
204
    else:
283
205
        diff_file = internal_diff
284
206
    
 
207
 
285
208
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
286
209
                          specific_files=specific_files)
287
210
 
288
 
    has_changes = 0
289
211
    for path, file_id, kind in delta.removed:
290
 
        has_changes = 1
291
 
        print >>to_file, '=== removed %s %r' % (kind, path)
292
 
        old_tree.inventory[file_id].diff(diff_file, old_label + path, old_tree,
293
 
                                         DEVNULL, None, None, to_file)
 
212
        print >>to_file, '*** removed %s %r' % (kind, path)
 
213
        if kind == 'file':
 
214
            diff_file(old_label + path,
 
215
                      old_tree.get_file(file_id).readlines(),
 
216
                      DEVNULL, 
 
217
                      [],
 
218
                      to_file)
 
219
 
294
220
    for path, file_id, kind in delta.added:
295
 
        has_changes = 1
296
 
        print >>to_file, '=== added %s %r' % (kind, path)
297
 
        new_tree.inventory[file_id].diff(diff_file, new_label + path, new_tree,
298
 
                                         DEVNULL, None, None, to_file, 
299
 
                                         reverse=True)
300
 
    for (old_path, new_path, file_id, kind,
301
 
         text_modified, meta_modified) in delta.renamed:
302
 
        has_changes = 1
303
 
        prop_str = get_prop_change(meta_modified)
304
 
        print >>to_file, '=== renamed %s %r => %r%s' % (
305
 
                    kind, old_path, new_path, prop_str)
306
 
        _maybe_diff_file_or_symlink(old_label, old_path, old_tree, file_id,
307
 
                                    new_label, new_path, new_tree,
308
 
                                    text_modified, kind, to_file, diff_file)
309
 
    for path, file_id, kind, text_modified, meta_modified in delta.modified:
310
 
        has_changes = 1
311
 
        prop_str = get_prop_change(meta_modified)
312
 
        print >>to_file, '=== modified %s %r%s' % (kind, path, prop_str)
 
221
        print >>to_file, '*** added %s %r' % (kind, path)
 
222
        if kind == 'file':
 
223
            diff_file(DEVNULL,
 
224
                      [],
 
225
                      new_label + path,
 
226
                      new_tree.get_file(file_id).readlines(),
 
227
                      to_file)
 
228
 
 
229
    for old_path, new_path, file_id, kind, text_modified in delta.renamed:
 
230
        print >>to_file, '*** renamed %s %r => %r' % (kind, old_path, new_path)
313
231
        if text_modified:
314
 
            _maybe_diff_file_or_symlink(old_label, path, old_tree, file_id,
315
 
                                        new_label, path, new_tree,
316
 
                                        True, kind, to_file, diff_file)
317
 
 
318
 
    return has_changes
319
 
 
320
 
 
321
 
def _raise_if_doubly_unversioned(specific_files, old_tree, new_tree):
322
 
    """Complain if paths are not versioned in either tree."""
323
 
    if not specific_files:
324
 
        return
325
 
    old_unversioned = old_tree.filter_unversioned_files(specific_files)
326
 
    new_unversioned = new_tree.filter_unversioned_files(specific_files)
327
 
    unversioned = old_unversioned.intersection(new_unversioned)
328
 
    if unversioned:
329
 
        raise errors.PathsNotVersionedError(sorted(unversioned))
330
 
    
331
 
 
332
 
def _raise_if_nonexistent(paths, old_tree, new_tree):
333
 
    """Complain if paths are not in either inventory or tree.
334
 
 
335
 
    It's OK with the files exist in either tree's inventory, or 
336
 
    if they exist in the tree but are not versioned.
337
 
    
338
 
    This can be used by operations such as bzr status that can accept
339
 
    unknown or ignored files.
340
 
    """
341
 
    mutter("check paths: %r", paths)
342
 
    if not paths:
343
 
        return
344
 
    s = old_tree.filter_unversioned_files(paths)
345
 
    s = new_tree.filter_unversioned_files(s)
346
 
    s = [path for path in s if not new_tree.has_filename(path)]
347
 
    if s:
348
 
        raise errors.PathsDoNotExist(sorted(s))
349
 
 
350
 
 
351
 
def get_prop_change(meta_modified):
352
 
    if meta_modified:
353
 
        return " (properties changed)"
354
 
    else:
355
 
        return  ""
356
 
 
357
 
 
358
 
def _maybe_diff_file_or_symlink(old_label, old_path, old_tree, file_id,
359
 
                                new_label, new_path, new_tree, text_modified,
360
 
                                kind, to_file, diff_file):
361
 
    if text_modified:
362
 
        new_entry = new_tree.inventory[file_id]
363
 
        old_tree.inventory[file_id].diff(diff_file,
364
 
                                         old_label + old_path, old_tree,
365
 
                                         new_label + new_path, new_entry, 
366
 
                                         new_tree, to_file)
 
232
            diff_file(old_label + old_path,
 
233
                      old_tree.get_file(file_id).readlines(),
 
234
                      new_label + new_path,
 
235
                      new_tree.get_file(file_id).readlines(),
 
236
                      to_file)
 
237
 
 
238
    for path, file_id, kind in delta.modified:
 
239
        print >>to_file, '*** modified %s %r' % (kind, path)
 
240
        if kind == 'file':
 
241
            diff_file(old_label + path,
 
242
                      old_tree.get_file(file_id).readlines(),
 
243
                      new_label + path,
 
244
                      new_tree.get_file(file_id).readlines(),
 
245
                      to_file)
 
246
 
 
247
 
 
248
 
 
249
 
 
250