shell

Documentation

Overview

Package shell provides gbash's project-owned shell core plus the in-tree parser, expansion, and interpreter packages it executes against.

Index

• func ExitCode(err error) int
• func IsExitStatus(err error) bool
• func IsUserSyntaxError(err error) bool
• type Execution
• type InteractiveParser
  • func NewInteractiveParser(name string) *InteractiveParser
  • func (p *InteractiveParser) Incomplete() bool
  • func (p *InteractiveParser) Seq(r io.Reader) iter.Seq2[string, error]
• type InteractiveResult
  • func Interact(ctx context.Context, exec *Execution) (*InteractiveResult, error)
• type RunResult
  • func Run(ctx context.Context, exec *Execution) (*RunResult, error)
  • func RunCommand(ctx context.Context, exec *Execution) (*RunResult, error)

Functions

func ExitCode

func ExitCode(err error) int

func IsExitStatus

func IsExitStatus(err error) bool

func IsUserSyntaxError

func IsUserSyntaxError(err error) bool

IsUserSyntaxError reports whether err is a user-facing shell syntax error suitable for REPL and fuzz-test classification.

Types

type Execution

type Execution struct {
	Name              string
	Interpreter       string
	PassthroughArgs   []string
	ScriptPath        string
	Script            string
	Command           []string
	Args              []string
	StartupOptions    []string
	StartupHome       string
	Interactive       bool
	Env               map[string]string
	Dir               string
	VisiblePWD        string
	HasVisiblePWD     bool
	BuiltinCommandDir string
	CompletionState   *shellstate.CompletionState
	Stdin             io.Reader
	Stdout            io.Writer
	Stderr            io.Writer
	FS                gbfs.FileSystem
	Network           network.Client
	Registry          commands.CommandRegistry
	Policy            policy.Policy
	Trace             trace.Recorder
	Exec              func(context.Context, *commands.ExecutionRequest) (*commands.ExecutionResult, error)
	Interact          func(context.Context, *commands.InteractiveRequest) (*commands.InteractiveResult, error)
	// contains filtered or unexported fields
}

type InteractiveParser

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

InteractiveParser is the shell-owned frontend helper for interactive parsing. It assembles complete script chunks for REPL-style callers, but it does not execute them or provide a second shell engine.

func NewInteractiveParser

func NewInteractiveParser(name string) *InteractiveParser

NewInteractiveParser builds the shell-owned parser/printer pair used by repo REPL frontends and tests.

func (*InteractiveParser) Incomplete

func (p *InteractiveParser) Incomplete() bool

Incomplete reports whether the most recent interactive parse needs a continuation line.

func (*InteractiveParser) Seq

func (p *InteractiveParser) Seq(r io.Reader) iter.Seq2[string, error]

Seq parses interactive input and yields rendered script chunks ready for execution.

type InteractiveResult

type InteractiveResult struct {
	ExitCode int
}

func Interact

func Interact(ctx context.Context, exec *Execution) (*InteractiveResult, error)

type RunResult

type RunResult struct {
	FinalEnv    map[string]string
	ShellExited bool
}

func Run

func Run(ctx context.Context, exec *Execution) (*RunResult, error)

func RunCommand

func RunCommand(ctx context.Context, exec *Execution) (*RunResult, error)