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


-- | Process piping library
--   
--   A library with operations for piping data through a pipeline of
--   processes.
@package Pipe
@version 2.0


-- | Operations for piping data through multiple processes.
--   
--   <a>pipe</a> is the most general function, with 'pipe\'' and
--   <a>pipeString</a> provided for convenience purposes.
--   
--   <a>handlePipe</a>, <a>filePipe</a>, and 'filePipe\'' are for the
--   common file-to-file case and behave somewhat differently.
--   
--   Whenever specifying a path to a process, explicitly specifying the
--   current directory is recommended for portability. That is: use "./foo"
--   instead of "foo", for instance.
--   
--   On Windows, appending ".exe" to process paths is attempted if the
--   invocation fails.
module System.Process.Pipe

-- | Pipes the input, using the given writer and reader functions, through
--   all the commands named, in the given working directory. Returns the
--   result.
--   
--   An exception is thrown if the list of programs is empty.
--   
--   The writer function is called in a 'forkIO'\'d thread, allowing this
--   to be lazy.
pipe :: (Handle -> a -> IO ()) -> (Handle -> IO b) -> FilePath -> [(FilePath, [String])] -> a -> IO b

-- | A convenience function for when you don't care about the working
--   directory, 'pipe\'' uses <a>.</a>.
pipe' :: (Handle -> a -> IO ()) -> (Handle -> IO b) -> [(FilePath, [String])] -> a -> IO b

-- | A convenience function for the common case of piping from a
--   <a>String</a> to a <a>String</a>.
pipeString :: [(FilePath, [String])] -> String -> IO String

-- | A function for the common case of piping from a <a>Handle</a> to a
--   <a>Handle</a>.
--   
--   Note that this is not a convenient frontend for <a>pipe</a> and is
--   fundamentally different in the following ways:
--   
--   <ul>
--   <li>A null list of programs is allowed, in which case the contents of
--   the input Handle are simply written to the output Handle.</li>
--   <li>This function is not lazy and returns only when the writing has
--   been completed.</li>
--   </ul>
handlePipe :: FilePath -> [(FilePath, [String])] -> Handle -> Handle -> IO ()

-- | A convenience function for <a>handlePipe</a>. Opens the given files in
--   binary mode.
filePipe :: FilePath -> [(FilePath, [String])] -> FilePath -> FilePath -> IO ()

-- | Like <a>filePipe</a>, but the working directory used is the directory
--   component of the path to the first file.
filePipe' :: [(FilePath, [String])] -> FilePath -> FilePath -> IO ()