// SPDX-License-Identifier: Apache-2.0

package chiselTests.stage.phases


import chisel3._
import chisel3.stage.{ChiselCircuitAnnotation, ChiselGeneratorAnnotation}
import chisel3.stage.phases.Elaborate

import firrtl.options.Phase
import org.scalatest.flatspec.AnyFlatSpec
import org.scalatest.matchers.should.Matchers

class ElaborateSpec extends AnyFlatSpec with Matchers {

  class Foo extends Module {
    override def desiredName: String = "Foo"
    val io = IO(
      new Bundle {
        val in = Input(Bool())
        val out = Output(Bool())
      })

    io.out := ~io.in
  }

  class Bar extends Foo {
    override def desiredName: String = "Bar"
  }

  class Fixture { val phase: Phase = new Elaborate }

  behavior of classOf[Elaborate].toString

  it should "expand ChiselGeneratorAnnotations into ChiselCircuitAnnotations and delete originals" in new Fixture {
    val annotations = Seq( ChiselGeneratorAnnotation(() => new Foo),
                           ChiselGeneratorAnnotation(() => new Bar) )
    val out = phase.transform(annotations)

    info("original annotations removed")
    out.collect{ case a: ChiselGeneratorAnnotation => a } should be (empty)

    info("circuits created with the expected names")
    out.collect{ case a: ChiselCircuitAnnotation => a.circuit.name } should be (Seq("Foo", "Bar"))
  }

}
