pyffi.formats.kfm

129 """This class implements the kfm file format.""" 130 xml_file_name = 'kfm.xml' 131 # where to look for kfm.xml and in what order: 132 # KFMXMLPATH env var, or KfmFormat module directory 133 xml_file_path = [os.getenv('KFMXMLPATH'), 134 os.path.join(os.path.dirname(__file__), "kfmxml")] 135 # file name regular expression match 136 RE_FILENAME = re.compile(r'^.*\.kfm$', re.IGNORECASE) 137 # used for comparing floats 138 _EPSILON = 0.0001 139 140 # basic types 141 int = pyffi.object_models.common.Int 142 uint = pyffi.object_models.common.UInt 143 byte = pyffi.object_models.common.UByte # not a typo 144 char = pyffi.object_models.common.Char 145 short = pyffi.object_models.common.Short 146 ushort = pyffi.object_models.common.UShort 147 float = pyffi.object_models.common.Float 148 SizedString = pyffi.object_models.common.SizedString 149 TextString = pyffi.object_models.common.UndecodedData # for text (used by older kfm versions) 150 151 # implementation of kfm-specific basic types 152

153 - class HeaderString(BasicBase):

154 """The kfm header string."""

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

156 BasicBase.__init__(self, **kwargs) 157 self._doseol = False

158

159 - def __str__(self):

160 return ';Gamebryo KFM File Version x.x.x.x'

161

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

163 """Return a hash value for this value. 164 165 :return: An immutable object that can be used as a hash. 166 """ 167 return None

168

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

170 """Read header string from stream and check it. 171 172 :param stream: The stream to read from. 173 :type stream: file 174 :keyword version: The file version. 175 :type version: int 176 """ 177 # get the string we expect 178 version_string = self.version_string(data.version) 179 # read string from stream 180 hdrstr = stream.read(len(version_string)) 181 # check if the string is correct 182 if hdrstr != version_string.encode("ascii"): 183 raise ValueError( 184 "invalid KFM header: expected '%s' but got '%s'" 185 % (version_string, hdrstr)) 186 # check eol style 187 nextchar = stream.read(1) 188 if nextchar == '\x0d'.encode("ascii"): 189 nextchar = stream.read(1) 190 self._doseol = True 191 else: 192 self._doseol = False 193 if nextchar != '\x0a'.encode("ascii"): 194 raise ValueError( 195 "invalid KFM header: string does not end on \\n or \\r\\n")

196

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

198 """Write the header string to stream. 199 200 :param stream: The stream to write to. 201 :type stream: file 202 """ 203 # write the version string 204 stream.write(self.version_string(data.version).encode("ascii")) 205 # write \n (or \r\n for older versions) 206 if self._doseol: 207 stream.write('\x0d\x0a'.encode("ascii")) 208 else: 209 stream.write('\x0a'.encode("ascii"))

210

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

212 """Return number of bytes the header string occupies in a file. 213 214 :return: Number of bytes. 215 """ 216 return len(self.version_string(data.version)) \ 217 + (1 if not self._doseol else 2)

218 219 # DetailNode 220

221 - def get_detail_display(self):

222 return str(self)

223 224 @staticmethod

225 - def version_string(version):

226 """Transforms version number into a version string. 227 228 :param version: The version number. 229 :type version: int 230 :return: A version string. 231 232 >>> KfmFormat.HeaderString.version_string(0x0202000b) 233 ';Gamebryo KFM File Version 2.2.0.0b' 234 >>> KfmFormat.HeaderString.version_string(0x01024b00) 235 ';Gamebryo KFM File Version 1.2.4b' 236 """ 237 if version == -1 or version is None: 238 raise RuntimeError('no string for version %s'%version) 239 return ";Gamebryo KFM File Version %s"%({ 240 0x01000000 : "1.0", 241 0x01024b00 : "1.2.4b", 242 0x0200000b : "2.0.0.0b", 243 0x0201000b : "2.1.0.0b", 244 0x0202000b : "2.2.0.0b" } [version])

245 246 # other types with internal implementation

247 - class FilePath(SizedString):

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

249 """Return a hash value for this value. 250 For file paths, the hash value is case insensitive. 251 252 :return: An immutable object that can be used as a hash. 253 """ 254 return self.get_value().lower()

255 256 @staticmethod

257 - def version_number(version_str):

258 """Converts version string into an integer. 259 260 :param version_str: The version string. 261 :type version_str: str 262 :return: A version integer. 263 264 >>> hex(KfmFormat.version_number('1.0')) 265 '0x1000000' 266 >>> hex(KfmFormat.version_number('1.2.4b')) 267 '0x1024b00' 268 >>> hex(KfmFormat.version_number('2.2.0.0b')) 269 '0x202000b' 270 """ 271 272 if not '.' in version_str: 273 return int(version_str) 274 275 try: 276 ver_list = [int(x, 16) for x in version_str.split('.')] 277 except ValueError: 278 # version not supported (i.e. version_str '10.0.1.3z' would 279 # trigger this) 280 return -1 281 if len(ver_list) > 4 or len(ver_list) < 1: 282 # version not supported 283 return -1 284 for ver_digit in ver_list: 285 if (ver_digit | 0xff) > 0xff: 286 return -1 # version not supported 287 while len(ver_list) < 4: 288 ver_list.append(0) 289 return ((ver_list[0] << 24) 290 + (ver_list[1] << 16) 291 + (ver_list[2] << 8) 292 + ver_list[3])

293

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

295 """A class to contain the actual kfm data.""" 296 version = 0x01024B00 297

299 """Quick heuristic check if stream contains KFM data, 300 by looking at the first 64 bytes. Sets version and reads 301 header string. 302 303 :param stream: The stream to inspect. 304 :type stream: file 305 """ 306 pos = stream.tell() 307 try: 308 hdrstr = stream.readline(64).rstrip() 309 finally: 310 stream.seek(pos) 311 if hdrstr.startswith(";Gamebryo KFM File Version ".encode("ascii")): 312 version_str = hdrstr[27:].decode("ascii") 313 else: 314 # not a kfm file 315 raise ValueError("Not a KFM file.") 316 try: 317 ver = KfmFormat.version_number(version_str) 318 except: 319 # version not supported 320 raise ValueError("KFM version not supported.") 321 if not ver in KfmFormat.versions.values(): 322 # unsupported version 323 raise ValueError("KFM version not supported.") 324 # store version 325 self.version = ver 326 # read header string 327 try: 328 self._header_string_value_.read(stream, self) 329 self._unknown_byte_value_.read(stream, self) 330 self._nif_file_name_value_.read(stream, self) 331 self._master_value_.read(stream, self) 332 finally: 333 stream.seek(pos)

334

336 """Read a kfm file. 337 338 :param stream: The stream from which to read. 339 :type stream: ``file`` 340 """ 341 # read the file 342 self.inspect(stream) # quick check 343 pyffi.object_models.xml.struct_.StructBase.read( 344 self, stream, self) 345 346 # check if we are at the end of the file 347 if stream.read(1): 348 raise ValueError('end of file not reached: corrupt kfm file?')

349 359 360 # GlobalNode 361 364

368

369 - class Animation:

370 # XXX this does not work yet (see todo for KfmFormat)

371 - def get_detail_display(self):

372 """Display the kf file name.""" 373 return self.kf_file_name if not self.name else self.name

374

375 - def get_global_display(self):

376 """Display the kf file name.""" 377 return self.kf_file_name if not self.name else self.name

Source Code for Package pyffi.formats.kfm