/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/memorytree.py

  • Committer: John Arbash Meinel
  • Date: 2008-09-05 02:29:34 UTC
  • mto: (3697.7.4 1.7)
  • mto: This revision was merged to the branch mainline in revision 3748.
  • Revision ID: john@arbash-meinel.com-20080905022934-s8692mbwpkdwi106
Cleanups to the algorithm documentation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/memorytree.py
 
1
# Copyright (C) 2006 Canonical Ltd
 
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
"""MemoryTree object.
 
18
 
 
19
See MemoryTree for more details.
 
20
"""
 
21
 
 
22
 
 
23
from copy import deepcopy
 
24
import os
 
25
 
 
26
from bzrlib import (
 
27
    errors,
 
28
    mutabletree,
 
29
    osutils,
 
30
    revision as _mod_revision,
 
31
    )
 
32
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
33
from bzrlib.osutils import sha_file
 
34
from bzrlib.mutabletree import needs_tree_write_lock
 
35
from bzrlib.transport.memory import MemoryTransport
 
36
 
 
37
 
 
38
class MemoryTree(mutabletree.MutableTree):
 
39
    """A MemoryTree is a specialisation of MutableTree.
 
40
    
 
41
    It maintains nearly no state outside of read_lock and write_lock
 
42
    transactions. (it keeps a reference to the branch, and its last-revision
 
43
    only).
 
44
    """
 
45
 
 
46
    def __init__(self, branch, revision_id):
 
47
        """Construct a MemoryTree for branch using revision_id."""
 
48
        self.branch = branch
 
49
        self.bzrdir = branch.bzrdir
 
50
        self._branch_revision_id = revision_id
 
51
        self._locks = 0
 
52
        self._lock_mode = None
 
53
 
 
54
    @needs_tree_write_lock
 
55
    def _add(self, files, ids, kinds):
 
56
        """See MutableTree._add."""
 
57
        for f, file_id, kind in zip(files, ids, kinds):
 
58
            if kind is None:
 
59
                kind = 'file'
 
60
            if file_id is None:
 
61
                self._inventory.add_path(f, kind=kind)
 
62
            else:
 
63
                self._inventory.add_path(f, kind=kind, file_id=file_id)
 
64
 
 
65
    def basis_tree(self):
 
66
        """See Tree.basis_tree()."""
 
67
        return self._basis_tree
 
68
 
 
69
    @staticmethod
 
70
    def create_on_branch(branch):
 
71
        """Create a MemoryTree for branch, using the last-revision of branch."""
 
72
        revision_id = _mod_revision.ensure_null(branch.last_revision())
 
73
        if _mod_revision.is_null(revision_id):
 
74
            revision_id = None
 
75
        return MemoryTree(branch, revision_id)
 
76
 
 
77
    def _gather_kinds(self, files, kinds):
 
78
        """See MutableTree._gather_kinds.
 
79
        
 
80
        This implementation does not care about the file kind of
 
81
        missing files, so is a no-op.
 
82
        """
 
83
 
 
84
    def get_file(self, file_id, path=None):
 
85
        """See Tree.get_file."""
 
86
        if path is None:
 
87
            path = self.id2path(file_id)
 
88
        return self._file_transport.get(path)
 
89
 
 
90
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
91
        """See Tree.get_file_sha1()."""
 
92
        if path is None:
 
93
            path = self.id2path(file_id)
 
94
        stream = self._file_transport.get(path)
 
95
        return sha_file(stream)
 
96
 
 
97
    def get_root_id(self):
 
98
        return self.path2id('')
 
99
 
 
100
    def _comparison_data(self, entry, path):
 
101
        """See Tree._comparison_data."""
 
102
        if entry is None:
 
103
            return None, False, None
 
104
        return entry.kind, entry.executable, None
 
105
 
 
106
    @needs_tree_write_lock
 
107
    def rename_one(self, from_rel, to_rel):
 
108
        file_id = self.path2id(from_rel)
 
109
        to_dir, to_tail = os.path.split(to_rel)
 
110
        to_parent_id = self._inventory[file_id].parent_id
 
111
        self._file_transport.move(from_rel, to_rel)
 
112
        self._inventory.rename(file_id, to_parent_id, to_tail)
 
113
 
 
114
    def path_content_summary(self, path):
 
115
        """See Tree.path_content_summary."""
 
116
        id = self.path2id(path)
 
117
        if id is None:
 
118
            return 'missing', None, None, None
 
119
        kind = self.kind(id)
 
120
        if kind == 'file':
 
121
            bytes = self._file_transport.get_bytes(path)
 
122
            size = len(bytes)
 
123
            executable = self._inventory[id].executable
 
124
            sha1 = None # no stat cache
 
125
            return (kind, size, executable, sha1)
 
126
        elif kind == 'directory':
 
127
            # memory tree does not support nested trees yet.
 
128
            return kind, None, None, None
 
129
        elif kind == 'symlink':
 
130
            raise NotImplementedError('symlink support')
 
131
        else:
 
132
            raise NotImplementedError('unknown kind')
 
133
 
 
134
    def _file_size(self, entry, stat_value):
 
135
        """See Tree._file_size."""
 
136
        if entry is None:
 
137
            return 0
 
138
        return entry.text_size
 
139
 
 
140
    @needs_read_lock
 
141
    def get_parent_ids(self):
 
142
        """See Tree.get_parent_ids.
 
143
 
 
144
        This implementation returns the current cached value from
 
145
            self._parent_ids.
 
146
        """
 
147
        return list(self._parent_ids)
 
148
 
 
149
    def has_filename(self, filename):
 
150
        """See Tree.has_filename()."""
 
151
        return self._file_transport.has(filename)
 
152
 
 
153
    def is_executable(self, file_id, path=None):
 
154
        return self._inventory[file_id].executable
 
155
 
 
156
    def kind(self, file_id):
 
157
        return self._inventory[file_id].kind
 
158
 
 
159
    def mkdir(self, path, file_id=None):
 
160
        """See MutableTree.mkdir()."""
 
161
        self.add(path, file_id, 'directory')
 
162
        if file_id is None:
 
163
            file_id = self.path2id(path)
 
164
        self._file_transport.mkdir(path)
 
165
        return file_id
 
166
 
 
167
    @needs_read_lock
 
168
    def last_revision(self):
 
169
        """See MutableTree.last_revision."""
 
170
        return self._branch_revision_id
 
171
 
 
172
    def lock_read(self):
 
173
        """Lock the memory tree for reading.
 
174
 
 
175
        This triggers population of data from the branch for its revision.
 
176
        """
 
177
        self._locks += 1
 
178
        try:
 
179
            if self._locks == 1:
 
180
                self.branch.lock_read()
 
181
                self._lock_mode = "r"
 
182
                self._populate_from_branch()
 
183
        except:
 
184
            self._locks -= 1
 
185
            raise
 
186
 
 
187
    def lock_tree_write(self):
 
188
        """See MutableTree.lock_tree_write()."""
 
189
        self._locks += 1
 
190
        try:
 
191
            if self._locks == 1:
 
192
                self.branch.lock_read()
 
193
                self._lock_mode = "w"
 
194
                self._populate_from_branch()
 
195
            elif self._lock_mode == "r":
 
196
                raise errors.ReadOnlyError(self)
 
197
        except:
 
198
            self._locks -= 1
 
199
            raise
 
200
 
 
201
    def lock_write(self):
 
202
        """See MutableTree.lock_write()."""
 
203
        self._locks += 1
 
204
        try:
 
205
            if self._locks == 1:
 
206
                self.branch.lock_write()
 
207
                self._lock_mode = "w"
 
208
                self._populate_from_branch()
 
209
            elif self._lock_mode == "r":
 
210
                raise errors.ReadOnlyError(self)
 
211
        except:
 
212
            self._locks -= 1
 
213
            raise
 
214
 
 
215
    def _populate_from_branch(self):
 
216
        """Populate the in-tree state from the branch."""
 
217
        self._basis_tree = self.branch.repository.revision_tree(
 
218
            self._branch_revision_id)
 
219
        if self._branch_revision_id is None:
 
220
            self._parent_ids = []
 
221
        else:
 
222
            self._parent_ids = [self._branch_revision_id]
 
223
        self._inventory = deepcopy(self._basis_tree._inventory)
 
224
        self._file_transport = MemoryTransport()
 
225
        # TODO copy the revision trees content, or do it lazy, or something.
 
226
        inventory_entries = self._inventory.iter_entries()
 
227
        for path, entry in inventory_entries:
 
228
            if path == '':
 
229
                continue
 
230
            if entry.kind == 'directory':
 
231
                self._file_transport.mkdir(path)
 
232
            elif entry.kind == 'file':
 
233
                self._file_transport.put_file(path,
 
234
                    self._basis_tree.get_file(entry.file_id))
 
235
            else:
 
236
                raise NotImplementedError(self._populate_from_branch)
 
237
 
 
238
    def put_file_bytes_non_atomic(self, file_id, bytes):
 
239
        """See MutableTree.put_file_bytes_non_atomic."""
 
240
        self._file_transport.put_bytes(self.id2path(file_id), bytes)
 
241
 
 
242
    def unlock(self):
 
243
        """Release a lock.
 
244
 
 
245
        This frees all cached state when the last lock context for the tree is
 
246
        left.
 
247
        """
 
248
        if self._locks == 1:
 
249
            self._basis_tree = None
 
250
            self._parent_ids = []
 
251
            self._inventory = None
 
252
            try:
 
253
                self.branch.unlock()
 
254
            finally:
 
255
                self._locks = 0
 
256
                self._lock_mode = None
 
257
        else:
 
258
            self._locks -= 1
 
259
 
 
260
    @needs_tree_write_lock
 
261
    def unversion(self, file_ids):
 
262
        """Remove the file ids in file_ids from the current versioned set.
 
263
 
 
264
        When a file_id is unversioned, all of its children are automatically
 
265
        unversioned.
 
266
 
 
267
        :param file_ids: The file ids to stop versioning.
 
268
        :raises: NoSuchId if any fileid is not currently versioned.
 
269
        """
 
270
        # XXX: This should be in mutabletree, but the inventory-save action
 
271
        # is not relevant to memory tree. Until that is done in unlock by
 
272
        # working tree, we cannot share the implementation.
 
273
        for file_id in file_ids:
 
274
            if self._inventory.has_id(file_id):
 
275
                self._inventory.remove_recursive_id(file_id)
 
276
            else:
 
277
                raise errors.NoSuchId(self, file_id)
 
278
 
 
279
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
 
280
        """See MutableTree.set_parent_trees()."""
 
281
        for revision_id in revision_ids:
 
282
            _mod_revision.check_not_reserved_id(revision_id)
 
283
        if len(revision_ids) == 0:
 
284
            self._parent_ids = []
 
285
            self._basis_tree = self.branch.repository.revision_tree(None)
 
286
        else:
 
287
            self._parent_ids = revision_ids
 
288
            self._basis_tree = self.branch.repository.revision_tree(
 
289
                                    revision_ids[0])
 
290
            self._branch_revision_id = revision_ids[0]
 
291
 
 
292
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
 
293
        """See MutableTree.set_parent_trees()."""
 
294
        if len(parents_list) == 0:
 
295
            self._parent_ids = []
 
296
            self._basis_tree = self.branch.repository.revision_tree(None)
 
297
        else:
 
298
            if parents_list[0][1] is None and not allow_leftmost_as_ghost:
 
299
                # a ghost in the left most parent
 
300
                raise errors.GhostRevisionUnusableHere(parents_list[0][0])
 
301
            self._parent_ids = [parent_id for parent_id, tree in parents_list]
 
302
            if parents_list[0][1] is None or parents_list[0][1] == 'null:':
 
303
                self._basis_tree = self.branch.repository.revision_tree(None)
 
304
            else:
 
305
                self._basis_tree = parents_list[0][1]
 
306
            self._branch_revision_id = parents_list[0][0]