Opcode

Operation code consisting of the information of the operation.

Source code in core/opcode.py

class Opcode:
    """
    Operation code consisting of the information of the operation.
    """

    __slots__ = ("inst",)

    def __new__(cls, inst: int) -> t.Self:
        if isinstance(inst, int) and len(str(inst)) < 6:
            self = super(Opcode, cls).__new__(cls)
            return self

        else:
            raise ValueError(f"BAD OPCODE: {inst}")

    def __init__(self, inst: int) -> None:
        """
        Opcode Constructor.

        args:
            inst: instruction in the format of `hex(type|x|y|n|nn|nnn)`
        """
        self.inst = inst

    @property
    def type(self) -> int:
        """
        The type of operation. (first nibble)
        """
        value = self.inst & 0xF000
        return value

    @property
    def x(self) -> int:
        """
        General Purpose Register lookup. (second nibble)
        """
        value = (self.inst & 0x0F00) >> 8
        return value

    @property
    def y(self) -> int:
        """
        general purpose register lookup. (third nibble)
        """
        value = (self.inst & 0x00F0) >> 4
        return value

    @property
    def n(self) -> int:
        """
        4-bit numeric value. (fourth nibble)
        """
        value = self.inst & 0x000F
        return value

    @property
    def kk(self) -> int:
        """
        8-bit immediate. (third and fourth nibble)
        """
        value = self.inst & 0x00FF
        return value

    @property
    def nnn(self) -> int:
        """
        12-bit immediate memory address. (second, third and fourth nibble)
        """
        value = self.inst & 0x0FFF
        return value

    def __repr__(self) -> str:
        return f"Opcode(inst={hex(self.inst)})"

type: int property readonly

The type of operation. (first nibble)

x: int property readonly

General Purpose Register lookup. (second nibble)

y: int property readonly

general purpose register lookup. (third nibble)

n: int property readonly

4-bit numeric value. (fourth nibble)

kk: int property readonly

8-bit immediate. (third and fourth nibble)

nnn: int property readonly

12-bit immediate memory address. (second, third and fourth nibble)

__new__(cls, inst) special staticmethod

Create and return a new object. See help(type) for accurate signature.

Source code in core/opcode.py

def __new__(cls, inst: int) -> t.Self:
    if isinstance(inst, int) and len(str(inst)) < 6:
        self = super(Opcode, cls).__new__(cls)
        return self

    else:
        raise ValueError(f"BAD OPCODE: {inst}")

__init__(self, inst) special

Opcode Constructor.

Parameters:

Name	Type	Description	Default
inst	int	instruction in the format of hex(type|x|y|n|nn|nnn)	required

Source code in core/opcode.py

def __init__(self, inst: int) -> None:
    """
    Opcode Constructor.

    args:
        inst: instruction in the format of `hex(type|x|y|n|nn|nnn)`
    """
    self.inst = inst