A record type which describes the attributes of a shell.

A basic shell description with sane initial values.

Creates a simple shell description from a list of shell commands and an evaluation function.

The default shell exception handler. It simply prints the exception and returns the shell state unchanged. (However, it specificaly ignores the thread killed exception, because that is used to implement execution canceling)

Run a shell. Given a shell description, a shell backend to use and an initial state this function runs the shell until it exits, and then returns the final state.

Creates a shell command which will exit the shell.

Creates a command which will print the shell help message.

Creates a command to toggle a boolean value

Creates a user defined shell commmand. This relies on the typeclass machenery defined by CommandFunction.

This class is used in the cmd function to automaticly generate the command parsers and command syntax strings for user defined commands. The type of 'f' is restricted to have a restricted set of monomorphic arguments (Int, Integer, Float, Double, String, File, Username, and Completable) and the head type must be Sh st ()

 f :: Int -> File -> Sh MyShellState ()
 g :: Double -> Sh st ()
 h :: Sh SomeShellState ()

are all legal types, whereas:

 bad1 :: a -> Sh (MyShellState a) ()
 bad2 :: [Int] -> Sh MyShellState ()
 bad3 :: Bool -> MyShellState

are not.

Represents a command argument which is a filename

Represents a command argument which is a username

Represents a command argument which is an arbitrary completable item. The type argument determines the instance of Completion which is used to create completions for this command argument.

A typeclass representing user definable completion functions.

The type of a shell command. The shell description is passed in, and the tuple consists of (command name,command parser,command syntax document,help message document)

The type of subshells. The tuple consists of:

1. A function to generate the initial subshell state from the outer shell state
2. A function to generate the outer shell state from the final subshell state
3. A function to generate the shell description from the initial subshell state

Creates a simple subshell from a state mapping function and a shell description.

Prints the help message for this shell, which lists all avaliable commands with their syntax and a short informative message about each.

Print the help message for a particular shell command

Datatype describing the style of shell commands. This determines how shell input is parsed.

Special commands for the shell framework.

The type of commands which produce output on the shell console.

The type of results from shell commands. They are a modified shell state and possibly a shell "special" action to execute.