Documentation
¶
Overview ¶
Package script implements script environments for engine steps and predicates
Index ¶
- Constants
- Variables
- func QBESelector(qbe api.SpaceQuery) *api.ScriptConfig
- type Compiled
- type CompiledLua
- type Environment
- type JPathEnv
- func (c JPathEnv) Compile(st *api.Step, cfg *api.ScriptConfig) (Compiled, error)
- func (*JPathEnv) EvaluateMatch(c Compiled, input any) (bool, error)
- func (*JPathEnv) EvaluatePredicate(c Compiled, _ *api.Step, inputs api.Args) (bool, error)
- func (*JPathEnv) EvaluateScript(c Compiled, _ *api.Step, inputs api.Args) (api.Args, error)
- func (c JPathEnv) Validate(st *api.Step, script string) error
- type LuaEnv
- func (c LuaEnv) Compile(st *api.Step, cfg *api.ScriptConfig) (Compiled, error)
- func (e *LuaEnv) EvaluateMatch(c Compiled, input any) (bool, error)
- func (e *LuaEnv) EvaluatePredicate(c Compiled, _ *api.Step, inputs api.Args) (bool, error)
- func (e *LuaEnv) EvaluateScript(c Compiled, _ *api.Step, inputs api.Args) (api.Args, error)
- func (c LuaEnv) Validate(st *api.Step, script string) error
- type Registry
Constants ¶
const ( MatchTags = "tags" MatchType = "type" MatchHandling = "handling" MatchAttributes = "attributes" MatchAttributeRole = "role" MatchAttributeCompensated = "compensated" )
Variables ¶
var ( ErrJPathCompile = errors.New("jpath compile error") ErrJPathNoMatch = errors.New("jpath produced no matches") )
var ( ErrLuaLoad = errors.New("lua load error") ErrLuaExecution = errors.New("lua execution error") )
var MatchStep = &api.Step{ Attributes: api.AttributeSpecs{ matchValue: {Role: api.RoleRequired, Type: api.TypeAny}, }, }
MatchStep returns the minimal synthetic step used as the compilation context for a required match predicate, exposing only the candidate value
Functions ¶
func QBESelector ¶
func QBESelector(qbe api.SpaceQuery) *api.ScriptConfig
QBESelector returns a JPath match script equivalent to the query by example, ANDing the tags within a term and ORing the terms, so a step matches when it carries every tag of any one of them
Types ¶
type CompiledLua ¶
type CompiledLua struct {
// contains filtered or unexported fields
}
CompiledLua represents a compiled Lua script
type Environment ¶
type Environment interface {
// Validate checks if a script is syntactically valid
Validate(st *api.Step, script string) error
// Compile compiles a script and returns the compiled form
Compile(*api.Step, *api.ScriptConfig) (Compiled, error)
// EvaluateScript executes a compiled script with the given inputs
EvaluateScript(Compiled, *api.Step, api.Args) (api.Args, error)
// EvaluatePredicate evaluates a compiled predicate with given inputs
EvaluatePredicate(Compiled, *api.Step, api.Args) (bool, error)
// EvaluateMatch evaluates a compiled matcher with a single input
EvaluateMatch(c Compiled, input any) (bool, error)
}
Environment defines the interface for script environments
type JPathEnv ¶
type JPathEnv struct {
// contains filtered or unexported fields
}
JPathEnv provides JPath predicate evaluation
func NewJPathEnv ¶
func NewJPathEnv() *JPathEnv
NewJPathEnv creates a JPath predicate evaluation environment
func (*JPathEnv) EvaluateMatch ¶
EvaluateMatch applies the compiled JPath expression to a single input and treats any match as success, including explicit null matches
func (*JPathEnv) EvaluatePredicate ¶
EvaluatePredicate applies the compiled JPath expression and treats any match as predicate success, including explicit null matches
func (*JPathEnv) EvaluateScript ¶
EvaluateScript evaluates a compiled JPath expression against mapping inputs
type LuaEnv ¶
type LuaEnv struct {
// contains filtered or unexported fields
}
LuaEnv provides a Lua script execution environment with state pooling
func NewLuaEnv ¶
func NewLuaEnv() *LuaEnv
NewLuaEnv creates a new Lua script execution environment with a state pool for efficient script reuse
func (*LuaEnv) EvaluateMatch ¶
EvaluateMatch executes a compiled Lua matcher with a single input and returns the boolean result
func (*LuaEnv) EvaluatePredicate ¶
EvaluatePredicate executes a compiled Lua predicate with the provided inputs and returns the boolean result
func (*LuaEnv) EvaluateScript ¶
EvaluateScript runs a compiled Lua script with the provided inputs and returns the output arguments
type Registry ¶
type Registry struct {
// contains filtered or unexported fields
}
Registry manages script environments for different languages
func NewRegistry ¶
func NewRegistry() *Registry
NewRegistry creates a new registry with JPath and Lua environments
func (*Registry) Get ¶
func (r *Registry) Get(language string) (Environment, error)
Get returns the script environment for the given language
func (*Registry) Register ¶
func (r *Registry) Register(language string, env Environment)
Source Files