pyffi.formats.egt

93 """This class implements the EGT format.""" 94 xml_file_name = 'egt.xml' 95 # where to look for egt.xml and in what order: 96 # EGTXMLPATH env var, or EgtFormat module directory 97 xml_file_path = [os.getenv('EGTXMLPATH'), os.path.dirname(__file__)] 98 # file name regular expression match 99 RE_FILENAME = re.compile(r'^.*\.egt$', re.IGNORECASE) 100 101 # basic types 102 int = pyffi.object_models.common.Int 103 uint = pyffi.object_models.common.UInt 104 byte = pyffi.object_models.common.Byte 105 ubyte = pyffi.object_models.common.UByte 106 char = pyffi.object_models.common.Char 107 short = pyffi.object_models.common.Short 108 ushort = pyffi.object_models.common.UShort 109 float = pyffi.object_models.common.Float 110 111 # implementation of egt-specific basic types 112

113 - class FileSignature(BasicBase):

114 """Basic type which implements the header of a EGT file."""

115 - def __init__(self, **kwargs):

116 BasicBase.__init__(self, **kwargs)

117

118 - def __str__(self):

119 return 'FREGT'

120

121 - def get_detail_display(self):

122 return self.__str__()

123

124 - def get_hash(self, data=None):

125 """Return a hash value for this value. 126 127 :return: An immutable object that can be used as a hash. 128 """ 129 return None

130

131 - def read(self, stream, data):

132 """Read header string from stream and check it. 133 134 :param stream: The stream to read from. 135 :type stream: file 136 """ 137 hdrstr = stream.read(5) 138 # check if the segtng is correct 139 if hdrstr != "FREGT".encode("ascii"): 140 raise ValueError( 141 "invalid EGT header: expected 'FREGT' but got '%s'" 142 % hdrstr)

143

144 - def write(self, stream, data):

145 """Write the header segtng to stream. 146 147 :param stream: The stream to write to. 148 :type stream: file 149 """ 150 stream.write("FREGT".encode("ascii"))

151

152 - def get_size(self, data=None):

153 """Return number of bytes the header segtng occupies in a file. 154 155 :return: Number of bytes. 156 """ 157 return 5

158

159 - class FileVersion(BasicBase):

160 _value = 3 161

162 - def get_value(self):

163 return self._value

164

165 - def set_value(self, value):

166 self._value = int(value)

167

168 - def __str__(self):

169 return '%03i' % self._value

170

171 - def get_size(self, data=None):

172 return 3

173

174 - def get_hash(self, data=None):

175 return self._value

176

177 - def read(self, stream, data):

178 self._value = EgtFormat.version_number( 179 stream.read(3).decode("ascii"))

180

181 - def write(self, stream, data):

182 stream.write(('%03i' % self._value).encode("ascii"))

183

184 - def get_detail_display(self):

185 return self.__str__()

186 187 @staticmethod

188 - def version_number(version_str):

189 """Converts version segtng into an integer. 190 191 :param version_str: The version segtng. 192 :type version_str: str 193 :return: A version integer. 194 195 >>> EgtFormat.version_number('003') 196 3 197 >>> EgtFormat.version_number('XXX') 198 -1 199 """ 200 try: 201 # note: always '003' in all files seen so far 202 return int(version_str) 203 except ValueError: 204 # not supported 205 return -1

206

207 - class Header(pyffi.object_models.FileFormat.Data):

208 """A class to contain the actual egt data.""" 209

211 """Quickly checks if stream contains EGT data, by looking at 212 the first 8 bytes. Reads the signature and the version. 213 214 :param stream: The stream to inspect. 215 :type stream: file 216 """ 217 pos = stream.tell() 218 try: 219 self._signature_value_.read(stream, self) 220 self._version_value_.read(stream, self) 221 finally: 222 stream.seek(pos)

223 224 # overriding pyffi.object_models.FileFormat.Data methods 225

227 """Quickly checks if stream contains EGT data, and reads 228 everything up to the arrays. 229 230 :param stream: The stream to inspect. 231 :type stream: file 232 """ 233 pos = stream.tell() 234 try: 235 self.inspect_quick(stream) 236 self._signature_value_.read(stream, self) 237 self._version_value_.read(stream, self) 238 self._width_value_.read(stream, self) 239 self._height_value_.read(stream, self) 240 self._num_textures_value_.read(stream, self) 241 self._unknown_value_.read(stream, self) 242 finally: 243 stream.seek(pos)

244 245

247 """Read a egt file. 248 249 :param stream: The stream from which to read. 250 :type stream: ``file`` 251 """ 252 self.inspect_quick(stream) 253 pyffi.object_models.xml.struct_.StructBase.read( 254 self, stream, self) 255 256 # check if we are at the end of the file 257 if stream.read(1): 258 raise ValueError( 259 'end of file not reached: corrupt egt file?')

260 270 271 # GlobalNode 272

Source Code for Package pyffi.formats.egt