~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Martin Pool
  • Date: 2005-05-17 06:56:16 UTC
  • Revision ID: mbp@sourcefrog.net-20050517065616-6f23381d6184a8aa
- add space for un-merged patches

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 sets import Set, ImmutableSet
 
19
 
18
20
from trace import mutter
19
21
from errors import BzrError
20
22
 
21
23
 
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
24
 
26
 
def internal_diff(old_label, oldlines, new_label, newlines, to_file):
 
25
def _diff_one(oldlines, newlines, to_file, **kw):
27
26
    import difflib
28
27
    
29
28
    # FIXME: difflib is wrong if there is no trailing newline.
51
50
        newlines[-1] += '\n'
52
51
        nonl = True
53
52
 
54
 
    ud = difflib.unified_diff(oldlines, newlines,
55
 
                              fromfile=old_label, tofile=new_label)
 
53
    ud = difflib.unified_diff(oldlines, newlines, **kw)
56
54
 
57
55
    # work-around for difflib being too smart for its own good
58
56
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
69
67
    print >>to_file
70
68
 
71
69
 
72
 
 
73
 
 
74
 
def external_diff(old_label, oldlines, new_label, newlines, to_file,
75
 
                  diff_opts):
76
 
    """Display a diff by calling out to the external diff program."""
77
 
    import sys
78
 
    
79
 
    if to_file != sys.stdout:
80
 
        raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
81
 
                                  to_file)
82
 
 
83
 
    # make sure our own output is properly ordered before the diff
84
 
    to_file.flush()
85
 
 
86
 
    from tempfile import NamedTemporaryFile
87
 
    import os
88
 
 
89
 
    oldtmpf = NamedTemporaryFile()
90
 
    newtmpf = NamedTemporaryFile()
91
 
 
92
 
    try:
93
 
        # TODO: perhaps a special case for comparing to or from the empty
94
 
        # sequence; can just use /dev/null on Unix
95
 
 
96
 
        # TODO: if either of the files being compared already exists as a
97
 
        # regular named file (e.g. in the working directory) then we can
98
 
        # compare directly to that, rather than copying it.
99
 
 
100
 
        oldtmpf.writelines(oldlines)
101
 
        newtmpf.writelines(newlines)
102
 
 
103
 
        oldtmpf.flush()
104
 
        newtmpf.flush()
105
 
 
106
 
        if not diff_opts:
107
 
            diff_opts = []
108
 
        diffcmd = ['diff',
109
 
                   '--label', old_label,
110
 
                   oldtmpf.name,
111
 
                   '--label', new_label,
112
 
                   newtmpf.name]
113
 
 
114
 
        # diff only allows one style to be specified; they don't override.
115
 
        # note that some of these take optargs, and the optargs can be
116
 
        # directly appended to the options.
117
 
        # this is only an approximate parser; it doesn't properly understand
118
 
        # the grammar.
119
 
        for s in ['-c', '-u', '-C', '-U',
120
 
                  '-e', '--ed',
121
 
                  '-q', '--brief',
122
 
                  '--normal',
123
 
                  '-n', '--rcs',
124
 
                  '-y', '--side-by-side',
125
 
                  '-D', '--ifdef']:
126
 
            for j in diff_opts:
127
 
                if j.startswith(s):
128
 
                    break
129
 
            else:
130
 
                continue
131
 
            break
132
 
        else:
133
 
            diffcmd.append('-u')
134
 
                  
135
 
        if diff_opts:
136
 
            diffcmd.extend(diff_opts)
137
 
 
138
 
        rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
139
 
        
140
 
        if rc != 0 and rc != 1:
141
 
            # returns 1 if files differ; that's OK
142
 
            if rc < 0:
143
 
                msg = 'signal %d' % (-rc)
144
 
            else:
145
 
                msg = 'exit code %d' % rc
146
 
                
147
 
            raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
148
 
    finally:
149
 
        oldtmpf.close()                 # and delete
150
 
        newtmpf.close()
151
 
    
152
 
 
153
 
 
154
 
def show_diff(b, revision, specific_files, external_diff_options=None):
155
 
    """Shortcut for showing the diff to the working tree.
156
 
 
157
 
    b
158
 
        Branch.
159
 
 
160
 
    revision
161
 
        None for each, or otherwise the old revision to compare against.
162
 
    
163
 
    The more general form is show_diff_trees(), where the caller
164
 
    supplies any two trees.
165
 
    """
 
70
def show_diff(b, revision, specific_files):
166
71
    import sys
167
72
 
168
73
    if revision == None:
172
77
        
173
78
    new_tree = b.working_tree()
174
79
 
175
 
    show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
176
 
                    external_diff_options)
177
 
 
178
 
 
179
 
 
180
 
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
181
 
                    external_diff_options=None):
182
 
    """Show in text form the changes from one tree to another.
183
 
 
184
 
    to_files
185
 
        If set, include only changes to these files.
186
 
 
187
 
    external_diff_options
188
 
        If set, use an external GNU diff and pass these options.
189
 
    """
190
 
 
191
80
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
192
81
    old_label = ''
193
82
    new_label = ''
200
89
    # TODO: Generation of pseudo-diffs for added/deleted files could
201
90
    # be usefully made into a much faster special case.
202
91
 
203
 
    if external_diff_options:
204
 
        assert isinstance(external_diff_options, basestring)
205
 
        opts = external_diff_options.split()
206
 
        def diff_file(olab, olines, nlab, nlines, to_file):
207
 
            external_diff(olab, olines, nlab, nlines, to_file, opts)
208
 
    else:
209
 
        diff_file = internal_diff
210
 
    
211
 
 
212
92
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
213
93
                          specific_files=specific_files)
214
94
 
215
95
    for path, file_id, kind in delta.removed:
216
 
        print >>to_file, '*** removed %s %r' % (kind, path)
 
96
        print '*** removed %s %r' % (kind, path)
217
97
        if kind == 'file':
218
 
            diff_file(old_label + path,
219
 
                      old_tree.get_file(file_id).readlines(),
220
 
                      DEVNULL, 
221
 
                      [],
222
 
                      to_file)
 
98
            _diff_one(old_tree.get_file(file_id).readlines(),
 
99
                   [],
 
100
                   sys.stdout,
 
101
                   fromfile=old_label + path,
 
102
                   tofile=DEVNULL)
223
103
 
224
104
    for path, file_id, kind in delta.added:
225
 
        print >>to_file, '*** added %s %r' % (kind, path)
 
105
        print '*** added %s %r' % (kind, path)
226
106
        if kind == 'file':
227
 
            diff_file(DEVNULL,
228
 
                      [],
229
 
                      new_label + path,
230
 
                      new_tree.get_file(file_id).readlines(),
231
 
                      to_file)
 
107
            _diff_one([],
 
108
                   new_tree.get_file(file_id).readlines(),
 
109
                   sys.stdout,
 
110
                   fromfile=DEVNULL,
 
111
                   tofile=new_label + path)
232
112
 
233
113
    for old_path, new_path, file_id, kind, text_modified in delta.renamed:
234
 
        print >>to_file, '*** renamed %s %r => %r' % (kind, old_path, new_path)
 
114
        print '*** renamed %s %r => %r' % (kind, old_path, new_path)
235
115
        if text_modified:
236
 
            diff_file(old_label + old_path,
237
 
                      old_tree.get_file(file_id).readlines(),
238
 
                      new_label + new_path,
239
 
                      new_tree.get_file(file_id).readlines(),
240
 
                      to_file)
 
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)
241
121
 
242
122
    for path, file_id, kind in delta.modified:
243
 
        print >>to_file, '*** modified %s %r' % (kind, path)
 
123
        print '*** modified %s %r' % (kind, path)
244
124
        if kind == 'file':
245
 
            diff_file(old_label + path,
246
 
                      old_tree.get_file(file_id).readlines(),
247
 
                      new_label + path,
248
 
                      new_tree.get_file(file_id).readlines(),
249
 
                      to_file)
250
 
 
251
 
 
252
 
 
253
 
class TreeDelta(object):
 
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:
254
134
    """Describes changes from one tree to another.
255
135
 
256
136
    Contains four lists:
271
151
    Files that are both modified and renamed are listed only in
272
152
    renamed, with the text_modified flag true.
273
153
 
274
 
    Files are only considered renamed if their name has changed or
275
 
    their parent directory has changed.  Renaming a directory
276
 
    does not count as renaming all its contents.
277
 
 
278
154
    The lists are normally sorted when the delta is created.
279
155
    """
280
156
    def __init__(self):
284
160
        self.modified = []
285
161
        self.unchanged = []
286
162
 
287
 
    def __eq__(self, other):
288
 
        if not isinstance(other, TreeDelta):
289
 
            return False
290
 
        return self.added == other.added \
291
 
               and self.removed == other.removed \
292
 
               and self.renamed == other.renamed \
293
 
               and self.modified == other.modified \
294
 
               and self.unchanged == other.unchanged
295
 
 
296
 
    def __ne__(self, other):
297
 
        return not (self == other)
298
 
 
299
 
    def __repr__(self):
300
 
        return "TreeDelta(added=%r, removed=%r, renamed=%r, modified=%r," \
301
 
            " unchanged=%r)" % (self.added, self.removed, self.renamed,
302
 
            self.modified, self.unchanged)
303
 
 
304
 
    def has_changed(self):
305
 
        changes = len(self.added) + len(self.removed) + len(self.renamed)
306
 
        changes += len(self.modified) 
307
 
        return (changes != 0)
308
 
 
309
 
    def touches_file_id(self, file_id):
310
 
        """Return True if file_id is modified by this delta."""
311
 
        for l in self.added, self.removed, self.modified:
312
 
            for v in l:
313
 
                if v[1] == file_id:
314
 
                    return True
315
 
        for v in self.renamed:
316
 
            if v[2] == file_id:
317
 
                return True
318
 
        return False
319
 
            
320
 
 
321
163
    def show(self, to_file, show_ids=False, show_unchanged=False):
322
164
        def show_list(files):
323
165
            for path, fid, kind in files:
357
199
 
358
200
 
359
201
 
360
 
def compare_trees(old_tree, new_tree, want_unchanged=False, specific_files=None):
 
202
def compare_trees(old_tree, new_tree, want_unchanged, specific_files=None):
361
203
    """Describe changes from one tree to another.
362
204
 
363
205
    Returns a TreeDelta with details of added, modified, renamed, and
400
242
            old_path = old_inv.id2path(file_id)
401
243
            new_path = new_inv.id2path(file_id)
402
244
 
403
 
            old_ie = old_inv[file_id]
404
 
            new_ie = new_inv[file_id]
405
 
 
406
245
            if specific_files:
407
246
                if (not is_inside_any(specific_files, old_path) 
408
247
                    and not is_inside_any(specific_files, new_path)):
421
260
            # the same and the parents are unchanged all the way up.
422
261
            # May not be worthwhile.
423
262
            
424
 
            if (old_ie.name != new_ie.name
425
 
                or old_ie.parent_id != new_ie.parent_id):
 
263
            if old_path != new_path:
426
264
                delta.renamed.append((old_path, new_path, file_id, kind,
427
265
                                      text_modified))
428
266
            elif text_modified:
430
268
            elif want_unchanged:
431
269
                delta.unchanged.append((new_path, file_id, kind))
432
270
        else:
433
 
            kind = old_inv.get_file_kind(file_id)
434
271
            old_path = old_inv.id2path(file_id)
435
272
            if specific_files:
436
273
                if not is_inside_any(specific_files, old_path):