dissect.cstruct 4.8.dev9__py3-none-any.whl → 5.0.dev6__py3-none-any.whl

dissect/cstruct/{utils.py → util.py}

@@ -7,13 +7,14 @@ import sys
 from enum import Enum
 from typing import TYPE_CHECKING
 
-from dissect.cstruct.types.pointer import Pointer
-from dissect.cstruct.types.structure import Structure
-
 if TYPE_CHECKING:
     from collections.abc import Iterator
     from typing import Literal
 
+    from dissect.cstruct.cstruct import AllowedEndianness
+    from dissect.cstruct.types.base import BaseType
+    from dissect.cstruct.types.structure import Structure
+
 # Regular ANSI colors
 COLOR_RED = "\033[0;31m"
 COLOR_GREEN = "\033[0;32m"
@@ -51,13 +52,16 @@ COLOR_CLEAR_BOLD = "\033[1;0m"
 
 PRINTABLE = string.digits + string.ascii_letters + string.punctuation + " "
 
-ENDIANNESS_MAP: dict[str, Literal["big", "little"]] = {
-    "@": sys.byteorder,
-    "=": sys.byteorder,
+
+ENDIANNESS_TO_BYTEORDER_MAP: dict[AllowedEndianness, Literal["big", "little"]] = {
     "<": "little",
     ">": "big",
     "!": "big",
+    "@": sys.byteorder,
+    "=": sys.byteorder,
     "network": "big",
+    "little": "little",
+    "big": "big",
 }
 
 Palette = list[tuple[int, str]]
@@ -263,14 +267,15 @@ def _dumpstruct(
             continue
 
         value = getattr(structure, field._name)
-        if isinstance(value, (str, Pointer, Enum)):
-            value = repr(value)
-        elif isinstance(value, int):
+
+        if isinstance(value, int) and not isinstance(value, Enum):
             value = hex(value)
         elif isinstance(value, list):
             value = pprint.pformat(value)
             if "\n" in value:
                 value = value.replace("\n", f"\n{' ' * (len(field._name) + 4)}")
+        else:
+            value = repr(value)
 
         if color:
             foreground, background = colors[ci % len(colors)]
@@ -316,118 +321,124 @@ def dumpstruct(
     if output not in ("print", "string"):
         raise ValueError(f"Invalid output argument: {output!r} (should be 'print' or 'string').")
 
-    if isinstance(obj, Structure):
-        return _dumpstruct(obj, obj.dumps(), offset, color, output, autoskip)
-    if issubclass(obj, Structure) and data is not None:
+    if isinstance(obj, type) and data is not None:
         return _dumpstruct(obj(data), data, offset, color, output, autoskip)
-    raise ValueError("Invalid arguments")
+
+    return _dumpstruct(obj, obj.dumps(), offset, color, output, autoskip)
 
 
-def pack(value: int, size: int | None = None, endian: str = "little") -> bytes:
+def pack(value: int, size: int | None = None, endian: AllowedEndianness = "little") -> bytes:
     """Pack an integer value to a given bit size, endianness.
 
     Arguments:
         value: Value to pack.
         size: Integer size in bits.
-        endian: Endianness to use (little, big, network, <, > or !)
+        endian: Endianness to use (little, big, network, <, >, !, @ or =).
     """
+    if endian not in ENDIANNESS_TO_BYTEORDER_MAP:
+        raise ValueError(f"Invalid endianness: {endian!r} (should be little, big, network, <, >, !, @ or =)")
+
     size = ((size or value.bit_length()) + 7) // 8
-    return value.to_bytes(size, ENDIANNESS_MAP.get(endian, endian), signed=value < 0)
+    return value.to_bytes(size, ENDIANNESS_TO_BYTEORDER_MAP[endian], signed=value < 0)
 
 
-def unpack(value: bytes, size: int | None = None, endian: str = "little", sign: bool = False) -> int:
+def unpack(value: bytes, size: int | None = None, endian: AllowedEndianness = "little", sign: bool = False) -> int:
     """Unpack an integer value from a given bit size, endianness and sign.
 
     Arguments:
         value: Value to unpack.
         size: Integer size in bits.
-        endian: Endianness to use (little, big, network, <, > or !)
+        endian: Endianness to use (little, big, network, <, >, !, @ or =).
         sign: Signedness of the integer.
     """
     if size and len(value) != size // 8:
         raise ValueError(f"Invalid byte value, expected {size // 8} bytes, got {len(value)} bytes")
-    return int.from_bytes(value, ENDIANNESS_MAP.get(endian, endian), signed=sign)
+
+    if endian not in ENDIANNESS_TO_BYTEORDER_MAP:
+        raise ValueError(f"Invalid endianness: {endian!r} (should be little, big, network, <, >, !, @ or =)")
+
+    return int.from_bytes(value, ENDIANNESS_TO_BYTEORDER_MAP[endian], signed=sign)
 
 
-def p8(value: int, endian: str = "little") -> bytes:
+def p8(value: int, endian: AllowedEndianness = "little") -> bytes:
     """Pack an 8 bit integer.
 
     Arguments:
         value: Value to pack.
-        endian: Endianness to use (little, big, network, <, > or !)
+        endian: Endianness to use (little, big, network, <, >, !, @ or =).
     """
     return pack(value, 8, endian)
 
 
-def p16(value: int, endian: str = "little") -> bytes:
+def p16(value: int, endian: AllowedEndianness = "little") -> bytes:
     """Pack a 16 bit integer.
 
     Arguments:
         value: Value to pack.
-        endian: Endianness to use (little, big, network, <, > or !)
+        endian: Endianness to use (little, big, network, <, >, !, @ or =).
     """
     return pack(value, 16, endian)
 
 
-def p32(value: int, endian: str = "little") -> bytes:
+def p32(value: int, endian: AllowedEndianness = "little") -> bytes:
     """Pack a 32 bit integer.
 
     Arguments:
         value: Value to pack.
-        endian: Endianness to use (little, big, network, <, > or !)
+        endian: Endianness to use (little, big, network, <, >, !, @ or =).
     """
     return pack(value, 32, endian)
 
 
-def p64(value: int, endian: str = "little") -> bytes:
+def p64(value: int, endian: AllowedEndianness = "little") -> bytes:
     """Pack a 64 bit integer.
 
     Arguments:
         value: Value to pack.
-        endian: Endianness to use (little, big, network, <, > or !)
+        endian: Endianness to use (little, big, network, <, >, !, @ or =).
     """
     return pack(value, 64, endian)
 
 
-def u8(value: bytes, endian: str = "little", sign: bool = False) -> int:
+def u8(value: bytes, endian: AllowedEndianness = "little", sign: bool = False) -> int:
     """Unpack an 8 bit integer.
 
     Arguments:
         value: Value to unpack.
-        endian: Endianness to use (little, big, network, <, > or !)
+        endian: Endianness to use (little, big, network, <, >, !, @ or =).
         sign: Signedness of the integer.
     """
     return unpack(value, 8, endian, sign)
 
 
-def u16(value: bytes, endian: str = "little", sign: bool = False) -> int:
+def u16(value: bytes, endian: AllowedEndianness = "little", sign: bool = False) -> int:
     """Unpack a 16 bit integer.
 
     Arguments:
         value: Value to unpack.
-        endian: Endianness to use (little, big, network, <, > or !)
+        endian: Endianness to use (little, big, network, <, >, !, @ or =).
         sign: Signedness of the integer.
     """
     return unpack(value, 16, endian, sign)
 
 
-def u32(value: bytes, endian: str = "little", sign: bool = False) -> int:
+def u32(value: bytes, endian: AllowedEndianness = "little", sign: bool = False) -> int:
     """Unpack a 32 bit integer.
 
     Arguments:
         value: Value to unpack.
-        endian: Endianness to use (little, big, network, <, > or !)
+        endian: Endianness to use (little, big, network, <, >, !, @ or =).
         sign: Signedness of the integer.
     """
     return unpack(value, 32, endian, sign)
 
 
-def u64(value: bytes, endian: str = "little", sign: bool = False) -> int:
+def u64(value: bytes, endian: AllowedEndianness = "little", sign: bool = False) -> int:
     """Unpack a 64 bit integer.
 
     Arguments:
         value: Value to unpack.
-        endian: Endianness to use (little, big, network, <, > or !)
+        endian: Endianness to use (little, big, network, <, >, !, @ or =).
         sign: Signedness of the integer.
     """
     return unpack(value, 64, endian, sign)
@@ -468,3 +479,17 @@ def swap64(value: int) -> int:
         value: Integer to swap.
     """
     return swap(value, 64)
+
+
+def sizeof(type_: type[BaseType] | BaseType) -> int:
+    """Get the size of a type in bytes."""
+    return len(type_)
+
+
+def offsetof(type_: type[Structure], name: str) -> int:
+    """Get the offset of a field in a structure."""
+    if (field := type_.fields.get(name)) is None:
+        raise ValueError(f"Structure '{type_.__name__}' does not have a field named '{name}'")
+    if (offset := field.offset) is None:
+        raise ValueError(f"Field '{field._name}' of structure '{type_.__name__}' does not have a known offset")
+    return offset

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dissect.cstruct
-Version: 4.8.dev9
+Version: 5.0.dev6
 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.dev6.dist-info/RECORD

@@ -0,0 +1,32 @@
+dissect/cstruct/__init__.py,sha256=8VNVQfPH4aH5V_kD-jvtLPwQ-ag9ppKHTy3dbxIR6ik,1378
+dissect/cstruct/bitbuffer.py,sha256=lZuLUOluHx4mzFGRp62_FO45_iJwXayyzv9-v8b0Q08,2687
+dissect/cstruct/compiler.py,sha256=vVg2H-pi9ugQ8Xvhs1JQ--4BjA5gtO2tW-1W8jr36V4,14283
+dissect/cstruct/cstruct.py,sha256=bsCesSpbE0H4MUsHwb2iEbeadOBlOSAVENwyoP-UkP8,24929
+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=S__kLEb9HKZg_WZR4CGtXDxkIkERLKbzFTHoU8FT8tU,15313
+dissect/cstruct/tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dissect/cstruct/tools/stubgen.py,sha256=FLQieYE-MeKK31DcrDzwNUropUYHPjwdfcDb1X2L6j4,7651
+dissect/cstruct/types/__init__.py,sha256=6P71Pu94Dv7RNjZpDZ19pqzx-G0QzmQw4q0-3zWALso,911
+dissect/cstruct/types/base.py,sha256=TkU2a1TK1oDafz_9PTQfZuQT7g4aTRsKnG_-Q4jelsQ,12652
+dissect/cstruct/types/char.py,sha256=XAXlKZXbo88WJN-JPW4w4vzcuNgyvLl3Bpn8RLs9pVo,2707
+dissect/cstruct/types/enum.py,sha256=YIWyP3H0tdxmuSI82enoULiN0YevpnU0UaY5ioBCYfI,8518
+dissect/cstruct/types/flag.py,sha256=7xxQjFEDPHSQOxBHgcc75WzPiAxflOquwr7Z7c3erLE,2347
+dissect/cstruct/types/int.py,sha256=Ewejng5pBYnQHPtzL5W0wQMJVUPYyrY8ALES8mFaabI,1324
+dissect/cstruct/types/leb128.py,sha256=V97XTJT_Xbw1LpTwTN1OkjPHuQQAQUxd8OGuA6yEDmE,2387
+dissect/cstruct/types/packed.py,sha256=78nQWm-yylgfK3858nN-XZhO5jiqyO-piGNEyPD2ps4,2458
+dissect/cstruct/types/pointer.py,sha256=eGMrB_tTnKXKmYrcqyA_12IdukXcxRG3WOeQ1dgt7lk,3927
+dissect/cstruct/types/structure.py,sha256=_oMqkXtiF4PFHOh2eRXlkKo0Sb9T0CtrHZMvijJWtmM,37573
+dissect/cstruct/types/void.py,sha256=LCYnTcxsFPaxln36QEUxWuCZVioHRRckMuqtlm6tH54,1218
+dissect/cstruct/types/wchar.py,sha256=YwYE2T-QYYjvO-5O83_VUlzPtrjX_w0bD9Q3rtsO7sM,2870
+dissect_cstruct-5.0.dev6.dist-info/licenses/COPYRIGHT,sha256=H-18RXfshdH9AdHwW2eO1Xa-5s6tY5eipHh5c0whDu4,316
+dissect_cstruct-5.0.dev6.dist-info/licenses/LICENSE,sha256=PhUqiw6jAh2KbBdVRPBq_hfAvfcTBin7nZ3CK7NQbTM,11341
+dissect_cstruct-5.0.dev6.dist-info/METADATA,sha256=i6LEcERc5fpAuARF_fyAa5tF6dDifNqK1ME9k8w7eLg,9255
+dissect_cstruct-5.0.dev6.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+dissect_cstruct-5.0.dev6.dist-info/entry_points.txt,sha256=z53zqZqwD2OLrAkRwrP4wTeiU9CQe7xrMly0T2c0_wQ,71
+dissect_cstruct-5.0.dev6.dist-info/scm_file_list.json,sha256=qZZ_g1Xx93SzRIqQt_5slI4M_CHi3AeoUBF9uqiDfDQ,2306
+dissect_cstruct-5.0.dev6.dist-info/scm_version.json,sha256=fQVyKh0noL65fQHScjM0BBhoAJ2DxEOsu4SaVlpzeWs,162
+dissect_cstruct-5.0.dev6.dist-info/top_level.txt,sha256=Mn-CQzEYsAbkxrUI0TnplHuXnGVKzxpDw_po_sXpvv4,8
+dissect_cstruct-5.0.dev6.dist-info/RECORD,,

{dissect_cstruct-4.8.dev9.dist-info → dissect_cstruct-5.0.dev6.dist-info}/scm_file_list.json

@@ -12,12 +12,13 @@
     ".gitignore",
     "dissect/cstruct/cstruct.py",
     "dissect/cstruct/__init__.py",
-    "dissect/cstruct/exceptions.py",
     "dissect/cstruct/compiler.py",
     "dissect/cstruct/expression.py",
-    "dissect/cstruct/utils.py",
+    "dissect/cstruct/exception.py",
     "dissect/cstruct/parser.py",
+    "dissect/cstruct/lexer.py",
     "dissect/cstruct/bitbuffer.py",
+    "dissect/cstruct/util.py",
     "dissect/cstruct/types/int.py",
     "dissect/cstruct/types/__init__.py",
     "dissect/cstruct/types/leb128.py",
@@ -40,6 +41,7 @@
     "tests/test_types_union.py",
     "tests/test_tools_stubgen.py",
     "tests/test_basic.py",
+    "tests/test_lexer.py",
     "tests/test_types_int.py",
     "tests/test_expression.py",
     "tests/utils.py",

dissect_cstruct-5.0.dev6.dist-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "5.0.dev0",
+  "distance": 6,
+  "node": "g8fd15061a9f9618417a62277bc6f2d625768fdd2",
+  "dirty": true,
+  "branch": "main",
+  "node_date": "2026-07-16"
+}

dissect_cstruct-4.8.dev9.dist-info/RECORD

@@ -1,31 +0,0 @@
-dissect/cstruct/__init__.py,sha256=Z47dU_PpbZyc2ZSyu-ww-ncX6igaTw0ItVHzVgiaiKI,1380
-dissect/cstruct/bitbuffer.py,sha256=bid_N4ZsaTeC3x5Fzs8viUrldT863dMPtEDih20Nt6k,2644
-dissect/cstruct/compiler.py,sha256=uOjteLdoUIVNSX71TsBAusW8U085RRH9dXkbK3dp1vY,14203
-dissect/cstruct/cstruct.py,sha256=-qTwlvlhFME2WKlweJ8RfIOnxyevoF64N0fuE4okvzM,20409
-dissect/cstruct/exceptions.py,sha256=SX05-_HqQn8lYC7SBHv5OrYEepYRMNmRiIzVPW8bvMQ,330
-dissect/cstruct/expression.py,sha256=mf5GFGLAn_2Tz3QK86Yqoi317l8cjMcffBKzP2STE6M,10841
-dissect/cstruct/parser.py,sha256=Mk8QbkDov_xfauZnp2MqUmFGOPZlp7O2rSLYbB9S3g4,24550
-dissect/cstruct/utils.py,sha256=jSWZY8AWoLHF1W9ix-7EH2eI7pTHzLfnSfQHWH1qgKM,14190
-dissect/cstruct/tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-dissect/cstruct/tools/stubgen.py,sha256=wvl07h3VnJZWe9ygX4QMxjEH1ZcWaI_6_pSdAJoOEXk,7820
-dissect/cstruct/types/__init__.py,sha256=6P71Pu94Dv7RNjZpDZ19pqzx-G0QzmQw4q0-3zWALso,911
-dissect/cstruct/types/base.py,sha256=-NYmoX4vEfaFsnAIwQ0nZCz8X2qKEomgpnef2jB4klQ,9708
-dissect/cstruct/types/char.py,sha256=9XYCjCF0D_5o3EYnmIcjev-5GI2NzxOhd1ct1xF6SAM,2457
-dissect/cstruct/types/enum.py,sha256=vOsD99P7VLhj6vcH_ow1jmyipLP63FmqUQ9GLZ1L8Pc,7565
-dissect/cstruct/types/flag.py,sha256=7xxQjFEDPHSQOxBHgcc75WzPiAxflOquwr7Z7c3erLE,2347
-dissect/cstruct/types/int.py,sha256=MGsdUxJt-lj3nl9wzAgGX8cb_vJOtGLiCHwYZs1j_IA,1156
-dissect/cstruct/types/leb128.py,sha256=kDmsWGXX6vr1bm4uJcilsrQ7JABdQRio16rBZV21pno,2243
-dissect/cstruct/types/packed.py,sha256=tpZpb8tiSMXr1np6p0-nZqT4sY7zieO-4E16lmMmqJA,2128
-dissect/cstruct/types/pointer.py,sha256=PqeJOoNBUfMd5uO2kpF6OHeW7Q6R1N1W1V4q1MakN4I,3912
-dissect/cstruct/types/structure.py,sha256=I9LVeZ81rNE5GDT6wxpUL-PqMO31Ae6TVLLzTGyd6mM,33012
-dissect/cstruct/types/void.py,sha256=Gvh0HqI6jQSj2uesdo3J8-G41brWCz8pmP16l8xTBxE,1074
-dissect/cstruct/types/wchar.py,sha256=N9Y_XX2_hZEe2DwepJjxsB6xuRJ6zINRalcUofR59kY,2608
-dissect_cstruct-4.8.dev9.dist-info/licenses/COPYRIGHT,sha256=H-18RXfshdH9AdHwW2eO1Xa-5s6tY5eipHh5c0whDu4,316
-dissect_cstruct-4.8.dev9.dist-info/licenses/LICENSE,sha256=PhUqiw6jAh2KbBdVRPBq_hfAvfcTBin7nZ3CK7NQbTM,11341
-dissect_cstruct-4.8.dev9.dist-info/METADATA,sha256=fJPIx_vU4eO86goKEZQiuzMkhAXnMz74hkZPo2SCFTA,9255
-dissect_cstruct-4.8.dev9.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
-dissect_cstruct-4.8.dev9.dist-info/entry_points.txt,sha256=z53zqZqwD2OLrAkRwrP4wTeiU9CQe7xrMly0T2c0_wQ,71
-dissect_cstruct-4.8.dev9.dist-info/scm_file_list.json,sha256=7uE9QF1ctA5UjFpM9_OWmXeCn_A_osGyUh-6w4MJV_A,2249
-dissect_cstruct-4.8.dev9.dist-info/scm_version.json,sha256=h58edttPGk9dM9JAByXJVawy7O8spyqIVLgUpKibp5c,157
-dissect_cstruct-4.8.dev9.dist-info/top_level.txt,sha256=Mn-CQzEYsAbkxrUI0TnplHuXnGVKzxpDw_po_sXpvv4,8
-dissect_cstruct-4.8.dev9.dist-info/RECORD,,

dissect_cstruct-4.8.dev9.dist-info/scm_version.json

@@ -1,8 +0,0 @@
-{
-  "tag": "4.7",
-  "distance": 9,
-  "node": "g91f2347ef234a41eb3ea6ae55defb9e80379e12a",
-  "dirty": true,
-  "branch": "main",
-  "node_date": "2026-07-06"
-}