dissect.cstruct 5.0.dev9__py3-none-any.whl → 5.0.dev11__py3-none-any.whl

dissect/cstruct/types/int.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING, Any, BinaryIO
 
-from dissect.cstruct.types.base import BaseType
+from dissect.cstruct.types.base import EOF, BaseType, MetaType
 from dissect.cstruct.util import ENDIANNESS_TO_BYTEORDER_MAP
 
 if TYPE_CHECKING:
@@ -23,7 +23,26 @@ class Int(int, BaseType):
         if len(data) != cls.__size__:
             raise EOFError(f"Read {len(data)} bytes, but expected {cls.__size__}")
 
-        return cls.from_bytes(data, ENDIANNESS_TO_BYTEORDER_MAP[endian], signed=cls.signed)
+        return type.__call__(cls, int.from_bytes(data, ENDIANNESS_TO_BYTEORDER_MAP[endian], signed=cls.signed))
+
+    @classmethod
+    def _read_array(
+        cls, stream: BinaryIO, count: int, *, context: dict[str, Any] | None = None, endian: Endianness
+    ) -> list[Self]:
+        if count == EOF:
+            return MetaType._read_array(cls, stream, count, context=context, endian=endian)
+
+        size = cls.__size__
+        length = size * count
+        data = stream.read(length)
+        if len(data) != length:
+            raise EOFError(f"Read {len(data) % size} bytes, but expected {size}")
+
+        byteorder = ENDIANNESS_TO_BYTEORDER_MAP[endian]
+        return [
+            type.__call__(cls, int.from_bytes(data[i : i + size], byteorder, signed=cls.signed))
+            for i in range(0, length, size)
+        ]
 
     @classmethod
     def _read_0(cls, stream: BinaryIO, *, context: dict[str, Any] | None = None, endian: Endianness) -> Self:

dissect/cstruct/types/packed.py

@@ -1,9 +1,10 @@
 from __future__ import annotations
 
 import warnings
+from itertools import repeat
 from typing import TYPE_CHECKING, Any, BinaryIO, Generic, TypeVar
 
-from dissect.cstruct.types.base import EOF, BaseType
+from dissect.cstruct.types.base import EOF, BaseType, MetaType, _is_buffer_type
 from dissect.cstruct.util import _struct, classproperty
 
 if TYPE_CHECKING:
@@ -15,7 +16,35 @@ if TYPE_CHECKING:
 T = TypeVar("T", int, float)
 
 
-class Packed(BaseType, Generic[T]):
+class PackedMetaType(MetaType):
+    """Metaclass for packed types."""
+
+    def __call__(cls, *args, **kwargs) -> Packed:
+        if len(args) == 1 and not kwargs:
+            # Handle a few fast path cases
+            obj = args[0]
+            if (tp := type(obj)) is bytes or tp is bytearray or (tp is memoryview and obj.c_contiguous):
+                data = obj.cast("B") if tp is memoryview else obj
+                if len(data) < cls.__size__:
+                    raise EOFError(f"Read {len(data)} bytes, but expected {cls.__size__}")
+
+                return cls.__new__(cls, _struct(cls.__cs__.endian, cls.__fmt__).unpack_from(data)[0])
+
+            if hasattr(obj, "read") and not isinstance(obj, cls):
+                return cls._read(obj, endian=cls.__cs__.endian)
+
+            if not _is_buffer_type(obj):
+                # E.g. initializing with a value
+                return type.__call__(cls, obj)
+
+        elif not args and not kwargs:
+            # Default value
+            return type.__call__(cls)
+
+        return MetaType.__call__(cls, *args, **kwargs)
+
+
+class Packed(BaseType, Generic[T], metaclass=PackedMetaType):
     """Packed type for Python struct (un)packing."""
 
     __fmt__: str
@@ -46,7 +75,7 @@ class Packed(BaseType, Generic[T]):
         if len(data) != length:
             raise EOFError(f"Read {len(data)} bytes, but expected {length}")
 
-        return [cls.__new__(cls, value) for value in fmt.unpack(data)]
+        return list(map(cls.__new__, repeat(cls), fmt.unpack(data)))
 
     @classmethod
     def _read_0(cls, stream: BinaryIO, context: dict[str, Any] | None = None, *, endian: Endianness) -> Self:

dissect/cstruct/types/structure.py

@@ -17,11 +17,11 @@ from dissect.cstruct.bitbuffer import BitBuffer
 from dissect.cstruct.expression import Expression
 from dissect.cstruct.lexer import IDENTIFIER_TYPES
 from dissect.cstruct.types.base import (
+    _BUFFER_TYPES,
     BaseArray,
     BaseType,
     MetaType,
     _is_buffer_type,
-    _is_readable_type,
 )
 from dissect.cstruct.types.enum import EnumMetaType
 from dissect.cstruct.types.pointer import Pointer
@@ -75,6 +75,15 @@ class StructureMetaType(MetaType):
         return super().__new__(metacls, name, bases, classdict)
 
     def __call__(cls, *args, **kwargs) -> Self:  # type: ignore
+        if len(args) == 1 and not kwargs:
+            # Fast paths for the most common cases
+            obj = args[0]
+            if type(obj) in _BUFFER_TYPES:
+                return cls._read(io.BytesIO(obj), endian=cls.__cs__.endian)
+
+            if hasattr(obj, "read") and not isinstance(obj, cls):
+                return cls._read(obj, endian=cls.__cs__.endian)
+
         if not args and not kwargs:
             obj = type.__call__(cls)
             object.__setattr__(obj, "__dynamic_sizes__", {})
@@ -132,20 +141,6 @@ class StructureMetaType(MetaType):
         else:
             size, alignment = cls._calculate_size_and_offsets(fields, align)
 
-        if cls.__compiled__:
-            # If the previous class was compiled try to compile this too
-            from dissect.cstruct import compiler
-
-            try:
-                classdict["_read"] = compiler.Compiler(cls.__cs__).compile_read(
-                    fields, cls.__name__, align=cls.__align__
-                )
-                classdict["__compiled__"] = True
-            except Exception:
-                # Revert _read to the slower loop based method
-                classdict["_read"] = classmethod(Structure._read.__func__)
-                classdict["__compiled__"] = False
-
         # TODO: compile _write
         # TODO: generate cached_property for lazy reading
 
@@ -244,7 +239,7 @@ class StructureMetaType(MetaType):
         return offset, alignment
 
     def _read(cls, stream: BinaryIO, *, context: dict[str, Any] | None = None, endian: Endianness) -> Self:  # type: ignore
-        bit_buffer = BitBuffer(stream, endian=endian)
+        bit_buffer = None
         struct_start = stream.tell()
 
         result = {}
@@ -263,6 +258,9 @@ class StructureMetaType(MetaType):
                 stream.seek(offset)
 
             if field.bits:
+                if bit_buffer is None:
+                    bit_buffer = BitBuffer(stream, endian=endian)
+
                 if isinstance(field.type, EnumMetaType):
                     value = field.type(bit_buffer.read(field.type.__type__, field.bits))
                 else:
@@ -271,7 +269,8 @@ class StructureMetaType(MetaType):
                 result[field._name] = value
                 continue
 
-            bit_buffer.reset()
+            if bit_buffer is not None:
+                bit_buffer.reset()
 
             value = field.type._read(stream, context=result, endian=endian)
 
@@ -298,23 +297,24 @@ class StructureMetaType(MetaType):
         return result
 
     def _write(cls, stream: BinaryIO, data: Structure, *, endian: Endianness) -> int:
-        bit_buffer = BitBuffer(stream, endian=endian)
+        bit_buffer = None
         struct_start = stream.tell()
         num = 0
 
         for field in cls.__fields__:
             field_type = field.type
 
-            bit_field_type = (
-                (field_type.__type__ if isinstance(field_type, EnumMetaType) else field_type) if field.bits else None
-            )
-            # Current field is not a bit field, but previous was
-            # Or, moved to a bit field of another type, e.g. uint16 f1 : 8, uint32 f2 : 8;
-            if (not field.bits and bit_buffer._type is not None) or (
-                bit_buffer._type and bit_buffer._type != bit_field_type
-            ):
-                # Flush the current bit buffer so we can process alignment properly
-                bit_buffer.flush()
+            if bit_buffer is not None and bit_buffer._type is not None:
+                bit_field_type = (
+                    (field_type.__type__ if isinstance(field_type, EnumMetaType) else field_type)
+                    if field.bits
+                    else None
+                )
+                # Current field is not a bit field, but previous was
+                # Or, moved to a bit field of another type, e.g. uint16 f1 : 8, uint32 f2 : 8;
+                if bit_buffer._type != bit_field_type:
+                    # Flush the current bit buffer so we can process alignment properly
+                    bit_buffer.flush()
 
             offset = stream.tell()
 
@@ -324,10 +324,8 @@ class StructureMetaType(MetaType):
                 offset = struct_start + field.offset
 
             if cls.__align__ and field.offset is None:
-                is_bitbuffer_boundary = bit_buffer._type and (
-                    bit_buffer._remaining == 0 or bit_buffer._type != field_type
-                )
-                if not bit_buffer._type or is_bitbuffer_boundary:
+                bit_type = bit_buffer._type if bit_buffer is not None else None
+                if bit_type is None or bit_buffer._remaining == 0 or bit_type != field_type:
                     # Previous field was dynamically sized and we need to align
                     align_pad = -offset & (field.alignment - 1)
                     stream.write(b"\x00" * align_pad)
@@ -338,6 +336,9 @@ class StructureMetaType(MetaType):
                 value = field_type.__default__()
 
             if field.bits:
+                if bit_buffer is None:
+                    bit_buffer = BitBuffer(stream, endian=endian)
+
                 if isinstance(field_type, EnumMetaType):
                     bit_buffer.write(field_type.__type__, value.value, field.bits)
                 else:
@@ -346,7 +347,7 @@ class StructureMetaType(MetaType):
                 field_type._write(stream, value, endian=endian)
                 num += stream.tell() - offset
 
-        if bit_buffer._type is not None:
+        if bit_buffer is not None and bit_buffer._type is not None:
             bit_buffer.flush()
 
         if cls.__align__:
@@ -377,6 +378,12 @@ class StructureMetaType(MetaType):
         for key, value in classdict.items():
             setattr(cls, key, value)
 
+        if cls.__compiled__:
+            # If the previous class was compiled try to compile this too
+            from dissect.cstruct import compiler
+
+            compiler.compile_structure(cls)
+
     def cdef(cls, *, recursive: bool = False) -> str:
         """Render this structure (or union) back to its C-style definition.
 
@@ -579,7 +586,7 @@ class UnionMetaType(StructureMetaType):
             object.__setattr__(obj, "_endian", cls.__cs__.endian)
 
         # Calling with non-stream args or kwargs means we are initializing with values
-        if (args and not (len(args) == 1 and (_is_readable_type(args[0]) or _is_buffer_type(args[0])))) or kwargs:
+        if (args and not (len(args) == 1 and (hasattr(args[0], "read") or _is_buffer_type(args[0])))) or kwargs:
             # We don't support user initialization of dynamic unions yet
             if cls.__dynamic__:
                 raise NotImplementedError("Initializing a dynamic union is not yet supported")
@@ -656,6 +663,18 @@ class UnionMetaType(StructureMetaType):
             size = stream.tell() - start
             stream.seek(start)
             buf = stream.read(size)
+        elif "__init__" in cls.__dict__ and cls.__new__ is object.__new__:
+            # Fast path for static unions
+            buf = stream.read(cls.__size__)
+            result, sizes = cls._read_fields(io.BytesIO(buf), endian=endian)
+
+            obj: Union = object.__new__(cls)
+            obj.__dict__.update(result)
+            object.__setattr__(obj, "__dynamic_sizes__", sizes)
+            object.__setattr__(obj, "_buf", buf)
+            object.__setattr__(obj, "_endian", endian)
+            obj._proxify()
+            return obj
         else:
             result = {}
             sizes = {}

dissect/cstruct/types/wchar.py

@@ -4,7 +4,7 @@ import sys
 from typing import TYPE_CHECKING, Any, BinaryIO, ClassVar
 
 from dissect.cstruct.exception import ArraySizeError
-from dissect.cstruct.types.base import EOF, BaseArray, BaseType
+from dissect.cstruct.types.base import EOF, BaseArray, BaseType, _is_seekable, _read_null_terminated
 
 if TYPE_CHECKING:
     from dissect.cstruct.cstruct import Endianness
@@ -72,10 +72,13 @@ class Wchar(str, BaseType):
         if count != EOF and len(data) != count:
             raise EOFError(f"Read {len(data)} bytes, but expected {count}")
 
-        return type.__call__(cls, data.decode(cls.__encoding_map__[endian]))
+        return type.__call__(cls, str(data, cls.__encoding_map__[endian]))
 
     @classmethod
     def _read_0(cls, stream: BinaryIO, *, context: dict[str, Any] | None = None, endian: Endianness) -> Wchar:
+        if _is_seekable(stream):
+            return type.__call__(cls, _read_null_terminated(stream, 2).decode(cls.__encoding_map__[endian]))
+
         buf = []
         while True:
             point = stream.read(2)

{dissect_cstruct-5.0.dev9.dist-info → dissect_cstruct-5.0.dev11.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dissect.cstruct
-Version: 5.0.dev9
+Version: 5.0.dev11
 Summary: A Dissect module implementing a parser for C-like structures: structure parsing in Python made easy
 Author-email: Dissect Team <dissect@fox-it.com>
 License-Expression: Apache-2.0

dissect_cstruct-5.0.dev11.dist-info/RECORD

@@ -0,0 +1,30 @@
+dissect/cstruct/__init__.py,sha256=KOyNeUvu4c0JaAiyOfj7iftGwUIjTmD8MwHtFsLPLSU,1504
+dissect/cstruct/bitbuffer.py,sha256=aNzY4lkWe8ffAc8j7FODXzwZc8gZwbey77UosyoYCsw,2711
+dissect/cstruct/compiler.py,sha256=hhX1bxZFsPOcs6BUO82YHNtWqhKsiOb-H-d18Aa1Q6E,35148
+dissect/cstruct/cstruct.py,sha256=VQDgGF7OUaPKQ_Wsy_2fUHL9Jlims6R2JOh-1_bgiZ8,26550
+dissect/cstruct/exception.py,sha256=RqD08LuBkbMqa3iQ1A05DNN8XgEmQR_SUnguwe9LGo8,316
+dissect/cstruct/expression.py,sha256=Y27-N48BomBoRFozbWhGDF_DS2lfklRwWVUbCzGnxHE,10873
+dissect/cstruct/lexer.py,sha256=NDUfAWgyxgRNRuVO8ExXQ51LqQXS2mv9bywVa_M7tFQ,19665
+dissect/cstruct/parser.py,sha256=5vz1frbenevKyn-CobKyp9_22dnEbFej_nUXQeL5W8U,21368
+dissect/cstruct/util.py,sha256=vAf-kdOkk3zprW_gD6QmQeN3VIRgQqhPS4B_ha1jEpQ,18040
+dissect/cstruct/tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dissect/cstruct/tools/stubgen.py,sha256=MeZkLmSeNSLNcAEwlAdIGv1lKvlvK3UQ4WN85ovsxTM,7672
+dissect/cstruct/types/__init__.py,sha256=6P71Pu94Dv7RNjZpDZ19pqzx-G0QzmQw4q0-3zWALso,911
+dissect/cstruct/types/base.py,sha256=10HLF2SDeWUMVc6ISMv8xKdEggqrxLPHnJMwI03DEFg,17216
+dissect/cstruct/types/char.py,sha256=Rzjn2-pXbn-fV_UnNRGgQugFZ50mPuXQhcmgHvY5PR0,3172
+dissect/cstruct/types/enum.py,sha256=nOdI6vGtqTfPMhOBkKuiuOriIB2YHSt8Q9ruri37s3U,9177
+dissect/cstruct/types/flag.py,sha256=YxQHix8ZhK1qQX3J_Og7GJp_4JAxCwzUbUibuJeDaWQ,3479
+dissect/cstruct/types/int.py,sha256=9RbdrkvAI28zATM97VVORQnras0XhLaVMtdPjJwpTH4,2089
+dissect/cstruct/types/leb128.py,sha256=V97XTJT_Xbw1LpTwTN1OkjPHuQQAQUxd8OGuA6yEDmE,2387
+dissect/cstruct/types/packed.py,sha256=NgCX0YWX8SH8z47atq0f39w9MBjU_eBFJtUisUWdO-M,3867
+dissect/cstruct/types/pointer.py,sha256=FNuB9bfENWRebbKX-R6Vs6xWPMHepjvOhhomeUhr7I8,3985
+dissect/cstruct/types/structure.py,sha256=WDMmfhP2XE5p1Bn-WgFFstfaWC709AU7_y-SGi3TyDw,39116
+dissect/cstruct/types/void.py,sha256=fV4hKk50uop_EKbR1nfy1cdtAzvUYrSymXsdakCyFk8,1222
+dissect/cstruct/types/wchar.py,sha256=qUbX6auj0qHWSOkgvaI7ZW_f7RGgwa-Hf_d_mDpntlM,3410
+dissect_cstruct-5.0.dev11.dist-info/licenses/COPYRIGHT,sha256=H-18RXfshdH9AdHwW2eO1Xa-5s6tY5eipHh5c0whDu4,316
+dissect_cstruct-5.0.dev11.dist-info/licenses/LICENSE,sha256=PhUqiw6jAh2KbBdVRPBq_hfAvfcTBin7nZ3CK7NQbTM,11341
+dissect_cstruct-5.0.dev11.dist-info/METADATA,sha256=Wxf65kgjGnT9csqu2go1YVpp4RKcnFu_8smscSoywe8,9256
+dissect_cstruct-5.0.dev11.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+dissect_cstruct-5.0.dev11.dist-info/entry_points.txt,sha256=z53zqZqwD2OLrAkRwrP4wTeiU9CQe7xrMly0T2c0_wQ,71
+dissect_cstruct-5.0.dev11.dist-info/top_level.txt,sha256=Mn-CQzEYsAbkxrUI0TnplHuXnGVKzxpDw_po_sXpvv4,8
+dissect_cstruct-5.0.dev11.dist-info/RECORD,,

{dissect_cstruct-5.0.dev9.dist-info → dissect_cstruct-5.0.dev11.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (83.0.0)
+Generator: setuptools (84.2.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

dissect_cstruct-5.0.dev9.dist-info/RECORD

@@ -1,30 +0,0 @@
-dissect/cstruct/__init__.py,sha256=KOyNeUvu4c0JaAiyOfj7iftGwUIjTmD8MwHtFsLPLSU,1504
-dissect/cstruct/bitbuffer.py,sha256=aNzY4lkWe8ffAc8j7FODXzwZc8gZwbey77UosyoYCsw,2711
-dissect/cstruct/compiler.py,sha256=zcrO5CWCF2vWo2es-pFGn-Mvt-RTMh8W9bntK-hn85k,14343
-dissect/cstruct/cstruct.py,sha256=wC4Xd8MBxTCyl-IC1I2c3etI8M6C6D5yXVfELbfQk6c,25656
-dissect/cstruct/exception.py,sha256=RqD08LuBkbMqa3iQ1A05DNN8XgEmQR_SUnguwe9LGo8,316
-dissect/cstruct/expression.py,sha256=MEwqHGgqA2fUk4kYk4lRLDWNTAMhB4-saJ5BgTxl7OA,7956
-dissect/cstruct/lexer.py,sha256=NDUfAWgyxgRNRuVO8ExXQ51LqQXS2mv9bywVa_M7tFQ,19665
-dissect/cstruct/parser.py,sha256=xCK-1O8c86sVFvjaXXSRgTsJWWd0ncKM6KJf2wbyGG8,21348
-dissect/cstruct/util.py,sha256=vAf-kdOkk3zprW_gD6QmQeN3VIRgQqhPS4B_ha1jEpQ,18040
-dissect/cstruct/tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-dissect/cstruct/tools/stubgen.py,sha256=MeZkLmSeNSLNcAEwlAdIGv1lKvlvK3UQ4WN85ovsxTM,7672
-dissect/cstruct/types/__init__.py,sha256=6P71Pu94Dv7RNjZpDZ19pqzx-G0QzmQw4q0-3zWALso,911
-dissect/cstruct/types/base.py,sha256=vJUgrnsPg2ZA9Mel2P9JBBstI9z9oMxqi5Pnx9FlBIA,15023
-dissect/cstruct/types/char.py,sha256=zsRMlcZGW1cHYH_xQBNORDnM_a5CXcuZLGly1N1i_Ms,3029
-dissect/cstruct/types/enum.py,sha256=j2U6oE_80c4H2505YMddHPnF99az2K5IuDhX40Q7OEI,8590
-dissect/cstruct/types/flag.py,sha256=7xxQjFEDPHSQOxBHgcc75WzPiAxflOquwr7Z7c3erLE,2347
-dissect/cstruct/types/int.py,sha256=RCT3YjrajqRqh8cyeM-zaqzCmBfeJrXkD5W1FcRzXag,1340
-dissect/cstruct/types/leb128.py,sha256=V97XTJT_Xbw1LpTwTN1OkjPHuQQAQUxd8OGuA6yEDmE,2387
-dissect/cstruct/types/packed.py,sha256=QF1mAqgxLbgiibRZLhn6cp6SnuH2IxjGr9DsQdXCCSE,2713
-dissect/cstruct/types/pointer.py,sha256=FNuB9bfENWRebbKX-R6Vs6xWPMHepjvOhhomeUhr7I8,3985
-dissect/cstruct/types/structure.py,sha256=QZBVCCERu9eoXLqrumF7Kqy0gudywl12-cSZx6n3tPI,38402
-dissect/cstruct/types/void.py,sha256=fV4hKk50uop_EKbR1nfy1cdtAzvUYrSymXsdakCyFk8,1222
-dissect/cstruct/types/wchar.py,sha256=X-dRu6ujjQIIsBfzKbujwMO5skKdARtptF6P7R5v8Jo,3232
-dissect_cstruct-5.0.dev9.dist-info/licenses/COPYRIGHT,sha256=H-18RXfshdH9AdHwW2eO1Xa-5s6tY5eipHh5c0whDu4,316
-dissect_cstruct-5.0.dev9.dist-info/licenses/LICENSE,sha256=PhUqiw6jAh2KbBdVRPBq_hfAvfcTBin7nZ3CK7NQbTM,11341
-dissect_cstruct-5.0.dev9.dist-info/METADATA,sha256=1TPbiY0D5dnQscZ0QDgEJvsSjlguJxBNXgqM3_Xf0V4,9255
-dissect_cstruct-5.0.dev9.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
-dissect_cstruct-5.0.dev9.dist-info/entry_points.txt,sha256=z53zqZqwD2OLrAkRwrP4wTeiU9CQe7xrMly0T2c0_wQ,71
-dissect_cstruct-5.0.dev9.dist-info/top_level.txt,sha256=Mn-CQzEYsAbkxrUI0TnplHuXnGVKzxpDw_po_sXpvv4,8
-dissect_cstruct-5.0.dev9.dist-info/RECORD,,