Compiler

Abstract Value Members

abstract def emitter: Emitter
abstract def transforms: Seq[Transform]

The sequence of transforms this compiler will execute
The sequence of transforms this compiler will execute

Note
The inputForm of a given transform must be higher than or equal to the ouputForm of the preceding transform. See CircuitForm

Concrete 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[java.lang]
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @throws( ... )
def compile(state: CircuitState, customTransforms: Seq[Transform]): CircuitState

Perform compilation
Perform compilation
Emission will only be performed if EmitAnnotations are present
state
The Firrtl AST to compile
customTransforms
Any custom Transforms that will be inserted into the compilation process by CompilerUtils.mergeTransforms
returns
result of compilation
def compileAndEmit(state: CircuitState, customTransforms: Seq[Transform] = Seq.empty): CircuitState

Perform compilation and emit the whole Circuit
Perform compilation and emit the whole Circuit
This is intended as a convenience method wrapping up Annotation creation for the common case. It creates a EmitCircuitAnnotation that will be consumed by this Transform's emitter. The EmittedCircuit can be extracted from the returned CircuitState via CircuitState.emittedCircuitOption
state
The Firrtl AST to compile
customTransforms
Any custom Transforms that will be inserted into the compilation process by CompilerUtils.mergeTransforms
returns
result of compilation with emitted circuit annotated
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def inputForm: CircuitForm
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val logger: Logger

Definition Classes
LazyLogging
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
def outputForm: CircuitForm
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def compile(state: CircuitState, writer: Writer, customTransforms: Seq[Transform] = Seq.empty): CircuitState

Perform compilation
Perform compilation
state
The Firrtl AST to compile
writer
The java.io.Writer where the output of compilation will be emitted
customTransforms
Any custom Transforms that will be inserted into the compilation process by CompilerUtils.mergeTransforms

Annotations
@deprecated
Deprecated
(Since version firrtl 1.0) Please use compileAndEmit or other compile method instead
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

Related Doc: package firrtl

trait Compiler extends LazyLogging

Abstract Value Members

abstract def emitter: Emitter

abstract def transforms: Seq[Transform]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def compile(state: CircuitState, customTransforms: Seq[Transform]): CircuitState

def compileAndEmit(state: CircuitState, customTransforms: Seq[Transform] = Seq.empty): CircuitState

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

final def getClass(): Class[_]

def hashCode(): Int

def inputForm: CircuitForm

final def isInstanceOf[T0]: Boolean

val logger: Logger

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def outputForm: CircuitForm

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

final def wait(): Unit

Deprecated Value Members

def compile(state: CircuitState, writer: Writer, customTransforms: Seq[Transform] = Seq.empty): CircuitState

def finalize(): Unit

Inherited from LazyLogging

Inherited from AnyRef

Inherited from Any

Ungrouped