~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-30 22:27:17 UTC
  • Revision ID: mbp@sourcefrog.net-20050330222717-027b5837127b938d
experiment with new nested inventory file format
not used by default yet

Show diffs side-by-side

added added

removed removed

Lines of Context:
15
15
# along with this program; if not, write to the Free Software
16
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
17
 
18
 
from bzrlib.trace import mutter
19
 
from bzrlib.errors import BzrError
20
 
from bzrlib.delta import compare_trees
21
 
 
22
 
# TODO: Rather than building a changeset object, we should probably
23
 
# invoke callbacks on an object.  That object can either accumulate a
24
 
# list, write them out directly, etc etc.
25
 
 
26
 
def internal_diff(old_label, oldlines, new_label, newlines, to_file):
27
 
    import difflib
28
 
    
29
 
    # FIXME: difflib is wrong if there is no trailing newline.
30
 
    # The syntax used by patch seems to be "\ No newline at
31
 
    # end of file" following the last diff line from that
32
 
    # file.  This is not trivial to insert into the
33
 
    # unified_diff output and it might be better to just fix
34
 
    # or replace that function.
35
 
 
36
 
    # In the meantime we at least make sure the patch isn't
37
 
    # mangled.
38
 
 
39
 
 
40
 
    # Special workaround for Python2.3, where difflib fails if
41
 
    # both sequences are empty.
42
 
    if not oldlines and not newlines:
43
 
        return
44
 
 
45
 
    ud = difflib.unified_diff(oldlines, newlines,
46
 
                              fromfile=old_label, tofile=new_label)
47
 
 
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 = list(ud)
52
 
        ud[2] = ud[2].replace('-1,0', '-0,0')
53
 
    elif not newlines:
54
 
        ud = list(ud)
55
 
        ud[2] = ud[2].replace('+1,0', '+0,0')
56
 
 
57
 
    for line in ud:
58
 
        to_file.write(line)
59
 
        if not line.endswith('\n'):
60
 
            to_file.write("\n\\ No newline at end of file\n")
61
 
    print >>to_file
62
 
 
63
 
 
64
 
 
65
 
 
66
 
def external_diff(old_label, oldlines, new_label, newlines, to_file,
67
 
                  diff_opts):
68
 
    """Display a diff by calling out to the external diff program."""
69
 
    import sys
70
 
    
71
 
    if to_file != sys.stdout:
72
 
        raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
73
 
                                  to_file)
74
 
 
75
 
    # make sure our own output is properly ordered before the diff
76
 
    to_file.flush()
77
 
 
78
 
    from tempfile import NamedTemporaryFile
79
 
    import os
80
 
 
81
 
    oldtmpf = NamedTemporaryFile()
82
 
    newtmpf = NamedTemporaryFile()
83
 
 
84
 
    try:
85
 
        # TODO: perhaps a special case for comparing to or from the empty
86
 
        # sequence; can just use /dev/null on Unix
87
 
 
88
 
        # TODO: if either of the files being compared already exists as a
89
 
        # regular named file (e.g. in the working directory) then we can
90
 
        # compare directly to that, rather than copying it.
91
 
 
92
 
        oldtmpf.writelines(oldlines)
93
 
        newtmpf.writelines(newlines)
94
 
 
95
 
        oldtmpf.flush()
96
 
        newtmpf.flush()
97
 
 
98
 
        if not diff_opts:
99
 
            diff_opts = []
100
 
        diffcmd = ['diff',
101
 
                   '--label', old_label,
102
 
                   oldtmpf.name,
103
 
                   '--label', new_label,
104
 
                   newtmpf.name]
105
 
 
106
 
        # diff only allows one style to be specified; they don't override.
107
 
        # note that some of these take optargs, and the optargs can be
108
 
        # directly appended to the options.
109
 
        # this is only an approximate parser; it doesn't properly understand
110
 
        # the grammar.
111
 
        for s in ['-c', '-u', '-C', '-U',
112
 
                  '-e', '--ed',
113
 
                  '-q', '--brief',
114
 
                  '--normal',
115
 
                  '-n', '--rcs',
116
 
                  '-y', '--side-by-side',
117
 
                  '-D', '--ifdef']:
118
 
            for j in diff_opts:
119
 
                if j.startswith(s):
120
 
                    break
121
 
            else:
122
 
                continue
123
 
            break
124
 
        else:
125
 
            diffcmd.append('-u')
126
 
                  
127
 
        if diff_opts:
128
 
            diffcmd.extend(diff_opts)
129
 
 
130
 
        rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
131
 
        
132
 
        if rc != 0 and rc != 1:
133
 
            # returns 1 if files differ; that's OK
134
 
            if rc < 0:
135
 
                msg = 'signal %d' % (-rc)
136
 
            else:
137
 
                msg = 'exit code %d' % rc
138
 
                
139
 
            raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
140
 
    finally:
141
 
        oldtmpf.close()                 # and delete
142
 
        newtmpf.close()
143
 
    
144
 
 
145
 
 
146
 
def show_diff(b, revision, specific_files, external_diff_options=None,
147
 
              revision2=None):
148
 
    """Shortcut for showing the diff to the working tree.
149
 
 
150
 
    b
151
 
        Branch.
152
 
 
153
 
    revision
154
 
        None for each, or otherwise the old revision to compare against.
155
 
    
156
 
    The more general form is show_diff_trees(), where the caller
157
 
    supplies any two trees.
158
 
    """
159
 
    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
 
 
174
 
 
175
 
 
176
 
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
177
 
                    external_diff_options=None):
178
 
    """Show in text form the changes from one tree to another.
179
 
 
180
 
    to_files
181
 
        If set, include only changes to these files.
182
 
 
183
 
    external_diff_options
184
 
        If set, use an external GNU diff and pass these options.
185
 
    """
186
 
 
187
 
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
188
 
    old_label = ''
189
 
    new_label = ''
190
 
 
191
 
    DEVNULL = '/dev/null'
192
 
    # Windows users, don't panic about this filename -- it is a
193
 
    # special signal to GNU patch that the file should be created or
194
 
    # deleted respectively.
195
 
 
196
 
    # TODO: Generation of pseudo-diffs for added/deleted files could
197
 
    # be usefully made into a much faster special case.
198
 
 
199
 
    if external_diff_options:
200
 
        assert isinstance(external_diff_options, basestring)
201
 
        opts = external_diff_options.split()
202
 
        def diff_file(olab, olines, nlab, nlines, to_file):
203
 
            external_diff(olab, olines, nlab, nlines, to_file, opts)
204
 
    else:
205
 
        diff_file = internal_diff
206
 
    
207
 
 
208
 
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
209
 
                          specific_files=specific_files)
210
 
 
211
 
    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
 
 
220
 
    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)
231
 
        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
 
 
 
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_name == new_name
 
125
            assert old_kind == new_kind
 
126
 
 
127
            if old_kind == 'directory':
 
128
                yield '.', new_id, old_name, new_name, new_kind
 
129
            elif old_tree.get_file_size(old_id) != new_tree.get_file_size(old_id):
 
130
                mutter("    file size has changed, must be different")
 
131
                yield 'M', new_id, old_name, new_name, new_kind
 
132
            elif old_tree.get_file_sha1(old_id) == new_tree.get_file_sha1(old_id):
 
133
                mutter("      SHA1 indicates they're identical")
 
134
                ## assert compare_files(old_tree.get_file(i), new_tree.get_file(i))
 
135
                yield '.', new_id, old_name, new_name, new_kind
 
136
            else:
 
137
                mutter("      quick compare shows different")
 
138
                yield 'M', new_id, old_name, new_name, new_kind
 
139
 
 
140
            new_item = next(new_it)
 
141
            old_item = next(old_it)
249
142
 
250
143