Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 33ad064c4b642ed30353356a1d094330 > files > 99

ghc-haddock-devel-2.7.2-3.fc14.x86_64.rpm

<?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://www.cs.york.ac.uk/fp/darcs/hscolour/ -->
<title>src/Haddock/Interface.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-2"></a><span class='hs-comment'>-- |</span>
<a name="line-3"></a><span class='hs-comment'>-- Module      :  Haddock.Interface</span>
<a name="line-4"></a><span class='hs-comment'>-- Copyright   :  (c) Simon Marlow 2003-2006,</span>
<a name="line-5"></a><span class='hs-comment'>--                    David Waern  2006-2009</span>
<a name="line-6"></a><span class='hs-comment'>-- License     :  BSD-like</span>
<a name="line-7"></a><span class='hs-comment'>--</span>
<a name="line-8"></a><span class='hs-comment'>-- Maintainer  :  haddock@projects.haskell.org</span>
<a name="line-9"></a><span class='hs-comment'>-- Stability   :  experimental</span>
<a name="line-10"></a><span class='hs-comment'>-- Portability :  portable</span>
<a name="line-11"></a><span class='hs-comment'>--</span>
<a name="line-12"></a><span class='hs-comment'>-- Here we build the actual module interfaces. By interface we mean the</span>
<a name="line-13"></a><span class='hs-comment'>-- information that is used to render a Haddock page for a module. Parts of</span>
<a name="line-14"></a><span class='hs-comment'>-- this information are also stored in the .haddock files.</span>
<a name="line-15"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-16"></a>
<a name="line-17"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Haddock</span><span class='hs-varop'>.</span><span class='hs-conid'>Interface</span> <span class='hs-layout'>(</span>
<a name="line-18"></a>  <span class='hs-varid'>createInterfaces</span>
<a name="line-19"></a><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-20"></a>
<a name="line-21"></a>
<a name="line-22"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Haddock</span><span class='hs-varop'>.</span><span class='hs-conid'>Interface</span><span class='hs-varop'>.</span><span class='hs-conid'>Create</span>
<a name="line-23"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Haddock</span><span class='hs-varop'>.</span><span class='hs-conid'>Interface</span><span class='hs-varop'>.</span><span class='hs-conid'>AttachInstances</span>
<a name="line-24"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Haddock</span><span class='hs-varop'>.</span><span class='hs-conid'>Interface</span><span class='hs-varop'>.</span><span class='hs-conid'>Rename</span>
<a name="line-25"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Haddock</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span>
<a name="line-26"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Haddock</span><span class='hs-varop'>.</span><span class='hs-conid'>Options</span>
<a name="line-27"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Haddock</span><span class='hs-varop'>.</span><span class='hs-conid'>GhcUtils</span>
<a name="line-28"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Haddock</span><span class='hs-varop'>.</span><span class='hs-conid'>Utils</span>
<a name="line-29"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Haddock</span><span class='hs-varop'>.</span><span class='hs-conid'>InterfaceFile</span>
<a name="line-30"></a>
<a name="line-31"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Map</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>Map</span>
<a name="line-32"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>List</span>
<a name="line-33"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Maybe</span>
<a name="line-34"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span>
<a name="line-35"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Exception</span> <span class='hs-layout'>(</span> <span class='hs-varid'>evaluate</span> <span class='hs-layout'>)</span>
<a name="line-36"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Distribution</span><span class='hs-varop'>.</span><span class='hs-conid'>Verbosity</span>
<a name="line-37"></a>
<a name="line-38"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>GHC</span> <span class='hs-varid'>hiding</span> <span class='hs-layout'>(</span><span class='hs-varid'>verbosity</span><span class='hs-layout'>,</span> <span class='hs-varid'>flags</span><span class='hs-layout'>)</span>
<a name="line-39"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Digraph</span>
<a name="line-40"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>HscTypes</span>
<a name="line-41"></a>
<a name="line-42"></a>
<a name="line-43"></a><a name="createInterfaces"></a><span class='hs-comment'>-- | Create 'Interface' structures by typechecking the list of modules</span>
<a name="line-44"></a><span class='hs-comment'>-- using the GHC API and processing the resulting syntax trees.</span>
<a name="line-45"></a><span class='hs-definition'>createInterfaces</span>
<a name="line-46"></a>  <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Verbosity</span> <span class='hs-comment'>-- ^ Verbosity of logging to 'stdout'</span>
<a name="line-47"></a>  <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</span> <span class='hs-comment'>-- ^ A list of file or module names sorted by module topology</span>
<a name="line-48"></a>  <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Flag</span><span class='hs-keyglyph'>]</span> <span class='hs-comment'>-- ^ Command-line flags</span>
<a name="line-49"></a>  <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>InterfaceFile</span><span class='hs-keyglyph'>]</span> <span class='hs-comment'>-- ^ Interface files of package dependencies</span>
<a name="line-50"></a>  <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Ghc</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>[</span><span class='hs-conid'>Interface</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>,</span> <span class='hs-conid'>LinkEnv</span><span class='hs-layout'>)</span>
<a name="line-51"></a>  <span class='hs-comment'>-- ^ Resulting list of interfaces and renaming environment</span>
<a name="line-52"></a><span class='hs-definition'>createInterfaces</span> <span class='hs-varid'>verbosity</span> <span class='hs-varid'>modules</span> <span class='hs-varid'>flags</span> <span class='hs-varid'>extIfaces</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-53"></a>  <span class='hs-comment'>-- part 1, create interfaces</span>
<a name="line-54"></a>  <span class='hs-keyword'>let</span> <span class='hs-varid'>instIfaceMap</span> <span class='hs-keyglyph'>=</span>  <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>fromList</span> <span class='hs-keyglyph'>[</span> <span class='hs-layout'>(</span><span class='hs-varid'>instMod</span> <span class='hs-varid'>iface</span><span class='hs-layout'>,</span> <span class='hs-varid'>iface</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>ext</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>extIfaces</span>
<a name="line-55"></a>                                   <span class='hs-layout'>,</span> <span class='hs-varid'>iface</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>ifInstalledIfaces</span> <span class='hs-varid'>ext</span> <span class='hs-keyglyph'>]</span>
<a name="line-56"></a>  <span class='hs-varid'>out</span> <span class='hs-varid'>verbosity</span> <span class='hs-varid'>verbose</span> <span class='hs-str'>"Creating interfaces..."</span>
<a name="line-57"></a>  <span class='hs-varid'>interfaces</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>createInterfaces'</span> <span class='hs-varid'>verbosity</span> <span class='hs-varid'>modules</span> <span class='hs-varid'>flags</span> <span class='hs-varid'>instIfaceMap</span>
<a name="line-58"></a>
<a name="line-59"></a>  <span class='hs-comment'>-- part 2, build link environment</span>
<a name="line-60"></a>  <span class='hs-varid'>out</span> <span class='hs-varid'>verbosity</span> <span class='hs-varid'>verbose</span> <span class='hs-str'>"Building link environment..."</span>
<a name="line-61"></a>      <span class='hs-comment'>-- combine the link envs of the external packages into one</span>
<a name="line-62"></a>  <span class='hs-keyword'>let</span> <span class='hs-varid'>extLinks</span>  <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>unions</span> <span class='hs-layout'>(</span><span class='hs-varid'>map</span> <span class='hs-varid'>ifLinkEnv</span> <span class='hs-varid'>extIfaces</span><span class='hs-layout'>)</span>
<a name="line-63"></a>      <span class='hs-varid'>homeLinks</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>buildHomeLinks</span> <span class='hs-varid'>interfaces</span> <span class='hs-comment'>-- build the environment for the home</span>
<a name="line-64"></a>                                            <span class='hs-comment'>-- package</span>
<a name="line-65"></a>      <span class='hs-varid'>links</span>     <span class='hs-keyglyph'>=</span> <span class='hs-varid'>homeLinks</span> <span class='hs-varop'>`</span><span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>union</span><span class='hs-varop'>`</span> <span class='hs-varid'>extLinks</span>
<a name="line-66"></a>
<a name="line-67"></a>  <span class='hs-comment'>-- part 3, attach instances</span>
<a name="line-68"></a>  <span class='hs-varid'>out</span> <span class='hs-varid'>verbosity</span> <span class='hs-varid'>verbose</span> <span class='hs-str'>"Attaching instances..."</span>
<a name="line-69"></a>  <span class='hs-varid'>interfaces'</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>attachInstances</span> <span class='hs-varid'>interfaces</span> <span class='hs-varid'>instIfaceMap</span>
<a name="line-70"></a>
<a name="line-71"></a>  <span class='hs-comment'>-- part 4, rename interfaces</span>
<a name="line-72"></a>  <span class='hs-varid'>out</span> <span class='hs-varid'>verbosity</span> <span class='hs-varid'>verbose</span> <span class='hs-str'>"Renaming interfaces..."</span>
<a name="line-73"></a>  <span class='hs-keyword'>let</span> <span class='hs-varid'>warnings</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Flag_NoWarnings</span> <span class='hs-varop'>`notElem`</span> <span class='hs-varid'>flags</span>
<a name="line-74"></a>  <span class='hs-keyword'>let</span> <span class='hs-layout'>(</span><span class='hs-varid'>interfaces''</span><span class='hs-layout'>,</span> <span class='hs-varid'>msgs</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span>
<a name="line-75"></a>         <span class='hs-varid'>runWriter</span> <span class='hs-varop'>$</span> <span class='hs-varid'>mapM</span> <span class='hs-layout'>(</span><span class='hs-varid'>renameInterface</span> <span class='hs-varid'>links</span> <span class='hs-varid'>warnings</span><span class='hs-layout'>)</span> <span class='hs-varid'>interfaces'</span>
<a name="line-76"></a>  <span class='hs-varid'>liftIO</span> <span class='hs-varop'>$</span> <span class='hs-varid'>mapM_</span> <span class='hs-varid'>putStrLn</span> <span class='hs-varid'>msgs</span>
<a name="line-77"></a>
<a name="line-78"></a>  <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-varid'>interfaces''</span><span class='hs-layout'>,</span> <span class='hs-varid'>homeLinks</span><span class='hs-layout'>)</span>
<a name="line-79"></a>
<a name="line-80"></a>
<a name="line-81"></a><a name="createInterfaces'"></a><span class='hs-definition'>createInterfaces'</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Verbosity</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Flag</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>InstIfaceMap</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Ghc</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Interface</span><span class='hs-keyglyph'>]</span>
<a name="line-82"></a><span class='hs-definition'>createInterfaces'</span> <span class='hs-varid'>verbosity</span> <span class='hs-varid'>modules</span> <span class='hs-varid'>flags</span> <span class='hs-varid'>instIfaceMap</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-83"></a>  <span class='hs-varid'>targets</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>mapM</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>f</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>guessTarget</span> <span class='hs-varid'>f</span> <span class='hs-conid'>Nothing</span><span class='hs-layout'>)</span> <span class='hs-varid'>modules</span>
<a name="line-84"></a>  <span class='hs-varid'>setTargets</span> <span class='hs-varid'>targets</span>
<a name="line-85"></a>  <span class='hs-varid'>modgraph</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>depanal</span> <span class='hs-conid'>[]</span> <span class='hs-conid'>False</span>
<a name="line-86"></a>
<a name="line-87"></a>  <span class='hs-comment'>-- If template haskell is used by the package, we can not use</span>
<a name="line-88"></a>  <span class='hs-comment'>-- HscNothing as target since we might need to run code generated from</span>
<a name="line-89"></a>  <span class='hs-comment'>-- one or more of the modules during typechecking.</span>
<a name="line-90"></a>  <span class='hs-varid'>modgraph'</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-keyword'>if</span> <span class='hs-varid'>needsTemplateHaskell</span> <span class='hs-varid'>modgraph</span>
<a name="line-91"></a>       <span class='hs-keyword'>then</span> <span class='hs-keyword'>do</span>
<a name="line-92"></a>         <span class='hs-varid'>dflags</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>getSessionDynFlags</span>
<a name="line-93"></a>         <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>setSessionDynFlags</span> <span class='hs-varid'>dflags</span> <span class='hs-layout'>{</span> <span class='hs-varid'>hscTarget</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>defaultObjectTarget</span> <span class='hs-layout'>}</span>
<a name="line-94"></a>         <span class='hs-comment'>-- we need to set defaultObjectTarget on all the ModSummaries as well</span>
<a name="line-95"></a>         <span class='hs-keyword'>let</span> <span class='hs-varid'>addHscAsm</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>m</span> <span class='hs-layout'>{</span> <span class='hs-varid'>ms_hspp_opts</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>ms_hspp_opts</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span> <span class='hs-layout'>{</span> <span class='hs-varid'>hscTarget</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>defaultObjectTarget</span> <span class='hs-layout'>}</span> <span class='hs-layout'>}</span>
<a name="line-96"></a>         <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-varid'>map</span> <span class='hs-varid'>addHscAsm</span> <span class='hs-varid'>modgraph</span><span class='hs-layout'>)</span>
<a name="line-97"></a>       <span class='hs-keyword'>else</span> <span class='hs-varid'>return</span> <span class='hs-varid'>modgraph</span>
<a name="line-98"></a>
<a name="line-99"></a>  <span class='hs-keyword'>let</span> <span class='hs-varid'>orderedMods</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>flattenSCCs</span> <span class='hs-varop'>$</span> <span class='hs-varid'>topSortModuleGraph</span> <span class='hs-conid'>False</span> <span class='hs-varid'>modgraph'</span> <span class='hs-conid'>Nothing</span>
<a name="line-100"></a>  <span class='hs-layout'>(</span><span class='hs-varid'>ifaces</span><span class='hs-layout'>,</span> <span class='hs-keyword'>_</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>foldM</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-varid'>ifaces</span><span class='hs-layout'>,</span> <span class='hs-varid'>modMap</span><span class='hs-layout'>)</span> <span class='hs-varid'>modsum</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyword'>do</span>
<a name="line-101"></a>    <span class='hs-varid'>x</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>processModule</span> <span class='hs-varid'>verbosity</span> <span class='hs-varid'>modsum</span> <span class='hs-varid'>flags</span> <span class='hs-varid'>modMap</span> <span class='hs-varid'>instIfaceMap</span>
<a name="line-102"></a>    <span class='hs-keyword'>case</span> <span class='hs-varid'>x</span> <span class='hs-keyword'>of</span>
<a name="line-103"></a>      <span class='hs-conid'>Just</span> <span class='hs-varid'>interface</span> <span class='hs-keyglyph'>-&gt;</span>
<a name="line-104"></a>        <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-layout'>(</span><span class='hs-varid'>interface</span> <span class='hs-conop'>:</span> <span class='hs-varid'>ifaces</span> <span class='hs-layout'>,</span> <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>insert</span> <span class='hs-layout'>(</span><span class='hs-varid'>ifaceMod</span> <span class='hs-varid'>interface</span><span class='hs-layout'>)</span> <span class='hs-varid'>interface</span> <span class='hs-varid'>modMap</span><span class='hs-layout'>)</span>
<a name="line-105"></a>      <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-varid'>ifaces</span><span class='hs-layout'>,</span> <span class='hs-varid'>modMap</span><span class='hs-layout'>)</span>
<a name="line-106"></a>    <span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>[]</span><span class='hs-layout'>,</span> <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>empty</span><span class='hs-layout'>)</span> <span class='hs-varid'>orderedMods</span>
<a name="line-107"></a>  <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-varid'>reverse</span> <span class='hs-varid'>ifaces</span><span class='hs-layout'>)</span>
<a name="line-108"></a>
<a name="line-109"></a>
<a name="line-110"></a><a name="processModule"></a><span class='hs-definition'>processModule</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Verbosity</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>ModSummary</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Flag</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>ModuleMap</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>InstIfaceMap</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Ghc</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-conid'>Interface</span><span class='hs-layout'>)</span>
<a name="line-111"></a><span class='hs-definition'>processModule</span> <span class='hs-varid'>verbosity</span> <span class='hs-varid'>modsum</span> <span class='hs-varid'>flags</span> <span class='hs-varid'>modMap</span> <span class='hs-varid'>instIfaceMap</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-112"></a>  <span class='hs-varid'>out</span> <span class='hs-varid'>verbosity</span> <span class='hs-varid'>verbose</span> <span class='hs-varop'>$</span> <span class='hs-str'>"Checking module "</span> <span class='hs-varop'>++</span> <span class='hs-varid'>moduleString</span> <span class='hs-layout'>(</span><span class='hs-varid'>ms_mod</span> <span class='hs-varid'>modsum</span><span class='hs-layout'>)</span> <span class='hs-varop'>++</span> <span class='hs-str'>"..."</span>
<a name="line-113"></a>  <span class='hs-varid'>tc_mod</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>loadModule</span> <span class='hs-varop'>=&lt;&lt;</span> <span class='hs-varid'>typecheckModule</span> <span class='hs-varop'>=&lt;&lt;</span> <span class='hs-varid'>parseModule</span> <span class='hs-varid'>modsum</span>
<a name="line-114"></a>  <span class='hs-keyword'>if</span> <span class='hs-varid'>not</span> <span class='hs-varop'>$</span> <span class='hs-varid'>isBootSummary</span> <span class='hs-varid'>modsum</span>
<a name="line-115"></a>    <span class='hs-keyword'>then</span> <span class='hs-keyword'>do</span>
<a name="line-116"></a>      <span class='hs-keyword'>let</span> <span class='hs-varid'>filename</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>msHsFilePath</span> <span class='hs-varid'>modsum</span>
<a name="line-117"></a>      <span class='hs-keyword'>let</span> <span class='hs-varid'>dynflags</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ms_hspp_opts</span> <span class='hs-varid'>modsum</span>
<a name="line-118"></a>      <span class='hs-keyword'>let</span> <span class='hs-conid'>Just</span> <span class='hs-varid'>renamed_src</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>renamedSource</span> <span class='hs-varid'>tc_mod</span>
<a name="line-119"></a>      <span class='hs-keyword'>let</span> <span class='hs-varid'>ghcMod</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mkGhcModule</span> <span class='hs-layout'>(</span><span class='hs-varid'>ms_mod</span> <span class='hs-varid'>modsum</span><span class='hs-layout'>,</span>
<a name="line-120"></a>                            <span class='hs-varid'>filename</span><span class='hs-layout'>,</span>
<a name="line-121"></a>                            <span class='hs-layout'>(</span><span class='hs-varid'>parsedSource</span> <span class='hs-varid'>tc_mod</span><span class='hs-layout'>,</span>
<a name="line-122"></a>                             <span class='hs-varid'>renamed_src</span><span class='hs-layout'>,</span>
<a name="line-123"></a>                             <span class='hs-varid'>typecheckedSource</span> <span class='hs-varid'>tc_mod</span><span class='hs-layout'>,</span>
<a name="line-124"></a>                             <span class='hs-varid'>moduleInfo</span> <span class='hs-varid'>tc_mod</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-125"></a>                            <span class='hs-varid'>dynflags</span>
<a name="line-126"></a>      <span class='hs-varid'>out</span> <span class='hs-varid'>verbosity</span> <span class='hs-varid'>verbose</span> <span class='hs-str'>"Creating interface..."</span>
<a name="line-127"></a>      <span class='hs-layout'>(</span><span class='hs-varid'>interface</span><span class='hs-layout'>,</span> <span class='hs-varid'>msg</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>runWriterGhc</span> <span class='hs-varop'>$</span> <span class='hs-varid'>createInterface</span> <span class='hs-varid'>ghcMod</span> <span class='hs-varid'>flags</span> <span class='hs-varid'>modMap</span> <span class='hs-varid'>instIfaceMap</span>
<a name="line-128"></a>      <span class='hs-varid'>liftIO</span> <span class='hs-varop'>$</span> <span class='hs-varid'>mapM_</span> <span class='hs-varid'>putStrLn</span> <span class='hs-varid'>msg</span>
<a name="line-129"></a>      <span class='hs-varid'>interface'</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>liftIO</span> <span class='hs-varop'>$</span> <span class='hs-varid'>evaluate</span> <span class='hs-varid'>interface</span>
<a name="line-130"></a>      <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-conid'>Just</span> <span class='hs-varid'>interface'</span><span class='hs-layout'>)</span>
<a name="line-131"></a>    <span class='hs-keyword'>else</span>
<a name="line-132"></a>      <span class='hs-varid'>return</span> <span class='hs-conid'>Nothing</span>
<a name="line-133"></a>
<a name="line-134"></a>
<a name="line-135"></a><a name="CheckedMod"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>CheckedMod</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-conid'>Module</span><span class='hs-layout'>,</span> <span class='hs-conid'>FilePath</span><span class='hs-layout'>,</span> <span class='hs-conid'>FullyCheckedMod</span><span class='hs-layout'>)</span>
<a name="line-136"></a>
<a name="line-137"></a>
<a name="line-138"></a><a name="FullyCheckedMod"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>FullyCheckedMod</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-conid'>ParsedSource</span><span class='hs-layout'>,</span>
<a name="line-139"></a>                        <span class='hs-conid'>RenamedSource</span><span class='hs-layout'>,</span>
<a name="line-140"></a>                        <span class='hs-conid'>TypecheckedSource</span><span class='hs-layout'>,</span>
<a name="line-141"></a>                        <span class='hs-conid'>ModuleInfo</span><span class='hs-layout'>)</span>
<a name="line-142"></a>
<a name="line-143"></a>
<a name="line-144"></a><a name="mkGhcModule"></a><span class='hs-comment'>-- | Dig out what we want from the typechecker output</span>
<a name="line-145"></a><span class='hs-definition'>mkGhcModule</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>CheckedMod</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>DynFlags</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>GhcModule</span>
<a name="line-146"></a><span class='hs-definition'>mkGhcModule</span> <span class='hs-layout'>(</span><span class='hs-varid'>mdl</span><span class='hs-layout'>,</span> <span class='hs-varid'>file</span><span class='hs-layout'>,</span> <span class='hs-varid'>checkedMod</span><span class='hs-layout'>)</span> <span class='hs-varid'>dynflags</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>GhcModule</span> <span class='hs-layout'>{</span>
<a name="line-147"></a>  <span class='hs-varid'>ghcModule</span>         <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mdl</span><span class='hs-layout'>,</span>
<a name="line-148"></a>  <span class='hs-varid'>ghcFilename</span>       <span class='hs-keyglyph'>=</span> <span class='hs-varid'>file</span><span class='hs-layout'>,</span>
<a name="line-149"></a>  <span class='hs-varid'>ghcMbDocOpts</span>      <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mbOpts</span><span class='hs-layout'>,</span>
<a name="line-150"></a>  <span class='hs-varid'>ghcMbDocHdr</span>       <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mbDocHdr</span><span class='hs-layout'>,</span>
<a name="line-151"></a>  <span class='hs-varid'>ghcGroup</span>          <span class='hs-keyglyph'>=</span> <span class='hs-varid'>group_</span><span class='hs-layout'>,</span>
<a name="line-152"></a>  <span class='hs-varid'>ghcMbExports</span>      <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mbExports</span><span class='hs-layout'>,</span>
<a name="line-153"></a>  <span class='hs-varid'>ghcExportedNames</span>  <span class='hs-keyglyph'>=</span> <span class='hs-varid'>modInfoExports</span> <span class='hs-varid'>modInfo</span><span class='hs-layout'>,</span>
<a name="line-154"></a>  <span class='hs-varid'>ghcDefinedNames</span>   <span class='hs-keyglyph'>=</span> <span class='hs-varid'>map</span> <span class='hs-varid'>getName</span> <span class='hs-varop'>$</span> <span class='hs-varid'>modInfoTyThings</span> <span class='hs-varid'>modInfo</span><span class='hs-layout'>,</span>
<a name="line-155"></a>  <span class='hs-varid'>ghcNamesInScope</span>   <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fromJust</span> <span class='hs-varop'>$</span> <span class='hs-varid'>modInfoTopLevelScope</span> <span class='hs-varid'>modInfo</span><span class='hs-layout'>,</span>
<a name="line-156"></a>  <span class='hs-varid'>ghcInstances</span>      <span class='hs-keyglyph'>=</span> <span class='hs-varid'>modInfoInstances</span> <span class='hs-varid'>modInfo</span>
<a name="line-157"></a><span class='hs-layout'>}</span>
<a name="line-158"></a>  <span class='hs-keyword'>where</span>
<a name="line-159"></a>    <span class='hs-varid'>mbOpts</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>haddockOptions</span> <span class='hs-varid'>dynflags</span>
<a name="line-160"></a>    <span class='hs-layout'>(</span><span class='hs-varid'>group_</span><span class='hs-layout'>,</span> <span class='hs-keyword'>_</span><span class='hs-layout'>,</span> <span class='hs-varid'>mbExports</span><span class='hs-layout'>,</span> <span class='hs-varid'>mbDocHdr</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>renamed</span>
<a name="line-161"></a>    <span class='hs-layout'>(</span><span class='hs-keyword'>_</span><span class='hs-layout'>,</span> <span class='hs-varid'>renamed</span><span class='hs-layout'>,</span> <span class='hs-keyword'>_</span><span class='hs-layout'>,</span> <span class='hs-varid'>modInfo</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>checkedMod</span>
<a name="line-162"></a>
<a name="line-163"></a>
<a name="line-164"></a><a name="buildHomeLinks"></a><span class='hs-comment'>-- | Build a mapping which for each original name, points to the "best"</span>
<a name="line-165"></a><span class='hs-comment'>-- place to link to in the documentation.  For the definition of</span>
<a name="line-166"></a><span class='hs-comment'>-- "best", we use "the module nearest the bottom of the dependency</span>
<a name="line-167"></a><span class='hs-comment'>-- graph which exports this name", not including hidden modules.  When</span>
<a name="line-168"></a><span class='hs-comment'>-- there are multiple choices, we pick a random one.</span>
<a name="line-169"></a><span class='hs-comment'>--</span>
<a name="line-170"></a><span class='hs-comment'>-- The interfaces are passed in in topologically sorted order, but we start</span>
<a name="line-171"></a><span class='hs-comment'>-- by reversing the list so we can do a foldl.</span>
<a name="line-172"></a><span class='hs-definition'>buildHomeLinks</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Interface</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>LinkEnv</span>
<a name="line-173"></a><span class='hs-definition'>buildHomeLinks</span> <span class='hs-varid'>ifaces</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>foldl</span> <span class='hs-varid'>upd</span> <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>empty</span> <span class='hs-layout'>(</span><span class='hs-varid'>reverse</span> <span class='hs-varid'>ifaces</span><span class='hs-layout'>)</span>
<a name="line-174"></a>  <span class='hs-keyword'>where</span>
<a name="line-175"></a>    <span class='hs-varid'>upd</span> <span class='hs-varid'>old_env</span> <span class='hs-varid'>iface</span>
<a name="line-176"></a>      <span class='hs-keyglyph'>|</span> <span class='hs-conid'>OptHide</span>    <span class='hs-varop'>`elem`</span> <span class='hs-varid'>ifaceOptions</span> <span class='hs-varid'>iface</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>old_env</span>
<a name="line-177"></a>      <span class='hs-keyglyph'>|</span> <span class='hs-conid'>OptNotHome</span> <span class='hs-varop'>`elem`</span> <span class='hs-varid'>ifaceOptions</span> <span class='hs-varid'>iface</span> <span class='hs-keyglyph'>=</span>
<a name="line-178"></a>        <span class='hs-varid'>foldl'</span> <span class='hs-varid'>keep_old</span> <span class='hs-varid'>old_env</span> <span class='hs-varid'>exported_names</span>
<a name="line-179"></a>      <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>foldl'</span> <span class='hs-varid'>keep_new</span> <span class='hs-varid'>old_env</span> <span class='hs-varid'>exported_names</span>
<a name="line-180"></a>      <span class='hs-keyword'>where</span>
<a name="line-181"></a>        <span class='hs-varid'>exported_names</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ifaceVisibleExports</span> <span class='hs-varid'>iface</span>
<a name="line-182"></a>        <span class='hs-varid'>mdl</span>            <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ifaceMod</span> <span class='hs-varid'>iface</span>
<a name="line-183"></a>        <span class='hs-varid'>keep_old</span> <span class='hs-varid'>env</span> <span class='hs-varid'>n</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>insertWith</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-keyword'>_</span> <span class='hs-varid'>old</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>old</span><span class='hs-layout'>)</span> <span class='hs-varid'>n</span> <span class='hs-varid'>mdl</span> <span class='hs-varid'>env</span>
<a name="line-184"></a>        <span class='hs-varid'>keep_new</span> <span class='hs-varid'>env</span> <span class='hs-varid'>n</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>insert</span> <span class='hs-varid'>n</span> <span class='hs-varid'>mdl</span> <span class='hs-varid'>env</span>
</pre></body>
</html>