← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/delta.py

  • Committer: John Arbash Meinel
  • Date: 2007-03-02 16:51:24 UTC
  • mto: This revision was merged to the branch mainline in revision 2321.
  • Revision ID: john@arbash-meinel.com-20070302165124-pzxf42224e9j7ju2
Update the 'escaped store' tests to use both unicode and utf8 file ids.

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
 
    unversioned
41
 
        (path, None, kind)
42
41
 
43
42
    Each id is listed only once.
44
43
 
45
44
    Files that are both modified and renamed are listed only in
46
45
    renamed, with the text_modified flag true. The text_modified
47
 
    applies either to the content of the file or the target of the
 
46
    applies either to the the content of the file or the target of the
48
47
    symbolic link, depending of the kind of file.
49
48
 
50
49
    Files are only considered renamed if their name has changed or
60
59
        self.kind_changed = []
61
60
        self.modified = []
62
61
        self.unchanged = []
63
 
        self.unversioned = []
64
62
 
65
63
    def __eq__(self, other):
66
64
        if not isinstance(other, TreeDelta):
70
68
               and self.renamed == other.renamed \
71
69
               and self.modified == other.modified \
72
70
               and self.unchanged == other.unchanged \
73
 
               and self.kind_changed == other.kind_changed \
74
 
               and self.unversioned == other.unversioned
 
71
               and self.kind_changed == other.kind_changed
75
72
 
76
73
    def __ne__(self, other):
77
74
        return not (self == other)
78
75
 
79
76
    def __repr__(self):
80
77
        return "TreeDelta(added=%r, removed=%r, renamed=%r," \
81
 
            " kind_changed=%r, modified=%r, unchanged=%r," \
82
 
            " unversioned=%r)" % (self.added,
 
78
            " kind_changed=%r, modified=%r, unchanged=%r)" % (self.added,
83
79
            self.removed, self.renamed, self.kind_changed, self.modified,
84
 
            self.unchanged, self.unversioned)
 
80
            self.unchanged)
85
81
 
86
82
    def has_changed(self):
87
83
        return bool(self.modified
103
99
            if v[1] == file_id:
104
100
                return True
105
101
        return False
106
 
 
107
 
    def get_changes_as_text(self, show_ids=False, show_unchanged=False,
108
 
                            short_status=False):
109
 
        import StringIO
110
 
        output = StringIO.StringIO()
111
 
        report_delta(output, self, short_status, show_ids, show_unchanged)
112
 
        return output.getvalue()
113
 
 
114
 
 
115
 
def _compare_trees(old_tree, new_tree, want_unchanged, specific_files,
116
 
                   include_root, extra_trees=None,
117
 
                   require_versioned=False, want_unversioned=False):
118
 
    """Worker function that implements Tree.changes_from."""
 
102
            
 
103
 
 
104
    def show(self, to_file, show_ids=False, show_unchanged=False,
 
105
             short_status=False):
 
106
        """output this delta in status-like form to to_file."""
 
107
        def show_list(files, short_status_letter=''):
 
108
            for item in files:
 
109
                path, fid, kind = item[:3]
 
110
 
 
111
                if kind == 'directory':
 
112
                    path += '/'
 
113
                elif kind == 'symlink':
 
114
                    path += '@'
 
115
 
 
116
                if len(item) == 5 and item[4]:
 
117
                    path += '*'
 
118
 
 
119
                if show_ids:
 
120
                    print >>to_file, '%s  %-30s %s' % (short_status_letter,
 
121
                        path, fid)
 
122
                else:
 
123
                    print >>to_file, '%s  %s' % (short_status_letter, path)
 
124
            
 
125
        if self.removed:
 
126
            if not short_status:
 
127
                print >>to_file, 'removed:'
 
128
                show_list(self.removed)
 
129
            else:
 
130
                show_list(self.removed, 'D')
 
131
                
 
132
        if self.added:
 
133
            if not short_status:
 
134
                print >>to_file, 'added:'
 
135
                show_list(self.added)
 
136
            else:
 
137
                show_list(self.added, 'A')
 
138
 
 
139
        extra_modified = []
 
140
 
 
141
        if self.renamed:
 
142
            short_status_letter = 'R'
 
143
            if not short_status:
 
144
                print >>to_file, 'renamed:'
 
145
                short_status_letter = ''
 
146
            for (oldpath, newpath, fid, kind,
 
147
                 text_modified, meta_modified) in self.renamed:
 
148
                if text_modified or meta_modified:
 
149
                    extra_modified.append((newpath, fid, kind,
 
150
                                           text_modified, meta_modified))
 
151
                if meta_modified:
 
152
                    newpath += '*'
 
153
                if show_ids:
 
154
                    print >>to_file, '%s  %s => %s %s' % (
 
155
                        short_status_letter, oldpath, newpath, fid)
 
156
                else:
 
157
                    print >>to_file, '%s  %s => %s' % (
 
158
                        short_status_letter, oldpath, newpath)
 
159
 
 
160
        if self.kind_changed:
 
161
            if short_status:
 
162
                short_status_letter = 'K'
 
163
            else:
 
164
                print >>to_file, 'kind changed:'
 
165
                short_status_letter = ''
 
166
            for (path, fid, old_kind, new_kind) in self.kind_changed:
 
167
                if show_ids:
 
168
                    suffix = ' '+fid
 
169
                else:
 
170
                    suffix = ''
 
171
                print >>to_file, '%s  %s (%s => %s)%s' % (
 
172
                    short_status_letter, path, old_kind, new_kind, suffix)
 
173
 
 
174
        if self.modified or extra_modified:
 
175
            short_status_letter = 'M'
 
176
            if not short_status:
 
177
                print >>to_file, 'modified:'
 
178
                short_status_letter = ''
 
179
            show_list(self.modified, short_status_letter)
 
180
            show_list(extra_modified, short_status_letter)
 
181
            
 
182
        if show_unchanged and self.unchanged:
 
183
            if not short_status:
 
184
                print >>to_file, 'unchanged:'
 
185
                show_list(self.unchanged)
 
186
            else:
 
187
                show_list(self.unchanged, 'S')
 
188
 
 
189
 
 
190
@deprecated_function(zero_nine)
 
191
def compare_trees(old_tree, new_tree, want_unchanged=False,
 
192
                  specific_files=None, extra_trees=None,
 
193
                  require_versioned=False):
 
194
    """compare_trees was deprecated in 0.10. Please see Tree.changes_from."""
 
195
    return new_tree.changes_from(old_tree,
 
196
        want_unchanged=want_unchanged,
 
197
        specific_files=specific_files,
 
198
        extra_trees=extra_trees,
 
199
        require_versioned=require_versioned,
 
200
        include_root=False)
 
201
 
 
202
 
 
203
def _compare_trees(old_tree, new_tree, want_unchanged, specific_file_ids,
 
204
                   include_root):
119
205
    delta = TreeDelta()
120
206
    # mutter('start compare_trees')
121
207
 
122
208
    for (file_id, path, content_change, versioned, parent_id, name, kind,
123
 
         executable) in new_tree.iter_changes(old_tree, want_unchanged,
124
 
            specific_files, extra_trees=extra_trees,
125
 
            require_versioned=require_versioned,
126
 
            want_unversioned=want_unversioned):
127
 
        if versioned == (False, False):
128
 
            delta.unversioned.append((path[1], None, kind[1]))
129
 
            continue
 
209
         executable) in new_tree._iter_changes(old_tree, want_unchanged, 
 
210
                                               specific_file_ids):
130
211
        if not include_root and (None, None) == parent_id:
131
212
            continue
132
213
        fully_present = tuple((versioned[x] and kind[x] is not None) for
133
214
                              x in range(2))
134
215
        if fully_present[0] != fully_present[1]:
135
216
            if fully_present[1] is True:
136
 
                delta.added.append((path[1], file_id, kind[1]))
 
217
                delta.added.append((path, file_id, kind[1]))
137
218
            else:
138
 
                delta.removed.append((path[0], file_id, kind[0]))
 
219
                assert fully_present[0] is True
 
220
                old_path = old_tree.id2path(file_id)
 
221
                delta.removed.append((old_path, file_id, kind[0]))
139
222
        elif fully_present[0] is False:
140
223
            continue
141
224
        elif name[0] != name[1] or parent_id[0] != parent_id[1]:
142
225
            # If the name changes, or the parent_id changes, we have a rename
143
226
            # (if we move a parent, that doesn't count as a rename for the
144
227
            # file)
145
 
            delta.renamed.append((path[0],
146
 
                                  path[1],
147
 
                                  file_id,
 
228
            old_path = old_tree.id2path(file_id)
 
229
            delta.renamed.append((old_path,
 
230
                                  path,
 
231
                                  file_id, 
148
232
                                  kind[1],
149
 
                                  content_change,
 
233
                                  content_change, 
150
234
                                  (executable[0] != executable[1])))
151
235
        elif kind[0] != kind[1]:
152
 
            delta.kind_changed.append((path[1], file_id, kind[0], kind[1]))
153
 
        elif content_change or executable[0] != executable[1]:
154
 
            delta.modified.append((path[1], file_id, kind[1],
155
 
                                   content_change,
 
236
            delta.kind_changed.append((path, file_id, kind[0], kind[1]))
 
237
        elif content_change is True or executable[0] != executable[1]:
 
238
            delta.modified.append((path, file_id, kind[1],
 
239
                                   content_change, 
156
240
                                   (executable[0] != executable[1])))
157
241
        else:
158
 
            delta.unchanged.append((path[1], file_id, kind[1]))
 
242
            delta.unchanged.append((path, file_id, kind[1]))
159
243
 
160
244
    delta.removed.sort()
161
245
    delta.added.sort()
168
252
    return delta
169
253
 
170
254
 
171
 
class _ChangeReporter(object):
 
255
class ChangeReporter(object):
172
256
    """Report changes between two trees"""
173
257
 
174
 
    def __init__(self, output=None, suppress_root_add=True,
175
 
                 output_file=None, unversioned_filter=None, view_info=None):
 
258
    def __init__(self, old_inventory, output=None, suppress_root_add=True,
 
259
                 output_file=None):
176
260
        """Constructor
177
261
 
 
262
        :param old_inventory: The inventory of the old tree
178
263
        :param output: a function with the signature of trace.note, i.e.
179
264
            accepts a format and parameters.
180
265
        :param supress_root_add: If true, adding the root will be ignored
181
266
            (i.e. when a tree has just been initted)
182
267
        :param output_file: If supplied, a file-like object to write to.
183
268
            Only one of output and output_file may be supplied.
184
 
        :param unversioned_filter: A filter function to be called on
185
 
            unversioned files. This should return True to ignore a path.
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.
190
269
        """
 
270
        self.old_inventory = old_inventory
191
271
        if output_file is not None:
192
272
            if output is not None:
193
273
                raise BzrError('Cannot specify both output and output_file')
198
278
            from bzrlib import trace
199
279
            self.output = trace.note
200
280
        self.suppress_root_add = suppress_root_add
201
 
        self.modified_map = {'kind changed': 'K',
202
 
                             'unchanged': ' ',
203
 
                             'created': 'N',
204
 
                             'modified': 'M',
205
 
                             'deleted': 'D'}
206
 
        self.versioned_map = {'added': '+', # versioned target
207
 
                              'unchanged': ' ', # versioned in both
208
 
                              'removed': '-', # versioned in source
209
 
                              'unversioned': '?', # versioned in neither
210
 
                              }
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,))
220
281
 
221
 
    def report(self, file_id, paths, versioned, renamed, modified, exe_change,
 
282
    def report(self, file_id, path, versioned, renamed, modified, exe_change,
222
283
               kind):
223
284
        """Report one change to a file
224
285
 
225
286
        :param file_id: The file_id of the file
226
 
        :param path: The old and new paths as generated by Tree.iter_changes.
227
 
        :param versioned: may be 'added', 'removed', 'unchanged', or
228
 
            'unversioned.
 
287
        :param path: The path the file has (or would have) in the tree (as
 
288
            generated by Tree._iter_changes)
 
289
        :param versioned: may be 'added', 'removed', or 'unchanged'
229
290
        :param renamed: may be True or False
230
291
        :param modified: may be 'created', 'deleted', 'kind changed',
231
292
            'modified' or 'unchanged'.
232
293
        :param exe_change: True if the execute bit has changed
233
 
        :param kind: A pair of file kinds, as generated by Tree.iter_changes.
 
294
        :param kind: A pair of file kinds, as generated by Tree._iter_changes.
234
295
            None indicates no file present.
235
296
        """
236
 
        if is_quiet():
237
 
            return
238
 
        if paths[1] == '' and versioned == 'added' and self.suppress_root_add:
239
 
            return
240
 
        if self.view_files and not osutils.is_inside_any(self.view_files,
241
 
            paths[1]):
242
 
            return
243
 
        if versioned == 'unversioned':
244
 
            # skip ignored unversioned files if needed.
245
 
            if self.unversioned_filter is not None:
246
 
                if self.unversioned_filter(paths[1]):
247
 
                    return
248
 
            # dont show a content change in the output.
249
 
            modified = 'unchanged'
250
 
        # we show both paths in the following situations:
251
 
        # the file versioning is unchanged AND
252
 
        # ( the path is different OR
253
 
        #   the kind is different)
254
 
        if (versioned == 'unchanged' and
255
 
            (renamed or modified == 'kind changed')):
256
 
            if renamed:
257
 
                # on a rename, we show old and new
258
 
                old_path, path = paths
259
 
            else:
260
 
                # if it's not renamed, we're showing both for kind changes
261
 
                # so only show the new path
262
 
                old_path, path = paths[1], paths[1]
263
 
            # if the file is not missing in the source, we show its kind
264
 
            # when we show two paths.
265
 
            if kind[0] is not None:
266
 
                old_path += osutils.kind_marker(kind[0])
267
 
            old_path += " => "
268
 
        elif versioned == 'removed':
269
 
            # not present in target
270
 
            old_path = ""
271
 
            path = paths[0]
272
 
        else:
273
 
            old_path = ""
274
 
            path = paths[1]
 
297
        if path == '' and versioned == 'added' and self.suppress_root_add:
 
298
            return
 
299
        modified_map = {'kind changed': 'K',
 
300
                        'unchanged': ' ',
 
301
                        'created': 'N',
 
302
                        'modified': 'M',
 
303
                        'deleted': 'D'}
 
304
        versioned_map = {'added': '+',
 
305
                         'unchanged': ' ',
 
306
                         'removed': '-'}
 
307
        old_path = ""
275
308
        if renamed:
 
309
            old_path = self.old_inventory.id2path(file_id)
276
310
            rename = "R"
277
311
        else:
278
 
            rename = self.versioned_map[versioned]
279
 
        # we show the old kind on the new path when the content is deleted.
 
312
            rename = versioned_map[versioned]
 
313
        if modified == 'kind changed':
 
314
            if old_path == "":
 
315
                old_path = path
280
316
        if modified == 'deleted':
281
317
            path += osutils.kind_marker(kind[0])
282
 
        # otherwise we always show the current kind when there is one
283
318
        elif kind[1] is not None:
284
319
            path += osutils.kind_marker(kind[1])
 
320
        if old_path != "":
 
321
            if kind[0] is not None:
 
322
                old_path += osutils.kind_marker(kind[0])
 
323
            old_path += " => "
285
324
        if exe_change:
286
325
            exe = '*'
287
326
        else:
288
327
            exe = ' '
289
 
        self.output("%s%s%s %s%s", rename, self.modified_map[modified], exe,
 
328
        self.output("%s%s%s %s%s", rename, modified_map[modified], exe,
290
329
                    old_path, path)
291
330
 
 
331
 
292
332
def report_changes(change_iterator, reporter):
293
333
    """Report the changes from a change iterator.
294
334
 
296
336
    Further processing may be required to produce a human-readable output.
297
337
    Unfortunately, some tree-changing operations are very complex
298
338
    :change_iterator: an iterator or sequence of changes in the format
299
 
        generated by Tree.iter_changes
300
 
    :param reporter: The _ChangeReporter that will report the changes.
 
339
        generated by Tree._iter_changes
 
340
    :param reporter: The ChangeReporter that will report the changes.
301
341
    """
302
 
    versioned_change_map = {
303
 
        (True, True)  : 'unchanged',
304
 
        (True, False) : 'removed',
305
 
        (False, True) : 'added',
306
 
        (False, False): 'unversioned',
307
 
        }
308
342
    for (file_id, path, content_change, versioned, parent_id, name, kind,
309
343
         executable) in change_iterator:
310
344
        exe_change = False
329
363
                modified = "unchanged"
330
364
            if kind[1] == "file":
331
365
                exe_change = (executable[0] != executable[1])
332
 
        versioned_change = versioned_change_map[versioned]
 
366
        if versioned[0] != versioned[1]:
 
367
            if versioned[0]:
 
368
                versioned_change = "removed"
 
369
            else:
 
370
                versioned_change = "added"
 
371
        else:
 
372
            versioned_change = "unchanged"
333
373
        reporter.report(file_id, path, versioned_change, renamed, modified,
334
374
                        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