15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# TODO: Maybe also keep the full path of the entry, and the children?
19
# But those depend on its position within a particular inventory, and
20
# it would be nice not to need to hold the backpointer here.
22
# TODO: Perhaps split InventoryEntry into subclasses for files,
23
# directories, etc etc.
18
26
# This should really be an id randomly assigned when the tree is
19
27
# created, but it's not for now.
20
28
ROOT_ID = "TREE_ROOT"
23
import sys, os.path, types, re
26
37
from bzrlib.errors import BzrError, BzrCheckError
28
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
39
from bzrlib.osutils import quotefn, splitpath, joinpath, appendpath
29
40
from bzrlib.trace import mutter
30
41
from bzrlib.errors import NotVersionedError
33
44
class InventoryEntry(object):
34
45
"""Description of a versioned file.
36
47
An InventoryEntry has the following fields, which are also
37
48
present in the XML inventory-entry element:
40
* *name*: (only the basename within the directory, must not
42
* *kind*: "directory" or "file"
43
* *directory_id*: (if absent/null means the branch root directory)
44
* *text_sha1*: only for files
45
* *text_size*: in bytes, only for files
46
* *text_id*: identifier for the text version, only for files
48
InventoryEntries can also exist inside a WorkingTree
49
inventory, in which case they are not yet bound to a
50
particular revision of the file. In that case the text_sha1,
51
text_size and text_id are absent.
53
(within the parent directory)
59
file_id of the parent directory, or ROOT_ID
62
the revision_id in which the name or parent of this file was
66
sha-1 of the text of the file
69
size in bytes of the text of the file
72
the revision_id in which the text of this file was introduced
74
(reading a version 4 tree created a text_id field.)
54
76
>>> i = Inventory()
79
101
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
81
103
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
82
>>> for j in i.iter_entries():
84
... assert i.path2id(j[0])
104
>>> for path, entry in i.iter_entries():
105
... print path.replace('\\\\', '/') # for win32 os.sep
106
... assert i.path2id(path)
90
112
src/wibble/wibble.c
113
>>> i.id2path('2326').replace('\\\\', '/')
92
114
'src/wibble/wibble.c'
94
TODO: Maybe also keep the full path of the entry, and the children?
95
But those depend on its position within a particular inventory, and
96
it would be nice not to need to hold the backpointer here.
99
# TODO: split InventoryEntry into subclasses for files,
100
# directories, etc etc.
102
117
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
103
118
'text_id', 'parent_id', 'children',
104
'text_version', 'entry_version', ]
119
'text_version', 'name_version', ]
107
122
def __init__(self, file_id, name, kind, parent_id, text_id=None):
151
166
other = InventoryEntry(self.file_id, self.name, self.kind,
152
self.parent_id, text_id=self.text_id)
168
other.text_id = self.text_id
153
169
other.text_sha1 = self.text_sha1
154
170
other.text_size = self.text_size
171
other.text_version = self.text_version
172
other.name_version = self.name_version
155
173
# note that children are *not* copied; they're pulled across when
156
174
# others are added
178
196
and (self.parent_id == other.parent_id) \
179
197
and (self.kind == other.kind) \
180
198
and (self.text_version == other.text_version) \
181
and (self.entry_version == other.entry_version)
199
and (self.name_version == other.name_version)
184
202
def __ne__(self, other):
262
280
self._byid = {self.root.file_id: self.root}
284
other = Inventory(self.root.file_id)
285
# copy recursively so we know directories will be added before
286
# their children. There are more efficient ways than this...
287
for path, entry in self.iter_entries():
288
if entry == self.root:
290
other.add(entry.copy())
265
294
def __iter__(self):
266
295
return iter(self._byid)