← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/delta.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2011-08-17 18:13:57 UTC
  • mfrom: (5268.7.29 transport-segments)
  • Revision ID: pqm@pqm.ubuntu.com-20110817181357-y5q5eth1hk8bl3om
(jelmer) Allow specifying the colocated branch to use in the branch URL,
 and retrieving the branch name using ControlDir._get_selected_branch.
 (Jelmer Vernooij)

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
16
 
17
17
from bzrlib import (
18
 
    errors,
19
18
    osutils,
20
19
    )
21
 
from bzrlib.inventory import InventoryEntry
22
 
from bzrlib.trace import mutter, is_quiet
23
 
from bzrlib.symbol_versioning import deprecated_function
 
20
from bzrlib.trace import is_quiet
24
21
 
25
22
 
26
23
class TreeDelta(object):
27
24
    """Describes changes from one tree to another.
28
25
 
29
 
    Contains four lists:
 
26
    Contains seven lists:
30
27
 
31
28
    added
32
29
        (path, id, kind)
34
31
        (path, id, kind)
35
32
    renamed
36
33
        (oldpath, newpath, id, kind, text_modified, meta_modified)
 
34
    kind_changed
 
35
        (path, id, old_kind, new_kind)
37
36
    modified
38
37
        (path, id, kind, text_modified, meta_modified)
39
38
    unchanged
40
39
        (path, id, kind)
41
40
    unversioned
42
 
        (path, kind)
 
41
        (path, None, kind)
43
42
 
44
43
    Each id is listed only once.
45
44
 
46
45
    Files that are both modified and renamed are listed only in
47
46
    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
 
47
    applies either to the content of the file or the target of the
49
48
    symbolic link, depending of the kind of file.
50
49
 
51
50
    Files are only considered renamed if their name has changed or
62
61
        self.modified = []
63
62
        self.unchanged = []
64
63
        self.unversioned = []
 
64
        self.missing = []
65
65
 
66
66
    def __eq__(self, other):
67
67
        if not isinstance(other, TreeDelta):
104
104
            if v[1] == file_id:
105
105
                return True
106
106
        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
107
 
198
108
    def get_changes_as_text(self, show_ids=False, show_unchanged=False,
199
 
             short_status=False):
 
109
                            short_status=False):
200
110
        import StringIO
201
111
        output = StringIO.StringIO()
202
 
        self.show(output, show_ids, show_unchanged, short_status)
 
112
        report_delta(output, self, short_status, show_ids, show_unchanged)
203
113
        return output.getvalue()
204
114
 
205
115
 
228
138
            else:
229
139
                delta.removed.append((path[0], file_id, kind[0]))
230
140
        elif fully_present[0] is False:
231
 
            continue
 
141
            delta.missing.append((path[1], file_id, kind[1]))
232
142
        elif name[0] != name[1] or parent_id[0] != parent_id[1]:
233
143
            # If the name changes, or the parent_id changes, we have a rename
234
144
            # (if we move a parent, that doesn't count as a rename for the
241
151
                                  (executable[0] != executable[1])))
242
152
        elif kind[0] != kind[1]:
243
153
            delta.kind_changed.append((path[1], file_id, kind[0], kind[1]))
244
 
        elif content_change is True or executable[0] != executable[1]:
 
154
        elif content_change or executable[0] != executable[1]:
245
155
            delta.modified.append((path[1], file_id, kind[1],
246
156
                                   content_change,
247
157
                                   (executable[0] != executable[1])))
251
161
    delta.removed.sort()
252
162
    delta.added.sort()
253
163
    delta.renamed.sort()
 
164
    delta.missing.sort()
254
165
    # TODO: jam 20060529 These lists shouldn't need to be sorted
255
166
    #       since we added them in alphabetical order.
256
167
    delta.modified.sort()
263
174
    """Report changes between two trees"""
264
175
 
265
176
    def __init__(self, output=None, suppress_root_add=True,
266
 
                 output_file=None, unversioned_filter=None):
 
177
                 output_file=None, unversioned_filter=None, view_info=None,
 
178
                 classify=True):
267
179
        """Constructor
268
180
 
269
181
        :param output: a function with the signature of trace.note, i.e.
272
184
            (i.e. when a tree has just been initted)
273
185
        :param output_file: If supplied, a file-like object to write to.
274
186
            Only one of output and output_file may be supplied.
275
 
        :param unversioned_filter: A filter function to be called on 
 
187
        :param unversioned_filter: A filter function to be called on
276
188
            unversioned files. This should return True to ignore a path.
277
189
            By default, no filtering takes place.
 
190
        :param view_info: A tuple of view_name,view_files if only
 
191
            items inside a view are to be reported on, or None for
 
192
            no view filtering.
 
193
        :param classify: Add special symbols to indicate file kind.
278
194
        """
279
195
        if output_file is not None:
280
196
            if output is not None:
290
206
                             'unchanged': ' ',
291
207
                             'created': 'N',
292
208
                             'modified': 'M',
293
 
                             'deleted': 'D'}
 
209
                             'deleted': 'D',
 
210
                             'missing': '!',
 
211
                             }
294
212
        self.versioned_map = {'added': '+', # versioned target
295
213
                              'unchanged': ' ', # versioned in both
296
214
                              'removed': '-', # versioned in source
297
215
                              'unversioned': '?', # versioned in neither
298
216
                              }
299
217
        self.unversioned_filter = unversioned_filter
 
218
        if classify:
 
219
            self.kind_marker = osutils.kind_marker
 
220
        else:
 
221
            self.kind_marker = lambda kind: ''
 
222
        if view_info is None:
 
223
            self.view_name = None
 
224
            self.view_files = []
 
225
        else:
 
226
            self.view_name = view_info[0]
 
227
            self.view_files = view_info[1]
 
228
            self.output("Operating on whole tree but only reporting on "
 
229
                        "'%s' view." % (self.view_name,))
300
230
 
301
231
    def report(self, file_id, paths, versioned, renamed, modified, exe_change,
302
232
               kind):
317
247
            return
318
248
        if paths[1] == '' and versioned == 'added' and self.suppress_root_add:
319
249
            return
 
250
        if self.view_files and not osutils.is_inside_any(self.view_files,
 
251
            paths[1]):
 
252
            return
320
253
        if versioned == 'unversioned':
321
254
            # skip ignored unversioned files if needed.
322
255
            if self.unversioned_filter is not None:
340
273
            # if the file is not missing in the source, we show its kind
341
274
            # when we show two paths.
342
275
            if kind[0] is not None:
343
 
                old_path += osutils.kind_marker(kind[0])
 
276
                old_path += self.kind_marker(kind[0])
344
277
            old_path += " => "
345
278
        elif versioned == 'removed':
346
279
            # not present in target
355
288
            rename = self.versioned_map[versioned]
356
289
        # we show the old kind on the new path when the content is deleted.
357
290
        if modified == 'deleted':
358
 
            path += osutils.kind_marker(kind[0])
 
291
            path += self.kind_marker(kind[0])
359
292
        # otherwise we always show the current kind when there is one
360
293
        elif kind[1] is not None:
361
 
            path += osutils.kind_marker(kind[1])
 
294
            path += self.kind_marker(kind[1])
362
295
        if exe_change:
363
296
            exe = '*'
364
297
        else:
366
299
        self.output("%s%s%s %s%s", rename, self.modified_map[modified], exe,
367
300
                    old_path, path)
368
301
 
369
 
 
370
302
def report_changes(change_iterator, reporter):
371
303
    """Report the changes from a change iterator.
372
304
 
403
335
        else:
404
336
            if content_change:
405
337
                modified = "modified"
 
338
            elif kind[0] is None:
 
339
                modified = "missing"
406
340
            else:
407
341
                modified = "unchanged"
408
342
            if kind[1] == "file":
410
344
        versioned_change = versioned_change_map[versioned]
411
345
        reporter.report(file_id, path, versioned_change, renamed, modified,
412
346
                        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