feat: add more integer types

TODO: consider Python ctypes

Author: MrIndeciso

libdestruct/c/__init__.py

@@ -4,12 +4,9 @@
 # Licensed under the MIT license. See LICENSE file in the project root for details.
 #
 
-from libdestruct.c.c_int import c_int
-from libdestruct.c.c_long import c_long
+from libdestruct.c.c_integer_types import c_char, c_int, c_long, c_short, c_uchar, c_uint, c_ulong, c_ushort
 from libdestruct.c.c_str import c_str
-from libdestruct.c.c_uint import c_uint
-from libdestruct.c.c_ulong import c_ulong
 
-__all__ = ["c_int", "c_long", "c_str", "c_uint", "c_ulong"]
+__all__ = ["c_char", "c_uchar", "c_short", "c_ushort", "c_int", "c_uint", "c_long", "c_ulong", "c_str"]
 
 import libdestruct.c.base_type_inflater  # noqa: F401

libdestruct/c/base_type_inflater.py

@@ -6,16 +6,17 @@
 
 from __future__ import annotations
 
-from libdestruct.c.c_int import c_int
-from libdestruct.c.c_long import c_long
+from libdestruct.c.c_integer_types import c_char, c_int, c_long, c_short, c_uchar, c_uint, c_ulong, c_ushort
 from libdestruct.c.c_str import c_str
-from libdestruct.c.c_uint import c_uint
-from libdestruct.c.c_ulong import c_ulong
 from libdestruct.common.type_registry import TypeRegistry
 
 registry = TypeRegistry()
 
 
+registry.register_mapping(c_char, c_char)
+registry.register_mapping(c_uchar, c_uchar)
+registry.register_mapping(c_short, c_short)
+registry.register_mapping(c_ushort, c_ushort)
 registry.register_mapping(c_int, c_int)
 registry.register_mapping(c_uint, c_uint)
 registry.register_mapping(c_long, c_long)

libdestruct/c/c_int.py

@@ -0,0 +1,125 @@
+#
+# This file is part of libdestruct (https://github.com/mrindeciso/libdestruct).
+# Copyright (c) 2024 Roberto Alessandro Bertolini. All rights reserved.
+# Licensed under the MIT license. See LICENSE file in the project root for details.
+#
+
+from __future__ import annotations
+
+from libdestruct.common.obj import obj
+
+
+class _c_integer(obj):
+    """A generic C integer, to be subclassed by signed and unsigned integers."""
+
+    size: int
+    """The size of an integer in bytes."""
+
+    signed: bool
+    """Whether the integer is signed."""
+
+    _frozen_value: int | None = None
+    """The frozen value of the integer."""
+
+    def get(self: _c_integer) -> int:
+        """Return the value of the integer."""
+        return int.from_bytes(self.memory[self.address : self.address + self.size], self.endianness, signed=self.signed)
+
+    def to_bytes(self: _c_integer) -> bytes:
+        """Return the serialized representation of the object."""
+        if self._frozen:
+            return self._frozen_value.to_bytes(self.size, self.endianness, signed=self.signed)
+
+        return self.memory[self.address : self.address + self.size]
+
+    def _set(self: _c_integer, value: int) -> None:
+        """Set the value of the integer to the given value."""
+        self.memory[self.address : self.address + self.size] = value.to_bytes(
+            self.size,
+            self.endianness,
+            signed=self.signed,
+        )
+
+    def __int__(self: _c_integer) -> int:
+        """Return the value of the integer."""
+        return self.get()
+
+
+class c_char(_c_integer):
+    """A C char."""
+
+    size: int = 1
+    """The size of a char in bytes."""
+
+    signed: bool = True
+    """Whether the char is signed."""
+
+
+class c_uchar(_c_integer):
+    """A C unsigned char."""
+
+    size: int = 1
+    """The size of a char in bytes."""
+
+    signed: bool = False
+    """Whether the char is signed."""
+
+
+class c_short(_c_integer):
+    """A C short."""
+
+    size: int = 2
+    """The size of a short in bytes."""
+
+    signed: bool = True
+    """Whether the short is signed."""
+
+
+class c_ushort(_c_integer):
+    """A C unsigned short."""
+
+    size: int = 2
+    """The size of a short in bytes."""
+
+    signed: bool = False
+    """Whether the short is signed."""
+
+
+class c_int(_c_integer):
+    """A C integer."""
+
+    size: int = 4
+    """The size of an integer in bytes."""
+
+    signed: bool = True
+    """Whether the integer is signed."""
+
+
+class c_uint(_c_integer):
+    """A C unsigned integer."""
+
+    size: int = 4
+    """The size of an integer in bytes."""
+
+    signed: bool = False
+    """Whether the integer is signed."""
+
+
+class c_long(_c_integer):
+    """A C long."""
+
+    size: int = 8
+    """The size of a long in bytes."""
+
+    signed: bool = True
+    """Whether the long is signed."""
+
+
+class c_ulong(_c_integer):
+    """A C unsigned long."""
+
+    size: int = 8
+    """The size of a long in bytes."""
+
+    signed: bool = False
+    """Whether the long is signed."""

libdestruct/c/c_integer_types.py

@@ -20,7 +20,7 @@ class obj(ABC):
     """The address of the object in the memory view."""
 
     endianness: str = "little"
-    """The endianness of the backing refenrece view."""
+    """The endianness of the backing reference view."""
 
     memory: MutableSequence
     """The backing memory view."""
@@ -86,6 +86,18 @@ def freeze(self: obj) -> None:
         self._frozen_value = self.get()
         self._frozen = True
 
+    def diff(self: obj) -> tuple[object, object]:
+        """Return the difference between the current value and the frozen value."""
+        return self._frozen_value, self.get()
+
+    def reset(self: obj) -> None:
+        """Reset the object to its frozen value."""
+        self._set(self._frozen_value)
+
+    def update(self: obj) -> None:
+        """Update the object with the given value."""
+        self._frozen_value = self.get()
+
     @property
     def value(self: obj) -> object:
         """Return the value of the object."""
@@ -105,6 +117,10 @@ def to_str(self: obj, indent: int = 0) -> str:
         """Return a string representation of the object."""
         return f"{' ' * indent}{self.get()}"
 
+    def pdiff(self: obj) -> str:
+        """Return a string representation of the difference between the current value and the frozen value."""
+        return f"{self._frozen_value} -> {self.get()}"
+
     def __str__(self: obj) -> str:
         """Return a string representation of the object."""
         return self.to_str()