class TransformManager extends Transform with DependencyAPIMigration with DependencyManager[CircuitState, Transform]
- Alphabetic
- By Inheritance
- TransformManager
- DependencyManager
- DependencyAPIMigration
- Transform
- DependencyAPI
- TransformLike
- LazyLogging
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
TransformManager(targets: Seq[TransformDependency], currentState: Seq[TransformDependency] = Seq.empty, knownObjects: Set[Transform] = Set.empty)
- targets
the transforms you want to run
- currentState
the transforms that have already run
- knownObjects
existing transform objects that have already been constructed
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
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( ... ) @native() @HotSpotIntrinsicCandidate()
-
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[Dependency[Transform]], b: Seq[Dependency[Transform]], c: Set[Transform]): TransformManager
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
- TransformManager → DependencyManager
-
val
currentState: Seq[TransformDependency]
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
- TransformManager → DependencyManager
-
def
customPrintHandling(tab: String, charSet: CharSet, size: Int): Option[PartialFunction[(Transform, 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[Transform]
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[Transform], Transform]
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
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
execute(state: CircuitState): CircuitState
Perform the transform, encode renaming with RenameMap, and can delete annotations Called by runTransform.
Perform the transform, encode renaming with RenameMap, and can delete annotations Called by runTransform.
- state
Input Firrtl AST
- returns
A transformed Firrtl AST
- Definition Classes
- TransformManager → Transform
-
lazy val
flattenedTransformOrder: Seq[Transform]
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[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
getLogger: Logger
- Definition Classes
- LazyLogging
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
lazy val
invalidateGraph: DiGraph[Transform]
A directed graph consisting of invalidation edges
A directed graph consisting of invalidation edges
- Definition Classes
- DependencyManager
-
def
invalidates(a: Transform): 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[Transform]
Existing transform objects that have already been constructed
Existing transform objects that have already been constructed
- Definition Classes
- TransformManager → DependencyManager
-
val
logger: Logger
- Attributes
- protected
- Definition Classes
- LazyLogging
-
def
name: String
A convenience function useful for debugging and error messages
A convenience function useful for debugging and error messages
- Definition Classes
- Transform → TransformLike
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
optionalPrerequisiteOf: Seq[Dependency[Transform]]
A sequence of transforms to add this transform as an
optionalPrerequisite
.A sequence of transforms to add this transform as an
optionalPrerequisite
. The use ofoptionalPrerequisiteOf
enables the transform declaring them to always run before some other transforms. However, declaringoptionalPrerequisiteOf
will 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
DependencyManager
with multiple targets.
-
def
optionalPrerequisites: Seq[Dependency[Transform]]
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[Transform]]
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 = ...): 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
runTransform(state: CircuitState): CircuitState
Perform the transform and update annotations.
Perform the transform and update annotations.
- state
Input Firrtl AST
- returns
A transformed Firrtl AST
- Definition Classes
- Transform
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
val
targets: Seq[TransformDependency]
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
- TransformManager → DependencyManager
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
transform(annotations: CircuitState): CircuitState
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[Transform]
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.DependencyManagerException
if a cycle exists in either the dependencyGraph or the invalidateGraph.
-
def
transformOrderToGraphviz(colormap: Seq[String] = colormap): String
- Definition Classes
- DependencyManager
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
wrappers: Seq[(Transform) ⇒ Transform]
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
dependents: Seq[Dependency[Transform]]
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
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.3) Due to confusion, 'dependents' is being renamed to 'optionalPrerequisiteOf'. Override the latter instead.
- 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
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated
-
final
def
inputForm: CircuitForm
- Definition Classes
- DependencyAPIMigration
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.3) Use Dependency API methods for equivalent functionality. See: https://bit.ly/2Voppre
-
final
def
outputForm: CircuitForm
- Definition Classes
- DependencyAPIMigration
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.3) Use Dependency API methods for equivalent functionality. See: https://bit.ly/2Voppre
This is the documentation for Firrtl.