TransformManager
Related Docs:
object TransformManager
| package stage
the transforms you want to run
the transforms that have already run
existing transform objects that have already been constructed
This colormap uses Colorbrewer's 4-class OrRd color scheme
This colormap uses Colorbrewer's 4-class OrRd color scheme
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.
the transforms that have already run
the transforms that have already run
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.
the current tab setting
the character set in use
the number of nodes at the current level of the tree
Convert all prerequisites, optionalPrerequisites, optionalPrerequisiteOf, and invalidates to a Graphviz representation.
Convert all prerequisites, optionalPrerequisites, optionalPrerequisiteOf, and invalidates to a Graphviz representation.
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
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.
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.
Input Firrtl AST
A transformed Firrtl AST
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.
A directed graph consisting of invalidation edges
A directed graph consisting of invalidation edges
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).
transform
existing transform objects that have already been constructed
existing transform objects that have already been constructed
A convenience function useful for debugging and error messages
A convenience function useful for debugging and error messages
A sequence of transforms to add this transform as an optionalPrerequisite.
A sequence of transforms to add this transform as an optionalPrerequisite. The use of optionalPrerequisiteOf
enables the transform declaring them to always run before some other transforms. However, declaring
optionalPrerequisiteOf 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.
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.
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.
The use of a Seq here is to preserve input order. Internally, this will be converted to a private, ordered Set.
All transform that must run before this transform
All transform that must run before this transform
The use of a Seq here is to preserve input order. Internally, this will be converted to a private, ordered Set.
Textually show the determined transform order
Textually show the determined transform order
an indentation string to use for every line of output
a collection of characters to use when printing
Helper utility when recursing during pretty printing
Helper utility when recursing during pretty printing
an indentation string to use for every line of output
a collection of characters to use when printing
Perform the transform and update annotations.
Perform the transform and update annotations.
Input Firrtl AST
A transformed Firrtl AST
the transforms you want to run
the transforms you want to run
A mathematical transform on some type
A mathematical transform on some type
an output object of the same type
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 DependencyManagers.
DependencyManagerException if a cycle exists in either the dependencyGraph or the invalidateGraph.
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.
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.
(Since version FIRRTL 1.3) Due to confusion, 'dependents' is being renamed to 'optionalPrerequisiteOf'. Override the latter instead.
The use of a Seq here is to preserve input order. Internally, this will be converted to a private, ordered Set.
firrtl.passes.CheckTypes for an example of an optional checking firrtl.Transform
Convenience method to get annotations relevant to this Transform
Convenience method to get annotations relevant to this Transform
The CircuitState form which to extract annotations
A collection of annotations
(Since version 1.1) Just collect the actual Annotation types the transform wants
(Since version FIRRTL 1.3) Use Dependency API methods for equivalent functionality. See: https://bit.ly/2Voppre
(Since version FIRRTL 1.3) Use Dependency API methods for equivalent functionality. See: https://bit.ly/2Voppre
A Transform that ensures some other Transforms and their prerequisites are executed.