~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/delta.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-09 04:51:05 UTC
  • Revision ID: mbp@sourcefrog.net-20050309045105-d02cd410a115da2c
import all docs from arch

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#! /usr/bin/env python
2
 
# -*- coding: UTF-8 -*-
3
 
 
4
 
# This program is free software; you can redistribute it and/or modify
5
 
# it under the terms of the GNU General Public License as published by
6
 
# the Free Software Foundation; either version 2 of the License, or
7
 
# (at your option) any later version.
8
 
 
9
 
# This program is distributed in the hope that it will be useful,
10
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
 
# GNU General Public License for more details.
13
 
 
14
 
# You should have received a copy of the GNU General Public License
15
 
# along with this program; if not, write to the Free Software
16
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
 
 
18
 
from bzrlib.trace import mutter
19
 
 
20
 
class TreeDelta(object):
21
 
    """Describes changes from one tree to another.
22
 
 
23
 
    Contains four lists:
24
 
 
25
 
    added
26
 
        (path, id, kind)
27
 
    removed
28
 
        (path, id, kind)
29
 
    renamed
30
 
        (oldpath, newpath, id, kind, text_modified)
31
 
    modified
32
 
        (path, id, kind)
33
 
    unchanged
34
 
        (path, id, kind)
35
 
 
36
 
    Each id is listed only once.
37
 
 
38
 
    Files that are both modified and renamed are listed only in
39
 
    renamed, with the text_modified flag true.
40
 
 
41
 
    Files are only considered renamed if their name has changed or
42
 
    their parent directory has changed.  Renaming a directory
43
 
    does not count as renaming all its contents.
44
 
 
45
 
    The lists are normally sorted when the delta is created.
46
 
    """
47
 
    def __init__(self):
48
 
        self.added = []
49
 
        self.removed = []
50
 
        self.renamed = []
51
 
        self.modified = []
52
 
        self.unchanged = []
53
 
 
54
 
    def __eq__(self, other):
55
 
        if not isinstance(other, TreeDelta):
56
 
            return False
57
 
        return self.added == other.added \
58
 
               and self.removed == other.removed \
59
 
               and self.renamed == other.renamed \
60
 
               and self.modified == other.modified \
61
 
               and self.unchanged == other.unchanged
62
 
 
63
 
    def __ne__(self, other):
64
 
        return not (self == other)
65
 
 
66
 
    def __repr__(self):
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)
70
 
 
71
 
    def has_changed(self):
72
 
        changes = len(self.added) + len(self.removed) + len(self.renamed)
73
 
        changes += len(self.modified) 
74
 
        return (changes != 0)
75
 
 
76
 
    def touches_file_id(self, file_id):
77
 
        """Return True if file_id is modified by this delta."""
78
 
        for l in self.added, self.removed, self.modified:
79
 
            for v in l:
80
 
                if v[1] == file_id:
81
 
                    return True
82
 
        for v in self.renamed:
83
 
            if v[2] == file_id:
84
 
                return True
85
 
        return False
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
150
 
    delta = TreeDelta()
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)
179
 
            else:
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))
198
 
        else:
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))
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
 
            
221
 
    delta.removed.sort()
222
 
    delta.added.sort()
223
 
    delta.renamed.sort()
224
 
    delta.modified.sort()
225
 
    delta.unchanged.sort()
226
 
 
227
 
    return delta