1
# -*- coding: UTF-8 -*-
 
 
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.
 
 
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.
 
 
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
 
 
17
from bzrlib.trace import mutter
 
 
18
from bzrlib.errors import BzrError
 
 
19
from bzrlib.delta import compare_trees
 
 
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.
 
 
25
def internal_diff(old_label, oldlines, new_label, newlines, to_file):
 
 
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.
 
 
35
    # In the meantime we at least make sure the patch isn't
 
 
39
    # Special workaround for Python2.3, where difflib fails if
 
 
40
    # both sequences are empty.
 
 
41
    if not oldlines and not newlines:
 
 
44
    ud = difflib.unified_diff(oldlines, newlines,
 
 
45
                              fromfile=old_label, tofile=new_label)
 
 
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
 
 
51
        ud[2] = ud[2].replace('-1,0', '-0,0')
 
 
53
        ud[2] = ud[2].replace('+1,0', '+0,0')
 
 
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'
 
 
60
        if not line.endswith('\n'):
 
 
61
            to_file.write("\n\\ No newline at end of file\n")
 
 
65
def external_diff(old_label, oldlines, new_label, newlines, to_file,
 
 
67
    """Display a diff by calling out to the external diff program."""
 
 
70
    if to_file != sys.stdout:
 
 
71
        raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
 
 
74
    # make sure our own output is properly ordered before the diff
 
 
77
    from tempfile import NamedTemporaryFile
 
 
80
    oldtmpf = NamedTemporaryFile()
 
 
81
    newtmpf = NamedTemporaryFile()
 
 
84
        # TODO: perhaps a special case for comparing to or from the empty
 
 
85
        # sequence; can just use /dev/null on Unix
 
 
87
        # TODO: if either of the files being compared already exists as a
 
 
88
        # regular named file (e.g. in the working directory) then we can
 
 
89
        # compare directly to that, rather than copying it.
 
 
91
        oldtmpf.writelines(oldlines)
 
 
92
        newtmpf.writelines(newlines)
 
 
100
                   '--label', old_label,
 
 
102
                   '--label', new_label,
 
 
105
        # diff only allows one style to be specified; they don't override.
 
 
106
        # note that some of these take optargs, and the optargs can be
 
 
107
        # directly appended to the options.
 
 
108
        # this is only an approximate parser; it doesn't properly understand
 
 
110
        for s in ['-c', '-u', '-C', '-U',
 
 
115
                  '-y', '--side-by-side',
 
 
127
            diffcmd.extend(diff_opts)
 
 
129
        rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
 
 
131
        if rc != 0 and rc != 1:
 
 
132
            # returns 1 if files differ; that's OK
 
 
134
                msg = 'signal %d' % (-rc)
 
 
136
                msg = 'exit code %d' % rc
 
 
138
            raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
 
 
140
        oldtmpf.close()                 # and delete
 
 
143
def show_diff(b, from_spec, specific_files, external_diff_options=None,
 
 
144
              revision2=None, output=None):
 
 
145
    """Shortcut for showing the diff to the working tree.
 
 
151
        None for 'basis tree', or otherwise the old revision to compare against.
 
 
153
    The more general form is show_diff_trees(), where the caller
 
 
154
    supplies any two trees.
 
 
160
    if from_spec is None:
 
 
161
        old_tree = b.basis_tree()
 
 
163
        old_tree = b.revision_tree(from_spec.in_history(b).rev_id)
 
 
165
    if revision2 is None:
 
 
166
        new_tree = b.working_tree()
 
 
168
        new_tree = b.revision_tree(revision2.in_history(b).rev_id)
 
 
170
    show_diff_trees(old_tree, new_tree, output, specific_files,
 
 
171
                    external_diff_options)
 
 
175
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
 
 
176
                    external_diff_options=None):
 
 
177
    """Show in text form the changes from one tree to another.
 
 
180
        If set, include only changes to these files.
 
 
182
    external_diff_options
 
 
183
        If set, use an external GNU diff and pass these options.
 
 
186
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
 
 
190
    DEVNULL = '/dev/null'
 
 
191
    # Windows users, don't panic about this filename -- it is a
 
 
192
    # special signal to GNU patch that the file should be created or
 
 
193
    # deleted respectively.
 
 
195
    # TODO: Generation of pseudo-diffs for added/deleted files could
 
 
196
    # be usefully made into a much faster special case.
 
 
198
    if external_diff_options:
 
 
199
        assert isinstance(external_diff_options, basestring)
 
 
200
        opts = external_diff_options.split()
 
 
201
        def diff_file(olab, olines, nlab, nlines, to_file):
 
 
202
            external_diff(olab, olines, nlab, nlines, to_file, opts)
 
 
204
        diff_file = internal_diff
 
 
207
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
 
 
208
                          specific_files=specific_files)
 
 
210
    for path, file_id, kind in delta.removed:
 
 
211
        print >>to_file, '=== removed %s %r' % (kind, path)
 
 
212
        old_tree.inventory[file_id].diff(diff_file, old_label + path, old_tree,
 
 
213
                                         DEVNULL, None, None, to_file)
 
 
214
    for path, file_id, kind in delta.added:
 
 
215
        print >>to_file, '=== added %s %r' % (kind, path)
 
 
216
        new_tree.inventory[file_id].diff(diff_file, new_label + path, new_tree,
 
 
217
                                         DEVNULL, None, None, to_file, 
 
 
219
    for (old_path, new_path, file_id, kind,
 
 
220
         text_modified, meta_modified) in delta.renamed:
 
 
221
        prop_str = get_prop_change(meta_modified)
 
 
222
        print >>to_file, '=== renamed %s %r => %r%s' % (
 
 
223
                          kind, old_path, new_path, prop_str)
 
 
224
        _maybe_diff_file_or_symlink(old_label, old_path, old_tree, file_id,
 
 
225
                                    new_label, new_path, new_tree,
 
 
226
                                    text_modified, kind, to_file, diff_file)
 
 
227
    for path, file_id, kind, text_modified, meta_modified in delta.modified:
 
 
228
        prop_str = get_prop_change(meta_modified)
 
 
229
        print >>to_file, '=== modified %s %r%s' % (kind, path, prop_str)
 
 
231
            _maybe_diff_file_or_symlink(old_label, path, old_tree, file_id,
 
 
232
                                        new_label, path, new_tree,
 
 
233
                                        True, kind, to_file, diff_file)
 
 
236
def get_prop_change(meta_modified):
 
 
238
        return " (properties changed)"
 
 
243
def _maybe_diff_file_or_symlink(old_label, old_path, old_tree, file_id,
 
 
244
                                new_label, new_path, new_tree, text_modified,
 
 
245
                                kind, to_file, diff_file):
 
 
247
        new_entry = new_tree.inventory[file_id]
 
 
248
        old_tree.inventory[file_id].diff(diff_file,
 
 
249
                                         old_label + old_path, old_tree,
 
 
250
                                         new_label + new_path, new_entry,