~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/delta.py

  • Committer: Martin Pool
  • Date: 2005-05-03 08:00:27 UTC
  • Revision ID: mbp@sourcefrog.net-20050503080027-908edb5b39982198
doc

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# -*- coding: UTF-8 -*-
2
 
 
3
 
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License as published by
5
 
# the Free Software Foundation; either version 2 of the License, or
6
 
# (at your option) any later version.
7
 
 
8
 
# This program is distributed in the hope that it will be useful,
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
 
# GNU General Public License for more details.
12
 
 
13
 
# You should have received a copy of the GNU General Public License
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
16
 
 
17
 
from bzrlib.inventory import InventoryEntry
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, meta_modified)
31
 
    modified
32
 
        (path, id, kind, text_modified, meta_modified)
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. The text_modified
40
 
    applies either to the the content of the file or the target of the
41
 
    symbolic link, depending of the kind of file.
42
 
 
43
 
    Files are only considered renamed if their name has changed or
44
 
    their parent directory has changed.  Renaming a directory
45
 
    does not count as renaming all its contents.
46
 
 
47
 
    The lists are normally sorted when the delta is created.
48
 
    """
49
 
    def __init__(self):
50
 
        self.added = []
51
 
        self.removed = []
52
 
        self.renamed = []
53
 
        self.modified = []
54
 
        self.unchanged = []
55
 
 
56
 
    def __eq__(self, other):
57
 
        if not isinstance(other, TreeDelta):
58
 
            return False
59
 
        return self.added == other.added \
60
 
               and self.removed == other.removed \
61
 
               and self.renamed == other.renamed \
62
 
               and self.modified == other.modified \
63
 
               and self.unchanged == other.unchanged
64
 
 
65
 
    def __ne__(self, other):
66
 
        return not (self == other)
67
 
 
68
 
    def __repr__(self):
69
 
        return "TreeDelta(added=%r, removed=%r, renamed=%r, modified=%r," \
70
 
            " unchanged=%r)" % (self.added, self.removed, self.renamed,
71
 
            self.modified, self.unchanged)
72
 
 
73
 
    def has_changed(self):
74
 
        return bool(self.modified
75
 
                    or self.added
76
 
                    or self.removed
77
 
                    or self.renamed)
78
 
 
79
 
    def touches_file_id(self, file_id):
80
 
        """Return True if file_id is modified by this delta."""
81
 
        for l in self.added, self.removed, self.modified:
82
 
            for v in l:
83
 
                if v[1] == file_id:
84
 
                    return True
85
 
        for v in self.renamed:
86
 
            if v[2] == file_id:
87
 
                return True
88
 
        return False
89
 
            
90
 
 
91
 
    def show(self, to_file, show_ids=False, show_unchanged=False):
92
 
        def show_list(files):
93
 
            for item in files:
94
 
                path, fid, kind = item[:3]
95
 
 
96
 
                if kind == 'directory':
97
 
                    path += '/'
98
 
                elif kind == 'symlink':
99
 
                    path += '@'
100
 
 
101
 
                if len(item) == 5 and item[4]:
102
 
                    path += '*'
103
 
 
104
 
                if show_ids:
105
 
                    print >>to_file, '  %-30s %s' % (path, fid)
106
 
                else:
107
 
                    print >>to_file, ' ', path
108
 
            
109
 
        if self.removed:
110
 
            print >>to_file, 'removed:'
111
 
            show_list(self.removed)
112
 
                
113
 
        if self.added:
114
 
            print >>to_file, 'added:'
115
 
            show_list(self.added)
116
 
 
117
 
        extra_modified = []
118
 
 
119
 
        if self.renamed:
120
 
            print >>to_file, 'renamed:'
121
 
            for (oldpath, newpath, fid, kind,
122
 
                 text_modified, meta_modified) in self.renamed:
123
 
                if text_modified or meta_modified:
124
 
                    extra_modified.append((newpath, fid, kind,
125
 
                                           text_modified, meta_modified))
126
 
                if meta_modified:
127
 
                    newpath += '*'
128
 
                if show_ids:
129
 
                    print >>to_file, '  %s => %s %s' % (oldpath, newpath, fid)
130
 
                else:
131
 
                    print >>to_file, '  %s => %s' % (oldpath, newpath)
132
 
                    
133
 
        if self.modified or extra_modified:
134
 
            print >>to_file, 'modified:'
135
 
            show_list(self.modified)
136
 
            show_list(extra_modified)
137
 
            
138
 
        if show_unchanged and self.unchanged:
139
 
            print >>to_file, 'unchanged:'
140
 
            show_list(self.unchanged)
141
 
 
142
 
 
143
 
 
144
 
def compare_trees(old_tree, new_tree, want_unchanged=False, specific_files=None):
145
 
    """Describe changes from one tree to another.
146
 
 
147
 
    Returns a TreeDelta with details of added, modified, renamed, and
148
 
    deleted entries.
149
 
 
150
 
    The root entry is specifically exempt.
151
 
 
152
 
    This only considers versioned files.
153
 
 
154
 
    want_unchanged
155
 
        If true, also list files unchanged from one version to
156
 
        the next.
157
 
 
158
 
    specific_files
159
 
        If true, only check for changes to specified names or
160
 
        files within them.
161
 
    """
162
 
 
163
 
    old_tree.lock_read()
164
 
    try:
165
 
        new_tree.lock_read()
166
 
        try:
167
 
            return _compare_trees(old_tree, new_tree, want_unchanged,
168
 
                                  specific_files)
169
 
        finally:
170
 
            new_tree.unlock()
171
 
    finally:
172
 
        old_tree.unlock()
173
 
 
174
 
 
175
 
def _compare_trees(old_tree, new_tree, want_unchanged, specific_files):
176
 
 
177
 
    from osutils import is_inside_any
178
 
    
179
 
    old_inv = old_tree.inventory
180
 
    new_inv = new_tree.inventory
181
 
    delta = TreeDelta()
182
 
    mutter('start compare_trees')
183
 
 
184
 
    # TODO: match for specific files can be rather smarter by finding
185
 
    # the IDs of those files up front and then considering only that.
186
 
 
187
 
    for file_id in old_tree:
188
 
        if file_id in new_tree:
189
 
            old_ie = old_inv[file_id]
190
 
            new_ie = new_inv[file_id]
191
 
 
192
 
            kind = old_ie.kind
193
 
            assert kind == new_ie.kind
194
 
            
195
 
            assert kind in InventoryEntry.known_kinds, \
196
 
                   'invalid file kind %r' % kind
197
 
 
198
 
            if kind == 'root_directory':
199
 
                continue
200
 
            
201
 
            if specific_files:
202
 
                if (not is_inside_any(specific_files, old_inv.id2path(file_id)) 
203
 
                    and not is_inside_any(specific_files, new_inv.id2path(file_id))):
204
 
                    continue
205
 
 
206
 
            # temporary hack until all entries are populated before clients 
207
 
            # get them
208
 
            old_path = old_inv.id2path(file_id)
209
 
            new_path = new_inv.id2path(file_id)
210
 
            old_ie._read_tree_state(old_path, old_tree)
211
 
            new_ie._read_tree_state(new_path, new_tree)
212
 
            text_modified, meta_modified = new_ie.detect_changes(old_ie)
213
 
 
214
 
            # TODO: Can possibly avoid calculating path strings if the
215
 
            # two files are unchanged and their names and parents are
216
 
            # the same and the parents are unchanged all the way up.
217
 
            # May not be worthwhile.
218
 
            
219
 
            if (old_ie.name != new_ie.name
220
 
                or old_ie.parent_id != new_ie.parent_id):
221
 
                delta.renamed.append((old_path,
222
 
                                      new_path,
223
 
                                      file_id, kind,
224
 
                                      text_modified, meta_modified))
225
 
            elif text_modified or meta_modified:
226
 
                delta.modified.append((new_path, file_id, kind,
227
 
                                       text_modified, meta_modified))
228
 
            elif want_unchanged:
229
 
                delta.unchanged.append((new_path, file_id, kind))
230
 
        else:
231
 
            kind = old_inv.get_file_kind(file_id)
232
 
            if kind == 'root_directory':
233
 
                continue
234
 
            old_path = old_inv.id2path(file_id)
235
 
            if specific_files:
236
 
                if not is_inside_any(specific_files, old_path):
237
 
                    continue
238
 
            delta.removed.append((old_path, file_id, kind))
239
 
 
240
 
    mutter('start looking for new files')
241
 
    for file_id in new_inv:
242
 
        if file_id in old_inv or file_id not in new_tree:
243
 
            continue
244
 
        kind = new_inv.get_file_kind(file_id)
245
 
        if kind == 'root_directory':
246
 
            continue
247
 
        new_path = new_inv.id2path(file_id)
248
 
        if specific_files:
249
 
            if not is_inside_any(specific_files, new_path):
250
 
                continue
251
 
        delta.added.append((new_path, file_id, kind))
252
 
            
253
 
    delta.removed.sort()
254
 
    delta.added.sort()
255
 
    delta.renamed.sort()
256
 
    delta.modified.sort()
257
 
    delta.unchanged.sort()
258
 
 
259
 
    return delta