class PhaseManager extends DependencyManager[AnnotationSeq, Phase] with Phase
A Phase that will ensure that some other Phases and their prerequisites are executed.
This tries to determine a phase ordering such that an AnnotationSeq output is produced that has had all of the requested Phase target transforms run without having them be invalidated.
- Source
- DependencyManager.scala
- Alphabetic
- By Inheritance
- PhaseManager
- Phase
- DependencyManager
- DependencyAPI
- TransformLike
- LazyLogging
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new PhaseManager(targets: Seq[PhaseDependency], currentState: Seq[PhaseDependency] = Seq.empty, knownObjects: Set[Phase] = Set.empty)
- targets
the Phases you want to run
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from PhaseManager toany2stringadd[PhaseManager] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (PhaseManager, B)
- Implicit
- This member is added by an implicit conversion from PhaseManager toArrowAssoc[PhaseManager] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- 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
- def copy(a: Seq[PhaseDependency], b: Seq[PhaseDependency], 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
- val currentState: Seq[PhaseDependency]
A sequence of TransformLikes that have been run.
A sequence of TransformLikes that have been run. Internally, this will be converted to an ordered set.
- Definition Classes
- PhaseManager → DependencyManager
- def customPrintHandling(tab: String, charSet: CharSet, size: Int): Option[PartialFunction[(Phase, Int), Seq[String]]]
A method that can be overridden to define custom print handling.
A method that can be overridden to define custom print handling. This is useful if you would like to make some transform print additional information.
- tab
the current tab setting
- charSet
the character set in use
- size
the number of nodes at the current level of the tree
- Definition Classes
- DependencyManager
- def dependenciesToGraphviz: String
Convert all prerequisites, optionalPrerequisites, optionalPrerequisiteOf, and invalidates to a Graphviz representation.
Convert all prerequisites, optionalPrerequisites, optionalPrerequisiteOf, and invalidates to a Graphviz representation.
- Definition Classes
- DependencyManager
- lazy val dependencyGraph: DiGraph[Phase]
A directed graph consisting of all prerequisites, including prerequisites derived from optionalPrerequisites and optionalPrerequisiteOf
A directed graph consisting of all prerequisites, including prerequisites derived from optionalPrerequisites and optionalPrerequisiteOf
- Definition Classes
- DependencyManager
- lazy val dependencyToObject: LinkedHashMap[Dependency[Phase], 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
- def ensuring(cond: (PhaseManager) => Boolean, msg: => Any): PhaseManager
- Implicit
- This member is added by an implicit conversion from PhaseManager toEnsuring[PhaseManager] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (PhaseManager) => Boolean): PhaseManager
- Implicit
- This member is added by an implicit conversion from PhaseManager toEnsuring[PhaseManager] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): PhaseManager
- Implicit
- This member is added by an implicit conversion from PhaseManager toEnsuring[PhaseManager] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): PhaseManager
- Implicit
- This member is added by an implicit conversion from PhaseManager toEnsuring[PhaseManager] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- 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
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getLogger: Logger
- Definition Classes
- LazyLogging
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- lazy val invalidateGraph: DiGraph[Phase]
A directed graph consisting of invalidation edges
A directed graph consisting of invalidation edges
- Definition Classes
- DependencyManager
- def invalidates(a: Phase): Boolean
A function that, given *another* transform (parameter
a) will return true if this transform invalidates/undos the effects of the *other* transform (parametera).A function that, given *another* transform (parameter
a) will return true if this transform invalidates/undos the effects of the *other* transform (parametera).- a
transform
- Definition Classes
- DependencyManager → DependencyAPI
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val knownObjects: Set[Phase]
Existing transform objects that have already been constructed
Existing transform objects that have already been constructed
- Definition Classes
- PhaseManager → DependencyManager
- val logger: Logger
- Attributes
- protected
- Definition Classes
- LazyLogging
- 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
simpleNameof the class.- returns
this phase's name
- Definition Classes
- Phase → TransformLike
- Note
Override this with your own implementation for different naming behavior.
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def optionalPrerequisiteOf: Seq[Dependency[Phase]]
A sequence of transforms to add this transform as an
optionalPrerequisite.A sequence of transforms to add this transform as an
optionalPrerequisite. The use ofoptionalPrerequisiteOfenables the transform declaring them to always run before some other transforms. However, declaringoptionalPrerequisiteOfwill not result in the sequence of transforms executing.This is useful for providing an ordering constraint to guarantee that other transforms (e.g., emitters) will not be scheduled before you.
- Definition Classes
- DependencyManager → DependencyAPI
- Note
This method **will not** result in the listed transforms running. If you want to add multiple transforms at once, you should use a
DependencyManagerwith multiple targets.
- def optionalPrerequisites: Seq[Dependency[Phase]]
All transforms that, if a prerequisite of *another* transform, will run before this transform.
All transforms that, if a prerequisite of *another* transform, will run before this transform.
- Definition Classes
- DependencyManager → DependencyAPI
- Note
The use of a Seq here is to preserve input order. Internally, this will be converted to a private, ordered Set.
- def prerequisites: Seq[Dependency[Phase]]
All transform that must run before this transform
All transform that must run before this transform
- Definition Classes
- DependencyManager → DependencyAPI
- Note
The use of a Seq here is to preserve input order. Internally, this will be converted to a private, ordered Set.
- def prettyPrint(tab: String = "", charSet: CharSet = DependencyManagerUtils.PrettyCharSet): String
Textually show the determined transform order
Textually show the determined transform order
- tab
an indentation string to use for every line of output
- charSet
a collection of characters to use when printing
- Definition Classes
- DependencyManager
- def prettyPrintRec(tab: String, charSet: CharSet): Seq[String]
Helper utility when recursing during pretty printing
Helper utility when recursing during pretty printing
- tab
an indentation string to use for every line of output
- charSet
a collection of characters to use when printing
- Definition Classes
- DependencyManager
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- 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
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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
- 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, optionalPrerequisites, optionalPrerequisiteOf, 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 firrtl.options.DependencyManagers.
- Definition Classes
- DependencyManager
- Exceptions thrown
firrtl.options.DependencyManagerExceptionif a cycle exists in either the dependencyGraph or the invalidateGraph.
- def transformOrderToGraphviz(colormap: Seq[String] = colormap): String
- Definition Classes
- DependencyManager
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- 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
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from PhaseManager toStringFormat[PhaseManager] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (PhaseManager, B)
- Implicit
- This member is added by an implicit conversion from PhaseManager toArrowAssoc[PhaseManager] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.