runtime

Documentation

Index

• Variables
• func RegisterBuiltin(importPath string, f PackageFunc)
• type Compiler
• type Config
• type Interpreter
• type PackageFunc
• type Runtime
  • func New() *Runtime
  • func NewWithSettings(v internal.EvaluatorVersion, flags cuedebug.Config) *Runtime
  • func (r *Runtime) AddInst(path string, key *adt.Vertex, p *build.Instance)
  • func (x *Runtime) Build(cfg *Config, b *build.Instance) (v *adt.Vertex, errs errors.Error)
  • func (r *Runtime) BuildData(b *build.Instance) (x interface{}, ok bool)
  • func (x *Runtime) BuiltinPackagePath(path string) string
  • func (r *Runtime) Compile(cfg *Config, source interface{}) (*adt.Vertex, *build.Instance)
  • func (r *Runtime) CompileFile(cfg *Config, file *ast.File) (*adt.Vertex, *build.Instance)
  • func (r *Runtime) GetInstanceFromNode(key *adt.Vertex) *build.Instance
  • func (r *Runtime) IndexToString(i int64) string
  • func (r *Runtime) Init()
  • func (r *Runtime) IsInitialized() bool
  • func (r *Runtime) Label(s string, isIdent bool) adt.Feature
  • func (r *Runtime) LabelStr(l adt.Feature) string
  • func (r *Runtime) LoadImport(importPath string) *adt.Vertex
  • func (x *Runtime) LoadType(t reflect.Type) (src ast.Expr, expr adt.Expr, ok bool)
  • func (r *Runtime) NextUniqueID() uint64
  • func (r *Runtime) ResolveFiles(p *build.Instance) (errs errors.Error)
  • func (r *Runtime) SetBuildData(b *build.Instance, x interface{})
  • func (r *Runtime) SetDebugOptions(flags *cuedebug.Config)
  • func (r *Runtime) SetInterpreter(i Interpreter)
  • func (r *Runtime) SetVersion(v internal.EvaluatorVersion)
  • func (r *Runtime) Settings() (internal.EvaluatorVersion, cuedebug.Config)
  • func (x *Runtime) StoreType(t reflect.Type, src ast.Expr, expr adt.Expr)
  • func (r *Runtime) StrLabel(str string) adt.Feature
  • func (r *Runtime) StringToIndex(s string) int64

Variables

var SharedRuntime = &Runtime{index: sharedIndex}

Functions

func RegisterBuiltin

func RegisterBuiltin(importPath string, f PackageFunc)

Types

type Compiler

type Compiler interface {
	// Compile creates an adt.Expr (usually a builtin) for the
	// given external named resource (usually a function). name
	// is the name of the resource to compile, taken from altName
	// in `@extern(name=altName)`, or from the field name if that's
	// not defined. Scope is the struct that contains the field.
	// Other than "name", the fields in a are implementation
	// specific.
	Compile(name string, scope adt.Value, a *internal.Attr) (adt.Expr, errors.Error)
}

A Compiler fills in an adt.Expr for fields marked with `@extern(kind)`.

type Config

type Config struct {
	Runtime    *Runtime
	Filename   string
	ImportPath string

	Counts *stats.Counts

	compile.Config
}

type Interpreter

type Interpreter interface {
	// NewCompiler creates a compiler for b and reports any errors.
	NewCompiler(b *build.Instance, r *Runtime) (Compiler, errors.Error)

	// Kind returns the string to be used in the file-level @extern attribute.
	Kind() string
}

Interpreter defines an entrypoint for creating per-package interpreters.

type PackageFunc

type PackageFunc func(ctx adt.Runtime) (*adt.Vertex, errors.Error)

type Runtime

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

A Runtime maintains data structures for indexing and reuse for evaluation.

func New

func New() *Runtime

New is a wrapper for NewVersioned(internal.DefaultVersion).

func NewWithSettings

func NewWithSettings(v internal.EvaluatorVersion, flags cuedebug.Config) *Runtime

NewWithSettings creates a new Runtime using the given runtime version and debug flags. The builtins registered with RegisterBuiltin are available for evaluation.

func (*Runtime) AddInst

func (r *Runtime) AddInst(path string, key *adt.Vertex, p *build.Instance)

func (*Runtime) Build

func (x *Runtime) Build(cfg *Config, b *build.Instance) (v *adt.Vertex, errs errors.Error)

Build builds b and all its transitive dependencies, insofar they have not been build yet.

func (*Runtime) BuildData

func (r *Runtime) BuildData(b *build.Instance) (x interface{}, ok bool)

func (*Runtime) BuiltinPackagePath

func (x *Runtime) BuiltinPackagePath(path string) string

BuiltinPackagePath converts a short-form builtin package identifier to its full path or "" if this doesn't exist.

func (*Runtime) Compile

func (r *Runtime) Compile(cfg *Config, source interface{}) (*adt.Vertex, *build.Instance)

func (*Runtime) CompileFile

func (r *Runtime) CompileFile(cfg *Config, file *ast.File) (*adt.Vertex, *build.Instance)

func (*Runtime) GetInstanceFromNode

func (r *Runtime) GetInstanceFromNode(key *adt.Vertex) *build.Instance

func (*Runtime) IndexToString

func (r *Runtime) IndexToString(i int64) string

func (*Runtime) Init

func (r *Runtime) Init()

func (*Runtime) IsInitialized

func (r *Runtime) IsInitialized() bool

IsInitialized reports whether the runtime has been initialized.

func (*Runtime) Label

func (r *Runtime) Label(s string, isIdent bool) adt.Feature

func (*Runtime) LabelStr

func (r *Runtime) LabelStr(l adt.Feature) string

func (*Runtime) LoadImport

func (r *Runtime) LoadImport(importPath string) *adt.Vertex

func (*Runtime) LoadType

func (x *Runtime) LoadType(t reflect.Type) (src ast.Expr, expr adt.Expr, ok bool)

func (*Runtime) NextUniqueID

func (r *Runtime) NextUniqueID() uint64

func (*Runtime) ResolveFiles

func (r *Runtime) ResolveFiles(p *build.Instance) (errs errors.Error)

TODO(resolve): this is also done in compile, do we need both?

func (*Runtime) SetBuildData

func (r *Runtime) SetBuildData(b *build.Instance, x interface{})

func (*Runtime) SetDebugOptions

func (r *Runtime) SetDebugOptions(flags *cuedebug.Config)

SetDebugOptions sets the debug flags to use for the Runtime. This should only be set before first use.

func (*Runtime) SetInterpreter

func (r *Runtime) SetInterpreter(i Interpreter)

SetInterpreter sets the interpreter for interpretation of files marked with @extern(kind).

func (*Runtime) SetVersion

func (r *Runtime) SetVersion(v internal.EvaluatorVersion)

SetVersion sets the version to use for the Runtime. This should only be set before first use.

func (*Runtime) Settings

func (r *Runtime) Settings() (internal.EvaluatorVersion, cuedebug.Config)

func (*Runtime) StoreType

func (x *Runtime) StoreType(t reflect.Type, src ast.Expr, expr adt.Expr)

func (*Runtime) StrLabel

func (r *Runtime) StrLabel(str string) adt.Feature

func (*Runtime) StringToIndex

func (r *Runtime) StringToIndex(s string) int64