Packages

c

firrtl.transforms

ManipulateNamesAllowlistAnnotation

case class ManipulateNamesAllowlistAnnotation[A <: ManipulateNames[_]](targets: Seq[Seq[Target]], transform: Dependency[A]) extends ManipulateNamesListAnnotation[A] with Product with Serializable

Annotation to filter name manipulation to only manipulate specific Targets in a transform that subclasses ManipulateNames. Targets will be renamed if they are not listed in a ManipulateNamesBlocklistAnnotation and also listed in this annotation.

Not providing a ManipulateNamesAllowlistAnnotation means that all targets in a circuit may be renamed.

A

a sub-type of ManipulateNames

targets

FIRRTL IR targets to include in name manipulation

transform

the transform that this should apply to

Source
ManipulateNames.scala
Exceptions thrown

java.lang.IllegalArgumentException if any non-local targets are given

Note

All targets must be local. Name modification in a non-local target (e.g., a node in a specific instance) makes no structural modification and will be ignored during deduplication. If you want this behavior, use a combination of a sub-class of this annotation and a NoDedupAnnotation.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ManipulateNamesAllowlistAnnotation
  2. Serializable
  3. Serializable
  4. ManipulateNamesListAnnotation
  5. MultiTargetAnnotation
  6. Annotation
  7. Product
  8. Equals
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ManipulateNamesAllowlistAnnotation(targets: Seq[Seq[Target]], transform: Dependency[A])

    targets

    FIRRTL IR targets to include in name manipulation

    transform

    the transform that this should apply to

    Exceptions thrown

    java.lang.IllegalArgumentException if any non-local targets are given

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 duplicate(a: Seq[Seq[Target]]): ManipulateNamesAllowlistAnnotation[A]

    Create another instance of this Annotation

    Create another instance of this Annotation

    The inner Seqs correspond to the renames of the inner Seqs of targets

    Definition Classes
    ManipulateNamesAllowlistAnnotationMultiTargetAnnotation
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. def flat(): AnnotationSeq

    Assume RenameMap is Map(TargetA -> Seq(TargetA1, TargetA2, TargetA3), TargetB -> Seq(TargetB1, TargetB2)) After flat, this Annotation will be flat to the AnnotationSeq in the below form Seq(Seq(TargetA1), Seq(TargetB1), Seq(TargetC)); Seq(Seq(TargetA1), Seq(TargetB2), Seq(TargetC)) Seq(Seq(TargetA2), Seq(TargetB1), Seq(TargetC)); Seq(Seq(TargetA2), Seq(TargetB2), Seq(TargetC)) Seq(Seq(TargetA3), Seq(TargetB1), Seq(TargetC)); Seq(Seq(TargetA3), Seq(TargetB2), Seq(TargetC))

    Assume RenameMap is Map(TargetA -> Seq(TargetA1, TargetA2, TargetA3), TargetB -> Seq(TargetB1, TargetB2)) After flat, this Annotation will be flat to the AnnotationSeq in the below form Seq(Seq(TargetA1), Seq(TargetB1), Seq(TargetC)); Seq(Seq(TargetA1), Seq(TargetB2), Seq(TargetC)) Seq(Seq(TargetA2), Seq(TargetB1), Seq(TargetC)); Seq(Seq(TargetA2), Seq(TargetB2), Seq(TargetC)) Seq(Seq(TargetA3), Seq(TargetB1), Seq(TargetC)); Seq(Seq(TargetA3), Seq(TargetB2), Seq(TargetC))

    Definition Classes
    MultiTargetAnnotation
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def getTargets: Seq[Target]

    Returns all Target members in this annotation

    Returns all Target members in this annotation

    Definition Classes
    Annotation
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. def serialize: String

    Optional pretty print

    Optional pretty print

    Definition Classes
    Annotation
    Note

    rarely used

  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. val targets: Seq[Seq[Target]]

    Contains a nested sequence of Target

    Contains a nested sequence of Target

    Each inner Seq should contain a single element. For example:

    def targets = Seq(Seq(foo), Seq(bar))
    Definition Classes
    ManipulateNamesAllowlistAnnotationMultiTargetAnnotation
  19. val transform: Dependency[A]
  20. def update(renames: RenameMap): Seq[Annotation]

    Assume RenameMap is Map(TargetA -> Seq(TargetA1, TargetA2, TargetA3), TargetB -> Seq(TargetB1, TargetB2)) in the update, this Annotation is still one annotation, but the contents are renamed in the below form Seq(Seq(TargetA1, TargetA2, TargetA3), Seq(TargetB1, TargetB2), Seq(TargetC))

    Assume RenameMap is Map(TargetA -> Seq(TargetA1, TargetA2, TargetA3), TargetB -> Seq(TargetB1, TargetB2)) in the update, this Annotation is still one annotation, but the contents are renamed in the below form Seq(Seq(TargetA1, TargetA2, TargetA3), Seq(TargetB1, TargetB2), Seq(TargetC))

    Definition Classes
    MultiTargetAnnotationAnnotation
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

Inherited from Serializable

Inherited from ManipulateNamesListAnnotation[A]

Inherited from MultiTargetAnnotation

Inherited from Annotation

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped