Frame

class Frame( val outerFrame: Frame?, val code: A_RawFunction, val debugName: String)

An abstract representation of an invocation. Note that this is not itself an L2SemanticValue, but is used by some specific kinds of semantic values. The outermost Frame has an outerFrame of null, and all other frames have a non-null outer frame. Frames compare by identity.

Parameters

outerFrame

The frame that was active at the point where an invocation of this frame occurred, or null if this is the outermost frame.

code

The actual A_RawFunction that has the L1 code for this frame.

debugName

What to name this frame.

Constructors

Frame

fun Frame( outerFrame: Frame?, code: A_RawFunction, debugName: String)

Construct a new Frame representing a call within the given frame.

Functions

depth

fun depth(): Int

Answer the depth of this frame, which is how many invocations deep it is relative to the outermost frame represented by an L2Chunk. Note that frames compare by identity, so two frames with the same depth are not necessarily equal.

function

fun function(): L2SemanticValue

Answer the L2SemanticValue representing this frame's function.

label

fun label(): L2SemanticValue

Answer the L2SemanticValue representing this frame's label.

outer

fun outer(outerIndex: Int, optionalName: String?): L2SemanticValue

Answer the L2SemanticValue representing one of this frame's function's captured outer values.

reifiedCaller

fun reifiedCaller(): L2SemanticValue

Answer an L2SemanticValue that represents the reified caller continuation.

result

fun result(): L2SemanticValue

Answer the L2SemanticValue representing the return result from this frame.

slot

fun slot( slotIndex: Int, afterPc: Int, optionalName: String?): L2SemanticValue

Answer the L2SemanticValue representing one of this frame's slots, as of just after the particular nybblecode that wrote it.

temp

fun temp(uniqueId: Int): L2SemanticValue

Answer the semantic value representing a new temporary value.

toString

open override fun toString(): String

transform

fun transform(topFrameReplacement: Frame, frameTransformer: (Frame) -> Frame): Frame

Transform the receiver via the given Function.

Properties

code

val code: A_RawFunction

The actual raw function that's associated with semantic values tied to this frame.

debugName

val debugName: String

The symbolic name to use to describe this frame. Note that it does not affect the identity of the frame, which is what's used for comparing and hashing.

outerFrame

val outerFrame: Frame?

The frame that was active at the site of the invocation that this frame represents.