sealed trait Target extends Named
Refers to something in a FIRRTL firrtl.ir.Circuit. Used for Annotation targets.
Can be in various states of completion/resolved:
- Legal: TargetToken's in tokens are in an order that makes sense
- Complete: circuitOpt and moduleOpt are non-empty, and all Instance(_) are followed by OfModule(_)
- Local: tokens does not refer to things through an instance hierarchy (no Instance(_) or OfModule(_) tokens)
- Source
- Target.scala
- Alphabetic
- By Inheritance
- Target
- Named
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def circuitOpt: Option[String]
- returns
Circuit name, if it exists
- abstract def getComplete: Option[CompleteTarget]
- returns
If legal, convert this Target into a CompleteTarget
- abstract def isLocal: Boolean
Whether the target is directly instantiated in its root module
- abstract def moduleOpt: Option[String]
- returns
Module name, if it exists
- abstract def path: Seq[(Instance, OfModule)]
- returns
Returns the instance hierarchy path, if one exists
- abstract def toTarget: CompleteTarget
- Definition Classes
- Named
- abstract def tokens: Seq[TargetToken]
- returns
Target tokens
Concrete 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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def complete: CompleteTarget
- returns
Converts this Target into a CompleteTarget
- def encapsulatedBy(other: IsModule): Boolean
Checks whether this is inside of other
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def modify(circuitOpt: Option[String] = circuitOpt, moduleOpt: Option[String] = moduleOpt, tokens: Seq[TargetToken] = tokens): GenericTarget
- returns
Returns a new GenericTarget with new values
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def prettyPrint(tab: String = ""): String
Pretty serialization, ideal for error messages.
Pretty serialization, ideal for error messages. Cannot be deserialized.
- returns
Human-readable serialization
- def serialize: String
- def sharedRoot(other: Target): Boolean
Share root module
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toGenericTarget: GenericTarget
- returns
Converts this Target into a GenericTarget
- def toNamed: Named
- returns
Converts this Target into either a CircuitName, ModuleName, or ComponentName
- def toString(): String
- Definition Classes
- AnyRef → Any
- def tryToComplete: Target
- returns
Converts this Target into a CompleteTarget, or if it can't, return original Target
- 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]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
This is the documentation for Firrtl.