← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/delta.py

  • Committer: Ian Clatworthy
  • Date: 2007-03-22 01:02:07 UTC
  • mto: (2370.2.1 jam-integration)
  • mto: This revision was merged to the branch mainline in revision 2371.
  • Revision ID: ian.clatworthy@internode.on.net-20070322010207-r8xcwjshipoahmcx
Minor corrections to HACKING

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/delta.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
from __future__ import absolute_import
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18
16
 
19
17
from bzrlib import (
 
18
    errors,
20
19
    osutils,
21
20
    )
22
 
from bzrlib.trace import is_quiet
 
21
from bzrlib.inventory import InventoryEntry
 
22
from bzrlib.trace import mutter
 
23
from bzrlib.symbol_versioning import deprecated_function, zero_nine
23
24
 
24
25
 
25
26
class TreeDelta(object):
26
27
    """Describes changes from one tree to another.
27
28
 
28
 
    Contains seven lists:
 
29
    Contains four lists:
29
30
 
30
31
    added
31
32
        (path, id, kind)
33
34
        (path, id, kind)
34
35
    renamed
35
36
        (oldpath, newpath, id, kind, text_modified, meta_modified)
36
 
    kind_changed
37
 
        (path, id, old_kind, new_kind)
38
37
    modified
39
38
        (path, id, kind, text_modified, meta_modified)
40
39
    unchanged
41
40
        (path, id, kind)
42
41
    unversioned
43
 
        (path, None, kind)
 
42
        (path, kind)
44
43
 
45
44
    Each id is listed only once.
46
45
 
47
46
    Files that are both modified and renamed are listed only in
48
47
    renamed, with the text_modified flag true. The text_modified
49
 
    applies either to the content of the file or the target of the
 
48
    applies either to the the content of the file or the target of the
50
49
    symbolic link, depending of the kind of file.
51
50
 
52
51
    Files are only considered renamed if their name has changed or
63
62
        self.modified = []
64
63
        self.unchanged = []
65
64
        self.unversioned = []
66
 
        self.missing = []
67
65
 
68
66
    def __eq__(self, other):
69
67
        if not isinstance(other, TreeDelta):
106
104
            if v[1] == file_id:
107
105
                return True
108
106
        return False
109
 
 
110
 
    def get_changes_as_text(self, show_ids=False, show_unchanged=False,
111
 
                            short_status=False):
112
 
        import StringIO
113
 
        output = StringIO.StringIO()
114
 
        report_delta(output, self, short_status, show_ids, show_unchanged)
115
 
        return output.getvalue()
 
107
            
 
108
 
 
109
    def show(self, to_file, show_ids=False, show_unchanged=False,
 
110
             short_status=False):
 
111
        """output this delta in status-like form to to_file."""
 
112
        def show_list(files, short_status_letter=''):
 
113
            for item in files:
 
114
                path, fid, kind = item[:3]
 
115
 
 
116
                if kind == 'directory':
 
117
                    path += '/'
 
118
                elif kind == 'symlink':
 
119
                    path += '@'
 
120
 
 
121
                if len(item) == 5 and item[4]:
 
122
                    path += '*'
 
123
 
 
124
                if show_ids:
 
125
                    print >>to_file, '%s  %-30s %s' % (short_status_letter,
 
126
                        path, fid)
 
127
                else:
 
128
                    print >>to_file, '%s  %s' % (short_status_letter, path)
 
129
            
 
130
        if self.removed:
 
131
            if not short_status:
 
132
                print >>to_file, 'removed:'
 
133
                show_list(self.removed)
 
134
            else:
 
135
                show_list(self.removed, 'D')
 
136
                
 
137
        if self.added:
 
138
            if not short_status:
 
139
                print >>to_file, 'added:'
 
140
                show_list(self.added)
 
141
            else:
 
142
                show_list(self.added, 'A')
 
143
 
 
144
        extra_modified = []
 
145
 
 
146
        if self.renamed:
 
147
            short_status_letter = 'R'
 
148
            if not short_status:
 
149
                print >>to_file, 'renamed:'
 
150
                short_status_letter = ''
 
151
            for (oldpath, newpath, fid, kind,
 
152
                 text_modified, meta_modified) in self.renamed:
 
153
                if text_modified or meta_modified:
 
154
                    extra_modified.append((newpath, fid, kind,
 
155
                                           text_modified, meta_modified))
 
156
                if meta_modified:
 
157
                    newpath += '*'
 
158
                if show_ids:
 
159
                    print >>to_file, '%s  %s => %s %s' % (
 
160
                        short_status_letter, oldpath, newpath, fid)
 
161
                else:
 
162
                    print >>to_file, '%s  %s => %s' % (
 
163
                        short_status_letter, oldpath, newpath)
 
164
 
 
165
        if self.kind_changed:
 
166
            if short_status:
 
167
                short_status_letter = 'K'
 
168
            else:
 
169
                print >>to_file, 'kind changed:'
 
170
                short_status_letter = ''
 
171
            for (path, fid, old_kind, new_kind) in self.kind_changed:
 
172
                if show_ids:
 
173
                    suffix = ' '+fid
 
174
                else:
 
175
                    suffix = ''
 
176
                print >>to_file, '%s  %s (%s => %s)%s' % (
 
177
                    short_status_letter, path, old_kind, new_kind, suffix)
 
178
 
 
179
        if self.modified or extra_modified:
 
180
            short_status_letter = 'M'
 
181
            if not short_status:
 
182
                print >>to_file, 'modified:'
 
183
                short_status_letter = ''
 
184
            show_list(self.modified, short_status_letter)
 
185
            show_list(extra_modified, short_status_letter)
 
186
            
 
187
        if show_unchanged and self.unchanged:
 
188
            if not short_status:
 
189
                print >>to_file, 'unchanged:'
 
190
                show_list(self.unchanged)
 
191
            else:
 
192
                show_list(self.unchanged, 'S')
 
193
 
 
194
        if self.unversioned:
 
195
            print >>to_file, 'unknown:'
 
196
            show_list(self.unversioned)
 
197
 
 
198
 
 
199
@deprecated_function(zero_nine)
 
200
def compare_trees(old_tree, new_tree, want_unchanged=False,
 
201
                  specific_files=None, extra_trees=None,
 
202
                  require_versioned=False):
 
203
    """compare_trees was deprecated in 0.10. Please see Tree.changes_from."""
 
204
    return new_tree.changes_from(old_tree,
 
205
        want_unchanged=want_unchanged,
 
206
        specific_files=specific_files,
 
207
        extra_trees=extra_trees,
 
208
        require_versioned=require_versioned,
 
209
        include_root=False)
116
210
 
117
211
 
118
212
def _compare_trees(old_tree, new_tree, want_unchanged, specific_files,
119
213
                   include_root, extra_trees=None,
120
 
                   require_versioned=False, want_unversioned=False):
 
214
                   want_unversioned=False):
121
215
    """Worker function that implements Tree.changes_from."""
122
216
    delta = TreeDelta()
123
217
    # mutter('start compare_trees')
124
218
 
125
219
    for (file_id, path, content_change, versioned, parent_id, name, kind,
126
 
         executable) in new_tree.iter_changes(old_tree, want_unchanged,
 
220
         executable) in new_tree._iter_changes(old_tree, want_unchanged,
127
221
            specific_files, extra_trees=extra_trees,
128
 
            require_versioned=require_versioned,
129
222
            want_unversioned=want_unversioned):
130
223
        if versioned == (False, False):
131
224
            delta.unversioned.append((path[1], None, kind[1]))
138
231
            if fully_present[1] is True:
139
232
                delta.added.append((path[1], file_id, kind[1]))
140
233
            else:
 
234
                assert fully_present[0] is True
141
235
                delta.removed.append((path[0], file_id, kind[0]))
142
236
        elif fully_present[0] is False:
143
 
            delta.missing.append((path[1], file_id, kind[1]))
 
237
            continue
144
238
        elif name[0] != name[1] or parent_id[0] != parent_id[1]:
145
239
            # If the name changes, or the parent_id changes, we have a rename
146
240
            # (if we move a parent, that doesn't count as a rename for the
153
247
                                  (executable[0] != executable[1])))
154
248
        elif kind[0] != kind[1]:
155
249
            delta.kind_changed.append((path[1], file_id, kind[0], kind[1]))
156
 
        elif content_change or executable[0] != executable[1]:
 
250
        elif content_change is True or executable[0] != executable[1]:
157
251
            delta.modified.append((path[1], file_id, kind[1],
158
252
                                   content_change,
159
253
                                   (executable[0] != executable[1])))
163
257
    delta.removed.sort()
164
258
    delta.added.sort()
165
259
    delta.renamed.sort()
166
 
    delta.missing.sort()
167
260
    # TODO: jam 20060529 These lists shouldn't need to be sorted
168
261
    #       since we added them in alphabetical order.
169
262
    delta.modified.sort()
176
269
    """Report changes between two trees"""
177
270
 
178
271
    def __init__(self, output=None, suppress_root_add=True,
179
 
                 output_file=None, unversioned_filter=None, view_info=None,
180
 
                 classify=True):
 
272
                 output_file=None, unversioned_filter=None):
181
273
        """Constructor
182
274
 
183
275
        :param output: a function with the signature of trace.note, i.e.
186
278
            (i.e. when a tree has just been initted)
187
279
        :param output_file: If supplied, a file-like object to write to.
188
280
            Only one of output and output_file may be supplied.
189
 
        :param unversioned_filter: A filter function to be called on
 
281
        :param unversioned_filter: A filter function to be called on 
190
282
            unversioned files. This should return True to ignore a path.
191
283
            By default, no filtering takes place.
192
 
        :param view_info: A tuple of view_name,view_files if only
193
 
            items inside a view are to be reported on, or None for
194
 
            no view filtering.
195
 
        :param classify: Add special symbols to indicate file kind.
196
284
        """
197
285
        if output_file is not None:
198
286
            if output is not None:
208
296
                             'unchanged': ' ',
209
297
                             'created': 'N',
210
298
                             'modified': 'M',
211
 
                             'deleted': 'D',
212
 
                             'missing': '!',
213
 
                             }
 
299
                             'deleted': 'D'}
214
300
        self.versioned_map = {'added': '+', # versioned target
215
301
                              'unchanged': ' ', # versioned in both
216
302
                              'removed': '-', # versioned in source
217
303
                              'unversioned': '?', # versioned in neither
218
304
                              }
219
305
        self.unversioned_filter = unversioned_filter
220
 
        if classify:
221
 
            self.kind_marker = osutils.kind_marker
222
 
        else:
223
 
            self.kind_marker = lambda kind: ''
224
 
        if view_info is None:
225
 
            self.view_name = None
226
 
            self.view_files = []
227
 
        else:
228
 
            self.view_name = view_info[0]
229
 
            self.view_files = view_info[1]
230
 
            self.output("Operating on whole tree but only reporting on "
231
 
                        "'%s' view." % (self.view_name,))
232
306
 
233
307
    def report(self, file_id, paths, versioned, renamed, modified, exe_change,
234
308
               kind):
235
309
        """Report one change to a file
236
310
 
237
311
        :param file_id: The file_id of the file
238
 
        :param path: The old and new paths as generated by Tree.iter_changes.
 
312
        :param path: The old and new paths as generated by Tree._iter_changes.
239
313
        :param versioned: may be 'added', 'removed', 'unchanged', or
240
314
            'unversioned.
241
315
        :param renamed: may be True or False
242
316
        :param modified: may be 'created', 'deleted', 'kind changed',
243
317
            'modified' or 'unchanged'.
244
318
        :param exe_change: True if the execute bit has changed
245
 
        :param kind: A pair of file kinds, as generated by Tree.iter_changes.
 
319
        :param kind: A pair of file kinds, as generated by Tree._iter_changes.
246
320
            None indicates no file present.
247
321
        """
248
 
        if is_quiet():
249
 
            return
250
322
        if paths[1] == '' and versioned == 'added' and self.suppress_root_add:
251
323
            return
252
 
        if self.view_files and not osutils.is_inside_any(self.view_files,
253
 
            paths[1]):
254
 
            return
255
324
        if versioned == 'unversioned':
256
325
            # skip ignored unversioned files if needed.
257
326
            if self.unversioned_filter is not None:
269
338
                # on a rename, we show old and new
270
339
                old_path, path = paths
271
340
            else:
272
 
                # if it's not renamed, we're showing both for kind changes
 
341
                # if its not renamed, we're showing both for kind changes
273
342
                # so only show the new path
274
343
                old_path, path = paths[1], paths[1]
275
344
            # if the file is not missing in the source, we show its kind
276
345
            # when we show two paths.
277
346
            if kind[0] is not None:
278
 
                old_path += self.kind_marker(kind[0])
 
347
                old_path += osutils.kind_marker(kind[0])
279
348
            old_path += " => "
280
349
        elif versioned == 'removed':
281
350
            # not present in target
290
359
            rename = self.versioned_map[versioned]
291
360
        # we show the old kind on the new path when the content is deleted.
292
361
        if modified == 'deleted':
293
 
            path += self.kind_marker(kind[0])
 
362
            path += osutils.kind_marker(kind[0])
294
363
        # otherwise we always show the current kind when there is one
295
364
        elif kind[1] is not None:
296
 
            path += self.kind_marker(kind[1])
 
365
            path += osutils.kind_marker(kind[1])
297
366
        if exe_change:
298
367
            exe = '*'
299
368
        else:
301
370
        self.output("%s%s%s %s%s", rename, self.modified_map[modified], exe,
302
371
                    old_path, path)
303
372
 
 
373
 
304
374
def report_changes(change_iterator, reporter):
305
375
    """Report the changes from a change iterator.
306
376
 
308
378
    Further processing may be required to produce a human-readable output.
309
379
    Unfortunately, some tree-changing operations are very complex
310
380
    :change_iterator: an iterator or sequence of changes in the format
311
 
        generated by Tree.iter_changes
 
381
        generated by Tree._iter_changes
312
382
    :param reporter: The _ChangeReporter that will report the changes.
313
383
    """
314
384
    versioned_change_map = {
337
407
        else:
338
408
            if content_change:
339
409
                modified = "modified"
340
 
            elif kind[0] is None:
341
 
                modified = "missing"
342
410
            else:
343
411
                modified = "unchanged"
344
412
            if kind[1] == "file":
346
414
        versioned_change = versioned_change_map[versioned]
347
415
        reporter.report(file_id, path, versioned_change, renamed, modified,
348
416
                        exe_change, kind)
349
 
 
350
 
def report_delta(to_file, delta, short_status=False, show_ids=False, 
351
 
         show_unchanged=False, indent='', filter=None, classify=True):
352
 
    """Output this delta in status-like form to to_file.
353
 
 
354
 
    :param to_file: A file-like object where the output is displayed.
355
 
 
356
 
    :param delta: A TreeDelta containing the changes to be displayed
357
 
 
358
 
    :param short_status: Single-line status if True.
359
 
 
360
 
    :param show_ids: Output the file ids if True.
361
 
 
362
 
    :param show_unchanged: Output the unchanged files if True.
363
 
 
364
 
    :param indent: Added at the beginning of all output lines (for merged
365
 
        revisions).
366
 
 
367
 
    :param filter: A callable receiving a path and a file id and
368
 
        returning True if the path should be displayed.
369
 
 
370
 
    :param classify: Add special symbols to indicate file kind.
371
 
    """
372
 
 
373
 
    def decorate_path(path, kind, meta_modified=None):
374
 
        if not classify:
375
 
            return path
376
 
        if kind == 'directory':
377
 
            path += '/'
378
 
        elif kind == 'symlink':
379
 
            path += '@'
380
 
        if meta_modified:
381
 
            path += '*'
382
 
        return path
383
 
 
384
 
    def show_more_renamed(item):
385
 
        (oldpath, file_id, kind,
386
 
         text_modified, meta_modified, newpath) = item
387
 
        dec_new_path = decorate_path(newpath, kind, meta_modified)
388
 
        to_file.write(' => %s' % dec_new_path)
389
 
        if text_modified or meta_modified:
390
 
            extra_modified.append((newpath, file_id, kind,
391
 
                                   text_modified, meta_modified))
392
 
 
393
 
    def show_more_kind_changed(item):
394
 
        (path, file_id, old_kind, new_kind) = item
395
 
        to_file.write(' (%s => %s)' % (old_kind, new_kind))
396
 
 
397
 
    def show_path(path, file_id, kind, meta_modified,
398
 
                  default_format, with_file_id_format):
399
 
        dec_path = decorate_path(path, kind, meta_modified)
400
 
        if show_ids:
401
 
            to_file.write(with_file_id_format % dec_path)
402
 
        else:
403
 
            to_file.write(default_format % dec_path)
404
 
 
405
 
    def show_list(files, long_status_name, short_status_letter,
406
 
                  default_format='%s', with_file_id_format='%-30s',
407
 
                  show_more=None):
408
 
        if files:
409
 
            header_shown = False
410
 
            if short_status:
411
 
                prefix = short_status_letter
412
 
            else:
413
 
                prefix = ''
414
 
            prefix = indent + prefix + '  '
415
 
 
416
 
            for item in files:
417
 
                path, file_id, kind = item[:3]
418
 
                if (filter is not None and not filter(path, file_id)):
419
 
                    continue
420
 
                if not header_shown and not short_status:
421
 
                    to_file.write(indent + long_status_name + ':\n')
422
 
                    header_shown = True
423
 
                meta_modified = None
424
 
                if len(item) == 5:
425
 
                    meta_modified = item[4]
426
 
 
427
 
                to_file.write(prefix)
428
 
                show_path(path, file_id, kind, meta_modified,
429
 
                          default_format, with_file_id_format)
430
 
                if show_more is not None:
431
 
                    show_more(item)
432
 
                if show_ids:
433
 
                    to_file.write(' %s' % file_id)
434
 
                to_file.write('\n')
435
 
 
436
 
    show_list(delta.removed, 'removed', 'D')
437
 
    show_list(delta.added, 'added', 'A')
438
 
    show_list(delta.missing, 'missing', '!')
439
 
    extra_modified = []
440
 
    # Reorder delta.renamed tuples so that all lists share the same
441
 
    # order for their 3 first fields and that they also begin like
442
 
    # the delta.modified tuples
443
 
    renamed = [(p, i, k, tm, mm, np)
444
 
               for  p, np, i, k, tm, mm  in delta.renamed]
445
 
    show_list(renamed, 'renamed', 'R', with_file_id_format='%s',
446
 
              show_more=show_more_renamed)
447
 
    show_list(delta.kind_changed, 'kind changed', 'K',
448
 
              with_file_id_format='%s',
449
 
              show_more=show_more_kind_changed)
450
 
    show_list(delta.modified + extra_modified, 'modified', 'M')
451
 
    if show_unchanged:
452
 
        show_list(delta.unchanged, 'unchanged', 'S')
453
 
 
454
 
    show_list(delta.unversioned, 'unknown', ' ')
455