~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revisiontree.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-21 22:29:49 UTC
  • Revision ID: mbp@sourcefrog.net-20050321222949-232c2093a6eadd80
fixup doctest for new module structure

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005 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
 
"""RevisionTree - a Tree implementation backed by repository data for a revision."""
18
 
 
19
 
from cStringIO import StringIO
20
 
 
21
 
from bzrlib.tree import Tree
22
 
 
23
 
 
24
 
class RevisionTree(Tree):
25
 
    """Tree viewing a previous revision.
26
 
 
27
 
    File text can be retrieved from the text store.
28
 
 
29
 
    TODO: Some kind of `__repr__` method, but a good one
30
 
           probably means knowing the branch and revision number,
31
 
           or at least passing a description to the constructor.
32
 
    """
33
 
    
34
 
    def __init__(self, branch, inv, revision_id):
35
 
        # for compatability the 'branch' parameter has not been renamed to 
36
 
        # repository at this point. However, we should change RevisionTree's
37
 
        # construction to always be via Repository and not via direct 
38
 
        # construction - this will mean that we can change the constructor
39
 
        # with much less chance of breaking client code.
40
 
        self._repository = branch
41
 
        self._weave_store = branch.weave_store
42
 
        self._inventory = inv
43
 
        assert inv.root is not None
44
 
        self._revision_id = revision_id
45
 
 
46
 
    def get_parent_ids(self):
47
 
        """See Tree.get_parent_ids.
48
 
 
49
 
        A RevisionTree's parents match the revision graph.
50
 
        """
51
 
        if self._revision_id not in (None, 'null:'):
52
 
            parent_ids = self._repository.get_revision(
53
 
                self._revision_id).parent_ids
54
 
        else:
55
 
            parent_ids = []
56
 
        return parent_ids
57
 
        
58
 
    def get_revision_id(self):
59
 
        """Return the revision id associated with this tree."""
60
 
        return self._revision_id
61
 
 
62
 
    def get_weave(self, file_id):
63
 
        return self._weave_store.get_weave(file_id,
64
 
                self._repository.get_transaction())
65
 
 
66
 
    def get_file_lines(self, file_id):
67
 
        ie = self._inventory[file_id]
68
 
        weave = self.get_weave(file_id)
69
 
        return weave.get_lines(ie.revision)
70
 
 
71
 
    def get_file_text(self, file_id):
72
 
        return ''.join(self.get_file_lines(file_id))
73
 
 
74
 
    def get_file(self, file_id):
75
 
        return StringIO(self.get_file_text(file_id))
76
 
 
77
 
    def get_file_size(self, file_id):
78
 
        return self._inventory[file_id].text_size
79
 
 
80
 
    def get_file_sha1(self, file_id, path=None):
81
 
        ie = self._inventory[file_id]
82
 
        if ie.kind == "file":
83
 
            return ie.text_sha1
84
 
        return None
85
 
 
86
 
    def get_file_mtime(self, file_id, path=None):
87
 
        ie = self._inventory[file_id]
88
 
        revision = self._repository.get_revision(ie.revision)
89
 
        return revision.timestamp
90
 
 
91
 
    def is_executable(self, file_id, path=None):
92
 
        ie = self._inventory[file_id]
93
 
        if ie.kind != "file":
94
 
            return None 
95
 
        return self._inventory[file_id].executable
96
 
 
97
 
    def has_filename(self, filename):
98
 
        return bool(self.inventory.path2id(filename))
99
 
 
100
 
    def list_files(self):
101
 
        # The only files returned by this are those from the version
102
 
        entries = self.inventory.iter_entries()
103
 
        # skip the root for compatability with the current apis.
104
 
        entries.next()
105
 
        for path, entry in entries:
106
 
            yield path, 'V', entry.kind, entry.file_id, entry
107
 
 
108
 
    def get_symlink_target(self, file_id):
109
 
        ie = self._inventory[file_id]
110
 
        return ie.symlink_target;
111
 
 
112
 
    def kind(self, file_id):
113
 
        return self._inventory[file_id].kind
114
 
 
115
 
    def lock_read(self):
116
 
        self._repository.lock_read()
117
 
 
118
 
    def unlock(self):
119
 
        self._repository.unlock()
120
 
 
121