zuspec-dataclasses 0.0.1.18247735261rc0__py3-none-any.whl → 0.0.1.18517051305rc0__py3-none-any.whl

zuspec/dataclasses/__init__.py

@@ -14,23 +14,15 @@
 # limitations under the License.
 #****************************************************************************
 # from .activity_stmts import *
-from .decorators import dataclass, field, export, extern, process, input, output, sync, const, port, export, bind
-from .tlm import *
-# from .claims_refs import *
-# from .shared_stmts import *
-# from .types import *
-# from .core_lib import *
-# from vsc_dataclasses.expr import *
-
-from . import api
-from . import std
+from asyncio import Event
+from .decorators import (
+    dataclass, field, export, extern, mirror, process, input, output, 
+    sync, const, port, export, bind, Exec, ExecKind, ExecSync, 
+    Output, FSM, ExecState, fsm, binder
+)
+from .types import *
+#from .tlm import *
 
-from .bit import Bit
-from .action import Action
-from .std.clock_reset import ClockReset
-from .component import Component
-from .exec import ExecSync, Exec
-from .struct import Struct, ZuspecTypeBase
-from .ports import Input, Output, Port
+#from . import api
+#from . import std
 
-from asyncio import Event

zuspec/dataclasses/__version__.py

@@ -15,5 +15,5 @@
 # limitations under the License.
 #****************************************************************************
 BASE="0.0.1"
-SUFFIX=".18247735261rc0"
+SUFFIX=".18517051305rc0"
 VERSION="%s%s" % (BASE, SUFFIX)

zuspec/dataclasses/api/visitor.py

@@ -18,11 +18,6 @@ import logging
 from dataclasses import Field, MISSING
 from typing import Callable, ClassVar, Dict, Type, List, Tuple
 from ..annotation import Annotation
-from ..bit import Bit
-from ..component import Component
-from ..exec import Exec, ExecKind, ExecSync
-from ..ports import Input, Output
-from ..struct import Extern, Struct
 import inspect
 import ast
 import textwrap

zuspec/dataclasses/decorators.py

@@ -19,9 +19,7 @@
 import dataclasses
 import dataclasses as dc
 import enum
-import inspect
-import typing
-from typing import Any, Callable, Dict, Optional, Self, TypeVar, TYPE_CHECKING, Union
+from typing import Any, Callable, Dict, Optional, Self, TypeVar, TYPE_CHECKING, Union, TypeVarTuple, Generic
 from .annotation import Annotation, AnnotationSync
 
 
@@ -38,7 +36,7 @@ def dataclass(cls, **kwargs):
             print("TODO: annotate field")
             cls_annotations[name] = int
 
-    cls_t = dc.dataclass(cls, **kwargs)
+    cls_t = dc.dataclass(cls, kw_only=True, **kwargs)
 
     setattr(cls_t, "__base_init__", getattr(cls_t, "__init__"))
     def local_init(self, tp : 'TypeProcessor', *args, **kwargs):
@@ -53,7 +51,6 @@ def dataclass(cls, **kwargs):
             return tp.new(c, *args, **kwargs)
         setattr(cls_t, "__new__", local_new)
 
-
     return cls_t
 
 def bundle():
@@ -62,76 +59,28 @@ def bundle():
 def mirror():
     return dc.field()
 
-class BitLiteral(int):
-    width : int = 1
-    def __getitem__(self, v) -> 'BitLiteral':
-        return self
-        pass
-    pass
+def monitor():
+    return dc.field()
 
-def bit(t : int) -> BitLiteral:
-    return BitLiteral(t)
-
-def val(t : int) -> int:
-    return t
-
-def always(instr : BitLiteral):
-   match instr[0:1]:
-      case bit(0):
-        match instr[13:15]:
-           case bit(0):
-              pass
-           case bit(2):
-              pass
-    # unique case (instr_i[1:0])
-    #   // C0
-    #   2'b00: begin
-    #     unique case (instr_i[15:13])
-    #       3'b000: begin
-    #         // c.addi4spn -> addi rd', x2, imm
-    #         instr_o = {2'b0, instr_i[10:7], instr_i[12:11], instr_i[5],
-    #                    instr_i[6], 2'b00, 5'h02, 3'b000, 2'b01, instr_i[4:2], {OPCODE_OP_IMM}};
-    #         if (instr_i[12:5] == 8'b0)  illegal_instr_o = 1'b1;
-    #       end
-
-    #       3'b010: begin
-    #         // c.lw -> lw rd', imm(rs1')
-    #         instr_o = {5'b0, instr_i[5], instr_i[12:10], instr_i[6],
-    #                    2'b00, 2'b01, instr_i[9:7], 3'b010, 2'b01, instr_i[4:2], {OPCODE_LOAD}};
-    #       end
-
-    #       3'b110: begin
-    #         // c.sw -> sw rs2', imm(rs1')
-    #         instr_o = {5'b0, instr_i[5], instr_i[12], 2'b01, instr_i[4:2],
-    #                    2'b01, instr_i[9:7], 3'b010, instr_i[11:10], instr_i[6],
-    #                    2'b00, {OPCODE_STORE}};
-    #       end
-
-    #       3'b001,
-    #       3'b011,
-    #       3'b100,
-    #       3'b101,
-    #       3'b111: begin
-    #         illegal_instr_o = 1'b1;
-    #       end
-
-    #       default: begin
-    #         illegal_instr_o = 1'b1;
-    #       end
-    #     endcase
-
-a = bit(20)[3:4] 
-
-SelfT = TypeVar('SelfT')
-T = TypeVar('T')
-
-class bind[T]:
-    def __init__(self, c : Callable[[T],Dict[Any,Any]]):
+BindT = TypeVarTuple('BindT')
+
+#class bind(Generic[*BindT]):
+#    """Helper class for specifying binds. Ensures that the parameter
+#     passed to the lambda is identified as the class type
+#    """
+#    def __init__(self, c : Callable[[*BindT],Dict[Any,Any]]):
+#        self._c = c
+
+class bind[Ts,Ti]:
+    """Helper class for specifying binds. Ensures that the parameter
+     passed to the lambda is identified as the class type.
+    """
+    def __init__(self, c : Callable[[Ts,Ti],Dict[Any,Any]]):
         self._c = c
-    def __call__(self, s) -> Dict[Any,Any]:
-        return self._c(s)
-    
-#a = bind2(lambda s:{s.}, selfT=Self)
+
+class binder(object):
+    def __init__(self, c : Callable):
+        pass
 
 def field(
         rand=False, 
@@ -189,9 +138,13 @@ def field(
     # # TODO: 
     # return dc.field()
 
-class Input(object): pass
+class Input(object): 
+    """Marker type for 'input' dataclass fields"""
+    ...
 
-class Output(object): pass
+class Output(object):
+    """Marker type for 'output' dataclass fields"""
+    ...
 
 def input(*args, **kwargs):
     """
@@ -231,9 +184,9 @@ class ExecKind(enum.Enum):
 @dc.dataclass
 class Exec(object):
     method : Callable = dc.field()
-    kind : ExecKind = dc.field()
-    timebase : Optional[Callable] = field(default=None)
-    t : Optional[Callable] = field(default=None)
+#    kind : ExecKind = dc.field()
+#    timebase : Optional[Callable] = field(default=None)
+#    t : Optional[Callable] = field(default=None)
 
 def extern(
     typename,
@@ -251,12 +204,14 @@ def extern(
                         files=files,
                         params=params))
 
+class ExecProc(Exec): pass
+
 def process(T):
     """
     Marks an always-running process. The specified
     method must be `async` and take no arguments
     """
-    return Exec(T, ExecKind.Proc)
+    return ExecProc(T)
 
 def reg(offset=0):
     return dc.field()
@@ -293,7 +248,7 @@ def sync(clock : Callable, reset : Callable):
     each time _update is evaluated.
     """
     def __call__(T):
-        return ExecSync(method=T, kind=ExecKind.Sync, clock=clock, reset=reset)
+        return ExecSync(method=T, clock=clock, reset=reset)
     return __call__
 
 def comb(latch : bool=False):
@@ -305,147 +260,34 @@ def comb(latch : bool=False):
         return Exec(method=T, kind=ExecKind.Comb, )
     return __call__
 
+@dc.dataclass
+class ExecState(Exec): pass
+
+class FSM(object):
+    """Declares a method-based FSM"""
+    state : ExecState = field(default_factory=ExecState)
+
+class fsm(object):
+
+    def __new__(cls, 
+                 initial : ExecState,
+                 clock : Optional[Callable] = None,
+                 reset : Optional[Callable] = None) -> dc.Field:
+        """Defines the parameters of an FSM field"""
+        return dc.field(
+            metadata=dict(initial=initial, clock=clock, reset=reset),
+            default_factory=FSM)
+
+    @staticmethod
+    def state(T):
+        """Decorates an FSM state method. A state method is automatically
+        invoked on an active clock edge when the state machine that this
+        method is a member of is in the appropriate state. FSM state 
+        methods are non-blocking assignment regions just like sync exec blocks.
+        State methods cannot be called directly"""
+        return ExecState(method=T)
 
-# def action(*args, **kwargs): 
-#     if len(args) == 1 and len(kwargs) == 0 and callable(args[0]):
-#         # No-argument form
-#         return ActionDecoratorImpl([], {})(args[0])
-#     else:
-#         # Argument form
-#         return ActionDecoratorImpl(args, kwargs)
-    
-# def activity(*args, **kwargs):
-#     if len(args) == 1 and len(kwargs) == 0 and callable(args[0]):
-#         # No-argument form
-#         return ActivityDecoratorImpl([], {})(args[0])
-#     else:
-#         return ActivityDecoratorImpl(args, kwargs)
-
-# def component(*args, **kwargs):
-#     if len(args) == 1 and len(kwargs) == 0 and callable(args[0]):
-#         # No-argument form
-#         return ComponentDecoratorImpl([], {})(args[0])
-#     else:
-#         return ComponentDecoratorImpl(args, kwargs)
 
 def constraint(T):
     setattr(T, "__constraint__", True)
     return T
-    
- # def constraint(*args, **kwargs):
-# #     if len(args) == 1 and len(kwargs) == 0 and callable(args[0]):
-# #         # No-argument form
-# #         return ConstraintDecoratorImpl({})(args[0])
-# #     else:
-# #         return ConstraintDecoratorImpl(kwargs)
-
-# def buffer(*args, **kwargs): 
-#     if len(args) == 1 and len(kwargs) == 0 and callable(args[0]):
-#         # No-argument form
-#         return StructDecoratorImpl(StructKindE.Buffer, [], {})(args[0])
-#     else:
-#         return ActionDecoratorImpl(StructKindE.Buffer, args, kwargs)
-    
-# def resource(*args, **kwargs): 
-#     if len(args) == 1 and len(kwargs) == 0 and callable(args[0]):
-#         # No-argument form
-#         return StructDecoratorImpl(StructKindE.Resource, [], {})(args[0])
-#     else:
-#         return StructDecoratorImpl(StructKindE.Resource, [], kwargs)
-    
-# def state(*args, **kwargs): 
-#     if len(args) == 1 and len(kwargs) == 0 and callable(args[0]):
-#         # No-argument form
-#         return StructDecoratorImpl(StructKindE.State, {})(args[0])
-#     else:
-#         return ActionDecoratorImpl(StructKindE.State, kwargs)
-    
-# def stream(*args, **kwargs): 
-#     if len(args) == 1 and len(kwargs) == 0 and callable(args[0]):
-#         # No-argument form
-#         return StructDecoratorImpl(StructKindE.Stream, {})(args[0])
-#     else:
-#         return ActionDecoratorImpl(StructKindE.Stream, kwargs)
-    
-# def struct(*args, **kwargs): 
-#     if len(args) == 1 and len(kwargs) == 0 and callable(args[0]):
-#         # No-argument form
-#         return StructDecoratorImpl(StructKindE.Struct, [], {})(args[0])
-#     else:
-#         return ActionDecoratorImpl(StructKindE.Struct, args, kwargs)
-
-# class exec(object):
-#     @staticmethod
-#     def body(*args, **kwargs):
-#         if len(args) == 1 and len(kwargs) == 0 and callable(args[0]):
-#             # No-argument form
-#             return ExecDecoratorImpl(ExecKindE.Body, [], {})(args[0])
-#         else:
-#             return ExecDecoratorImpl(ExecKindE.Body, args, kwargs)
-        
-#     @staticmethod
-#     def init_down(*args, **kwargs):
-#         if len(args) == 1 and len(kwargs) == 0 and callable(args[0]):
-#             # No-argument form
-#             return ExecDecoratorImpl(ExecKindE.InitDown, [], {})(args[0])
-#         else:
-#             return ExecDecoratorImpl(ExecKindE.InitDown, args, kwargs)
-        
-#     @staticmethod
-#     def init_up(*args, **kwargs):
-#         if len(args) == 1 and len(kwargs) == 0 and callable(args[0]):
-#             # No-argument form
-#             return ExecDecoratorImpl(ExecKindE.InitUp, [], {})(args[0])
-#         else:
-#             return ExecDecoratorImpl(ExecKindE.InitUp, args, kwargs)
-        
-#     @staticmethod
-#     def pre_solve(*args, **kwargs):
-#         if len(args) == 1 and len(kwargs) == 0 and callable(args[0]):
-#             # No-argument form
-#             return ExecDecoratorImpl(ExecKindE.PreSolve, [], {})(args[0])
-#         else:
-#             return ExecDecoratorImpl(ExecKindE.PreSolve, args, kwargs)
-        
-#     @staticmethod
-#     def post_solve(*args, **kwargs):
-#         if len(args) == 1 and len(kwargs) == 0 and callable(args[0]):
-#             # No-argument form
-#             return ExecDecoratorImpl(ExecKindE.PostSolve, [], {})(args[0])
-#         else:
-#             return ExecDecoratorImpl(ExecKindE.PostSolve, args, kwargs)
-
-# class extend(object):
-#     @staticmethod
-#     def action(target, *args, **kwargs):
-#         return ExtendActionDecoratorImpl(target, args, kwargs)
-
-#     @staticmethod
-#     def component(target, *args, **kwargs):
-#         return ExtendComponentDecoratorImpl(target, args, kwargs)
-
-# class extern(object):
-
-#     # TODO:    
-#     @staticmethod
-#     def action(*args, **kwargs):
-#         raise NotImplementedError("extern.action not implemented")
-#         if len(args) == 1 and len(kwargs) == 0 and callable(args[0]):
-#             # No-argument form
-#             return ExecDecoratorImpl(ExecKindE.PreSolve, {})(args[0])
-#         else:
-#             return ExecDecoratorImpl(ExecKindE.PreSolve, kwargs)
-
-# def fn(*args, **kwargs): 
-#     if len(args) == 1 and len(kwargs) == 0 and callable(args[0]):
-#         # No-argument form
-#         return FnDecoratorImpl(False, {})(args[0])
-#     else:
-#         return FnDecoratorImpl(False, kwargs)
-
-# def import_fn(*args, **kwargs): 
-#     if len(args) == 1 and len(kwargs) == 0 and callable(args[0]):
-#         # No-argument form
-#         return FnDecoratorImpl(True, {})(args[0])
-#     else:
-#         return FnDecoratorImpl(True, kwargs)

zuspec/dataclasses/std/clock_reset.py

@@ -14,9 +14,8 @@
 # limitations under the License.
 #****************************************************************************
 import abc
-from ..component import Component
+from ..types import Bit, Component
 from ..decorators import dataclass, field, output
-from ..bit import Bit
 
 @dataclass
 class ClockReset(Component):

zuspec/dataclasses/std/timebase.py

@@ -16,8 +16,7 @@
 import abc
 from typing import Protocol, TYPE_CHECKING
 from ..decorators import dataclass
-from ..bit import Bit
-from ..component import Component
+from ..types import Bit, Component
 
 class TimeBase(Protocol):
     """

zuspec/dataclasses/types.py

@@ -0,0 +1,204 @@
+#****************************************************************************
+# Copyright 2019-2025 Matthew Ballance and contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#****************************************************************************
+import abc
+from typing import Dict, Generic, Optional, TypeVar, Literal, Type
+from .decorators import dataclass, field
+
+@dataclass
+class TypeBase(object):
+    """Marker for all Zuspec types"""
+    pass
+
+class BitMeta(type):
+    """
+    The BitMeta class is a constructor for Bit types.
+    Bit[12], for example, produces a Bit type where
+    W=12.
+    """
+
+    def __new__(cls, name, bases, attrs):
+        return super().__new__(cls, name, bases, attrs)
+    
+    def __init__(self, name, bases, attrs):
+        super().__init__(name, bases, attrs)
+        self.type_m : Dict = {}
+    
+    def __getitem__(self, W : int):
+        if W in self.type_m.keys():
+            return self.type_m[W]
+        else:
+            t = type("bit[%d]" % W, (Bit,), {
+                "W" : W
+            })
+            self.type_m[W] = t
+            return t
+
+# class BitLiteral(int):
+#     W : int = 1
+
+#     def __new__(cls, )
+
+#     def __getitem__(self, v) -> 'BitLiteral':
+#         return self
+#         pass
+#     pass
+
+class Bit(int, metaclass=BitMeta):
+    """
+    Variables of 'Bit' type represent unsigned W-bit values.
+    The value of the variables is automatically masked. For 
+    example, assigning 20 (b10100) to a 4-bit variable will 
+    result in 4 (b0100) being stored in the variable.
+    """
+    W : int = 1
+
+    def __new__(cls, val : int=0):
+        return super(Bit, cls).__new__(cls, val)
+
+class Bits(int, metaclass=BitMeta):
+    W : int = -1
+
+    def __new__(cls, val : int=0):
+        return super(Bits, cls).__new__(cls, val)
+
+class IntMeta(type):
+    """
+    The IntMeta class is a constructor for Int types.
+    Int[12], for example, produces a Int type where
+    W=12.
+    """
+
+    def __new__(cls, name, bases, attrs):
+        return super().__new__(cls, name, bases, attrs)
+    
+    def __init__(self, name, bases, attrs):
+        super().__init__(name, bases, attrs)
+        self.type_m : Dict = {}
+    
+    def __getitem__(self, W : int):
+        if W in self.type_m.keys():
+            return self.type_m[W]
+        else:
+            t = type("bit[%d]" % W, (Bit,), {
+                "W" : W
+            })
+            self.type_m[W] = t
+            return t
+
+class Int(TypeBase, metaclass=IntMeta):
+    """
+    Variables of 'Int' type represent signed W-bit values.
+    The value of the variables is automatically masked. For 
+    example, assigning 20 (b10100) to a 4-bit variable will 
+    result in 4 (b0100) being stored in the variable. Note
+    that this may change the size of the variable.
+    """
+    W : int = -1
+
+@dataclass
+class Bundle(TypeBase):
+    """
+    A bundle type collects one or more ports, exports,
+    inputs, outputs, or bundles. 
+
+    Bundle fields are created with field(). Bundle-mirror
+    fields are created with mirror() or field(mirror=True)
+    Bundle-monitor fields are created with monitor() or
+    field(monitor=True)
+
+    A bundle field can be connected to a mirror field. 
+    A bundle monitor field can be connected to both a 
+    bundle and a bundle mirror.
+    - Bundle
+    - Bundle Mirror
+    - Bundle Monitor (all are inputs / exports)
+    """
+    pass
+
+@dataclass
+class StructPacked(TypeBase):
+    """
+    StructPacked types are fixed-size data structures. 
+    Fields may only be of a fixed size. 
+
+    Valid sub-regions
+    - constraint
+    - pre_solve / post_solve
+    """
+    pass
+
+@dataclass
+class Struct(TypeBase):
+    """
+    Struct types are data structures that may contain
+    variable-size fields. 
+
+    Valid sub-regions
+    - constraint
+    - pre_solve / post_solve
+    - method
+    """
+
+@dataclass
+class Component(Struct):
+    """
+    Component classes are structural in nature. 
+    The lifecycle of a component tree is as follows:
+    - The root component and fields of component type are constructed
+    - The 'init_down' method is invoked in a depth-first manner
+    - The 'init_up' method is invoked
+
+    A Component class supports the following decorated methods:
+    - sync
+    - constraint
+    - activity
+    """
+
+    def __bind__(self) -> Optional[Dict]: ...
+
+    @abc.abstractmethod
+    async def wait(self, amt : float, units : int = 0):
+        """
+        Uses the default timebase to suspend execution of the
+        calling coroutine for the specified time.
+        """
+        pass
+
+CompT = TypeVar('CompT', bound=Component)
+
+@dataclass
+class ComponentExtern(Component):
+    """
+    Extern components are used to interface with existing descriptions,
+    such as existing Verilog RTL.
+    """
+
+@dataclass
+class Action[CompT](Struct):
+    """
+    Action-derived types 
+
+    Valid fields
+    - All Struct fields
+    - Input / Output fields of Buffer, Stream, and State types
+    - Lock / Share fields of Resource types
+    Valid sub-regions
+    - All Struct sub-regions
+    - activity
+    """
+    comp : Type[CompT] = field()
+
+

{zuspec_dataclasses-0.0.1.18247735261rc0.dist-info → zuspec_dataclasses-0.0.1.18517051305rc0.dist-info}/METADATA

@@ -1,5 +1,5 @@
 Metadata-Version: 2.4
 Name: zuspec-dataclasses
-Version: 0.0.1.18247735261rc0
+Version: 0.0.1.18517051305rc0
 License-File: LICENSE
 Dynamic: license-file

zuspec_dataclasses-0.0.1.18517051305rc0.dist-info/RECORD

@@ -0,0 +1,19 @@
+zuspec/dataclasses/__init__.py,sha256=bWpgkedG2klldv4QG6_LlX0ysWBdtrwcWzcFEpmOXQk,1100
+zuspec/dataclasses/__version__.py,sha256=YXHa4lcuY_JblUMJXjV69-R6oAZpC_gQsBPNCi1SG7o,829
+zuspec/dataclasses/addr_reg.py,sha256=yKENXgCf9E5VEbfj0qCcJS-fwnQGdSaXG7t00aqA784,2759
+zuspec/dataclasses/annotation.py,sha256=m_3h065RAR81skrq39wxsJ1V0BxpwiyAWzdTrvW51Gg,1086
+zuspec/dataclasses/decorators.py,sha256=VLP2Rfw9nB-5fcsyrI_d-DQiF9P3y1_PGzc5ymAIF_o,8943
+zuspec/dataclasses/dependency.py,sha256=LukfqqvTUfShrtYdidqZeVMie-l50oAzkpYqo_bqie0,1289
+zuspec/dataclasses/tlm.py,sha256=sbAlnkYhVidinbiMKBT_mbe5yr1dDU9F_6aKBAXZjjE,431
+zuspec/dataclasses/types.py,sha256=K-mRJ80vtppaqbZJTS4FUxm_F6pkXlJD0g_sEP-7W9s,5581
+zuspec/dataclasses/api/__init__.py,sha256=UZY5lg-DjxtE0ixosJGpHFCBMshT8a0nZ8I0rIv75Ag,869
+zuspec/dataclasses/api/type_processor.py,sha256=4VqIbj-Uo_DqNJpENSq8k5ll5TxhRFlLjq5Psi0Ss7I,956
+zuspec/dataclasses/api/visitor.py,sha256=2XB19_xk2M0DQ5ZDCcrWSLiO-IVDlGr6LZizk1P4KxI,11682
+zuspec/dataclasses/std/__init__.py,sha256=7xOZCDuEikfg5NRpC0eFGIvgj3hHz7ibtJawzroU4nY,839
+zuspec/dataclasses/std/clock_reset.py,sha256=WzvcuaeVe1XI2u18puUZfHO73esSX7BHJ9XNTELVIqg,1184
+zuspec/dataclasses/std/timebase.py,sha256=euNa9Jsu1xq31JPnyzUlkmXgsGtv_7rWfmN5sTL_6hs,1299
+zuspec_dataclasses-0.0.1.18517051305rc0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+zuspec_dataclasses-0.0.1.18517051305rc0.dist-info/METADATA,sha256=gWcSF8r9r-m7dFi74hfyZWfr5nnUruoz8sJ-71QCRBY,121
+zuspec_dataclasses-0.0.1.18517051305rc0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+zuspec_dataclasses-0.0.1.18517051305rc0.dist-info/top_level.txt,sha256=3WM_V5g1RvpI4_z1TPY_AmroKhWIp6QJo4Vz5Tqbgak,7
+zuspec_dataclasses-0.0.1.18517051305rc0.dist-info/RECORD,,

zuspec/dataclasses/action.py

@@ -1,40 +0,0 @@
-#****************************************************************************
-# Copyright 2019-2025 Matthew Ballance and contributors
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#****************************************************************************
-from typing import Self, Type, TypeVar
-from .decorators import dataclass, field
-from .component import Component
-from .struct import Struct
-
-CompT = TypeVar('CompT', bound=Component)
-
-@dataclass
-class Action[CompT](Struct):
-    """
-    Action-derived types 
-
-    Valid fields
-    - All Struct fields
-    - Input / Output fields of Buffer, Stream, and State types
-    - Lock / Share fields of Resource types
-    Valid sub-regions
-    - All Struct sub-regions
-    - activity
-    """
-    comp : Type[CompT] = field()
-
-@dataclass
-class MyAction(Action[Component]):
-    pass

zuspec/dataclasses/bit.py

@@ -1,38 +0,0 @@
-import dataclasses as dc
-from typing import Dict, Generic, TypeVar, Literal, Type
-
-class BitMeta(type):
-    """
-    The BitMeta class is a constructor for Bit types.
-    Bit[12], for example, produces a Bit type where
-    W=12.
-    """
-
-    def __new__(cls, name, bases, attrs):
-        return super().__new__(cls, name, bases, attrs)
-    
-    def __init__(self, name, bases, attrs):
-        super().__init__(name, bases, attrs)
-        self.type_m : Dict = {}
-    
-    def __getitem__(self, W : int):
-        if W in self.type_m.keys():
-            return self.type_m[W]
-        else:
-            t = type("bit[%d]" % W, (Bit,), {
-                "W" : W
-            })
-            self.type_m[W] = t
-            return t
-
-class Bit(metaclass=BitMeta):
-    """
-    Variables of 'Bit' type represent unsigned W-bit values.
-    The value of the variables is automatically masked. For 
-    example, assigning 20 (b10100) to a 4-bit variable will 
-    result in 4 (b0100) being stored in the variable.
-    """
-    W : int = 1
-
-class Bits(metaclass=BitMeta):
-    W : int = -1

zuspec/dataclasses/bundle.py

@@ -1,49 +0,0 @@
-#****************************************************************************
-# Copyright 2019-2025 Matthew Ballance and contributors
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#****************************************************************************
-from typing import Annotated, Type, TypeVar
-from .decorators import dataclass
-
-@dataclass
-class Bundle(object):
-    """
-    A bundle type collects one or more ports, exports,
-    inputs, outputs, or bundles. 
-
-    Bundle fields are created with field(). Bundle-mirror
-    fields are created with mirror() or field(mirror=True)
-
-    A bundle field can be connected to a mirror field. 
-    A bundle monitor field can be connected to both a 
-    bundle and a bundle mirror.
-    - Bundle
-    - Bundle Mirror
-    - Bundle Monitor (all are inputs / exports)
-    """
-    pass
-
-#BundleT=TypeVar('BundleT', bound=Bundle)
-
-#class Mirror[BundleT](Annotated[Type[BundleT], "is mirror"]): pass
-
-# class MirrorMeta[BundleT](type):
-
-#     def __getitem__(self, t : BundleT) -> BundleT:
-#         pass
-
-# @dataclass
-# class Mirror[BundleT](metaclass=MirrorMeta[BundleT]):
-#     pass
-

zuspec/dataclasses/component.py

@@ -1,62 +0,0 @@
-#****************************************************************************
-# Copyright 2019-2025 Matthew Ballance and contributors
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#****************************************************************************
-import abc
-from typing import TYPE_CHECKING
-from .decorators import dataclass, field
-from .struct import Struct
-
-if TYPE_CHECKING:
-    from .std.timebase import TimeBase
-
-@dataclass
-class Component(Struct):
-    """
-    Component classes are structural in nature. 
-    The lifecycle of a component tree is as follows:
-    - The root component and fields of component type are constructed
-    - The 'init_down' method is invoked in a depth-first manner
-    - The 'init_up' method is invoked
-
-    A Component class supports the following decorated methods:
-    - sync
-    - constraint
-    - activity
-    """
-#    def build(self): pass
-
-    @abc.abstractmethod
-    async def wait(self, amt : float, units):
-        """
-        Uses the default timebase to suspend execution of the
-        calling coroutine for the specified time.
-        """
-        pass
-
-    @abc.abstractmethod
-    async def wait_next(self, count : int = 1):
-        """
-        Uses the default timebase to suspend execution of the
-        calling coroutine for the specified number of domain
-        evaluation events (eg clock cycles).
-        """
-        pass
-
-@dataclass
-class ComponentExtern(Component):
-    """
-    Extern components are used to interface with existing descriptions,
-    such as existing Verilog RTL.
-    """

zuspec/dataclasses/ports.py

@@ -1,56 +0,0 @@
-import dataclasses as dc
-from typing import ClassVar, Dict, Generic, Type
-from abc import abstractmethod
-
-
-class Port[T]():
-
-    @abstractmethod
-    def __call__(self) -> T:
-        pass
-
-# # Bundle is a collection of ports/exports
-# class WishboneI():
-#     valid : Output[bool]
-#     ready : Input[bool]
-#     pass
-
-# class ReverseT(type):
-#     def __new__(cls, name, bases, attrs):
-#         return super().__new__(cls, name, bases, attrs)
-
-#     def __getitem__(self, T : type):
-#         pass
-
-
-# class Reverse[T](metaclass=ReverseT):
-
-#     def __class_getitem__(cls):
-#         pass
-
-#     pass
-
-# WishboneIM=Reverse[WishboneI]
-
-# class Api[T](ABC):
-
-#     @abstractmethod
-#     def put(self, val : T):
-#         pass
-
-#     @abstractmethod
-#     def get(self) -> T:
-#         pass
-
-# class MyModule:
-#     init_o : Port[WishboneI]
-#     dat_o : Port[Api[int]]
-
-#     def doit(self):
-#         self.init_o().ready = 1
-#         if self.init_o().valid:
-#             pass
-
-#         a = self.dat_o().get()
-#         self.dat_o().put(5)
-

zuspec/dataclasses/py.typed

@@ -1 +0,0 @@
-

zuspec/dataclasses/struct.py

@@ -1,49 +0,0 @@
-import abc
-from typing import Dict, Optional, Type
-from .decorators import dataclass
-
-@dataclass
-class ZuspecTypeBase(object):
-    pass
-
-@dataclass
-class StructPacked(ZuspecTypeBase):
-    """
-    StructPacked types are fixed-size data structures. 
-    Fields may only be of a fixed size. 
-
-    Valid sub-regions
-    - constraint
-    - pre_solve / post_solve
-    """
-    pass
-
-@dataclass
-class Struct(ZuspecTypeBase):
-    """
-    Struct types are data structures that may contain
-    variable-size fields. 
-
-    Valid sub-regions
-    - constraint
-    - pre_solve / post_solve
-    - method
-    """
-
-
-    # @abc.abstractmethod
-    # def bind[T](self, t : T):
-    #             t : Type[T], 
-    #             init : Optional[Dict]=None,
-    #             bind : Optional[Dict]=None) -> T:
-    #     """
-    #     Public API
-    #     Applies service Creates a new instance of the specified class.
-    #     - Resolves service claims relative to the context
-    #       object and any bind specifications.
-    #     """
-    #     pass
-
-    pass
-
-class Extern(ZuspecTypeBase): pass

zuspec/dataclasses/util/extract_cpp_embedded_dsl.py

@@ -1,197 +0,0 @@
-#****************************************************************************
-#* extract_cpp_embedded_dsl.py
-#*
-#* Copyright 2022 Matthew Ballance and Contributors
-#*
-#* Licensed under the Apache License, Version 2.0 (the "License"); you may 
-#* not use this file except in compliance with the License.  
-#* You may obtain a copy of the License at:
-#*
-#*   http://www.apache.org/licenses/LICENSE-2.0
-#*
-#* Unless required by applicable law or agreed to in writing, software 
-#* distributed under the License is distributed on an "AS IS" BASIS, 
-#* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
-#* See the License for the specific language governing permissions and 
-#* limitations under the License.
-#*
-#* Created on:
-#*     Author: 
-#*
-#****************************************************************************
-from typing import List
-
-#
-#
-#  ZSP_DATACLASSES(TestSuite_testname, RootComp, RootAction, R"(
-#    @vdc.randclass
-#    class MyC(object):
-#      a : vdc.rand_uint32_t
-#  )")
-#
-#
-
-class DSLContent(object):
-    def __init__(self,
-                 name,
-                 root_comp,
-                 root_action,
-                 content):
-        self.name = name
-        self.root_comp = root_comp
-        self.root_action = root_action
-        self.content = content
-
-class ExtractCppEmbeddedDSL(object):
-
-    def __init__(self, 
-            file_or_fp,
-            name=None,
-            macro_name="ZSP_DATACLASSES"):
-        self._macro_name = macro_name
-        if hasattr(file_or_fp, "read"):
-            # This is a stream-like object
-            self._fp = file_or_fp
-            if name is None:
-                self._name = self._fp.name()
-        else:
-            self._fp = open(file_or_fp, "r")
-            self._name = file_or_fp
-        
-        self._lineno = 0
-        self._unget_ch = None
-        self._last_ch = None
-        self._buffer = ""
-        self._buffer_i = 0
-
-    def extract(self) -> List[DSLContent]:
-        ret = []
-
-        while self.find_macro():
-
-            lineno = self._lineno
-            while True:
-                ch = self.getch()
-
-                if ch is None or ch == '(':
-                    break
-
-            if ch is None:
-                raise Exception("Failed to parse embedded DSL @ %s:%d" % (self._name, self._lineno))
-            
-            # Now, collect the complete content of the macro
-            content = ""
-            count_b = 1
-            while count_b > 0:
-                ch = self.getch()
-
-                if ch is None:
-                    break
-                content += ch
-
-                if ch == '(':
-                    count_b += 1
-                elif ch == ')':
-                    count_b -= 1
-
-            if count_b > 0:
-                raise Exception("Unbalanced parens")
-            content = content[:-2]
-            
-            # We now have text from a macro invocation
-            start = 0
-            count_b = 0
-            params = []
-
-            for i in range(len(content)):
-                if content[i] == "," and count_b == 0:
-                    params.append(content[start:i].strip())
-                    start = i+1
-                elif content[i] == '(':
-                    count_b += 1
-                elif content[i] == ')':
-                    count_b -= 1
-
-            if count_b != 0:
-                raise Exception("Unbalanced parens while tokenizing") 
-
-            if start < len(content):
-                params.append(content[start:].strip())
-
-            if len(params) != 4:
-                raise Exception("Expected 3 params; received %d" % len(params))
-
-            if params[-1].startswith('R"('):
-                params[-1] = params[-1][3:-2]
-
-            content = params[-1].split("\n")
-            min_ws = 10000
-
-            for l in content:
-                l_strip = l.strip()
-                if l_strip != "":
-                    ws_l = len(l) - len(l_strip)
-                    if ws_l < min_ws:
-                        min_ws = ws_l
-
-            for i in range(len(content)):
-                content[i] = content[i][min_ws:]
-
-            vsc_content = "\n".join(content)
-
-            root_comp = params[1]
-            root_action = params[2]
-
-            info = DSLContent(params[0], root_comp, root_action, vsc_content)
-            ret.append(info)
-
-        self._fp.close()
-        return ret
-
-    def find_macro(self):
-
-        while True:
-            line = self._fp.readline()
-            self._lineno += 1
-
-            if line == "":
-                break
-            
-            idx = line.find(self._macro_name)
-            
-            if idx >= 0:
-                self._buffer = line
-                self._buffer_i = idx + len(self._macro_name)
-                return True
-        
-        return False
-
-    def getch(self):
-        if self._buffer is None:
-            return None
-
-        if self._buffer_i >= len(self._buffer):
-            try:
-                self._buffer = self._fp.readline()
-                self._buffer_i = 0
-                self._lineno += 1
-                if self._buffer == "":
-                    self._buffer = None
-                    return None
-            except Exception:
-                self._buffer = None
-                return None
-            
-        ret = self._buffer[self._buffer_i]
-        self._buffer_i += 1
-        return ret
-    
-    def ungetch(self, ch):
-        if self._buffer is None:
-            self._buffer = ch
-        elif self._buffer_i > 0:
-            self._buffer_i -= 1
-            self._buffer[self._buffer_i] = ch
-        else:
-            self._buffer.insert(0, ch)
-

zuspec/dataclasses/util/gen_cpp_dt_defs/__main__.py

@@ -1,102 +0,0 @@
-#****************************************************************************
-#* __main__.py
-#*
-#* zsp_dataclasses.util.gen_cpp_dt_defs
-#*
-#* Copyright 2022 Matthew Ballance and Contributors
-#*
-#* Licensed under the Apache License, Version 2.0 (the "License"); you may 
-#* not use this file except in compliance with the License.  
-#* You may obtain a copy of the License at:
-#*
-#*   http://www.apache.org/licenses/LICENSE-2.0
-#*
-#* Unless required by applicable law or agreed to in writing, software 
-#* distributed under the License is distributed on an "AS IS" BASIS, 
-#* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
-#* See the License for the specific language governing permissions and 
-#* limitations under the License.
-#*
-#* Created on:
-#*     Author: 
-#*
-#****************************************************************************
-
-import argparse
-import os
-import zuspec as zdc
-from zuspec.impl.ctor import Ctor
-from zuspec.impl.pyctxt.context import Context
-from zuspec.impl.generators.zsp_data_model_cpp_gen import ZspDataModelCppGen
-from ..extract_cpp_embedded_dsl import ExtractCppEmbeddedDSL
-
-def get_parser():
-    parser = argparse.ArgumentParser()
-    parser.add_argument("-o","--outdir", default="zspdefs",
-        help="Specifies the output directory")
-    parser.add_argument("-d", "--depfile",
-        help="Specifies a dependency file")
-    parser.add_argument("files", nargs='+')
-
-    return parser
-
-def main():
-    parser = get_parser()
-    args = parser.parse_args()
-
-    deps_ts = None
-    if args.depfile is not None and os.path.isfile(args.depfile):
-        deps_ts = os.path.getmtime(args.depfile)
-
-    fragment_m = {}
-    for file in args.files:
-        print("Process %s" % file)
-        if deps_ts is not None:
-            file_ts = os.path.getmtime(file)
-            if file_ts <= deps_ts:
-                print("Skip due to deps")
-                continue
-
-        fragments = ExtractCppEmbeddedDSL(file).extract()
-        print("fragments: %s" % str(fragments))
-
-        for f in fragments:
-            if f.name in fragment_m.keys():
-                raise Exception("Duplicate fragment-name %s" % f.name)
-            fragment_m[f.name] = f
-
-    if not os.path.isdir(args.outdir):
-        os.makedirs(args.outdir, exist_ok=True)
-
-    for fn in fragment_m.keys():
-        Ctor.init(Context())
-
-        print("--> Process Fragment %s" % fn)
-        _globals = globals().copy()
-        exec(fragment_m[fn].content, _globals)
-        print("<-- Process Fragment %s" % fn)
-
-        Ctor.inst().elab()
-
-        header_path = os.path.join(args.outdir, "%s.h" % fn)
-        root_comp = Ctor.inst().ctxt().findDataTypeComponent(fragment_m[fn].root_comp)
-        if root_comp is None:
-            raise Exception("Failed to find root component %s" % fragment_m[fn].root_comp)
-        root_action = Ctor.inst().ctxt().findDataTypeAction(fragment_m[fn].root_action)
-        if root_action is None:
-            raise Exception("Failed to find root action %s" % fragment_m[fn].root_action)
-        gen = ZspDataModelCppGen()
-        gen._ctxt = "m_ctxt"
-        with open(header_path, "w") as fp:
-            fp.write(gen.generate(
-                root_comp, 
-                root_action, 
-                Ctor.inst().ctxt().getDataTypeFunctions()))
-
-    if args.depfile is not None:
-        with open(args.depfile, "w") as fp:
-            fp.write("\n")
-
-if __name__ == "__main__":
-    main()
-

zuspec/impl/__init__.py

@@ -1 +0,0 @@
-# Package marker for zuspec.impl

zuspec_dataclasses-0.0.1.18247735261rc0.dist-info/RECORD

@@ -1,29 +0,0 @@
-zuspec/dataclasses/__init__.py,sha256=WSYClXn7Bugmg6tHtQpENpZpW7Lphful7VPJ0kXEv2I,1369
-zuspec/dataclasses/__version__.py,sha256=bSVqz-OXPGTZAO0TqxCChxvIlteTdq4XJ_6WEn0sc7M,829
-zuspec/dataclasses/action.py,sha256=12n8lihUhX0BFPcW370IlPgyEXLUMDSDQ_h_-rZr7ik,1328
-zuspec/dataclasses/addr_reg.py,sha256=yKENXgCf9E5VEbfj0qCcJS-fwnQGdSaXG7t00aqA784,2759
-zuspec/dataclasses/annotation.py,sha256=m_3h065RAR81skrq39wxsJ1V0BxpwiyAWzdTrvW51Gg,1086
-zuspec/dataclasses/bit.py,sha256=qBTt8mj_S4WK6VeRaaqeNzzuvy3P12WigKaeU2Gr0mw,1072
-zuspec/dataclasses/bundle.py,sha256=YIuEQS_4oS3LWQ3Zv3Ib78L6V6QzhDsd2S89BP0dsl8,1626
-zuspec/dataclasses/component.py,sha256=yXSmg87uj_1TaazO99mLv72Z0lAlzzQiBTmn0wI5alo,2056
-zuspec/dataclasses/decorators.py,sha256=A8vqoenJ8XkhMLZm7JcKw6BCC9uTG8lQIVh9XtPuvTQ,14528
-zuspec/dataclasses/dependency.py,sha256=LukfqqvTUfShrtYdidqZeVMie-l50oAzkpYqo_bqie0,1289
-zuspec/dataclasses/ports.py,sha256=OydeAfPIAef8pCp_3FhL87fq7mrbhiNLa9qfPHkCK1E,1044
-zuspec/dataclasses/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-zuspec/dataclasses/struct.py,sha256=_7Lgf2BbF_WQXSpdKmowR6mATBjqZtqK6VoPPc1tdLg,1077
-zuspec/dataclasses/tlm.py,sha256=sbAlnkYhVidinbiMKBT_mbe5yr1dDU9F_6aKBAXZjjE,431
-zuspec/dataclasses/api/__init__.py,sha256=UZY5lg-DjxtE0ixosJGpHFCBMshT8a0nZ8I0rIv75Ag,869
-zuspec/dataclasses/api/type_processor.py,sha256=4VqIbj-Uo_DqNJpENSq8k5ll5TxhRFlLjq5Psi0Ss7I,956
-zuspec/dataclasses/api/visitor.py,sha256=CduJ6k11xY81_nFl8k0dVSRJt88a21mHem64Yeg6sDI,11852
-zuspec/dataclasses/std/__init__.py,sha256=7xOZCDuEikfg5NRpC0eFGIvgj3hHz7ibtJawzroU4nY,839
-zuspec/dataclasses/std/clock_reset.py,sha256=AveFnqB-OAgWfVr2eA7v9XfAPuE12WtQpSbbE1zhwME,1205
-zuspec/dataclasses/std/timebase.py,sha256=v-GIdpVP_hIAGt3-oC-PikQQmYCG5ODTCu7syIzQNjE,1320
-zuspec/dataclasses/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-zuspec/dataclasses/util/extract_cpp_embedded_dsl.py,sha256=SyMMLumZD6fsubj40hyekYzWyrcoUGTijJH3NmK1ihY,5630
-zuspec/dataclasses/util/gen_cpp_dt_defs/__main__.py,sha256=t3CnHJKcN_N33sxCsDH-R36ghCcQ7xjMcjUrzUT2SGM,3447
-zuspec/impl/__init__.py,sha256=GZWCeBPdVzLR0RNPkmXNXPgdS-2vg5dMC1goTYJs3yI,33
-zuspec_dataclasses-0.0.1.18247735261rc0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-zuspec_dataclasses-0.0.1.18247735261rc0.dist-info/METADATA,sha256=U596wNV1wSbTXiWLNEGG72gHKLQosXRWbwPA67yVnCM,121
-zuspec_dataclasses-0.0.1.18247735261rc0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-zuspec_dataclasses-0.0.1.18247735261rc0.dist-info/top_level.txt,sha256=3WM_V5g1RvpI4_z1TPY_AmroKhWIp6QJo4Vz5Tqbgak,7
-zuspec_dataclasses-0.0.1.18247735261rc0.dist-info/RECORD,,