package shell

Import Path
	src.elv.sh/pkg/shell (on go.dev)

Dependency Relation
	imports 38 packages, and imported by 3 packages

Involved Source Files
	      editor.go
	      interact.go
	      paths.go
	      paths_unix.go
	      runtime.go
	      script.go
	   d➜ shell.go
		Package shell is the entry point for the terminal interface of Elvish.

	      signal_unix.go
Package-Level Type Names (total 8, in which 3 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type InteractConfig (struct)
		InteractConfig keeps configuration for the interactive mode.

		Fields (total 2, both are exported)
			Paths Paths
			SpawnDaemon bool
		As Inputs Of (at least one exported)
			func Interact(fds [3]*os.File, cfg *InteractConfig)

	 type Paths (struct)
		Paths keeps all paths required for the Elvish runtime.

		Fields (total 7, all are exported)
			Bin string
			DataDir string
			Db string
			LibDir string
			Rc string
			RunDir string
			Sock string
		As Outputs Of (at least one exported)
			func MakePaths(stderr io.Writer, overrides Paths) Paths
		As Inputs Of (at least 3, in which 2 are exported)
			func InitRuntime(stderr io.Writer, p Paths, spawn bool) *eval.Evaler
			func MakePaths(stderr io.Writer, overrides Paths) Paths
			/* at least one unexported ... *//* at least one unexported: */
			func setupShell(fds [3]*os.File, p Paths, spawn bool) (*eval.Evaler, func())

	 type ScriptConfig (struct)
		ScriptConfig keeps configuration for the script mode.

		Fields (total 5, all are exported)
			Cmd bool
			CompileOnly bool
			JSON bool
			Paths Paths
			SpawnDaemon bool
		As Inputs Of (at least one exported)
			func Script(fds [3]*os.File, args []string, cfg *ScriptConfig) int

	/* 5 unexporteds ... *//* 5 unexporteds: */
	 type daemonStatus int (basic type)

		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func detectDaemon(sockpath string, cl daemon.Client) (daemonStatus, error)
		As Types Of (total 7, none are exported)
			/* 7 unexporteds ... *//* 7 unexporteds: */
			const connectionOtherError
			const connectionShutdown
			const daemonInvalidDB
			const daemonOK
			const daemonOutdated
			const sockfileMissing
			const sockfileOtherError

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

		Methods (total 2, both are exported)
			( T) ReadCode() (string, error)
			( T) RunAfterCommandHooks(src parse.Source, duration float64, err error)
		Implemented By (at least 2, in which 1 are exported)
			*src.elv.sh/pkg/edit.Editor
			/* at least one unexported ... *//* at least one unexported: */
			*minEditor
		Implements (at least one exported)
			 T : src.elv.sh/pkg/eval.Editor

	 type errorInJSON (struct)
		An auxiliary struct for converting errors with diagnostics information to JSON.

		Fields (total 4, all are exported)
			End int
			FileName string
			Message string
			Start int

	 type minEditor (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			in *bufio.Reader
			out io.Writer
		Methods (total 2, both are exported)
			(*T) ReadCode() (string, error)
			(*T) RunAfterCommandHooks(src parse.Source, duration float64, err error)
				RunAfterCommandHooks is a no-op in the minimum editor since it doesn't support
				`edit:after-command` hooks. The method is needed to satisfy the `editor` interface.

		Implements (at least 2, in which 1 are exported)
			*T : src.elv.sh/pkg/eval.Editor
			/* at least one unexported ... *//* at least one unexported: */
			*T : editor
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func newMinEditor(in, out *os.File) *minEditor

	 type program (struct)

		Methods (total 2, both are exported)
			( T) Run(fds [3]*os.File, f *prog.Flags, args []string) error
			( T) ShouldRun(*prog.Flags) bool
		Implements (at least one exported)
			 T : src.elv.sh/pkg/prog.Program


Package-Level Functions (total 24, in which 5 are exported)

	 func CleanupRuntime(stderr io.Writer, ev *eval.Evaler)
		CleanupRuntime cleans up the runtime.

	 func InitRuntime(stderr io.Writer, p Paths, spawn bool) *eval.Evaler
		InitRuntime initializes the runtime. The caller should call CleanupRuntime
		when the Evaler is no longer needed.

	 func Interact(fds [3]*os.File, cfg *InteractConfig)
		Interact runs an interactive shell session.

	 func MakePaths(stderr io.Writer, overrides Paths) Paths
		MakePaths makes a populated Paths, using the given overrides.

	 func Script(fds [3]*os.File, args []string, cfg *ScriptConfig) int
		Script executes a shell script.

	/* 19 unexporteds ... *//* 19 unexporteds: */
	 func checkExclusiveAccess(runDir string) bool
	 func connectToDaemon(stderr io.Writer, spawnCfg *daemon.SpawnConfig) (daemon.Client, error)
	 func detectDaemon(sockpath string, cl daemon.Client) (daemonStatus, error)
	 func ensureDataDir() (string, error)
		Ensures Elvish's data directory exists, creating it if necessary. It returns
		the path to the data directory (never with a trailing slash) and possible
		error.

	 func errorsToJSON(parseErr *parse.Error, compileErr *diag.Error) []byte
		Converts parse and compilation errors into JSON.

	 func evalInTTY(ev *eval.Evaler, fds [3]*os.File, src parse.Source) (float64, error)
	 func getRunDirCandidates() []string
		Returns one or more candidates for the run directory, in descending order of
		preference.

	 func getSecureRunDir() (string, error)
		Returns a "run directory" for storing ephemeral files, which is guaranteed
		to be only accessible to the current user.

		The path of the run directory is either $XDG_RUNTIME_DIR/elvish or
		$tmpdir/elvish-$uid (where $tmpdir is the system temporary directory). The
		former is used if the XDG_RUNTIME_DIR environment variable exists and the
		latter directory does not exist.

	 func handlePanic()
		Interactive mode panic handler.

	 func handleSignal(sig os.Signal, stderr *os.File)
	 func incSHLVL() func()
	 func killDaemon(cl daemon.Client) error
	 func newMinEditor(in, out *os.File) *minEditor
	 func readFileUTF8(fname string) (string, error)
	 func saveEnv(name string) func()
	 func setChild(p *string, d, name string)
	 func setDir(p *string, what string, f func() (string, error), stderr io.Writer)
	 func setupShell(fds [3]*os.File, p Paths, spawn bool) (*eval.Evaler, func())
	 func sourceRC(fds [3]*os.File, ev *eval.Evaler, ed eval.Editor, rcPath string) error
Package-Level Variables (total 5, in which 1 are exported)

	  var Program prog.Program
		Program is the shell subprogram.

	/* 4 unexporteds ... *//* 4 unexporteds: */
	  var errInvalidDB error
	  var errSourceNotUTF8 error
	  var interactiveRescueShell bool
		InteractiveRescueShell determines whether a panic results in a rescue shell
		being launched. It should be set to false by interactive mode unit tests.

	  var logger *log.Logger
Package-Level Constants (total 11, none are exported)

	/* 11 unexporteds ... *//* 11 unexporteds: */
	const connectionOtherError daemonStatus = 4
	const connectionShutdown daemonStatus = 3
	const connectionShutdownFmt = "Socket file %s exists but is not responding to request. This is like...
	const daemonInvalidDB daemonStatus = 5
	const daemonOK daemonStatus = 0
	const daemonOutdated daemonStatus = 6
	const daemonWaitLoops = 100
	const daemonWaitPerLoop time.Duration = 10000000
	const daemonWontWorkMsg = "Daemon-related functions will likely not work."
	const sockfileMissing daemonStatus = 1
	const sockfileOtherError daemonStatus = 2

The pages are generated with Golds v0.2.8-preview. (GOOS=darwin GOARCH=arm64)