-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | shell monad
--   
--   This is a shell monad, for generating shell scripts.
@package shell-monad
@version 0.6.2


-- | Shell quoting
module Control.Monad.Shell.Quote

-- | A value that is safely quoted so that it can be exposed to the shell.
--   
--   While the constructor is exposed, you should avoid directly
--   constucting Quoted values. Instead, use <a>quote</a>.
newtype Quoted a
Q :: a -> Quoted a
getQ :: Quoted a -> a

-- | Quotes a value to allow it to be safely exposed to the shell.
--   
--   The method used is to replace ' with '"'"' and wrap the value inside
--   single quotes. This works for POSIX shells, as well as other shells
--   like csh.
class Quotable t
quote :: Quotable t => t -> Quoted Text

-- | An arbitrary value.
newtype Val v
Val :: v -> Val v
instance [overlap ok] Eq a => Eq (Quoted a)
instance [overlap ok] Ord a => Ord (Quoted a)
instance [overlap ok] Show a => Show (Quoted a)
instance [overlap ok] Monoid a => Monoid (Quoted a)
instance [overlap ok] Quotable (Val String)
instance [overlap ok] Quotable (Val Text)
instance [overlap ok] Show v => Quotable (Val v)
instance [overlap ok] Quotable String
instance [overlap ok] Quotable Text


-- | This is a shell monad, for generating shell scripts.
module Control.Monad.Shell

-- | Shell script monad.
data Script a

-- | Generates a shell script, including hashbang, suitable to be written
--   to a file.
script :: Script f -> Text

-- | Generates a single line of shell code.
linearScript :: Script f -> Text

-- | A term that can be expanded in a shell command line.
data Term t a

-- | Used to represent a shell variable.
data Var

-- | Used for a static value.
data Static

-- | A value that is safely quoted so that it can be exposed to the shell.
--   
--   While the constructor is exposed, you should avoid directly
--   constucting Quoted values. Instead, use <a>quote</a>.
data Quoted a

-- | Quotes a value to allow it to be safely exposed to the shell.
--   
--   The method used is to replace ' with '"'"' and wrap the value inside
--   single quotes. This works for POSIX shells, as well as other shells
--   like csh.
class Quotable t
quote :: Quotable t => t -> Quoted Text

-- | Treats the Text as a glob, which expands to one parameter per matching
--   file.
--   
--   The input is assumed to be a well-formed glob. Characters in it that
--   are not alphanumeric and are not wildcard characters will be escaped
--   before it is exposed to the shell. This allows eg, spaces in globs.
glob :: Text -> Quoted Text

-- | Adds a shell command to the script.
run :: Text -> [Text] -> Script ()

-- | Variadic and polymorphic version of <a>run</a>
--   
--   A command can be passed any number of Params.
--   
--   <pre>
--   demo = script $ do
--     cmd "echo" "hello, world"
--     name &lt;- newVar "name"
--     readVar name
--     cmd "echo" "hello" name
--   </pre>
--   
--   For the most efficient use of <a>cmd</a>, add the following
--   boilerplate, which will make string literals in your program default
--   to being Text:
--   
--   <pre>
--   {-# LANGUAGE OverloadedStrings, ExtendedDefaultRules #-}
--   {-# OPTIONS_GHC -fno-warn-type-defaults #-}
--   import Control.Monad.Shell
--   import qualified Data.Text.Lazy as L
--   default (L.Text)
--   </pre>
--   
--   Note that the command to run is itself a Param, so it can be a Text,
--   or a String, or even a Var or Output. For example, this echos "hi":
--   
--   <pre>
--   demo = script $ do
--      echovar &lt;- newVarContaining "echo" ()
--      cmd echovar "hi"
--   </pre>
cmd :: (Param command, CmdParams params) => command -> params

-- | A Param is anything that can be used as the parameter of a command.
class Param a

-- | Allows a function to take any number of Params.
class CmdParams t

-- | The output of a command, or even a more complicated Script can be
--   passed as a parameter to <a>cmd</a>
--   
--   Examples:
--   
--   <pre>
--   cmd "echo" "hello there," (Output (cmd "whoami"))
--   cmd "echo" "root's pwent" (Output (cmd "cat" "/etc/passwd" -|- cmd "grep" "root"))
--   </pre>
newtype Output
Output :: (Script ()) -> Output

-- | Suggests that a shell variable or function have its name contain the
--   specified Text.
newtype NamedLike
NamedLike :: Text -> NamedLike

-- | Class of values that provide a hint for the name to use for a shell
--   variable or function.
--   
--   If you don't want to provide a naming hint, use <tt>()</tt>.
--   
--   <pre>
--   v1 &lt;- <a>newVar</a> ()
--   </pre>
--   
--   To provide a naming hint, use either <a>NamedLike</a>.
--   
--   <pre>
--   v1 &lt;- <a>newVar</a> (<a>NamedLike</a> "x")
--   </pre>
class NameHinted h

-- | Makes a Static Term from any value that can be shown.
static :: Quotable (Val t) => t -> Term Static t

-- | Defines a new shell variable, which starts out not being set.
--   
--   Each call to newVar will generate a new, unique variable name.
--   
--   The namehint can influence this name, but is modified to ensure
--   uniqueness.
newVar :: NameHinted namehint => forall a. namehint -> Script (Term Var a)

-- | Creates a new shell variable, with an initial value which can be
--   anything that can be shown.
--   
--   <pre>
--   s &lt;- newVarContaining "foo bar baz" (NamedLike "s")
--   i &lt;- newVarContaining (1 :: Int) (NamedLike "i")
--   </pre>
newVarContaining :: (NameHinted namehint, Quotable (Val t)) => t -> namehint -> Script (Term Var t)

-- | Sets the Var to the value of the param.
setVar :: Param param => forall a. Term Var a -> param -> Script ()

-- | Gets a Var that refers to a global variable, such as PATH
globalVar :: Text -> Script (Term Var a)

-- | This special Var expands to whatever parameters were passed to the
--   shell script.
--   
--   Inside a func, it expands to whatever parameters were passed to the
--   func.
--   
--   (This is <tt>$@</tt> in shell)
positionalParameters :: Term Var a

-- | Takes the first positional parameter, removing it from
--   positionalParameters and returning a new Var that holds the value of
--   the parameter.
--   
--   If there are no more positional parameters, the script will crash with
--   an error.
--   
--   For example:
--   
--   <pre>
--   removefirstfile = script $ do
--     cmd "rm" =&lt;&lt; takeParameter
--     cmd "echo" "remaining parameters:" positionalParameters
--   </pre>
takeParameter :: NameHinted namehint => forall a. namehint -> Script (Term Var a)

-- | Generates a new Var. Expanding this Var will yield the same result as
--   expanding the input Var, unless it is empty, in which case it instead
--   defaults to the expansion of the param.
defaultVar :: Param param => forall a. Term Var a -> param -> Script (Term Var a)

-- | Generates a new Var. If the input Var is empty, then this new Var will
--   likewise expand to the empty string. But if not, the new Var expands
--   to the param.
whenVar :: Param param => forall a. Term Var a -> param -> Script (Term Var a)

-- | Generates a new Var, which expands to the length of the expansion of
--   the input Var.
--   
--   Note that 'lengthVar positionalParameters' expands to the number of
--   positional parameters.
lengthVar :: Term Var a -> Script (Term Var Integer)

-- | Produces a Var that is a trimmed version of the input Var.
--   
--   The Quoted Text is removed from the value of the Var, either from the
--   beginning or from the end.
--   
--   If the Quoted Text was produced by <a>glob</a>, it could match in
--   multiple ways. You can choose whether to remove the shortest or the
--   longest match.
--   
--   The act of trimming a Var is assumed to be able to produce a new Var
--   holding a different data type.
trimVar :: Greediness -> Direction -> Term Var String -> Quoted Text -> Script (Term Var a)
data Greediness
ShortestMatch :: Greediness
LongestMatch :: Greediness
data Direction
FromBeginning :: Direction
FromEnd :: Direction

-- | Allows modifying the value of a variable before it is passed to a
--   command. The function is passed a Quoted Text which will expand to the
--   value of the variable, and can modify it, by using eg <a>mappend</a>.
--   
--   <pre>
--   cmd "rmdir" (WithVar name ("/home/" &lt;&gt;))
--   </pre>
data WithVar a
WithVar :: (Term Var a) -> (Quoted Text -> Quoted Text) -> WithVar a

-- | Defines a shell function, and returns an action that can be run to
--   call the function.
--   
--   The action is variadic; it can be passed any number of CmdParams.
--   Typically, it will make sense to specify a more concrete type when
--   defining the shell function.
--   
--   The shell function will be given a unique name, that is not used by
--   any other shell function. The namehint can be used to influence the
--   contents of the function name, which makes for more readable generated
--   shell code.
--   
--   For example:
--   
--   <pre>
--   demo = script $ do
--      hohoho &lt;- mkHohoho
--      hohoho (static 1)
--      echo "And I heard him exclaim, ere he rode out of sight ..."
--      hohoho (static 3)
--   
--   mkHohoho :: Script (Term Val Int -&gt; Script ())
--   mkHohoho = func (NamedLike "hohoho") $ do
--      num &lt;- takeParameter
--      forCmd (cmd "seq" "1" num) $ \_n -&gt;
--         cmd "echo" "Ho, ho, ho!" "Merry xmas!"
--   </pre>
func :: (NameHinted namehint, CmdParams callfunc) => namehint -> Script () -> Script callfunc

-- | Runs the command, and separates its output into parts (using the IFS)
--   
--   The action is run for each part, passed a Var containing the part.
forCmd :: Script () -> (Term Var a -> Script ()) -> Script ()

-- | As long as the first Script exits nonzero, runs the second script.
whileCmd :: Script () -> Script () -> Script ()

-- | if with a Script conditional.
--   
--   If the conditional exits 0, the first action is run, else the second.
ifCmd :: Script () -> Script () -> Script () -> Script ()

-- | when with a monadic conditional
whenCmd :: Script () -> Script () -> Script ()

-- | unless with a monadic conditional
unlessCmd :: Script () -> Script () -> Script ()

-- | Matches the value of the Var against the Quoted Text (which can be
--   generated by <a>glob</a>), and runs the Script action associated with
--   the first match.
caseOf :: Term Var a -> [(Quoted Text, Script ())] -> Script ()

-- | Pipes together two Scripts.
(-|-) :: Script () -> Script () -> Script ()

-- | ANDs two Scripts.
(-&&-) :: Script () -> Script () -> Script ()

-- | ORs two Scripts.
(-||-) :: Script () -> Script () -> Script ()

-- | Any function that takes a RedirFile can be passed a a FilePath, in
--   which case the default file descriptor will be redirected to/from the
--   FilePath.
--   
--   Or, it can be passed a tuple of (Fd, FilePath), in which case the
--   specified Fd will be redirected to/from the FilePath.
class RedirFile r

-- | Redirects to a file, overwriting any existing file.
--   
--   For example, to shut up a noisy command:
--   
--   <pre>
--   cmd "find" "/" |&gt; "/dev/null"
--   </pre>
(|>) :: RedirFile f => Script () -> f -> Script ()

-- | Appends to a file. (If file doesn't exist, it will be created.)
(|>>) :: RedirFile f => Script () -> f -> Script ()

-- | Redirects standard input from a file.
(|<) :: RedirFile f => Script () -> f -> Script ()

-- | Redirects a script's output to stderr.
toStderr :: Script () -> Script ()

-- | Redirects the first file descriptor to output to the second.
--   
--   For example, to redirect a command's stderr to stdout:
--   
--   <pre>
--   cmd "foo" &amp;stdError&gt;&amp;stdOutput
--   </pre>
(>&) :: (Script (), Fd) -> Fd -> Script ()

-- | Redirects the first file descriptor to input from the second.
--   
--   For example, to read from Fd 42:
--   
--   <pre>
--   cmd "foo" &amp;stdInput&lt;&amp;Fd 42
--   </pre>
(<&) :: (Script (), Fd) -> Fd -> Script ()

-- | Helper for <a>&gt;&amp;</a> and <a>&lt;&amp;</a>
(&) :: Script () -> Fd -> (Script (), Fd)

-- | Provides the Text as input to the Script, using a here-document.
hereDocument :: Script () -> Text -> Script ()

-- | By default, shell scripts continue running past commands that exit
--   nonzero. Use "stopOnFailure True" to make the script stop on the first
--   such command.
stopOnFailure :: Bool -> Script ()

-- | Makes a nonzero exit status be ignored.
ignoreFailure :: Script () -> Script ()

-- | Generates a new Var. If the input Var is empty then expanding this new
--   Var will cause an error to be thrown, using the param as the error
--   message. If the input Var is not empty, then the new Var expands to
--   the same thing the input Var expands to.
errUnlessVar :: Param param => forall a. Term Var a -> param -> Script (Term Var a)

-- | Creates a Script that checks a Test and exits true (0) or false (1).
--   
--   Useful with ifCmd, whenCmd, etc; for example:
--   
--   <pre>
--   ifCmd (test (FileExists "foo")) (foo, bar)
--   </pre>
test :: Test -> Script ()

-- | Note that this should only include things that test(1) and shell
--   built-in test commands support portably.
data Test
TNot :: Test -> Test
TAnd :: Test -> Test -> Test
TOr :: Test -> Test -> Test
TEmpty :: p -> Test
TNonEmpty :: p -> Test
TStrEqual :: p -> q -> Test
TStrNotEqual :: p -> q -> Test
TEqual :: Term Var p -> Term Var q -> Test
TNotEqual :: Term Var p -> Term Var q -> Test
TGT :: Term Var p -> Term Var q -> Test
TLT :: Term Var p -> Term Var q -> Test
TGE :: Term Var p -> Term Var q -> Test
TLE :: Term Var p -> Term Var q -> Test
TFileEqual :: p -> q -> Test
TFileNewer :: p -> q -> Test
TFileOlder :: p -> q -> Test
TBlockExists :: p -> Test
TCharExists :: p -> Test
TDirExists :: p -> Test
TFileExists :: p -> Test
TRegularFileExists :: p -> Test
TSymlinkExists :: p -> Test
TFileNonEmpty :: p -> Test
TFileExecutable :: p -> Test

-- | Lifts a Term to Arith.
val :: Term t Integer -> Arith

-- | This data type represents shell Arithmetic Expressions.
--   
--   Note that in shell arithmetic, expressions that would evaluate to a
--   Bool, such as ANot and AEqual instead evaluate to 1 for True and 0 for
--   False.
data Arith
ANum :: Integer -> Arith
AVar :: (Term Var Integer) -> Arith
AStatic :: (Term Static Integer) -> Arith

-- | negation
ANegate :: Arith -> Arith

-- | <a>+</a>
APlus :: Arith -> Arith -> Arith

-- | <a>-</a>
AMinus :: Arith -> Arith -> Arith

-- | <a>*</a>
AMult :: Arith -> Arith -> Arith

-- | <a>/</a>
ADiv :: Arith -> Arith -> Arith

-- | <a>mod</a>
AMod :: Arith -> Arith -> Arith

-- | <a>not</a>
ANot :: Arith -> Arith

-- | <a>or</a>
AOr :: Arith -> Arith -> Arith

-- | <a>and</a>
AAnd :: Arith -> Arith -> Arith

-- | <a>==</a>
AEqual :: Arith -> Arith -> Arith

-- | <a>/=</a>
ANotEqual :: Arith -> Arith -> Arith

-- | <a>&lt;</a>
ALT :: Arith -> Arith -> Arith

-- | <a>&gt;</a>
AGT :: Arith -> Arith -> Arith

-- | <a>&lt;=</a>
ALE :: Arith -> Arith -> Arith

-- | <a>&gt;=</a>
AGE :: Arith -> Arith -> Arith

-- | OR of the bits of the two arguments
ABitOr :: Arith -> Arith -> Arith

-- | XOR of the bits of the two arguments
ABitXOr :: Arith -> Arith -> Arith

-- | AND of the bits of the two arguments
ABitAnd :: Arith -> Arith -> Arith

-- | shift left (first argument's bits are shifted by the value of the
--   second argument)
AShiftLeft :: Arith -> Arith -> Arith

-- | shift right
AShiftRight :: Arith -> Arith -> Arith

-- | if the first argument is non-zero, the result is the second, else the
--   result is the third
AIf :: Arith -> (Arith, Arith) -> Arith

-- | Adds a comment that is embedded in the generated shell script.
comment :: Text -> Script ()

-- | Fills a variable with a line read from stdin.
readVar :: Term Var String -> Script ()
instance Eq VarName
instance Ord VarName
instance Show VarName
instance Eq Func
instance Ord Func
instance Show Func
instance Functor Script
instance Enum Arith
instance Num Arith
instance (Show a, Num a) => Num (Term Static a)
instance RedirFile (Fd, FilePath)
instance RedirFile FilePath
instance NameHinted (Maybe Text)
instance NameHinted NamedLike
instance NameHinted ()
instance f ~ () => CmdParams (Script f)
instance (Param arg, CmdParams result) => CmdParams (arg -> result)
instance Param Arith
instance Param Output
instance Param (Quoted Text)
instance Param (WithVar a)
instance Show a => Param (Term Static a)
instance Param (Term Var a)
instance Param UntypedVar
instance Param String
instance Param Text
instance Monoid Env
instance Monad Script
instance Named Func
instance Named VarName
instance Named UntypedVar
instance Named (Term Var t)