Class/Object

firrtl.options.phases

DeletedWrapper

Related Docs: object DeletedWrapper | package phases

Permalink

class DeletedWrapper extends Phase with Translator[AnnotationSeq, (AnnotationSeq, AnnotationSeq)]

Wrap a Phase such that any Annotation removed by the wrapped Phase will be added as DeletedAnnotations.

Source
DeletedWrapper.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DeletedWrapper
  2. Translator
  3. Phase
  4. DependencyAPI
  5. TransformLike
  6. LazyLogging
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DeletedWrapper(p: Phase)

    Permalink

    p

    a Phase to wrap

Type Members

  1. type Dependency = Class[_ <: Phase]

    Permalink

    The type used to express dependencies: a class which itself has dependencies.

    The type used to express dependencies: a class which itself has dependencies.

    Definition Classes
    DependencyAPI

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. def aToB(a: AnnotationSeq): (AnnotationSeq, AnnotationSeq)

    Permalink

    A method converting type A into type B

    A method converting type A into type B

    returns

    an object of type B

    Definition Classes
    DeletedWrapperTranslator
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def bToA(b: (AnnotationSeq, AnnotationSeq)): AnnotationSeq

    Permalink

    A method converting type B back into type A

    A method converting type B back into type A

    returns

    an object of type A

    Definition Classes
    DeletedWrapperTranslator
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  8. def dependents: Seq[Dependency]

    Permalink

    All transforms that must run after this transform

    All transforms that must run after this transform

    This is a means of prerequisite injection into some other transform. Normally a transform will define its own prerequisites. Dependents exist for two main situations:

    First, they improve the composition of optional transforms. If some first transform is optional (e.g., an expensive validation check), you would like to be able to conditionally cause it to run. If it is listed as a prerequisite on some other, second transform then it must always run before that second transform. There's no way to turn it off. However, by listing the second transform as a dependent of the first transform, the first transform will only run (and be treated as a prerequisite of the second transform) if included in a list of target transforms that should be run.

    Second, an external library would like to inject some first transform before a second transform inside FIRRTL. In this situation, the second transform cannot have any knowledge of external libraries. The use of a dependent here allows for prerequisite injection into FIRRTL proper.

    Definition Classes
    DependencyAPI
    Note

    The use of a Seq here is to preserve input order. Internally, this will be converted to a private, ordered Set.

    See also

    firrtl.passes.CheckTypes for an example of an optional checking firrtl.Transform

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

    Permalink
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  13. def internalTransform(b: (AnnotationSeq, AnnotationSeq)): (AnnotationSeq, AnnotationSeq)

    Permalink

    A transform on an internal type

    A transform on an internal type

    b

    an object of type B

    returns

    an object of type B

    Definition Classes
    DeletedWrapperTranslator
  14. def invalidates(a: Phase): Boolean

    Permalink

    A function that, given *another* transform (parameter a) will return true if this transform invalidates/undos the effects of the *other* transform (parameter a).

    A function that, given *another* transform (parameter a) will return true if this transform invalidates/undos the effects of the *other* transform (parameter a).

    a

    transform

    Definition Classes
    DependencyAPI
  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. val logger: Logger

    Permalink
    Definition Classes
    LazyLogging
  17. lazy val name: String

    Permalink

    The name of this Phase.

    The name of this Phase. This will be used to generate debug/error messages or when deleting annotations. This will default to the simpleName of the class.

    returns

    this phase's name

    Definition Classes
    DeletedWrapperPhaseTransformLike
    Note

    Override this with your own implementation for different naming behavior.

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

    Permalink
    Definition Classes
    AnyRef
  19. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  21. def prerequisites: Seq[Dependency]

    Permalink

    All transform that must run before this transform

    All transform that must run before this transform

    Definition Classes
    DependencyAPI
    Note

    The use of a Seq here is to preserve input order. Internally, this will be converted to a private, ordered Set.

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

    Permalink
    Definition Classes
    AnyRef
  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  24. final def transform(a: AnnotationSeq): AnnotationSeq

    Permalink

    Convert the input object to the internal type, transform the internal type, and convert back to the original type

    Convert the input object to the internal type, transform the internal type, and convert back to the original type

    a

    an input object

    returns

    an output object of the same type

    Definition Classes
    TranslatorTransformLike
  25. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(): Unit

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

Deprecated Value Members

  1. def finalize(): Unit

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

    (Since version ) see corresponding Javadoc for more information.

Inherited from Phase

Inherited from DependencyAPI[Phase]

Inherited from TransformLike[AnnotationSeq]

Inherited from LazyLogging

Inherited from AnyRef

Inherited from Any

Ungrouped