Restructured Compiler to use Transforms. Added an InlineInstance pass.

Transforms are new unit of modularity within the compiler.

1 files changed, 82 insertions, 0 deletions

diff --git a/src/test/scala/firrtlTests/PassTests.scala b/src/test/scala/firrtlTests/PassTests.scala
new file mode 100644
index 00000000..38ecc7c3
--- /dev/null
+++ b/src/test/scala/firrtlTests/PassTests.scala
@@ -0,0 +1,82 @@
+package firrtlTests
+
+import com.typesafe.scalalogging.LazyLogging
+import java.io.{StringWriter,Writer}
+import org.scalatest.{FlatSpec, Matchers}
+import org.scalatest.junit.JUnitRunner
+import firrtl.{Parser,Circuit,FIRRTLEmitter}
+import firrtl.Parser.IgnoreInfo
+import firrtl.passes.{Pass, PassExceptions}
+import firrtl.{
+   Transform,
+   CircuitAnnotation,
+   TransformResult,
+   SimpleRun,
+   Chisel3ToHighFirrtl,
+   IRToWorkingIR,
+   ResolveAndCheck,
+   HighFirrtlToMiddleFirrtl,
+   MiddleFirrtlToLowFirrtl,
+   EmitFirrtl,
+   Compiler
+}
+
+
+// An example methodology for testing Firrtl Passes
+// Spec class should extend this class
+abstract class SimpleTransformSpec extends FlatSpec with Matchers with Compiler with LazyLogging {
+   // Utility function
+   def parse(s: String): Circuit = Parser.parse(s.split("\n").toIterator, infoMode = IgnoreInfo)
+
+   // Executes the test. Call in tests.
+   def execute(writer: Writer, annotations: Seq[CircuitAnnotation], input: String, check: String) = {
+      compile(parse(input), annotations, writer)
+      logger.debug(writer.toString)
+      logger.debug(check)
+      (parse(writer.toString)) should be (parse(check))
+   }
+   // Executes the test, should throw an error
+   def failingexecute(writer: Writer, annotations: Seq[CircuitAnnotation], input: String) = {
+      intercept[PassExceptions] {
+         compile(parse(input), annotations, writer)
+      }
+   }
+}
+
+trait LowTransformSpec extends SimpleTransformSpec {
+   def transform: Transform
+   def transforms (writer: Writer) = Seq(
+      new Chisel3ToHighFirrtl(),
+      new IRToWorkingIR(),
+      new ResolveAndCheck(),
+      new HighFirrtlToMiddleFirrtl(),
+      new MiddleFirrtlToLowFirrtl(),
+      new ResolveAndCheck(),
+      transform,
+      new EmitFirrtl(writer)
+   )
+}
+
+trait MiddleTransformSpec extends SimpleTransformSpec {
+   def transform: Transform
+   def transforms (writer: Writer) = Seq(
+      new Chisel3ToHighFirrtl(),
+      new IRToWorkingIR(),
+      new ResolveAndCheck(),
+      new HighFirrtlToMiddleFirrtl(),
+      new ResolveAndCheck(),
+      transform,
+      new EmitFirrtl(writer)
+   )
+}
+
+trait HighTransformSpec extends SimpleTransformSpec {
+   def transform: Transform
+   def transforms (writer: Writer) = Seq(
+      new Chisel3ToHighFirrtl(),
+      new IRToWorkingIR(),
+      new ResolveAndCheck(),
+      transform,
+      new EmitFirrtl(writer)
+   )
+}