interpreter

package
v0.195.2 Latest Latest
Warning

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

 Go to latest Published: Aug 13, 2024 License: MIT Imports: 11 Imported by: 8

Documentation

Overview

Package interpreter provides the implementation of the Flux interpreter.

Index

Constants

View Source 
const (
	PackageMain = "main"
	NowPkg      = "universe"
	NowOption   = "now"
)

Variables

This section is empty.

Functions

func DoFunctionCall 

func DoFunctionCall(f func(args Arguments) (values.Value, error), argsObj values.Object) (values.Value, error)

DoFunctionCall will call DoFunctionCallContext with a background context.

func DoFunctionCallContext added in v0.45.0 

func DoFunctionCallContext(f func(ctx context.Context, args Arguments) (values.Value, error), ctx context.Context, argsObj values.Object) (values.Value, error)

DoFunctionCallContext will treat the argsObj as the arguments to a function. It will then invoke that function with the Arguments and return the value from the function.

This function verifies that all of the arguments have been consumed by the function call.

func GetOption added in v0.141.0 

func GetOption(ctx context.Context, pkg string, option string) (values.Value, bool)

func ResolveIdsInFunction added in v0.81.0 

func ResolveIdsInFunction(scope values.Scope, origFn *semantic.FunctionExpression, n semantic.Node, localIdentifiers *[]string) (semantic.Node, error)

func ToFloatArray 

func ToFloatArray(a values.Array) ([]float64, error)

func ToStringArray 

func ToStringArray(a values.Array) ([]string, error)

Types

type Arguments 

type Arguments interface {
	GetAll() []string
	Get(name string) (values.Value, bool)
	GetRequired(name string) (values.Value, error)

	GetString(name string) (string, bool, error)
	GetUInt(name string) (uint64, bool, error)
	GetInt(name string) (int64, bool, error)
	GetFloat(name string) (float64, bool, error)
	GetBool(name string) (bool, bool, error)
	GetFunction(name string) (values.Function, bool, error)
	GetArray(name string, t semantic.Nature) (values.Array, bool, error)
	GetArrayAllowEmpty(name string, t semantic.Nature) (values.Array, bool, error)
	GetObject(name string) (values.Object, bool, error)
	GetDictionary(name string) (values.Dictionary, bool, error)

	GetRequiredString(name string) (string, error)
	GetRequiredUInt(name string) (uint64, error)
	GetRequiredInt(name string) (int64, error)
	GetRequiredFloat(name string) (float64, error)
	GetRequiredBool(name string) (bool, error)
	GetRequiredFunction(name string) (values.Function, error)
	GetRequiredArray(name string, t semantic.Nature) (values.Array, error)
	GetRequiredArrayAllowEmpty(name string, t semantic.Nature) (values.Array, error)
	GetRequiredObject(name string) (values.Object, error)
	GetRequiredDictionary(name string) (values.Dictionary, error)
	RawObject() values.Object
	// contains filtered or unexported methods
}

Arguments provides access to the keyword arguments passed to a function. semantic.The Get{Type} methods return three values: the typed value of the arg, whether the argument was specified and any errors about the argument type. semantic.The GetRequired{Type} methods return only two values, the typed value of the arg and any errors, a missing argument is considered an error in this case.

func NewArguments 

func NewArguments(obj values.Object) Arguments

type ExecOptsConfig added in v0.91.0 

type ExecOptsConfig interface {
	ConfigureProfiler(ctx context.Context, profilerNames []string)
	ConfigureNow(ctx context.Context, now time.Time)
}

This interface is used by the interpreter to set options that are relevant to the execution engine. For most cases it would be sufficient to pull options out after the interpreter is run, however it is possible for the interpreter to invoke the execution engine via tableFind and chain functions. These options need to get immediately installed in the execution dependencies when they are interpreted. We cannot access them directly here due to circular dependencies, so we use an interface, with an implementation defined by the caller.

type Importer added in v0.10.0 

type Importer interface {
	ImportPackageObject(path string) (*Package, error)
}

Importer produces a package given an import path

type Interpreter 

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

func NewInterpreter 

func NewInterpreter(pkg *Package, eoc ExecOptsConfig) *Interpreter

func (*Interpreter) Eval 

func (itrp *Interpreter) Eval(ctx context.Context, node semantic.Node, scope values.Scope, importer Importer) ([]SideEffect, error)

Eval evaluates the expressions composing a Flux package and returns any side effects that occurred during this evaluation.

func (*Interpreter) PackageName added in v0.68.0 

func (itrp *Interpreter) PackageName() string

type Package added in v0.10.0 

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

Package is an importable package that can be used from another section of code. The package itself cannot have its attributes modified after creation, but the options may be changed.

func NewPackage added in v0.14.0 

func NewPackage(name string) *Package

func NewPackageWithValues added in v0.14.0 

func NewPackageWithValues(name, path string, obj values.Object) *Package

func (*Package) Array added in v0.14.0 

func (p *Package) Array() values.Array

func (*Package) Bool added in v0.14.0 

func (p *Package) Bool() bool

func (*Package) Bytes added in v0.40.0 

func (p *Package) Bytes() []byte

func (*Package) Copy added in v0.14.0 

func (p *Package) Copy() *Package

func (*Package) Dict added in v0.96.0 

func (p *Package) Dict() values.Dictionary

func (*Package) Duration added in v0.14.0 

func (p *Package) Duration() values.Duration

func (*Package) Dynamic added in v0.185.0 

func (p *Package) Dynamic() values.Dynamic

func (*Package) Equal added in v0.14.0 

func (p *Package) Equal(rhs values.Value) bool

func (*Package) Float added in v0.14.0 

func (p *Package) Float() float64

func (*Package) Function added in v0.14.0 

func (p *Package) Function() values.Function

func (*Package) Get added in v0.14.0 

func (p *Package) Get(name string) (values.Value, bool)

func (*Package) Int added in v0.14.0 

func (p *Package) Int() int64

func (*Package) IsNull added in v0.14.0 

func (p *Package) IsNull() bool

func (*Package) Len added in v0.14.0 

func (p *Package) Len() int

func (*Package) Name added in v0.10.0 

func (p *Package) Name() string

Name returns the package name.

func (*Package) Object added in v0.14.0 

func (p *Package) Object() values.Object

func (*Package) Path added in v0.68.0 

func (p *Package) Path() string

Path returns the canonical import path for this package.

func (*Package) Range added in v0.14.0 

func (p *Package) Range(f func(name string, v values.Value))

func (*Package) Regexp added in v0.14.0 

func (p *Package) Regexp() *regexp.Regexp

func (*Package) Release added in v0.153.0 

func (p *Package) Release()

func (*Package) Retain added in v0.153.0 

func (p *Package) Retain()

func (*Package) Set added in v0.14.0 

func (p *Package) Set(name string, v values.Value)

func (*Package) SideEffects added in v0.10.0 

func (p *Package) SideEffects() []SideEffect

func (*Package) Str added in v0.14.0 

func (p *Package) Str() string

func (*Package) String added in v0.14.0 

func (p *Package) String() string

func (*Package) Time added in v0.14.0 

func (p *Package) Time() values.Time

func (*Package) Type added in v0.14.0 

func (p *Package) Type() semantic.MonoType

func (*Package) UInt added in v0.14.0 

func (p *Package) UInt() uint64

func (*Package) Vector added in v0.154.0 

func (p *Package) Vector() values.Vector

type Packages added in v0.141.0 

type Packages map[string]*Package

func (Packages) Inject added in v0.141.0 

func (p Packages) Inject(ctx context.Context) context.Context

type ResolvedFunction added in v0.40.0 

type ResolvedFunction struct {
	Fn    *semantic.FunctionExpression `json:"fn"`
	Scope values.Scope                 `json:"-"`
}

ResolvedFunction represents a function that can be passed down to the compiler. Both the function expression and scope are captured. The scope cannot be serialized, which is no longer a problem in the current design with the exception of the REPL which will not be able to correctly pass through the scope.

func ResolveFunction 

func ResolveFunction(f values.Function) (ResolvedFunction, error)

ResolveFunction produces a function that can execute externally.

func (ResolvedFunction) Copy added in v0.40.0 

func (r ResolvedFunction) Copy() ResolvedFunction

type Resolver 

type Resolver interface {
	Resolve() (semantic.Node, error)
	Scope() values.Scope
}

Resolver represents a value that can resolve itself. Resolving is the action of capturing the scope at function declaration and replacing any identifiers with static values from the scope where possible. TODO(nathanielc): Improve implementations of scope to only preserve values in the scope that are referrenced.

type SideEffect added in v0.29.0 

type SideEffect struct {
	Node  semantic.Node
	Value values.Value
}

SideEffect contains its value, and the semantic node that generated it.

type StackEntry added in v0.83.0 

type StackEntry struct {
	FunctionName string
	Location     ast.SourceLocation
}

StackEntry describes a single entry in the call stack.

func Stack added in v0.83.0 

func Stack(ctx context.Context) []StackEntry

Stack retrieves the call stack for a given context.

type Value 

type Value interface {
	// Type reports the type of value
	Type() semantic.MonoType
	// Value returns the actual value represented.
	Value() interface{}
	// Property returns a new value which is a property of this value.
	Property(name string) (values.Value, error)
}

Value represents any value that can be the result of evaluating any expression.

Source Files

View all Source files

Directories

Path Synopsis

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.