← 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: 2010-06-02 05:03:31 UTC
  • mto: This revision was merged to the branch mainline in revision 5279.
  • Revision ID: mbp@canonical.com-20100602050331-n2p1qt8hfsahspnv
Correct more sloppy use of the term 'Linux'

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
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
104
103
            if v[1] == file_id:
105
104
                return True
106
105
        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
 
                    print >>to_file, indent + '%s  %-30s %s' % (short_status_letter,
126
 
                        path, fid)
127
 
                else:
128
 
                    print >>to_file, indent + '%s  %s' % (short_status_letter, path)
129
 
            
130
 
        if self.removed:
131
 
            if not short_status:
132
 
                print >>to_file, indent + '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, indent + '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, indent + '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, indent + '%s  %s => %s %s' % (
160
 
                        short_status_letter, oldpath, newpath, fid)
161
 
                else:
162
 
                    print >>to_file, indent + '%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, indent + '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, indent + '%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, indent + '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, indent + 'unchanged:'
190
 
                show_list(self.unchanged)
191
 
            else:
192
 
                show_list(self.unchanged, 'S')
193
 
 
194
 
        if self.unversioned:
195
 
            print >>to_file, indent + 'unknown:'
196
 
            show_list(self.unversioned)
197
106
 
198
107
    def get_changes_as_text(self, show_ids=False, show_unchanged=False,
199
 
             short_status=False):
 
108
                            short_status=False):
200
109
        import StringIO
201
110
        output = StringIO.StringIO()
202
 
        self.show(output, show_ids, show_unchanged, short_status)
 
111
        report_delta(output, self, short_status, show_ids, show_unchanged)
203
112
        return output.getvalue()
204
113
 
205
114
 
211
120
    # mutter('start compare_trees')
212
121
 
213
122
    for (file_id, path, content_change, versioned, parent_id, name, kind,
214
 
         executable) in new_tree._iter_changes(old_tree, want_unchanged,
 
123
         executable) in new_tree.iter_changes(old_tree, want_unchanged,
215
124
            specific_files, extra_trees=extra_trees,
216
125
            require_versioned=require_versioned,
217
126
            want_unversioned=want_unversioned):
226
135
            if fully_present[1] is True:
227
136
                delta.added.append((path[1], file_id, kind[1]))
228
137
            else:
229
 
                assert fully_present[0] is True
230
138
                delta.removed.append((path[0], file_id, kind[0]))
231
139
        elif fully_present[0] is False:
232
140
            continue
242
150
                                  (executable[0] != executable[1])))
243
151
        elif kind[0] != kind[1]:
244
152
            delta.kind_changed.append((path[1], file_id, kind[0], kind[1]))
245
 
        elif content_change is True or executable[0] != executable[1]:
 
153
        elif content_change or executable[0] != executable[1]:
246
154
            delta.modified.append((path[1], file_id, kind[1],
247
155
                                   content_change,
248
156
                                   (executable[0] != executable[1])))
264
172
    """Report changes between two trees"""
265
173
 
266
174
    def __init__(self, output=None, suppress_root_add=True,
267
 
                 output_file=None, unversioned_filter=None):
 
175
                 output_file=None, unversioned_filter=None, view_info=None):
268
176
        """Constructor
269
177
 
270
178
        :param output: a function with the signature of trace.note, i.e.
273
181
            (i.e. when a tree has just been initted)
274
182
        :param output_file: If supplied, a file-like object to write to.
275
183
            Only one of output and output_file may be supplied.
276
 
        :param unversioned_filter: A filter function to be called on 
 
184
        :param unversioned_filter: A filter function to be called on
277
185
            unversioned files. This should return True to ignore a path.
278
186
            By default, no filtering takes place.
 
187
        :param view_info: A tuple of view_name,view_files if only
 
188
            items inside a view are to be reported on, or None for
 
189
            no view filtering.
279
190
        """
280
191
        if output_file is not None:
281
192
            if output is not None:
298
209
                              'unversioned': '?', # versioned in neither
299
210
                              }
300
211
        self.unversioned_filter = unversioned_filter
 
212
        if view_info is None:
 
213
            self.view_name = None
 
214
            self.view_files = []
 
215
        else:
 
216
            self.view_name = view_info[0]
 
217
            self.view_files = view_info[1]
 
218
            self.output("Operating on whole tree but only reporting on "
 
219
                        "'%s' view." % (self.view_name,))
301
220
 
302
221
    def report(self, file_id, paths, versioned, renamed, modified, exe_change,
303
222
               kind):
304
223
        """Report one change to a file
305
224
 
306
225
        :param file_id: The file_id of the file
307
 
        :param path: The old and new paths as generated by Tree._iter_changes.
 
226
        :param path: The old and new paths as generated by Tree.iter_changes.
308
227
        :param versioned: may be 'added', 'removed', 'unchanged', or
309
228
            'unversioned.
310
229
        :param renamed: may be True or False
311
230
        :param modified: may be 'created', 'deleted', 'kind changed',
312
231
            'modified' or 'unchanged'.
313
232
        :param exe_change: True if the execute bit has changed
314
 
        :param kind: A pair of file kinds, as generated by Tree._iter_changes.
 
233
        :param kind: A pair of file kinds, as generated by Tree.iter_changes.
315
234
            None indicates no file present.
316
235
        """
 
236
        if is_quiet():
 
237
            return
317
238
        if paths[1] == '' and versioned == 'added' and self.suppress_root_add:
318
239
            return
 
240
        if self.view_files and not osutils.is_inside_any(self.view_files,
 
241
            paths[1]):
 
242
            return
319
243
        if versioned == 'unversioned':
320
244
            # skip ignored unversioned files if needed.
321
245
            if self.unversioned_filter is not None:
333
257
                # on a rename, we show old and new
334
258
                old_path, path = paths
335
259
            else:
336
 
                # if its not renamed, we're showing both for kind changes
 
260
                # if it's not renamed, we're showing both for kind changes
337
261
                # so only show the new path
338
262
                old_path, path = paths[1], paths[1]
339
263
            # if the file is not missing in the source, we show its kind
365
289
        self.output("%s%s%s %s%s", rename, self.modified_map[modified], exe,
366
290
                    old_path, path)
367
291
 
368
 
 
369
292
def report_changes(change_iterator, reporter):
370
293
    """Report the changes from a change iterator.
371
294
 
373
296
    Further processing may be required to produce a human-readable output.
374
297
    Unfortunately, some tree-changing operations are very complex
375
298
    :change_iterator: an iterator or sequence of changes in the format
376
 
        generated by Tree._iter_changes
 
299
        generated by Tree.iter_changes
377
300
    :param reporter: The _ChangeReporter that will report the changes.
378
301
    """
379
302
    versioned_change_map = {
409
332
        versioned_change = versioned_change_map[versioned]
410
333
        reporter.report(file_id, path, versioned_change, renamed, modified,
411
334
                        exe_change, kind)
 
335
 
 
336
def report_delta(to_file, delta, short_status=False, show_ids=False, 
 
337
         show_unchanged=False, indent='', filter=None):
 
338
    """Output this delta in status-like form to to_file.
 
339
 
 
340
    :param to_file: A file-like object where the output is displayed.
 
341
 
 
342
    :param delta: A TreeDelta containing the changes to be displayed
 
343
 
 
344
    :param short_status: Single-line status if True.
 
345
 
 
346
    :param show_ids: Output the file ids if True.
 
347
 
 
348
    :param show_unchanged: Output the unchanged files if True.
 
349
 
 
350
    :param indent: Added at the beginning of all output lines (for merged
 
351
        revisions).
 
352
 
 
353
    :param filter: A callable receiving a path and a file id and
 
354
        returning True if the path should be displayed.
 
355
    """
 
356
 
 
357
    def decorate_path(path, kind, meta_modified=None):
 
358
        if kind == 'directory':
 
359
            path += '/'
 
360
        elif kind == 'symlink':
 
361
            path += '@'
 
362
        if meta_modified:
 
363
            path += '*'
 
364
        return path
 
365
 
 
366
    def show_more_renamed(item):
 
367
        (oldpath, file_id, kind,
 
368
         text_modified, meta_modified, newpath) = item
 
369
        dec_new_path = decorate_path(newpath, kind, meta_modified)
 
370
        to_file.write(' => %s' % dec_new_path)
 
371
        if text_modified or meta_modified:
 
372
            extra_modified.append((newpath, file_id, kind,
 
373
                                   text_modified, meta_modified))
 
374
 
 
375
    def show_more_kind_changed(item):
 
376
        (path, file_id, old_kind, new_kind) = item
 
377
        to_file.write(' (%s => %s)' % (old_kind, new_kind))
 
378
 
 
379
    def show_path(path, file_id, kind, meta_modified,
 
380
                  default_format, with_file_id_format):
 
381
        dec_path = decorate_path(path, kind, meta_modified)
 
382
        if show_ids:
 
383
            to_file.write(with_file_id_format % dec_path)
 
384
        else:
 
385
            to_file.write(default_format % dec_path)
 
386
 
 
387
    def show_list(files, long_status_name, short_status_letter,
 
388
                  default_format='%s', with_file_id_format='%-30s',
 
389
                  show_more=None):
 
390
        if files:
 
391
            header_shown = False
 
392
            if short_status:
 
393
                prefix = short_status_letter
 
394
            else:
 
395
                prefix = ''
 
396
            prefix = indent + prefix + '  '
 
397
 
 
398
            for item in files:
 
399
                path, file_id, kind = item[:3]
 
400
                if (filter is not None and not filter(path, file_id)):
 
401
                    continue
 
402
                if not header_shown and not short_status:
 
403
                    to_file.write(indent + long_status_name + ':\n')
 
404
                    header_shown = True
 
405
                meta_modified = None
 
406
                if len(item) == 5:
 
407
                    meta_modified = item[4]
 
408
 
 
409
                to_file.write(prefix)
 
410
                show_path(path, file_id, kind, meta_modified,
 
411
                          default_format, with_file_id_format)
 
412
                if show_more is not None:
 
413
                    show_more(item)
 
414
                if show_ids:
 
415
                    to_file.write(' %s' % file_id)
 
416
                to_file.write('\n')
 
417
 
 
418
    show_list(delta.removed, 'removed', 'D')
 
419
    show_list(delta.added, 'added', 'A')
 
420
    extra_modified = []
 
421
    # Reorder delta.renamed tuples so that all lists share the same
 
422
    # order for their 3 first fields and that they also begin like
 
423
    # the delta.modified tuples
 
424
    renamed = [(p, i, k, tm, mm, np)
 
425
               for  p, np, i, k, tm, mm  in delta.renamed]
 
426
    show_list(renamed, 'renamed', 'R', with_file_id_format='%s',
 
427
              show_more=show_more_renamed)
 
428
    show_list(delta.kind_changed, 'kind changed', 'K',
 
429
              with_file_id_format='%s',
 
430
              show_more=show_more_kind_changed)
 
431
    show_list(delta.modified + extra_modified, 'modified', 'M')
 
432
    if show_unchanged:
 
433
        show_list(delta.unchanged, 'unchanged', 'S')
 
434
 
 
435
    show_list(delta.unversioned, 'unknown', ' ')
 
436