avail/avail.interpreter.levelTwo/L2NamedOperandType

L2NamedOperandType

class L2NamedOperandType

An L2NamedOperandType is used to specify both an L2OperandType and a String naming its purpose with respect to some L2Operation. This effectively allows operations to declare named operands, increasing the descriptiveness of the level two instruction set. The names are not used in any way at runtime.

Author

Mark van Gulik

Todd L Smith

Parameters

operandType

The L2OperandType to wrap.

name

The name of this operand.

purpose

The Purpose that best describes the L2NamedOperandType, if any.

Types

enum Purpose : Enum<L2NamedOperandType.Purpose>

A Purpose specifies additional semantic meaning for an L2NamedOperandType.

Properties

val name: String

The String that names the receiver within an L2Operation.

val operandType: L2OperandType

The L2OperandType that the receiver decorates.

val purpose: L2NamedOperandType.Purpose?

The Purpose that best describes the L2NamedOperandType, if any.

Functions

fun name(): String

Answer the String that names the receiver.

fun operandType(): L2OperandType

Answer the L2OperandType that this decorates.

fun purpose(): L2NamedOperandType.Purpose?

Answer the Purpose that best describes the L2NamedOperandType, if any.

open override fun toString(): String