lua

type Instance ¶

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

Instance stores metadata and synchronization primitives for a compiled Lua VM.

func (inst *Instance) Do(m *Manager, id uuid.UUID, action VMAction) error

func (inst *Instance) IsBusy() bool

func (inst *Instance) RegisterFunction(name string, fn lua.LGFunction)

func (inst *Instance) RegisterFunctions(functions map[string]lua.LGFunction)

func (inst *Instance) RegisterGlobal(name string, value lua.LValue)

func (inst *Instance) RegisterGlobals(globals map[string]lua.LValue)

func (inst *Instance) RegisterModule(name string, provider ModuleProvider)

func (inst *Instance) RegisterModules(providers map[string]ModuleProvider)

type InstanceInfo ¶ added in v0.12.4

type InstanceInfo struct {
	Mode       VMMode
	Persistent bool
	Paused     bool
	Killed     bool
	Locked     bool
}

InstanceInfo reports metadata about a tracked VM instance.

type LuaInstanceModuleProvider ¶ added in v0.12.18

type LuaInstanceModuleProvider struct {
	InstanceID     uuid.UUID
	ExportFunction string
	InvokeFunction string
	// contains filtered or unexported fields
}

LuaInstanceModuleProvider resolves modules through another managed Lua VM. The provider VM must be persistent and expose export/invoke globals.

func NewLuaInstanceModuleProvider(instanceID uuid.UUID, exportFunction, invokeFunction string) *LuaInstanceModuleProvider

func (p *LuaInstanceModuleProvider) ProvideModule(ctx *ModuleContext) (lua.LValue, error)

type LuaSymbol ¶ added in v0.12.18

type LuaSymbol struct {
	// Value exports a literal Lua value as module[field].
	Value lua.LValue
	// Function exports a Go callback as module[field] when non-nil.
	Function lua.LGFunction
}

LuaSymbol describes a field exported from a Go-defined Lua module table.

type Manager ¶

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

Manager coordinates multiple sandboxed Lua states.

func NewManager(logger *log.Loggee) *Manager

func (m *Manager) Close()

func (m *Manager) Do(id uuid.UUID, action VMAction) error

func (m *Manager) GetInstance(id uuid.UUID) (*Instance, error)

func (m *Manager) InstanceInfo(id uuid.UUID) (InstanceInfo, error)

func (m *Manager) PrepareModuleProviderVM(config ModuleProviderVMConfig) (uuid.UUID, *Instance, error)

func (m *Manager) PrepareVM(mode VMMode, persistent bool, code string) (uuid.UUID, *Instance, error)

func (m *Manager) RegisterFunction(name string, fn lua.LGFunction)

func (m *Manager) RegisterFunctions(functions map[string]lua.LGFunction)

func (m *Manager) RegisterGlobal(name string, value lua.LValue)

func (m *Manager) RegisterGlobals(globals map[string]lua.LValue)

func (m *Manager) RegisterInstanceFunction(id uuid.UUID, name string, fn lua.LGFunction)

func (m *Manager) RegisterInstanceFunctions(id uuid.UUID, functions map[string]lua.LGFunction)

func (m *Manager) RegisterInstanceGlobal(id uuid.UUID, name string, value lua.LValue)

func (m *Manager) RegisterInstanceGlobals(id uuid.UUID, globals map[string]lua.LValue)

func (m *Manager) RegisterInstanceModule(id uuid.UUID, name string, provider ModuleProvider)

func (m *Manager) RegisterInstanceModules(id uuid.UUID, providers map[string]ModuleProvider)

func (m *Manager) RegisterModule(name string, provider ModuleProvider)

func (m *Manager) RegisterModules(providers map[string]ModuleProvider)

func (m *Manager) SetDefaultSender(sender string)

type ModuleContext ¶ added in v0.12.18

type ModuleContext struct {
	Manager    *Manager
	Identifier string
	Mode       VMMode
	State      *lua.LState
	Module     string
}

ModuleContext carries metadata for resolving a single require("module") request.

type ModuleProvider ¶ added in v0.12.18

type ModuleProvider interface {
	ProvideModule(ctx *ModuleContext) (lua.LValue, error)
}

ModuleProvider resolves a single module binding into a Lua value.

func GoModule(symbols map[string]LuaSymbol) ModuleProvider

type ModuleProviderFunc ¶ added in v0.12.18

type ModuleProviderFunc func(ctx *ModuleContext) (lua.LValue, error)

ModuleProviderFunc adapts a function into a ModuleProvider.

func (f ModuleProviderFunc) ProvideModule(ctx *ModuleContext) (lua.LValue, error)

type ModuleProviderVMConfig ¶ added in v0.12.18

type ModuleProviderVMConfig struct {
	Mode      VMMode
	Code      string
	Functions map[string]lua.LGFunction
	Globals   map[string]lua.LValue
	Modules   map[string]ModuleProvider
}

ModuleProviderVMConfig configures a persistent Lua VM intended to serve modules.

type VMAction ¶ added in v0.12.4

type VMAction uint8

VMAction enumerates supported manager operations for persistent VMs.

const (
	// Run executes the compiled script, blocking until the VM lock is held.
	Run VMAction = iota
	// RunSafe only executes when TryLock succeeds and otherwise returns ErrInstanceBusy.
	RunSafe
	// Terminate waits for the current run to finish, then removes the VM cleanly.
	Terminate
	// Kill forcibly removes the VM immediately without waiting for the run to finish.
	Kill
)

func (a VMAction) String() string

type VMMode ¶ added in v0.12.2

type VMMode uint8

const (
	// Sandboxed removes risky loaders and keeps require() restricted to registered modules.
	Sandboxed VMMode = iota
	// Elevated exposes os/io/package helpers while still skipping arbitrary C loading.
	Elevated
	// Unsafe opens the full set of Lua libs for debugging/compatibility scenarios.
	Unsafe
)

func (m VMMode) String() string