eval

package
v0.12.0 Latest Latest
Warning

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

 Go to latest Published: Jul 8, 2018 License: BSD-2-Clause Imports: 40 Imported by: 0

Documentation

Overview

Package eval handles evaluation of parsed Elvish code and provides runtime facilities.

Index

Constants

View Source 
const (
	// FnSuffix is the suffix for the variable names of functions. Defining a
	// function "foo" is equivalent to setting a variable named "foo~", and vice
	// versa.
	FnSuffix = "~"
	// NsSuffix is the suffix for the variable names of namespaces. Defining a
	// namespace foo is equivalent to setting a variable named "foo:", and vice
	// versa.
	NsSuffix = ":"
)

Variables

View Source 
var (
	// ErrRelativeUseNotFromMod is thrown by "use" when relative use is used
	// not from a module
	ErrRelativeUseNotFromMod = errors.New("Relative use not from module")
	// ErrRelativeUseGoesOutsideLib is thrown when a relative use goes out of
	// the library directory.
	ErrRelativeUseGoesOutsideLib = errors.New("Module outside library directory")
)
View Source 
var (
	ErrBadGlobPattern          = errors.New("bad GlobPattern; elvish bug")
	ErrCannotDetermineUsername = errors.New("cannot determine user name from glob pattern")
)

Errors thrown when globbing.

View Source 
var (
	ErrCanOnlyAssignList          = errors.New("can only assign compatible values")
	ErrPathMustBeString           = errors.New("path must be string")
	ErrPathCannotContainColonZero = errors.New(`path cannot contain colon or \0`)
)

Errors

View Source 
var (
	ErrExternalCmdOpts = errors.New("external commands don't accept elvish options")
	ErrCdNoArg         = errors.New("implicit cd accepts no arguments")
)
View Source 
var (
	ErrMustFollowWildcard   = errors.New("must follow wildcard")
	ErrModifierMustBeString = errors.New("modifier must be string")
	ErrWildcardNoMatch      = errors.New("wildcard has no match")
)
View Source 
var (
	// ClosedChan is a closed channel, suitable for use as placeholder channel input.
	ClosedChan = make(chan interface{})
	// BlackholeChan is channel writes onto which disappear, suitable for use as
	// placeholder channel output.
	BlackholeChan = make(chan interface{})
	// DevNull is /dev/null.
	DevNull *os.File
	// DevNullClosedInput is a port made up from DevNull and ClosedChan,
	// suitable as placeholder input port.
	DevNullClosedChan *Port
)
View Source 
var (
	// NoArgs is an empty argument list. It can be used as an argument to Call.
	NoArgs = []interface{}{}
	// NoOpts is an empty option map. It can be used as an argument to Call.
	NoOpts = map[string]interface{}{}
)
View Source 
var ErrArgs = errors.New("args error")
View Source 
var ErrArityMismatch = errors.New("arity mismatch")

ErrArityMismatch is thrown by a closure when the number of arguments the user supplies does not match with what is required.

View Source 
var ErrBadBase = errors.New("bad base")

ErrBadBase is thrown by the "base" builtin if the base is smaller than 2 or greater than 36.

View Source 
var ErrImpure = errors.New("expression is impure")
View Source 
var ErrInput = errors.New("input error")
View Source 
var ErrInterrupted = errors.New("interrupted")
View Source 
var ErrMoreThanOneRest = errors.New("more than one @ lvalue")

ErrMoreThanOneRest is returned when the LHS of an assignment contains more than one rest variables.

View Source 
var ErrNoOptAccepted = errors.New("no option accepted")
View Source 
var ErrNotInSameGroup = errors.New("not in the same process group")
View Source 
var ErrStoreNotConnected = errors.New("store not connected")
View Source 
var IsBuiltinSpecial = map[string]bool{}

IsBuiltinSpecial is the set of all names of builtin special forms. It is intended for external consumption, e.g. the syntax highlighter.

View Source 
var OK = &Exception{}

OK is a pointer to the zero value of Exception, representing the absence of exception.

Functions

func ComposeExceptionsFromPipeline added in v0.6.0 

func ComposeExceptionsFromPipeline(excs []*Exception) error

ComposeExceptionsFromPipeline takes a slice of Exception pointers and composes a suitable error. If all elements of the slice are either nil or OK, a nil is returned. If there is exactly non-nil non-OK Exception, it is returned. Otherwise, a PipelineError built from the slice is returned, with nil items turned into OK's for easier access from elvishscript.

func EachExternal added in v0.11.0 

func EachExternal(f func(string))

EachExternal calls f for each name that can resolve to an external command. TODO(xiaq): Windows support

func FromJSONInterface 

func FromJSONInterface(v interface{}) interface{}

FromJSONInterface converts a interface{} that results from json.Unmarshal to a Value.

func InTempHome added in v0.12.0 

func InTempHome(f func(string))

InTempHome is like util.InTempDir, but it also sets HOME to the temporary directory when f is called.

func MakeVariableRef added in v0.12.0 

func MakeVariableRef(explode bool, ns string, name string) string

MakeVariableRef builds a variable reference.

func MustCreateEmpty added in v0.12.0 

func MustCreateEmpty(name string)

MustCreateEmpty creates an empty file, and panics if an error occurs. It is mainly useful in tests.

func MustMkdirAll added in v0.12.0 

func MustMkdirAll(name string, perm os.FileMode)

MustMkdirAll calls os.MkdirAll and panics if an error is returned. It is mainly useful in tests.

func MustWriteFile added in v0.12.0 

func MustWriteFile(filename string, data []byte, perm os.FileMode)

MustWriteFile calls ioutil.WriteFile and panics if an error occurs. It is mainly useful in tests.

func NewExternalCmdExit 

func NewExternalCmdExit(name string, ws syscall.WaitStatus, pid int) error

func ParseIncompleteVariableRef added in v0.12.0 

func ParseIncompleteVariableRef(text string) (explode bool, ns string, name string)

ParseIncompleteVariableRef parses an incomplete variable reference.

func ParseVariableRef added in v0.12.0 

func ParseVariableRef(text string) (explode bool, ns string, name string)

ParseVariableRef parses a variable reference.

func PurelyEvalCompound added in v0.11.0 

func PurelyEvalCompound(cn *parse.Compound) (string, error)

func SplitIncompleteVariableRef added in v0.12.0 

func SplitIncompleteVariableRef(text string) (explodePart, nsPart, name string)

SplitIncompleteVariableRef splits an incomplete variable reference into three parts: an optional explode operator (either "" or "@"), a namespace part, and a name part.

func SplitVariableRef added in v0.12.0 

func SplitVariableRef(text string) (explodePart, nsPart, name string)

SplitVariableRef splits a variable reference into three parts: an optional explode operator (either "" or "@"), a namespace part, and a name part.

func Styled added in v0.12.0 

func Styled(fm *Frame, input interface{}, transformers ...interface{}) (*styled.Text, error)

Styled turns a string, a styled Segment or a styled Text into a styled Text. This is done by applying a range of transformers to the input.

func TakeNoOpt added in v0.4.0 

func TakeNoOpt(opts map[string]interface{})

func Test added in v0.11.0 

func Test(t *testing.T, tests ...TestCase)

Test runs test cases. For each test case, a new Evaler is created with NewEvaler.

func TestWithSetup added in v0.12.0 

func TestWithSetup(t *testing.T, setup func(*Evaler), tests ...TestCase)

Test runs test cases. For each test case, a new Evaler is created with NewEvaler and passed to the setup function.

Types

type AddDirer added in v0.11.0 

type AddDirer interface {
	// AddDir adds a directory with the given weight to some storage.
	AddDir(dir string, weight float64) error
}

AddDirer wraps the AddDir function.

type BuiltinFn 

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

BuiltinFn uses reflection to wrap arbitrary Go functions into Elvish functions.

Parameters are passed following these rules:

1. If the first parameter of function has type *Frame, it gets the current call frame.

2. If (possibly after a *Frame parameter) the first parameter has type RawOptions, it gets a map of options. If the function has not declared an RawOptions parameter but is passed options, an error is thrown.

3. If the last parameter is non-variadic and has type Inputs, it represents an optional parameter that contains the input to this function. If the argument is not supplied, the input channel of the Frame will be used to supply the inputs.

4. Other parameters are converted using elvToGo.

Return values go to the channel part of the stdout port, after being converted using goToElv. If the last return value has type error and is not nil, it is turned into an exception and no ouputting happens. If the last return value is a nil error, it is ignored.

func NewBuiltinFn added in v0.12.0 

func NewBuiltinFn(name string, impl interface{}) *BuiltinFn

NewBuiltinFn creates a new ReflectBuiltinFn instance.

func (*BuiltinFn) Call 

func (b *BuiltinFn) Call(f *Frame, args []interface{}, opts map[string]interface{}) error

Call calls the implementation using reflection.

func (*BuiltinFn) Equal added in v0.10.0 

func (b *BuiltinFn) Equal(rhs interface{}) bool

Equal compares identity.

func (*BuiltinFn) Hash added in v0.10.0 

func (b *BuiltinFn) Hash() uint32

Hash hashes the address.

func (*BuiltinFn) Kind 

func (*BuiltinFn) Kind() string

Kind returns "fn".

func (*BuiltinFn) Repr 

func (b *BuiltinFn) Repr(int) string

Repr returns an opaque representation "<builtin $name>".

type Callable added in v0.7.0 

type Callable interface {
	// Call calls the receiver in a Frame with arguments and options.
	Call(fm *Frame, args []interface{}, opts map[string]interface{}) error
}

Callable wraps the Call method.

type Closure 

type Closure struct {
	ArgNames []string
	// The name for the rest argument. If empty, the function has fixed arity.
	RestArg     string
	OptNames    []string
	OptDefaults []interface{}
	Op          Op
	Captured    Ns
	SrcMeta     *Source
	DefBegint   int
	DefEnd      int
}

Closure is a closure defined in elvish script.

func (*Closure) Call 

func (c *Closure) Call(fm *Frame, args []interface{}, opts map[string]interface{}) error

Call calls a closure.

func (*Closure) Equal added in v0.10.0 

func (c *Closure) Equal(rhs interface{}) bool

Equal compares by identity.

func (*Closure) Hash added in v0.10.0 

func (c *Closure) Hash() uint32

func (*Closure) Index added in v0.12.0 

func (c *Closure) Index(k interface{}) (interface{}, bool)

func (*Closure) IterateKeys added in v0.12.0 

func (c *Closure) IterateKeys(f func(interface{}) bool)

func (*Closure) Kind 

func (*Closure) Kind() string

Kind returns "fn".

func (*Closure) Repr 

func (c *Closure) Repr(int) string

Repr returns an opaque representation "<closure 0x23333333>".

type CompilationError added in v0.6.0 

type CompilationError struct {
	Message string
	Context util.SourceRange
}

CompilationError represents a compilation error and can pretty print it.

func (*CompilationError) Error added in v0.6.0 

func (ce *CompilationError) Error() string

func (*CompilationError) Pprint added in v0.6.0 

func (ce *CompilationError) Pprint(indent string) string

Pprint pretty-prints a compilation error.

type Editor added in v0.4.0 

type Editor interface {
	Notify(string, ...interface{})
}

Editor is the interface that the line editor has to satisfy. It is needed so that this package does not depend on the edit package.

type EnvList added in v0.10.0 

type EnvList struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

EnvList is a variable whose value is constructed from an environment variable by splitting at pathListSeparator. Changes to it are also propagated to the corresponding environment variable. Its elements cannot contain pathListSeparator or \0; attempting to put any in its elements will result in an error.

func (*EnvList) Get added in v0.10.0 

func (envli *EnvList) Get() interface{}

Get returns a Value for an EnvPathList.

func (*EnvList) Set added in v0.10.0 

func (envli *EnvList) Set(v interface{}) error

Set sets an EnvPathList. The underlying environment variable is set.

type Evaler 

type Evaler struct {
	DaemonClient *daemon.Client

	Editor Editor
	// contains filtered or unexported fields
}

Evaler is used to evaluate elvish sources. It maintains runtime context shared among all evalCtx instances.

func NewEvaler 

func NewEvaler() *Evaler

NewEvaler creates a new Evaler.

func (*Evaler) AddAfterChdir added in v0.12.0 

func (ev *Evaler) AddAfterChdir(f func(string))

AddAfterChdir adds a function to run after changing directory.

func (*Evaler) AddBeforeChdir added in v0.12.0 

func (ev *Evaler) AddBeforeChdir(f func(string))

AddBeforeChdir adds a function to run before changing directory.

func (*Evaler) Chdir added in v0.12.0 

func (ev *Evaler) Chdir(path string) error

Chdir changes the current directory. On success it also updates the PWD environment variable and records the new directory in the directory history. It runs the functions in beforeChdir immediately before changing the directory, and the functions in afterChdir immediately after (if chdir was successful). It returns nil as long as the directory changing part succeeds.

func (*Evaler) Close added in v0.11.0 

func (ev *Evaler) Close() error

Close releases resources allocated when creating this Evaler. Currently this does nothing and always returns a nil error.

func (*Evaler) Compile 

func (ev *Evaler) Compile(n *parse.Chunk, src *Source) (Op, error)

Compile compiles Elvish code in the global scope. If the error is not nil, it always has type CompilationError.

func (*Evaler) EachNsInTop added in v0.11.0 

func (ev *Evaler) EachNsInTop(f func(s string))

EachNsInTop calls the passed function for each namespace that can be used from the top context.

func (*Evaler) EachVariableInTop added in v0.11.0 

func (ev *Evaler) EachVariableInTop(ns string, f func(s string))

EachVariableInTop calls the passed function for each variable name in namespace ns that can be found from the top context.

func (*Evaler) Eval 

func (ev *Evaler) Eval(op Op, ports []*Port, src *Source) error

Eval sets up the Evaler with the given ports and evaluates an Op. The supplied name and text are used in diagnostic messages.

func (*Evaler) EvalSource added in v0.12.0 

func (ev *Evaler) EvalSource(src *Source) error

EvalSource evaluates a chunk of Elvish source.

func (*Evaler) EvalWithStdPorts added in v0.12.0 

func (ev *Evaler) EvalWithStdPorts(op Op, src *Source) error

EvalWithStdPorts sets up the Evaler with standard ports and evaluates an Op. The supplied name and text are used in diagnostic messages.

func (*Evaler) InstallBundled added in v0.11.0 

func (ev *Evaler) InstallBundled(name, src string)

InstallBundled installs a bundled module to the Evaler.

func (*Evaler) InstallDaemonClient added in v0.11.0 

func (ev *Evaler) InstallDaemonClient(client *daemon.Client)

InstallDaemonClient installs a daemon client to the Evaler.

func (*Evaler) InstallModule added in v0.11.0 

func (ev *Evaler) InstallModule(name string, mod Ns)

InstallModule installs a module to the Evaler so that it can be used with "use $name" from script.

func (*Evaler) PurelyEvalCompound added in v0.11.0 

func (ev *Evaler) PurelyEvalCompound(cn *parse.Compound) (string, error)

func (*Evaler) PurelyEvalPartialCompound added in v0.11.0 

func (ev *Evaler) PurelyEvalPartialCompound(cn *parse.Compound, upto *parse.Indexing) (string, error)

func (*Evaler) PurelyEvalPrimary added in v0.11.0 

func (ev *Evaler) PurelyEvalPrimary(pn *parse.Primary) interface{}

PurelyEvalPrimary evaluates a primary node without causing any side effects. If this cannot be done, it returns nil.

Currently, only string literals and variables with no @ can be evaluated.

func (*Evaler) SetArgs added in v0.11.0 

func (ev *Evaler) SetArgs(args []string)

SetArgs sets the $args builtin variable.

func (*Evaler) SetLibDir added in v0.11.0 

func (ev *Evaler) SetLibDir(libDir string)

SetLibDir sets the library directory, in which external modules are to be found.

func (*Evaler) SourceRC added in v0.12.0 

func (ev *Evaler) SourceRC(src *Source) error

SourceRC evaluates a rc.elv file. It evaluates the file in the global namespace. If the file defines a $-exports- map variable, the variable is removed and its content is poured into the global namespace, not overriding existing variables.

type Exception added in v0.6.0 

type Exception struct {
	Cause     error
	Traceback *stackTrace
}

Exception represents an elvish exception. It is both a Value accessible to elvishscript, and the type of error returned by public facing evaluation methods like (*Evaler)PEval.

func (*Exception) Bool added in v0.6.0 

func (exc *Exception) Bool() bool

func (*Exception) Equal added in v0.10.0 

func (exc *Exception) Equal(rhs interface{}) bool

Equal compares by identity.

func (*Exception) Error added in v0.6.0 

func (exc *Exception) Error() string

func (*Exception) Hash added in v0.10.0 

func (exc *Exception) Hash() uint32

func (*Exception) Index added in v0.12.0 

func (exc *Exception) Index(k interface{}) (interface{}, bool)

func (*Exception) IterateKeys added in v0.12.0 

func (exc *Exception) IterateKeys(f func(interface{}) bool)

func (*Exception) Kind added in v0.6.0 

func (exc *Exception) Kind() string

func (*Exception) Pprint added in v0.6.0 

func (exc *Exception) Pprint(indent string) string

func (*Exception) Repr added in v0.6.0 

func (exc *Exception) Repr(indent int) string

type ExternalCmd 

type ExternalCmd struct {
	Name string
}

ExternalCmd is an external command.

func (ExternalCmd) Call 

func (e ExternalCmd) Call(fm *Frame, argVals []interface{}, opts map[string]interface{}) error

Call calls an external command.

func (ExternalCmd) Equal added in v0.10.0 

func (e ExternalCmd) Equal(a interface{}) bool

func (ExternalCmd) Hash added in v0.10.0 

func (e ExternalCmd) Hash() uint32

func (ExternalCmd) Kind 

func (ExternalCmd) Kind() string

func (ExternalCmd) Repr 

func (e ExternalCmd) Repr(int) string

type ExternalCmdExit 

type ExternalCmdExit struct {
	syscall.WaitStatus
	CmdName string
	Pid     int
}

ExternalCmdExit contains the exit status of external commands. If the command was stopped rather than terminated, the Pid field contains the pid of the process.

func (ExternalCmdExit) Error 

func (exit ExternalCmdExit) Error() string

type Flow added in v0.6.0 

type Flow uint

Flow is a special type of error used for control flows. 

const (
	Return Flow = iota
	Break
	Continue
)

Control flows.

func (Flow) Error added in v0.6.0 

func (f Flow) Error() string

func (Flow) Pprint added in v0.6.0 

func (f Flow) Pprint(string) string

func (Flow) Repr added in v0.6.0 

func (f Flow) Repr(int) string

type Frame added in v0.11.0 

type Frame struct {
	*Evaler
	// contains filtered or unexported fields
}

Frame contains information of the current running function, aknin to a call frame in native CPU execution. A Frame is only modified during and very shortly after creation; new Frame's are "forked" when needed.

func NewTopFrame added in v0.11.0 

func NewTopFrame(ev *Evaler, src *Source, ports []*Port) *Frame

NewTopFrame creates a top-level Frame.

func (*Frame) Call added in v0.12.0 

func (fm *Frame) Call(f Callable, args []interface{}, opts map[string]interface{}) (err error)

Call calls a function with the given arguments and options. It does so in a protected environment so that exceptions thrown are wrapped in an Error.

func (*Frame) CallWithOutputCallback added in v0.12.0 

func (fm *Frame) CallWithOutputCallback(fn Callable, args []interface{}, opts map[string]interface{}, valuesCb func(<-chan interface{}), bytesCb func(*os.File)) error

CallWithOutputCallback calls a function with the given arguments and options, feeding the outputs to the given callbacks. It does so in a protected environment so that exceptions thrown are wrapped in an Error.

func (*Frame) CaptureOutput added in v0.12.0 

func (fm *Frame) CaptureOutput(fn Callable, args []interface{}, opts map[string]interface{}) (vs []interface{}, err error)

CaptureOutput calls a function with the given arguments and options, capturing and returning the output. It does so in a protected environment so that exceptions thrown are wrapped in an Error.

func (*Frame) Close added in v0.12.0 

func (fm *Frame) Close() error

Close releases resources allocated for this frame. It always returns a nil error. It may be called only once.

func (Frame) EachNsInTop added in v0.11.0 

func (ev Frame) EachNsInTop(f func(s string))

EachNsInTop calls the passed function for each namespace that can be used from the top context.

func (Frame) EachVariableInTop added in v0.11.0 

func (ev Frame) EachVariableInTop(ns string, f func(s string))

EachVariableInTop calls the passed function for each variable name in namespace ns that can be found from the top context.

func (*Frame) Eval added in v0.12.0 

func (fm *Frame) Eval(op Op) (err error)

Eval evaluates an op. It does so in a protected environment so that exceptions thrown are wrapped in an Error.

func (*Frame) ExecAndUnwrap added in v0.11.0 

func (ctx *Frame) ExecAndUnwrap(desc string, op ValuesOp) ValuesUnwrapper

ExecAndUnwrap executes a ValuesOp and creates an Unwrapper for the obtained values.

func (*Frame) InputChan added in v0.11.0 

func (fm *Frame) InputChan() chan interface{}

InputChan returns a channel from which input can be read.

func (*Frame) InputFile added in v0.11.0 

func (fm *Frame) InputFile() *os.File

InputFile returns a file from which input can be read.

func (*Frame) Interrupts added in v0.11.0 

func (fm *Frame) Interrupts() <-chan struct{}

Interrupts returns a channel that is closed when an interrupt signal comes.

func (*Frame) IsInterrupted added in v0.12.0 

func (fm *Frame) IsInterrupted() bool

IsInterrupted reports whether there has been an interrupt.

func (*Frame) IterateInputs added in v0.11.0 

func (fm *Frame) IterateInputs(f func(interface{}))

IterateInputs calls the passed function for each input element.

func (*Frame) OutputChan added in v0.11.0 

func (fm *Frame) OutputChan() chan<- interface{}

OutputChan returns a channel onto which output can be written.

func (*Frame) OutputFile added in v0.11.0 

func (fm *Frame) OutputFile() *os.File

OutputFile returns a file onto which output can be written.

func (*Frame) ResolveVar added in v0.11.0 

func (fm *Frame) ResolveVar(n, name string) vars.Var

ResolveVar resolves a variable. When the variable cannot be found, nil is returned.

func (*Frame) Unwrap added in v0.11.0 

func (ctx *Frame) Unwrap(desc string, begin, end int, vs []interface{}) ValuesUnwrapper

Unwrap creates an Unwrapper.

type GlobFlag added in v0.6.0 

type GlobFlag uint
const (
	NoMatchOK GlobFlag = 1 << iota
)

func (GlobFlag) Has added in v0.6.0 

func (f GlobFlag) Has(g GlobFlag) bool

type GlobPattern 

type GlobPattern struct {
	glob.Pattern
	Flags GlobFlag
	Buts  []string
}

GlobPattern is en ephemeral Value generated when evaluating tilde and wildcards.

func (GlobPattern) Concat added in v0.12.0 

func (gp GlobPattern) Concat(v interface{}) (interface{}, error)

func (GlobPattern) Equal added in v0.10.0 

func (gp GlobPattern) Equal(a interface{}) bool

func (GlobPattern) Hash added in v0.10.0 

func (gp GlobPattern) Hash() uint32

func (GlobPattern) Index 

func (gp GlobPattern) Index(k interface{}) (interface{}, error)

func (GlobPattern) Kind 

func (GlobPattern) Kind() string

func (GlobPattern) RConcat added in v0.12.0 

func (gp GlobPattern) RConcat(v interface{}) (interface{}, error)

func (GlobPattern) Repr 

func (gp GlobPattern) Repr(int) string

type Inputs added in v0.12.0 

type Inputs func(func(interface{}))

type LValuesOp 

type LValuesOp struct {
	Body       LValuesOpBody
	Begin, End int
}

LValuesOp is an operation on an Frame that produce Variable's.

func (LValuesOp) Exec 

func (op LValuesOp) Exec(fm *Frame) ([]vars.Var, error)

Exec executes an LValuesOp, producing Variable's.

type LValuesOpBody added in v0.12.0 

type LValuesOpBody interface {
	Invoke(*Frame) ([]vars.Var, error)
}

LValuesOpBody is the body of an LValuesOp.

type Ns added in v0.11.0 

type Ns map[string]vars.Var

Ns is a map from names to variables.

func NewNs added in v0.12.0 

func NewNs() Ns

NewNs creates an empty namespace.

func (Ns) Add added in v0.12.0 

func (ns Ns) Add(name string, v vars.Var) Ns

Add adds a variable to the namespace and returns the namespace itself.

func (Ns) AddBuiltinFn added in v0.12.0 

func (ns Ns) AddBuiltinFn(nsName, name string, impl interface{}) Ns

AddBuiltinFn adds a builtin function to a namespace. It returns the namespace itself.

func (Ns) AddBuiltinFns added in v0.12.0 

func (ns Ns) AddBuiltinFns(nsName string, fns map[string]interface{}) Ns

AddBuiltinFns adds builtin functions to a namespace. It returns the namespace itself.

func (Ns) AddFn added in v0.12.0 

func (ns Ns) AddFn(name string, v Callable) Ns

AddFn adds a function to a namespace. It returns the namespace itself.

func (Ns) AddNs added in v0.12.0 

func (ns Ns) AddNs(name string, v Ns) Ns

AddNs adds a sub-namespace to a namespace. It returns the namespace itself.

func (Ns) Clone added in v0.12.0 

func (ns Ns) Clone() Ns

Clone returns a shallow copy of the namespace.

func (Ns) Equal added in v0.11.0 

func (ns Ns) Equal(rhs interface{}) bool

func (Ns) HasName added in v0.12.0 

func (ns Ns) HasName(name string) bool

HasName reports the namespace contains the given name.

func (Ns) Hash added in v0.11.0 

func (ns Ns) Hash() uint32

func (Ns) Index added in v0.12.0 

func (ns Ns) Index(k interface{}) (interface{}, bool)

func (Ns) IterateKeys added in v0.12.0 

func (ns Ns) IterateKeys(f func(interface{}) bool)

func (Ns) Kind added in v0.11.0 

func (Ns) Kind() string

func (Ns) PopName added in v0.12.0 

func (ns Ns) PopName(name string) vars.Var

PopName removes a name from the namespace and returns the variable it used to contain.

func (Ns) Repr added in v0.11.0 

func (ns Ns) Repr(int) string

type Op 

type Op struct {
	Body       OpBody
	Begin, End int
}

Op is an operation on an Frame.

func (Op) Exec 

func (op Op) Exec(fm *Frame) error

Exec executes an Op.

type OpBody added in v0.12.0 

type OpBody interface {
	Invoke(*Frame) error
}

OpBody is the body of an Op.

type PipelineError added in v0.6.0 

type PipelineError struct {
	Errors []*Exception
}

PipelineError represents the errors of pipelines, in which multiple commands may error.

func (PipelineError) Error added in v0.6.0 

func (pe PipelineError) Error() string

func (PipelineError) Repr added in v0.6.0 

func (pe PipelineError) Repr(indent int) string

type Port 

type Port struct {
	File      *os.File
	Chan      chan interface{}
	CloseFile bool
	CloseChan bool
}

Port conveys data stream. It always consists of a byte band and a channel band.

func (*Port) Close 

func (p *Port) Close()

Close closes a Port.

func (*Port) Fork 

func (p *Port) Fork() *Port

Fork returns a copy of a Port with the Close* flags unset.

type PwdVariable 

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

PwdVariable is a variable whose value always reflects the current working directory. Setting it changes the current working directory.

func (PwdVariable) Get 

func (PwdVariable) Get() interface{}

func (PwdVariable) Set 

func (pwd PwdVariable) Set(v interface{}) error

type RawOptions added in v0.12.0 

type RawOptions map[string]interface{}

func (RawOptions) Scan added in v0.12.0 

func (rawOpts RawOptions) Scan(ptr interface{})

Scan takes a pointer to a struct and scan options into it. A field named FieldName corresponds to the option named field-name, unless the field has a explicit "name" tag.

type Source added in v0.11.0 

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

Source describes a piece of source code.

func NewInteractiveSource added in v0.11.0 

func NewInteractiveSource(code string) *Source

NewInteractiveSource returns a Source for a piece of code entered interactively.

func NewInternalSource added in v0.11.0 

func NewInternalSource(name string) *Source

func NewModuleSource added in v0.11.0 

func NewModuleSource(name, path, code string) *Source

NewModuleSource returns a Source for a piece of code used as a module.

func NewScriptSource added in v0.11.0 

func NewScriptSource(name, path, code string) *Source

NewScriptSource returns a Source for a piece of code used as a script.

func (*Source) Equal added in v0.11.0 

func (src *Source) Equal(other interface{}) bool

func (*Source) Hash added in v0.11.0 

func (src *Source) Hash() uint32

func (*Source) Index added in v0.12.0 

func (src *Source) Index(k interface{}) (interface{}, bool)

func (*Source) IterateKeys added in v0.12.0 

func (src *Source) IterateKeys(f func(interface{}) bool)

func (*Source) Kind added in v0.11.0 

func (src *Source) Kind() string

func (*Source) Repr added in v0.11.0 

func (src *Source) Repr(int) string

type SrcType added in v0.11.0 

type SrcType int

SrcType records the type of a piece of source code. 

const (
	// SrcInternal is a special SrcType for internal operations.
	SrcInternal SrcType = iota
	// SrcInteractive is the type of source code entered interactively.
	SrcInteractive
	// SrcScript is the type of source code used as a script.
	SrcScript
	// SrcModule is the type of source code used as a module.
	SrcModule
)

func (SrcType) String added in v0.11.0 

func (t SrcType) String() string

type TestCase added in v0.12.0 

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

TestCase is a test case for Test.

func That added in v0.12.0 

func That(text string) TestCase

That returns a new Test with the specified source code.

func (TestCase) DoesNothing added in v0.12.0 

func (t TestCase) DoesNothing() TestCase

DoesNothing returns t unchanged. It is used to mark that a piece of code should simply does nothing. In particular, it shouldn't have any output and does not error.

func (TestCase) Errors added in v0.12.0 

func (t TestCase) Errors() TestCase

Errors returns an altered Test that requires the source code to result in any error when evaluated.

func (TestCase) ErrorsWith added in v0.12.0 

func (t TestCase) ErrorsWith(err error) TestCase

ErrorsWith returns an altered Test that requires the source code to result in the specified error when evaluted.

func (TestCase) Prints added in v0.12.0 

func (t TestCase) Prints(s string) TestCase

Prints returns an altered test that requires the source code to produce the specified output in the byte pipe when evaluated.

func (TestCase) Puts added in v0.12.0 

func (t TestCase) Puts(vs ...interface{}) TestCase

Puts returns an altered Test that requires the source code to produce the specified values in the value channel when evaluated.

func (TestCase) PutsStrings added in v0.12.0 

func (t TestCase) PutsStrings(ss []string) TestCase

Puts returns an altered Test that requires the source code to produce the specified strings in the value channel when evaluated.

type ValueUnwrapper added in v0.10.0 

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

ValueUnwrapper unwraps one Value.

func (ValueUnwrapper) Any added in v0.10.0 

func (u ValueUnwrapper) Any() interface{}

func (ValueUnwrapper) Callable added in v0.10.0 

func (u ValueUnwrapper) Callable() Callable

func (ValueUnwrapper) FdOrClose added in v0.10.0 

func (u ValueUnwrapper) FdOrClose() int

func (ValueUnwrapper) Int added in v0.10.0 

func (u ValueUnwrapper) Int() int

func (ValueUnwrapper) NonNegativeInt added in v0.10.0 

func (u ValueUnwrapper) NonNegativeInt() int

func (ValueUnwrapper) String added in v0.10.0 

func (u ValueUnwrapper) String() string

type ValuesOp 

type ValuesOp struct {
	Body       ValuesOpBody
	Begin, End int
}

ValuesOp is an operation on an Frame that produce Value's.

func (ValuesOp) Exec 

func (op ValuesOp) Exec(fm *Frame) ([]interface{}, error)

Exec executes a ValuesOp and produces Value's.

type ValuesOpBody added in v0.12.0 

type ValuesOpBody interface {
	Invoke(*Frame) ([]interface{}, error)
}

ValuesOpBody is the body of ValuesOp.

type ValuesUnwrapper added in v0.10.0 

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

ValuesUnwrapper unwraps []Value.

func (ValuesUnwrapper) One added in v0.10.0 

func (u ValuesUnwrapper) One() ValueUnwrapper

One unwraps the value to be exactly one value.

Notes

Bugs

  • When evaluating closures, async access to global variables and ports can be problematic.

Source Files

View all Source files

Directories

Path Synopsis
Package bundled keeps bundled modules.
 Package bundled keeps bundled modules.
Package daemon implements the builtin daemon: module.
 Package daemon implements the builtin daemon: module.
Package re implements the re: module for using regular expressions.
 Package re implements the re: module for using regular expressions.
Package str exposes functionality from Go's strings package as an Elvish module.
 Package str exposes functionality from Go's strings package as an Elvish module.
Package vals contains basic facilities for manipulating values used in the Elvish runtime.
 Package vals contains basic facilities for manipulating values used in the Elvish runtime.
Package vars contains basic types for manipulating Elvish variables.
 Package vars contains basic types for manipulating Elvish variables.

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.