#!/usr/bin/env python3
#
# _cont.py
"""
CONT record type.
"""
#
# Copyright © 2024 Dominic Davis-Foster <dominic@davis-foster.co.uk>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
# OR OTHER DEALINGS IN THE SOFTWARE.
#
# stdlib
import struct
from io import BytesIO
from typing import Iterator, NamedTuple, Type
# 3rd party
from typing_extensions import Self
# this package
from esp_parser.subrecords import EDID, OBND, Destruction, Item, Model
from esp_parser.types import CStringRecord, FormIDRecord, Record, RecordType
from esp_parser.utils import namedtuple_qualname_repr
__all__ = ["CONT"]
[docs]class CONT(Record):
"""
Container.
"""
[docs] class FULL(CStringRecord):
"""
Container name.
"""
[docs] class SCRI(FormIDRecord):
"""
Script.
Form ID of a :class:`~.SCPT` record.
"""
[docs] class DATA(NamedTuple):
"""
Data.
"""
flags: int
weight: float
[docs] @classmethod
def parse(cls: Type[Self], raw_bytes: BytesIO) -> Self:
"""
Parse this subrecord.
:param raw_bytes: Raw bytes for this record
"""
assert raw_bytes.read(2) == b"\x05\x00" # size field
return cls(*struct.unpack("<Bf", raw_bytes.read(5)))
[docs] def unparse(self) -> bytes:
"""
Turn this subrecord back into raw bytes for an ESP file.
"""
return b"DATA\x05\x00" + struct.pack("<Bf", *self)
def __repr__(self) -> str:
return namedtuple_qualname_repr(self)
[docs] class SNAM(FormIDRecord):
"""
Sound - open.
Form ID of a :class:`~.SOUN` record.
"""
[docs] class QNAM(FormIDRecord):
"""
Sound - close.
Form ID of a :class:`~.SOUN` record.
"""
[docs] class RNAM(FormIDRecord):
"""
Sound - random/looping (New Vegas only).
Form ID of a :class:`~.SOUN` record.
"""
[docs] @classmethod
def parse_subrecords(cls, raw_bytes: BytesIO) -> Iterator[RecordType]:
"""
Parse this record's subrecords.
:param raw_bytes: Raw bytes for this record's subrecords
"""
while True:
record_type = raw_bytes.read(4)
if not record_type:
break
if record_type == b"EDID":
yield EDID.parse(raw_bytes)
elif record_type == b"OBND":
yield OBND.parse(raw_bytes)
elif record_type in {b"DATA", b"FULL", b"QNAM", b"RNAM", b"SCRI", b"SNAM"}:
yield getattr(cls, record_type.decode()).parse(raw_bytes)
elif record_type in Model.members:
yield Model.parse_member(record_type, raw_bytes)
elif record_type in Item.members:
yield Item.parse_member(record_type, raw_bytes)
elif record_type in Destruction.members:
yield Destruction.parse_member(record_type, raw_bytes)
else:
raise NotImplementedError(record_type)