class AddImplicitOutputFile extends Phase
Phase that adds an OutputFileAnnotation if one does not already exist.
To determine the OutputFileAnnotation, the following precedence is used. Whichever happens first succeeds:
- Do nothing if an OutputFileAnnotation "--split-verilog" was specified
- Use the main in the first discovered FirrtlCircuitAnnotation (see note below)
- Use "a"
- Alphabetic
- By Inheritance
- AddImplicitOutputFile
- Phase
- DependencyAPI
- TransformLike
- LazyLogging
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new AddImplicitOutputFile()
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 AddImplicitOutputFile toany2stringadd[AddImplicitOutputFile] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (AddImplicitOutputFile, B)
- Implicit
- This member is added by an implicit conversion from AddImplicitOutputFile toArrowAssoc[AddImplicitOutputFile] 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()
- def ensuring(cond: (AddImplicitOutputFile) => Boolean, msg: => Any): AddImplicitOutputFile
- Implicit
- This member is added by an implicit conversion from AddImplicitOutputFile toEnsuring[AddImplicitOutputFile] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (AddImplicitOutputFile) => Boolean): AddImplicitOutputFile
- Implicit
- This member is added by an implicit conversion from AddImplicitOutputFile toEnsuring[AddImplicitOutputFile] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): AddImplicitOutputFile
- Implicit
- This member is added by an implicit conversion from AddImplicitOutputFile toEnsuring[AddImplicitOutputFile] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): AddImplicitOutputFile
- Implicit
- This member is added by an implicit conversion from AddImplicitOutputFile toEnsuring[AddImplicitOutputFile] 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])
- 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()
- 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
- AddImplicitOutputFile → DependencyAPI
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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
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 optionalPrerequisiteOf: Seq[Nothing]
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
- AddImplicitOutputFile → 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[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
- 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[Nothing]
All transform that must run before this transform
All transform that must run before this transform
- Definition Classes
- AddImplicitOutputFile → DependencyAPI
- Note
The use of a Seq here is to preserve input order. Internally, this will be converted to a private, ordered Set.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def transform(annotations: AnnotationSeq): AnnotationSeq
Add an OutputFileAnnotation to an AnnotationSeq
Add an OutputFileAnnotation to an AnnotationSeq
- returns
an output object of the same type
- Definition Classes
- AddImplicitOutputFile → TransformLike
- 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()
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from AddImplicitOutputFile toStringFormat[AddImplicitOutputFile] 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,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): (AddImplicitOutputFile, B)
- Implicit
- This member is added by an implicit conversion from AddImplicitOutputFile toArrowAssoc[AddImplicitOutputFile] 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.