<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html> <head> <!-- Generated by HsColour, http://code.haskell.org/~malcolm/hscolour/ --> <title>src/System/IO/Streams/Process.hs</title> <link type='text/css' rel='stylesheet' href='hscolour.css' /> </head> <body> <pre><a name="line-1"></a><span class='hs-comment'>-- | A module adapting the functions from "System.Process" to work with</span> <a name="line-2"></a><span class='hs-comment'>-- @io-streams@.</span> <a name="line-3"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>IO</span><span class='hs-varop'>.</span><span class='hs-conid'>Streams</span><span class='hs-varop'>.</span><span class='hs-conid'>Process</span> <a name="line-4"></a> <span class='hs-layout'>(</span> <span class='hs-keyword'>module</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Process</span> <a name="line-5"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>runInteractiveCommand</span> <a name="line-6"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>runInteractiveProcess</span> <a name="line-7"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span> <a name="line-8"></a> <a name="line-9"></a><span class='hs-comment'>------------------------------------------------------------------------------</span> <a name="line-10"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-varop'>.</span><span class='hs-conid'>Char8</span> <span class='hs-layout'>(</span><span class='hs-conid'>ByteString</span><span class='hs-layout'>)</span> <a name="line-11"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-varid'>hClose</span><span class='hs-layout'>)</span> <a name="line-12"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Process</span> <span class='hs-layout'>(</span><span class='hs-conid'>CmdSpec</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-conid'>CreateProcess</span> <span class='hs-layout'>(</span><span class='hs-conid'>CreateProcess</span><span class='hs-layout'>,</span> <span class='hs-varid'>close_fds</span><span class='hs-layout'>,</span> <span class='hs-varid'>cmdspec</span><span class='hs-layout'>,</span> <span class='hs-varid'>create_group</span><span class='hs-layout'>,</span> <span class='hs-varid'>cwd</span><span class='hs-layout'>,</span> <span class='hs-varid'>std_err</span><span class='hs-layout'>,</span> <span class='hs-varid'>std_in</span><span class='hs-layout'>,</span> <span class='hs-varid'>std_out</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-conid'>ProcessHandle</span><span class='hs-layout'>,</span> <span class='hs-conid'>StdStream</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>createProcess</span><span class='hs-layout'>,</span> <span class='hs-varid'>getProcessExitCode</span><span class='hs-layout'>,</span> <span class='hs-varid'>interruptProcessGroupOf</span><span class='hs-layout'>,</span> <span class='hs-varid'>proc</span><span class='hs-layout'>,</span> <span class='hs-varid'>rawSystem</span><span class='hs-layout'>,</span> <span class='hs-varid'>readProcess</span><span class='hs-layout'>,</span> <span class='hs-varid'>readProcessWithExitCode</span><span class='hs-layout'>,</span> <span class='hs-varid'>runCommand</span><span class='hs-layout'>,</span> <span class='hs-varid'>shell</span><span class='hs-layout'>,</span> <span class='hs-varid'>showCommandForUser</span><span class='hs-layout'>,</span> <span class='hs-varid'>system</span><span class='hs-layout'>,</span> <span class='hs-varid'>terminateProcess</span><span class='hs-layout'>,</span> <span class='hs-varid'>waitForProcess</span><span class='hs-layout'>)</span> <a name="line-13"></a><span class='hs-comment'>------------------------------------------------------------------------------</span> <a name="line-14"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>IO</span><span class='hs-varop'>.</span><span class='hs-conid'>Streams</span><span class='hs-varop'>.</span><span class='hs-conid'>Combinators</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>Streams</span> <a name="line-15"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>IO</span><span class='hs-varop'>.</span><span class='hs-conid'>Streams</span><span class='hs-varop'>.</span><span class='hs-conid'>Handle</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>Streams</span> <a name="line-16"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>IO</span><span class='hs-varop'>.</span><span class='hs-conid'>Streams</span><span class='hs-varop'>.</span><span class='hs-conid'>Internal</span> <span class='hs-layout'>(</span><span class='hs-conid'>InputStream</span><span class='hs-layout'>,</span> <span class='hs-conid'>OutputStream</span><span class='hs-layout'>)</span> <a name="line-17"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>IO</span><span class='hs-varop'>.</span><span class='hs-conid'>Streams</span><span class='hs-varop'>.</span><span class='hs-conid'>Internal</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>Streams</span> <a name="line-18"></a> <a name="line-19"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Process</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>P</span> <a name="line-20"></a> <a name="line-21"></a> <a name="line-22"></a><a name="runInteractiveCommand"></a><span class='hs-comment'>------------------------------------------------------------------------------</span> <a name="line-23"></a><span class='hs-comment'>-- | Runs a command using the shell, and returns streams that may be used to</span> <a name="line-24"></a><span class='hs-comment'>-- communicate with the process via its stdin, stdout, and stderr respectively.</span> <a name="line-25"></a><span class='hs-comment'>--</span> <a name="line-26"></a><span class='hs-comment'>-- The streams returned by this command are guarded by locks and are therefore</span> <a name="line-27"></a><span class='hs-comment'>-- safe to use in multithreaded code.</span> <a name="line-28"></a><span class='hs-comment'>--</span> <a name="line-29"></a><span class='hs-comment'>-- /Since: 1.0.2.0/</span> <a name="line-30"></a><span class='hs-comment'>--</span> <a name="line-31"></a><span class='hs-definition'>runInteractiveCommand</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <a name="line-32"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>OutputStream</span> <span class='hs-conid'>ByteString</span><span class='hs-layout'>,</span> <a name="line-33"></a> <span class='hs-conid'>InputStream</span> <span class='hs-conid'>ByteString</span><span class='hs-layout'>,</span> <a name="line-34"></a> <span class='hs-conid'>InputStream</span> <span class='hs-conid'>ByteString</span><span class='hs-layout'>,</span> <a name="line-35"></a> <span class='hs-conid'>ProcessHandle</span><span class='hs-layout'>)</span> <a name="line-36"></a><span class='hs-definition'>runInteractiveCommand</span> <span class='hs-varid'>scmd</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span> <a name="line-37"></a> <span class='hs-layout'>(</span><span class='hs-varid'>hin</span><span class='hs-layout'>,</span> <span class='hs-varid'>hout</span><span class='hs-layout'>,</span> <span class='hs-varid'>herr</span><span class='hs-layout'>,</span> <span class='hs-varid'>ph</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'><-</span> <span class='hs-conid'>P</span><span class='hs-varop'>.</span><span class='hs-varid'>runInteractiveCommand</span> <span class='hs-varid'>scmd</span> <a name="line-38"></a> <span class='hs-varid'>sIn</span> <span class='hs-keyglyph'><-</span> <span class='hs-conid'>Streams</span><span class='hs-varop'>.</span><span class='hs-varid'>handleToOutputStream</span> <span class='hs-varid'>hin</span> <span class='hs-varop'>>>=</span> <a name="line-39"></a> <span class='hs-conid'>Streams</span><span class='hs-varop'>.</span><span class='hs-varid'>atEndOfOutput</span> <span class='hs-layout'>(</span><span class='hs-varid'>hClose</span> <span class='hs-varid'>hin</span><span class='hs-layout'>)</span> <span class='hs-varop'>>>=</span> <a name="line-40"></a> <span class='hs-conid'>Streams</span><span class='hs-varop'>.</span><span class='hs-varid'>lockingOutputStream</span> <a name="line-41"></a> <span class='hs-varid'>sOut</span> <span class='hs-keyglyph'><-</span> <span class='hs-conid'>Streams</span><span class='hs-varop'>.</span><span class='hs-varid'>handleToInputStream</span> <span class='hs-varid'>hout</span> <span class='hs-varop'>>>=</span> <a name="line-42"></a> <span class='hs-conid'>Streams</span><span class='hs-varop'>.</span><span class='hs-varid'>atEndOfInput</span> <span class='hs-layout'>(</span><span class='hs-varid'>hClose</span> <span class='hs-varid'>hout</span><span class='hs-layout'>)</span> <span class='hs-varop'>>>=</span> <a name="line-43"></a> <span class='hs-conid'>Streams</span><span class='hs-varop'>.</span><span class='hs-varid'>lockingInputStream</span> <a name="line-44"></a> <span class='hs-varid'>sErr</span> <span class='hs-keyglyph'><-</span> <span class='hs-conid'>Streams</span><span class='hs-varop'>.</span><span class='hs-varid'>handleToInputStream</span> <span class='hs-varid'>herr</span> <span class='hs-varop'>>>=</span> <a name="line-45"></a> <span class='hs-conid'>Streams</span><span class='hs-varop'>.</span><span class='hs-varid'>atEndOfInput</span> <span class='hs-layout'>(</span><span class='hs-varid'>hClose</span> <span class='hs-varid'>herr</span><span class='hs-layout'>)</span> <span class='hs-varop'>>>=</span> <a name="line-46"></a> <span class='hs-conid'>Streams</span><span class='hs-varop'>.</span><span class='hs-varid'>lockingInputStream</span> <a name="line-47"></a> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-varid'>sIn</span><span class='hs-layout'>,</span> <span class='hs-varid'>sOut</span><span class='hs-layout'>,</span> <span class='hs-varid'>sErr</span><span class='hs-layout'>,</span> <span class='hs-varid'>ph</span><span class='hs-layout'>)</span> <a name="line-48"></a> <a name="line-49"></a> <a name="line-50"></a><a name="runInteractiveProcess"></a><span class='hs-comment'>------------------------------------------------------------------------------</span> <a name="line-51"></a><span class='hs-comment'>-- | Runs a raw command, and returns streams that may be used to communicate</span> <a name="line-52"></a><span class='hs-comment'>-- with the process via its @stdin@, @stdout@ and @stderr@ respectively.</span> <a name="line-53"></a><span class='hs-comment'>--</span> <a name="line-54"></a><span class='hs-comment'>-- For example, to start a process and feed a string to its stdin:</span> <a name="line-55"></a><span class='hs-comment'>--</span> <a name="line-56"></a><span class='hs-comment'>-- > (inp,out,err,pid) <- runInteractiveProcess "..."</span> <a name="line-57"></a><span class='hs-comment'>-- > forkIO (Streams.write (Just str) inp)</span> <a name="line-58"></a><span class='hs-comment'>--</span> <a name="line-59"></a><span class='hs-comment'>-- The streams returned by this command are guarded by locks and are therefore</span> <a name="line-60"></a><span class='hs-comment'>-- safe to use in multithreaded code.</span> <a name="line-61"></a><span class='hs-comment'>--</span> <a name="line-62"></a><span class='hs-comment'>-- /Since: 1.0.2.0/</span> <a name="line-63"></a><span class='hs-comment'>--</span> <a name="line-64"></a><span class='hs-definition'>runInteractiveProcess</span> <a name="line-65"></a> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>FilePath</span> <span class='hs-comment'>-- ^ Filename of the executable (see 'proc' for details)</span> <a name="line-66"></a> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</span> <span class='hs-comment'>-- ^ Arguments to pass to the executable</span> <a name="line-67"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>FilePath</span> <span class='hs-comment'>-- ^ Optional path to the working directory</span> <a name="line-68"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Maybe</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>String</span><span class='hs-layout'>,</span><span class='hs-conid'>String</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span> <span class='hs-comment'>-- ^ Optional environment (otherwise inherit)</span> <a name="line-69"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>OutputStream</span> <span class='hs-conid'>ByteString</span><span class='hs-layout'>,</span> <a name="line-70"></a> <span class='hs-conid'>InputStream</span> <span class='hs-conid'>ByteString</span><span class='hs-layout'>,</span> <a name="line-71"></a> <span class='hs-conid'>InputStream</span> <span class='hs-conid'>ByteString</span><span class='hs-layout'>,</span> <a name="line-72"></a> <span class='hs-conid'>ProcessHandle</span><span class='hs-layout'>)</span> <a name="line-73"></a><span class='hs-definition'>runInteractiveProcess</span> <span class='hs-varid'>cmd</span> <span class='hs-varid'>args</span> <span class='hs-varid'>wd</span> <span class='hs-varid'>env</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span> <a name="line-74"></a> <span class='hs-layout'>(</span><span class='hs-varid'>hin</span><span class='hs-layout'>,</span> <span class='hs-varid'>hout</span><span class='hs-layout'>,</span> <span class='hs-varid'>herr</span><span class='hs-layout'>,</span> <span class='hs-varid'>ph</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'><-</span> <span class='hs-conid'>P</span><span class='hs-varop'>.</span><span class='hs-varid'>runInteractiveProcess</span> <span class='hs-varid'>cmd</span> <span class='hs-varid'>args</span> <span class='hs-varid'>wd</span> <span class='hs-varid'>env</span> <a name="line-75"></a> <span class='hs-varid'>sIn</span> <span class='hs-keyglyph'><-</span> <span class='hs-conid'>Streams</span><span class='hs-varop'>.</span><span class='hs-varid'>handleToOutputStream</span> <span class='hs-varid'>hin</span> <span class='hs-varop'>>>=</span> <a name="line-76"></a> <span class='hs-conid'>Streams</span><span class='hs-varop'>.</span><span class='hs-varid'>atEndOfOutput</span> <span class='hs-layout'>(</span><span class='hs-varid'>hClose</span> <span class='hs-varid'>hin</span><span class='hs-layout'>)</span> <span class='hs-varop'>>>=</span> <a name="line-77"></a> <span class='hs-conid'>Streams</span><span class='hs-varop'>.</span><span class='hs-varid'>lockingOutputStream</span> <a name="line-78"></a> <span class='hs-varid'>sOut</span> <span class='hs-keyglyph'><-</span> <span class='hs-conid'>Streams</span><span class='hs-varop'>.</span><span class='hs-varid'>handleToInputStream</span> <span class='hs-varid'>hout</span> <span class='hs-varop'>>>=</span> <a name="line-79"></a> <span class='hs-conid'>Streams</span><span class='hs-varop'>.</span><span class='hs-varid'>atEndOfInput</span> <span class='hs-layout'>(</span><span class='hs-varid'>hClose</span> <span class='hs-varid'>hout</span><span class='hs-layout'>)</span> <span class='hs-varop'>>>=</span> <a name="line-80"></a> <span class='hs-conid'>Streams</span><span class='hs-varop'>.</span><span class='hs-varid'>lockingInputStream</span> <a name="line-81"></a> <span class='hs-varid'>sErr</span> <span class='hs-keyglyph'><-</span> <span class='hs-conid'>Streams</span><span class='hs-varop'>.</span><span class='hs-varid'>handleToInputStream</span> <span class='hs-varid'>herr</span> <span class='hs-varop'>>>=</span> <a name="line-82"></a> <span class='hs-conid'>Streams</span><span class='hs-varop'>.</span><span class='hs-varid'>atEndOfInput</span> <span class='hs-layout'>(</span><span class='hs-varid'>hClose</span> <span class='hs-varid'>herr</span><span class='hs-layout'>)</span> <span class='hs-varop'>>>=</span> <a name="line-83"></a> <span class='hs-conid'>Streams</span><span class='hs-varop'>.</span><span class='hs-varid'>lockingInputStream</span> <a name="line-84"></a> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-varid'>sIn</span><span class='hs-layout'>,</span> <span class='hs-varid'>sOut</span><span class='hs-layout'>,</span> <span class='hs-varid'>sErr</span><span class='hs-layout'>,</span> <span class='hs-varid'>ph</span><span class='hs-layout'>)</span> </pre></body> </html>
