// SPDX-License-Identifier: Apache-2.0

package firrtl.transforms.formal

import firrtl._
import firrtl.ir._
import firrtl.options.Dependency

/** Convert Asserts
  *
  * Replaces all Assert nodes with a gated print-and-stop. This effectively
  * emulates the assert for IEEE 1364 Verilog.
  */
object ConvertAsserts extends Transform with DependencyAPIMigration {
  override def prerequisites = Nil
  override def optionalPrerequisites = Nil
  override def optionalPrerequisiteOf =
    Seq(Dependency[VerilogEmitter], Dependency[MinimumVerilogEmitter], Dependency[RemoveVerificationStatements])

  override def invalidates(a: Transform): Boolean = false

  def convertAsserts(stmt: Statement): Statement = stmt match {
    case Verification(Formal.Assert, i, clk, pred, en, msg) =>
      val nPred = DoPrim(PrimOps.Not, Seq(pred), Nil, pred.tpe)
      val gatedNPred = DoPrim(PrimOps.And, Seq(nPred, en), Nil, pred.tpe)
      val stop = Stop(i, 1, clk, gatedNPred)
      msg match {
        case StringLit("") => stop
        case _             => Block(Print(i, msg, Nil, clk, gatedNPred), stop)
      }
    case s => s.mapStmt(convertAsserts)
  }

  def execute(state: CircuitState): CircuitState = {
    state.copy(circuit = state.circuit.mapModule(m => m.mapStmt(convertAsserts)))
  }
}
