bytecode

package
v1.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 19, 2026 License: MIT Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	TagNil        byte = 0x00
	TagTrue       byte = 0x01
	TagFalse      byte = 0x02
	TagInt        byte = 0x03
	TagFloat      byte = 0x04
	TagString     byte = 0x05
	TagKeyword    byte = 0x06
	TagSymbol     byte = 0x07
	TagChar       byte = 0x08
	TagBigInt     byte = 0x09
	TagVoid       byte = 0x0A
	TagFunc       byte = 0x10
	TagVarRef     byte = 0x11
	TagEmptyList  byte = 0x20
	TagList       byte = 0x21
	TagVector     byte = 0x22
	TagMap        byte = 0x23
	TagSet        byte = 0x24
	TagRecordType byte = 0x30
	TagRecord     byte = 0x31
	TagRegex      byte = 0x32
	TagAtom       byte = 0x33
)

Type tags for const pool entries.

View Source 
const (
	FlagConstsBase uint16 = 1 << 0 // ConstsBase field is present in consts section
)

Module flags.

View Source 
const FormatVersion uint16 = 1

FormatVersion is the current serialization format version.

Variables

View Source 
var Magic = [4]byte{'L', 'G', 'B', 0x01}

Magic bytes identifying an LGB file.

Functions

func Encode 

func Encode(w io.Writer, m *Module) error

Encode serializes a Module to binary format.

func EncodeBundle 

func EncodeBundle(w io.Writer, consts *vm.Consts, nsChunks map[string]*vm.CodeChunk) error

EncodeBundle serializes a multi-namespace compilation bundle. nsChunks maps namespace names to their main CodeChunks. The "core" entry (chunk index 0) is treated as the entry point.

func EncodeBundleOrdered added in v1.3.5 

func EncodeBundleOrdered(w io.Writer, consts *vm.Consts, nsChunks map[string]*vm.CodeChunk, nsOrder []string) error

EncodeBundleOrdered serializes a multi-namespace bundle with explicit ordering. nsOrder determines the chunk index assignment (lower index = earlier dependency).

func EncodeCompilation 

func EncodeCompilation(w io.Writer, consts *vm.Consts, mainChunk *vm.CodeChunk) error

EncodeCompilation serializes a compilation result (main chunk + const pool). The main chunk is always chunk index 0. All CodeChunks referenced by Funcs in the const pool are collected automatically. If consts is a child pool, only the child's entries are serialized with the base offset stored so the decoder can reconstruct the layering.

func EncodeModule 

func EncodeModule(w io.Writer, consts *vm.Consts, chunks []*vm.CodeChunk) error

EncodeModule builds a Module from live VM objects and serializes it.

Types

type ChunkData 

type ChunkData struct {
	MaxStack  int
	Code      []int32
	SourceMap []SourceEntry
}

ChunkData holds the data for a single code chunk.

type ExecUnit 

type ExecUnit struct {
	Consts    *vm.Consts
	MainChunk *vm.CodeChunk
	// NSChunks maps namespace names to their main chunks (for bundles).
	NSChunks map[string]*vm.CodeChunk
	// NSOrder lists namespace names in chunk index order (load/dependency order).
	NSOrder []string
}

ExecUnit is a decoded compilation unit ready for execution.

func DecodeToExecUnit 

func DecodeToExecUnit(r io.Reader, resolve VarResolver) (*ExecUnit, error)

DecodeToExecUnit decodes an LGB module and returns a ready-to-execute unit. The main chunk is chunk index 0. All decoded consts are populated into a shared Consts pool that all chunks reference.

func DecodeToExecUnitWithParent 

func DecodeToExecUnitWithParent(r io.Reader, resolve VarResolver, parent *vm.Consts) (*ExecUnit, error)

DecodeToExecUnitWithParent decodes an LGB module with an optional parent const pool. If parent is non-nil and the module has a ConstsBase, the decoded consts are layered on top of the parent pool — indices < base resolve from the parent.

type Module 

type Module struct {
	Version uint16
	Flags   uint16
	Strings []string
	Chunks  []*ChunkData
	Consts  []vm.Value
	// ConstsBase is the starting global index for the consts in this module.
	// For layered pools, indices 0..ConstsBase-1 are in a parent pool.
	ConstsBase int
	// NSTable maps namespace names to their main chunk indices (for bundles).
	NSTable map[string]int
}

Module is the serializable unit — a complete compilation result.

func Decode 

func Decode(r io.Reader) (*Module, error)

Decode reads a binary module from r.

func DecodeWithResolver 

func DecodeWithResolver(r io.Reader, resolve VarResolver) (*Module, error)

DecodeWithResolver reads a binary module, resolving var references with the given function.

type ModuleBuilder 

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

ModuleBuilder collects strings, chunks, and consts for serialization.

func NewModuleBuilder 

func NewModuleBuilder() *ModuleBuilder

NewModuleBuilder creates a new builder.

func (*ModuleBuilder) AddChunk 

func (b *ModuleBuilder) AddChunk(c *vm.CodeChunk) int

AddChunk registers a CodeChunk and interns its strings.

func (*ModuleBuilder) AddConst 

func (b *ModuleBuilder) AddConst(v vm.Value)

AddConst registers a const value and interns related strings/chunks.

func (*ModuleBuilder) Build 

func (b *ModuleBuilder) Build() *Module

Build creates the Module.

func (*ModuleBuilder) ChunkIndex 

func (b *ModuleBuilder) ChunkIndex(c *vm.CodeChunk) (int, bool)

ChunkIndex returns the index for a given CodeChunk pointer.

func (*ModuleBuilder) SetNSEntry 

func (b *ModuleBuilder) SetNSEntry(name string, chunk *vm.CodeChunk)

SetNSEntry records a namespace name → main chunk mapping for bundle modules.

type Reader 

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

Reader wraps a buffered reader with binary decoding helpers.

func NewReader 

func NewReader(r io.Reader) *Reader

NewReader creates a Reader wrapping r.

func (*Reader) ReadByte 

func (r *Reader) ReadByte() (byte, error)

ReadByte reads a single byte.

func (*Reader) ReadBytes 

func (r *Reader) ReadBytes(n int) ([]byte, error)

ReadBytes reads exactly n bytes.

func (*Reader) ReadFloat64 

func (r *Reader) ReadFloat64() (float64, error)

ReadFloat64 reads an IEEE 754 little-endian float64.

func (*Reader) ReadInt32 

func (r *Reader) ReadInt32() (int32, error)

ReadInt32 reads a little-endian int32.

func (*Reader) ReadSvarint 

func (r *Reader) ReadSvarint() (int64, error)

ReadSvarint reads a signed zigzag-encoded varint.

func (*Reader) ReadUint16 

func (r *Reader) ReadUint16() (uint16, error)

ReadUint16 reads a little-endian uint16.

func (*Reader) ReadVarint 

func (r *Reader) ReadVarint() (uint64, error)

ReadVarint reads an unsigned LEB128-encoded integer.

type SourceEntry 

type SourceEntry struct {
	StartIP                          int
	File                             string
	Line, Column, EndLine, EndColumn int
}

SourceEntry is a source map entry for serialization.

type VarResolver 

type VarResolver func(ns, name string) *vm.Var

VarResolver resolves a var reference by namespace and name.

type Writer 

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

Writer wraps a buffered writer with binary encoding helpers.

func NewWriter 

func NewWriter(w io.Writer) *Writer

NewWriter creates a Writer wrapping w.

func (*Writer) Flush 

func (w *Writer) Flush() error

Flush flushes the underlying buffer.

func (*Writer) WriteByte 

func (w *Writer) WriteByte(b byte) error

WriteByte writes a single byte.

func (*Writer) WriteBytes 

func (w *Writer) WriteBytes(b []byte) error

WriteBytes writes a byte slice.

func (*Writer) WriteFloat64 

func (w *Writer) WriteFloat64(v float64) error

WriteFloat64 writes an IEEE 754 little-endian float64.

func (*Writer) WriteInt32 

func (w *Writer) WriteInt32(v int32) error

WriteInt32 writes a little-endian int32.

func (*Writer) WriteSvarint 

func (w *Writer) WriteSvarint(v int64) error

WriteSvarint writes a signed zigzag-encoded varint.

func (*Writer) WriteUint16 

func (w *Writer) WriteUint16(v uint16) error

WriteUint16 writes a little-endian uint16.

func (*Writer) WriteVarint 

func (w *Writer) WriteVarint(v uint64) error

WriteVarint writes an unsigned LEB128-encoded integer.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.