← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/delta.py

  • Committer: Jelmer Vernooij
  • Date: 2012-06-28 16:17:34 UTC
  • mfrom: (6531 +trunk)
  • mto: This revision was merged to the branch mainline in revision 6533.
  • Revision ID: jelmer@samba.org-20120628161734-2iqmgnxx6ogt9o6h
Merge trunk.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/delta.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
from __future__ import absolute_import
16
18
 
17
19
from bzrlib import (
18
 
    errors,
19
20
    osutils,
20
21
    )
21
 
from bzrlib.inventory import InventoryEntry
22
 
from bzrlib.trace import mutter, is_quiet
23
 
from bzrlib.symbol_versioning import deprecated_function
 
22
from bzrlib.trace import is_quiet
24
23
 
25
24
 
26
25
class TreeDelta(object):
27
26
    """Describes changes from one tree to another.
28
27
 
29
 
    Contains four lists:
 
28
    Contains seven lists:
30
29
 
31
30
    added
32
31
        (path, id, kind)
34
33
        (path, id, kind)
35
34
    renamed
36
35
        (oldpath, newpath, id, kind, text_modified, meta_modified)
 
36
    kind_changed
 
37
        (path, id, old_kind, new_kind)
37
38
    modified
38
39
        (path, id, kind, text_modified, meta_modified)
39
40
    unchanged
40
41
        (path, id, kind)
41
42
    unversioned
42
 
        (path, kind)
 
43
        (path, None, kind)
43
44
 
44
45
    Each id is listed only once.
45
46
 
46
47
    Files that are both modified and renamed are listed only in
47
48
    renamed, with the text_modified flag true. The text_modified
48
 
    applies either to the the content of the file or the target of the
 
49
    applies either to the content of the file or the target of the
49
50
    symbolic link, depending of the kind of file.
50
51
 
51
52
    Files are only considered renamed if their name has changed or
62
63
        self.modified = []
63
64
        self.unchanged = []
64
65
        self.unversioned = []
 
66
        self.missing = []
65
67
 
66
68
    def __eq__(self, other):
67
69
        if not isinstance(other, TreeDelta):
104
106
            if v[1] == file_id:
105
107
                return True
106
108
        return False
107
 
            
108
 
 
109
 
    def show(self, to_file, show_ids=False, show_unchanged=False,
110
 
             short_status=False, indent=''):
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
 
                    to_file.write(indent + '%s  %-30s %s\n' % (short_status_letter,
126
 
                        path, fid))
127
 
                else:
128
 
                    to_file.write(indent + '%s  %s\n' % (short_status_letter, path))
129
 
            
130
 
        if self.removed:
131
 
            if not short_status:
132
 
                to_file.write(indent + 'removed:\n')
133
 
                show_list(self.removed)
134
 
            else:
135
 
                show_list(self.removed, 'D')
136
 
                
137
 
        if self.added:
138
 
            if not short_status:
139
 
                to_file.write(indent + 'added:\n')
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
 
                to_file.write(indent + 'renamed:\n')
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
 
                    to_file.write(indent + '%s  %s => %s %s\n' % (
160
 
                        short_status_letter, oldpath, newpath, fid))
161
 
                else:
162
 
                    to_file.write(indent + '%s  %s => %s\n' % (
163
 
                        short_status_letter, oldpath, newpath))
164
 
 
165
 
        if self.kind_changed:
166
 
            if short_status:
167
 
                short_status_letter = 'K'
168
 
            else:
169
 
                to_file.write(indent + 'kind changed:\n')
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
 
                to_file.write(indent + '%s  %s (%s => %s)%s\n' % (
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
 
                to_file.write(indent + 'modified:\n')
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
 
                to_file.write(indent + 'unchanged:\n')
190
 
                show_list(self.unchanged)
191
 
            else:
192
 
                show_list(self.unchanged, 'S')
193
 
 
194
 
        if self.unversioned:
195
 
            to_file.write(indent + 'unknown:\n')
196
 
            show_list(self.unversioned)
197
109
 
198
110
    def get_changes_as_text(self, show_ids=False, show_unchanged=False,
199
 
             short_status=False):
 
111
                            short_status=False):
200
112
        import StringIO
201
113
        output = StringIO.StringIO()
202
 
        self.show(output, show_ids, show_unchanged, short_status)
 
114
        report_delta(output, self, short_status, show_ids, show_unchanged)
203
115
        return output.getvalue()
204
116
 
205
117
 
228
140
            else:
229
141
                delta.removed.append((path[0], file_id, kind[0]))
230
142
        elif fully_present[0] is False:
231
 
            continue
 
143
            delta.missing.append((path[1], file_id, kind[1]))
232
144
        elif name[0] != name[1] or parent_id[0] != parent_id[1]:
233
145
            # If the name changes, or the parent_id changes, we have a rename
234
146
            # (if we move a parent, that doesn't count as a rename for the
251
163
    delta.removed.sort()
252
164
    delta.added.sort()
253
165
    delta.renamed.sort()
 
166
    delta.missing.sort()
254
167
    # TODO: jam 20060529 These lists shouldn't need to be sorted
255
168
    #       since we added them in alphabetical order.
256
169
    delta.modified.sort()
263
176
    """Report changes between two trees"""
264
177
 
265
178
    def __init__(self, output=None, suppress_root_add=True,
266
 
                 output_file=None, unversioned_filter=None):
 
179
                 output_file=None, unversioned_filter=None, view_info=None,
 
180
                 classify=True):
267
181
        """Constructor
268
182
 
269
183
        :param output: a function with the signature of trace.note, i.e.
272
186
            (i.e. when a tree has just been initted)
273
187
        :param output_file: If supplied, a file-like object to write to.
274
188
            Only one of output and output_file may be supplied.
275
 
        :param unversioned_filter: A filter function to be called on 
 
189
        :param unversioned_filter: A filter function to be called on
276
190
            unversioned files. This should return True to ignore a path.
277
191
            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.
278
196
        """
279
197
        if output_file is not None:
280
198
            if output is not None:
290
208
                             'unchanged': ' ',
291
209
                             'created': 'N',
292
210
                             'modified': 'M',
293
 
                             'deleted': 'D'}
 
211
                             'deleted': 'D',
 
212
                             'missing': '!',
 
213
                             }
294
214
        self.versioned_map = {'added': '+', # versioned target
295
215
                              'unchanged': ' ', # versioned in both
296
216
                              'removed': '-', # versioned in source
297
217
                              'unversioned': '?', # versioned in neither
298
218
                              }
299
219
        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,))
300
232
 
301
233
    def report(self, file_id, paths, versioned, renamed, modified, exe_change,
302
234
               kind):
317
249
            return
318
250
        if paths[1] == '' and versioned == 'added' and self.suppress_root_add:
319
251
            return
 
252
        if self.view_files and not osutils.is_inside_any(self.view_files,
 
253
            paths[1]):
 
254
            return
320
255
        if versioned == 'unversioned':
321
256
            # skip ignored unversioned files if needed.
322
257
            if self.unversioned_filter is not None:
340
275
            # if the file is not missing in the source, we show its kind
341
276
            # when we show two paths.
342
277
            if kind[0] is not None:
343
 
                old_path += osutils.kind_marker(kind[0])
 
278
                old_path += self.kind_marker(kind[0])
344
279
            old_path += " => "
345
280
        elif versioned == 'removed':
346
281
            # not present in target
355
290
            rename = self.versioned_map[versioned]
356
291
        # we show the old kind on the new path when the content is deleted.
357
292
        if modified == 'deleted':
358
 
            path += osutils.kind_marker(kind[0])
 
293
            path += self.kind_marker(kind[0])
359
294
        # otherwise we always show the current kind when there is one
360
295
        elif kind[1] is not None:
361
 
            path += osutils.kind_marker(kind[1])
 
296
            path += self.kind_marker(kind[1])
362
297
        if exe_change:
363
298
            exe = '*'
364
299
        else:
366
301
        self.output("%s%s%s %s%s", rename, self.modified_map[modified], exe,
367
302
                    old_path, path)
368
303
 
369
 
 
370
304
def report_changes(change_iterator, reporter):
371
305
    """Report the changes from a change iterator.
372
306
 
403
337
        else:
404
338
            if content_change:
405
339
                modified = "modified"
 
340
            elif kind[0] is None:
 
341
                modified = "missing"
406
342
            else:
407
343
                modified = "unchanged"
408
344
            if kind[1] == "file":
410
346
        versioned_change = versioned_change_map[versioned]
411
347
        reporter.report(file_id, path, versioned_change, renamed, modified,
412
348
                        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