← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/delta.py

  • Committer: Martin Pool
  • Date: 2009-07-02 03:48:25 UTC
  • mto: This revision was merged to the branch mainline in revision 4502.
  • Revision ID: mbp@sourcefrog.net-20090702034825-2330z69r93a701ws
iter(i) returns i so we don't need a check

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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
from __future__ import absolute_import
18
 
 
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, is_quiet
 
23
from bzrlib.symbol_versioning import deprecated_function
23
24
 
24
25
 
25
26
class TreeDelta(object):
46
47
 
47
48
    Files that are both modified and renamed are listed only in
48
49
    renamed, with the text_modified flag true. The text_modified
49
 
    applies either to the content of the file or the target of the
 
50
    applies either to the the content of the file or the target of the
50
51
    symbolic link, depending of the kind of file.
51
52
 
52
53
    Files are only considered renamed if their name has changed or
63
64
        self.modified = []
64
65
        self.unchanged = []
65
66
        self.unversioned = []
66
 
        self.missing = []
67
67
 
68
68
    def __eq__(self, other):
69
69
        if not isinstance(other, TreeDelta):
107
107
                return True
108
108
        return False
109
109
 
 
110
 
 
111
    def show(self, to_file, show_ids=False, show_unchanged=False,
 
112
             short_status=False, indent='',
 
113
             filter=None):
 
114
        """Output this delta in status-like form to to_file.
 
115
 
 
116
        :param to_file: A file-like object where the output is displayed.
 
117
 
 
118
        :param show_ids: Output the file ids if True.
 
119
 
 
120
        :param show_unchanged: Output the unchanged files if True.
 
121
 
 
122
        :param short_status: Single-line status if True.
 
123
 
 
124
        :param indent: Added at the beginning of all output lines (for merged
 
125
            revisions).
 
126
 
 
127
        :param filter: A callable receiving a path and a file id and
 
128
            returning True if the path should be displayed.
 
129
        """
 
130
 
 
131
        def decorate_path(path, kind, meta_modified=None):
 
132
            if kind == 'directory':
 
133
                path += '/'
 
134
            elif kind == 'symlink':
 
135
                path += '@'
 
136
            if meta_modified:
 
137
                path += '*'
 
138
            return path
 
139
 
 
140
        def show_more_renamed(item):
 
141
            (oldpath, file_id, kind,
 
142
             text_modified, meta_modified, newpath) = item
 
143
            dec_new_path = decorate_path(newpath, kind, meta_modified)
 
144
            to_file.write(' => %s' % dec_new_path)
 
145
            if text_modified or meta_modified:
 
146
                extra_modified.append((newpath, file_id, kind,
 
147
                                       text_modified, meta_modified))
 
148
 
 
149
        def show_more_kind_changed(item):
 
150
            (path, file_id, old_kind, new_kind) = item
 
151
            to_file.write(' (%s => %s)' % (old_kind, new_kind))
 
152
 
 
153
        def show_path(path, file_id, kind, meta_modified,
 
154
                      default_format, with_file_id_format):
 
155
            dec_path = decorate_path(path, kind, meta_modified)
 
156
            if show_ids:
 
157
                to_file.write(with_file_id_format % dec_path)
 
158
            else:
 
159
                to_file.write(default_format % dec_path)
 
160
 
 
161
        def show_list(files, long_status_name, short_status_letter,
 
162
                      default_format='%s', with_file_id_format='%-30s',
 
163
                      show_more=None):
 
164
            if files:
 
165
                header_shown = False
 
166
                if short_status:
 
167
                    prefix = short_status_letter
 
168
                else:
 
169
                    prefix = ''
 
170
                prefix = indent + prefix + '  '
 
171
 
 
172
                for item in files:
 
173
                    path, file_id, kind = item[:3]
 
174
                    if (filter is not None and not filter(path, file_id)):
 
175
                        continue
 
176
                    if not header_shown and not short_status:
 
177
                        to_file.write(indent + long_status_name + ':\n')
 
178
                        header_shown = True
 
179
                    meta_modified = None
 
180
                    if len(item) == 5:
 
181
                        meta_modified = item[4]
 
182
 
 
183
                    to_file.write(prefix)
 
184
                    show_path(path, file_id, kind, meta_modified,
 
185
                              default_format, with_file_id_format)
 
186
                    if show_more is not None:
 
187
                        show_more(item)
 
188
                    if show_ids:
 
189
                        to_file.write(' %s' % file_id)
 
190
                    to_file.write('\n')
 
191
 
 
192
        show_list(self.removed, 'removed', 'D')#
 
193
        show_list(self.added, 'added', 'A')
 
194
        extra_modified = []
 
195
        # Reorder self.renamed tuples so that all lists share the same
 
196
        # order for their 3 first fields and that they also begin like
 
197
        # the self.modified tuples
 
198
        renamed = [(p, i, k, tm, mm, np)
 
199
                   for  p, np, i, k, tm, mm  in self.renamed]
 
200
        show_list(renamed, 'renamed', 'R', with_file_id_format='%s',
 
201
                  show_more=show_more_renamed)
 
202
        show_list(self.kind_changed, 'kind changed', 'K',
 
203
                  with_file_id_format='%s',
 
204
                  show_more=show_more_kind_changed)
 
205
        show_list(self.modified + extra_modified, 'modified', 'M')
 
206
        if show_unchanged:
 
207
            show_list(self.unchanged, 'unchanged', 'S')
 
208
 
 
209
        show_list(self.unversioned, 'unknown', ' ')
 
210
 
110
211
    def get_changes_as_text(self, show_ids=False, show_unchanged=False,
111
 
                            short_status=False):
 
212
             short_status=False):
112
213
        import StringIO
113
214
        output = StringIO.StringIO()
114
 
        report_delta(output, self, short_status, show_ids, show_unchanged)
 
215
        self.show(output, show_ids, show_unchanged, short_status)
115
216
        return output.getvalue()
116
217
 
117
218
 
140
241
            else:
141
242
                delta.removed.append((path[0], file_id, kind[0]))
142
243
        elif fully_present[0] is False:
143
 
            delta.missing.append((path[1], file_id, kind[1]))
 
244
            continue
144
245
        elif name[0] != name[1] or parent_id[0] != parent_id[1]:
145
246
            # If the name changes, or the parent_id changes, we have a rename
146
247
            # (if we move a parent, that doesn't count as a rename for the
163
264
    delta.removed.sort()
164
265
    delta.added.sort()
165
266
    delta.renamed.sort()
166
 
    delta.missing.sort()
167
267
    # TODO: jam 20060529 These lists shouldn't need to be sorted
168
268
    #       since we added them in alphabetical order.
169
269
    delta.modified.sort()
176
276
    """Report changes between two trees"""
177
277
 
178
278
    def __init__(self, output=None, suppress_root_add=True,
179
 
                 output_file=None, unversioned_filter=None, view_info=None,
180
 
                 classify=True):
 
279
                 output_file=None, unversioned_filter=None, view_info=None):
181
280
        """Constructor
182
281
 
183
282
        :param output: a function with the signature of trace.note, i.e.
192
291
        :param view_info: A tuple of view_name,view_files if only
193
292
            items inside a view are to be reported on, or None for
194
293
            no view filtering.
195
 
        :param classify: Add special symbols to indicate file kind.
196
294
        """
197
295
        if output_file is not None:
198
296
            if output is not None:
208
306
                             'unchanged': ' ',
209
307
                             'created': 'N',
210
308
                             'modified': 'M',
211
 
                             'deleted': 'D',
212
 
                             'missing': '!',
213
 
                             }
 
309
                             'deleted': 'D'}
214
310
        self.versioned_map = {'added': '+', # versioned target
215
311
                              'unchanged': ' ', # versioned in both
216
312
                              'removed': '-', # versioned in source
217
313
                              'unversioned': '?', # versioned in neither
218
314
                              }
219
315
        self.unversioned_filter = unversioned_filter
220
 
        if classify:
221
 
            self.kind_marker = osutils.kind_marker
222
 
        else:
223
 
            self.kind_marker = lambda kind: ''
224
316
        if view_info is None:
225
317
            self.view_name = None
226
318
            self.view_files = []
275
367
            # if the file is not missing in the source, we show its kind
276
368
            # when we show two paths.
277
369
            if kind[0] is not None:
278
 
                old_path += self.kind_marker(kind[0])
 
370
                old_path += osutils.kind_marker(kind[0])
279
371
            old_path += " => "
280
372
        elif versioned == 'removed':
281
373
            # not present in target
290
382
            rename = self.versioned_map[versioned]
291
383
        # we show the old kind on the new path when the content is deleted.
292
384
        if modified == 'deleted':
293
 
            path += self.kind_marker(kind[0])
 
385
            path += osutils.kind_marker(kind[0])
294
386
        # otherwise we always show the current kind when there is one
295
387
        elif kind[1] is not None:
296
 
            path += self.kind_marker(kind[1])
 
388
            path += osutils.kind_marker(kind[1])
297
389
        if exe_change:
298
390
            exe = '*'
299
391
        else:
301
393
        self.output("%s%s%s %s%s", rename, self.modified_map[modified], exe,
302
394
                    old_path, path)
303
395
 
 
396
 
304
397
def report_changes(change_iterator, reporter):
305
398
    """Report the changes from a change iterator.
306
399
 
337
430
        else:
338
431
            if content_change:
339
432
                modified = "modified"
340
 
            elif kind[0] is None:
341
 
                modified = "missing"
342
433
            else:
343
434
                modified = "unchanged"
344
435
            if kind[1] == "file":
346
437
        versioned_change = versioned_change_map[versioned]
347
438
        reporter.report(file_id, path, versioned_change, renamed, modified,
348
439
                        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