Minor fixes and improvements (#45)

* "Normative points" renamed to "requirements"
 * `__copy__ ` and `__deepcopy__` operators implemented
 * Type hinting fixes

Author: Intuity

packtype/grammar/declarations.py

@@ -16,7 +16,7 @@
 from ..types.base import Base
 from ..types.constant import Constant
 from ..types.enum import Enum, EnumMode
-from ..types.normative import NormativePoint, Priority
+from ..types.requirement import Priority, RequirementTag
 from ..types.scalar import Scalar
 from ..types.struct import Struct
 from ..types.union import Union
@@ -407,8 +407,8 @@ def to_class(
 
 
 @dataclass
-class DeclNormative:
-    """Represents a normative point declaration."""
+class DeclRequirement:
+    """Represents a requirement tag declaration."""
 
     position: Position
     name: str
@@ -423,9 +423,10 @@ def to_class(
             ],
             int | type[Base],
         ],
-    ) -> type[NormativePoint]:
-        entity = build_from_fields(NormativePoint, self.name, {}, {"priority": self.priority})
+    ) -> type[RequirementTag]:
+        entity = build_from_fields(RequirementTag, self.name, {}, {"priority": self.priority})
         entity.__doc__ = str(self.description) if self.description else None
+        entity.priority = self.priority
         return entity
 
 

packtype/grammar/grammar.py

@@ -21,8 +21,8 @@
     DeclEnum,
     DeclImport,
     DeclInstance,
-    DeclNormative,
     DeclPackage,
+    DeclRequirement,
     DeclScalar,
     DeclStruct,
     DeclUnion,
@@ -227,7 +227,7 @@ def _resolve(ref: str | ForeignRef) -> int:
                     package._pt_attach(obj := decl.to_class(source, _resolve))
                     # Remember this type
                     known_entities[decl.name] = (obj, decl.position)
-                case DeclNormative():
+                case DeclRequirement():
                     # Check for name collisions
                     _check_collision(decl.name)
                     obj = decl.to_class(_resolve)

packtype/grammar/packtype.lark

@@ -73,7 +73,7 @@ modifier: "@" name "=" (name | ESCAPED_STRING | NUMERIC)
             | decl_enum
             | decl_struct
             | decl_union
-            | decl_normative
+            | decl_requirement
 
 // =============================================================================
 // Package
@@ -213,16 +213,16 @@ decl_union: "union"i name "{" descr? modifier* field* "}"
 
 
 // =============================================================================
-// Normative Points
+// Requirement Tags
 //
-// vnorm my_feature : P1 "This feature is high priority"
+// requirement my_feature : P1 "This feature is high priority"
 //
 // =============================================================================
 
 // Priority keywords
 PRIORITY: /P[0-9]+/
 
-decl_normative: "vnorm"i name ":" PRIORITY descr?
+decl_requirement: "requirement"i name ":" PRIORITY descr?
 
 // =============================================================================
 // Expressions
@@ -241,7 +241,10 @@ expr: expr_term (OPERATOR expr_term)*
 expr_funcs: name "(" (expr ","?)* ")"
 
 NUMERIC: HEX | BINARY | DECIMAL
-HEX: (/\b0x[0-9a-f]+\b/i)
+
+// Allowing the following format 0x0000_0000_...
+HEX: (/\b0x[0-9a-f]+(?:_[0-9a-f]+)*\b/i)
+
 BINARY: (/\b0b[0-1]+\b/)
 DECIMAL: SIGN? /\b[0-9]+\b/
 OPERATOR: SIGN

packtype/grammar/transformer.py

@@ -12,7 +12,7 @@
 from ..common.expression import Expression, ExpressionFunction
 from ..types.assembly import Packing
 from ..types.enum import EnumMode
-from ..types.normative import Priority
+from ..types.requirement import Priority
 from .declarations import (
     DeclAlias,
     DeclConstant,
@@ -21,8 +21,8 @@
     DeclField,
     DeclImport,
     DeclInstance,
-    DeclNormative,
     DeclPackage,
+    DeclRequirement,
     DeclScalar,
     DeclStruct,
     DeclUnion,
@@ -307,8 +307,8 @@ def decl_union(self, meta, body):
         return DeclUnion(Position(meta.line, meta.column), name, description, mods, remainder)
 
     @v_args(meta=True)
-    def decl_normative(self, meta, body):
-        """Transform a normative point declaration."""
+    def decl_requirement(self, meta, body):
+        """Transform a requirement tag declaration."""
         name, priority_token, *remainder = body
         if remainder and isinstance(remainder[0], Description):
             descr, *remainder = remainder
@@ -317,7 +317,7 @@ def decl_normative(self, meta, body):
 
         priority = Priority[priority_token.value.upper()]
 
-        return DeclNormative(Position(meta.line, meta.column), name, priority, descr)
+        return DeclRequirement(Position(meta.line, meta.column), name, priority, descr)
 
     def variant_default(self, body):
         return VariantCondition(conditions=None)

packtype/types/array.py

@@ -5,7 +5,12 @@
 import functools
 import math
 from collections.abc import Callable, Iterable
-from typing import Any, Self
+from typing import Any
+
+try:
+    from typing import Self
+except ImportError:
+    from typing_extensions import Self  # noqa: UP035
 
 from .bitvector import BitVector, BitVectorWindow
 from .numeric import Numeric
@@ -190,6 +195,20 @@ def __str__(self) -> str:
             lines.append(f"- Entry[{i}]: {self._pt_entries[i]!s}")
         return "\n".join(lines)
 
+    def __copy__(self) -> "PackedArray":
+        """
+        Copy this object by unpacking and then packing it again.
+        :return: A copy of this object
+        """
+        return self._pt_spec._pt_unpack(self._pt_pack())
+
+    def __deepcopy__(self, _memo: dict) -> "PackedArray":
+        """
+        Reuse __copy__,
+        which should already be a deep copy for objects that pack and unpack cleanly.
+        """
+        return self.__copy__()
+
 
 class UnpackedArray:
     def __init__(

packtype/types/assembly.py

@@ -8,6 +8,11 @@
 from textwrap import indent
 from typing import Any
 
+try:
+    from typing import Self
+except ImportError:
+    from typing_extensions import Self  # noqa: UP035
+
 from ..svg.render import ElementStyle, SvgConfig, SvgField, SvgRender
 from .array import ArraySpec, PackedArray
 from .base import Base
@@ -123,7 +128,8 @@ def __getattribute__(self, fname: str):
                 return finst
             # Is this the padding field?
             elif fname == "_padding" and self._PT_PADDING > 0:
-                padding = Scalar[self._PT_PADDING](_pt_bv=self._pt_bv)
+                lsb, msb = self._PT_RANGES["_padding"]
+                padding = Scalar[self._PT_PADDING](_pt_bv=self._pt_bv.create_window(msb, lsb))
                 self._pt_force_set("_padding", padding)
                 return padding
             # If not resolved, forward the attribute error
@@ -382,7 +388,7 @@ def _pt_pack(self) -> int:
         return int(self._pt_bv)
 
     @classmethod
-    def _pt_unpack(cls, packed: int) -> "PackedAssembly":
+    def _pt_unpack(cls, packed: int) -> Self:
         inst = cls()
         inst._pt_set(packed)
         return inst

packtype/types/base.py

@@ -117,13 +117,3 @@ def _list_objs():
                     print(f"{cnt:10d}: {obj}")  # noqa: T201
 
         atexit.register(_list_objs)
-
-    def __copy__(self) -> Self:
-        raise NotImplementedError(
-            "Please use packtype.utils.basic.copy() to copy a Packtype definition"
-        )
-
-    def __deepcopy__(self, _memo: dict[int, Any]) -> Self:
-        raise NotImplementedError(
-            "Please use packtype.utils.basic.copy() to copy a Packtype definition"
-        )

packtype/types/enum.py

@@ -6,6 +6,11 @@
 import math
 from typing import Any
 
+try:
+    from typing import Self
+except ImportError:
+    from typing_extensions import Self  # noqa: UP035
+
 from .base import Base
 from .bitvector import BitVector, BitVectorWindow
 from .constant import Constant
@@ -154,8 +159,12 @@ def _pt_as_dict(cls) -> dict[str, int]:
         return {n: int(v) for v, n in cls._PT_LKP_INST.items()}
 
     @classmethod
-    def _pt_cast(cls, value: int) -> None:
+    def _pt_cast(cls, value: int) -> Self:
         if value in cls._PT_LKP_VALUE:
             return cls._PT_LKP_VALUE[value]
         else:
             return cls(value)
+
+    @classmethod
+    def _pt_unpack(cls, packed: int) -> Self:
+        return cls._pt_cast(packed)

packtype/types/numeric.py

@@ -3,6 +3,12 @@
 #
 
 
+try:
+    from typing import Self
+except ImportError:
+    from typing_extensions import Self  # noqa: UP035
+
+
 class Numeric:
     def __int__(self) -> int:
         raise NotImplementedError("Subclass must implement __int__")
@@ -248,3 +254,26 @@ def __ge__(self, other) -> bool:
 
     def __hash__(self) -> int:
         return id(self)
+
+    @classmethod
+    def _pt_unpack(cls, _packed: int) -> Self:
+        """
+        Unpack the object from an integer
+        :param packed: The value to unpack
+        :return: The unpacked object
+        """
+        raise NotImplementedError
+
+    def __copy__(self) -> Self:
+        """
+        Copy this object by unpacking and then packing it again
+        :return: A copy of this object
+        """
+        return self._pt_unpack(int(self))
+
+    def __deepcopy__(self, _memo: dict) -> Self:
+        """
+        Reuse __copy__,
+        which should already be a deep copy for objects that pack and unpack cleanly.
+        """
+        return self.__copy__()

packtype/types/package.py

@@ -13,8 +13,8 @@
 from .base import Base
 from .constant import Constant
 from .enum import Enum
-from .normative import NormativePoint
 from .primitive import NumericType
+from .requirement import RequirementTag
 from .scalar import ScalarType
 from .struct import Struct
 from .union import Union
@@ -24,13 +24,13 @@
 class Package(Base):
     _PT_ALLOW_DEFAULTS: list[type[Base]] = [Constant]
     _PT_FIELDS: dict
-    _PT_NORMS: dict
+    _PT_REQUIREMENTS: dict
 
     @classmethod
     def _pt_construct(cls, parent: Base) -> None:
         super()._pt_construct(parent)
         cls._PT_FIELDS = {}
-        cls._PT_NORMS = {}
+        cls._PT_REQUIREMENTS = {}
         for fname, ftype, fval in cls._pt_definitions():
             if inspect.isclass(ftype) and issubclass(ftype, Constant):
                 cls._pt_attach_constant(fname, ftype(default=fval))
@@ -45,9 +45,9 @@ def _pt_attach_constant(cls, fname: str, finst: Constant) -> Constant:
         return finst
 
     @classmethod
-    def _pt_attach_norm(cls, fname: str, finst: NormativePoint) -> NormativePoint:
+    def _pt_attach_norm(cls, fname: str, finst: RequirementTag) -> RequirementTag:
         finst._PT_ATTACHED_TO = cls
-        cls._PT_NORMS[fname] = finst
+        cls._PT_REQUIREMENTS[fname] = finst
         cls._PT_FIELDS[finst] = finst
         setattr(cls, fname, finst)
         return finst
@@ -170,8 +170,11 @@ def _pt_unions(self) -> Iterable[tuple[str, Union]]:
         return self._pt_filter_for_class(Union)
 
     @property
-    def _pt_norms(self) -> Iterable[tuple[str, NormativePoint]]:
-        return ((vnorm_name, vnorm_inst) for vnorm_name, vnorm_inst in self._PT_NORMS.items())
+    def _pt_reqs(self) -> Iterable[tuple[str, RequirementTag]]:
+        return (
+            (requirement_name, requirement_inst)
+            for requirement_name, requirement_inst in self._PT_REQUIREMENTS.items()
+        )
 
     @property
     def _pt_structs_and_unions(self) -> Iterable[tuple[str, Struct | Union]]: