refactored resource ownership and constraints

moved resource context to core module

Author: Oron Port

core/src/main/scala/dfhdl/core/MutableDB.scala

@@ -311,6 +311,16 @@ final class MutableDB():
     def ownerOption: Option[DFOwner] = stack.headOption
   end OwnershipContext
 
+  object ResourceOwnershipContext:
+    import dfhdl.platforms.resources.ResourceOwner
+    private var stack: List[ResourceOwner] = Nil
+    def enter(owner: ResourceOwner): Unit =
+      stack = owner :: stack
+    def exit(): Unit =
+      stack = stack.drop(1)
+    def owner: ResourceOwner = stack.head
+    def ownerOpt: Option[ResourceOwner] = stack.headOption
+
   object GlobalTagContext:
     private[MutableDB] var tags: DFTags = DFTags.empty
     def set[CT <: DFTag: ClassTag](tag: CT): Unit = tags = tags.tag(tag)

lib/src/main/scala/dfhdl/platforms/resources/Resource.scala renamed to core/src/main/scala/dfhdl/platforms/resources/Resource.scala

@@ -2,13 +2,12 @@ package dfhdl.platforms.resources
 import scala.annotation.implicitNotFound
 import scala.collection.mutable.ListBuffer
 
-trait Resource(using ctx: RCtx):
-  final val id: String = ctx.id
-  final val owner: ResourceOwner = ctx.owner
+trait Resource extends ResourceContext:
+  private val owner: ResourceOwner = dfc.mutableDB.ResourceOwnershipContext.owner
   private val connections = ListBuffer[Resource]()
   protected[resources] def connect(that: Resource): Unit =
     connections += that
-  owner.add(this)
+  owner.addResource(this)
 
 private trait ResourceLP:
   import Resource.CanConnect

core/src/main/scala/dfhdl/core/ResourceContainer.scala renamed to core/src/main/scala/dfhdl/platforms/resources/ResourceContext.scala

@@ -1,9 +1,11 @@
-package dfhdl.core
+package dfhdl.platforms.resources
 import dfhdl.internals.*
+import dfhdl.core.*
 import scala.annotation.Annotation
 
-class ResourceContainer extends OnCreateEvents, HasDFC, HasClsMetaArgs:
+trait ResourceContext extends OnCreateEvents, HasDFC, HasClsMetaArgs:
   final lazy val dfc: DFC = __dfc
+  final lazy val id: String = dfc.nameOpt.get
   protected def __dfc: DFC =
     println("Severe error: missing DFHDL context!\nMake sure you enable the DFHDL compiler plugin.")
     sys.exit(1)
@@ -13,4 +15,4 @@ class ResourceContainer extends OnCreateEvents, HasDFC, HasClsMetaArgs:
       docOpt: Option[String],
       annotations: List[Annotation]
   ): Unit = {}
-end ResourceContainer
+end ResourceContext

lib/src/main/scala/dfhdl/platforms/resources/ResourceDeps.scala renamed to core/src/main/scala/dfhdl/platforms/resources/ResourceDeps.scala

@@ -1,6 +1,6 @@
 package dfhdl.platforms.resources
 
-trait ResourceDeps(using RCtx) extends Resource:
+trait ResourceDeps extends Resource:
   protected def deps: List[Resource]
   override protected[resources] def connect(that: Resource): Unit =
     deps.lazyZip(that.asInstanceOf[ResourceDeps].deps).foreach {

lib/src/main/scala/dfhdl/platforms/resources/ResourceGroup.scala renamed to core/src/main/scala/dfhdl/platforms/resources/ResourceGroup.scala

@@ -1,6 +1,6 @@
 package dfhdl.platforms.resources
 
-trait ResourceGroup(using RCtx) extends Resource, ResourceOwner:
+trait ResourceGroup extends Resource, ResourceOwner:
   override protected[resources] def connect(that: Resource): Unit =
     getResources.lazyZip(that.asInstanceOf[ResourceGroup].getResources).foreach {
       // skipping ResourceDeps in the group, since their dependencies are already connected

core/src/main/scala/dfhdl/platforms/resources/ResourceOwner.scala

@@ -0,0 +1,12 @@
+package dfhdl.platforms.resources
+import scala.collection.mutable.ListBuffer
+trait ResourceOwner extends ResourceContext:
+  dfc.mutableDB.ResourceOwnershipContext.enter(this)
+  private val resources = ListBuffer[Resource]()
+  private val children = ListBuffer[ResourceOwner]()
+  private[resources] def getResources: List[Resource] = resources.toList
+  private[resources] def getChildren: List[ResourceOwner] = children.toList
+  private[resources] def addResource(resource: Resource): Unit = resources += resource
+  override def onCreateEnd(thisOwner: Option[This]): Unit =
+    dfc.mutableDB.ResourceOwnershipContext.exit()
+    dfc.mutableDB.ResourceOwnershipContext.ownerOpt.foreach(_.children += this)

lib/src/main/scala/dfhdl/platforms/resources/Button.scala

@@ -1,12 +1,8 @@
 package dfhdl.platforms.resources
 import dfhdl.Encoded
-import dfhdl.compiler.ir.constraints
 
 enum Button extends Encoded.Toggle:
   case Released, Pressed
 
 object Button:
-  final case class Resource(
-      activeState: Button = Button.Pressed,
-      ioc: constraints.IO = constraints.IO(standard = constraints.IO.Standard.LVCMOS33)
-  )(using RCtx) extends ToggleIO
+  class Resource(val activeState: Button = Button.Pressed) extends ToggleIO

lib/src/main/scala/dfhdl/platforms/resources/DiffPair.scala

@@ -1,6 +1,6 @@
 package dfhdl.platforms.resources
 
-trait DiffPair(using RCtx) extends ResourceDeps:
+trait DiffPair extends ResourceDeps:
   val pPin: IO
   val nPin: IO
   protected def deps: List[Resource] = List(pPin, nPin)

lib/src/main/scala/dfhdl/platforms/resources/IO.scala

@@ -1,12 +1,8 @@
 package dfhdl.platforms.resources
 import dfhdl.platforms.resources.Resource.CanConnect
-import dfhdl.compiler.ir.constraints
 
 trait IO extends Resource
 object IO:
   given [T <: IO, R <: IO]: CanConnect[T, R] = (resource1: T, resource2: R) =>
     resource1.connect(resource2)
     resource2.connect(resource1)
-
-trait HasIOConstraints extends IO:
-  val ioc: constraints.IO

lib/src/main/scala/dfhdl/platforms/resources/IOBus.scala

@@ -2,6 +2,6 @@ package dfhdl.platforms.resources
 import dfhdl.internals.CTName
 import dfhdl.compiler.ir.constraints
 
-final case class IOBus[T <: IO](val ios: T*)(using RCtx) extends ResourceDeps:
+class IOBus[T <: IO](val ios: T*) extends ResourceDeps:
   def apply(i: Int): T = ios(i)
   protected def deps: List[Resource] = ios.toList