1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
|
// See LICENSE for license details.
package firrtl
package annotations
import net.jcazevedo.moultingyaml._
import firrtl.annotations.AnnotationYamlProtocol._
case class AnnotationException(message: String) extends Exception(message)
final case class Annotation(target: Named, transform: Class[_ <: Transform], value: String) {
val targetString: String = target.serialize
val transformClass: String = transform.getName
/**
* This serialize is basically a pretty printer, actual serialization is handled by
* AnnotationYamlProtocol
* @return a nicer string than the raw case class default
*/
def serialize: String = {
s"Annotation(${target.serialize},${transform.getCanonicalName},$value)"
}
def update(tos: Seq[Named]): Seq[Annotation] = {
check(target, tos, this)
propagate(target, tos, duplicate)
}
def propagate(from: Named, tos: Seq[Named], dup: Named=>Annotation): Seq[Annotation] = tos.map(dup(_))
def check(from: Named, tos: Seq[Named], which: Annotation): Unit = {}
def duplicate(n: Named) = Annotation(n, transform, value)
}
object DeletedAnnotation {
def apply(xFormName: String, anno: Annotation): Annotation =
Annotation(anno.target, classOf[Transform], s"""DELETED by $xFormName\n${AnnotationUtils.toYaml(anno)}""")
private val deletedRegex = """(?s)DELETED by ([^\n]*)\n(.*)""".r
def unapply(a: Annotation): Option[(String, Annotation)] = a match {
case Annotation(named, t, deletedRegex(xFormName, annoString)) if t == classOf[Transform] =>
Some((xFormName, AnnotationUtils.fromYaml(annoString)))
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
}
}
|
