Merge pull request #1228 from freechipsproject/getSimpleName-considered-harmful

getSimpleName considered harmful

5 files changed, 33 insertions, 8 deletions

diff --git a/src/main/scala/firrtl/Compiler.scala b/src/main/scala/firrtl/Compiler.scala
index 600b991e..9014d213 100644
--- a/src/main/scala/firrtl/Compiler.scala
+++ b/src/main/scala/firrtl/Compiler.scala
@@ -171,7 +171,7 @@ final case object UnknownForm extends CircuitForm(-1) {
 /** The basic unit of operating on a Firrtl AST */
 abstract class Transform extends TransformLike[CircuitState] {
   /** A convenience function useful for debugging and error messages */
-  def name: String = this.getClass.getSimpleName
+  def name: String = this.getClass.getName
   /** The [[firrtl.CircuitForm]] that this transform requires to operate on */
   def inputForm: CircuitForm
   /** The [[firrtl.CircuitForm]] that this transform outputs */
diff --git a/src/main/scala/firrtl/annotations/JsonProtocol.scala b/src/main/scala/firrtl/annotations/JsonProtocol.scala
index c3853650..9992400a 100644
--- a/src/main/scala/firrtl/annotations/JsonProtocol.scala
+++ b/src/main/scala/firrtl/annotations/JsonProtocol.scala
@@ -109,7 +109,7 @@ object JsonProtocol {
     val annos = parsed match {
       case JArray(objs) => objs
       case x => throw new InvalidAnnotationJSONException(
-        s"Annotations must be serialized as a JArray, got ${x.getClass.getSimpleName} instead!")
+        s"Annotations must be serialized as a JArray, got ${x.getClass.getName} instead!")
     }
     // Recursively gather typeHints by pulling the "class" field from JObjects
     // Json4s should emit this as the first field in all serialized classes
diff --git a/src/main/scala/firrtl/options/DependencyManager.scala b/src/main/scala/firrtl/options/DependencyManager.scala
index 1de8095b..604a1b10 100644
--- a/src/main/scala/firrtl/options/DependencyManager.scala
+++ b/src/main/scala/firrtl/options/DependencyManager.scala
@@ -291,7 +291,7 @@ trait DependencyManager[A, B <: TransformLike[A] with DependencyAPI[B]] extends
     val nodes =
       (prerequisiteGraph + dependentsGraph + invalidateGraph + otherDependents)
         .getVertices
-        .map(v => s"""${transformName(v)} [label="${v.getClass.getSimpleName}"]""")
+        .map(v => s"""${transformName(v)} [label="${v.getClass.getName}"]""")
 
     s"""|digraph DependencyManager {
         |  graph [rankdir=BT]
@@ -315,8 +315,8 @@ trait DependencyManager[A, B <: TransformLike[A] with DependencyAPI[B]] extends
     def rec(pm: DependencyManager[A, B], cm: Seq[String], tab: String = "", id: Int = 0): (String, Int) = {
       var offset = id
 
-      val targets = pm._targets.toSeq.map(_.getSimpleName).mkString(", ")
-      val state = pm._currentState.toSeq.map(_.getSimpleName).mkString(", ")
+      val targets = pm._targets.toSeq.map(_.getName).mkString(", ")
+      val state = pm._currentState.toSeq.map(_.getName).mkString(", ")
 
       val header = s"""|${tab}subgraph cluster_$id {
                        |$tab  label="targets: $targets\\nstate: $state"
@@ -331,7 +331,7 @@ trait DependencyManager[A, B <: TransformLike[A] with DependencyAPI[B]] extends
         case a =>
           val name = s"""${transformName(a, "_" + id)}"""
           sorted += name
-          s"""$tab  $name [label="${a.getClass.getSimpleName}"]"""
+          s"""$tab  $name [label="${a.getClass.getName}"]"""
       }.mkString("\n")
 
       (Seq(header, body, s"$tab}").mkString("\n"), offset)
diff --git a/src/main/scala/firrtl/stage/package.scala b/src/main/scala/firrtl/stage/package.scala
index 89a61914..d0a481fb 100644
--- a/src/main/scala/firrtl/stage/package.scala
+++ b/src/main/scala/firrtl/stage/package.scala
@@ -49,7 +49,7 @@ package object stage {
       options.collectFirst{ case a: FirrtlCircuitAnnotation => a.circuit } match {
         case None => FirrtlExecutionFailure("No circuit found in AnnotationSeq!")
         case Some(a) => FirrtlExecutionSuccess(
-          emitType = fopts.compiler.getClass.getSimpleName,
+          emitType = fopts.compiler.getClass.getName,
           emitted = emittedRes,
           circuitState = CircuitState(
             circuit = a,
diff --git a/src/test/scala/firrtlTests/CustomTransformSpec.scala b/src/test/scala/firrtlTests/CustomTransformSpec.scala
index 1b0e8190..e0ed6fdb 100644
--- a/src/test/scala/firrtlTests/CustomTransformSpec.scala
+++ b/src/test/scala/firrtlTests/CustomTransformSpec.scala
@@ -6,6 +6,8 @@ import firrtl.ir.Circuit
 import firrtl._
 import firrtl.passes.Pass
 import firrtl.ir._
+import firrtl.annotations.{Annotation, NoTargetAnnotation}
+import firrtl.stage.{FirrtlSourceAnnotation, FirrtlStage, RunFirrtlTransformAnnotation}
 
 class CustomTransformSpec extends FirrtlFlatSpec {
   behavior of "Custom Transforms"
@@ -71,5 +73,28 @@ class CustomTransformSpec extends FirrtlFlatSpec {
       Driver.execute(optionsManager)
     }).getMessage should include (errorString)
   }
-}
 
+  object Foo {
+    class A extends Transform {
+      def inputForm = HighForm
+      def outputForm = HighForm
+      def execute(s: CircuitState) = {
+        println(name)
+        s
+      }
+    }
+  }
+
+  they should "work if placed inside an object" in {
+    val input =
+      """|circuit Foo:
+         |  module Foo:
+         |    node a = UInt<1>(0)
+         |""".stripMargin
+    val annotations = Seq(
+      RunFirrtlTransformAnnotation(new Foo.A),
+      FirrtlSourceAnnotation(input)
+    )
+    (new FirrtlStage).execute(Array.empty, annotations)
+  }
+}