From 4cffd184397905eeb79e2df0913b4ded97dc8558 Mon Sep 17 00:00:00 2001
From: Jack Koenig
Date: Thu, 23 Mar 2017 14:56:26 -0700
Subject: Add TargetDirAnnotation to give transforms access (#503)

Also add GlobalCircuitAnnotation for creating similar annotations---
 src/main/scala/firrtl/Driver.scala                 |  7 ++-
 .../scala/firrtl/ExecutionOptionsManager.scala     |  3 +
 src/main/scala/firrtl/annotations/Annotation.scala | 17 ++++++
 .../annotationTests/TargetDirAnnotationSpec.scala  | 71 ++++++++++++++++++++++
 4 files changed, 97 insertions(+), 1 deletion(-)
 create mode 100644 src/test/scala/firrtlTests/annotationTests/TargetDirAnnotationSpec.scala

(limited to 'src')

diff --git a/src/main/scala/firrtl/Driver.scala b/src/main/scala/firrtl/Driver.scala
index 0fe2119d..94cfface 100644
--- a/src/main/scala/firrtl/Driver.scala
+++ b/src/main/scala/firrtl/Driver.scala
@@ -164,8 +164,13 @@ object Driver {
     // Output Annotations
     val outputAnnos = firrtlConfig.getEmitterAnnos(optionsManager)
 
+    // Should these and outputAnnos be moved to loadAnnotations?
+    val globalAnnos = Seq(TargetDirAnnotation(optionsManager.targetDirName))
+
     val finalState = firrtlConfig.compiler.compile(
-      CircuitState(parsedInput, ChirrtlForm, Some(AnnotationMap(firrtlConfig.annotations ++ outputAnnos))),
+      CircuitState(parsedInput,
+                   ChirrtlForm,
+                   Some(AnnotationMap(firrtlConfig.annotations ++ outputAnnos ++ globalAnnos))),
       firrtlConfig.customTransforms
     )
 
diff --git a/src/main/scala/firrtl/ExecutionOptionsManager.scala b/src/main/scala/firrtl/ExecutionOptionsManager.scala
index 7bba50a5..2e95ee0c 100644
--- a/src/main/scala/firrtl/ExecutionOptionsManager.scala
+++ b/src/main/scala/firrtl/ExecutionOptionsManager.scala
@@ -46,6 +46,9 @@ case class CommonOptions(
   }
 }
 
+/** [[annotations.GlobalCircuitAnnotation]] that contains the [[CommonOptions]] target directory */
+object TargetDirAnnotation extends GlobalCircuitAnnotation
+
 trait HasCommonOptions {
   self: ExecutionOptionsManager =>
   var commonOptions = CommonOptions()
diff --git a/src/main/scala/firrtl/annotations/Annotation.scala b/src/main/scala/firrtl/annotations/Annotation.scala
index cbc9bf1c..f96724c6 100644
--- a/src/main/scala/firrtl/annotations/Annotation.scala
+++ b/src/main/scala/firrtl/annotations/Annotation.scala
@@ -41,3 +41,20 @@ object DeletedAnnotation {
     case _ => None
   }
 }
+
+/** Parent class to create global annotations
+  *
+  * These annotations are Circuit-level and available to every transform
+  */
+abstract class GlobalCircuitAnnotation {
+  private lazy val marker = this.getClass.getName
+  def apply(value: String): Annotation =
+    Annotation(CircuitTopName, classOf[Transform], s"$marker:$value")
+  def unapply(a: Annotation): Option[String] = a match {
+    // Assumes transform is already filtered appropriately
+    case Annotation(CircuitTopName, _, str) if str.startsWith(marker) =>
+      Some(str.stripPrefix(s"$marker:"))
+    case _ => None
+  }
+}
+
diff --git a/src/test/scala/firrtlTests/annotationTests/TargetDirAnnotationSpec.scala b/src/test/scala/firrtlTests/annotationTests/TargetDirAnnotationSpec.scala
new file mode 100644
index 00000000..60cbf0fc
--- /dev/null
+++ b/src/test/scala/firrtlTests/annotationTests/TargetDirAnnotationSpec.scala
@@ -0,0 +1,71 @@
+// See LICENSE for license details.
+
+package firrtlTests
+package annotationTests
+
+import firrtlTests._
+import firrtl._
+
+/** Looks for [[TargetDirAnnotation]] */
+class FindTargetDirTransform(expected: String) extends Transform {
+  def inputForm = HighForm
+  def outputForm = HighForm
+  var foundTargetDir = false
+  var run = false
+  def execute(state: CircuitState): CircuitState = {
+    run = true
+    state.annotations.foreach { aMap =>
+      aMap.annotations.collectFirst {
+        case TargetDirAnnotation(expected) =>
+          foundTargetDir = true
+      }
+    }
+    state
+  }
+}
+
+class TargetDirAnnotationSpec extends FirrtlFlatSpec {
+  behavior of "The target directory"
+
+  val input =
+    """circuit Top :
+      |  module Top :
+      |    input foo : UInt<32>
+      |    output bar : UInt<32>
+      |    bar <= foo
+      """.stripMargin
+  val targetDir = "a/b/c"
+
+  it should "be available as an annotation when using execution options" in {
+    val findTargetDir = new FindTargetDirTransform(targetDir) // looks for the annotation
+
+    val optionsManager = new ExecutionOptionsManager("TargetDir") with HasFirrtlOptions {
+      commonOptions = commonOptions.copy(targetDirName = targetDir,
+                                         topName = "Top")
+      firrtlOptions = firrtlOptions.copy(compilerName = "high",
+                                         firrtlSource = Some(input),
+                                         customTransforms = Seq(findTargetDir))
+    }
+    Driver.execute(optionsManager)
+
+    // Check that FindTargetDirTransform transform is run and finds the annotation
+    findTargetDir.run should be (true)
+    findTargetDir.foundTargetDir should be (true)
+
+    // Delete created directory
+    val dir = new java.io.File(targetDir)
+    dir.exists should be (true)
+    FileUtils.deleteDirectoryHierarchy("a") should be (true)
+  }
+
+  it should "NOT be available as an annotation when using a raw compiler" in {
+    val findTargetDir = new FindTargetDirTransform(targetDir) // looks for the annotation
+    val compiler = new VerilogCompiler
+    val circuit = Parser.parse(input split "\n")
+    compiler.compileAndEmit(CircuitState(circuit, HighForm), Seq(findTargetDir))
+
+    // Check that FindTargetDirTransform does not find the annotation
+    findTargetDir.run should be (true)
+    findTargetDir.foundTargetDir should be (false)
+  }
+}
-- 
cgit v1.2.3