~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Robert Collins
  • Date: 2005-10-06 22:15:52 UTC
  • mfrom: (1185.13.2)
  • mto: This revision was merged to the branch mainline in revision 1420.
  • Revision ID: robertc@robertcollins.net-20051006221552-9b15c96fa504e0ad
mergeĀ fromĀ upstream

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#! /usr/bin/env python
2
1
# -*- coding: UTF-8 -*-
3
2
 
4
3
# This program is free software; you can redistribute it and/or modify
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
 
18
 
from sets import Set
19
 
 
20
 
from trace import mutter
21
 
 
22
 
 
23
 
 
24
 
 
25
 
 
26
 
 
27
 
def diff_trees(old_tree, new_tree):
28
 
    """Compute diff between two trees.
29
 
 
30
 
    They may be in different branches and may be working or historical
31
 
    trees.
32
 
 
33
 
    Yields a sequence of (state, id, old_name, new_name, kind).
34
 
    Each filename and each id is listed only once.
35
 
    """
36
 
 
37
 
    ## TODO: Compare files before diffing; only mention those that have changed
38
 
 
39
 
    ## TODO: Set nice names in the headers, maybe include diffstat
40
 
 
41
 
    ## TODO: Perhaps make this a generator rather than using
42
 
    ## a callback object?
43
 
 
44
 
    ## TODO: Allow specifying a list of files to compare, rather than
45
 
    ## doing the whole tree?  (Not urgent.)
46
 
 
47
 
    ## TODO: Allow diffing any two inventories, not just the
48
 
    ## current one against one.  We mgiht need to specify two
49
 
    ## stores to look for the files if diffing two branches.  That
50
 
    ## might imply this shouldn't be primarily a Branch method.
51
 
 
52
 
    ## XXX: This doesn't report on unknown files; that can be done
53
 
    ## from a separate method.
54
 
 
55
 
    old_it = old_tree.list_files()
56
 
    new_it = new_tree.list_files()
57
 
 
58
 
    def next(it):
59
 
        try:
60
 
            return it.next()
61
 
        except StopIteration:
62
 
            return None
63
 
 
64
 
    old_item = next(old_it)
65
 
    new_item = next(new_it)
66
 
 
67
 
    # We step through the two sorted iterators in parallel, trying to
68
 
    # keep them lined up.
69
 
 
70
 
    while (old_item != None) or (new_item != None):
71
 
        # OK, we still have some remaining on both, but they may be
72
 
        # out of step.        
73
 
        if old_item != None:
74
 
            old_name, old_class, old_kind, old_id = old_item
75
 
        else:
76
 
            old_name = None
77
 
            
78
 
        if new_item != None:
79
 
            new_name, new_class, new_kind, new_id = new_item
80
 
        else:
81
 
            new_name = None
82
 
 
83
 
        mutter("   diff pairwise %r" % (old_item,))
84
 
        mutter("                 %r" % (new_item,))
85
 
 
86
 
        if old_item:
87
 
            # can't handle the old tree being a WorkingTree
88
 
            assert old_class == 'V'
89
 
 
90
 
        if new_item and (new_class != 'V'):
91
 
            yield new_class, None, None, new_name, new_kind
92
 
            new_item = next(new_it)
93
 
        elif (not new_item) or (old_item and (old_name < new_name)):
94
 
            mutter("     extra entry in old-tree sequence")
95
 
            if new_tree.has_id(old_id):
96
 
                # will be mentioned as renamed under new name
97
 
                pass
98
 
            else:
99
 
                yield 'D', old_id, old_name, None, old_kind
100
 
            old_item = next(old_it)
101
 
        elif (not old_item) or (new_item and (new_name < old_name)):
102
 
            mutter("     extra entry in new-tree sequence")
103
 
            if old_tree.has_id(new_id):
104
 
                yield 'R', new_id, old_tree.id2path(new_id), new_name, new_kind
105
 
            else:
106
 
                yield 'A', new_id, None, new_name, new_kind
107
 
            new_item = next(new_it)
108
 
        elif old_id != new_id:
109
 
            assert old_name == new_name
110
 
            # both trees have a file of this name, but it is not the
111
 
            # same file.  in other words, the old filename has been
112
 
            # overwritten by either a newly-added or a renamed file.
113
 
            # (should we return something about the overwritten file?)
114
 
            if old_tree.has_id(new_id):
115
 
                # renaming, overlying a deleted file
116
 
                yield 'R', new_id, old_tree.id2path(new_id), new_name, new_kind
117
 
            else:
118
 
                yield 'A', new_id, None, new_name, new_kind
119
 
 
120
 
            new_item = next(new_it)
121
 
            old_item = next(old_it)
122
 
        else:
123
 
            assert old_id == new_id
124
 
            assert old_id != None
125
 
            assert old_name == new_name
126
 
            assert old_kind == new_kind
127
 
 
128
 
            if old_kind == 'directory':
129
 
                yield '.', new_id, old_name, new_name, new_kind
130
 
            elif old_tree.get_file_size(old_id) != new_tree.get_file_size(old_id):
131
 
                mutter("    file size has changed, must be different")
132
 
                yield 'M', new_id, old_name, new_name, new_kind
133
 
            elif old_tree.get_file_sha1(old_id) == new_tree.get_file_sha1(old_id):
134
 
                mutter("      SHA1 indicates they're identical")
135
 
                ## assert compare_files(old_tree.get_file(i), new_tree.get_file(i))
136
 
                yield '.', new_id, old_name, new_name, new_kind
137
 
            else:
138
 
                mutter("      quick compare shows different")
139
 
                yield 'M', new_id, old_name, new_name, new_kind
140
 
 
141
 
            new_item = next(new_it)
142
 
            old_item = next(old_it)
143
 
 
144
 
 
 
17
from bzrlib.trace import mutter
 
18
from bzrlib.errors import BzrError
 
19
from bzrlib.delta import compare_trees
 
20
 
 
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
 
 
25
def internal_diff(old_label, oldlines, new_label, newlines, to_file):
 
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
 
 
44
    ud = difflib.unified_diff(oldlines, newlines,
 
45
                              fromfile=old_label, tofile=new_label)
 
46
 
 
47
    ud = list(ud)
 
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')
 
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'
 
57
 
 
58
    for line in ud:
 
59
        to_file.write(line)
 
60
        if not line.endswith('\n'):
 
61
            to_file.write("\n\\ No newline at end of file\n")
 
62
    print >>to_file
 
63
 
 
64
 
 
65
def external_diff(old_label, oldlines, new_label, newlines, to_file,
 
66
                  diff_opts):
 
67
    """Display a diff by calling out to the external diff program."""
 
68
    import sys
 
69
    
 
70
    if to_file != sys.stdout:
 
71
        raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
 
72
                                  to_file)
 
73
 
 
74
    # make sure our own output is properly ordered before the diff
 
75
    to_file.flush()
 
76
 
 
77
    from tempfile import NamedTemporaryFile
 
78
    import os
 
79
 
 
80
    oldtmpf = NamedTemporaryFile()
 
81
    newtmpf = NamedTemporaryFile()
 
82
 
 
83
    try:
 
84
        # TODO: perhaps a special case for comparing to or from the empty
 
85
        # sequence; can just use /dev/null on Unix
 
86
 
 
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.
 
90
 
 
91
        oldtmpf.writelines(oldlines)
 
92
        newtmpf.writelines(newlines)
 
93
 
 
94
        oldtmpf.flush()
 
95
        newtmpf.flush()
 
96
 
 
97
        if not diff_opts:
 
98
            diff_opts = []
 
99
        diffcmd = ['diff',
 
100
                   '--label', old_label,
 
101
                   oldtmpf.name,
 
102
                   '--label', new_label,
 
103
                   newtmpf.name]
 
104
 
 
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
 
109
        # the grammar.
 
110
        for s in ['-c', '-u', '-C', '-U',
 
111
                  '-e', '--ed',
 
112
                  '-q', '--brief',
 
113
                  '--normal',
 
114
                  '-n', '--rcs',
 
115
                  '-y', '--side-by-side',
 
116
                  '-D', '--ifdef']:
 
117
            for j in diff_opts:
 
118
                if j.startswith(s):
 
119
                    break
 
120
            else:
 
121
                continue
 
122
            break
 
123
        else:
 
124
            diffcmd.append('-u')
 
125
                  
 
126
        if diff_opts:
 
127
            diffcmd.extend(diff_opts)
 
128
 
 
129
        rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
 
130
        
 
131
        if rc != 0 and rc != 1:
 
132
            # returns 1 if files differ; that's OK
 
133
            if rc < 0:
 
134
                msg = 'signal %d' % (-rc)
 
135
            else:
 
136
                msg = 'exit code %d' % rc
 
137
                
 
138
            raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
 
139
    finally:
 
140
        oldtmpf.close()                 # and delete
 
141
        newtmpf.close()
 
142
 
 
143
def show_diff(b, revision, specific_files, external_diff_options=None,
 
144
              revision2=None, output=None):
 
145
    """Shortcut for showing the diff to the working tree.
 
146
 
 
147
    b
 
148
        Branch.
 
149
 
 
150
    revision
 
151
        None for each, or otherwise the old revision to compare against.
 
152
    
 
153
    The more general form is show_diff_trees(), where the caller
 
154
    supplies any two trees.
 
155
    """
 
156
    if output is None:
 
157
        import sys
 
158
        output = sys.stdout
 
159
 
 
160
    if revision is None:
 
161
        old_tree = b.basis_tree()
 
162
    else:
 
163
        old_tree = b.revision_tree(revision.in_history(b).rev_id)
 
164
 
 
165
    if revision2 is None:
 
166
        new_tree = b.working_tree()
 
167
    else:
 
168
        new_tree = b.revision_tree(revision2.in_history(b).rev_id)
 
169
 
 
170
    show_diff_trees(old_tree, new_tree, output, specific_files,
 
171
                    external_diff_options)
 
172
 
 
173
 
 
174
 
 
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.
 
178
 
 
179
    to_files
 
180
        If set, include only changes to these files.
 
181
 
 
182
    external_diff_options
 
183
        If set, use an external GNU diff and pass these options.
 
184
    """
 
185
 
 
186
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
 
187
    old_label = ''
 
188
    new_label = ''
 
189
 
 
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.
 
194
 
 
195
    # TODO: Generation of pseudo-diffs for added/deleted files could
 
196
    # be usefully made into a much faster special case.
 
197
 
 
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)
 
203
    else:
 
204
        diff_file = internal_diff
 
205
    
 
206
 
 
207
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
 
208
                          specific_files=specific_files)
 
209
 
 
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, 
 
218
                                         reverse=True)
 
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)
 
230
        if text_modified:
 
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)
 
234
    
 
235
 
 
236
def get_prop_change(meta_modified):
 
237
    if meta_modified:
 
238
        return " (properties changed)"
 
239
    else:
 
240
        return  ""
 
241
 
 
242
 
 
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):
 
246
    if text_modified:
 
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, 
 
251
                                         new_tree, to_file)