/usr/share/doc/libghc-leksah-server-doc/html/IDE-Utils-Tool.html is in libghc-leksah-server-doc 0.12.1.2-3build2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>IDE.Utils.Tool</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_IDE-Utils-Tool.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/IDE-Utils-Tool.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">leksah-server-0.12.1.2: Metadata collection for leksah</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>None</td></tr></table><p class="caption">IDE.Utils.Tool</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Support for running external tools. Written mainly for GHCi but with
| support for others in mind.
</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:ToolOutput">ToolOutput</a> <ul class="subs"><li>= <a href="#v:ToolInput">ToolInput</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> </li><li>| <a href="#v:ToolError">ToolError</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> </li><li>| <a href="#v:ToolOutput">ToolOutput</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> </li><li>| <a href="#v:ToolPrompt">ToolPrompt</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> </li><li>| <a href="#v:ToolExit">ToolExit</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-Exit.html#t:ExitCode">ExitCode</a> </li></ul></li><li class="src short"><a href="#v:toolline">toolline</a> :: <a href="IDE-Utils-Tool.html#t:ToolOutput">ToolOutput</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:ToolCommand">ToolCommand</a> = <a href="#v:ToolCommand">ToolCommand</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> (<a href="/usr/share/doc/libghc-enumerator-doc/html/Data-Enumerator-Internal.html#t:Iteratee">Iteratee</a> <a href="IDE-Utils-Tool.html#t:ToolOutput">ToolOutput</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> ())</li><li class="src short"><span class="keyword">data</span> <a href="#t:ToolState">ToolState</a> = <a href="#v:ToolState">ToolState</a> {<ul class="subs"><li><a href="#v:toolProcessMVar">toolProcessMVar</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Control-Concurrent-MVar.html#t:MVar">MVar</a> <a href="IDE-Utils-Tool.html#t:ProcessHandle">ProcessHandle</a></li><li><a href="#v:outputClosed">outputClosed</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Control-Concurrent-MVar.html#t:MVar">MVar</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Bool.html#t:Bool">Bool</a></li><li><a href="#v:toolCommands">toolCommands</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Control-Concurrent-Chan.html#t:Chan">Chan</a> <a href="IDE-Utils-Tool.html#t:ToolCommand">ToolCommand</a></li><li><a href="#v:toolCommandsRead">toolCommandsRead</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Control-Concurrent-Chan.html#t:Chan">Chan</a> <a href="IDE-Utils-Tool.html#t:ToolCommand">ToolCommand</a></li><li><a href="#v:currentToolCommand">currentToolCommand</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Control-Concurrent-MVar.html#t:MVar">MVar</a> <a href="IDE-Utils-Tool.html#t:ToolCommand">ToolCommand</a></li></ul>}</li><li class="src short"><a href="#v:toolProcess">toolProcess</a> :: <a href="IDE-Utils-Tool.html#t:ToolState">ToolState</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> <a href="IDE-Utils-Tool.html#t:ProcessHandle">ProcessHandle</a></li><li class="src short"><a href="#v:newToolState">newToolState</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> <a href="IDE-Utils-Tool.html#t:ToolState">ToolState</a></li><li class="src short"><a href="#v:runTool">runTool</a> :: <a href="/usr/share/doc/libghc-transformers-doc/html/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m => <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:FilePath">FilePath</a> -> [<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a>] -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:FilePath">FilePath</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/libghc-enumerator-doc/html/Data-Enumerator-Internal.html#t:Enumerator">Enumerator</a> <a href="IDE-Utils-Tool.html#t:ToolOutput">ToolOutput</a> m b, <a href="IDE-Utils-Tool.html#t:ProcessHandle">ProcessHandle</a>)</li><li class="src short"><a href="#v:runTool-39-">runTool'</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:FilePath">FilePath</a> -> [<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a>] -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:FilePath">FilePath</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> ([<a href="IDE-Utils-Tool.html#t:ToolOutput">ToolOutput</a>], <a href="IDE-Utils-Tool.html#t:ProcessHandle">ProcessHandle</a>)</li><li class="src short"><a href="#v:runInteractiveTool">runInteractiveTool</a> :: <a href="IDE-Utils-Tool.html#t:ToolState">ToolState</a> -> CommandLineReader -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:FilePath">FilePath</a> -> [<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a>] -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:newGhci">newGhci</a> :: [<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a>] -> [<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a>] -> <a href="/usr/share/doc/libghc-enumerator-doc/html/Data-Enumerator-Internal.html#t:Iteratee">Iteratee</a> <a href="IDE-Utils-Tool.html#t:ToolOutput">ToolOutput</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> () -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> <a href="IDE-Utils-Tool.html#t:ToolState">ToolState</a></li><li class="src short"><a href="#v:newGhci-39-">newGhci'</a> :: [<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a>] -> <a href="/usr/share/doc/libghc-enumerator-doc/html/Data-Enumerator-Internal.html#t:Iteratee">Iteratee</a> <a href="IDE-Utils-Tool.html#t:ToolOutput">ToolOutput</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> () -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> <a href="IDE-Utils-Tool.html#t:ToolState">ToolState</a></li><li class="src short"><a href="#v:executeCommand">executeCommand</a> :: <a href="IDE-Utils-Tool.html#t:ToolState">ToolState</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/libghc-enumerator-doc/html/Data-Enumerator-Internal.html#t:Iteratee">Iteratee</a> <a href="IDE-Utils-Tool.html#t:ToolOutput">ToolOutput</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> () -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:executeGhciCommand">executeGhciCommand</a> :: <a href="IDE-Utils-Tool.html#t:ToolState">ToolState</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/libghc-enumerator-doc/html/Data-Enumerator-Internal.html#t:Iteratee">Iteratee</a> <a href="IDE-Utils-Tool.html#t:ToolOutput">ToolOutput</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> () -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:quoteArg">quoteArg</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:escapeQuotes">escapeQuotes</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:runCommand">runCommand</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> <a href="IDE-Utils-Tool.html#t:ProcessHandle">ProcessHandle</a></li><li class="src short"><a href="#v:waitForProcess">waitForProcess</a> :: <a href="IDE-Utils-Tool.html#t:ProcessHandle">ProcessHandle</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-Exit.html#t:ExitCode">ExitCode</a></li><li class="src short"><a href="#v:interruptProcessGroupOf">interruptProcessGroupOf</a> :: <a href="IDE-Utils-Tool.html#t:ProcessHandle">ProcessHandle</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><span class="keyword">data</span> <a href="#t:ProcessHandle">ProcessHandle</a> </li><li class="src short"><a href="#v:getProcessExitCode">getProcessExitCode</a> :: <a href="IDE-Utils-Tool.html#t:ProcessHandle">ProcessHandle</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-Exit.html#t:ExitCode">ExitCode</a>)</li><li class="src short"><a href="#v:runInteractiveProcess">runInteractiveProcess</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:FilePath">FilePath</a> -> [<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a>] -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:FilePath">FilePath</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> [(<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a>, <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a>)] -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/GHC-IO-Handle.html#t:Handle">Handle</a>, <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/GHC-IO-Handle.html#t:Handle">Handle</a>, <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/GHC-IO-Handle.html#t:Handle">Handle</a>, <a href="IDE-Utils-Tool.html#t:ProcessHandle">ProcessHandle</a>)</li><li class="src short"><a href="#v:runProcess">runProcess</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:FilePath">FilePath</a> -> [<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a>] -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:FilePath">FilePath</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> [(<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a>, <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a>)] -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/GHC-IO-Handle.html#t:Handle">Handle</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/GHC-IO-Handle.html#t:Handle">Handle</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/GHC-IO-Handle.html#t:Handle">Handle</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> <a href="IDE-Utils-Tool.html#t:ProcessHandle">ProcessHandle</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:ToolOutput" class="def">ToolOutput</a> <a href="src/IDE-Utils-Tool.html#ToolOutput" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:ToolInput" class="def">ToolInput</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:ToolError" class="def">ToolError</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:ToolOutput" class="def">ToolOutput</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:ToolPrompt" class="def">ToolPrompt</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:ToolExit" class="def">ToolExit</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-Exit.html#t:ExitCode">ExitCode</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:ToolOutput" class="caption collapser" onclick="toggleSection('i:ToolOutput')">Instances</p><div id="section.i:ToolOutput" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Eq.html#t:Eq">Eq</a> <a href="IDE-Utils-Tool.html#t:ToolOutput">ToolOutput</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Text-Show.html#t:Show">Show</a> <a href="IDE-Utils-Tool.html#t:ToolOutput">ToolOutput</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/deepseq-1.3.0.1/Control-DeepSeq.html#t:NFData">NFData</a> <a href="IDE-Utils-Tool.html#t:ToolOutput">ToolOutput</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:toolline" class="def">toolline</a> :: <a href="IDE-Utils-Tool.html#t:ToolOutput">ToolOutput</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a><a href="src/IDE-Utils-Tool.html#toolline" class="link">Source</a></p></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:ToolCommand" class="def">ToolCommand</a> <a href="src/IDE-Utils-Tool.html#ToolCommand" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:ToolCommand" class="def">ToolCommand</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> (<a href="/usr/share/doc/libghc-enumerator-doc/html/Data-Enumerator-Internal.html#t:Iteratee">Iteratee</a> <a href="IDE-Utils-Tool.html#t:ToolOutput">ToolOutput</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> ())</td><td class="doc empty"> </td></tr></table></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:ToolState" class="def">ToolState</a> <a href="src/IDE-Utils-Tool.html#ToolState" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:ToolState" class="def">ToolState</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:toolProcessMVar" class="def">toolProcessMVar</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Control-Concurrent-MVar.html#t:MVar">MVar</a> <a href="IDE-Utils-Tool.html#t:ProcessHandle">ProcessHandle</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:outputClosed" class="def">outputClosed</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Control-Concurrent-MVar.html#t:MVar">MVar</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Bool.html#t:Bool">Bool</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:toolCommands" class="def">toolCommands</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Control-Concurrent-Chan.html#t:Chan">Chan</a> <a href="IDE-Utils-Tool.html#t:ToolCommand">ToolCommand</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:toolCommandsRead" class="def">toolCommandsRead</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Control-Concurrent-Chan.html#t:Chan">Chan</a> <a href="IDE-Utils-Tool.html#t:ToolCommand">ToolCommand</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:currentToolCommand" class="def">currentToolCommand</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Control-Concurrent-MVar.html#t:MVar">MVar</a> <a href="IDE-Utils-Tool.html#t:ToolCommand">ToolCommand</a></dt><dd class="doc empty"> </dd></dl><div class="clear"></div></div></td></tr></table></div></div><div class="top"><p class="src"><a name="v:toolProcess" class="def">toolProcess</a> :: <a href="IDE-Utils-Tool.html#t:ToolState">ToolState</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> <a href="IDE-Utils-Tool.html#t:ProcessHandle">ProcessHandle</a><a href="src/IDE-Utils-Tool.html#toolProcess" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:newToolState" class="def">newToolState</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> <a href="IDE-Utils-Tool.html#t:ToolState">ToolState</a><a href="src/IDE-Utils-Tool.html#newToolState" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:runTool" class="def">runTool</a> :: <a href="/usr/share/doc/libghc-transformers-doc/html/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m => <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:FilePath">FilePath</a> -> [<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a>] -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:FilePath">FilePath</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/libghc-enumerator-doc/html/Data-Enumerator-Internal.html#t:Enumerator">Enumerator</a> <a href="IDE-Utils-Tool.html#t:ToolOutput">ToolOutput</a> m b, <a href="IDE-Utils-Tool.html#t:ProcessHandle">ProcessHandle</a>)<a href="src/IDE-Utils-Tool.html#runTool" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:runTool-39-" class="def">runTool'</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:FilePath">FilePath</a> -> [<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a>] -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:FilePath">FilePath</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> ([<a href="IDE-Utils-Tool.html#t:ToolOutput">ToolOutput</a>], <a href="IDE-Utils-Tool.html#t:ProcessHandle">ProcessHandle</a>)<a href="src/IDE-Utils-Tool.html#runTool%27" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:runInteractiveTool" class="def">runInteractiveTool</a> :: <a href="IDE-Utils-Tool.html#t:ToolState">ToolState</a> -> CommandLineReader -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:FilePath">FilePath</a> -> [<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a>] -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> ()<a href="src/IDE-Utils-Tool.html#runInteractiveTool" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:newGhci" class="def">newGhci</a> :: [<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a>] -> [<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a>] -> <a href="/usr/share/doc/libghc-enumerator-doc/html/Data-Enumerator-Internal.html#t:Iteratee">Iteratee</a> <a href="IDE-Utils-Tool.html#t:ToolOutput">ToolOutput</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> () -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> <a href="IDE-Utils-Tool.html#t:ToolState">ToolState</a><a href="src/IDE-Utils-Tool.html#newGhci" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:newGhci-39-" class="def">newGhci'</a> :: [<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a>] -> <a href="/usr/share/doc/libghc-enumerator-doc/html/Data-Enumerator-Internal.html#t:Iteratee">Iteratee</a> <a href="IDE-Utils-Tool.html#t:ToolOutput">ToolOutput</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> () -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> <a href="IDE-Utils-Tool.html#t:ToolState">ToolState</a><a href="src/IDE-Utils-Tool.html#newGhci%27" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:executeCommand" class="def">executeCommand</a> :: <a href="IDE-Utils-Tool.html#t:ToolState">ToolState</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/libghc-enumerator-doc/html/Data-Enumerator-Internal.html#t:Iteratee">Iteratee</a> <a href="IDE-Utils-Tool.html#t:ToolOutput">ToolOutput</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> () -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> ()<a href="src/IDE-Utils-Tool.html#executeCommand" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:executeGhciCommand" class="def">executeGhciCommand</a> :: <a href="IDE-Utils-Tool.html#t:ToolState">ToolState</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/libghc-enumerator-doc/html/Data-Enumerator-Internal.html#t:Iteratee">Iteratee</a> <a href="IDE-Utils-Tool.html#t:ToolOutput">ToolOutput</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> () -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> ()<a href="src/IDE-Utils-Tool.html#executeGhciCommand" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:quoteArg" class="def">quoteArg</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a><a href="src/IDE-Utils-Tool.html#quoteArg" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:escapeQuotes" class="def">escapeQuotes</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a><a href="src/IDE-Utils-Tool.html#escapeQuotes" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:runCommand" class="def">runCommand</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> <a href="IDE-Utils-Tool.html#t:ProcessHandle">ProcessHandle</a></p><div class="doc"><p>Runs a command using the shell.
</p></div></div><div class="top"><p class="src"><a name="v:waitForProcess" class="def">waitForProcess</a> :: <a href="IDE-Utils-Tool.html#t:ProcessHandle">ProcessHandle</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-Exit.html#t:ExitCode">ExitCode</a></p><div class="doc"><p>Waits for the specified process to terminate, and returns its exit code.
</p><p>GHC Note: in order to call <code>waitForProcess</code> without blocking all the
other threads in the system, you must compile the program with
<code>-threaded</code>.
</p></div></div><div class="top"><p class="src"><a name="v:interruptProcessGroupOf" class="def">interruptProcessGroupOf</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="IDE-Utils-Tool.html#t:ProcessHandle">ProcessHandle</a></td><td class="doc"><p>A process in the process group
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> ()</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Sends an interrupt signal to the process group of the given process.
</p><p>On Unix systems, it sends the group the SIGINT signal.
</p><p>On Windows systems, it generates a CTRL_BREAK_EVENT and will only work for
processes created using <code><a href="/usr/share/doc/ghc-doc/html/libraries/process-1.1.0.2/System-Process.html#v:createProcess">createProcess</a></code> and setting the <code><a href="/usr/share/doc/ghc-doc/html/libraries/process-1.1.0.2/System-Process.html#v:create_group">create_group</a></code> flag
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:ProcessHandle" class="def">ProcessHandle</a> </p></div><div class="top"><p class="src"><a name="v:getProcessExitCode" class="def">getProcessExitCode</a> :: <a href="IDE-Utils-Tool.html#t:ProcessHandle">ProcessHandle</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-Exit.html#t:ExitCode">ExitCode</a>)</p><div class="doc"><p>This is a non-blocking version of <code><a href="IDE-Utils-Tool.html#v:waitForProcess">waitForProcess</a></code>. If the process is
still running, <code><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#v:Nothing">Nothing</a></code> is returned. If the process has exited, then
<code><code><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#v:Just">Just</a></code> e</code> is returned where <code>e</code> is the exit code of the process.
</p></div></div><div class="top"><p class="src"><a name="v:runInteractiveProcess" class="def">runInteractiveProcess</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:FilePath">FilePath</a></td><td class="doc"><p>Filename of the executable (see <code><a href="/usr/share/doc/ghc-doc/html/libraries/process-1.1.0.2/System-Process.html#v:proc">proc</a></code> for details)
</p></td></tr><tr><td class="src">-> [<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a>]</td><td class="doc"><p>Arguments to pass to the executable
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:FilePath">FilePath</a></td><td class="doc"><p>Optional path to the working directory
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> [(<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a>, <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a>)]</td><td class="doc"><p>Optional environment (otherwise inherit)
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/GHC-IO-Handle.html#t:Handle">Handle</a>, <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/GHC-IO-Handle.html#t:Handle">Handle</a>, <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/GHC-IO-Handle.html#t:Handle">Handle</a>, <a href="IDE-Utils-Tool.html#t:ProcessHandle">ProcessHandle</a>)</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Runs a raw command, and returns <code><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/GHC-IO-Handle.html#t:Handle">Handle</a></code>s that may be used to communicate
with the process via its <code>stdin</code>, <code>stdout</code> and <code>stderr</code> respectively.
</p><p>For example, to start a process and feed a string to its stdin:
</p><pre> (inp,out,err,pid) <- runInteractiveProcess "..."
forkIO (hPutStr inp str)
</pre><p>The <code><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/GHC-IO-Handle.html#t:Handle">Handle</a></code>s are initially in binary mode; if you need them to be
in text mode then use <code><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/GHC-IO-Handle.html#v:hSetBinaryMode">hSetBinaryMode</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:runProcess" class="def">runProcess</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:FilePath">FilePath</a></td><td class="doc"><p>Filename of the executable (see <code><a href="/usr/share/doc/ghc-doc/html/libraries/process-1.1.0.2/System-Process.html#v:proc">proc</a></code> for details)
</p></td></tr><tr><td class="src">-> [<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a>]</td><td class="doc"><p>Arguments to pass to the executable
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:FilePath">FilePath</a></td><td class="doc"><p>Optional path to the working directory
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> [(<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a>, <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a>)]</td><td class="doc"><p>Optional environment (otherwise inherit)
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/GHC-IO-Handle.html#t:Handle">Handle</a></td><td class="doc"><p>Handle to use for <code>stdin</code> (Nothing => use existing <code>stdin</code>)
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/GHC-IO-Handle.html#t:Handle">Handle</a></td><td class="doc"><p>Handle to use for <code>stdout</code> (Nothing => use existing <code>stdout</code>)
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/GHC-IO-Handle.html#t:Handle">Handle</a></td><td class="doc"><p>Handle to use for <code>stderr</code> (Nothing => use existing <code>stderr</code>)
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> <a href="IDE-Utils-Tool.html#t:ProcessHandle">ProcessHandle</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Runs a raw command, optionally specifying <code><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/GHC-IO-Handle.html#t:Handle">Handle</a></code>s from which to
take the <code>stdin</code>, <code>stdout</code> and <code>stderr</code> channels for the new
process (otherwise these handles are inherited from the current
process).
</p><p>Any <code><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/GHC-IO-Handle.html#t:Handle">Handle</a></code>s passed to <code><a href="IDE-Utils-Tool.html#v:runProcess">runProcess</a></code> are placed immediately in the
closed state.
</p><p>Note: consider using the more general <code><a href="/usr/share/doc/ghc-doc/html/libraries/process-1.1.0.2/System-Process.html#v:createProcess">createProcess</a></code> instead of
<code><a href="IDE-Utils-Tool.html#v:runProcess">runProcess</a></code>.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.13.2</p></div></body></html>
|