checker

package
v0.1.0 Latest Latest
Warning

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

 Go to latest Published: Dec 14, 2025 License: MIT Imports: 29 Imported by: 0

Documentation

Overview

Package checker implements the Elk type checker

Package checker implements the Elk type checker

Package checker implements the Elk type checker

Index

Constants

View Source 
const (
	HeaderFlag bitfield.BitFlag16 = 1 << iota // whether the currently checked file is an Elk header file `.elh`
	GoCompilerFlag
)
View Source 
const (
	NEW_CONST constState = iota
	CHECKING_CONST
	CHECKED_CONST
)
View Source 
const (
	NEW_TYPEDEF typedefState = iota
	CHECKING_MACRO_TYPEDEF
	CHECKED_MACRO_TYPEDEF
	CHECKING_TYPEDEF
	CHECKED_TYPEDEF
	ERROR_TYPEDEF
)

Variables

View Source 
var MethodCheckConcurrencyLimit = 100

Functions

func CheckAST 

func CheckAST(sourceName string, ast *ast.ProgramNode, globalEnv *types.GlobalEnvironment, flags bitfield.BitField16, threadPool *vm.ThreadPool) (*vm.BytecodeFunction, diagnostic.DiagnosticList)

Check the types of an Elk AST and generate bytecode

func CheckASTNative 

func CheckASTNative(sourceName string, ast *ast.ProgramNode, globalEnv *types.GlobalEnvironment, output io.Writer, threadPool *vm.ThreadPool) (*compiler.GoCompiler, diagnostic.DiagnosticList)

Check the types of an Elk AST and generate Go source

func CheckFile 

func CheckFile(fileName string, globalEnv *types.GlobalEnvironment, flags bitfield.BitField16, threadPool *vm.ThreadPool) (*vm.BytecodeFunction, diagnostic.DiagnosticList)

Check the types of an Elk file and generate bytecode

func CheckFileNative 

func CheckFileNative(fileName string, globalEnv *types.GlobalEnvironment, output io.Writer, threadPool *vm.ThreadPool) (*compiler.GoCompiler, diagnostic.DiagnosticList)

Check the types of an Elk file and generate Go source

func CheckSource 

func CheckSource(sourceName string, source string, globalEnv *types.GlobalEnvironment, flags bitfield.BitField16, threadPool *vm.ThreadPool) (*vm.BytecodeFunction, diagnostic.DiagnosticList)

Check the types of Elk source code ang generate bytecode

func CheckSourceNative 

func CheckSourceNative(sourceName string, source string, globalEnv *types.GlobalEnvironment, output io.Writer, threadPool *vm.ThreadPool) (*compiler.GoCompiler, diagnostic.DiagnosticList)

Check the types of Elk source code and generate Go source

func I 

func I(typ types.Type) string

Types

type CheckExpressionFunc 

type CheckExpressionFunc func(ast.ExpressionNode) ast.ExpressionNode

type Checker 

type Checker struct {
	Filename string                                    // name of the current source file
	Errors   *diagnostic.SyncDiagnosticList            // list of typechecking errors
	ASTCache *concurrent.Map[string, *ast.ProgramNode] // stores the ASTs of parsed source code files
	// contains filtered or unexported fields
}

Holds the state of the type checking process

func New 

func New() *Checker

Instantiate a new Checker instance.

func NewWithEnv 

func NewWithEnv(env *types.GlobalEnvironment) *Checker

Instantiate a new Checker instance.

func (*Checker) CanBeFalsy 

func (c *Checker) CanBeFalsy(typ types.Type) bool

Type can be falsy

func (*Checker) CanBeTruthy 

func (c *Checker) CanBeTruthy(typ types.Type) bool

Type can be truthy

func (*Checker) CheckSource 

func (c *Checker) CheckSource(sourceName string, source string) (*vm.BytecodeFunction, diagnostic.DiagnosticList)

Used in the REPL to typecheck and compile the input

func (*Checker) ClearErrors 

func (c *Checker) ClearErrors()

func (*Checker) DefinedMacros 

func (c *Checker) DefinedMacros() bool

func (*Checker) Env 

func (c *Checker) Env() *types.GlobalEnvironment

func (*Checker) GetIteratorElementType 

func (c *Checker) GetIteratorElementType(typ types.Type) (types.Type, types.Type)

func (*Checker) GetIteratorType 

func (c *Checker) GetIteratorType(typ types.Type) types.Type

func (*Checker) IsClosure 

func (c *Checker) IsClosure(typ types.Namespace) bool

func (*Checker) IsFalse 

func (c *Checker) IsFalse(typ types.Type) bool

Type is always `false`

func (*Checker) IsFalsy 

func (c *Checker) IsFalsy(typ types.Type) bool

Type is always falsy.

func (*Checker) IsHeader 

func (c *Checker) IsHeader() bool

func (*Checker) IsIncremental 

func (c *Checker) IsIncremental() bool

func (*Checker) IsNil 

func (c *Checker) IsNil(typ types.Type) bool

Type is always `nil`

func (*Checker) IsNilable 

func (c *Checker) IsNilable(typ types.Type) bool

Type can be `nil`

func (*Checker) IsNotNilable 

func (c *Checker) IsNotNilable(typ types.Type) bool

Type cannot be `nil`

func (*Checker) IsSubtype 

func (c *Checker) IsSubtype(a, b types.Type) bool

func (*Checker) IsTheSameNamespace 

func (c *Checker) IsTheSameNamespace(a, b types.Namespace) bool

Check whether the two given types represent the same type. Return true if they do, otherwise false.

func (*Checker) IsTheSameType 

func (c *Checker) IsTheSameType(a, b types.Type) bool

func (*Checker) IsTrue 

func (c *Checker) IsTrue(typ types.Type) bool

Type is always `false`

func (*Checker) IsTruthy 

func (c *Checker) IsTruthy(typ types.Type) bool

Type is always truthy.

func (*Checker) MacroTypeOf 

func (c *Checker) MacroTypeOf(node ast.Node) types.Type

Returns the type of the AST node, for use in macros

func (*Checker) NewNormalisedIntersection 

func (c *Checker) NewNormalisedIntersection(elements ...types.Type) types.Type

func (*Checker) NewNormalisedUnion 

func (c *Checker) NewNormalisedUnion(elements ...types.Type) types.Type

func (*Checker) NormaliseType 

func (c *Checker) NormaliseType(typ types.Type) types.Type

func (*Checker) SelfType 

func (c *Checker) SelfType() types.Type

func (*Checker) SetHeader 

func (c *Checker) SetHeader(val bool)

func (*Checker) SetIncremental 

func (c *Checker) SetIncremental(val bool)

func (*Checker) Std 

func (c *Checker) Std(name value.Symbol) types.Type

func (*Checker) StdAST 

func (c *Checker) StdAST() *types.Module

func (*Checker) StdAnyInt 

func (c *Checker) StdAnyInt() types.Type

func (*Checker) StdArrayList 

func (c *Checker) StdArrayList() *types.Class

func (*Checker) StdArrayTuple 

func (c *Checker) StdArrayTuple() *types.Class

func (*Checker) StdBigFloat 

func (c *Checker) StdBigFloat() *types.Class

func (*Checker) StdBool 

func (c *Checker) StdBool() *types.Class

func (*Checker) StdClass 

func (c *Checker) StdClass() *types.Class

func (*Checker) StdConstantNode 

func (c *Checker) StdConstantNode() *types.Mixin

func (*Checker) StdConstantNodeConvertible 

func (c *Checker) StdConstantNodeConvertible() *types.Interface

func (*Checker) StdElk 

func (c *Checker) StdElk() *types.Module

func (*Checker) StdExpressionNode 

func (c *Checker) StdExpressionNode() *types.Mixin

func (*Checker) StdExpressionNodeConvertible 

func (c *Checker) StdExpressionNodeConvertible() *types.Interface

func (*Checker) StdFalse 

func (c *Checker) StdFalse() *types.Class

func (*Checker) StdFloat 

func (c *Checker) StdFloat() *types.Class

func (*Checker) StdHashMap 

func (c *Checker) StdHashMap() *types.Class

func (*Checker) StdHashRecord 

func (c *Checker) StdHashRecord() *types.Class

func (*Checker) StdHashSet 

func (c *Checker) StdHashSet() *types.Class

func (*Checker) StdIdentifierNode 

func (c *Checker) StdIdentifierNode() *types.Mixin

func (*Checker) StdIdentifierNodeConvertible 

func (c *Checker) StdIdentifierNodeConvertible() *types.Interface

func (*Checker) StdInspectable 

func (c *Checker) StdInspectable() types.Type

func (*Checker) StdInstanceVariableNode 

func (c *Checker) StdInstanceVariableNode() *types.Mixin

func (*Checker) StdInstanceVariableNodeConvertible 

func (c *Checker) StdInstanceVariableNodeConvertible() *types.Interface

func (*Checker) StdInt 

func (c *Checker) StdInt() *types.Class

func (*Checker) StdList 

func (c *Checker) StdList() *types.Mixin

func (*Checker) StdLiteralPatternNode 

func (c *Checker) StdLiteralPatternNode() *types.Mixin

func (*Checker) StdLiteralPatternNodeConvertible 

func (c *Checker) StdLiteralPatternNodeConvertible() *types.Interface

func (*Checker) StdMap 

func (c *Checker) StdMap() *types.Mixin

func (*Checker) StdNil 

func (c *Checker) StdNil() *types.Class

func (*Checker) StdNode 

func (c *Checker) StdNode() *types.Mixin

func (*Checker) StdNodeConvertible 

func (c *Checker) StdNodeConvertible() *types.Interface

func (*Checker) StdPatternNode 

func (c *Checker) StdPatternNode() *types.Mixin

func (*Checker) StdPatternNodeConvertible 

func (c *Checker) StdPatternNodeConvertible() *types.Interface

func (*Checker) StdPrimitiveIterable 

func (c *Checker) StdPrimitiveIterable() *types.Interface

func (*Checker) StdRange 

func (c *Checker) StdRange() *types.Mixin

func (*Checker) StdRecord 

func (c *Checker) StdRecord() *types.Mixin

func (*Checker) StdSet 

func (c *Checker) StdSet() *types.Mixin

func (*Checker) StdString 

func (c *Checker) StdString() *types.Class

func (*Checker) StdStringConvertible 

func (c *Checker) StdStringConvertible() types.Type

func (*Checker) StdTrue 

func (c *Checker) StdTrue() *types.Class

func (*Checker) StdTuple 

func (c *Checker) StdTuple() *types.Mixin

func (*Checker) StdTypeNode 

func (c *Checker) StdTypeNode() *types.Mixin

func (*Checker) StdTypeNodeConvertible 

func (c *Checker) StdTypeNodeConvertible() *types.Interface

func (*Checker) StdValue 

func (c *Checker) StdValue() *types.Class

func (*Checker) ToNilable 

func (c *Checker) ToNilable(typ types.Type) types.Type

func (*Checker) ToNonFalsy 

func (c *Checker) ToNonFalsy(typ types.Type) types.Type

func (*Checker) ToNonLiteral 

func (c *Checker) ToNonLiteral(typ types.Type, widenSingletonTypes bool) types.Type

func (*Checker) ToNonNilable 

func (c *Checker) ToNonNilable(typ types.Type) types.Type

func (*Checker) ToNonTruthy 

func (c *Checker) ToNonTruthy(typ types.Type) types.Type

func (*Checker) TypeOf 

func (c *Checker) TypeOf(node ast.Node) types.Type

Returns the type of the value represented by the AST node

func (*Checker) TypesIntersect 

func (c *Checker) TypesIntersect(a, b types.Type) bool

Check whether the two given types intersect. Return true if they do, otherwise false.

Source Files

View all Source files

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.