li.cil.tis3d.common.module.execution.instruction

Interface Instruction

All Known Implementing Classes:

InstructionAdd, InstructionAddImmediate, InstructionBitwiseAnd, InstructionBitwiseAndImmediate, InstructionBitwiseNot, InstructionBitwiseOr, InstructionBitwiseOrImmediate, InstructionBitwiseShiftLeft, InstructionBitwiseShiftLeftImmediate, InstructionBitwiseShiftRight, InstructionBitwiseShiftRightImmediate, InstructionBitwiseXor, InstructionBitwiseXorImmediate, InstructionDiv, InstructionDivImmediate, InstructionHaltAndCatchFire, InstructionJump, InstructionJumpEqualZero, InstructionJumpGreaterThanZero, InstructionJumpLessThanZero, InstructionJumpNotZero, InstructionJumpRelative, InstructionJumpRelativeImmediate, InstructionLastRotateLeft, InstructionLastRotateRight, InstructionMove, InstructionMoveImmediate, InstructionMul, InstructionMulImmediate, InstructionNegate, InstructionSave, InstructionSubtract, InstructionSubtractImmediate, InstructionSwap

public interface Instruction

A single instruction that can be executed by the execution module.

Note that instructions must not have any mutable state! They always operate on the machine given to them, and the pipes connected to that machine. Their only state is their configuration.

Method Summary

Modifier and Type	Method and Description
default void	onBeforeWriteComplete(MachineImpl machine, Port port) Take action based on pending write operation completion, e.g.
default void	onWriteCompleted(Machine machine, Port port) Finish a write operation started by the instruction, usually by advancing the program counter.
void	step(Machine machine) Update the instruction, when it is done it must increment the machine's program counter itself.

Method Detail

step

void step(Machine machine)

Update the instruction, when it is done it must increment the machine's program counter itself.

Parameters:

machine - the machine to run the instruction on.

onBeforeWriteComplete

default void onBeforeWriteComplete(MachineImpl machine,
                                   Port port)

Take action based on pending write operation completion, e.g. to abort other writes when a value should only be readable once.

Parameters:

machine - the machine the operation will finish on.

port - the port the operation will finish on.

See Also:

Module.onBeforeWriteComplete(Port)

onWriteCompleted

default void onWriteCompleted(Machine machine,
                              Port port)

Finish a write operation started by the instruction, usually by advancing the program counter.

Instructions must always await or cancel a write operation they started.

Parameters:

machine - the machine the operation finished on.

port - the port the operation finished on.