← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Martin Pool
  • Date: 2005-06-10 07:13:33 UTC
  • Revision ID: mbp@sourcefrog.net-20050610071333-23ae2f973a1eb0f5
doc

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/diff.py
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 sets import Set, ImmutableSet
19
 
 
20
18
from trace import mutter
21
19
from errors import BzrError
22
20
 
23
21
 
24
 
 
25
 
def _diff_one(oldlines, newlines, to_file, **kw):
 
22
def internal_diff(old_label, oldlines, new_label, newlines, to_file):
26
23
    import difflib
27
24
    
28
25
    # FIXME: difflib is wrong if there is no trailing newline.
50
47
        newlines[-1] += '\n'
51
48
        nonl = True
52
49
 
53
 
    ud = difflib.unified_diff(oldlines, newlines, **kw)
 
50
    ud = difflib.unified_diff(oldlines, newlines,
 
51
                              fromfile=old_label, tofile=new_label)
54
52
 
55
53
    # work-around for difflib being too smart for its own good
56
54
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
67
65
    print >>to_file
68
66
 
69
67
 
70
 
def show_diff(b, revision, specific_files):
 
68
 
 
69
 
 
70
def external_diff(old_label, oldlines, new_label, newlines, to_file,
 
71
                  diff_opts):
 
72
    """Display a diff by calling out to the external diff program."""
 
73
    import sys
 
74
    
 
75
    if to_file != sys.stdout:
 
76
        raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
 
77
                                  to_file)
 
78
 
 
79
    # make sure our own output is properly ordered before the diff
 
80
    to_file.flush()
 
81
 
 
82
    from tempfile import NamedTemporaryFile
 
83
    import os
 
84
 
 
85
    oldtmpf = NamedTemporaryFile()
 
86
    newtmpf = NamedTemporaryFile()
 
87
 
 
88
    try:
 
89
        # TODO: perhaps a special case for comparing to or from the empty
 
90
        # sequence; can just use /dev/null on Unix
 
91
 
 
92
        # TODO: if either of the files being compared already exists as a
 
93
        # regular named file (e.g. in the working directory) then we can
 
94
        # compare directly to that, rather than copying it.
 
95
 
 
96
        oldtmpf.writelines(oldlines)
 
97
        newtmpf.writelines(newlines)
 
98
 
 
99
        oldtmpf.flush()
 
100
        newtmpf.flush()
 
101
 
 
102
        if not diff_opts:
 
103
            diff_opts = []
 
104
        diffcmd = ['diff',
 
105
                   '--label', old_label,
 
106
                   oldtmpf.name,
 
107
                   '--label', new_label,
 
108
                   newtmpf.name]
 
109
 
 
110
        # diff only allows one style to be specified; they don't override.
 
111
        # note that some of these take optargs, and the optargs can be
 
112
        # directly appended to the options.
 
113
        # this is only an approximate parser; it doesn't properly understand
 
114
        # the grammar.
 
115
        for s in ['-c', '-u', '-C', '-U',
 
116
                  '-e', '--ed',
 
117
                  '-q', '--brief',
 
118
                  '--normal',
 
119
                  '-n', '--rcs',
 
120
                  '-y', '--side-by-side',
 
121
                  '-D', '--ifdef']:
 
122
            for j in diff_opts:
 
123
                if j.startswith(s):
 
124
                    break
 
125
            else:
 
126
                continue
 
127
            break
 
128
        else:
 
129
            diffcmd.append('-u')
 
130
                  
 
131
        if diff_opts:
 
132
            diffcmd.extend(diff_opts)
 
133
 
 
134
        rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
 
135
        
 
136
        if rc != 0 and rc != 1:
 
137
            # returns 1 if files differ; that's OK
 
138
            if rc < 0:
 
139
                msg = 'signal %d' % (-rc)
 
140
            else:
 
141
                msg = 'exit code %d' % rc
 
142
                
 
143
            raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
 
144
    finally:
 
145
        oldtmpf.close()                 # and delete
 
146
        newtmpf.close()
 
147
    
 
148
 
 
149
 
 
150
def show_diff(b, revision, specific_files, external_diff_options=None):
 
151
    """Shortcut for showing the diff to the working tree.
 
152
 
 
153
    b
 
154
        Branch.
 
155
 
 
156
    revision
 
157
        None for each, or otherwise the old revision to compare against.
 
158
    
 
159
    The more general form is show_diff_trees(), where the caller
 
160
    supplies any two trees.
 
161
    """
71
162
    import sys
72
163
 
73
164
    if revision == None:
77
168
        
78
169
    new_tree = b.working_tree()
79
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
 
80
187
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
81
188
    old_label = ''
82
189
    new_label = ''
89
196
    # TODO: Generation of pseudo-diffs for added/deleted files could
90
197
    # be usefully made into a much faster special case.
91
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
 
92
208
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
93
209
                          specific_files=specific_files)
94
210
 
95
211
    for path, file_id, kind in delta.removed:
96
 
        print '*** removed %s %r' % (kind, path)
 
212
        print >>to_file, '*** removed %s %r' % (kind, path)
97
213
        if kind == 'file':
98
 
            _diff_one(old_tree.get_file(file_id).readlines(),
99
 
                   [],
100
 
                   sys.stdout,
101
 
                   fromfile=old_label + path,
102
 
                   tofile=DEVNULL)
 
214
            diff_file(old_label + path,
 
215
                      old_tree.get_file(file_id).readlines(),
 
216
                      DEVNULL, 
 
217
                      [],
 
218
                      to_file)
103
219
 
104
220
    for path, file_id, kind in delta.added:
105
 
        print '*** added %s %r' % (kind, path)
 
221
        print >>to_file, '*** added %s %r' % (kind, path)
106
222
        if kind == 'file':
107
 
            _diff_one([],
108
 
                   new_tree.get_file(file_id).readlines(),
109
 
                   sys.stdout,
110
 
                   fromfile=DEVNULL,
111
 
                   tofile=new_label + path)
 
223
            diff_file(DEVNULL,
 
224
                      [],
 
225
                      new_label + path,
 
226
                      new_tree.get_file(file_id).readlines(),
 
227
                      to_file)
112
228
 
113
229
    for old_path, new_path, file_id, kind, text_modified in delta.renamed:
114
 
        print '*** renamed %s %r => %r' % (kind, old_path, new_path)
 
230
        print >>to_file, '*** renamed %s %r => %r' % (kind, old_path, new_path)
115
231
        if text_modified:
116
 
            _diff_one(old_tree.get_file(file_id).readlines(),
117
 
                   new_tree.get_file(file_id).readlines(),
118
 
                   sys.stdout,
119
 
                   fromfile=old_label + old_path,
120
 
                   tofile=new_label + new_path)
 
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)
121
237
 
122
238
    for path, file_id, kind in delta.modified:
123
 
        print '*** modified %s %r' % (kind, path)
 
239
        print >>to_file, '*** modified %s %r' % (kind, path)
124
240
        if kind == 'file':
125
 
            _diff_one(old_tree.get_file(file_id).readlines(),
126
 
                   new_tree.get_file(file_id).readlines(),
127
 
                   sys.stdout,
128
 
                   fromfile=old_label + path,
129
 
                   tofile=new_label + path)
130
 
 
131
 
 
132
 
 
133
 
class TreeDelta:
 
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
 
 
249
class TreeDelta(object):
134
250
    """Describes changes from one tree to another.
135
251
 
136
252
    Contains four lists:
160
276
        self.modified = []
161
277
        self.unchanged = []
162
278
 
 
279
    def __repr__(self):
 
280
        return "TreeDelta(added=%r, removed=%r, renamed=%r, modified=%r," \
 
281
            " unchanged=%r)" % (self.added, self.removed, self.renamed,
 
282
            self.modified, self.unchanged)
 
283
 
 
284
    def has_changed(self):
 
285
        changes = len(self.added) + len(self.removed) + len(self.renamed)
 
286
        changes += len(self.modified) 
 
287
        return (changes != 0)
 
288
 
 
289
    def touches_file_id(self, file_id):
 
290
        """Return True if file_id is modified by this delta."""
 
291
        for l in self.added, self.removed, self.modified:
 
292
            for v in l:
 
293
                if v[1] == file_id:
 
294
                    return True
 
295
        for v in self.renamed:
 
296
            if v[2] == file_id:
 
297
                return True
 
298
        return False
 
299
            
 
300
 
163
301
    def show(self, to_file, show_ids=False, show_unchanged=False):
164
302
        def show_list(files):
165
303
            for path, fid, kind in files:
268
406
            elif want_unchanged:
269
407
                delta.unchanged.append((new_path, file_id, kind))
270
408
        else:
 
409
            kind = old_inv.get_file_kind(file_id)
271
410
            old_path = old_inv.id2path(file_id)
272
411
            if specific_files:
273
412
                if not is_inside_any(specific_files, old_path):