builtin

Documentation

Index

• func FuncsInit(out io.Writer)
• func GetConstant(name string) (val interface{}, found bool)
• func HasConstant(name string) bool
• func HasFunction(name string) bool
• func ListConstants() map[string]interface{}
• func Predict(word string) string
• func RegisterConstant[T string | bool | uint64 | int64 | float64](name string, value T)
• func RegisterFunction(name string, function Func)
• func SystemInit(sys System)
• type Environment
• type Func
  • func GetFunction(name string) (function Func, found bool)
• type FuncMap
  • func ListFunctions() FuncMap
• type System

Functions

func FuncsInit

func FuncsInit(out io.Writer)

Deprecated: Use builtin.SystemInit instead. builtin.SystemInit provides greater portability.

func GetConstant

func GetConstant(name string) (val interface{}, found bool)

Get constant by name from the builtin constant map.

func HasConstant

func HasConstant(name string) bool

Is constant with name presented in the builtin constant map.

func HasFunction

func HasFunction(name string) bool

Is function with name presented in the builtin function map.

func ListConstants

func ListConstants() map[string]interface{}

Return the builtin constant map.

func Predict

func Predict(word string) string

func RegisterConstant

func RegisterConstant[T string | bool | uint64 | int64 | float64](name string, value T)

Register a new constant and add it to the builtin constant map.

func RegisterFunction

func RegisterFunction(name string, function Func)

Register a new function and add it to the builtin function map.

func SystemInit

func SystemInit(sys System)

Provide your own system description.

Use this function to implement native integration into your application.

Types

type Environment

type Environment struct {
	Description string
	UserVars    map[string]interface{}
	UserFuncs   map[string]user.Func
}

type Func

type Func struct {
	// Arguments description.
	Args string
	// Function description.
	Desc string
	// Function that will be executed.
	Exec func(args ...interface{}) (interface{}, error)
}

func GetFunction

func GetFunction(name string) (function Func, found bool)

Get function by name from the builtin function map.

type FuncMap

type FuncMap map[string]Func

func ListFunctions

func ListFunctions() FuncMap

Return the builtin function map.

type System

type System struct {
	// Is syntax highlighting enabled for built-in functions output.
	HighlightEnabled bool

	// Writer for additional output.
	Stdout io.Writer
	// Callback that should clears screen.
	ClearScreen func()

	// Random seed that sets on SystemInit.
	RandomSeed int64

	// Callback that should return list of available environment file names.
	ListEnvironments func() ([]string, error)
	// Callback that should open environment file with provided name for write and return it as io.WriteCloser.
	WriteEnvironment func(name string) (io.WriteCloser, error)
	// Callback that should open environment file with provided name for read and return it as io.ReadCloser.
	ReadEnvironment func(name string) (io.ReadCloser, error)

	// Callback that should terminate the program and perform any necessary cleanup.
	Exit func(errCode int)
}