janet

README

go-janet

To update the janet version, clone it and run make, then copy build/c/janet.c, src/include/janet.h, and src/conf/janetconf.h to this directory.

Documentation

Index

• Variables
• func IsValidType(value interface{}) bool
• type Call
  • func CallBytes(data []byte) Call
  • func CallString(code string) Call
• type CallOptions
• type Callback
• type Docstrings
• type Documented
• type Fiber
• type Function
  • func (f *Function) Call(ctx context.Context, params ...interface{}) error
  • func (f *Function) CallContext(ctx context.Context, user interface{}, params ...interface{}) error
• type Keyword
• type Named
  • func (n *Named[T]) Values() T
  • func (n *Named[T]) WithDefault(defaults T) T
• type Params
  • func (p Params) Error(err error)
  • func (p Params) Ok()
  • func (p Params) Out(value *Value)
  • func (p Params) Pipe() Params
  • func (p Params) Wait() error
• type PartialCallback
  • func (p *PartialCallback) Call() []reflect.Value
• type Renamable
• type Request
• type Result
• type Table
• type VM
  • func New(ctx context.Context) (*VM, error)
  • func (v *VM) Callback(name string, docstring string, callback interface{}) error
  • func (v *VM) Env() *Table
  • func (v *VM) Execute(ctx context.Context, code string) error
  • func (v *VM) ExecuteCall(ctx context.Context, user interface{}, call Call) error
  • func (v *VM) ExecuteFile(ctx context.Context, path string) error
  • func (v *VM) Module(name string, module interface{}) error
  • func (v *VM) Unmarshal(source C.Janet, dest interface{}) error
• type Value
  • func (v *Value) Free()
  • func (v *Value) IsFree() bool
  • func (v *Value) Unmarshal(dest interface{}) error

Variables

var DEFAULT_CALL_OPTIONS = CallOptions{
	UpdateEnv: true,
}

var ERROR_FREED = fmt.Errorf("cannot use freed value")

var GO_BOOT_FILE []byte

var JANET_TYPE_TO_STRING map[C.JanetType]string = map[C.JanetType]string{
	C.JANET_NUMBER:    "number",
	C.JANET_NIL:       "nil",
	C.JANET_BOOLEAN:   "boolean",
	C.JANET_FIBER:     "fiber",
	C.JANET_STRING:    "string",
	C.JANET_SYMBOL:    "symbol",
	C.JANET_KEYWORD:   "keyword",
	C.JANET_ARRAY:     "array",
	C.JANET_TUPLE:     "tuple",
	C.JANET_TABLE:     "table",
	C.JANET_STRUCT:    "struct",
	C.JANET_BUFFER:    "buffer",
	C.JANET_FUNCTION:  "function",
	C.JANET_CFUNCTION: "cfunction",
	C.JANET_ABSTRACT:  "abstract",
	C.JANET_POINTER:   "pointer",
}

var (
	METHOD_REGEX = regexp.MustCompile("^# doc: (\\w+)$")
)

Functions

func IsValidType

func IsValidType(value interface{}) bool

IsValidType returns true if the given value can be translated to a Janet value.

Types

type Call

type Call struct {
	Code       []byte
	SourcePath string
	Options    CallOptions
}

func CallBytes

func CallBytes(data []byte) Call

func CallString

func CallString(code string) Call

type CallOptions

type CallOptions struct {
	// Whether to allow the code to mutate the current environment.
	UpdateEnv bool
}

type Callback

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

type Docstrings

type Docstrings interface {
	Docstrings() map[string]string
}

Docstrings provides docstrings for module methods. This is a mapping from the method's Go name to its Janet docstring.

type Documented

type Documented interface {
	Documentation() string
}

Documented provides documentation in the form of a Markdown-formatted string. All of the lines following a top-level Markdown header with a title that matches a Go method name will be included as the Janet documentation for that method.

For example, providing a string that looks like this: ``` # doc: SomeMethod This is some documentation # doc: SomeMethodB This is some other documentation ``` Will result in SomeMethod and SomeMethodB having those docstrings.

type Fiber

type Fiber struct {
	*Value
	// contains filtered or unexported fields
}

type Function

type Function struct {
	*Value
	// contains filtered or unexported fields
}

func (*Function) Call

func (f *Function) Call(ctx context.Context, params ...interface{}) error

func (*Function) CallContext

func (f *Function) CallContext(
	ctx context.Context,
	user interface{},
	params ...interface{},
) error

type Keyword

type Keyword string

type Named

type Named[T any] struct {
	// contains filtered or unexported fields
}

func (*Named[T]) Values

func (n *Named[T]) Values() T

func (*Named[T]) WithDefault

func (n *Named[T]) WithDefault(defaults T) T

type Params

type Params struct {
	Context context.Context
	User    interface{}
	Result  chan Result
}

func (Params) Error

func (p Params) Error(err error)

func (Params) Ok

func (p Params) Ok()

func (Params) Out

func (p Params) Out(value *Value)

func (Params) Pipe

func (p Params) Pipe() Params

Make new Params with an overwritten Result channel.

func (Params) Wait

func (p Params) Wait() error

type PartialCallback

type PartialCallback struct {
	Type reflect.Type
	// contains filtered or unexported fields
}

func (*PartialCallback) Call

func (p *PartialCallback) Call() []reflect.Value

type Renamable

type Renamable interface {
	Renames() map[string]string
}

Renamable provides a mapping from Go method names to Janet function names. This is useful for declaring Janet functions that are not valid Go, such as "boolean?".

type Request

type Request interface{}

type Result

type Result struct {
	Out   *Value
	Error error
}

type Table

type Table struct {
	*Value
	// contains filtered or unexported fields
}

type VM

type VM struct {
	deadlock.RWMutex
	// contains filtered or unexported fields
}

func New

func New(ctx context.Context) (*VM, error)

func (*VM) Callback

func (v *VM) Callback(name string, docstring string, callback interface{}) error

func (*VM) Env

func (v *VM) Env() *Table

func (*VM) Execute

func (v *VM) Execute(ctx context.Context, code string) error

func (*VM) ExecuteCall

func (v *VM) ExecuteCall(ctx context.Context, user interface{}, call Call) error

func (*VM) ExecuteFile

func (v *VM) ExecuteFile(ctx context.Context, path string) error

func (*VM) Module

func (v *VM) Module(name string, module interface{}) error

func (*VM) Unmarshal

func (v *VM) Unmarshal(source C.Janet, dest interface{}) error

type Value

type Value struct {
	deadlock.RWMutex
	// contains filtered or unexported fields
}

func (*Value) Free

func (v *Value) Free()

func (*Value) IsFree

func (v *Value) IsFree() bool

func (*Value) Unmarshal

func (v *Value) Unmarshal(dest interface{}) error