opcode

Documentation

Overview

Package opcode defines our opcode to integer mapping.

Index

• Variables
• type Opcode
  • func NewOpcode(instruction byte) *Opcode
  • func (o *Opcode) String() string
  • func (o *Opcode) Value() byte

Variables

var (
	// EXIT is our first opcode.
	EXIT = 0x00

	// INT_STORE allows an integer to be stored in a register.
	INT_STORE = 0x01

	// INT_PRINT is used to print the integer contents of a register.
	INT_PRINT = 0x02

	// INT_TOSTRING converts an integer-register value to a string.
	INT_TOSTRING = 0x03

	// INT_RANDOM generates a random number.
	INT_RANDOM = 0x04

	// JUMP_TO is an unconditional jump.
	JUMP_TO = 0x10

	// JUMP_Z jumps if the Z-flag is set.
	JUMP_Z = 0x11

	// JUMP_NZ jumps if the Z-flag is NOT set.
	JUMP_NZ = 0x12

	// XOR_OP performs an XOR operation against two registers.
	XOR_OP = 0x20

	// ADD_OP performs an ADD operation against two registers.
	ADD_OP = 0x21

	// SUB_OP performs an MINUS operation against two registers.
	SUB_OP = 0x22

	// MUL_OP performs a MULTIPLY operation against two registers.
	MUL_OP = 0x23

	// DIV_OP performs a DIVIDE operation against two registers.
	DIV_OP = 0x24

	// INC_OP increments the given register by one.
	INC_OP = 0x25

	// DEC_OP decrements the given register by one.
	DEC_OP = 0x26

	// AND_OP performs a logical AND operation against two registers.
	AND_OP = 0x27

	// OR_OP performs a logical OR operation against two registers.
	OR_OP = 0x28

	// STRING_STORE stores a string in a register.
	STRING_STORE = 0x30

	// STRING_PRINT prints the string contents of a register.
	STRING_PRINT = 0x31

	// STRING_CONCAT joins two strings.
	STRING_CONCAT = 0x32

	// STRING_SYSTEM executes the system binary stored in the given string-register.
	STRING_SYSTEM = 0x33

	// STRING_TOINT converts the given string-register contents to an int.
	STRING_TOINT = 0x34

	// CMP_REG compares two registers.
	CMP_REG = 0x40

	// CMP_IMMEDIATE compares a register contents with a number.
	CMP_IMMEDIATE = 0x41

	// CMP_STRING compares a register contents with a string.
	CMP_STRING = 0x42

	// IS_STRING tests if a register contains a string.
	IS_STRING = 0x43

	// IS_INTEGER tests if a register contains an integer.
	IS_INTEGER = 0x44

	// IS_MORE_REG compares reg1 > reg2.
	IS_MORE_REG = 0x45

	// NOP_OP does nothing.
	NOP_OP = 0x50

	// REG_STORE stores the contents of one register in another.
	REG_STORE = 0x51

	// PEEK reads from memory.
	PEEK = 0x60

	// POKE sets an address-content.
	POKE = 0x61

	// MEMCPY copies a region of RAM.
	MEMCPY = 0x62

	// STACK_PUSH pushes the given register-contents onto the stack.
	STACK_PUSH = 0x70

	// STACK_POP retrieves a value from the stack.
	STACK_POP = 0x71

	// STACK_RET returns from a CALL
	STACK_RET = 0x72

	// STACK_CALL calls a subroutine.
	STACK_CALL = 0x73

	// TRAP_OP invokes a CPU trap.
	TRAP_OP = 0x80
)

Types

type Opcode

type Opcode struct {
	// contains filtered or unexported fields
}

Opcode is a holder for a single instruction. Note that this doesn't take any account of the arguments which might be necessary.

func NewOpcode

func NewOpcode(instruction byte) *Opcode

NewOpcode creates a new Opcode.

func (*Opcode) String

func (o *Opcode) String() string

String converts the given Opcode to a string, but again note that it doesn't take into account the value.

func (*Opcode) Value

func (o *Opcode) Value() byte

Value returns the byte-value of the opcode.