gmnlisp

package module
v0.7.24 Latest Latest
Warning

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

 Go to latest Published: Aug 25, 2025 License: MIT Imports: 19 Imported by: 3

README

Gmnlisp

Go Reference Go Test

Gmnlisp is an ISLisp interpreter written in Go, designed for embedding into Go applications to enable scripting and customization in ISLisp.

Example image

Features

  • High ISLisp Standard Compliance

    • Verified with the ISLisp Verification System:
      PASS: 16173 / FAIL: 238 → Pass rate: 98.54%
    • Remaining failures are mainly due to:
      • Class system and generic functions: core features implemented, a few features still missing
      • Nearly all standard functions have correct parameter validation; some minor cases remain
      • Strings are currently immutable (spec requires mutability)

  • Written in Go — Interpreter

    • Pure interpreter implementation (no compiler)
    • Embeddable directly into Go programs
    • Allows mutual function calls between Go and ISLisp

  • Embedding-Oriented API

    • Simple registration of variables, functions, and special forms from Go
    • Direct access to Lisp objects as Go interfaces (gmnlisp.Node)
    • Works on Windows and Linux

Usage and Integration Guide

package main

import (
    "context"
    "fmt"
    "os"

    "github.com/hymkor/gmnlisp"
)

func sum(ctx context.Context, w *gmnlisp.World, args []gmnlisp.Node) (gmnlisp.Node, error) {
    a, err := gmnlisp.ExpectClass[gmnlisp.Integer](ctx, w, args[0])
    if err != nil {
        return nil, err
    }
    b, err := gmnlisp.ExpectClass[gmnlisp.Integer](ctx, w, args[1])
    if err != nil {
        return nil, err
    }
    return a + b, nil
}

func main() {
    lisp := gmnlisp.New()

    lisp = lisp.Let(gmnlisp.Variables{
        gmnlisp.NewSymbol("a"): gmnlisp.Integer(1),
        gmnlisp.NewSymbol("b"): gmnlisp.Integer(2),
    })

    lisp = lisp.Flet(
        gmnlisp.Functions{
            gmnlisp.NewSymbol("sum"): &gmnlisp.Function{C: 2, F: sum},
        })

    value, err := lisp.Interpret(context.TODO(), "(sum a b)")
    if err != nil {
        fmt.Fprintln(os.Stderr, err.Error())
        return
    }
    fmt.Println(value.String())
}

$ go run examples/example.go
3
  • gmnlisp.New returns a new Lisp interpreter instance (*gmnlisp.World).
  • gmnlisp.NewSymbol constructs a symbol. Calling gmnlisp.NewSymbol("a") always returns the same value, no matter how many times it's called.
  • gmnlisp.Variables is a symbol map type. It is an alias for map[gmnlisp.Symbol]gmnlisp.Node.
    Node is the interface that all Lisp objects must implement.
  • .Let creates a new world instance with the given variable bindings (namespace).
lisp.Let(gmnlisp.Variables{
    gmnlisp.NewSymbol("a"): gmnlisp.Integer(1),
    gmnlisp.NewSymbol("b"): gmnlisp.Integer(2),
}).Interpret(context.Background(), "(c)")

is equivalent to the Lisp code: (let ((a 1) (b 2)) (c))

Type assertions

a, err := gmnlisp.ExpectClass[gmnlisp.Integer](ctx, w, x)
is similar to:
a, ok := x.(gmnlisp.Integer)

However, ExpectClass invokes the user-defined error handler if x is not of type Integer.

User-defined functions

You can register user-defined functions to the interpreter using .Flet():

lisp = lisp.Flet(
    gmnlisp.Functions{
        gmnlisp.NewSymbol("sum"): &gmnlisp.Function{C: 2, F: sum},
    })

The function definitions are passed as a gmnlisp.Functions map, where the keys are symbols and the values are Lisp function objects. There are several ways to define the function values:

  • gmnlisp.Function1(f) For a function f with the signature: func(context.Context, *gmnlisp.World, gmnlisp.Node) (gmnlisp.Node, error) Accepts one evaluated argument.

  • gmnlisp.Function2(f) For a function f with the signature: func(context.Context, *gmnlisp.World, gmnlisp.Node, gmnlisp.Node) (gmnlisp.Node, error) Accepts two evaluated arguments.

  • &gmnlisp.Function{ C: n, Min: min, Max: max, F: f } For a function f with the signature: func(context.Context, *gmnlisp.World, []gmnlisp.Node) (gmnlisp.Node, error) Accepts multiple evaluated arguments.

    • If C is non-zero, the function strictly expects C arguments.
    • If Min and Max are specified instead, the function accepts a range of arguments.
    • If all are left as zero values, argument count is not validated.

    Note: A zero value (0) means "unspecified"; negative values are not used.

  • gmnlisp.SpecialF(f) For defining special forms (macros, control structures, etc.), where arguments are passed unevaluated: func(context.Context, *gmnlisp.World, gmnlisp.Node) (gmnlisp.Node, error) All arguments are passed as a Lisp list (e.g., (list a b c) becomes &gmnlisp.Cons{Car: ..., Cdr: ...}).

    Inside this function, you can evaluate an argument manually with:

    result, err := w.Eval(ctx, x)

See the example in the "Usage and Integration Guide" section above for how to define and register a user function.

Supported Types

Lisp values correspond to the following Go types or constructors when embedding gmnlisp in Go applications:

Lisp Go
t gmnlisp.True
nil gmnlisp.Null
1 gmnlisp.Integer(1)
2.3 gmnlisp.Float(2.3)
"string" gmnlisp.String("string")
SYMBOL gmnlisp.NewSymbol("SYMBOL")
(cons 1 2) &gmnlisp.Cons{ Car:gmnlisp.Integer(1), Cdr:gmnlisp.Integer(2) }
#\A gmnlisp.Rune('A')

Unlike other types shown above, gmnlisp.NewSymbol(...) is a function call, not a type conversion. It returns a value of type Symbol (defined as type Symbol int), which is distinct from int. The function guarantees that the same string always maps to the same symbol value.

gmnlisp.Node is the root interface. All values that appear in Lisp code must implement this interface.

type Node interface {
    Equals(Node, EqlMode) bool
    String() string
    ClassOf() Class
}

type Class interface {
    Node
    Name() Symbol
    InstanceP(Node) bool
    Create() Node
    InheritP(Class) bool
}

type EqlMode int

const (
    STRICT EqlMode = iota // corresponds to (eql a b)
    EQUAL                 // corresponds to (equal a b)
    EQUALP                // corresponds to (equalp a b) 
)
(load) and (eval)

The functions (load) and (eval) are provided by the eval subpackage.
To make them available, simply import the package:

import _ "github.com/hymkor/gmnlisp/eval"

  • (load "filename") Reads S-expressions from the specified file and evaluates them sequentially.

  • (eval expr) Evaluates the given S-expression.

Importing the eval package is sufficient; the functions are automatically registered when a gmnlisp interpreter instance is created.

(quit) and (abort)

The functions (quit) and (abort) are provided by the exit subpackage. To use them, import:

import "github.com/hymkor/gmnlisp/exit"

  • (quit [N]) Terminates the gmnlisp executable with exit code N.

    • N must be a non-negative integer (0–255).
    • If omitted, the exit code defaults to 0.
    • Passing a non-integer or a negative integer signals a <domain-error>.
    • Passing an integer greater than 255 signals a <program-error>.

  • (abort) When running a script from the gmnlisp executable, terminates with exit code 1. In the interactive REPL, (abort) does not terminate the REPL itself; it only stops the current evaluation. Internally, (abort) raises an exit.AbortError instance (ErrAbort).

Both (quit) and (abort) are only available when the exit package is imported. In the gmnlisp executable, they are imported by default.

Projects Using gmnlisp

The following open-source applications embed gmnlisp to provide ISLisp-based customization and scripting:

  • lispect:
    A text-terminal automation tool similar to expect(1), powered by a subset of ISLisp.

  • smake:
    A build automation tool where Makefiles are written in S-expressions.

References

Documents (English)
Documents (Japanese)
Gmnlisp and other implementations of ISLisp
Implementation Language Windows Linux Execution Model
OK!ISLisp C Supported Supported Interpreter/Bytecode compiler
iris Go/JavaScript Supported Supported Interpreter
Easy-ISLisp C Supported Interpreter/Native Compiler
gmnlisp Go Supported Supported Interpreter

Author

hymkor (HAYAMA Kaoru)

License

MIT Licence

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrExpectedClass  = errors.New("expected class")
	ErrInvalidFormat  = errors.New("invalid format")
	ErrNoMatchMethods = errors.New("no match methods")
	ErrNotSupportType = errors.New("not support type")

	ErrTooFewArguments  = ProgramError{/* contains filtered or unexported fields */}
	ErrTooManyArguments = ProgramError{/* contains filtered or unexported fields */}
	ErrTooShortTokens   = parser.ErrTooShortTokens
	ErrIndexOutOfRange  = ProgramError{/* contains filtered or unexported fields */}
	ErrDotEnditList     = ProgramError{/* contains filtered or unexported fields */}
)
View Source 
var BuiltInClassObject = NewAbstractClass[*BuiltInClass]("<built-in-class>")
View Source 
var ExhaustThreshold int64 = 123456789
View Source 
var NewLineOnFormat = []byte{'\n'}
View Source 
var ObjectClass = &BuiltInClass{
	name:      NewSymbol("<object>"),
	instanceP: func(Node) bool { return true },
	create:    func() Node { return nil },
}

Functions

func ExpectClass added in v0.7.1 

func ExpectClass[T Node](ctx context.Context, w *World, v Node) (T, error)

func ExpectGeneric added in v0.6.0 

func ExpectGeneric(c Callable) (*genericType, error)

func ExpectInterface added in v0.7.1 

func ExpectInterface[T Node](ctx context.Context, w *World, v Node, class Class) (T, error)

func ExpectNonReservedSymbol added in v0.7.10 

func ExpectNonReservedSymbol(ctx context.Context, w *World, v Node) (_Symbol, error)

func Export added in v0.2.0 

func Export(name Symbol, value Callable)

func ExportRange added in v0.2.0 

func ExportRange(v Functions)

func IsNone added in v0.2.1 

func IsNone(node Node) bool

IsNone returns whether `node` does not have a value or not

func IsSome added in v0.2.1 

func IsSome(node Node) bool

IsSome returns whether `node` has a value or not

func ListToArray 

func ListToArray(list Node, slice []Node) error

func MakeError added in v0.2.0 

func MakeError(e error, s any) error

func MapCar 

func MapCar(ctx context.Context, w *World, funcNode Node, sourceSet []Node, store func(Node)) error

func NewSymbol 

func NewSymbol(s string) _Symbol

func SeqEach 

func SeqEach(ctx context.Context, w *World, list Node, f func(Node) error) error

func Shift 

func Shift(list Node) (Node, Node, error)

Types

type ArithmeticError added in v0.7.1 

type ArithmeticError struct {
	Operation FunctionRef
	Operands  Node
}

func (*ArithmeticError) ClassOf added in v0.7.1 

func (e *ArithmeticError) ClassOf() Class

func (*ArithmeticError) Equals added in v0.7.1 

func (e *ArithmeticError) Equals(other Node, mode EqlMode) bool

func (*ArithmeticError) Error added in v0.7.1 

func (e *ArithmeticError) Error() string

func (*ArithmeticError) GetOperands added in v0.7.19 

func (A *ArithmeticError) GetOperands() Node

func (*ArithmeticError) GetOperation added in v0.7.19 

func (A *ArithmeticError) GetOperation() FunctionRef

func (*ArithmeticError) String added in v0.7.1 

func (e *ArithmeticError) String() string

type ArithmeticErrorInterface added in v0.7.19 

type ArithmeticErrorInterface interface {
	GetOperation() FunctionRef
	GetOperands() Node
	Node
}

type Array added in v0.1.4 

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

func (*Array) ClassOf added in v0.6.0 

func (a *Array) ClassOf() Class

func (*Array) Elt added in v0.1.4 

func (A *Array) Elt(n int) (Node, error)

func (*Array) Equals added in v0.1.4 

func (A *Array) Equals(_B Node, mode EqlMode) bool

func (*Array) FirstAndRest added in v0.7.18 

func (A *Array) FirstAndRest() (Node, Node, bool)

func (Array) GoString added in v0.1.4 

func (t Array) GoString() string

func (*Array) PrintTo added in v0.1.4 

func (A *Array) PrintTo(w io.Writer, mode PrintMode) (int, error)

func (Array) String added in v0.1.4 

func (t Array) String() string

type BigInt added in v0.7.1 

type BigInt struct {
	*big.Int
}

func (BigInt) ClassOf added in v0.7.1 

func (b BigInt) ClassOf() Class

func (BigInt) Equals added in v0.7.1 

func (b BigInt) Equals(n Node, m EqlMode) bool

func (BigInt) LessThan added in v0.7.22 

func (b BigInt) LessThan(ctx context.Context, w *World, other Node) (bool, error)

func (BigInt) Multi added in v0.7.19 

func (b BigInt) Multi(ctx context.Context, w *World, other Node) (Node, error)

func (BigInt) Sub added in v0.7.22 

func (b BigInt) Sub(ctx context.Context, w *World, other Node) (Node, error)

type BuiltInClass added in v0.7.17 

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

func NewAbstractClass added in v0.7.17 

func NewAbstractClass[T Node](name string, super ...Class) *BuiltInClass

func NewBuiltInClass added in v0.7.17 

func NewBuiltInClass[T Node](name string, super ...Class) *BuiltInClass

func (*BuiltInClass) ClassOf added in v0.7.17 

func (e *BuiltInClass) ClassOf() Class

func (*BuiltInClass) Create added in v0.7.17 

func (e *BuiltInClass) Create() Node

func (*BuiltInClass) Equals added in v0.7.17 

func (e *BuiltInClass) Equals(_other Node, _ EqlMode) bool

func (*BuiltInClass) InheritP added in v0.7.17 

func (e *BuiltInClass) InheritP(c Class) bool

func (*BuiltInClass) InstanceP added in v0.7.17 

func (e *BuiltInClass) InstanceP(n Node) bool

func (*BuiltInClass) Name added in v0.7.17 

func (e *BuiltInClass) Name() Symbol

func (*BuiltInClass) String added in v0.7.17 

func (e *BuiltInClass) String() string

func (*BuiltInClass) Supers added in v0.7.20 

func (e *BuiltInClass) Supers() []Class

type Callable 

type Callable interface {
	Call(context.Context, *World, Node) (Node, error)
	FuncId() uintptr
}

func ExpectFunction added in v0.7.0 

func ExpectFunction(ctx context.Context, w *World, value Node) (Callable, error)

type Class added in v0.6.0 

type Class interface {
	Node
	Name() Symbol
	InstanceP(Node) bool
	Create() Node
	InheritP(Class) bool
	Supers() []Class
}

type Condition added in v0.7.17 

type Condition interface {
	error
	Node
}

type Cons 

type Cons struct {
	Car Node
	Cdr Node
}

func (*Cons) ClassOf added in v0.6.0 

func (*Cons) ClassOf() Class

func (*Cons) Elt added in v0.7.21 

func (cons *Cons) Elt(n int) (Node, error)

func (*Cons) Equals 

func (cons *Cons) Equals(n Node, m EqlMode) bool

func (*Cons) Eval 

func (cons *Cons) Eval(ctx context.Context, w *World) (Node, error)

func (*Cons) FirstAndRest 

func (cons *Cons) FirstAndRest() (Node, Node, bool)

func (Cons) GoString added in v0.1.4 

func (t Cons) GoString() string

func (*Cons) PrintTo 

func (cons *Cons) PrintTo(w io.Writer, m PrintMode) (int, error)

func (Cons) String added in v0.1.4 

func (t Cons) String() string

type Constants added in v0.7.7 

type Constants map[Symbol]Node

func (Constants) Get added in v0.7.7 

func (m Constants) Get(key Symbol) (Node, bool)

func (Constants) Set added in v0.7.7 

func (m Constants) Set(key Symbol, value Node) error

type Continuable added in v0.7.17 

type Continuable interface {
	SetContinuableString(String)
	ContinuableString() Node
}

type ControlError added in v0.7.1 

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

func (ControlError) ClassOf added in v0.7.1 

func (e ControlError) ClassOf() Class

func (ControlError) Equals added in v0.7.1 

func (e ControlError) Equals(n Node, _ EqlMode) bool

func (ControlError) Error added in v0.7.1 

func (e ControlError) Error() string

func (ControlError) String added in v0.7.1 

func (e ControlError) String() string

func (ControlError) Unwrap added in v0.7.1 

func (e ControlError) Unwrap() error

type ControlFlow added in v0.7.23 

type ControlFlow interface {
	IsControlFlow()
}

type DivisionByZero added in v0.7.19 

type DivisionByZero struct {
	ArithmeticError
}

func (*DivisionByZero) ClassOf added in v0.7.19 

func (d *DivisionByZero) ClassOf() Class

func (*DivisionByZero) Equals added in v0.7.19 

func (d *DivisionByZero) Equals(other Node, m EqlMode) bool

type DomainError added in v0.6.0 

type DomainError struct {
	Object        Node
	ExpectedClass Class
	Reason        string
}

func (*DomainError) ClassOf added in v0.6.0 

func (e *DomainError) ClassOf() Class

func (*DomainError) Equals added in v0.6.0 

func (e *DomainError) Equals(_other Node, mode EqlMode) bool

func (*DomainError) Error added in v0.6.0 

func (e *DomainError) Error() string

func (*DomainError) String added in v0.6.0 

func (e *DomainError) String() string

type EndOfStream added in v0.7.2 

type EndOfStream struct {
	Stream Node
}

func (EndOfStream) ClassOf added in v0.7.2 

func (e EndOfStream) ClassOf() Class

func (EndOfStream) Equals added in v0.7.2 

func (e EndOfStream) Equals(n Node, _ EqlMode) bool

func (EndOfStream) Error added in v0.7.2 

func (e EndOfStream) Error() string

func (EndOfStream) String added in v0.7.2 

func (e EndOfStream) String() string

type EqlMode 

type EqlMode int
const (
	STRICT EqlMode = iota // corresponds to (eql A B)
	EQUAL                 // corresponds to (equal A B)
	EQUALP                // corresponds to (equalp A B)
)

type ErrorNode 

type ErrorNode struct {
	Value error
}

func (ErrorNode) ClassOf added in v0.6.0 

func (ErrorNode) ClassOf() Class

func (ErrorNode) Equals 

func (e ErrorNode) Equals(n Node, m EqlMode) bool

func (ErrorNode) Error added in v0.7.1 

func (e ErrorNode) Error() string

func (ErrorNode) String added in v0.1.4 

func (e ErrorNode) String() string

type Float 

type Float float64

func (Float) Add 

func (f Float) Add(ctx context.Context, w *World, n Node) (Node, error)

func (Float) ClassOf added in v0.6.0 

func (Float) ClassOf() Class

func (Float) Equals 

func (f Float) Equals(n Node, m EqlMode) bool

func (Float) LessThan 

func (f Float) LessThan(ctx context.Context, w *World, n Node) (bool, error)

func (Float) Multi 

func (f Float) Multi(ctx context.Context, w *World, n Node) (Node, error)

func (Float) String added in v0.1.4 

func (f Float) String() string

func (Float) Sub 

func (f Float) Sub(ctx context.Context, w *World, n Node) (Node, error)

type FloatingPointOverflow added in v0.7.19 

type FloatingPointOverflow struct {
	ArithmeticError
}

func (*FloatingPointOverflow) ClassOf added in v0.7.19 

func (f *FloatingPointOverflow) ClassOf() Class

func (*FloatingPointOverflow) Equals added in v0.7.19 

func (f *FloatingPointOverflow) Equals(other Node, m EqlMode) bool

type FloatingPointUnderflow added in v0.7.19 

type FloatingPointUnderflow struct {
	ArithmeticError
}

func (*FloatingPointUnderflow) ClassOf added in v0.7.19 

func (f *FloatingPointUnderflow) ClassOf() Class

func (*FloatingPointUnderflow) Equals added in v0.7.19 

func (f *FloatingPointUnderflow) Equals(other Node, m EqlMode) bool

type FuncScope added in v0.7.0 

type FuncScope interface {
	Get(Symbol) (Callable, bool)
	Set(Symbol, Callable)
	Range(func(Symbol, Callable) bool)
}

type Function 

type Function struct {
	C   int
	F   func(context.Context, *World, []Node) (Node, error)
	Min int
	Max int
}

func (*Function) Call 

func (f *Function) Call(ctx context.Context, w *World, list Node) (Node, error)

func (*Function) FuncId added in v0.7.19 

func (f *Function) FuncId() uintptr

type Function0 added in v0.7.1 

type Function0 func(context.Context, *World) (Node, error)

func (Function0) Call added in v0.7.1 

func (f Function0) Call(ctx context.Context, w *World, list Node) (Node, error)

func (Function0) FuncId added in v0.7.19 

func (f Function0) FuncId() uintptr

type Function1 added in v0.7.1 

type Function1 func(context.Context, *World, Node) (Node, error)

func (Function1) Call added in v0.7.1 

func (f Function1) Call(ctx context.Context, w *World, list Node) (Node, error)

func (Function1) FuncId added in v0.7.19 

func (f Function1) FuncId() uintptr

type Function2 added in v0.7.1 

type Function2 func(context.Context, *World, Node, Node) (Node, error)

func (Function2) Call added in v0.7.1 

func (f Function2) Call(ctx context.Context, w *World, list Node) (Node, error)

func (Function2) FuncId added in v0.7.19 

func (f Function2) FuncId() uintptr

type FunctionRef added in v0.7.0 

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

func (FunctionRef) ClassOf added in v0.7.0 

func (f FunctionRef) ClassOf() Class

func (FunctionRef) Equals added in v0.7.0 

func (f FunctionRef) Equals(other Node, mode EqlMode) bool

func (FunctionRef) GoString added in v0.7.0 

func (f FunctionRef) GoString() string

func (FunctionRef) PrintTo added in v0.7.0 

func (f FunctionRef) PrintTo(w io.Writer, _ PrintMode) (int, error)

func (FunctionRef) String added in v0.7.0 

func (f FunctionRef) String() string

type Functions added in v0.7.0 

type Functions map[Symbol]Callable

func (Functions) Get added in v0.7.0 

func (m Functions) Get(key Symbol) (Callable, bool)

func (Functions) Range added in v0.7.0 

func (m Functions) Range(f func(Symbol, Callable) bool)

func (Functions) Set added in v0.7.0 

func (m Functions) Set(key Symbol, value Callable)

type IOFile added in v0.7.6 

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

func (*IOFile) ClassOf added in v0.7.6 

func (t *IOFile) ClassOf() Class

func (*IOFile) Close added in v0.7.6 

func (iof *IOFile) Close() error

func (*IOFile) Column added in v0.7.6 

func (iof *IOFile) Column() int

func (*IOFile) ElementClass added in v0.7.22 

func (iof *IOFile) ElementClass() int64

func (*IOFile) Equals added in v0.7.6 

func (t *IOFile) Equals(Node, EqlMode) bool

func (*IOFile) FilePosition added in v0.7.6 

func (i *IOFile) FilePosition() (int64, error)

func (*IOFile) IsClosed added in v0.7.6 

func (iof *IOFile) IsClosed() bool

func (*IOFile) QueryStreamReady added in v0.7.6 

func (i *IOFile) QueryStreamReady() (Node, error)

func (*IOFile) Read added in v0.7.6 

func (iof *IOFile) Read(b []byte) (int, error)

func (*IOFile) ReadByte added in v0.7.6 

func (iof *IOFile) ReadByte() (byte, error)

func (*IOFile) ReadRune added in v0.7.6 

func (iof *IOFile) ReadRune() (rune, int, error)

func (*IOFile) SetFilePosition added in v0.7.6 

func (i *IOFile) SetFilePosition(n int64) (int64, error)

func (*IOFile) String added in v0.7.6 

func (t *IOFile) String() string

func (*IOFile) UnreadRune added in v0.7.6 

func (iof *IOFile) UnreadRune() error

func (*IOFile) Write added in v0.7.6 

func (iof *IOFile) Write(b []byte) (int, error)

type Integer 

type Integer int64

func (Integer) Add 

func (i Integer) Add(ctx context.Context, w *World, n Node) (Node, error)

func (Integer) ClassOf added in v0.6.0 

func (i Integer) ClassOf() Class

func (Integer) Equals 

func (i Integer) Equals(n Node, m EqlMode) bool

func (Integer) LessThan 

func (i Integer) LessThan(ctx context.Context, w *World, n Node) (bool, error)

func (Integer) Multi 

func (i Integer) Multi(ctx context.Context, w *World, n Node) (Node, error)

func (Integer) String added in v0.1.4 

func (i Integer) String() string

func (Integer) Sub 

func (i Integer) Sub(ctx context.Context, w *World, n Node) (Node, error)

type Keyword 

type Keyword int

func NewKeyword added in v0.3.0 

func NewKeyword(name string) Keyword

func (Keyword) ClassOf added in v0.6.0 

func (Keyword) ClassOf() Class

func (Keyword) Equals 

func (k Keyword) Equals(n Node, m EqlMode) bool

func (Keyword) String added in v0.1.4 

func (k Keyword) String() string

type Node 

type Node interface {
	Equals(Node, EqlMode) bool
	String() string
	ClassOf() Class
}
var Null Node = nullType{}
var True Node = trueType{}

func ExpectList added in v0.7.16 

func ExpectList(ctx context.Context, w *World, arg Node) (Node, error)

func List 

func List(nodes ...Node) Node

func NReverse 

func NReverse(ctx context.Context, w *World, list Node) (Node, error)

func NewVector 

func NewVector(ctx context.Context, w *World, args ...Node) Node

func Progn 

func Progn(ctx context.Context, w *World, n Node) (value Node, err error)

func ReadAll 

func ReadAll(rs io.RuneScanner) ([]Node, error)

func ReadNode 

func ReadNode(rs io.RuneScanner) (Node, error)

func Reverse 

func Reverse(list Node) (Node, error)

type Pair 

type Pair struct {
	Key   Symbol
	Value Node
}

func (*Pair) Get 

func (m *Pair) Get(key Symbol) (Node, bool)

func (*Pair) Range added in v0.3.0 

func (m *Pair) Range(f func(Symbol, Node) bool)

func (*Pair) Set 

func (m *Pair) Set(key Symbol, value Node) error

type ParseError added in v0.7.1 

type ParseError struct {
	ExpectedClass Class
	// contains filtered or unexported fields
}

func (*ParseError) ClassOf added in v0.7.1 

func (p *ParseError) ClassOf() Class

func (*ParseError) Equals added in v0.7.1 

func (p *ParseError) Equals(other Node, m EqlMode) bool

func (*ParseError) Error added in v0.7.1 

func (p *ParseError) Error() string

func (*ParseError) String added in v0.7.1 

func (p *ParseError) String() string

type PrintMode 

type PrintMode int
const (
	PRINT PrintMode = iota // AS S-Expression
	PRINC                  // AS IS
)

type ProgramError added in v0.7.1 

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

func (ProgramError) ClassOf added in v0.7.1 

func (e ProgramError) ClassOf() Class

func (ProgramError) Equals added in v0.7.1 

func (e ProgramError) Equals(n Node, _ EqlMode) bool

func (ProgramError) Error added in v0.7.1 

func (e ProgramError) Error() string

func (ProgramError) String added in v0.7.1 

func (e ProgramError) String() string

func (ProgramError) Unwrap added in v0.7.1 

func (e ProgramError) Unwrap() error

type Reserved added in v0.7.10 

type Reserved int

func NewReserved added in v0.7.10 

func NewReserved(name string) Reserved

func (Reserved) ClassOf added in v0.7.10 

func (Reserved) ClassOf() Class

func (Reserved) Equals added in v0.7.10 

func (r Reserved) Equals(n Node, m EqlMode) bool

func (Reserved) Eval added in v0.7.10 

func (r Reserved) Eval(_ context.Context, w *World) (Node, error)

func (Reserved) Id added in v0.7.10 

func (r Reserved) Id() int

func (Reserved) OriginalString added in v0.7.10 

func (s Reserved) OriginalString() string

func (Reserved) String added in v0.7.10 

func (r Reserved) String() string

type Rune 

type Rune rune

func (Rune) Add 

func (r Rune) Add(ctx context.Context, w *World, n Node) (Node, error)

func (Rune) ClassOf added in v0.6.0 

func (Rune) ClassOf() Class

func (Rune) Equals 

func (r Rune) Equals(n Node, m EqlMode) bool

func (Rune) GoString added in v0.1.4 

func (r Rune) GoString() string

func (Rune) String added in v0.1.4 

func (r Rune) String() string

func (Rune) Sub 

func (r Rune) Sub(ctx context.Context, w *World, n Node) (Node, error)

type Scope 

type Scope interface {
	Get(Symbol) (Node, bool)
	Set(Symbol, Node) error
	Range(func(Symbol, Node) bool)
}

type Sequence 

type Sequence interface {
	FirstAndRest() (Node, Node, bool)
	Node
}

type SimpleError added in v0.7.11 

type SimpleError struct {
	FormatString    Node
	FormatArguments Node
	// contains filtered or unexported fields
}

func (*SimpleError) ClassOf added in v0.7.11 

func (s *SimpleError) ClassOf() Class

func (*SimpleError) ContinuableString added in v0.7.17 

func (s *SimpleError) ContinuableString() Node

func (*SimpleError) Equals added in v0.7.11 

func (s *SimpleError) Equals(other Node, m EqlMode) bool

func (*SimpleError) Error added in v0.7.16 

func (s *SimpleError) Error() string

func (*SimpleError) SetContinuableString added in v0.7.17 

func (s *SimpleError) SetContinuableString(cs String)

func (*SimpleError) String added in v0.7.11 

func (s *SimpleError) String() string

type SpecialF 

type SpecialF func(context.Context, *World, Node) (Node, error)

func (SpecialF) Call 

func (f SpecialF) Call(ctx context.Context, w *World, n Node) (Node, error)

func (SpecialF) FuncId added in v0.7.19 

func (f SpecialF) FuncId() uintptr

type SpecialN added in v0.7.21 

type SpecialN struct {
	F   func(context.Context, *World, []Node) (Node, error)
	Min int
	Max int
}

func (*SpecialN) Call added in v0.7.21 

func (f *SpecialN) Call(ctx context.Context, w *World, n Node) (Node, error)

func (*SpecialN) FuncId added in v0.7.21 

func (f *SpecialN) FuncId() uintptr

type StorageExhausted added in v0.7.1 

type StorageExhausted struct{}

func (StorageExhausted) ClassOf added in v0.7.1 

func (s StorageExhausted) ClassOf() Class

func (StorageExhausted) Equals added in v0.7.1 

func (s StorageExhausted) Equals(n Node, _ EqlMode) bool

func (StorageExhausted) Error added in v0.7.1 

func (s StorageExhausted) Error() string

func (StorageExhausted) String added in v0.7.1 

func (s StorageExhausted) String() string

type StreamError added in v0.7.2 

type StreamError struct {
	Stream Node
}

func (StreamError) ClassOf added in v0.7.2 

func (s StreamError) ClassOf() Class

func (StreamError) Equals added in v0.7.2 

func (s StreamError) Equals(other Node, m EqlMode) bool

func (StreamError) Error added in v0.7.2 

func (s StreamError) Error() string

func (StreamError) String added in v0.7.2 

func (s StreamError) String() string

type String 

type String string

func (String) Add added in v0.1.4 

func (s String) Add(ctx context.Context, w *World, n Node) (Node, error)

func (String) ClassOf added in v0.6.0 

func (String) ClassOf() Class

func (String) EachRune added in v0.1.4 

func (s String) EachRune(f func(Rune) error) error

func (String) Elt added in v0.7.21 

func (s String) Elt(n int) (Node, error)

func (String) Equals added in v0.1.4 

func (s String) Equals(n Node, m EqlMode) bool

func (String) FirstAndRest added in v0.1.4 

func (s String) FirstAndRest() (Node, Node, bool)

func (String) GoString added in v0.1.4 

func (s String) GoString() string

func (String) LessThan added in v0.1.4 

func (s String) LessThan(ctx context.Context, w *World, n Node) (bool, error)

func (String) String added in v0.1.4 

func (s String) String() string

type Symbol 

type Symbol interface {
	Id() int
	Node
	OriginalString() string
}

func ExpectSymbol added in v0.7.0 

func ExpectSymbol(ctx context.Context, w *World, v Node) (Symbol, error)

type Variables 

type Variables map[Symbol]Node

func (Variables) Get 

func (m Variables) Get(key Symbol) (Node, bool)

func (Variables) Range added in v0.3.0 

func (m Variables) Range(f func(Symbol, Node) bool)

func (Variables) Set 

func (m Variables) Set(key Symbol, value Node) error

type World 

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

func New 

func New() *World

func (*World) Assert 

func (w *World) Assert(equation string, expect Node) string

func (*World) DefineGlobal 

func (w *World) DefineGlobal(name Symbol, value Node)

DefineGlobal implements (defglobal) of ISLisp or (defparameter) of CommonLisp.

func (*World) Dynamic added in v0.3.1 

func (w *World) Dynamic(name Symbol) Node

func (*World) Errout 

func (w *World) Errout() io.Writer

func (*World) Eval added in v0.7.1 

func (w *World) Eval(ctx context.Context, node Node) (Node, error)

func (*World) Flet added in v0.7.0 

func (w *World) Flet(scope FuncScope) *World

func (*World) FuncRange added in v0.7.16 

func (W *World) FuncRange(f func(Symbol, Callable) bool)

func (*World) Get 

func (w *World) Get(name Symbol) (Node, error)

func (*World) GetFunc added in v0.7.0 

func (w *World) GetFunc(name Symbol) (Callable, error)

func (*World) Interpret 

func (w *World) Interpret(ctx context.Context, code string) (Node, error)

func (*World) InterpretBytes 

func (w *World) InterpretBytes(ctx context.Context, code []byte) (Node, error)

func (*World) InterpretNodes 

func (w *World) InterpretNodes(ctx context.Context, ns []Node) (Node, error)

func (*World) Let 

func (w *World) Let(scope Scope) *World

func (*World) Range added in v0.3.0 

func (W *World) Range(f func(Symbol, Node) bool)

func (*World) Set 

func (w *World) Set(name Symbol, value Node) error

func (*World) SetErrout 

func (w *World) SetErrout(writer io.Writer)

func (*World) SetStdout 

func (w *World) SetStdout(writer io.Writer)

func (*World) ShiftAndEvalCar 

func (w *World) ShiftAndEvalCar(ctx context.Context, list Node) (Node, Node, error)

func (*World) Stdin 

func (w *World) Stdin() _Reader

func (*World) Stdout 

func (w *World) Stdout() io.Writer

type Writer added in v0.7.6 

type Writer interface {
	io.Writer
	Node
}

type WriterStream added in v0.7.17 

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

func NewWriterStream added in v0.7.17 

func NewWriterStream(w io.Writer) *WriterStream

func (WriterStream) ClassOf added in v0.7.17 

func (WriterStream) ClassOf() Class

func (*WriterStream) Column added in v0.7.17 

func (w *WriterStream) Column() int

func (WriterStream) Equals added in v0.7.17 

func (t WriterStream) Equals(Node, EqlMode) bool

func (WriterStream) RawWriter added in v0.7.17 

func (t WriterStream) RawWriter() io.Writer

func (WriterStream) String added in v0.7.17 

func (t WriterStream) String() string

func (*WriterStream) Write added in v0.7.17 

func (w *WriterStream) Write(p []byte) (int, error)

Source Files

View all Source files

Directories

Path Synopsis
cmd
gmnlisp command
gmnlpp command

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.