~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revisiontree.py

  • Committer: Martin Pool
  • Date: 2007-04-04 01:22:11 UTC
  • mfrom: (2393.1.1 bzr.docs)
  • mto: This revision was merged to the branch mainline in revision 2397.
  • Revision ID: mbp@sourcefrog.net-20070404012211-sq269me6bai9m6xk
merge trunk and doc fix from elliot

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2007 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 import (
 
22
    osutils,
 
23
    revision,
 
24
    )
 
25
from bzrlib.tree import Tree
 
26
 
 
27
 
 
28
class RevisionTree(Tree):
 
29
    """Tree viewing a previous revision.
 
30
 
 
31
    File text can be retrieved from the text store.
 
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
        self._revision_id = osutils.safe_revision_id(revision_id)
 
44
 
 
45
    def supports_tree_reference(self):
 
46
        return True
 
47
 
 
48
    def get_parent_ids(self):
 
49
        """See Tree.get_parent_ids.
 
50
 
 
51
        A RevisionTree's parents match the revision graph.
 
52
        """
 
53
        if self._revision_id in (None, revision.NULL_REVISION):
 
54
            parent_ids = []
 
55
        else:
 
56
            parent_ids = self._repository.get_revision(
 
57
                self._revision_id).parent_ids
 
58
        return parent_ids
 
59
        
 
60
    def get_revision_id(self):
 
61
        """Return the revision id associated with this tree."""
 
62
        return self._revision_id
 
63
 
 
64
    def get_weave(self, file_id):
 
65
        file_id = osutils.safe_file_id(file_id)
 
66
        return self._weave_store.get_weave(file_id,
 
67
                self._repository.get_transaction())
 
68
 
 
69
    def get_file_lines(self, file_id):
 
70
        file_id = osutils.safe_file_id(file_id)
 
71
        ie = self._inventory[file_id]
 
72
        weave = self.get_weave(file_id)
 
73
        return weave.get_lines(ie.revision)
 
74
 
 
75
    def get_file_text(self, file_id):
 
76
        file_id = osutils.safe_file_id(file_id)
 
77
        return ''.join(self.get_file_lines(file_id))
 
78
 
 
79
    def get_file(self, file_id):
 
80
        file_id = osutils.safe_file_id(file_id)
 
81
        return StringIO(self.get_file_text(file_id))
 
82
 
 
83
    def annotate_iter(self, file_id):
 
84
        """See Tree.annotate_iter"""
 
85
        file_id = osutils.safe_file_id(file_id)
 
86
        w = self.get_weave(file_id)
 
87
        return w.annotate_iter(self.inventory[file_id].revision)
 
88
 
 
89
    def get_file_size(self, file_id):
 
90
        file_id = osutils.safe_file_id(file_id)
 
91
        return self._inventory[file_id].text_size
 
92
 
 
93
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
94
        file_id = osutils.safe_file_id(file_id)
 
95
        ie = self._inventory[file_id]
 
96
        if ie.kind == "file":
 
97
            return ie.text_sha1
 
98
        return None
 
99
 
 
100
    def get_file_mtime(self, file_id, path=None):
 
101
        file_id = osutils.safe_file_id(file_id)
 
102
        ie = self._inventory[file_id]
 
103
        revision = self._repository.get_revision(ie.revision)
 
104
        return revision.timestamp
 
105
 
 
106
    def is_executable(self, file_id, path=None):
 
107
        file_id = osutils.safe_file_id(file_id)
 
108
        ie = self._inventory[file_id]
 
109
        if ie.kind != "file":
 
110
            return None
 
111
        return ie.executable
 
112
 
 
113
    def has_filename(self, filename):
 
114
        return bool(self.inventory.path2id(filename))
 
115
 
 
116
    def list_files(self, include_root=False):
 
117
        # The only files returned by this are those from the version
 
118
        entries = self.inventory.iter_entries()
 
119
        # skip the root for compatability with the current apis.
 
120
        if self.inventory.root is not None and not include_root:
 
121
            # skip the root for compatability with the current apis.
 
122
            entries.next()
 
123
        for path, entry in entries:
 
124
            yield path, 'V', entry.kind, entry.file_id, entry
 
125
 
 
126
    def get_symlink_target(self, file_id):
 
127
        file_id = osutils.safe_file_id(file_id)
 
128
        ie = self._inventory[file_id]
 
129
        return ie.symlink_target;
 
130
 
 
131
    def get_reference_revision(self, file_id, path=None):
 
132
        return self.inventory[file_id].reference_revision
 
133
 
 
134
    def get_root_id(self):
 
135
        if self.inventory.root:
 
136
            return self.inventory.root.file_id
 
137
 
 
138
    def kind(self, file_id):
 
139
        file_id = osutils.safe_file_id(file_id)
 
140
        return self._inventory[file_id].kind
 
141
 
 
142
    def _comparison_data(self, entry, path):
 
143
        if entry is None:
 
144
            return None, False, None
 
145
        return entry.kind, entry.executable, None
 
146
 
 
147
    def _file_size(self, entry, stat_value):
 
148
        assert entry.text_size is not None
 
149
        return entry.text_size
 
150
 
 
151
    def lock_read(self):
 
152
        self._repository.lock_read()
 
153
 
 
154
    def __repr__(self):
 
155
        return '<%s instance at %x, rev_id=%r>' % (
 
156
            self.__class__.__name__, id(self), self._revision_id)
 
157
 
 
158
    def unlock(self):
 
159
        self._repository.unlock()
 
160
 
 
161
    def walkdirs(self, prefix=""):
 
162
        _directory = 'directory'
 
163
        inv = self.inventory
 
164
        top_id = inv.path2id(prefix)
 
165
        if top_id is None:
 
166
            pending = []
 
167
        else:
 
168
            pending = [(prefix, '', _directory, None, top_id, None)]
 
169
        while pending:
 
170
            dirblock = []
 
171
            currentdir = pending.pop()
 
172
            # 0 - relpath, 1- basename, 2- kind, 3- stat, id, v-kind
 
173
            if currentdir[0]:
 
174
                relroot = currentdir[0] + '/'
 
175
            else:
 
176
                relroot = ""
 
177
            # FIXME: stash the node in pending
 
178
            entry = inv[currentdir[4]]
 
179
            for name, child in entry.sorted_children():
 
180
                toppath = relroot + name
 
181
                dirblock.append((toppath, name, child.kind, None,
 
182
                    child.file_id, child.kind
 
183
                    ))
 
184
            yield (currentdir[0], entry.file_id), dirblock
 
185
            # push the user specified dirs from dirblock
 
186
            for dir in reversed(dirblock):
 
187
                if dir[2] == _directory:
 
188
                    pending.append(dir)