compiler

Documentation

Overview

Package compiler implements a compiler that converts Mixer's expression language into a Mixer IL-based program that can be executed via an interpreter.

Index

• func Compile(text string, finder expr.AttributeDescriptorFinder, ...) (*il.Program, error)
• type Compiler
  • func New(finder expr.AttributeDescriptorFinder, ...) *Compiler
  • func (c *Compiler) CompileExpression(text string) (uint32, descriptor.ValueType, error)
  • func (c *Compiler) Program() *il.Program
• type Result

Functions

func Compile

func Compile(text string, finder expr.AttributeDescriptorFinder, functions map[string]expr.FunctionMetadata) (*il.Program, error)

Compile converts the given expression text, into an IL based program.

Types

type Compiler

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

Compiler is a stateful compiler that can be used to gradually build an il.Program out of multiple independent compilation of expressions.

func New

func New(finder expr.AttributeDescriptorFinder, functions map[string]expr.FunctionMetadata) *Compiler

New returns a new compiler instance.

func (*Compiler) CompileExpression

func (c *Compiler) CompileExpression(text string) (uint32, descriptor.ValueType, error)

CompileExpression creates a new parameterless IL function, using the given expression text as its body. Upon success, it returns the id of the generated function.

func (*Compiler) Program

func (c *Compiler) Program() *il.Program

Program returns the program instance that is being built by this compiler.

type Result

type Result struct {
	Program    *il.Program
	Expression *expr.Expression
}

Result is returned as the result of compilation.