/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

merge from bzr.dev, fix conflicts

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