t3xf

Documentation

Index

• Variables
• func Decode(b []byte) (n int, op opcode.Opcode, arg interface{})
• type Compiler
  • func NewCompiler() *Compiler
  • func (c *Compiler) Assemble() ([]byte, error)
  • func (c *Compiler) Compile(n syntax.Node) error
  • func (c *Compiler) Err() error
• type Encoder
  • func NewEncoder() *Encoder
  • func (e *Encoder) Assemble() ([]byte, error)
  • func (e *Encoder) Encode(op opcode.Opcode, arg any) error
  • func (e *Encoder) Len() int
  • func (e *Encoder) Reset()
• type EncoderError
  • func (e *EncoderError) Error() string
  • func (e *EncoderError) Unwrap() error
• type Reference
• type String
  • func NewString(l int, b []byte) *String
  • func (s *String) Bytes() []byte
  • func (s *String) Len() int

Variables

var ErrInvalidArg = errors.New("invalid argument")

ErrInvalidArg is returned when an argument is not of the expected type or size.

var ErrUnknownReference = errors.New("unknown reference")

ErrUnknownReference is returned when a reference to an unknown instruction is encountered.

Functions

func Decode

func Decode(b []byte) (n int, op opcode.Opcode, arg interface{})

Decode decodes a T3XF instruction from a byte slice. It returns the number of bytes read, the opcode and its argument.

The type of the argument depends on the opcode:

• LINE, NATLONG, SCAN, IFIELD, IGET and IDEF: the argument is an int.
• IEEE754DP: the argument is a float64.
• BITS, NIBBLES and OCTETS: the argument is a *t3xf.String. The underlying byte slice is the given byte slice b. Note, that the number of bytes read and the number of bytes in the String slice may differ, because T3XF instructions are 4-byte aligned.
• NAME, UTF8, ISTR and FSTR: the argument is a string.
• REF, GOTO and FROZEN_REF: the argument is a t3xf.Reference.

Types

type Compiler

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

func NewCompiler

func NewCompiler() *Compiler

func (*Compiler) Assemble

func (c *Compiler) Assemble() ([]byte, error)

func (*Compiler) Compile

func (c *Compiler) Compile(n syntax.Node) error

func (*Compiler) Err

func (c *Compiler) Err() error

type Encoder

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

func NewEncoder

func NewEncoder() *Encoder

func (*Encoder) Assemble

func (e *Encoder) Assemble() ([]byte, error)

Assemble returns the assembled T3XF byte code. References are resolved when possible, otherwise they are left unresolved and an error is returned.

It is safe to call Assemble multiple times during the lifetime of an Encoder.

func (*Encoder) Encode

func (e *Encoder) Encode(op opcode.Opcode, arg any) error

Encode the given opcode and argument. If an argument is not of the expected type or size, an error is returned.

• References are given as the index of the Encode call that will be referenced.
• String arguments are expected to implement the Len() and Bytes() methods.
• Integer arguments are expected to be of type int.
• Float arguments are expected to be of type float64.

func (*Encoder) Len

func (e *Encoder) Len() int

func (*Encoder) Reset

func (e *Encoder) Reset()

Reset resets the encoder to its initial state.

type EncoderError

type EncoderError struct {
	Err error         // Underlying error
	I   int           // Instruction index
	Op  opcode.Opcode // Current Opcode
}

func (*EncoderError) Error

func (e *EncoderError) Error() string

func (*EncoderError) Unwrap

func (e *EncoderError) Unwrap() error

type Reference

type Reference int

Reference is a T3XF offset.

type String

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

String is a T3XF string.

func NewString

func NewString(l int, b []byte) *String

func (*String) Bytes

func (s *String) Bytes() []byte

Bytes returns the byte slice for the string.

func (*String) Len

func (s *String) Len() int

Len returns the number of elements in the string. For a bitstring, this is the number of bits, for a charstring the number of characters.