~bzr-pqm/bzr/bzr.dev

1 by mbp at sourcefrog
import from baz patch-364
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
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
17
from bzrlib.trace import mutter
18
from bzrlib.errors import BzrError
19
from bzrlib.delta import compare_trees
1 by mbp at sourcefrog
import from baz patch-364
20
767 by Martin Pool
- files are only reported as modified if their name or parent has changed,
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
568 by Martin Pool
- start adding support for showing diffs by calling out to
25
def internal_diff(old_label, oldlines, new_label, newlines, to_file):
475 by Martin Pool
- rewrite diff using compare_trees()
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
568 by Martin Pool
- start adding support for showing diffs by calling out to
44
    ud = difflib.unified_diff(oldlines, newlines,
45
                              fromfile=old_label, tofile=new_label)
475 by Martin Pool
- rewrite diff using compare_trees()
46
1092.1.50 by Robert Collins
make diff lsdiff/filterdiff friendly
47
    ud = list(ud)
475 by Martin Pool
- rewrite diff using compare_trees()
48
    # work-around for difflib being too smart for its own good
49
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
50
    if not oldlines:
51
        ud[2] = ud[2].replace('-1,0', '-0,0')
52
    elif not newlines:
53
        ud[2] = ud[2].replace('+1,0', '+0,0')
1092.1.50 by Robert Collins
make diff lsdiff/filterdiff friendly
54
    # work around for difflib emitting random spaces after the label
55
    ud[0] = ud[0][:-2] + '\n'
56
    ud[1] = ud[1][:-2] + '\n'
475 by Martin Pool
- rewrite diff using compare_trees()
57
804 by Martin Pool
Patch from John:
58
    for line in ud:
59
        to_file.write(line)
974.1.5 by Aaron Bentley
Fixed handling of missing newlines in udiffs
60
        if not line.endswith('\n'):
61
            to_file.write("\n\\ No newline at end of file\n")
475 by Martin Pool
- rewrite diff using compare_trees()
62
    print >>to_file
63
64
550 by Martin Pool
- Refactor diff code into one that works purely on
65
568 by Martin Pool
- start adding support for showing diffs by calling out to
66
571 by Martin Pool
- new --diff-options to pass options through to external
67
def external_diff(old_label, oldlines, new_label, newlines, to_file,
68
                  diff_opts):
568 by Martin Pool
- start adding support for showing diffs by calling out to
69
    """Display a diff by calling out to the external diff program."""
70
    import sys
71
    
72
    if to_file != sys.stdout:
73
        raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
74
                                  to_file)
75
581 by Martin Pool
- make sure any bzr output is flushed before
76
    # make sure our own output is properly ordered before the diff
77
    to_file.flush()
78
568 by Martin Pool
- start adding support for showing diffs by calling out to
79
    from tempfile import NamedTemporaryFile
571 by Martin Pool
- new --diff-options to pass options through to external
80
    import os
568 by Martin Pool
- start adding support for showing diffs by calling out to
81
82
    oldtmpf = NamedTemporaryFile()
83
    newtmpf = NamedTemporaryFile()
84
85
    try:
86
        # TODO: perhaps a special case for comparing to or from the empty
87
        # sequence; can just use /dev/null on Unix
88
89
        # TODO: if either of the files being compared already exists as a
90
        # regular named file (e.g. in the working directory) then we can
91
        # compare directly to that, rather than copying it.
92
93
        oldtmpf.writelines(oldlines)
94
        newtmpf.writelines(newlines)
95
96
        oldtmpf.flush()
97
        newtmpf.flush()
98
571 by Martin Pool
- new --diff-options to pass options through to external
99
        if not diff_opts:
100
            diff_opts = []
101
        diffcmd = ['diff',
102
                   '--label', old_label,
103
                   oldtmpf.name,
104
                   '--label', new_label,
105
                   newtmpf.name]
106
107
        # diff only allows one style to be specified; they don't override.
108
        # note that some of these take optargs, and the optargs can be
109
        # directly appended to the options.
110
        # this is only an approximate parser; it doesn't properly understand
111
        # the grammar.
112
        for s in ['-c', '-u', '-C', '-U',
113
                  '-e', '--ed',
114
                  '-q', '--brief',
115
                  '--normal',
116
                  '-n', '--rcs',
117
                  '-y', '--side-by-side',
118
                  '-D', '--ifdef']:
119
            for j in diff_opts:
120
                if j.startswith(s):
121
                    break
122
            else:
123
                continue
124
            break
125
        else:
126
            diffcmd.append('-u')
127
                  
128
        if diff_opts:
129
            diffcmd.extend(diff_opts)
130
131
        rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
132
        
133
        if rc != 0 and rc != 1:
134
            # returns 1 if files differ; that's OK
135
            if rc < 0:
136
                msg = 'signal %d' % (-rc)
137
            else:
138
                msg = 'exit code %d' % rc
139
                
140
            raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
568 by Martin Pool
- start adding support for showing diffs by calling out to
141
    finally:
142
        oldtmpf.close()                 # and delete
143
        newtmpf.close()
144
    
145
146
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
147
def show_diff(b, revision, specific_files, external_diff_options=None,
1092.1.47 by Robert Collins
make show_diff redirectable
148
              revision2=None, output=None):
619 by Martin Pool
doc
149
    """Shortcut for showing the diff to the working tree.
150
151
    b
152
        Branch.
153
154
    revision
155
        None for each, or otherwise the old revision to compare against.
156
    
157
    The more general form is show_diff_trees(), where the caller
158
    supplies any two trees.
159
    """
1092.1.47 by Robert Collins
make show_diff redirectable
160
    if output is None:
161
        import sys
162
        output = sys.stdout
475 by Martin Pool
- rewrite diff using compare_trees()
163
1185.2.13 by Lalo Martins
polishing up the RevisionSpec api, as per suggestions from Robert
164
    if revision is None:
329 by Martin Pool
- refactor command functions into command classes
165
        old_tree = b.basis_tree()
166
    else:
1185.2.14 by Lalo Martins
fixing up users of RevisionSpec, and moving it over to commands.py
167
        old_tree = b.revision_tree(revision.in_history(b).rev_id)
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
168
1185.2.13 by Lalo Martins
polishing up the RevisionSpec api, as per suggestions from Robert
169
    if revision2 is None:
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
170
        new_tree = b.working_tree()
171
    else:
1185.2.14 by Lalo Martins
fixing up users of RevisionSpec, and moving it over to commands.py
172
        new_tree = b.revision_tree(revision2.in_branch(b).rev_id)
329 by Martin Pool
- refactor command functions into command classes
173
1092.1.47 by Robert Collins
make show_diff redirectable
174
    show_diff_trees(old_tree, new_tree, output, specific_files,
571 by Martin Pool
- new --diff-options to pass options through to external
175
                    external_diff_options)
176
177
178
179
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
180
                    external_diff_options=None):
550 by Martin Pool
- Refactor diff code into one that works purely on
181
    """Show in text form the changes from one tree to another.
182
183
    to_files
184
        If set, include only changes to these files.
571 by Martin Pool
- new --diff-options to pass options through to external
185
186
    external_diff_options
187
        If set, use an external GNU diff and pass these options.
550 by Martin Pool
- Refactor diff code into one that works purely on
188
    """
189
329 by Martin Pool
- refactor command functions into command classes
190
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
191
    old_label = ''
192
    new_label = ''
193
194
    DEVNULL = '/dev/null'
195
    # Windows users, don't panic about this filename -- it is a
196
    # special signal to GNU patch that the file should be created or
197
    # deleted respectively.
198
199
    # TODO: Generation of pseudo-diffs for added/deleted files could
200
    # be usefully made into a much faster special case.
201
571 by Martin Pool
- new --diff-options to pass options through to external
202
    if external_diff_options:
203
        assert isinstance(external_diff_options, basestring)
204
        opts = external_diff_options.split()
205
        def diff_file(olab, olines, nlab, nlines, to_file):
206
            external_diff(olab, olines, nlab, nlines, to_file, opts)
207
    else:
208
        diff_file = internal_diff
209
    
210
478 by Martin Pool
- put back support for running diff or status on
211
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
483 by Martin Pool
- change 'file_list' to more explanatory 'specific_files'
212
                          specific_files=specific_files)
475 by Martin Pool
- rewrite diff using compare_trees()
213
214
    for path, file_id, kind in delta.removed:
1092.1.50 by Robert Collins
make diff lsdiff/filterdiff friendly
215
        print >>to_file, '=== removed %s %r' % (kind, path)
475 by Martin Pool
- rewrite diff using compare_trees()
216
        if kind == 'file':
568 by Martin Pool
- start adding support for showing diffs by calling out to
217
            diff_file(old_label + path,
218
                      old_tree.get_file(file_id).readlines(),
219
                      DEVNULL, 
220
                      [],
221
                      to_file)
475 by Martin Pool
- rewrite diff using compare_trees()
222
223
    for path, file_id, kind in delta.added:
1092.1.50 by Robert Collins
make diff lsdiff/filterdiff friendly
224
        print >>to_file, '=== added %s %r' % (kind, path)
475 by Martin Pool
- rewrite diff using compare_trees()
225
        if kind == 'file':
568 by Martin Pool
- start adding support for showing diffs by calling out to
226
            diff_file(DEVNULL,
227
                      [],
228
                      new_label + path,
229
                      new_tree.get_file(file_id).readlines(),
230
                      to_file)
475 by Martin Pool
- rewrite diff using compare_trees()
231
232
    for old_path, new_path, file_id, kind, text_modified in delta.renamed:
1092.1.50 by Robert Collins
make diff lsdiff/filterdiff friendly
233
        print >>to_file, '=== renamed %s %r => %r' % (kind, old_path, new_path)
475 by Martin Pool
- rewrite diff using compare_trees()
234
        if text_modified:
568 by Martin Pool
- start adding support for showing diffs by calling out to
235
            diff_file(old_label + old_path,
236
                      old_tree.get_file(file_id).readlines(),
237
                      new_label + new_path,
238
                      new_tree.get_file(file_id).readlines(),
239
                      to_file)
475 by Martin Pool
- rewrite diff using compare_trees()
240
241
    for path, file_id, kind in delta.modified:
1092.1.50 by Robert Collins
make diff lsdiff/filterdiff friendly
242
        print >>to_file, '=== modified %s %r' % (kind, path)
475 by Martin Pool
- rewrite diff using compare_trees()
243
        if kind == 'file':
568 by Martin Pool
- start adding support for showing diffs by calling out to
244
            diff_file(old_label + path,
245
                      old_tree.get_file(file_id).readlines(),
246
                      new_label + path,
247
                      new_tree.get_file(file_id).readlines(),
248
                      to_file)
329 by Martin Pool
- refactor command functions into command classes
249
250
379 by Martin Pool
- Simpler compare_inventories() to possibly replace diff_trees
251
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
252
253