// SPDX-License-Identifier: Apache-2.0

package firrtl.passes
package memlib

import firrtl.ir._

object DefAnnotatedMemory {
  def apply(m: DefMemory): DefAnnotatedMemory = {
    new DefAnnotatedMemory(
      m.info,
      m.name,
      m.dataType,
      m.depth,
      m.writeLatency,
      m.readLatency,
      m.readers,
      m.writers,
      m.readwriters,
      m.readUnderWrite,
      None, // mask granularity annotation
      None // No reference yet to another memory
    )
  }
}

case class DefAnnotatedMemory(
  info:           Info,
  name:           String,
  dataType:       Type,
  depth:          BigInt,
  writeLatency:   Int,
  readLatency:    Int,
  readers:        Seq[String],
  writers:        Seq[String],
  readwriters:    Seq[String],
  readUnderWrite: ReadUnderWrite.Value,
  maskGran:       Option[BigInt],
  memRef:         Option[(String, String)] /* (Module, Mem) */
  //pins: Seq[Pin],
) extends Statement
    with IsDeclaration {
  override def serialize: String = this.toMem.serialize
  def mapStmt(f:   Statement => Statement):   Statement = this
  def mapExpr(f:   Expression => Expression): Statement = this
  def mapType(f:   Type => Type):             Statement = this.copy(dataType = f(dataType))
  def mapString(f: String => String):         Statement = this.copy(name = f(name))
  def toMem =
    DefMemory(info, name, dataType, depth, writeLatency, readLatency, readers, writers, readwriters, readUnderWrite)
  def mapInfo(f:       Info => Info):       Statement = this.copy(info = f(info))
  def foreachStmt(f:   Statement => Unit):  Unit = ()
  def foreachExpr(f:   Expression => Unit): Unit = ()
  def foreachType(f:   Type => Unit):       Unit = f(dataType)
  def foreachString(f: String => Unit):     Unit = f(name)
  def foreachInfo(f:   Info => Unit):       Unit = f(info)
}