Class

firrtl.transforms

ManipulateNamesBlocklistAnnotation

Related Doc: package transforms

Permalink

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

Annotation to prevent name manipulation ofTargets in a transform that subclasses ManipulateNames. All listed targets will not be modified.

A

a sub-type of ManipulateNames

targets

FIRRTL IR targets to exclude from 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.

Linear Supertypes
Serializable, Serializable, ManipulateNamesListAnnotation[A], MultiTargetAnnotation, Annotation, Product, Equals, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ManipulateNamesBlocklistAnnotation
  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 ManipulateNamesBlocklistAnnotation(targets: Seq[Seq[Target]], transform: Dependency[A])

    Permalink

    targets

    FIRRTL IR targets to exclude from 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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. def duplicate(a: Seq[Seq[Target]]): ManipulateNamesBlocklistAnnotation[A]

    Permalink

    Create another instance of this Annotation

    Create another instance of this Annotation

    Definition Classes
    ManipulateNamesBlocklistAnnotation → MultiTargetAnnotation

  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  9. def flat(): AnnotationSeq

    Permalink

    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[_]

    Permalink
    Definition Classes
    AnyRef → Any

  11. def getTargets: Seq[Target]

    Permalink

    Returns all Target members in this annotation

    Returns all Target members in this annotation

    Definition Classes
    Annotation

  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  16. def serialize: String

    Permalink

    Optional pretty print

    Optional pretty print

    Definition Classes
    Annotation
    Note

    rarely used

  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  18. val targets: Seq[Seq[Target]]

    Permalink

    FIRRTL IR targets to exclude from name manipulation

    FIRRTL IR targets to exclude from name manipulation

    Definition Classes
    ManipulateNamesBlocklistAnnotation → MultiTargetAnnotation

  19. val transform: Dependency[A]

    Permalink

    the transform that this should apply to

    the transform that this should apply to

    Definition Classes
    ManipulateNamesBlocklistAnnotation → ManipulateNamesListAnnotation

  20. def update(renames: RenameMap): Seq[Annotation]

    Permalink

    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
    MultiTargetAnnotation → Annotation

  21. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  22. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  23. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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