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.  lazy val classToObject: LinkedHashMap[Dependency, Phase]

   Store of conversions between classes and objects.

   Store of conversions between classes and objects. Objects that do not exist in the map will be lazily constructed.

   Attributes

   protected

   Definition Classes

   DependencyManager

6.  def clone(): AnyRef

   Attributes

   protected[lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... ) @native()

7.  val colormap: Seq[String]

   This colormap uses Colorbrewer's 4-class OrRd color scheme

   This colormap uses Colorbrewer's 4-class OrRd color scheme

   Attributes

   protected

   Definition Classes

   DependencyManager

8.  def copy(a: Seq[Dependency], b: Seq[Dependency], c: Set[Phase]): PhaseManager

   A method that will create a copy of this DependencyManager, but with different requirements.

   A method that will create a copy of this DependencyManager, but with different requirements. This is used to solve sub-problems arising from invalidations.

   Attributes

   protected

   Definition Classes

   PhaseManager → DependencyManager

9.  val currentState: Seq[PhaseDependency]

   A sequence of firrtl.Transforms that have been run.

   A sequence of firrtl.Transforms that have been run. Internally, this will be converted to an ordered set.

   Definition Classes

   PhaseManager → DependencyManager

10.  def dependenciesToGraphviz: String

    Convert all prerequisites, dependents, and invalidates to a Graphviz representation.

    Convert all prerequisites, dependents, and invalidates to a Graphviz representation.

    Definition Classes

    DependencyManager

11.  lazy val dependencyGraph: DiGraph[Phase]

    A directed graph consisting of all prerequisites, including prerequisites derived from dependents

    A directed graph consisting of all prerequisites, including prerequisites derived from dependents

    Definition Classes

    DependencyManager

12.  def dependents: Seq[Dependency]

    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

13.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

14.  def equals(arg0: Any): Boolean

    Definition Classes

    AnyRef → Any

15.  def finalize(): Unit

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

16.  lazy val flattenedTransformOrder: Seq[Phase]

    A version of the transformOrder that flattens the transforms of any internal DependencyManagers.

    A version of the transformOrder that flattens the transforms of any internal DependencyManagers.

    Definition Classes

    DependencyManager

17.  final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

18.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

19.  lazy val invalidateGraph: DiGraph[Phase]

    A directed graph consisting of invalidation edges

    A directed graph consisting of invalidation edges

    Definition Classes

    DependencyManager

20.  def invalidates(a: Phase): Boolean

    A function that, given a transform will return true if this transform invalidates/undos the effects of the input transform

    A function that, given a transform will return true if this transform invalidates/undos the effects of the input transform

    Definition Classes

    DependencyAPI

    Note

    Can a Phase ever invalidate itself?

21.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

22.  val knownObjects: Set[Phase]

    Existing transform objects that have already been constructed

    Existing transform objects that have already been constructed

    Definition Classes

    PhaseManager → DependencyManager

23.  val logger: Logger

    Definition Classes

    LazyLogging

24.  lazy val name: String

    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

    Phase → TransformLike

    Note

    Override this with your own implementation for different naming behavior.

25.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

26.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

27.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

28.  def prerequisites: Seq[Dependency]

    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.

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

    Definition Classes

    AnyRef

30.  val targets: Seq[PhaseDependency]

    Requested TransformLikes that should be run.

    Requested TransformLikes that should be run. Internally, this will be converted to a set based on the ordering defined here.

    Definition Classes

    PhaseManager → DependencyManager

31.  def toString(): String

    Definition Classes

    AnyRef → Any

32.  final def transform(annotations: AnnotationSeq): AnnotationSeq

    A mathematical transform on some type

    A mathematical transform on some type

    returns

    an output object of the same type

    Definition Classes

    DependencyManager → TransformLike

33.  lazy val transformOrder: Seq[Phase]

    An ordering of TransformLikes that causes the requested targets to be executed starting from the currentState.

    An ordering of TransformLikes that causes the requested targets to be executed starting from the currentState. This ordering respects prerequisites, dependents, and invalidates of all constituent TransformLikes. This uses an algorithm that attempts to reduce the number of re-lowerings due to invalidations. Re-lowerings are implemented as new DependencyManagers.

    Definition Classes

    DependencyManager

    Exceptions thrown

    DependencyManagerException if a cycle exists in either the dependencyGraph or the invalidateGraph.

34.  def transformOrderToGraphviz(colormap: Seq[String] = colormap): String

    Definition Classes

    DependencyManager

35.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

37.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... ) @native()

38.  def wrappers: Seq[(Phase) ⇒ Phase]

    A sequence of wrappers to apply to the resulting TransformLike sequence.

    A sequence of wrappers to apply to the resulting TransformLike sequence. This can be used to, e.g., add automated pre-processing and post-processing.

    Definition Classes

    DependencyManager