← 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-28 05:33:40 UTC
  • Revision ID: mbp@sourcefrog.net-20050628053340-ea73b03fbcde9c46
- Remove XMLMixin class in favour of simple pack_xml, unpack_xml functions
  called as needed.  

- Avoid importing xml and ElementTree library unless needed.

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
 
 
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.
24
25
 
25
 
def _diff_one(oldlines, newlines, to_file, **kw):
 
26
def internal_diff(old_label, oldlines, new_label, newlines, to_file):
26
27
    import difflib
27
28
    
28
29
    # FIXME: difflib is wrong if there is no trailing newline.
50
51
        newlines[-1] += '\n'
51
52
        nonl = True
52
53
 
53
 
    ud = difflib.unified_diff(oldlines, newlines, **kw)
 
54
    ud = difflib.unified_diff(oldlines, newlines,
 
55
                              fromfile=old_label, tofile=new_label)
54
56
 
55
57
    # work-around for difflib being too smart for its own good
56
58
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
67
69
    print >>to_file
68
70
 
69
71
 
70
 
def show_diff(b, revision, specific_files):
 
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
    """
71
166
    import sys
72
167
 
73
168
    if revision == None:
77
172
        
78
173
    new_tree = b.working_tree()
79
174
 
 
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
 
80
191
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
81
192
    old_label = ''
82
193
    new_label = ''
89
200
    # TODO: Generation of pseudo-diffs for added/deleted files could
90
201
    # be usefully made into a much faster special case.
91
202
 
 
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
 
92
212
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
93
213
                          specific_files=specific_files)
94
214
 
95
215
    for path, file_id, kind in delta.removed:
96
 
        print '*** removed %s %r' % (kind, path)
 
216
        print >>to_file, '*** removed %s %r' % (kind, path)
97
217
        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)
 
218
            diff_file(old_label + path,
 
219
                      old_tree.get_file(file_id).readlines(),
 
220
                      DEVNULL, 
 
221
                      [],
 
222
                      to_file)
103
223
 
104
224
    for path, file_id, kind in delta.added:
105
 
        print '*** added %s %r' % (kind, path)
 
225
        print >>to_file, '*** added %s %r' % (kind, path)
106
226
        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)
 
227
            diff_file(DEVNULL,
 
228
                      [],
 
229
                      new_label + path,
 
230
                      new_tree.get_file(file_id).readlines(),
 
231
                      to_file)
112
232
 
113
233
    for old_path, new_path, file_id, kind, text_modified in delta.renamed:
114
 
        print '*** renamed %s %r => %r' % (kind, old_path, new_path)
 
234
        print >>to_file, '*** renamed %s %r => %r' % (kind, old_path, new_path)
115
235
        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)
 
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)
121
241
 
122
242
    for path, file_id, kind in delta.modified:
123
 
        print '*** modified %s %r' % (kind, path)
 
243
        print >>to_file, '*** modified %s %r' % (kind, path)
124
244
        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:
 
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):
134
254
    """Describes changes from one tree to another.
135
255
 
136
256
    Contains four lists:
151
271
    Files that are both modified and renamed are listed only in
152
272
    renamed, with the text_modified flag true.
153
273
 
 
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
 
154
278
    The lists are normally sorted when the delta is created.
155
279
    """
156
280
    def __init__(self):
160
284
        self.modified = []
161
285
        self.unchanged = []
162
286
 
 
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
 
163
321
    def show(self, to_file, show_ids=False, show_unchanged=False):
164
322
        def show_list(files):
165
323
            for path, fid, kind in files:
199
357
 
200
358
 
201
359
 
202
 
def compare_trees(old_tree, new_tree, want_unchanged, specific_files=None):
 
360
def compare_trees(old_tree, new_tree, want_unchanged=False, specific_files=None):
203
361
    """Describe changes from one tree to another.
204
362
 
205
363
    Returns a TreeDelta with details of added, modified, renamed, and
242
400
            old_path = old_inv.id2path(file_id)
243
401
            new_path = new_inv.id2path(file_id)
244
402
 
 
403
            old_ie = old_inv[file_id]
 
404
            new_ie = new_inv[file_id]
 
405
 
245
406
            if specific_files:
246
407
                if (not is_inside_any(specific_files, old_path) 
247
408
                    and not is_inside_any(specific_files, new_path)):
260
421
            # the same and the parents are unchanged all the way up.
261
422
            # May not be worthwhile.
262
423
            
263
 
            if old_path != new_path:
 
424
            if (old_ie.name != new_ie.name
 
425
                or old_ie.parent_id != new_ie.parent_id):
264
426
                delta.renamed.append((old_path, new_path, file_id, kind,
265
427
                                      text_modified))
266
428
            elif text_modified:
268
430
            elif want_unchanged:
269
431
                delta.unchanged.append((new_path, file_id, kind))
270
432
        else:
 
433
            kind = old_inv.get_file_kind(file_id)
271
434
            old_path = old_inv.id2path(file_id)
272
435
            if specific_files:
273
436
                if not is_inside_any(specific_files, old_path):