~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-05-23 11:06:22 UTC
  • mfrom: (1704.2.28 bzr.mbp.integration)
  • Revision ID: pqm@pqm.ubuntu.com-20060523110622-5ad5c2bf9dee4fc5
(mbp) use bisect to find revisions by date

Show diffs side-by-side

added added

removed removed

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