class FirrtlStage extends Stage
- Alphabetic
- By Inheritance
- FirrtlStage
- Stage
- Phase
- DependencyAPI
- TransformLike
- LazyLogging
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new FirrtlStage()
Type Members
-
type
Dependency = Class[_ <: Phase]
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
-
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()
-
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
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
execute(args: Array[String], annotations: AnnotationSeq): AnnotationSeq
Run this stage on on a mix of arguments and annotations
Run this stage on on a mix of arguments and annotations
- args
command line arguments
- returns
output annotations
- Definition Classes
- Stage
- Exceptions thrown
OptionsException
if command line or annotation validation fails
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
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?
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
val
logger: Logger
- 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
simpleName
of 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
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.
-
def
run(annotations: AnnotationSeq): AnnotationSeq
Run this stage on some input annotations
Run this stage on some input annotations
- annotations
input annotations
- returns
output annotations
- Definition Classes
- FirrtlStage → Stage
-
val
shell: Shell
A utility that helps convert command line options to annotations
A utility that helps convert command line options to annotations
- Definition Classes
- FirrtlStage → Stage
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
transform(annotations: AnnotationSeq): AnnotationSeq
Execute this stage on some input annotations.
Execute this stage on some input annotations. Annotations will be read from any input annotation files.
- annotations
input annotations
- returns
output annotations
- Definition Classes
- Stage → TransformLike
- Exceptions thrown
OptionsException
if command line or annotation validation fails
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
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()
This is the documentation for Firrtl.