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


-- | Enhanced version of process-extras
--   
--   Extra functionality for the Process library
--   <a>http://hackage.haskell.org/package/process</a>. This is a drop-in
--   replacement for
--   <a>http://hackage.haskell.org/package/process-extras</a>, which adds
--   support for creating processes from a CreateProcess, more access to
--   the internals, and completes support for the String type.
@package process-listlike
@version 0.9


-- | Generalized versions of the functions <a>readProcess</a>, and
--   <a>readProcessWithExitCode</a>.
module System.Process.ListLike

-- | Class of types which can be used as the input and outputs of these
--   process functions.
class ListLikeIO a c => ListLikePlus a c
setModes :: ListLikePlus a c => a -> (Maybe Handle, Maybe Handle, Maybe Handle, ProcessHandle) -> IO ()
readChunks :: ListLikePlus a c => Handle -> IO [a]

-- | Read the output of a process and use the argument functions to convert
--   it into a Monoid, preserving the order of appearance of the different
--   chunks of output from standard output and standard error.
readProcessInterleaved :: (ListLikePlus a c, Monoid b) => (ProcessHandle -> b) -> (ExitCode -> b) -> (a -> b) -> (a -> b) -> CreateProcess -> a -> IO b

-- | Simultaneously read the output from several file handles, using the
--   associated functions to add them to a Monoid b in the order they
--   appear. This closes each handle on EOF, because AFAIK it is the only
--   useful thing to do with a file handle that has reached EOF.
readInterleaved :: (ListLikePlus a c, Monoid b) => b -> [(a -> b, Handle)] -> IO b -> IO b

-- | An implementation of <a>readProcessWithExitCode</a> with a two
--   generalizations: (1) The input and outputs can be any instance of
--   <a>ListLikePlus</a>, and (2) The CreateProcess is passes an argument,
--   so you can use either <a>proc</a> or <a>rawSystem</a> and you can
--   modify its fields such as <a>cwd</a> before the process starts
readCreateProcessWithExitCode :: ListLikePlus a c => CreateProcess -> a -> IO (ExitCode, a, a)

-- | An implementation of <a>readProcess</a> with a two generalizations:
--   (1) The input and outputs can be any instance of <a>ListLikePlus</a>,
--   and (2) The CreateProcess is passes an argument, so you can use either
--   <a>proc</a> or <a>rawSystem</a> and you can modify its fields such as
--   <a>cwd</a> before the process starts
--   
--   This can't be implemented by calling readProcessInterleaved because
--   the std_err field needs to be set to Inherit, which means that
--   <a>createProcess</a> returns no stderr handle. Instead, we have a
--   nearly identical copy of the <a>readProcessInterleaved</a> code which
--   only passes one pair <a>readInterleaved</a>. REMEMBER to keep these
--   two in sync if there are future changes!
readCreateProcess :: ListLikePlus a c => CreateProcess -> a -> IO a

-- | A version of <a>readProcessWithExitCode</a> that uses any instance of
--   <a>ListLikePlus</a> instead of <a>String</a>, implemented using
--   <a>readCreateProcessWithExitCode</a>.
readProcessWithExitCode :: ListLikePlus a c => FilePath -> [String] -> a -> IO (ExitCode, a, a)

-- | Implementation of <a>readProcess</a> that uses any instance of
--   <a>ListLikePlus</a> instead of <a>String</a>, implemented using
--   <a>readCreateProcess</a>.
readProcess :: ListLikePlus a c => FilePath -> [String] -> a -> IO a
showCmdSpecForUser :: CmdSpec -> String
instance Monoid ExitCode

module System.Process.Lazy
instance ListLikePlus String Char
instance ListLikePlus Text Char
instance ListLikePlus ByteString Word8


-- | ListLikePlus instances for strict types - these are more dangerous, if
--   you start a long running process with them they will block until the
--   process finishes. Why not try a lazy type?
module System.Process.Strict
instance ListLikePlus Text Char
instance ListLikePlus ByteString Word8


-- | <a>System.Process.ListLike</a> functions restricted to type
--   <a>ByteString</a>.
module System.Process.ByteString
readProcess :: a ~ ByteString => FilePath -> [String] -> a -> IO a
readProcessWithExitCode :: a ~ ByteString => FilePath -> [String] -> a -> IO (ExitCode, a, a)
readCreateProcess :: a ~ ByteString => CreateProcess -> a -> IO a
readCreateProcessWithExitCode :: a ~ ByteString => CreateProcess -> a -> IO (ExitCode, a, a)


-- | <a>System.Process.ListLike</a> functions restricted to the lazy
--   <a>ByteString</a> type.
module System.Process.ByteString.Lazy
readProcess :: a ~ ByteString => FilePath -> [String] -> a -> IO a
readProcessWithExitCode :: a ~ ByteString => FilePath -> [String] -> a -> IO (ExitCode, a, a)
readCreateProcess :: a ~ ByteString => CreateProcess -> a -> IO a
readCreateProcessWithExitCode :: a ~ ByteString => CreateProcess -> a -> IO (ExitCode, a, a)


-- | <a>System.Process.ListLike</a> functions restricted to type
--   <a>String</a>.
module System.Process.String
readProcess :: a ~ String => FilePath -> [String] -> a -> IO a
readProcessWithExitCode :: a ~ String => FilePath -> [String] -> a -> IO (ExitCode, a, a)
readCreateProcess :: a ~ String => CreateProcess -> a -> IO a
readCreateProcessWithExitCode :: a ~ String => CreateProcess -> a -> IO (ExitCode, a, a)


-- | <a>System.Process.ListLike</a> functions restricted to type
--   <a>Text</a>.
module System.Process.Text
readProcess :: a ~ Text => FilePath -> [String] -> a -> IO a
readProcessWithExitCode :: a ~ Text => FilePath -> [String] -> a -> IO (ExitCode, a, a)
readCreateProcess :: a ~ Text => CreateProcess -> a -> IO a
readCreateProcessWithExitCode :: a ~ Text => CreateProcess -> a -> IO (ExitCode, a, a)


-- | <a>System.Process.ListLike</a> functions restricted to the lazy
--   <a>Text</a> type.
module System.Process.Text.Lazy
readProcess :: a ~ Text => FilePath -> [String] -> a -> IO a
readProcessWithExitCode :: a ~ Text => FilePath -> [String] -> a -> IO (ExitCode, a, a)
readCreateProcess :: a ~ Text => CreateProcess -> a -> IO a
readCreateProcessWithExitCode :: a ~ Text => CreateProcess -> a -> IO (ExitCode, a, a)

module System.Process.Chunks

-- | The output stream of a process returned by <a>readProcessChunks</a>.
data Chunk a

-- | This will always come first
ProcessHandle :: ProcessHandle -> Chunk a
Stdout :: a -> Chunk a
Stderr :: a -> Chunk a
Exception :: IOError -> Chunk a
Result :: ExitCode -> Chunk a

-- | A concrete use of <a>readProcessInterleaved</a> - build a list
--   containing chunks of process output, any exceptions that get thrown
--   (unimplemented), and finally an exit code.
readProcessChunks :: ListLikePlus a c => CreateProcess -> a -> IO [Chunk a]
foldChunk :: (ProcessHandle -> b) -> (a -> b) -> (a -> b) -> (IOError -> b) -> (ExitCode -> b) -> Chunk a -> b

-- | Build a value from a chunk stream.
foldChunks :: (r -> Chunk a -> r) -> r -> [Chunk a] -> r

-- | Write the Stdout chunks to stdout and the Stderr chunks to stderr.
putChunk :: ListLikePlus a c => Chunk a -> IO ()

-- | Merge adjacent Stdout or Stderr chunks.
canonicalChunks :: ListLikePlus a c => [Chunk a] -> [Chunk a]

-- | Pure function to indent the text of a chunk list.
indentChunks :: (ListLikePlus a c, Eq c) => c -> a -> a -> [Chunk a] -> [Chunk a]

-- | Output the indented text of a chunk list, but return the original
--   unindented list.
putIndented :: (ListLikePlus a c, Eq c) => c -> a -> a -> [Chunk a] -> IO [Chunk a]
dotifyChunk :: (Monad m, Functor m, ListLikePlus a c) => Int -> c -> Chunk a -> StateT Int m [Chunk a]
dotifyChunks :: ListLikePlus a c => Int -> c -> [Chunk a] -> [Chunk a]

-- | Output the dotified text of a chunk list, but return the original
--   unindented list.
putDots :: ListLikePlus a c => Int -> c -> [Chunk a] -> IO [Chunk a]
instance Show a => Show (Chunk a)
instance Eq BOL
instance Show ProcessHandle
instance NFData ExitCode