/usr/share/doc/libghc-language-c-doc/html/Language-C-System-Preprocess.html is in libghc-language-c-doc 0.4.2-4build1.
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 | <!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>Language.C.System.Preprocess</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_Language-C-System-Preprocess.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Language-C-System-Preprocess.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">language-c-0.4.2: Analysis and generation of C code</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>portable</td></tr><tr><th>Stability</th><td>experimental</td></tr><tr><th>Maintainer</th><td>benedikt.huber@gmail.com</td></tr><tr><th>Safe Haskell</th><td>None</td></tr></table><p class="caption">Language.C.System.Preprocess</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Invoking external preprocessors.
</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">class</span> <a href="#t:Preprocessor">Preprocessor</a> cpp <span class="keyword">where</span><ul class="subs"><li><a href="#v:parseCPPArgs">parseCPPArgs</a> :: cpp -> [<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-Either.html#t:Either">Either</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> (<a href="Language-C-System-Preprocess.html#t:CppArgs">CppArgs</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:runCPP">runCPP</a> :: cpp -> <a href="Language-C-System-Preprocess.html#t:CppArgs">CppArgs</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></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:CppOption">CppOption</a> <ul class="subs"><li>= <a href="#v:IncludeDir">IncludeDir</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:FilePath">FilePath</a> </li><li>| <a href="#v:Define">Define</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>| <a href="#v:Undefine">Undefine</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:IncludeFile">IncludeFile</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:FilePath">FilePath</a> </li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:CppArgs">CppArgs</a> = <a href="#v:CppArgs">CppArgs</a> {<ul class="subs"><li><a href="#v:cppOptions">cppOptions</a> :: [<a href="Language-C-System-Preprocess.html#t:CppOption">CppOption</a>]</li><li><a href="#v:extraOptions">extraOptions</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:cppTmpDir">cppTmpDir</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></li><li><a href="#v:inputFile">inputFile</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:FilePath">FilePath</a></li><li><a href="#v:outputFile">outputFile</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></li></ul>}</li><li class="src short"><a href="#v:rawCppArgs">rawCppArgs</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:FilePath">FilePath</a> -> <a href="Language-C-System-Preprocess.html#t:CppArgs">CppArgs</a></li><li class="src short"><a href="#v:addCppOption">addCppOption</a> :: <a href="Language-C-System-Preprocess.html#t:CppArgs">CppArgs</a> -> <a href="Language-C-System-Preprocess.html#t:CppOption">CppOption</a> -> <a href="Language-C-System-Preprocess.html#t:CppArgs">CppArgs</a></li><li class="src short"><a href="#v:addExtraOption">addExtraOption</a> :: <a href="Language-C-System-Preprocess.html#t:CppArgs">CppArgs</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> -> <a href="Language-C-System-Preprocess.html#t:CppArgs">CppArgs</a></li><li class="src short"><a href="#v:runPreprocessor">runPreprocessor</a> :: <a href="Language-C-System-Preprocess.html#t:Preprocessor">Preprocessor</a> cpp => cpp -> <a href="Language-C-System-Preprocess.html#t:CppArgs">CppArgs</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-Either.html#t:Either">Either</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-Exit.html#t:ExitCode">ExitCode</a> <a href="Language-C-Data-InputStream.html#t:InputStream">InputStream</a>)</li><li class="src short"><a href="#v:isPreprocessed">isPreprocessed</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-Bool.html#t:Bool">Bool</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">class</span> <a name="t:Preprocessor" class="def">Preprocessor</a> cpp <span class="keyword">where</span><a href="src/Language-C-System-Preprocess.html#Preprocessor" class="link">Source</a></p><div class="doc"><p><code><a href="Language-C-System-Preprocess.html#t:Preprocessor">Preprocessor</a></code> encapsulates the abstract interface for invoking C preprocessors
</p></div><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:parseCPPArgs" class="def">parseCPPArgs</a> :: cpp -> [<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-Either.html#t:Either">Either</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> (<a href="Language-C-System-Preprocess.html#t:CppArgs">CppArgs</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/Language-C-System-Preprocess.html#parseCPPArgs" class="link">Source</a></p><div class="doc"><p>parse the given command line arguments, and return a pair of parsed and ignored arguments
</p></div><p class="src"><a name="v:runCPP" class="def">runCPP</a> :: cpp -> <a href="Language-C-System-Preprocess.html#t:CppArgs">CppArgs</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><a href="src/Language-C-System-Preprocess.html#runCPP" class="link">Source</a></p><div class="doc"><p>run the preprocessor
</p></div></div><div class="subs instances"><p id="control.i:Preprocessor" class="caption collapser" onclick="toggleSection('i:Preprocessor')">Instances</p><div id="section.i:Preprocessor" class="show"><table><tr><td class="src"><a href="Language-C-System-Preprocess.html#t:Preprocessor">Preprocessor</a> <a href="Language-C-System-GCC.html#t:GCC">GCC</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:CppOption" class="def">CppOption</a> <a href="src/Language-C-System-Preprocess.html#CppOption" class="link">Source</a></p><div class="doc"><p>Generic Options for the preprocessor
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:IncludeDir" class="def">IncludeDir</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 empty"> </td></tr><tr><td class="src"><a name="v:Define" class="def">Define</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 empty"> </td></tr><tr><td class="src"><a name="v:Undefine" class="def">Undefine</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:IncludeFile" class="def">IncludeFile</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 empty"> </td></tr></table></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:CppArgs" class="def">CppArgs</a> <a href="src/Language-C-System-Preprocess.html#CppArgs" class="link">Source</a></p><div class="doc"><p>Generic arguments for the preprocessor
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:CppArgs" class="def">CppArgs</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:cppOptions" class="def">cppOptions</a> :: [<a href="Language-C-System-Preprocess.html#t:CppOption">CppOption</a>]</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:extraOptions" class="def">extraOptions</a> :: [<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a>]</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:cppTmpDir" class="def">cppTmpDir</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></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:inputFile" class="def">inputFile</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:FilePath">FilePath</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:outputFile" class="def">outputFile</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></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:rawCppArgs" class="def">rawCppArgs</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:FilePath">FilePath</a> -> <a href="Language-C-System-Preprocess.html#t:CppArgs">CppArgs</a><a href="src/Language-C-System-Preprocess.html#rawCppArgs" class="link">Source</a></p><div class="doc"><p>use the given preprocessor arguments without analyzing them
</p></div></div><div class="top"><p class="src"><a name="v:addCppOption" class="def">addCppOption</a> :: <a href="Language-C-System-Preprocess.html#t:CppArgs">CppArgs</a> -> <a href="Language-C-System-Preprocess.html#t:CppOption">CppOption</a> -> <a href="Language-C-System-Preprocess.html#t:CppArgs">CppArgs</a><a href="src/Language-C-System-Preprocess.html#addCppOption" class="link">Source</a></p><div class="doc"><p>add a typed option to the given preprocessor arguments
</p></div></div><div class="top"><p class="src"><a name="v:addExtraOption" class="def">addExtraOption</a> :: <a href="Language-C-System-Preprocess.html#t:CppArgs">CppArgs</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> -> <a href="Language-C-System-Preprocess.html#t:CppArgs">CppArgs</a><a href="src/Language-C-System-Preprocess.html#addExtraOption" class="link">Source</a></p><div class="doc"><p>add a string option to the given preprocessor arguments
</p></div></div><div class="top"><p class="src"><a name="v:runPreprocessor" class="def">runPreprocessor</a> :: <a href="Language-C-System-Preprocess.html#t:Preprocessor">Preprocessor</a> cpp => cpp -> <a href="Language-C-System-Preprocess.html#t:CppArgs">CppArgs</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-Either.html#t:Either">Either</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-Exit.html#t:ExitCode">ExitCode</a> <a href="Language-C-Data-InputStream.html#t:InputStream">InputStream</a>)<a href="src/Language-C-System-Preprocess.html#runPreprocessor" class="link">Source</a></p><div class="doc"><p>run the preprocessor and return an <code><a href="Language-C-Data-InputStream.html#t:InputStream">InputStream</a></code> if preprocesssing succeeded
</p></div></div><div class="top"><p class="src"><a name="v:isPreprocessed" class="def">isPreprocessed</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-Bool.html#t:Bool">Bool</a><a href="src/Language-C-System-Preprocess.html#isPreprocessed" class="link">Source</a></p><div class="doc"><p>guess whether a file is preprocessed (file end with .i)
</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>
|