interpreter

Documentation

Index

• func EvaluateEnv(ctx context.Context, script []byte, args []string, envs []string) ([]string, error)
• func GetEnv(hc interp.HandlerContext) []string
• type OpenHandler
• type Shell
  • func New(r io.Reader, name string, args []string, envs []string, ...) (s *Shell, err error)
  • func (s *Shell) LookPath(ctx context.Context, cmd string) (string, error)
  • func (s *Shell) RegisterOpenHandler(path string, handler OpenHandler)
  • func (s *Shell) RegisterShellBuiltin(name string, builtin ShellBuiltin)
  • func (s *Shell) Run(ctx context.Context) error
  • func (s *Shell) Status() uint8
• type ShellBuiltin

Functions

func EvaluateEnv

func EvaluateEnv(ctx context.Context, script []byte, args []string, envs []string) ([]string, error)

EvaluateEnv evaluates the environment variable script and returns the list of variables set in the script. Command execution is disabled along with redirection.

func GetEnv

func GetEnv(hc interp.HandlerContext) []string

GetEnv returns an the list of all exported environment variables within the context of the shell interpreter.

Types

type OpenHandler

type OpenHandler func(path string, flag int, perm os.FileMode) (io.ReadWriteCloser, error)

OpenHandler defines function prototype for shell interpreter file handler registration.

type Shell

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

Shell defines the shell interpreter.

func New

func New(r io.Reader, name string, args []string, envs []string, runnerOptions ...interp.RunnerOption) (s *Shell, err error)

New returns a shell interpreter instance.

func (*Shell) LookPath

func (s *Shell) LookPath(ctx context.Context, cmd string) (string, error)

LookPath returns the absolute path for the command passed in argument within the context of the shell interpreter.

func (*Shell) RegisterOpenHandler

func (s *Shell) RegisterOpenHandler(path string, handler OpenHandler)

RegisterOpenHandler registers a shell interpreter file handler.

func (*Shell) RegisterShellBuiltin

func (s *Shell) RegisterShellBuiltin(name string, builtin ShellBuiltin)

RegisterShellBuiltin registers a shell interpreter builtin.

func (*Shell) Run

func (s *Shell) Run(ctx context.Context) error

Run runs the shell interpreter.

func (*Shell) Status

func (s *Shell) Status() uint8

Status returns the exit code status of the shell interpreter.

type ShellBuiltin

type ShellBuiltin func(ctx context.Context, args []string) error

ShellBuiltin defines function prototype for shell interpreter builtin registration.