IRLookup

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
def allTargets(r: ReferenceTarget): Seq[ReferenceTarget]

Given: A firrtl.annotations.ReferenceTarget of ~Top|Module>ref, which is a type of {foo: {bar: UInt}} Return: Seq(~Top|Module>ref, ~Top|Module>ref.foo, ~Top|Module>ref.foo.bar)
Given: A firrtl.annotations.ReferenceTarget of ~Top|Module>ref, which is a type of {foo: {bar: UInt}} Return: Seq(~Top|Module>ref, ~Top|Module>ref.foo, ~Top|Module>ref.foo.bar)
returns
a target to each sub-component, including intermediate subcomponents
final def asInstanceOf[T0]: T0

Definition Classes
Any
def asLocalRef(t: ReferenceTarget): ReferenceTarget
returns
the target converted to its local reference
Example:
1. Given ~Top|MyModule/inst:Other>foo.bar, returns ~Top|Other>foo
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @throws( ... )
def contains(mt: IsModule): Boolean

mt
firrtl.annotations.ModuleTarget or firrtl.annotations.InstanceTarget to be queried.
returns
whether a ModuleTarget or InstanceTarget is contained in this IRLookup
def contains(t: ReferenceTarget): Boolean

t
firrtl.annotations.ReferenceTarget to be queried.
returns
whether a ReferenceTarget is contained in this IRLookup
def declaration(t: ReferenceTarget): FirrtlNode

t
firrtl.annotations.ReferenceTarget to be queried.
returns
the statement containing the declaration of the target
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def expr(t: ReferenceTarget, flow: Flow = UnknownFlow): Expression

t
firrtl.annotations.ReferenceTarget to be queried.
flow
flow of the target
returns
expression of t
def flow(t: ReferenceTarget): Flow
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def getExpr(t: ReferenceTarget, flow: Flow): Option[Expression]

get expression of the target.
get expression of the target. It can return None for many reasons, including
- declaration is missing
- flow is wrong
- component is wrong
t
firrtl.annotations.ReferenceTarget to be queried.
flow
flow of the target
returns
Some(e) if expression exists, None if it does not
def hashCode(): Int

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

Definition Classes
Any
def kind(t: ReferenceTarget): Kind
def kindFinder(moduleTarget: ModuleTarget, kind: Kind): Seq[ReferenceTarget]

Find firrtl.annotations.ReferenceTarget with a specific firrtl.Kind in a firrtl.annotations.ModuleTarget
Find firrtl.annotations.ReferenceTarget with a specific firrtl.Kind in a firrtl.annotations.ModuleTarget
moduleTarget
firrtl.annotations.ModuleTarget to be queried.
kind
firrtl.Kind to be find.
returns
all firrtl.annotations.ReferenceTarget in this node.
def leafTargets(r: ReferenceTarget): Seq[ReferenceTarget]

Given: A firrtl.annotations.ReferenceTarget of ~Top|Module>ref and a type of {foo: {bar: UInt}} Return: Seq(~Top|Module>ref.foo.bar)
Given: A firrtl.annotations.ReferenceTarget of ~Top|Module>ref and a type of {foo: {bar: UInt}} Return: Seq(~Top|Module>ref.foo.bar)
returns
a target to each sub-component, excluding intermediate subcomponents.
def moduleLeafPortTargets(m: ModuleTarget): (Seq[(ReferenceTarget, Type)], Seq[(ReferenceTarget, Type)])

returns
Returns ((inputs, outputs)) target and type of each module port.
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 ports(mt: ModuleTarget): Seq[ReferenceTarget]

Returns the references to the module's ports
Returns the references to the module's ports
mt
firrtl.annotations.ModuleTarget to be queried.
returns
the port references of mt
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def tpe(t: ReferenceTarget): Type
def validPath(t: IsModule): Boolean

t
firrtl.annotations.ReferenceTarget to be queried.
returns
whether a given firrtl.annotations.IsModule is valid, given the circuit's module/instance hierarchy
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 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 Docs: object IRLookup | package analyses

class IRLookup extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def allTargets(r: ReferenceTarget): Seq[ReferenceTarget]

final def asInstanceOf[T0]: T0

def asLocalRef(t: ReferenceTarget): ReferenceTarget

def clone(): AnyRef

def contains(mt: IsModule): Boolean

def contains(t: ReferenceTarget): Boolean

def declaration(t: ReferenceTarget): FirrtlNode

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def expr(t: ReferenceTarget, flow: Flow = UnknownFlow): Expression

def flow(t: ReferenceTarget): Flow

final def getClass(): Class[_]

def getExpr(t: ReferenceTarget, flow: Flow): Option[Expression]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def kind(t: ReferenceTarget): Kind

def kindFinder(moduleTarget: ModuleTarget, kind: Kind): Seq[ReferenceTarget]

def leafTargets(r: ReferenceTarget): Seq[ReferenceTarget]

def moduleLeafPortTargets(m: ModuleTarget): (Seq[(ReferenceTarget, Type)], Seq[(ReferenceTarget, Type)])

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def ports(mt: ModuleTarget): Seq[ReferenceTarget]

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

def toString(): String

def tpe(t: ReferenceTarget): Type

def validPath(t: IsModule): Boolean

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

final def wait(arg0: Long): Unit

final def wait(): Unit

Deprecated Value Members

def finalize(): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped