← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revisiontree.py

  • Committer: John Arbash Meinel
  • Date: 2007-02-17 22:25:37 UTC
  • mto: This revision was merged to the branch mainline in revision 2298.
  • Revision ID: john@arbash-meinel.com-20070217222537-p0hxseinc3x84e96
Minor performance improvement, use None as signal rather than ROOT_ID
for xml5 inventories. Discover small bug in serialized text because of this.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/revisiontree.py
 
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 import (
 
22
    osutils,
 
23
    )
 
24
from bzrlib.tree import Tree
 
25
 
 
26
 
 
27
class RevisionTree(Tree):
 
28
    """Tree viewing a previous revision.
 
29
 
 
30
    File text can be retrieved from the text store.
 
31
 
 
32
    TODO: Some kind of `__repr__` method, but a good one
 
33
           probably means knowing the branch and revision number,
 
34
           or at least passing a description to the constructor.
 
35
    """
 
36
    
 
37
    def __init__(self, branch, inv, revision_id):
 
38
        # for compatability the 'branch' parameter has not been renamed to 
 
39
        # repository at this point. However, we should change RevisionTree's
 
40
        # construction to always be via Repository and not via direct 
 
41
        # construction - this will mean that we can change the constructor
 
42
        # with much less chance of breaking client code.
 
43
        self._repository = branch
 
44
        self._weave_store = branch.weave_store
 
45
        self._inventory = inv
 
46
        self._revision_id = osutils.safe_revision_id(revision_id)
 
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 not in (None, 'null:'):
 
54
            parent_ids = self._repository.get_revision(
 
55
                self._revision_id).parent_ids
 
56
        else:
 
57
            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
        return self._weave_store.get_weave(file_id,
 
66
                self._repository.get_transaction())
 
67
 
 
68
    def get_file_lines(self, file_id):
 
69
        ie = self._inventory[file_id]
 
70
        weave = self.get_weave(file_id)
 
71
        return weave.get_lines(ie.revision)
 
72
 
 
73
    def get_file_text(self, file_id):
 
74
        return ''.join(self.get_file_lines(file_id))
 
75
 
 
76
    def get_file(self, file_id):
 
77
        return StringIO(self.get_file_text(file_id))
 
78
 
 
79
    def annotate_iter(self, file_id):
 
80
        """See Tree.annotate_iter"""
 
81
        w = self.get_weave(file_id)
 
82
        return w.annotate_iter(self.inventory[file_id].revision)
 
83
 
 
84
    def get_file_size(self, file_id):
 
85
        return self._inventory[file_id].text_size
 
86
 
 
87
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
88
        ie = self._inventory[file_id]
 
89
        if ie.kind == "file":
 
90
            return ie.text_sha1
 
91
        return None
 
92
 
 
93
    def get_file_mtime(self, file_id, path=None):
 
94
        ie = self._inventory[file_id]
 
95
        revision = self._repository.get_revision(ie.revision)
 
96
        return revision.timestamp
 
97
 
 
98
    def is_executable(self, file_id, path=None):
 
99
        ie = self._inventory[file_id]
 
100
        if ie.kind != "file":
 
101
            return None 
 
102
        return self._inventory[file_id].executable
 
103
 
 
104
    def has_filename(self, filename):
 
105
        return bool(self.inventory.path2id(filename))
 
106
 
 
107
    def list_files(self, include_root=False):
 
108
        # The only files returned by this are those from the version
 
109
        entries = self.inventory.iter_entries()
 
110
        # skip the root for compatability with the current apis.
 
111
        if self.inventory.root is not None and not include_root:
 
112
            # skip the root for compatability with the current apis.
 
113
            entries.next()
 
114
        for path, entry in entries:
 
115
            yield path, 'V', entry.kind, entry.file_id, entry
 
116
 
 
117
    def get_symlink_target(self, file_id):
 
118
        ie = self._inventory[file_id]
 
119
        return ie.symlink_target;
 
120
 
 
121
    def kind(self, file_id):
 
122
        return self._inventory[file_id].kind
 
123
 
 
124
    def _comparison_data(self, entry, path):
 
125
        if entry is None:
 
126
            return None, False, None
 
127
        return entry.kind, entry.executable, None
 
128
 
 
129
    def _file_size(self, entry, stat_value):
 
130
        assert entry.text_size is not None
 
131
        return entry.text_size
 
132
 
 
133
    def lock_read(self):
 
134
        self._repository.lock_read()
 
135
 
 
136
    def unlock(self):
 
137
        self._repository.unlock()
 
138
 
 
139