← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/delta.py

InterTree.compare and delta._compare_trees did not pass its 
parameter require_versioned on correctly.

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
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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
 
23
from bzrlib.symbol_versioning import deprecated_function, zero_nine
21
24
 
22
25
 
23
26
class TreeDelta(object):
24
27
    """Describes changes from one tree to another.
25
28
 
26
 
    Contains seven lists:
 
29
    Contains four lists:
27
30
 
28
31
    added
29
32
        (path, id, kind)
31
34
        (path, id, kind)
32
35
    renamed
33
36
        (oldpath, newpath, id, kind, text_modified, meta_modified)
34
 
    kind_changed
35
 
        (path, id, old_kind, new_kind)
36
37
    modified
37
38
        (path, id, kind, text_modified, meta_modified)
38
39
    unchanged
39
40
        (path, id, kind)
40
41
    unversioned
41
 
        (path, None, kind)
 
42
        (path, kind)
42
43
 
43
44
    Each id is listed only once.
44
45
 
45
46
    Files that are both modified and renamed are listed only in
46
47
    renamed, with the text_modified flag true. The text_modified
47
 
    applies either to the content of the file or the target of the
 
48
    applies either to the the content of the file or the target of the
48
49
    symbolic link, depending of the kind of file.
49
50
 
50
51
    Files are only considered renamed if their name has changed or
103
104
            if v[1] == file_id:
104
105
                return True
105
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
                    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)
106
197
 
107
198
    def get_changes_as_text(self, show_ids=False, show_unchanged=False,
108
 
                            short_status=False):
 
199
             short_status=False):
109
200
        import StringIO
110
201
        output = StringIO.StringIO()
111
 
        report_delta(output, self, short_status, show_ids, show_unchanged)
 
202
        self.show(output, show_ids, show_unchanged, short_status)
112
203
        return output.getvalue()
113
204
 
 
205
@deprecated_function(zero_nine)
 
206
def compare_trees(old_tree, new_tree, want_unchanged=False,
 
207
                  specific_files=None, extra_trees=None,
 
208
                  require_versioned=False):
 
209
    """compare_trees was deprecated in 0.10. Please see Tree.changes_from."""
 
210
    return new_tree.changes_from(old_tree,
 
211
        want_unchanged=want_unchanged,
 
212
        specific_files=specific_files,
 
213
        extra_trees=extra_trees,
 
214
        require_versioned=require_versioned,
 
215
        include_root=False)
 
216
 
114
217
 
115
218
def _compare_trees(old_tree, new_tree, want_unchanged, specific_files,
116
219
                   include_root, extra_trees=None,
120
223
    # mutter('start compare_trees')
121
224
 
122
225
    for (file_id, path, content_change, versioned, parent_id, name, kind,
123
 
         executable) in new_tree.iter_changes(old_tree, want_unchanged,
 
226
         executable) in new_tree._iter_changes(old_tree, want_unchanged,
124
227
            specific_files, extra_trees=extra_trees,
125
228
            require_versioned=require_versioned,
126
229
            want_unversioned=want_unversioned):
135
238
            if fully_present[1] is True:
136
239
                delta.added.append((path[1], file_id, kind[1]))
137
240
            else:
 
241
                assert fully_present[0] is True
138
242
                delta.removed.append((path[0], file_id, kind[0]))
139
243
        elif fully_present[0] is False:
140
244
            continue
150
254
                                  (executable[0] != executable[1])))
151
255
        elif kind[0] != kind[1]:
152
256
            delta.kind_changed.append((path[1], file_id, kind[0], kind[1]))
153
 
        elif content_change or executable[0] != executable[1]:
 
257
        elif content_change is True or executable[0] != executable[1]:
154
258
            delta.modified.append((path[1], file_id, kind[1],
155
259
                                   content_change,
156
260
                                   (executable[0] != executable[1])))
172
276
    """Report changes between two trees"""
173
277
 
174
278
    def __init__(self, output=None, suppress_root_add=True,
175
 
                 output_file=None, unversioned_filter=None, view_info=None):
 
279
                 output_file=None, unversioned_filter=None):
176
280
        """Constructor
177
281
 
178
282
        :param output: a function with the signature of trace.note, i.e.
181
285
            (i.e. when a tree has just been initted)
182
286
        :param output_file: If supplied, a file-like object to write to.
183
287
            Only one of output and output_file may be supplied.
184
 
        :param unversioned_filter: A filter function to be called on
 
288
        :param unversioned_filter: A filter function to be called on 
185
289
            unversioned files. This should return True to ignore a path.
186
290
            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.
190
291
        """
191
292
        if output_file is not None:
192
293
            if output is not None:
209
310
                              'unversioned': '?', # versioned in neither
210
311
                              }
211
312
        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,))
220
313
 
221
314
    def report(self, file_id, paths, versioned, renamed, modified, exe_change,
222
315
               kind):
223
316
        """Report one change to a file
224
317
 
225
318
        :param file_id: The file_id of the file
226
 
        :param path: The old and new paths as generated by Tree.iter_changes.
 
319
        :param path: The old and new paths as generated by Tree._iter_changes.
227
320
        :param versioned: may be 'added', 'removed', 'unchanged', or
228
321
            'unversioned.
229
322
        :param renamed: may be True or False
230
323
        :param modified: may be 'created', 'deleted', 'kind changed',
231
324
            'modified' or 'unchanged'.
232
325
        :param exe_change: True if the execute bit has changed
233
 
        :param kind: A pair of file kinds, as generated by Tree.iter_changes.
 
326
        :param kind: A pair of file kinds, as generated by Tree._iter_changes.
234
327
            None indicates no file present.
235
328
        """
236
 
        if is_quiet():
237
 
            return
238
329
        if paths[1] == '' and versioned == 'added' and self.suppress_root_add:
239
330
            return
240
 
        if self.view_files and not osutils.is_inside_any(self.view_files,
241
 
            paths[1]):
242
 
            return
243
331
        if versioned == 'unversioned':
244
332
            # skip ignored unversioned files if needed.
245
333
            if self.unversioned_filter is not None:
257
345
                # on a rename, we show old and new
258
346
                old_path, path = paths
259
347
            else:
260
 
                # if it's not renamed, we're showing both for kind changes
 
348
                # if its not renamed, we're showing both for kind changes
261
349
                # so only show the new path
262
350
                old_path, path = paths[1], paths[1]
263
351
            # if the file is not missing in the source, we show its kind
289
377
        self.output("%s%s%s %s%s", rename, self.modified_map[modified], exe,
290
378
                    old_path, path)
291
379
 
 
380
 
292
381
def report_changes(change_iterator, reporter):
293
382
    """Report the changes from a change iterator.
294
383
 
296
385
    Further processing may be required to produce a human-readable output.
297
386
    Unfortunately, some tree-changing operations are very complex
298
387
    :change_iterator: an iterator or sequence of changes in the format
299
 
        generated by Tree.iter_changes
 
388
        generated by Tree._iter_changes
300
389
    :param reporter: The _ChangeReporter that will report the changes.
301
390
    """
302
391
    versioned_change_map = {
332
421
        versioned_change = versioned_change_map[versioned]
333
422
        reporter.report(file_id, path, versioned_change, renamed, modified,
334
423
                        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