<!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>SysTools</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_SysTools.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">ghc-7.4.2: The GHC API</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">SysTools</p></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"><a href="#v:initSysTools">initSysTools</a> :: <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="DynFlags.html#t:Settings">Settings</a></li><li class="src short"><a href="#v:runUnlit">runUnlit</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> [<a href="SysTools.html#t:Option">Option</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:runCpp">runCpp</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> [<a href="SysTools.html#t:Option">Option</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:runCc">runCc</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> [<a href="SysTools.html#t:Option">Option</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:runPp">runPp</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> [<a href="SysTools.html#t:Option">Option</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:runSplit">runSplit</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> [<a href="SysTools.html#t:Option">Option</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:runAs">runAs</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> [<a href="SysTools.html#t:Option">Option</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:runLink">runLink</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> [<a href="SysTools.html#t:Option">Option</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:runMkDLL">runMkDLL</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> [<a href="SysTools.html#t:Option">Option</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:runWindres">runWindres</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> [<a href="SysTools.html#t:Option">Option</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:runLlvmOpt">runLlvmOpt</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> [<a href="SysTools.html#t:Option">Option</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:runLlvmLlc">runLlvmLlc</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> [<a href="SysTools.html#t:Option">Option</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:runClang">runClang</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> [<a href="SysTools.html#t:Option">Option</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:figureLlvmVersion">figureLlvmVersion</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> (<a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="../base-4.5.1.0/Data-Int.html#t:Int">Int</a>)</li><li class="src short"><a href="#v:readElfSection">readElfSection</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> (<a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a>)</li><li class="src short"><a href="#v:askCc">askCc</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> [<a href="SysTools.html#t:Option">Option</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:touch">touch</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:copy">copy</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:copyWithHeader">copyWithHeader</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:setTmpDir">setTmpDir</a> :: <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> <a href="DynFlags.html#t:DynFlags">DynFlags</a></li><li class="src short"><a href="#v:newTempName">newTempName</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> <a href="Util.html#t:Suffix">Suffix</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a></li><li class="src short"><a href="#v:cleanTempDirs">cleanTempDirs</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:cleanTempFiles">cleanTempFiles</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:cleanTempFilesExcept">cleanTempFilesExcept</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> [<a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:addFilesToClean">addFilesToClean</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> [<a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><span class="keyword">data</span> <a href="#t:Option">Option</a> <ul class="subs"><li>= <a href="#v:FileOption">FileOption</a> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> </li><li>| <a href="#v:Option">Option</a> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> </li></ul></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a name="v:initSysTools" class="def">initSysTools</a> :: <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="DynFlags.html#t:Settings">Settings</a></p></div><div class="top"><p class="src"><a name="v:runUnlit" class="def">runUnlit</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> [<a href="SysTools.html#t:Option">Option</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p></div><div class="top"><p class="src"><a name="v:runCpp" class="def">runCpp</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> [<a href="SysTools.html#t:Option">Option</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p></div><div class="top"><p class="src"><a name="v:runCc" class="def">runCc</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> [<a href="SysTools.html#t:Option">Option</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p></div><div class="top"><p class="src"><a name="v:runPp" class="def">runPp</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> [<a href="SysTools.html#t:Option">Option</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p></div><div class="top"><p class="src"><a name="v:runSplit" class="def">runSplit</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> [<a href="SysTools.html#t:Option">Option</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p></div><div class="top"><p class="src"><a name="v:runAs" class="def">runAs</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> [<a href="SysTools.html#t:Option">Option</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p></div><div class="top"><p class="src"><a name="v:runLink" class="def">runLink</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> [<a href="SysTools.html#t:Option">Option</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p></div><div class="top"><p class="src"><a name="v:runMkDLL" class="def">runMkDLL</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> [<a href="SysTools.html#t:Option">Option</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p></div><div class="top"><p class="src"><a name="v:runWindres" class="def">runWindres</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> [<a href="SysTools.html#t:Option">Option</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p></div><div class="top"><p class="src"><a name="v:runLlvmOpt" class="def">runLlvmOpt</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> [<a href="SysTools.html#t:Option">Option</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p><div class="doc"><p>Run the LLVM Optimiser
</p></div></div><div class="top"><p class="src"><a name="v:runLlvmLlc" class="def">runLlvmLlc</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> [<a href="SysTools.html#t:Option">Option</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p><div class="doc"><p>Run the LLVM Compiler
</p></div></div><div class="top"><p class="src"><a name="v:runClang" class="def">runClang</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> [<a href="SysTools.html#t:Option">Option</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p><div class="doc"><p>Run the clang compiler (used as an assembler for the LLVM
backend on OS X as LLVM doesn't support the OS X system
assembler)
</p></div></div><div class="top"><p class="src"><a name="v:figureLlvmVersion" class="def">figureLlvmVersion</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> (<a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="../base-4.5.1.0/Data-Int.html#t:Int">Int</a>)</p><div class="doc"><p>Figure out which version of LLVM we are running this session
</p></div></div><div class="top"><p class="src"><a name="v:readElfSection" class="def">readElfSection</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> (<a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a>)</p><div class="doc"><p>read the contents of the named section in an ELF object as a
String.
</p></div></div><div class="top"><p class="src"><a name="v:askCc" class="def">askCc</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> [<a href="SysTools.html#t:Option">Option</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></p></div><div class="top"><p class="src"><a name="v:touch" class="def">touch</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p></div><div class="top"><p class="src"><a name="v:copy" class="def">copy</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p></div><div class="top"><p class="src"><a name="v:copyWithHeader" class="def">copyWithHeader</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p></div><div class="top"><p class="src"><a name="v:setTmpDir" class="def">setTmpDir</a> :: <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> <a href="DynFlags.html#t:DynFlags">DynFlags</a></p></div><div class="top"><p class="src"><a name="v:newTempName" class="def">newTempName</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> <a href="Util.html#t:Suffix">Suffix</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a></p></div><div class="top"><p class="src"><a name="v:cleanTempDirs" class="def">cleanTempDirs</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p></div><div class="top"><p class="src"><a name="v:cleanTempFiles" class="def">cleanTempFiles</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p></div><div class="top"><p class="src"><a name="v:cleanTempFilesExcept" class="def">cleanTempFilesExcept</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> [<a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p></div><div class="top"><p class="src"><a name="v:addFilesToClean" class="def">addFilesToClean</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> [<a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Option" class="def">Option</a> </p><div class="doc"><p>When invoking external tools as part of the compilation pipeline, we
pass these a sequence of options on the command-line. Rather than
just using a list of Strings, we use a type that allows us to distinguish
between filepaths and 'other stuff'. The reason for this is that
this type gives us a handle on transforming filenames, and filenames only,
to whatever format they're expected to be on a particular platform.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:FileOption" class="def">FileOption</a> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Option" class="def">Option</a> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Option" class="caption collapser" onclick="toggleSection('i:Option')">Instances</p><div id="section.i:Option" class="show"><table><tr><td class="src"><a href="../base-4.5.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="SysTools.html#t:Option">Option</a></td><td class="doc empty"> </td></tr></table></div></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.11.0</p></div></body></html>
