← 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: 2005-09-01 06:32:52 UTC
  • Revision ID: mbp@sourcefrog.net-20050901063252-00fc761bf1076759
- make target to build emacs TAGS file

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/delta.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
2
 
#
 
1
#! /usr/bin/env python
 
2
# -*- coding: UTF-8 -*-
 
3
 
3
4
# This program is free software; you can redistribute it and/or modify
4
5
# it under the terms of the GNU General Public License as published by
5
6
# the Free Software Foundation; either version 2 of the License, or
6
7
# (at your option) any later version.
7
 
#
 
8
 
8
9
# This program is distributed in the hope that it will be useful,
9
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
12
# GNU General Public License for more details.
12
 
#
 
13
 
13
14
# You should have received a copy of the GNU General Public License
14
15
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
from bzrlib import (
18
 
    errors,
19
 
    osutils,
20
 
    )
21
 
from bzrlib.inventory import InventoryEntry
22
 
from bzrlib.trace import mutter, is_quiet
23
 
from bzrlib.symbol_versioning import deprecated_function
24
 
 
 
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
17
 
 
18
from bzrlib.trace import mutter
25
19
 
26
20
class TreeDelta(object):
27
21
    """Describes changes from one tree to another.
28
22
 
29
 
    Contains seven lists:
 
23
    Contains four lists:
30
24
 
31
25
    added
32
26
        (path, id, kind)
33
27
    removed
34
28
        (path, id, kind)
35
29
    renamed
36
 
        (oldpath, newpath, id, kind, text_modified, meta_modified)
37
 
    kind_changed
38
 
        (path, id, old_kind, new_kind)
 
30
        (oldpath, newpath, id, kind, text_modified)
39
31
    modified
40
 
        (path, id, kind, text_modified, meta_modified)
 
32
        (path, id, kind)
41
33
    unchanged
42
34
        (path, id, kind)
43
 
    unversioned
44
 
        (path, None, kind)
45
35
 
46
36
    Each id is listed only once.
47
37
 
48
38
    Files that are both modified and renamed are listed only in
49
 
    renamed, with the text_modified flag true. The text_modified
50
 
    applies either to the content of the file or the target of the
51
 
    symbolic link, depending of the kind of file.
 
39
    renamed, with the text_modified flag true.
52
40
 
53
41
    Files are only considered renamed if their name has changed or
54
42
    their parent directory has changed.  Renaming a directory
60
48
        self.added = []
61
49
        self.removed = []
62
50
        self.renamed = []
63
 
        self.kind_changed = []
64
51
        self.modified = []
65
52
        self.unchanged = []
66
 
        self.unversioned = []
67
53
 
68
54
    def __eq__(self, other):
69
55
        if not isinstance(other, TreeDelta):
72
58
               and self.removed == other.removed \
73
59
               and self.renamed == other.renamed \
74
60
               and self.modified == other.modified \
75
 
               and self.unchanged == other.unchanged \
76
 
               and self.kind_changed == other.kind_changed \
77
 
               and self.unversioned == other.unversioned
 
61
               and self.unchanged == other.unchanged
78
62
 
79
63
    def __ne__(self, other):
80
64
        return not (self == other)
81
65
 
82
66
    def __repr__(self):
83
 
        return "TreeDelta(added=%r, removed=%r, renamed=%r," \
84
 
            " kind_changed=%r, modified=%r, unchanged=%r," \
85
 
            " unversioned=%r)" % (self.added,
86
 
            self.removed, self.renamed, self.kind_changed, self.modified,
87
 
            self.unchanged, self.unversioned)
 
67
        return "TreeDelta(added=%r, removed=%r, renamed=%r, modified=%r," \
 
68
            " unchanged=%r)" % (self.added, self.removed, self.renamed,
 
69
            self.modified, self.unchanged)
88
70
 
89
71
    def has_changed(self):
90
 
        return bool(self.modified
91
 
                    or self.added
92
 
                    or self.removed
93
 
                    or self.renamed
94
 
                    or self.kind_changed)
 
72
        changes = len(self.added) + len(self.removed) + len(self.renamed)
 
73
        changes += len(self.modified) 
 
74
        return (changes != 0)
95
75
 
96
76
    def touches_file_id(self, file_id):
97
77
        """Return True if file_id is modified by this delta."""
102
82
        for v in self.renamed:
103
83
            if v[2] == file_id:
104
84
                return True
105
 
        for v in self.kind_changed:
106
 
            if v[1] == file_id:
107
 
                return True
108
85
        return False
109
 
 
110
 
    def get_changes_as_text(self, show_ids=False, show_unchanged=False,
111
 
                            short_status=False):
112
 
        import StringIO
113
 
        output = StringIO.StringIO()
114
 
        report_delta(output, self, short_status, show_ids, show_unchanged)
115
 
        return output.getvalue()
116
 
 
117
 
 
118
 
def _compare_trees(old_tree, new_tree, want_unchanged, specific_files,
119
 
                   include_root, extra_trees=None,
120
 
                   require_versioned=False, want_unversioned=False):
121
 
    """Worker function that implements Tree.changes_from."""
 
86
            
 
87
 
 
88
    def show(self, to_file, show_ids=False, show_unchanged=False):
 
89
        def show_list(files):
 
90
            for path, fid, kind in files:
 
91
                if kind == 'directory':
 
92
                    path += '/'
 
93
                elif kind == 'symlink':
 
94
                    path += '@'
 
95
                    
 
96
                if show_ids:
 
97
                    print >>to_file, '  %-30s %s' % (path, fid)
 
98
                else:
 
99
                    print >>to_file, ' ', path
 
100
            
 
101
        if self.removed:
 
102
            print >>to_file, 'removed:'
 
103
            show_list(self.removed)
 
104
                
 
105
        if self.added:
 
106
            print >>to_file, 'added:'
 
107
            show_list(self.added)
 
108
 
 
109
        if self.renamed:
 
110
            print >>to_file, 'renamed:'
 
111
            for oldpath, newpath, fid, kind, text_modified in self.renamed:
 
112
                if show_ids:
 
113
                    print >>to_file, '  %s => %s %s' % (oldpath, newpath, fid)
 
114
                else:
 
115
                    print >>to_file, '  %s => %s' % (oldpath, newpath)
 
116
                    
 
117
        if self.modified:
 
118
            print >>to_file, 'modified:'
 
119
            show_list(self.modified)
 
120
            
 
121
        if show_unchanged and self.unchanged:
 
122
            print >>to_file, 'unchanged:'
 
123
            show_list(self.unchanged)
 
124
 
 
125
 
 
126
 
 
127
def compare_trees(old_tree, new_tree, want_unchanged=False, specific_files=None):
 
128
    """Describe changes from one tree to another.
 
129
 
 
130
    Returns a TreeDelta with details of added, modified, renamed, and
 
131
    deleted entries.
 
132
 
 
133
    The root entry is specifically exempt.
 
134
 
 
135
    This only considers versioned files.
 
136
 
 
137
    want_unchanged
 
138
        If true, also list files unchanged from one version to
 
139
        the next.
 
140
 
 
141
    specific_files
 
142
        If true, only check for changes to specified names or
 
143
        files within them.
 
144
    """
 
145
 
 
146
    from osutils import is_inside_any
 
147
    
 
148
    old_inv = old_tree.inventory
 
149
    new_inv = new_tree.inventory
122
150
    delta = TreeDelta()
123
 
    # mutter('start compare_trees')
124
 
 
125
 
    for (file_id, path, content_change, versioned, parent_id, name, kind,
126
 
         executable) in new_tree.iter_changes(old_tree, want_unchanged,
127
 
            specific_files, extra_trees=extra_trees,
128
 
            require_versioned=require_versioned,
129
 
            want_unversioned=want_unversioned):
130
 
        if versioned == (False, False):
131
 
            delta.unversioned.append((path[1], None, kind[1]))
132
 
            continue
133
 
        if not include_root and (None, None) == parent_id:
134
 
            continue
135
 
        fully_present = tuple((versioned[x] and kind[x] is not None) for
136
 
                              x in range(2))
137
 
        if fully_present[0] != fully_present[1]:
138
 
            if fully_present[1] is True:
139
 
                delta.added.append((path[1], file_id, kind[1]))
 
151
    mutter('start compare_trees')
 
152
 
 
153
    # TODO: match for specific files can be rather smarter by finding
 
154
    # the IDs of those files up front and then considering only that.
 
155
 
 
156
    for file_id in old_tree:
 
157
        if file_id in new_tree:
 
158
            old_ie = old_inv[file_id]
 
159
            new_ie = new_inv[file_id]
 
160
 
 
161
            kind = old_ie.kind
 
162
            assert kind == new_ie.kind
 
163
            
 
164
            assert kind in ('file', 'directory', 'symlink', 'root_directory'), \
 
165
                   'invalid file kind %r' % kind
 
166
 
 
167
            if kind == 'root_directory':
 
168
                continue
 
169
            
 
170
            if specific_files:
 
171
                if (not is_inside_any(specific_files, old_inv.id2path(file_id)) 
 
172
                    and not is_inside_any(specific_files, new_inv.id2path(file_id))):
 
173
                    continue
 
174
 
 
175
            if kind == 'file':
 
176
                old_sha1 = old_tree.get_file_sha1(file_id)
 
177
                new_sha1 = new_tree.get_file_sha1(file_id)
 
178
                text_modified = (old_sha1 != new_sha1)
140
179
            else:
141
 
                delta.removed.append((path[0], file_id, kind[0]))
142
 
        elif fully_present[0] is False:
143
 
            continue
144
 
        elif name[0] != name[1] or parent_id[0] != parent_id[1]:
145
 
            # If the name changes, or the parent_id changes, we have a rename
146
 
            # (if we move a parent, that doesn't count as a rename for the
147
 
            # file)
148
 
            delta.renamed.append((path[0],
149
 
                                  path[1],
150
 
                                  file_id,
151
 
                                  kind[1],
152
 
                                  content_change,
153
 
                                  (executable[0] != executable[1])))
154
 
        elif kind[0] != kind[1]:
155
 
            delta.kind_changed.append((path[1], file_id, kind[0], kind[1]))
156
 
        elif content_change or executable[0] != executable[1]:
157
 
            delta.modified.append((path[1], file_id, kind[1],
158
 
                                   content_change,
159
 
                                   (executable[0] != executable[1])))
 
180
                ## mutter("no text to check for %r %r" % (file_id, kind))
 
181
                text_modified = False
 
182
 
 
183
            # TODO: Can possibly avoid calculating path strings if the
 
184
            # two files are unchanged and their names and parents are
 
185
            # the same and the parents are unchanged all the way up.
 
186
            # May not be worthwhile.
 
187
            
 
188
            if (old_ie.name != new_ie.name
 
189
                or old_ie.parent_id != new_ie.parent_id):
 
190
                delta.renamed.append((old_inv.id2path(file_id),
 
191
                                      new_inv.id2path(file_id),
 
192
                                      file_id, kind,
 
193
                                      text_modified))
 
194
            elif text_modified:
 
195
                delta.modified.append((new_inv.id2path(file_id), file_id, kind))
 
196
            elif want_unchanged:
 
197
                delta.unchanged.append((new_inv.id2path(file_id), file_id, kind))
160
198
        else:
161
 
            delta.unchanged.append((path[1], file_id, kind[1]))
 
199
            kind = old_inv.get_file_kind(file_id)
 
200
            if kind == 'root_directory':
 
201
                continue
 
202
            old_path = old_inv.id2path(file_id)
 
203
            if specific_files:
 
204
                if not is_inside_any(specific_files, old_path):
 
205
                    continue
 
206
            delta.removed.append((old_path, file_id, kind))
162
207
 
 
208
    mutter('start looking for new files')
 
209
    for file_id in new_inv:
 
210
        if file_id in old_inv:
 
211
            continue
 
212
        kind = new_inv.get_file_kind(file_id)
 
213
        if kind == 'root_directory':
 
214
            continue
 
215
        new_path = new_inv.id2path(file_id)
 
216
        if specific_files:
 
217
            if not is_inside_any(specific_files, new_path):
 
218
                continue
 
219
        delta.added.append((new_path, file_id, kind))
 
220
            
163
221
    delta.removed.sort()
164
222
    delta.added.sort()
165
223
    delta.renamed.sort()
166
 
    # TODO: jam 20060529 These lists shouldn't need to be sorted
167
 
    #       since we added them in alphabetical order.
168
224
    delta.modified.sort()
169
225
    delta.unchanged.sort()
170
226
 
171
227
    return delta
172
 
 
173
 
 
174
 
class _ChangeReporter(object):
175
 
    """Report changes between two trees"""
176
 
 
177
 
    def __init__(self, output=None, suppress_root_add=True,
178
 
                 output_file=None, unversioned_filter=None, view_info=None):
179
 
        """Constructor
180
 
 
181
 
        :param output: a function with the signature of trace.note, i.e.
182
 
            accepts a format and parameters.
183
 
        :param supress_root_add: If true, adding the root will be ignored
184
 
            (i.e. when a tree has just been initted)
185
 
        :param output_file: If supplied, a file-like object to write to.
186
 
            Only one of output and output_file may be supplied.
187
 
        :param unversioned_filter: A filter function to be called on
188
 
            unversioned files. This should return True to ignore a path.
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
 
        """
194
 
        if output_file is not None:
195
 
            if output is not None:
196
 
                raise BzrError('Cannot specify both output and output_file')
197
 
            def output(fmt, *args):
198
 
                output_file.write((fmt % args) + '\n')
199
 
        self.output = output
200
 
        if self.output is None:
201
 
            from bzrlib import trace
202
 
            self.output = trace.note
203
 
        self.suppress_root_add = suppress_root_add
204
 
        self.modified_map = {'kind changed': 'K',
205
 
                             'unchanged': ' ',
206
 
                             'created': 'N',
207
 
                             'modified': 'M',
208
 
                             'deleted': 'D'}
209
 
        self.versioned_map = {'added': '+', # versioned target
210
 
                              'unchanged': ' ', # versioned in both
211
 
                              'removed': '-', # versioned in source
212
 
                              'unversioned': '?', # versioned in neither
213
 
                              }
214
 
        self.unversioned_filter = unversioned_filter
215
 
        if view_info is None:
216
 
            self.view_name = None
217
 
            self.view_files = []
218
 
        else:
219
 
            self.view_name = view_info[0]
220
 
            self.view_files = view_info[1]
221
 
            self.output("Operating on whole tree but only reporting on "
222
 
                        "'%s' view." % (self.view_name,))
223
 
 
224
 
    def report(self, file_id, paths, versioned, renamed, modified, exe_change,
225
 
               kind):
226
 
        """Report one change to a file
227
 
 
228
 
        :param file_id: The file_id of the file
229
 
        :param path: The old and new paths as generated by Tree.iter_changes.
230
 
        :param versioned: may be 'added', 'removed', 'unchanged', or
231
 
            'unversioned.
232
 
        :param renamed: may be True or False
233
 
        :param modified: may be 'created', 'deleted', 'kind changed',
234
 
            'modified' or 'unchanged'.
235
 
        :param exe_change: True if the execute bit has changed
236
 
        :param kind: A pair of file kinds, as generated by Tree.iter_changes.
237
 
            None indicates no file present.
238
 
        """
239
 
        if is_quiet():
240
 
            return
241
 
        if paths[1] == '' and versioned == 'added' and self.suppress_root_add:
242
 
            return
243
 
        if self.view_files and not osutils.is_inside_any(self.view_files,
244
 
            paths[1]):
245
 
            return
246
 
        if versioned == 'unversioned':
247
 
            # skip ignored unversioned files if needed.
248
 
            if self.unversioned_filter is not None:
249
 
                if self.unversioned_filter(paths[1]):
250
 
                    return
251
 
            # dont show a content change in the output.
252
 
            modified = 'unchanged'
253
 
        # we show both paths in the following situations:
254
 
        # the file versioning is unchanged AND
255
 
        # ( the path is different OR
256
 
        #   the kind is different)
257
 
        if (versioned == 'unchanged' and
258
 
            (renamed or modified == 'kind changed')):
259
 
            if renamed:
260
 
                # on a rename, we show old and new
261
 
                old_path, path = paths
262
 
            else:
263
 
                # if it's not renamed, we're showing both for kind changes
264
 
                # so only show the new path
265
 
                old_path, path = paths[1], paths[1]
266
 
            # if the file is not missing in the source, we show its kind
267
 
            # when we show two paths.
268
 
            if kind[0] is not None:
269
 
                old_path += osutils.kind_marker(kind[0])
270
 
            old_path += " => "
271
 
        elif versioned == 'removed':
272
 
            # not present in target
273
 
            old_path = ""
274
 
            path = paths[0]
275
 
        else:
276
 
            old_path = ""
277
 
            path = paths[1]
278
 
        if renamed:
279
 
            rename = "R"
280
 
        else:
281
 
            rename = self.versioned_map[versioned]
282
 
        # we show the old kind on the new path when the content is deleted.
283
 
        if modified == 'deleted':
284
 
            path += osutils.kind_marker(kind[0])
285
 
        # otherwise we always show the current kind when there is one
286
 
        elif kind[1] is not None:
287
 
            path += osutils.kind_marker(kind[1])
288
 
        if exe_change:
289
 
            exe = '*'
290
 
        else:
291
 
            exe = ' '
292
 
        self.output("%s%s%s %s%s", rename, self.modified_map[modified], exe,
293
 
                    old_path, path)
294
 
 
295
 
def report_changes(change_iterator, reporter):
296
 
    """Report the changes from a change iterator.
297
 
 
298
 
    This is essentially a translation from low-level to medium-level changes.
299
 
    Further processing may be required to produce a human-readable output.
300
 
    Unfortunately, some tree-changing operations are very complex
301
 
    :change_iterator: an iterator or sequence of changes in the format
302
 
        generated by Tree.iter_changes
303
 
    :param reporter: The _ChangeReporter that will report the changes.
304
 
    """
305
 
    versioned_change_map = {
306
 
        (True, True)  : 'unchanged',
307
 
        (True, False) : 'removed',
308
 
        (False, True) : 'added',
309
 
        (False, False): 'unversioned',
310
 
        }
311
 
    for (file_id, path, content_change, versioned, parent_id, name, kind,
312
 
         executable) in change_iterator:
313
 
        exe_change = False
314
 
        # files are "renamed" if they are moved or if name changes, as long
315
 
        # as it had a value
316
 
        if None not in name and None not in parent_id and\
317
 
            (name[0] != name[1] or parent_id[0] != parent_id[1]):
318
 
            renamed = True
319
 
        else:
320
 
            renamed = False
321
 
        if kind[0] != kind[1]:
322
 
            if kind[0] is None:
323
 
                modified = "created"
324
 
            elif kind[1] is None:
325
 
                modified = "deleted"
326
 
            else:
327
 
                modified = "kind changed"
328
 
        else:
329
 
            if content_change:
330
 
                modified = "modified"
331
 
            else:
332
 
                modified = "unchanged"
333
 
            if kind[1] == "file":
334
 
                exe_change = (executable[0] != executable[1])
335
 
        versioned_change = versioned_change_map[versioned]
336
 
        reporter.report(file_id, path, versioned_change, renamed, modified,
337
 
                        exe_change, kind)
338
 
 
339
 
def report_delta(to_file, delta, short_status=False, show_ids=False, 
340
 
         show_unchanged=False, indent='', filter=None):
341
 
    """Output this delta in status-like form to to_file.
342
 
 
343
 
    :param to_file: A file-like object where the output is displayed.
344
 
 
345
 
    :param delta: A TreeDelta containing the changes to be displayed
346
 
 
347
 
    :param short_status: Single-line status if True.
348
 
 
349
 
    :param show_ids: Output the file ids if True.
350
 
 
351
 
    :param show_unchanged: Output the unchanged files if True.
352
 
 
353
 
    :param indent: Added at the beginning of all output lines (for merged
354
 
        revisions).
355
 
 
356
 
    :param filter: A callable receiving a path and a file id and
357
 
        returning True if the path should be displayed.
358
 
    """
359
 
 
360
 
    def decorate_path(path, kind, meta_modified=None):
361
 
        if kind == 'directory':
362
 
            path += '/'
363
 
        elif kind == 'symlink':
364
 
            path += '@'
365
 
        if meta_modified:
366
 
            path += '*'
367
 
        return path
368
 
 
369
 
    def show_more_renamed(item):
370
 
        (oldpath, file_id, kind,
371
 
         text_modified, meta_modified, newpath) = item
372
 
        dec_new_path = decorate_path(newpath, kind, meta_modified)
373
 
        to_file.write(' => %s' % dec_new_path)
374
 
        if text_modified or meta_modified:
375
 
            extra_modified.append((newpath, file_id, kind,
376
 
                                   text_modified, meta_modified))
377
 
 
378
 
    def show_more_kind_changed(item):
379
 
        (path, file_id, old_kind, new_kind) = item
380
 
        to_file.write(' (%s => %s)' % (old_kind, new_kind))
381
 
 
382
 
    def show_path(path, file_id, kind, meta_modified,
383
 
                  default_format, with_file_id_format):
384
 
        dec_path = decorate_path(path, kind, meta_modified)
385
 
        if show_ids:
386
 
            to_file.write(with_file_id_format % dec_path)
387
 
        else:
388
 
            to_file.write(default_format % dec_path)
389
 
 
390
 
    def show_list(files, long_status_name, short_status_letter,
391
 
                  default_format='%s', with_file_id_format='%-30s',
392
 
                  show_more=None):
393
 
        if files:
394
 
            header_shown = False
395
 
            if short_status:
396
 
                prefix = short_status_letter
397
 
            else:
398
 
                prefix = ''
399
 
            prefix = indent + prefix + '  '
400
 
 
401
 
            for item in files:
402
 
                path, file_id, kind = item[:3]
403
 
                if (filter is not None and not filter(path, file_id)):
404
 
                    continue
405
 
                if not header_shown and not short_status:
406
 
                    to_file.write(indent + long_status_name + ':\n')
407
 
                    header_shown = True
408
 
                meta_modified = None
409
 
                if len(item) == 5:
410
 
                    meta_modified = item[4]
411
 
 
412
 
                to_file.write(prefix)
413
 
                show_path(path, file_id, kind, meta_modified,
414
 
                          default_format, with_file_id_format)
415
 
                if show_more is not None:
416
 
                    show_more(item)
417
 
                if show_ids:
418
 
                    to_file.write(' %s' % file_id)
419
 
                to_file.write('\n')
420
 
 
421
 
    show_list(delta.removed, 'removed', 'D')
422
 
    show_list(delta.added, 'added', 'A')
423
 
    extra_modified = []
424
 
    # Reorder delta.renamed tuples so that all lists share the same
425
 
    # order for their 3 first fields and that they also begin like
426
 
    # the delta.modified tuples
427
 
    renamed = [(p, i, k, tm, mm, np)
428
 
               for  p, np, i, k, tm, mm  in delta.renamed]
429
 
    show_list(renamed, 'renamed', 'R', with_file_id_format='%s',
430
 
              show_more=show_more_renamed)
431
 
    show_list(delta.kind_changed, 'kind changed', 'K',
432
 
              with_file_id_format='%s',
433
 
              show_more=show_more_kind_changed)
434
 
    show_list(delta.modified + extra_modified, 'modified', 'M')
435
 
    if show_unchanged:
436
 
        show_list(delta.unchanged, 'unchanged', 'S')
437
 
 
438
 
    show_list(delta.unversioned, 'unknown', ' ')
439