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
Linear Supertypes
Named, AnyRef, Any
Known Subclasses
CircuitTarget, CompleteTarget, GenericTarget, InstanceTarget, IsComponent, IsMember, IsModule, ModuleTarget, ReferenceTarget
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Target
  2. Named
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def circuitOpt: Option[String]

    returns

    Circuit name, if it exists

  2. abstract def getComplete: Option[CompleteTarget]

    returns

    If legal, convert this Target into a CompleteTarget

  3. abstract def isLocal: Boolean

    Whether the target is directly instantiated in its root module

  4. abstract def moduleOpt: Option[String]

    returns

    Module name, if it exists

  5. abstract def path: Seq[(Instance, OfModule)]

    returns

    Returns the instance hierarchy path, if one exists

  6. abstract def toTarget: CompleteTarget
    Definition Classes
    Named
  7. abstract def tokens: Seq[TargetToken]

    returns

    Target tokens

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. def complete: CompleteTarget

    returns

    Converts this Target into a CompleteTarget

  7. def encapsulatedBy(other: IsModule): Boolean

    Checks whether this is inside of other

  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. def modify(circuitOpt: Option[String] = circuitOpt, moduleOpt: Option[String] = moduleOpt, tokens: Seq[TargetToken] = tokens): GenericTarget

    returns

    Returns a new GenericTarget with new values

  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. def prettyPrint(tab: String = ""): String

    Pretty serialization, ideal for error messages.

    Pretty serialization, ideal for error messages. Cannot be deserialized.

    returns

    Human-readable serialization

  19. def serialize: String

    returns

    Human-readable serialization

    Definition Classes
    Target → Named
  20. def sharedRoot(other: Target): Boolean

    Share root module

  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. def toGenericTarget: GenericTarget

    returns

    Converts this Target into a GenericTarget

  23. def toNamed: Named

    returns

    Converts this Target into either a CircuitName, ModuleName, or ComponentName

  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. def tryToComplete: Target

    returns

    Converts this Target into a CompleteTarget, or if it can't, return original Target

  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Named

Inherited from AnyRef

Inherited from Any

Ungrouped