// SPDX-License-Identifier: Apache-2.0

package chiselTests.properties

import chisel3._
import chisel3.experimental.hierarchy.{instantiable, public, Definition, Instance}
import chisel3.properties.{Class, DynamicObject, Property}
import chiselTests.{ChiselFlatSpec, MatchesAndOmits}
import circt.stage.ChiselStage

class ClassSpec extends ChiselFlatSpec with MatchesAndOmits {
  behavior.of("Class")

  it should "serialize to FIRRTL with anonymous names" in {
    val chirrtl = ChiselStage.emitCHIRRTL(new RawModule {
      Definition(new Class)
      Definition(new Class)
      Definition(new Class)
    })

    matchesAndOmits(chirrtl)(
      "class Class",
      "class Class_1",
      "class Class_2"
    )()
  }

  it should "serialize to FIRRTL with a desiredName" in {
    val chirrtl = ChiselStage.emitCHIRRTL(new RawModule {
      Definition(new Class {
        override def desiredName = "Foo"
      })
    })

    matchesAndOmits(chirrtl)(
      "class Foo"
    )()
  }

  it should "serialize to FIRRTL with the Scala class name" in {
    val chirrtl = ChiselStage.emitCHIRRTL(new RawModule {
      class MyClass extends Class {}

      Definition(new MyClass)
    })

    matchesAndOmits(chirrtl)(
      "class MyClass"
    )()
  }

  it should "support Property type ports" in {
    val chirrtl = ChiselStage.emitCHIRRTL(new RawModule {
      Definition(new Class {
        val in = IO(Input(Property[Int]()))
        val out = IO(Output(Property[Int]()))
      })
    })

    matchesAndOmits(chirrtl)(
      "input in : Integer",
      "output out : Integer"
    )()
  }

  it should "only support Property type ports" in {
    val e = the[ChiselException] thrownBy {
      ChiselStage.emitCHIRRTL(
        new RawModule {
          Definition(new Class {
            val in = IO(Input(Bool()))
          })
        },
        Array("--throw-on-first-error")
      )
    }
    e.getMessage should include("Class ports must be Property type, but found Bool.")
  }

  it should "support Property assignments" in {
    val chirrtl = ChiselStage.emitCHIRRTL(new RawModule {
      Definition(new Class {
        val in = IO(Input(Property[Int]()))
        val out = IO(Output(Property[Int]()))
        out := in
      })
    })

    matchesAndOmits(chirrtl)(
      "propassign out, in"
    )()
  }

  it should "support instantiation through its own API" in {
    val chirrtl = ChiselStage.emitCHIRRTL(new RawModule {
      val cls = Definition(new Class {
        override def desiredName = "Test"
        val in = IO(Input(Property[Int]()))
        val out = IO(Output(Property[Int]()))
        out := in
      })

      val obj1 = Class.unsafeGetDynamicObject("Test")
      val obj2 = Class.unsafeGetDynamicObject("Test")
    })

    matchesAndOmits(chirrtl)(
      "class Test",
      "object obj1 of Test",
      "object obj2 of Test"
    )()
  }

  it should "support instantiation within a Class" in {
    val chirrtl = ChiselStage.emitCHIRRTL(new RawModule {
      val cls = Definition(new Class {
        override def desiredName = "Test"
        val in = IO(Input(Property[Int]()))
        val out = IO(Output(Property[Int]()))
        out := in
      })

      Definition(new Class {
        override def desiredName = "Parent"
        val obj1 = Class.unsafeGetDynamicObject("Test")
      })
    })

    matchesAndOmits(chirrtl)(
      "class Test",
      "class Parent",
      "object obj1 of Test"
    )()
  }

  it should "support instantiation with Instance" in {
    val chirrtl = ChiselStage.emitCHIRRTL(
      new RawModule {
        val cls = Definition(new Class {
          override def desiredName = "Test"
          val in = IO(Input(Property[Int]()))
          val out = IO(Output(Property[Int]()))
          out := in
        })

        val obj1 = Instance(cls)
        val obj2 = Instance(cls)
      }
    )

    matchesAndOmits(chirrtl)(
      "class Test",
      "object obj1 of Test",
      "object obj2 of Test"
    )()
  }

  it should "support @instantiable and @public" in {
    @instantiable
    class Test extends Class {
      @public val in = IO(Input(Property[Int]()))
      @public val out = IO(Output(Property[Int]()))
      out := in
    }

    val chirrtl = ChiselStage.emitCHIRRTL(
      new RawModule {
        val cls = Definition(new Test)

        val obj1 = Instance(cls)
        val obj2 = Instance(cls)

        obj2.in := obj1.out
      }
    )

    matchesAndOmits(chirrtl)(
      "class Test",
      "object obj1 of Test",
      "object obj2 of Test",
      "propassign obj2.in, obj1.out"
    )()
  }
}
