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


-- | Quasiquoters for external commands
--   
--   Features:
--   
--   <ul>
--   <li>Quasiquotation syntax for external interpreters</li>
--   </ul>
--   
--   <pre>
--   &gt;&gt;&gt; [sh_| echo hello world! |]
--   hello world!
--   </pre>
--   
--   <ul>
--   <li>Custom quasiquoters</li>
--   </ul>
--   
--   <pre>
--   ghci = quoter $ callCommand "ghc" ["-ignore-dot-ghci", "-e"]
--   </pre>
--   
--   Then you can use <tt>ghci</tt> in ghci!
--   
--   <pre>
--   &gt;&gt;&gt; [ghci| putStrLn "hello world!" |] :: IO ()
--   hello world!
--   </pre>
--   
--   For more examples, see <a>System.Command.QQ.Predef</a>
--   
--   <ul>
--   <li>Haskell values embedding</li>
--   </ul>
--   
--   See README.md for an example
--   
--   <ul>
--   <li>DSLs</li>
--   </ul>
--   
--   See <tt>examples/CommandT.hs</tt>
@package command-qq
@version 0.3.1.0


-- | Haskell values embedding
module System.Command.QQ.Embed

-- | Embed haskell values into external commands
--   
--   I recommend using <tt>-XExtendedDefaultRules</tt> for modules where
--   you want to embed values, it would save for annoying type annotations
--   for numeric literals
--   
--   <pre>
--   embed . embed = embed
--   </pre>
class Embed a
embed :: Embed a => a -> String
embed :: (Embed a, Show a) => a -> String
instance System.Command.QQ.Embed.Embed GHC.Integer.Type.Integer
instance System.Command.QQ.Embed.Embed GHC.Types.Int
instance System.Command.QQ.Embed.Embed GHC.Int.Int8
instance System.Command.QQ.Embed.Embed GHC.Int.Int16
instance System.Command.QQ.Embed.Embed GHC.Int.Int32
instance System.Command.QQ.Embed.Embed GHC.Int.Int64
instance System.Command.QQ.Embed.Embed GHC.Types.Word
instance System.Command.QQ.Embed.Embed GHC.Word.Word8
instance System.Command.QQ.Embed.Embed GHC.Word.Word16
instance System.Command.QQ.Embed.Embed GHC.Word.Word32
instance System.Command.QQ.Embed.Embed GHC.Word.Word64
instance System.Command.QQ.Embed.Embed GHC.Types.Float
instance System.Command.QQ.Embed.Embed GHC.Types.Double
instance System.Command.QQ.Embed.Embed Foreign.C.Types.CChar
instance System.Command.QQ.Embed.Embed Foreign.C.Types.CSChar
instance System.Command.QQ.Embed.Embed Foreign.C.Types.CUChar
instance System.Command.QQ.Embed.Embed Foreign.C.Types.CShort
instance System.Command.QQ.Embed.Embed Foreign.C.Types.CUShort
instance System.Command.QQ.Embed.Embed Foreign.C.Types.CInt
instance System.Command.QQ.Embed.Embed Foreign.C.Types.CUInt
instance System.Command.QQ.Embed.Embed Foreign.C.Types.CLong
instance System.Command.QQ.Embed.Embed Foreign.C.Types.CULong
instance System.Command.QQ.Embed.Embed Foreign.C.Types.CSize
instance System.Command.QQ.Embed.Embed Foreign.C.Types.CLLong
instance System.Command.QQ.Embed.Embed Foreign.C.Types.CULLong
instance System.Command.QQ.Embed.Embed Foreign.C.Types.CFloat
instance System.Command.QQ.Embed.Embed Foreign.C.Types.CDouble
instance (a Data.Type.Equality.~ GHC.Integer.Type.Integer) => System.Command.QQ.Embed.Embed (GHC.Real.Ratio a)
instance System.Command.QQ.Embed.Embed GHC.Types.Char
instance System.Command.QQ.Embed.Embed GHC.Base.String
instance System.Command.QQ.Embed.Embed Data.Text.Internal.Text
instance System.Command.QQ.Embed.Embed Data.Text.Internal.Lazy.Text


-- | Evalute passed arguments with external interpreter
module System.Command.QQ.Eval

-- | Different interesting return types for quasiquoters
--   
--   Instances here mostly resemble the types of things in
--   <a>System.Process</a>
class Eval r
eval :: Eval r => String -> [String] -> r
instance System.Command.QQ.Eval.Eval (GHC.Types.IO ())
instance System.Command.QQ.Eval.Eval (GHC.Types.IO GHC.IO.Exception.ExitCode)
instance System.Command.QQ.Eval.Eval (GHC.Types.IO Data.Text.Internal.Lazy.Text)
instance System.Command.QQ.Eval.Eval (GHC.Types.IO GHC.Base.String)
instance (s Data.Type.Equality.~ GHC.IO.Exception.ExitCode, o Data.Type.Equality.~ Data.Text.Internal.Lazy.Text, e Data.Type.Equality.~ Data.Text.Internal.Lazy.Text) => System.Command.QQ.Eval.Eval (GHC.Types.IO (s, o, e))
instance (i Data.Type.Equality.~ Data.Text.Internal.Lazy.Text, o Data.Type.Equality.~ (GHC.IO.Exception.ExitCode, Data.Text.Internal.Lazy.Text, Data.Text.Internal.Lazy.Text)) => System.Command.QQ.Eval.Eval (i -> GHC.Types.IO o)


-- | Quasiquoters for external commands
module System.Command.QQ

-- | Simple quasiquoter for the default shell
--   
--   <a>sh</a> analog that always constructs an action of type <tt>IO
--   ()</tt> and so can always be used without type annotations
--   
--   <pre>
--   &gt;&gt;&gt; [sh_|echo "hello, world!"|]
--   hello, world!
--   </pre>
sh_ :: QuasiQuoter

-- | Quasiquoter for the default shell
--   
--   Constructs polymorphic action of type <tt>Eval a =&gt; a</tt> from
--   passed string.
--   
--   Uses <tt>SHELL</tt> environment variable as path to shell executable
--   or <tt>/bin/sh</tt> if it is unset.
--   
--   <pre>
--   &gt;&gt;&gt; [sh|echo "hello, world!"|] :: IO ExitCode
--   ExitSuccess
--   
--   &gt;&gt;&gt; [sh|echo "hello, world!"|] :: IO Text
--   "hello, world!\n"
--   </pre>
--   
--   Haskell values can be embedded with Ruby-like syntax:
--   
--   <pre>
--   &gt;&gt;&gt; let apples = 7
--   
--   &gt;&gt;&gt; [sh|echo "#{apples} apples!"|] :: IO Text
--   "7 apples!\n"
--   </pre>
sh :: QuasiQuoter

-- | Shell's quasiquoter constructor
--   
--   "Shell" here means executable that has the following API:
--   
--   <pre>
--   &lt;SHELL&gt; -c &lt;COMMAND&gt;
--   </pre>
--   
--   <i>e.g.</i> <tt>sh</tt>, <tt>bash</tt>, <tt>zsh</tt>, <tt>ksh</tt>,
--   <tt>tcsh</tt>, <tt>python</tt>, etc
shell :: FilePath -> QuasiQuoter

-- | Interpreter's quasiquoter constructor
--   
--   "Interpreter" here means executable that has the following API:
--   
--   <pre>
--   &lt;INTERPRETER&gt; -e &lt;COMMAND&gt;
--   </pre>
--   
--   <i>e.g.</i> <tt>perl</tt>, <tt>ruby</tt>, <tt>ghc</tt>, etc
interpreter :: FilePath -> QuasiQuoter

-- | Construct quasiquoter from function taking the string and producing
--   Haskell expression.
--   
--   Other kinds of quasiquoters (patterns, types or declarations
--   quasiquoters) will fail at compile time
quoter :: (String -> Q Exp) -> QuasiQuoter

-- | Construct Haskell expression for external command call
callCommand :: FilePath -> [String] -> String -> Q Exp

-- | Construct Haskell expression from the string, substituting variables
--   for their values. Variable expansion uses a ruby-like syntax
substituteVars :: String -> Q Exp


-- | Some predefined quasiquoters
module System.Command.QQ.Predef

-- | <tt>bash</tt> shell
bash :: QuasiQuoter

-- | <tt>zsh</tt> shell
zsh :: QuasiQuoter

-- | <tt>awk</tt> interpreter
awk :: QuasiQuoter

-- | <tt>ghci</tt> interpreter
ghci :: QuasiQuoter

-- | <tt>perl</tt> interpreter
perl :: QuasiQuoter

-- | <tt>ruby</tt> interpreter
ruby :: QuasiQuoter

-- | <tt>python</tt> interpreter
python :: QuasiQuoter

-- | <tt>python2</tt> interpreter
python2 :: QuasiQuoter

-- | <tt>python3</tt> interpreter
python3 :: QuasiQuoter