← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/delta.py

Add a NEWS entry and prepare submission.

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
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
from bzrlib import (
 
18
    errors,
18
19
    osutils,
19
20
    )
20
 
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
21
24
 
22
25
 
23
26
class TreeDelta(object):
61
64
        self.modified = []
62
65
        self.unchanged = []
63
66
        self.unversioned = []
64
 
        self.missing = []
65
67
 
66
68
    def __eq__(self, other):
67
69
        if not isinstance(other, TreeDelta):
105
107
                return True
106
108
        return False
107
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
 
108
211
    def get_changes_as_text(self, show_ids=False, show_unchanged=False,
109
 
                            short_status=False):
 
212
             short_status=False):
110
213
        import StringIO
111
214
        output = StringIO.StringIO()
112
 
        report_delta(output, self, short_status, show_ids, show_unchanged)
 
215
        self.show(output, show_ids, show_unchanged, short_status)
113
216
        return output.getvalue()
114
217
 
115
218
 
138
241
            else:
139
242
                delta.removed.append((path[0], file_id, kind[0]))
140
243
        elif fully_present[0] is False:
141
 
            delta.missing.append((path[1], file_id, kind[1]))
 
244
            continue
142
245
        elif name[0] != name[1] or parent_id[0] != parent_id[1]:
143
246
            # If the name changes, or the parent_id changes, we have a rename
144
247
            # (if we move a parent, that doesn't count as a rename for the
161
264
    delta.removed.sort()
162
265
    delta.added.sort()
163
266
    delta.renamed.sort()
164
 
    delta.missing.sort()
165
267
    # TODO: jam 20060529 These lists shouldn't need to be sorted
166
268
    #       since we added them in alphabetical order.
167
269
    delta.modified.sort()
174
276
    """Report changes between two trees"""
175
277
 
176
278
    def __init__(self, output=None, suppress_root_add=True,
177
 
                 output_file=None, unversioned_filter=None, view_info=None,
178
 
                 classify=True):
 
279
                 output_file=None, unversioned_filter=None, view_info=None):
179
280
        """Constructor
180
281
 
181
282
        :param output: a function with the signature of trace.note, i.e.
190
291
        :param view_info: A tuple of view_name,view_files if only
191
292
            items inside a view are to be reported on, or None for
192
293
            no view filtering.
193
 
        :param classify: Add special symbols to indicate file kind.
194
294
        """
195
295
        if output_file is not None:
196
296
            if output is not None:
206
306
                             'unchanged': ' ',
207
307
                             'created': 'N',
208
308
                             'modified': 'M',
209
 
                             'deleted': 'D',
210
 
                             'missing': '!',
211
 
                             }
 
309
                             'deleted': 'D'}
212
310
        self.versioned_map = {'added': '+', # versioned target
213
311
                              'unchanged': ' ', # versioned in both
214
312
                              'removed': '-', # versioned in source
215
313
                              'unversioned': '?', # versioned in neither
216
314
                              }
217
315
        self.unversioned_filter = unversioned_filter
218
 
        if classify:
219
 
            self.kind_marker = osutils.kind_marker
220
 
        else:
221
 
            self.kind_marker = lambda kind: ''
222
316
        if view_info is None:
223
317
            self.view_name = None
224
318
            self.view_files = []
273
367
            # if the file is not missing in the source, we show its kind
274
368
            # when we show two paths.
275
369
            if kind[0] is not None:
276
 
                old_path += self.kind_marker(kind[0])
 
370
                old_path += osutils.kind_marker(kind[0])
277
371
            old_path += " => "
278
372
        elif versioned == 'removed':
279
373
            # not present in target
288
382
            rename = self.versioned_map[versioned]
289
383
        # we show the old kind on the new path when the content is deleted.
290
384
        if modified == 'deleted':
291
 
            path += self.kind_marker(kind[0])
 
385
            path += osutils.kind_marker(kind[0])
292
386
        # otherwise we always show the current kind when there is one
293
387
        elif kind[1] is not None:
294
 
            path += self.kind_marker(kind[1])
 
388
            path += osutils.kind_marker(kind[1])
295
389
        if exe_change:
296
390
            exe = '*'
297
391
        else:
299
393
        self.output("%s%s%s %s%s", rename, self.modified_map[modified], exe,
300
394
                    old_path, path)
301
395
 
 
396
 
302
397
def report_changes(change_iterator, reporter):
303
398
    """Report the changes from a change iterator.
304
399
 
335
430
        else:
336
431
            if content_change:
337
432
                modified = "modified"
338
 
            elif kind[0] is None:
339
 
                modified = "missing"
340
433
            else:
341
434
                modified = "unchanged"
342
435
            if kind[1] == "file":
344
437
        versioned_change = versioned_change_map[versioned]
345
438
        reporter.report(file_id, path, versioned_change, renamed, modified,
346
439
                        exe_change, kind)
347
 
 
348
 
def report_delta(to_file, delta, short_status=False, show_ids=False, 
349
 
         show_unchanged=False, indent='', filter=None, classify=True):
350
 
    """Output this delta in status-like form to to_file.
351
 
 
352
 
    :param to_file: A file-like object where the output is displayed.
353
 
 
354
 
    :param delta: A TreeDelta containing the changes to be displayed
355
 
 
356
 
    :param short_status: Single-line status if True.
357
 
 
358
 
    :param show_ids: Output the file ids if True.
359
 
 
360
 
    :param show_unchanged: Output the unchanged files if True.
361
 
 
362
 
    :param indent: Added at the beginning of all output lines (for merged
363
 
        revisions).
364
 
 
365
 
    :param filter: A callable receiving a path and a file id and
366
 
        returning True if the path should be displayed.
367
 
 
368
 
    :param classify: Add special symbols to indicate file kind.
369
 
    """
370
 
 
371
 
    def decorate_path(path, kind, meta_modified=None):
372
 
        if not classify:
373
 
            return path
374
 
        if kind == 'directory':
375
 
            path += '/'
376
 
        elif kind == 'symlink':
377
 
            path += '@'
378
 
        if meta_modified:
379
 
            path += '*'
380
 
        return path
381
 
 
382
 
    def show_more_renamed(item):
383
 
        (oldpath, file_id, kind,
384
 
         text_modified, meta_modified, newpath) = item
385
 
        dec_new_path = decorate_path(newpath, kind, meta_modified)
386
 
        to_file.write(' => %s' % dec_new_path)
387
 
        if text_modified or meta_modified:
388
 
            extra_modified.append((newpath, file_id, kind,
389
 
                                   text_modified, meta_modified))
390
 
 
391
 
    def show_more_kind_changed(item):
392
 
        (path, file_id, old_kind, new_kind) = item
393
 
        to_file.write(' (%s => %s)' % (old_kind, new_kind))
394
 
 
395
 
    def show_path(path, file_id, kind, meta_modified,
396
 
                  default_format, with_file_id_format):
397
 
        dec_path = decorate_path(path, kind, meta_modified)
398
 
        if show_ids:
399
 
            to_file.write(with_file_id_format % dec_path)
400
 
        else:
401
 
            to_file.write(default_format % dec_path)
402
 
 
403
 
    def show_list(files, long_status_name, short_status_letter,
404
 
                  default_format='%s', with_file_id_format='%-30s',
405
 
                  show_more=None):
406
 
        if files:
407
 
            header_shown = False
408
 
            if short_status:
409
 
                prefix = short_status_letter
410
 
            else:
411
 
                prefix = ''
412
 
            prefix = indent + prefix + '  '
413
 
 
414
 
            for item in files:
415
 
                path, file_id, kind = item[:3]
416
 
                if (filter is not None and not filter(path, file_id)):
417
 
                    continue
418
 
                if not header_shown and not short_status:
419
 
                    to_file.write(indent + long_status_name + ':\n')
420
 
                    header_shown = True
421
 
                meta_modified = None
422
 
                if len(item) == 5:
423
 
                    meta_modified = item[4]
424
 
 
425
 
                to_file.write(prefix)
426
 
                show_path(path, file_id, kind, meta_modified,
427
 
                          default_format, with_file_id_format)
428
 
                if show_more is not None:
429
 
                    show_more(item)
430
 
                if show_ids:
431
 
                    to_file.write(' %s' % file_id)
432
 
                to_file.write('\n')
433
 
 
434
 
    show_list(delta.removed, 'removed', 'D')
435
 
    show_list(delta.added, 'added', 'A')
436
 
    show_list(delta.missing, 'missing', '!')
437
 
    extra_modified = []
438
 
    # Reorder delta.renamed tuples so that all lists share the same
439
 
    # order for their 3 first fields and that they also begin like
440
 
    # the delta.modified tuples
441
 
    renamed = [(p, i, k, tm, mm, np)
442
 
               for  p, np, i, k, tm, mm  in delta.renamed]
443
 
    show_list(renamed, 'renamed', 'R', with_file_id_format='%s',
444
 
              show_more=show_more_renamed)
445
 
    show_list(delta.kind_changed, 'kind changed', 'K',
446
 
              with_file_id_format='%s',
447
 
              show_more=show_more_kind_changed)
448
 
    show_list(delta.modified + extra_modified, 'modified', 'M')
449
 
    if show_unchanged:
450
 
        show_list(delta.unchanged, 'unchanged', 'S')
451
 
 
452
 
    show_list(delta.unversioned, 'unknown', ' ')
453