HSH-2.1.2: Library to mix shell scripting with Haskell programs

Copyright | Copyright (C) 2006-2009 John Goerzen
License | GNU LGPL, version 2.1 or above
Maintainer | John Goerzen <jgoerzen@complete.org>
Stability | provisional
Portability | portable
Safe Haskell | None
Language | Haskell98

HSH.Command

Description

Copyright (c) 2006-2009 John Goerzen, jgoerzen@complete.org

Synopsis

- type Environment = Maybe [(String, String)]
- class Show a => ShellCommand a where
  - fdInvoke :: a -> Environment -> Channel -> IO (Channel, [InvokeResult])
- data PipeCommand a b = (ShellCommand a, ShellCommand b) => PipeCommand a b
- (-|-) :: (ShellCommand a, ShellCommand b) => a -> b -> PipeCommand a b
- class RunResult a where
  - run :: ShellCommand b => b -> a
- runIO :: ShellCommand a => a -> IO ()
- runSL :: ShellCommand a => a -> IO String
- type InvokeResult = (String, IO ExitCode)
- checkResults :: (String, ExitCode) -> IO ()
- tryEC :: IO a -> IO (Either ExitCode a)
- catchEC :: IO a -> (ExitCode -> IO a) -> IO a
- setenv :: ShellCommand cmd => [(String, String)] -> cmd -> EnvironCommand cmd
- unsetenv :: ShellCommand cmd => [String] -> cmd -> EnvironCommand cmd

# Documentation

type Environment = Maybe [(String, String)] Source

Type for the environment.

class Show a => ShellCommand a where Source

A shell command is something we can invoke, pipe to, pipe from, or pipe in both directions. All commands that can be run as shell commands must define these methods.

Minimum implementation is `fdInvoke`.

Some pre-defined instances include:

- A simple bare string, which is passed to the shell for execution. The shell will then typically expand wildcards, parse parameters, etc.
- A `(String, [String])` tuple. The first item in the tuple gives the name of a program to run, and the second gives its arguments. The shell is never involved. This is ideal for passing filenames, since there is no security risk involving special shell characters.
- A `Handle -> Handle -> IO ()` function, which reads from the first handle and write to the second.
- Various functions. These functions will accept input representing its standard input and output will go to standard output.

Some pre-defined instance functions include:

- `(String -> String)`, `(String -> IO String)`, plus the same definitions for ByteStrings.
- `([String] -> [String])`, `([String] -> IO [String])`, where each `String` in the list represents a single line
- `(() -> String)`, `(() -> IO String)`, for commands that explicitly read no input. Useful with closures. Useful when you want to avoid reading stdin because something else already is. These have the unit as part of the function because otherwise we would have conflicts with things such as bare Strings, which represent a command name.

Methods

fdInvoke Source

Arguments

:: a | The command
-> Environment | The environment
-> Channel | Where to read input from
-> IO (Channel, [InvokeResult]) | Returns an action that, when evaluated, waits for the process to finish and returns an exit code.

Invoke a command.

Instances

ShellCommand String Source | An instance of `ShellCommand` for an external command. The String is split using words to the command to run, and the arguments, if any.
ShellCommand ([String] -> [String]) Source | An instance of `ShellCommand` for a pure Haskell function mapping [String] to [String]. A [String] is generated from a Handle via the `lines` function, and the reverse occurs via `unlines`. So, this function is intended to operate upon lines of input and produce lines of output.
ShellCommand ([String] -> IO [String]) Source | The same for an IO function
ShellCommand (String -> IO String) Source |
ShellCommand (String -> String) Source | An instance of `ShellCommand` for a pure Haskell function mapping String to String. Implement in terms of (String -> IO String) for simplicity.
ShellCommand (() -> [String]) Source |
ShellCommand (() -> IO [String]) Source |
ShellCommand (() -> IO String) Source | A user function that takes no input, and generates output. We will deal with it using hPutStr to send the output on.
ShellCommand (() -> IO ByteString) Source |
ShellCommand (() -> IO ByteString) Source |
ShellCommand (() -> String) Source |
ShellCommand (() -> ByteString) Source |
ShellCommand (() -> ByteString) Source |
ShellCommand (ByteString -> IO ByteString) Source |
ShellCommand (ByteString -> ByteString) Source |
ShellCommand (ByteString -> IO ByteString) Source |
ShellCommand (ByteString -> ByteString) Source |
ShellCommand (Channel -> IO Channel) Source |
ShellCommand (String, [String]) Source | An instance of `ShellCommand` for an external command. The first String is the command to run, and the list of Strings represents the arguments to the program, if any.
(ShellCommand a, ShellCommand b) => ShellCommand (PipeCommand a b) Source | An instance of `ShellCommand` represeting a pipeline.

data PipeCommand a b Source

Constructors

(ShellCommand a, ShellCommand b) => PipeCommand a b |

Instances

Show (PipeCommand a b) Source |
(ShellCommand a, ShellCommand b) => ShellCommand (PipeCommand a b) Source | An instance of `ShellCommand` represeting a pipeline.

(-|-) :: (ShellCommand a, ShellCommand b) => a -> b -> PipeCommand a b Source

Pipe the output of the first command into the input of the second.

class RunResult a where Source

Different ways to get data from `run`.

- IO () runs, throws an exception on error, and sends stdout to stdout
- IO String runs, throws an exception on error, reads stdout into a buffer, and returns it as a string. Note: This output is not lazy.
- IO [String] is same as IO String, but returns the results as lines. Note: this output is not lazy.
- IO ExitCode runs and returns an ExitCode with the exit information. stdout is sent to stdout. Exceptions are not thrown.
- IO (String, ExitCode) is like IO ExitCode, but also includes a description of the last command in the pipe to have an error (or the last command, if there was no error).
- IO ByteString and are similar to their String counterparts.
- IO (String, IO (String, ExitCode)) returns a String read lazily and an IO action that, when evaluated, finishes up the process and results in its exit status. This command returns immediately.
- IO (IO (String, ExitCode)) sends stdout to stdout but returns immediately. It forks off the child but does not wait for it to finish. You can use `checkResults` to wait for the finish.
- IO Int returns the exit code from a program directly. If a signal caused the command to be reaped, returns 128 + SIGNUM.
- IO Bool returns True if the program exited normally (exit code 0, not stopped by a signal) and False otherwise.

To address insufficient laziness, you can process anything that needs to be processed lazily within the pipeline itself.

Methods

run :: ShellCommand b => b -> a Source

Runs a command (or pipe of commands), with results presented in any number of different ways.

Instances

RunResult (IO Bool) Source |
RunResult (IO Int) Source |
RunResult (IO [String]) Source |
RunResult (IO (IO (String, ExitCode))) Source |
RunResult (IO String) Source |
RunResult (IO ()) Source |
RunResult (IO (String, IO (String, ExitCode))) Source |
RunResult (IO (String, ExitCode)) Source |
RunResult (IO (ByteString, IO (String, ExitCode))) Source |
RunResult (IO (ByteString, IO (String, ExitCode))) Source |
RunResult (IO ExitCode) Source |
RunResult (IO ByteString) Source |
RunResult (IO ByteString) Source |

runIO :: ShellCommand a => a -> IO () Source

A convenience function. Refers only to the version of `run` that returns `IO ()`. This prevents you from having to cast to it all the time when you do not care about the result of `run`.

The implementation is simply:

    runIO :: (ShellCommand a) => a -> IO ()
    runIO = run

runSL :: ShellCommand a => a -> IO String Source

Another convenience function. This returns the first line of the output, with any trailing newlines or whitespace stripped off. No leading whitespace is stripped. This function will raise an exception if there is not at least one line of output. Mnemonic: runSL means "run single line".

This command exists separately from `run` because there is already a `run` instance that returns a String, though that instance returns the entirety of the output in that String.

type InvokeResult = (String, IO ExitCode) Source

Result type for shell commands. The String is the text description of the command, not its output.

checkResults :: (String, ExitCode) -> IO () Source

Evaluates result codes and raises an error for any bad ones it finds.

tryEC :: IO a -> IO (Either ExitCode a) Source

Handle an exception derived from a program exiting abnormally

catchEC :: IO a -> (ExitCode -> IO a) -> IO a Source

Catch an exception derived from a program exiting abnormally

setenv :: ShellCommand cmd => [(String, String)] -> cmd -> EnvironCommand cmd Source

Sets an environment variable, replacing an existing one if it exists.

Here's a sample ghci session to illustrate. First, let's see the defaults for some variables:

    Prelude HSH> runIO $ "echo $TERM, $LANG"
    xterm, en_US.UTF-8

Now, let's set one:

    Prelude HSH> runIO $ setenv [("TERM", "foo")] $ "echo $TERM, $LANG"
    foo, en_US.UTF-8

Or two:

    Prelude HSH> runIO $ setenv [("TERM", "foo")] $ setenv [("LANG", "de_DE.UTF-8")] $ "echo $TERM, $LANG"
    foo, de_DE.UTF-8

We could also do it easier, like this:

    Prelude HSH> runIO $ setenv [("TERM", "foo"), ("LANG", "de_DE.UTF-8")] $ "echo $TERM, $LANG"
    foo, de_DE.UTF-8

It can be combined with unsetenv:

    Prelude HSH> runIO $ setenv [("TERM", "foo")] $ unsetenv ["LANG"] $ "echo $TERM, $LANG"
    foo,

And used with pipes:

    Prelude HSH> runIO $ setenv [("TERM", "foo")] $ "echo $TERM, $LANG" -|- "tr a-z A-Z"
    FOO, EN_US.UTF-8

See also `unsetenv`.

unsetenv :: ShellCommand cmd => [String] -> cmd -> EnvironCommand cmd Source

Removes an environment variable if it exists; does nothing otherwise.

See also `setenv`, which has a more extensive example.