L2CommentOperand

class L2CommentOperand(val comment: String) : L2Operand

An L2CommentOperand holds a descriptive string during level two translation, but this operand emits no actual data into the wordcode stream.

Author

Mark van Gulik

Parameters

comment

The comment string.

Constructors

Link copied to clipboard
fun L2CommentOperand(comment: String)

Construct a new L2CommentOperand with the specified comment String.

Functions

Link copied to clipboard
open fun addDestinationRegistersTo(destinationRegisters: MutableList<L2Register>)

Move any registers used as destinations within me into the provided list.

Link copied to clipboard
open fun addReadsTo(readOperands: MutableList<L2ReadOperand<*>>)

Capture all L2ReadOperands within this operand into the provided List.

Link copied to clipboard
open fun addSourceRegistersTo(sourceRegisters: MutableList<L2Register>)

Move any registers used as sources within me into the provided list.

Link copied to clipboard
open fun addWritesTo(writeOperands: MutableList<L2WriteOperand<*>>)

Capture all L2WriteOperands within this operand into the provided List.

Link copied to clipboard
open fun adjustCloneForInstruction(theInstruction: L2Instruction)

This is a freshly cloned operand. Adjust it for use in the given L2Instruction. Note that the new instruction has not yet been installed into an L2BasicBlock.

Link copied to clipboard
open override fun appendTo(builder: StringBuilder)

Write a description of this operand to the given StringBuilder.

Link copied to clipboard
fun appendWithWarningsTo(    builder: StringBuilder,     indent: Int,     warningStyleChange: (Boolean) -> Unit)

Append a textual representation of this operand to the provided StringBuilder. If a style change is appropriate while building the string, invoke the warningStyleChange lambda with true to enable the warning style, and false to turn it off again.

Link copied to clipboard
open fun assertHasBeenEmitted()

Assert that this operand knows its instruction, which should always be the case if the instruction has already been emitted.

Link copied to clipboard
open override fun clone(): L2Operand
Link copied to clipboard
open override fun dispatchOperand(dispatcher: L2OperandDispatcher)

Dispatch this L2Operand to the provided L2OperandDispatcher.

Link copied to clipboard
open fun instructionWasAdded(manifest: L2ValueManifest)

This is an operand of the given instruction, which was just added to its basic block. Its instruction was just set.

Link copied to clipboard
open fun instructionWasInserted(newInstruction: L2Instruction)

This is an operand of the given instruction, which was just inserted into its basic block as part of an optimization pass.

Link copied to clipboard
open fun instructionWasRemoved()

This is an operand of the given instruction, which was just removed from its basic block.

Link copied to clipboard
open fun postOptimizationCleanup()

Now that chunk optimization has completed, remove information from this instruction that will no longer be needed in the finished chunk. Note that during subsequent inlining of this chunk at a call site, the type and synonym information will be reconstructed without too much cost.

Link copied to clipboard
open fun replaceRegisters(registerRemap: Map<L2Register, L2Register>, theInstruction: L2Instruction)

Replace occurrences in this operand of each register that is a key of this map with the register that is the corresponding value. Do nothing to registers that are not keys of the map. Update all secondary structures, such as the instruction's source/destination collections.

Link copied to clipboard
open fun setInstruction(theInstruction: L2Instruction?)

Set the instructionOrNull field.

Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
open fun transformEachRead(transformer: (L2ReadOperand<*>) -> L2ReadOperand<*>): L2Operand

Transform each L2ReadOperand through the given lambda, producing either a new L2Operand of the same type, or the receiver.

Properties

Link copied to clipboard
val comment: String

The actual comment String.

Link copied to clipboard
val instruction: L2Instruction

Answer the L2Instruction containing this operand.

Link copied to clipboard
val instructionHasBeenEmitted: Boolean

Answer whether this write operand has been written yet as the destination of some instruction.

Link copied to clipboard
val isMisconnected: Boolean

Answer whether this operand is misconnected to its L2Instruction.

Link copied to clipboard
open override val operandType: L2OperandType

Answer this operand's L2OperandType.