Distribution-Simple-Build-Macros.html

<!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>Distribution.Simple.Build.Macros</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><link rel="stylesheet" type="text/css" href="quick-jump.css" /><script src="haddock-bundle.min.js" async="async" type="text/javascript"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></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">Cabal-2.4.0.1: A framework for packaging Haskell software</p></div><div id="content"><div id="module-header"><table class="info"><tr><th valign="top">Copyright</th><td>Simon Marlow 2008</td></tr><tr><th>Maintainer</th><td>cabal-devel@haskell.org</td></tr><tr><th>Portability</th><td>portable</td></tr><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Distribution.Simple.Build.Macros</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Generate cabal_macros.h - CPP macros for package version testing</p><p>When using CPP you get</p><pre>VERSION_&lt;package&gt;
MIN_VERSION_&lt;package&gt;(A,B,C)</pre><p>for each <em>package</em> in <code>build-depends</code>, which is true if the version of
 <em>package</em> in use is <code>&gt;= A.B.C</code>, using the normal ordering on version
 numbers.</p><p>TODO Figure out what to do about backpack and internal libraries. It is very
 suspecious that this stuff works with munged package identifiers</p></div></div><div id="synopsis"><details id="syn"><summary>Synopsis</summary><ul class="details-toggle" data-details-id="syn"><li class="src short"><a href="#v:generate">generate</a> :: <a href="Distribution-Types-PackageDescription.html#t:PackageDescription" title="Distribution.Types.PackageDescription">PackageDescription</a> -&gt; <a href="Distribution-Types-LocalBuildInfo.html#t:LocalBuildInfo" title="Distribution.Types.LocalBuildInfo">LocalBuildInfo</a> -&gt; <a href="Distribution-Types-ComponentLocalBuildInfo.html#t:ComponentLocalBuildInfo" title="Distribution.Types.ComponentLocalBuildInfo">ComponentLocalBuildInfo</a> -&gt; <a href="Distribution-Compat-Prelude-Internal.html#t:String" title="Distribution.Compat.Prelude.Internal">String</a></li><li class="src short"><a href="#v:generatePackageVersionMacros">generatePackageVersionMacros</a> :: [<a href="Distribution-Types-PackageId.html#t:PackageId" title="Distribution.Types.PackageId">PackageId</a>] -&gt; <a href="Distribution-Compat-Prelude-Internal.html#t:String" title="Distribution.Compat.Prelude.Internal">String</a></li></ul></details></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a id="v:generate" class="def">generate</a> :: <a href="Distribution-Types-PackageDescription.html#t:PackageDescription" title="Distribution.Types.PackageDescription">PackageDescription</a> -&gt; <a href="Distribution-Types-LocalBuildInfo.html#t:LocalBuildInfo" title="Distribution.Types.LocalBuildInfo">LocalBuildInfo</a> -&gt; <a href="Distribution-Types-ComponentLocalBuildInfo.html#t:ComponentLocalBuildInfo" title="Distribution.Types.ComponentLocalBuildInfo">ComponentLocalBuildInfo</a> -&gt; <a href="Distribution-Compat-Prelude-Internal.html#t:String" title="Distribution.Compat.Prelude.Internal">String</a> <a href="#v:generate" class="selflink">#</a></p><div class="doc"><p>The contents of the <code>cabal_macros.h</code> for the given configured package.</p></div></div><div class="top"><p class="src"><a id="v:generatePackageVersionMacros" class="def">generatePackageVersionMacros</a> :: [<a href="Distribution-Types-PackageId.html#t:PackageId" title="Distribution.Types.PackageId">PackageId</a>] -&gt; <a href="Distribution-Compat-Prelude-Internal.html#t:String" title="Distribution.Compat.Prelude.Internal">String</a> <a href="#v:generatePackageVersionMacros" class="selflink">#</a></p><div class="doc"><p>Helper function that generates just the <code>VERSION_pkg</code> and <code>MIN_VERSION_pkg</code>
 macros for a list of package ids (usually used with the specific deps of
 a configured package).</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.20.0</p></div></body></html>