case class XDCAnnotation(destinationFile: XDCDestinationFile, formatString: String, argumentList: ReferenceTarget*) extends Annotation with XDCAnnotationConstants with HasSerializationHints with DontTouchAllTargets with Product with Serializable
Encode a string to be emitted to an XDC file with specifiers derived from ReferenceTargets (RTs). RTs are called out in the format string using "{}" a la Python. This makes the emitted XDC more robust against the module hierarchy manipulations (such as promotion/extraction and linking) that Golden Gate performs.
For example: XDCAnnotation("get_pins -of [get_clocks {}]", clockRT)
Would eventually emit: get_pins -of [get_clocks absolute/path/to/clock]
Here the emission pass by default creates a full instance path to the reference to avoid multiple matches.
Restrictions: 1. Multiple specifiers in a string are permitted. However, to simplify emission under more complex duplication conditions, all RTs must share the same explicit root module (i.e their module parameter is the same). . 2. Specifiers currently cannot point at aggregates. This will be resolved in a future PR.
- Alphabetic
- By Inheritance
- XDCAnnotation
- Serializable
- DontTouchAllTargets
- HasDontTouches
- HasSerializationHints
- XDCAnnotationConstants
- Annotation
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new XDCAnnotation(destinationFile: XDCDestinationFile, formatString: String, argumentList: ReferenceTarget*)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val argumentList: ReferenceTarget*
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- val destinationFile: XDCDestinationFile
- def dontTouches: Iterable[ReferenceTarget]
- Definition Classes
- DontTouchAllTargets → HasDontTouches
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val formatString: String
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def getTargets: Seq[Target]
- Definition Classes
- Annotation
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def serialize: String
- Definition Classes
- Annotation
- val specifierRegex: Regex
- Definition Classes
- XDCAnnotationConstants
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def typeHints: Seq[Class[_]]
- Definition Classes
- XDCAnnotation → HasSerializationHints
- def update(renames: RenameMap): Seq[Annotation]
- Definition Classes
- XDCAnnotation → Annotation
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- val xdcHeader: String
- Definition Classes
- XDCAnnotationConstants