Sophie

Sophie

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

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/Create.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.Create</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>
<a name="line-13"></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-varop'>.</span><span class='hs-conid'>Create</span> <span class='hs-layout'>(</span><span class='hs-varid'>createInterface</span><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-14"></a>
<a name="line-15"></a>
<a name="line-16"></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-17"></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-18"></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-19"></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-20"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Haddock</span><span class='hs-varop'>.</span><span class='hs-conid'>Convert</span>
<a name="line-21"></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'>LexParseRn</span>
<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'>ExtractFnArgDocs</span>
<a name="line-23"></a>
<a name="line-24"></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-25"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Map</span> <span class='hs-layout'>(</span><span class='hs-conid'>Map</span><span class='hs-layout'>)</span>
<a name="line-26"></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-27"></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-28"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Ord</span>
<a name="line-29"></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-30"></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'>Traversable</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>Traversable</span>
<a name="line-31"></a>
<a name="line-32"></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'>flags</span><span class='hs-layout'>)</span>
<a name="line-33"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Name</span>
<a name="line-34"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Bag</span>
<a name="line-35"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>RdrName</span> <span class='hs-layout'>(</span><span class='hs-conid'>GlobalRdrEnv</span><span class='hs-layout'>)</span>
<a name="line-36"></a>
<a name="line-37"></a>
<a name="line-38"></a><a name="createInterface"></a><span class='hs-comment'>-- | Process the data in the GhcModule to produce an interface.</span>
<a name="line-39"></a><span class='hs-comment'>-- To do this, we need access to already processed modules in the topological</span>
<a name="line-40"></a><span class='hs-comment'>-- sort. That's what's in the module map.</span>
<a name="line-41"></a><span class='hs-definition'>createInterface</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>GhcModule</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>
<a name="line-42"></a>                <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>ErrMsgGhc</span> <span class='hs-conid'>Interface</span>
<a name="line-43"></a><span class='hs-definition'>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> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-44"></a>
<a name="line-45"></a>  <span class='hs-keyword'>let</span> <span class='hs-varid'>mdl</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ghcModule</span> <span class='hs-varid'>ghcMod</span>
<a name="line-46"></a>
<a name="line-47"></a>  <span class='hs-comment'>-- The pattern-match should not fail, because createInterface is only</span>
<a name="line-48"></a>  <span class='hs-comment'>-- done on loaded modules.</span>
<a name="line-49"></a>  <span class='hs-conid'>Just</span> <span class='hs-varid'>gre</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>liftGhcToErrMsgGhc</span> <span class='hs-varop'>$</span> <span class='hs-varid'>lookupLoadedHomeModuleGRE</span> <span class='hs-layout'>(</span><span class='hs-varid'>moduleName</span> <span class='hs-varid'>mdl</span><span class='hs-layout'>)</span>
<a name="line-50"></a>
<a name="line-51"></a>  <span class='hs-varid'>opts0</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>liftErrMsg</span> <span class='hs-varop'>$</span> <span class='hs-varid'>mkDocOpts</span> <span class='hs-layout'>(</span><span class='hs-varid'>ghcMbDocOpts</span> <span class='hs-varid'>ghcMod</span><span class='hs-layout'>)</span> <span class='hs-varid'>flags</span> <span class='hs-varid'>mdl</span>
<a name="line-52"></a>  <span class='hs-keyword'>let</span> <span class='hs-varid'>opts</span>
<a name="line-53"></a>        <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_IgnoreAllExports</span> <span class='hs-varop'>`elem`</span> <span class='hs-varid'>flags</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>OptIgnoreExports</span> <span class='hs-conop'>:</span> <span class='hs-varid'>opts0</span>
<a name="line-54"></a>        <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>opts0</span>
<a name="line-55"></a>
<a name="line-56"></a>  <span class='hs-layout'>(</span><span class='hs-varid'>info</span><span class='hs-layout'>,</span> <span class='hs-varid'>mbDoc</span><span class='hs-layout'>)</span>    <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>liftErrMsg</span> <span class='hs-varop'>$</span> <span class='hs-varid'>lexParseRnHaddockModHeader</span>
<a name="line-57"></a>                                       <span class='hs-varid'>gre</span> <span class='hs-layout'>(</span><span class='hs-varid'>ghcMbDocHdr</span> <span class='hs-varid'>ghcMod</span><span class='hs-layout'>)</span>
<a name="line-58"></a>  <span class='hs-varid'>decls0</span>           <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>liftErrMsg</span> <span class='hs-varop'>$</span> <span class='hs-varid'>declInfos</span> <span class='hs-varid'>gre</span> <span class='hs-layout'>(</span><span class='hs-varid'>topDecls</span> <span class='hs-layout'>(</span><span class='hs-varid'>ghcGroup</span> <span class='hs-varid'>ghcMod</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-59"></a>
<a name="line-60"></a>  <span class='hs-keyword'>let</span> <span class='hs-varid'>instances</span>      <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ghcInstances</span> <span class='hs-varid'>ghcMod</span>
<a name="line-61"></a>      <span class='hs-varid'>localInsts</span>     <span class='hs-keyglyph'>=</span> <span class='hs-varid'>filter</span> <span class='hs-layout'>(</span><span class='hs-varid'>nameIsLocalOrFrom</span> <span class='hs-varid'>mdl</span> <span class='hs-varop'>.</span> <span class='hs-varid'>getName</span><span class='hs-layout'>)</span> <span class='hs-varid'>instances</span>
<a name="line-62"></a>      <span class='hs-varid'>declDocs</span>       <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>[</span> <span class='hs-layout'>(</span><span class='hs-varid'>decl</span><span class='hs-layout'>,</span> <span class='hs-varid'>doc</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>|</span> <span class='hs-layout'>(</span><span class='hs-conid'>L</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>decl</span><span class='hs-layout'>,</span> <span class='hs-layout'>(</span><span class='hs-conid'>Just</span> <span class='hs-varid'>doc</span><span class='hs-layout'>,</span> <span class='hs-keyword'>_</span><span class='hs-layout'>)</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'>decls0</span> <span class='hs-keyglyph'>]</span>
<a name="line-63"></a>      <span class='hs-varid'>instanceDocMap</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mkInstanceDocMap</span> <span class='hs-varid'>localInsts</span> <span class='hs-varid'>declDocs</span>
<a name="line-64"></a>
<a name="line-65"></a>      <span class='hs-varid'>decls</span>         <span class='hs-keyglyph'>=</span> <span class='hs-varid'>filterOutInstances</span> <span class='hs-varid'>decls0</span>
<a name="line-66"></a>      <span class='hs-varid'>declMap</span>       <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mkDeclMap</span> <span class='hs-varid'>decls</span>
<a name="line-67"></a>      <span class='hs-varid'>exports</span>       <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fmap</span> <span class='hs-layout'>(</span><span class='hs-varid'>reverse</span> <span class='hs-varop'>.</span> <span class='hs-varid'>map</span> <span class='hs-varid'>unLoc</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>ghcMbExports</span> <span class='hs-varid'>ghcMod</span><span class='hs-layout'>)</span>
<a name="line-68"></a>      <span class='hs-varid'>ignoreExps</span>    <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Flag_IgnoreAllExports</span> <span class='hs-varop'>`elem`</span> <span class='hs-varid'>flags</span>
<a name="line-69"></a>      <span class='hs-varid'>exportedNames</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ghcExportedNames</span> <span class='hs-varid'>ghcMod</span>
<a name="line-70"></a>
<a name="line-71"></a>  <span class='hs-varid'>liftErrMsg</span> <span class='hs-varop'>$</span> <span class='hs-varid'>warnAboutFilteredDecls</span> <span class='hs-varid'>mdl</span> <span class='hs-varid'>decls0</span>
<a name="line-72"></a>
<a name="line-73"></a>  <span class='hs-varid'>exportItems</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>mkExportItems</span> <span class='hs-varid'>modMap</span> <span class='hs-varid'>mdl</span> <span class='hs-varid'>gre</span> <span class='hs-layout'>(</span><span class='hs-varid'>ghcExportedNames</span> <span class='hs-varid'>ghcMod</span><span class='hs-layout'>)</span> <span class='hs-varid'>decls</span> <span class='hs-varid'>declMap</span>
<a name="line-74"></a>                               <span class='hs-varid'>opts</span> <span class='hs-varid'>exports</span> <span class='hs-varid'>ignoreExps</span> <span class='hs-varid'>instances</span> <span class='hs-varid'>instIfaceMap</span>
<a name="line-75"></a>
<a name="line-76"></a>  <span class='hs-keyword'>let</span> <span class='hs-varid'>visibleNames</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mkVisibleNames</span> <span class='hs-varid'>exportItems</span> <span class='hs-varid'>opts</span>
<a name="line-77"></a>
<a name="line-78"></a>  <span class='hs-comment'>-- prune the export list to just those declarations that have</span>
<a name="line-79"></a>  <span class='hs-comment'>-- documentation, if the 'prune' option is on.</span>
<a name="line-80"></a>  <span class='hs-keyword'>let</span>
<a name="line-81"></a>    <span class='hs-varid'>prunedExportItems</span>
<a name="line-82"></a>      <span class='hs-keyglyph'>|</span> <span class='hs-conid'>OptPrune</span> <span class='hs-varop'>`elem`</span> <span class='hs-varid'>opts</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>pruneExportItems</span> <span class='hs-varid'>exportItems</span>
<a name="line-83"></a>      <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>exportItems</span>
<a name="line-84"></a>
<a name="line-85"></a>  <span class='hs-varid'>return</span> <span class='hs-conid'>Interface</span> <span class='hs-layout'>{</span>
<a name="line-86"></a>    <span class='hs-varid'>ifaceMod</span>             <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mdl</span><span class='hs-layout'>,</span>
<a name="line-87"></a>    <span class='hs-varid'>ifaceOrigFilename</span>    <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ghcFilename</span> <span class='hs-varid'>ghcMod</span><span class='hs-layout'>,</span>
<a name="line-88"></a>    <span class='hs-varid'>ifaceInfo</span>            <span class='hs-keyglyph'>=</span> <span class='hs-varid'>info</span><span class='hs-layout'>,</span>
<a name="line-89"></a>    <span class='hs-varid'>ifaceDoc</span>             <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mbDoc</span><span class='hs-layout'>,</span>
<a name="line-90"></a>    <span class='hs-varid'>ifaceRnDoc</span>           <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Nothing</span><span class='hs-layout'>,</span>
<a name="line-91"></a>    <span class='hs-varid'>ifaceOptions</span>         <span class='hs-keyglyph'>=</span> <span class='hs-varid'>opts</span><span class='hs-layout'>,</span>
<a name="line-92"></a>    <span class='hs-varid'>ifaceRnDocMap</span>        <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>empty</span><span class='hs-layout'>,</span>
<a name="line-93"></a>    <span class='hs-varid'>ifaceExportItems</span>     <span class='hs-keyglyph'>=</span> <span class='hs-varid'>prunedExportItems</span><span class='hs-layout'>,</span>
<a name="line-94"></a>    <span class='hs-varid'>ifaceRnExportItems</span>   <span class='hs-keyglyph'>=</span> <span class='hs-conid'>[]</span><span class='hs-layout'>,</span>
<a name="line-95"></a>    <span class='hs-varid'>ifaceExports</span>         <span class='hs-keyglyph'>=</span> <span class='hs-varid'>exportedNames</span><span class='hs-layout'>,</span>
<a name="line-96"></a>    <span class='hs-varid'>ifaceVisibleExports</span>  <span class='hs-keyglyph'>=</span> <span class='hs-varid'>visibleNames</span><span class='hs-layout'>,</span>
<a name="line-97"></a>    <span class='hs-varid'>ifaceDeclMap</span>         <span class='hs-keyglyph'>=</span> <span class='hs-varid'>declMap</span><span class='hs-layout'>,</span>
<a name="line-98"></a>    <span class='hs-varid'>ifaceSubMap</span>          <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mkSubMap</span> <span class='hs-varid'>declMap</span> <span class='hs-varid'>exportedNames</span><span class='hs-layout'>,</span>
<a name="line-99"></a>    <span class='hs-varid'>ifaceInstances</span>       <span class='hs-keyglyph'>=</span> <span class='hs-varid'>instances</span><span class='hs-layout'>,</span>
<a name="line-100"></a>    <span class='hs-varid'>ifaceInstanceDocMap</span>  <span class='hs-keyglyph'>=</span> <span class='hs-varid'>instanceDocMap</span>
<a name="line-101"></a>  <span class='hs-layout'>}</span>
<a name="line-102"></a>
<a name="line-103"></a>
<a name="line-104"></a><span class='hs-comment'>-------------------------------------------------------------------------------</span>
<a name="line-105"></a><span class='hs-comment'>-- Doc options</span>
<a name="line-106"></a><span class='hs-comment'>--</span>
<a name="line-107"></a><span class='hs-comment'>-- Haddock options that are embedded in the source file</span>
<a name="line-108"></a><span class='hs-comment'>-------------------------------------------------------------------------------</span>
<a name="line-109"></a>
<a name="line-110"></a>
<a name="line-111"></a><a name="mkDocOpts"></a><span class='hs-definition'>mkDocOpts</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>String</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'>Module</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>ErrMsgM</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>DocOption</span><span class='hs-keyglyph'>]</span>
<a name="line-112"></a><span class='hs-definition'>mkDocOpts</span> <span class='hs-varid'>mbOpts</span> <span class='hs-varid'>flags</span> <span class='hs-varid'>mdl</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-113"></a>  <span class='hs-varid'>opts</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>mbOpts</span> <span class='hs-keyword'>of</span>
<a name="line-114"></a>    <span class='hs-conid'>Just</span> <span class='hs-varid'>opts</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>words</span> <span class='hs-varop'>$</span> <span class='hs-varid'>replace</span> <span class='hs-chr'>','</span> <span class='hs-chr'>' '</span> <span class='hs-varid'>opts</span> <span class='hs-keyword'>of</span>
<a name="line-115"></a>      <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>tell</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"No option supplied to DOC_OPTION/doc_option"</span><span class='hs-keyglyph'>]</span> <span class='hs-varop'>&gt;&gt;</span> <span class='hs-varid'>return</span> <span class='hs-conid'>[]</span>
<a name="line-116"></a>      <span class='hs-varid'>xs</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>liftM</span> <span class='hs-varid'>catMaybes</span> <span class='hs-layout'>(</span><span class='hs-varid'>mapM</span> <span class='hs-varid'>parseOption</span> <span class='hs-varid'>xs</span><span class='hs-layout'>)</span>
<a name="line-117"></a>    <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>return</span> <span class='hs-conid'>[]</span>
<a name="line-118"></a>  <span class='hs-keyword'>if</span> <span class='hs-conid'>Flag_HideModule</span> <span class='hs-layout'>(</span><span class='hs-varid'>moduleString</span> <span class='hs-varid'>mdl</span><span class='hs-layout'>)</span> <span class='hs-varop'>`elem`</span> <span class='hs-varid'>flags</span>
<a name="line-119"></a>    <span class='hs-keyword'>then</span> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-conid'>OptHide</span> <span class='hs-conop'>:</span> <span class='hs-varid'>opts</span>
<a name="line-120"></a>    <span class='hs-keyword'>else</span> <span class='hs-varid'>return</span> <span class='hs-varid'>opts</span>
<a name="line-121"></a>
<a name="line-122"></a>
<a name="line-123"></a><a name="parseOption"></a><span class='hs-definition'>parseOption</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>ErrMsgM</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-conid'>DocOption</span><span class='hs-layout'>)</span>
<a name="line-124"></a><span class='hs-definition'>parseOption</span> <span class='hs-str'>"hide"</span>           <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-conid'>Just</span> <span class='hs-conid'>OptHide</span><span class='hs-layout'>)</span>
<a name="line-125"></a><span class='hs-definition'>parseOption</span> <span class='hs-str'>"prune"</span>          <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-conid'>Just</span> <span class='hs-conid'>OptPrune</span><span class='hs-layout'>)</span>
<a name="line-126"></a><span class='hs-definition'>parseOption</span> <span class='hs-str'>"ignore-exports"</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-conid'>Just</span> <span class='hs-conid'>OptIgnoreExports</span><span class='hs-layout'>)</span>
<a name="line-127"></a><span class='hs-definition'>parseOption</span> <span class='hs-str'>"not-home"</span>       <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-conid'>Just</span> <span class='hs-conid'>OptNotHome</span><span class='hs-layout'>)</span>
<a name="line-128"></a><span class='hs-definition'>parseOption</span> <span class='hs-varid'>other</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>tell</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"Unrecognised option: "</span> <span class='hs-varop'>++</span> <span class='hs-varid'>other</span><span class='hs-keyglyph'>]</span> <span class='hs-varop'>&gt;&gt;</span> <span class='hs-varid'>return</span> <span class='hs-conid'>Nothing</span>
<a name="line-129"></a>
<a name="line-130"></a>
<a name="line-131"></a><span class='hs-comment'>--------------------------------------------------------------------------------</span>
<a name="line-132"></a><span class='hs-comment'>-- Declarations</span>
<a name="line-133"></a><span class='hs-comment'>--------------------------------------------------------------------------------</span>
<a name="line-134"></a>
<a name="line-135"></a>
<a name="line-136"></a><a name="mkInstanceDocMap"></a><span class='hs-definition'>mkInstanceDocMap</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Instance</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>HsDecl</span> <span class='hs-varid'>name</span><span class='hs-layout'>,</span> <span class='hs-varid'>doc</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Map</span> <span class='hs-conid'>Name</span> <span class='hs-varid'>doc</span>
<a name="line-137"></a><span class='hs-definition'>mkInstanceDocMap</span> <span class='hs-varid'>instances</span> <span class='hs-varid'>decls</span> <span class='hs-keyglyph'>=</span>
<a name="line-138"></a>  <span class='hs-comment'>-- We relate Instances to InstDecls using the SrcSpans buried inside them.</span>
<a name="line-139"></a>  <span class='hs-comment'>-- That should work for normal user-written instances (from looking at GHC</span>
<a name="line-140"></a>  <span class='hs-comment'>-- sources). We can assume that commented instances are user-written.</span>
<a name="line-141"></a>  <span class='hs-comment'>-- This lets us relate Names (from Instances) to comments (associated</span>
<a name="line-142"></a>  <span class='hs-comment'>-- with InstDecls).</span>
<a name="line-143"></a>  <span class='hs-keyword'>let</span> <span class='hs-varid'>docMap</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'>loc</span><span class='hs-layout'>,</span> <span class='hs-varid'>doc</span><span class='hs-layout'>)</span>
<a name="line-144"></a>                            <span class='hs-keyglyph'>|</span> <span class='hs-layout'>(</span><span class='hs-conid'>InstD</span> <span class='hs-layout'>(</span><span class='hs-conid'>InstDecl</span> <span class='hs-layout'>(</span><span class='hs-conid'>L</span> <span class='hs-varid'>loc</span> <span class='hs-keyword'>_</span><span class='hs-layout'>)</span> <span class='hs-keyword'>_</span> <span class='hs-keyword'>_</span> <span class='hs-keyword'>_</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>doc</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>decls</span> <span class='hs-keyglyph'>]</span>
<a name="line-145"></a>
<a name="line-146"></a>  <span class='hs-keyword'>in</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'>name</span><span class='hs-layout'>,</span> <span class='hs-varid'>doc</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>inst</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>instances</span>
<a name="line-147"></a>                  <span class='hs-layout'>,</span> <span class='hs-keyword'>let</span> <span class='hs-varid'>name</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>getName</span> <span class='hs-varid'>inst</span>
<a name="line-148"></a>                  <span class='hs-layout'>,</span> <span class='hs-conid'>Just</span> <span class='hs-varid'>doc</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-keyglyph'>[</span> <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>lookup</span> <span class='hs-layout'>(</span><span class='hs-varid'>getSrcSpan</span> <span class='hs-varid'>name</span><span class='hs-layout'>)</span> <span class='hs-varid'>docMap</span> <span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>]</span>
<a name="line-149"></a>
<a name="line-150"></a>
<a name="line-151"></a><a name="mkSubMap"></a><span class='hs-comment'>-- | Make a sub map from a declaration map. Make sure we only include exported</span>
<a name="line-152"></a><span class='hs-comment'>-- names.</span>
<a name="line-153"></a><span class='hs-definition'>mkSubMap</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Map</span> <span class='hs-conid'>Name</span> <span class='hs-conid'>DeclInfo</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Name</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Map</span> <span class='hs-conid'>Name</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Name</span><span class='hs-keyglyph'>]</span>
<a name="line-154"></a><span class='hs-definition'>mkSubMap</span> <span class='hs-varid'>declMap</span> <span class='hs-varid'>exports</span> <span class='hs-keyglyph'>=</span>
<a name="line-155"></a>  <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>filterWithKey</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>k</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>k</span> <span class='hs-varop'>`elem`</span> <span class='hs-varid'>exports</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>map</span> <span class='hs-varid'>filterSubs</span> <span class='hs-varid'>declMap</span><span class='hs-layout'>)</span>
<a name="line-156"></a>  <span class='hs-keyword'>where</span>
<a name="line-157"></a>    <span class='hs-varid'>filterSubs</span> <span class='hs-layout'>(</span><span class='hs-keyword'>_</span><span class='hs-layout'>,</span> <span class='hs-keyword'>_</span><span class='hs-layout'>,</span> <span class='hs-varid'>subs</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>[</span> <span class='hs-varid'>sub</span>  <span class='hs-keyglyph'>|</span> <span class='hs-layout'>(</span><span class='hs-varid'>sub</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'>subs</span><span class='hs-layout'>,</span> <span class='hs-varid'>sub</span> <span class='hs-varop'>`elem`</span> <span class='hs-varid'>exports</span> <span class='hs-keyglyph'>]</span>
<a name="line-158"></a>
<a name="line-159"></a>
<a name="line-160"></a><a name="mkDeclMap"></a><span class='hs-comment'>-- Make a map from names to 'DeclInfo's. Exclude declarations that don't have</span>
<a name="line-161"></a><span class='hs-comment'>-- names (e.g. instances and stand-alone documentation comments). Include</span>
<a name="line-162"></a><span class='hs-comment'>-- subordinate names, but map them to their parent declarations.</span>
<a name="line-163"></a><span class='hs-definition'>mkDeclMap</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>DeclInfo</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Map</span> <span class='hs-conid'>Name</span> <span class='hs-conid'>DeclInfo</span>
<a name="line-164"></a><span class='hs-definition'>mkDeclMap</span> <span class='hs-varid'>decls</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-varop'>.</span> <span class='hs-varid'>concat</span> <span class='hs-varop'>$</span>
<a name="line-165"></a>  <span class='hs-keyglyph'>[</span> <span class='hs-layout'>(</span><span class='hs-varid'>declName</span> <span class='hs-varid'>d</span><span class='hs-layout'>,</span> <span class='hs-layout'>(</span><span class='hs-varid'>parent</span><span class='hs-layout'>,</span> <span class='hs-varid'>doc</span><span class='hs-layout'>,</span> <span class='hs-varid'>subs</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-conop'>:</span> <span class='hs-varid'>subDecls</span>
<a name="line-166"></a>  <span class='hs-keyglyph'>|</span> <span class='hs-layout'>(</span><span class='hs-varid'>parent</span><span class='hs-keyglyph'>@</span><span class='hs-layout'>(</span><span class='hs-conid'>L</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>d</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>doc</span><span class='hs-layout'>,</span> <span class='hs-varid'>subs</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>decls</span>
<a name="line-167"></a>  <span class='hs-layout'>,</span> <span class='hs-keyword'>let</span> <span class='hs-varid'>subDecls</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>[</span> <span class='hs-layout'>(</span><span class='hs-varid'>n</span><span class='hs-layout'>,</span> <span class='hs-layout'>(</span><span class='hs-varid'>parent</span><span class='hs-layout'>,</span> <span class='hs-varid'>doc'</span><span class='hs-layout'>,</span> <span class='hs-conid'>[]</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>|</span> <span class='hs-layout'>(</span><span class='hs-varid'>n</span><span class='hs-layout'>,</span> <span class='hs-varid'>doc'</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>subs</span> <span class='hs-keyglyph'>]</span>
<a name="line-168"></a>  <span class='hs-layout'>,</span> <span class='hs-varid'>not</span> <span class='hs-layout'>(</span><span class='hs-varid'>isDocD</span> <span class='hs-varid'>d</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>not</span> <span class='hs-layout'>(</span><span class='hs-varid'>isInstD</span> <span class='hs-varid'>d</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>]</span>
<a name="line-169"></a>
<a name="line-170"></a>
<a name="line-171"></a><a name="declInfos"></a><span class='hs-definition'>declInfos</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>GlobalRdrEnv</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>Decl</span><span class='hs-layout'>,</span> <span class='hs-conid'>MaybeDocStrings</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>ErrMsgM</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>DeclInfo</span><span class='hs-keyglyph'>]</span>
<a name="line-172"></a><span class='hs-definition'>declInfos</span> <span class='hs-varid'>gre</span> <span class='hs-varid'>decls</span> <span class='hs-keyglyph'>=</span>
<a name="line-173"></a>  <span class='hs-varid'>forM</span> <span class='hs-varid'>decls</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-varid'>parent</span><span class='hs-keyglyph'>@</span><span class='hs-layout'>(</span><span class='hs-conid'>L</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>d</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>mbDocString</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyword'>do</span>
<a name="line-174"></a>            <span class='hs-varid'>mbDoc</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>lexParseRnHaddockCommentList</span> <span class='hs-conid'>NormalHaddockComment</span>
<a name="line-175"></a>                       <span class='hs-varid'>gre</span> <span class='hs-varid'>mbDocString</span>
<a name="line-176"></a>            <span class='hs-varid'>fnArgsDoc</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>fmap</span> <span class='hs-layout'>(</span><span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>mapMaybe</span> <span class='hs-varid'>id</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span>
<a name="line-177"></a>                <span class='hs-conid'>Traversable</span><span class='hs-varop'>.</span><span class='hs-varid'>forM</span> <span class='hs-layout'>(</span><span class='hs-varid'>getDeclFnArgDocs</span> <span class='hs-varid'>d</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span>
<a name="line-178"></a>                <span class='hs-keyglyph'>\</span><span class='hs-varid'>doc</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>lexParseRnHaddockComment</span> <span class='hs-conid'>NormalHaddockComment</span> <span class='hs-varid'>gre</span> <span class='hs-varid'>doc</span>
<a name="line-179"></a>
<a name="line-180"></a>            <span class='hs-keyword'>let</span> <span class='hs-varid'>subs_</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>subordinates</span> <span class='hs-varid'>d</span>
<a name="line-181"></a>            <span class='hs-varid'>subs</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>forM</span> <span class='hs-varid'>subs_</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-varid'>subName</span><span class='hs-layout'>,</span> <span class='hs-varid'>mbSubDocStr</span><span class='hs-layout'>,</span> <span class='hs-varid'>subFnArgsDocStr</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyword'>do</span>
<a name="line-182"></a>                <span class='hs-varid'>mbSubDoc</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>lexParseRnHaddockCommentList</span> <span class='hs-conid'>NormalHaddockComment</span>
<a name="line-183"></a>                              <span class='hs-varid'>gre</span> <span class='hs-varid'>mbSubDocStr</span>
<a name="line-184"></a>                <span class='hs-varid'>subFnArgsDoc</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>fmap</span> <span class='hs-layout'>(</span><span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>mapMaybe</span> <span class='hs-varid'>id</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span>
<a name="line-185"></a>                  <span class='hs-conid'>Traversable</span><span class='hs-varop'>.</span><span class='hs-varid'>forM</span> <span class='hs-varid'>subFnArgsDocStr</span> <span class='hs-varop'>$</span>
<a name="line-186"></a>                  <span class='hs-keyglyph'>\</span><span class='hs-varid'>doc</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>lexParseRnHaddockComment</span> <span class='hs-conid'>NormalHaddockComment</span> <span class='hs-varid'>gre</span> <span class='hs-varid'>doc</span>
<a name="line-187"></a>                <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-varid'>subName</span><span class='hs-layout'>,</span> <span class='hs-layout'>(</span><span class='hs-varid'>mbSubDoc</span><span class='hs-layout'>,</span> <span class='hs-varid'>subFnArgsDoc</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-188"></a>
<a name="line-189"></a>            <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-varid'>parent</span><span class='hs-layout'>,</span> <span class='hs-layout'>(</span><span class='hs-varid'>mbDoc</span><span class='hs-layout'>,</span> <span class='hs-varid'>fnArgsDoc</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>subs</span><span class='hs-layout'>)</span>
<a name="line-190"></a>
<a name="line-191"></a>
<a name="line-192"></a><a name="subordinatesWithNoDocs"></a><span class='hs-comment'>-- | If you know the HsDecl can't contain any docs</span>
<a name="line-193"></a><span class='hs-comment'>-- (e.g., it was loaded from a .hi file and you don't have a .haddock file</span>
<a name="line-194"></a><span class='hs-comment'>-- to help you find out about the subs or docs)</span>
<a name="line-195"></a><span class='hs-comment'>-- then you can use this to get its subs.</span>
<a name="line-196"></a><span class='hs-definition'>subordinatesWithNoDocs</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>HsDecl</span> <span class='hs-conid'>Name</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>Name</span><span class='hs-layout'>,</span> <span class='hs-conid'>DocForDecl</span> <span class='hs-conid'>Name</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-197"></a><span class='hs-definition'>subordinatesWithNoDocs</span> <span class='hs-varid'>decl</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>map</span> <span class='hs-varid'>noDocs</span> <span class='hs-layout'>(</span><span class='hs-varid'>subordinates</span> <span class='hs-varid'>decl</span><span class='hs-layout'>)</span>
<a name="line-198"></a>  <span class='hs-keyword'>where</span>
<a name="line-199"></a>    <span class='hs-comment'>-- check the condition... or shouldn't we be checking?</span>
<a name="line-200"></a>    <span class='hs-varid'>noDocs</span> <span class='hs-layout'>(</span><span class='hs-varid'>n</span><span class='hs-layout'>,</span> <span class='hs-varid'>doc1</span><span class='hs-layout'>,</span> <span class='hs-varid'>doc2</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>null</span> <span class='hs-varid'>doc1</span><span class='hs-layout'>,</span> <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>null</span> <span class='hs-varid'>doc2</span>
<a name="line-201"></a>        <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>n</span><span class='hs-layout'>,</span> <span class='hs-varid'>noDocForDecl</span><span class='hs-layout'>)</span>
<a name="line-202"></a>    <span class='hs-varid'>noDocs</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>error</span> <span class='hs-layout'>(</span><span class='hs-str'>"no-docs thing has docs! "</span> <span class='hs-varop'>++</span> <span class='hs-varid'>pretty</span> <span class='hs-varid'>decl</span><span class='hs-layout'>)</span>
<a name="line-203"></a>
<a name="line-204"></a>
<a name="line-205"></a><a name="subordinates"></a><span class='hs-definition'>subordinates</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>HsDecl</span> <span class='hs-conid'>Name</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>Name</span><span class='hs-layout'>,</span> <span class='hs-conid'>MaybeDocStrings</span><span class='hs-layout'>,</span> <span class='hs-conid'>Map</span> <span class='hs-conid'>Int</span> <span class='hs-conid'>HsDocString</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-206"></a><span class='hs-definition'>subordinates</span> <span class='hs-layout'>(</span><span class='hs-conid'>TyClD</span> <span class='hs-varid'>d</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>classDataSubs</span> <span class='hs-varid'>d</span>
<a name="line-207"></a><span class='hs-definition'>subordinates</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>[]</span>
<a name="line-208"></a>
<a name="line-209"></a>
<a name="line-210"></a><a name="classDataSubs"></a><span class='hs-definition'>classDataSubs</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>TyClDecl</span> <span class='hs-conid'>Name</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>Name</span><span class='hs-layout'>,</span> <span class='hs-conid'>MaybeDocStrings</span><span class='hs-layout'>,</span> <span class='hs-conid'>Map</span> <span class='hs-conid'>Int</span> <span class='hs-conid'>HsDocString</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-211"></a><span class='hs-definition'>classDataSubs</span> <span class='hs-varid'>decl</span>
<a name="line-212"></a>  <span class='hs-keyglyph'>|</span> <span class='hs-varid'>isClassDecl</span> <span class='hs-varid'>decl</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>classSubs</span>
<a name="line-213"></a>  <span class='hs-keyglyph'>|</span> <span class='hs-varid'>isDataDecl</span>  <span class='hs-varid'>decl</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>dataSubs</span>
<a name="line-214"></a>  <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span>        <span class='hs-keyglyph'>=</span> <span class='hs-conid'>[]</span>
<a name="line-215"></a>  <span class='hs-keyword'>where</span>
<a name="line-216"></a>    <span class='hs-varid'>classSubs</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>[</span> <span class='hs-layout'>(</span><span class='hs-varid'>declName</span> <span class='hs-varid'>d</span><span class='hs-layout'>,</span> <span class='hs-varid'>doc</span><span class='hs-layout'>,</span> <span class='hs-varid'>fnArgsDoc</span><span class='hs-layout'>)</span>
<a name="line-217"></a>                <span class='hs-keyglyph'>|</span> <span class='hs-layout'>(</span><span class='hs-conid'>L</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>d</span><span class='hs-layout'>,</span> <span class='hs-varid'>doc</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>classDecls</span> <span class='hs-varid'>decl</span>
<a name="line-218"></a>                <span class='hs-layout'>,</span> <span class='hs-keyword'>let</span> <span class='hs-varid'>fnArgsDoc</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>getDeclFnArgDocs</span> <span class='hs-varid'>d</span> <span class='hs-keyglyph'>]</span>
<a name="line-219"></a>    <span class='hs-varid'>dataSubs</span>  <span class='hs-keyglyph'>=</span> <span class='hs-varid'>constrs</span> <span class='hs-varop'>++</span> <span class='hs-varid'>fields</span>
<a name="line-220"></a>      <span class='hs-keyword'>where</span>
<a name="line-221"></a>        <span class='hs-varid'>cons</span>    <span class='hs-keyglyph'>=</span> <span class='hs-varid'>map</span> <span class='hs-varid'>unL</span> <span class='hs-varop'>$</span> <span class='hs-varid'>tcdCons</span> <span class='hs-varid'>decl</span>
<a name="line-222"></a>        <span class='hs-comment'>-- should we use the type-signature of the constructor</span>
<a name="line-223"></a>        <span class='hs-comment'>-- and the docs of the fields to produce fnArgsDoc for the constr,</span>
<a name="line-224"></a>        <span class='hs-comment'>-- just in case someone exports it without exporting the type</span>
<a name="line-225"></a>        <span class='hs-comment'>-- and perhaps makes it look like a function?  I doubt it.</span>
<a name="line-226"></a>        <span class='hs-varid'>constrs</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>[</span> <span class='hs-layout'>(</span><span class='hs-varid'>unL</span> <span class='hs-varop'>$</span> <span class='hs-varid'>con_name</span> <span class='hs-varid'>c</span><span class='hs-layout'>,</span> <span class='hs-varid'>maybeToList</span> <span class='hs-varop'>$</span> <span class='hs-varid'>fmap</span> <span class='hs-varid'>unL</span> <span class='hs-varop'>$</span> <span class='hs-varid'>con_doc</span> <span class='hs-varid'>c</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>
<a name="line-227"></a>                  <span class='hs-keyglyph'>|</span> <span class='hs-varid'>c</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>cons</span> <span class='hs-keyglyph'>]</span>
<a name="line-228"></a>        <span class='hs-varid'>fields</span>  <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>[</span> <span class='hs-layout'>(</span><span class='hs-varid'>unL</span> <span class='hs-varid'>n</span><span class='hs-layout'>,</span> <span class='hs-varid'>maybeToList</span> <span class='hs-varop'>$</span> <span class='hs-varid'>fmap</span> <span class='hs-varid'>unL</span> <span class='hs-varid'>doc</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>
<a name="line-229"></a>                  <span class='hs-keyglyph'>|</span> <span class='hs-conid'>RecCon</span> <span class='hs-varid'>flds</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>map</span> <span class='hs-varid'>con_details</span> <span class='hs-varid'>cons</span>
<a name="line-230"></a>                  <span class='hs-layout'>,</span> <span class='hs-conid'>ConDeclField</span> <span class='hs-varid'>n</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>doc</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>flds</span> <span class='hs-keyglyph'>]</span>
<a name="line-231"></a>
<a name="line-232"></a>
<a name="line-233"></a><a name="classDecls"></a><span class='hs-comment'>-- All the sub declarations of a class (that we handle), ordered by</span>
<a name="line-234"></a><span class='hs-comment'>-- source location, with documentation attached if it exists.</span>
<a name="line-235"></a><span class='hs-definition'>classDecls</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>TyClDecl</span> <span class='hs-conid'>Name</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>Decl</span><span class='hs-layout'>,</span> <span class='hs-conid'>MaybeDocStrings</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-236"></a><span class='hs-definition'>classDecls</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>filterDecls</span> <span class='hs-varop'>.</span> <span class='hs-varid'>collectDocs</span> <span class='hs-varop'>.</span> <span class='hs-varid'>sortByLoc</span> <span class='hs-varop'>.</span> <span class='hs-varid'>declsFromClass</span>
<a name="line-237"></a>
<a name="line-238"></a>
<a name="line-239"></a><a name="declsFromClass"></a><span class='hs-definition'>declsFromClass</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>TyClDecl</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Located</span> <span class='hs-layout'>(</span><span class='hs-conid'>HsDecl</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-240"></a><span class='hs-definition'>declsFromClass</span> <span class='hs-varid'>class_</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>docs</span> <span class='hs-varop'>++</span> <span class='hs-varid'>defs</span> <span class='hs-varop'>++</span> <span class='hs-varid'>sigs</span> <span class='hs-varop'>++</span> <span class='hs-varid'>ats</span>
<a name="line-241"></a>  <span class='hs-keyword'>where</span>
<a name="line-242"></a>    <span class='hs-varid'>docs</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mkDecls</span> <span class='hs-varid'>tcdDocs</span> <span class='hs-conid'>DocD</span> <span class='hs-varid'>class_</span>
<a name="line-243"></a>    <span class='hs-varid'>defs</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mkDecls</span> <span class='hs-layout'>(</span><span class='hs-varid'>bagToList</span> <span class='hs-varop'>.</span> <span class='hs-varid'>tcdMeths</span><span class='hs-layout'>)</span> <span class='hs-conid'>ValD</span> <span class='hs-varid'>class_</span>
<a name="line-244"></a>    <span class='hs-varid'>sigs</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mkDecls</span> <span class='hs-varid'>tcdSigs</span> <span class='hs-conid'>SigD</span> <span class='hs-varid'>class_</span>
<a name="line-245"></a>    <span class='hs-varid'>ats</span>  <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mkDecls</span> <span class='hs-varid'>tcdATs</span> <span class='hs-conid'>TyClD</span> <span class='hs-varid'>class_</span>
<a name="line-246"></a>
<a name="line-247"></a>
<a name="line-248"></a><a name="declName"></a><span class='hs-definition'>declName</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>HsDecl</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>a</span>
<a name="line-249"></a><span class='hs-definition'>declName</span> <span class='hs-layout'>(</span><span class='hs-conid'>TyClD</span> <span class='hs-varid'>d</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>tcdName</span> <span class='hs-varid'>d</span>
<a name="line-250"></a><span class='hs-definition'>declName</span> <span class='hs-layout'>(</span><span class='hs-conid'>ForD</span> <span class='hs-layout'>(</span><span class='hs-conid'>ForeignImport</span> <span class='hs-varid'>n</span> <span class='hs-keyword'>_</span> <span class='hs-keyword'>_</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>unLoc</span> <span class='hs-varid'>n</span>
<a name="line-251"></a><span class='hs-comment'>-- we have normal sigs only (since they are taken from ValBindsOut)</span>
<a name="line-252"></a><span class='hs-definition'>declName</span> <span class='hs-layout'>(</span><span class='hs-conid'>SigD</span> <span class='hs-varid'>sig</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fromJust</span> <span class='hs-varop'>$</span> <span class='hs-varid'>sigNameNoLoc</span> <span class='hs-varid'>sig</span>
<a name="line-253"></a><span class='hs-definition'>declName</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>error</span> <span class='hs-str'>"unexpected argument to declName"</span>
<a name="line-254"></a>
<a name="line-255"></a>
<a name="line-256"></a><a name="topDecls"></a><span class='hs-comment'>-- | The top-level declarations of a module that we care about,</span>
<a name="line-257"></a><span class='hs-comment'>-- ordered by source location, with documentation attached if it exists.</span>
<a name="line-258"></a><span class='hs-definition'>topDecls</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>HsGroup</span> <span class='hs-conid'>Name</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>Decl</span><span class='hs-layout'>,</span> <span class='hs-conid'>MaybeDocStrings</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-259"></a><span class='hs-definition'>topDecls</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>filterClasses</span> <span class='hs-varop'>.</span> <span class='hs-varid'>filterDecls</span> <span class='hs-varop'>.</span> <span class='hs-varid'>collectDocs</span> <span class='hs-varop'>.</span> <span class='hs-varid'>sortByLoc</span> <span class='hs-varop'>.</span> <span class='hs-varid'>declsFromGroup</span>
<a name="line-260"></a>
<a name="line-261"></a>
<a name="line-262"></a><a name="filterOutInstances"></a><span class='hs-definition'>filterOutInstances</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>Located</span> <span class='hs-layout'>(</span><span class='hs-conid'>HsDecl</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>b</span><span class='hs-layout'>,</span> <span class='hs-varid'>c</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>Located</span> <span class='hs-layout'>(</span><span class='hs-conid'>HsDecl</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>b</span><span class='hs-layout'>,</span> <span class='hs-varid'>c</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-263"></a><span class='hs-definition'>filterOutInstances</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>filter</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>L</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>d</span><span class='hs-layout'>,</span> <span class='hs-keyword'>_</span><span class='hs-layout'>,</span> <span class='hs-keyword'>_</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>not</span> <span class='hs-layout'>(</span><span class='hs-varid'>isInstD</span> <span class='hs-varid'>d</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-264"></a>
<a name="line-265"></a>
<a name="line-266"></a><a name="declsFromGroup"></a><span class='hs-comment'>-- | Take all declarations except pragmas, infix decls, rules and value</span>
<a name="line-267"></a><span class='hs-comment'>-- bindings from an 'HsGroup'.</span>
<a name="line-268"></a><span class='hs-definition'>declsFromGroup</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>HsGroup</span> <span class='hs-conid'>Name</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Decl</span><span class='hs-keyglyph'>]</span>
<a name="line-269"></a><span class='hs-definition'>declsFromGroup</span> <span class='hs-varid'>group_</span> <span class='hs-keyglyph'>=</span>
<a name="line-270"></a>  <span class='hs-varid'>mkDecls</span> <span class='hs-varid'>hs_tyclds</span>  <span class='hs-conid'>TyClD</span>    <span class='hs-varid'>group_</span> <span class='hs-varop'>++</span>
<a name="line-271"></a>  <span class='hs-varid'>mkDecls</span> <span class='hs-varid'>hs_derivds</span> <span class='hs-conid'>DerivD</span>   <span class='hs-varid'>group_</span> <span class='hs-varop'>++</span>
<a name="line-272"></a>  <span class='hs-varid'>mkDecls</span> <span class='hs-varid'>hs_defds</span>   <span class='hs-conid'>DefD</span>     <span class='hs-varid'>group_</span> <span class='hs-varop'>++</span>
<a name="line-273"></a>  <span class='hs-varid'>mkDecls</span> <span class='hs-varid'>hs_fords</span>   <span class='hs-conid'>ForD</span>     <span class='hs-varid'>group_</span> <span class='hs-varop'>++</span>
<a name="line-274"></a>  <span class='hs-varid'>mkDecls</span> <span class='hs-varid'>hs_docs</span>    <span class='hs-conid'>DocD</span>     <span class='hs-varid'>group_</span> <span class='hs-varop'>++</span>
<a name="line-275"></a>  <span class='hs-varid'>mkDecls</span> <span class='hs-varid'>hs_instds</span>  <span class='hs-conid'>InstD</span>    <span class='hs-varid'>group_</span> <span class='hs-varop'>++</span>
<a name="line-276"></a>  <span class='hs-varid'>mkDecls</span> <span class='hs-layout'>(</span><span class='hs-varid'>typesigs</span> <span class='hs-varop'>.</span> <span class='hs-varid'>hs_valds</span><span class='hs-layout'>)</span> <span class='hs-conid'>SigD</span> <span class='hs-varid'>group_</span>
<a name="line-277"></a>  <span class='hs-keyword'>where</span>
<a name="line-278"></a>    <span class='hs-varid'>typesigs</span> <span class='hs-layout'>(</span><span class='hs-conid'>ValBindsOut</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>sigs</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>filter</span> <span class='hs-varid'>isVanillaLSig</span> <span class='hs-varid'>sigs</span>
<a name="line-279"></a>    <span class='hs-varid'>typesigs</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>error</span> <span class='hs-str'>"expected ValBindsOut"</span>
<a name="line-280"></a>
<a name="line-281"></a>
<a name="line-282"></a><a name="mkDecls"></a><span class='hs-comment'>-- | Take a field of declarations from a data structure and create HsDecls</span>
<a name="line-283"></a><span class='hs-comment'>-- using the given constructor</span>
<a name="line-284"></a><span class='hs-definition'>mkDecls</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-varid'>a</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Located</span> <span class='hs-varid'>b</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-layout'>(</span><span class='hs-varid'>b</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>c</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Located</span> <span class='hs-varid'>c</span><span class='hs-keyglyph'>]</span>
<a name="line-285"></a><span class='hs-definition'>mkDecls</span> <span class='hs-varid'>field</span> <span class='hs-varid'>con</span> <span class='hs-varid'>struct</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>[</span> <span class='hs-conid'>L</span> <span class='hs-varid'>loc</span> <span class='hs-layout'>(</span><span class='hs-varid'>con</span> <span class='hs-varid'>decl</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>L</span> <span class='hs-varid'>loc</span> <span class='hs-varid'>decl</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>field</span> <span class='hs-varid'>struct</span> <span class='hs-keyglyph'>]</span>
<a name="line-286"></a>
<a name="line-287"></a>
<a name="line-288"></a><a name="sortByLoc"></a><span class='hs-comment'>-- | Sort by source location</span>
<a name="line-289"></a><span class='hs-definition'>sortByLoc</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Located</span> <span class='hs-varid'>a</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Located</span> <span class='hs-varid'>a</span><span class='hs-keyglyph'>]</span>
<a name="line-290"></a><span class='hs-definition'>sortByLoc</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>sortBy</span> <span class='hs-layout'>(</span><span class='hs-varid'>comparing</span> <span class='hs-varid'>getLoc</span><span class='hs-layout'>)</span>
<a name="line-291"></a>
<a name="line-292"></a>
<a name="line-293"></a><a name="warnAboutFilteredDecls"></a><span class='hs-definition'>warnAboutFilteredDecls</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Module</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>LHsDecl</span> <span class='hs-conid'>Name</span><span class='hs-layout'>,</span> <span class='hs-varid'>b</span><span class='hs-layout'>,</span> <span class='hs-varid'>c</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>ErrMsgM</span> <span class='hs-conid'>()</span>
<a name="line-294"></a><span class='hs-definition'>warnAboutFilteredDecls</span> <span class='hs-varid'>mdl</span> <span class='hs-varid'>decls</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-295"></a>  <span class='hs-keyword'>let</span> <span class='hs-varid'>modStr</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>moduleString</span> <span class='hs-varid'>mdl</span>
<a name="line-296"></a>  <span class='hs-keyword'>let</span> <span class='hs-varid'>typeInstances</span> <span class='hs-keyglyph'>=</span>
<a name="line-297"></a>        <span class='hs-varid'>nub</span> <span class='hs-keyglyph'>[</span> <span class='hs-varid'>tcdName</span> <span class='hs-varid'>d</span> <span class='hs-keyglyph'>|</span> <span class='hs-layout'>(</span><span class='hs-conid'>L</span> <span class='hs-keyword'>_</span> <span class='hs-layout'>(</span><span class='hs-conid'>TyClD</span> <span class='hs-varid'>d</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-keyword'>_</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'>decls</span><span class='hs-layout'>,</span> <span class='hs-varid'>isFamInstDecl</span> <span class='hs-varid'>d</span> <span class='hs-keyglyph'>]</span>
<a name="line-298"></a>
<a name="line-299"></a>  <span class='hs-varid'>unless</span> <span class='hs-layout'>(</span><span class='hs-varid'>null</span> <span class='hs-varid'>typeInstances</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span>
<a name="line-300"></a>    <span class='hs-varid'>tell</span> <span class='hs-keyglyph'>[</span>
<a name="line-301"></a>      <span class='hs-str'>"Warning: "</span> <span class='hs-varop'>++</span> <span class='hs-varid'>modStr</span> <span class='hs-varop'>++</span> <span class='hs-str'>": Instances of type and data "</span>
<a name="line-302"></a>      <span class='hs-varop'>++</span> <span class='hs-str'>"families are not yet supported. Instances of the following families "</span>
<a name="line-303"></a>      <span class='hs-varop'>++</span> <span class='hs-str'>"will be filtered out:\n  "</span> <span class='hs-varop'>++</span> <span class='hs-varid'>concat</span> <span class='hs-layout'>(</span><span class='hs-varid'>intersperse</span> <span class='hs-str'>", "</span>
<a name="line-304"></a>      <span class='hs-varop'>$</span> <span class='hs-varid'>map</span> <span class='hs-layout'>(</span><span class='hs-varid'>occNameString</span> <span class='hs-varop'>.</span> <span class='hs-varid'>nameOccName</span><span class='hs-layout'>)</span> <span class='hs-varid'>typeInstances</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>]</span>
<a name="line-305"></a>
<a name="line-306"></a>  <span class='hs-keyword'>let</span> <span class='hs-varid'>instances</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>nub</span> <span class='hs-keyglyph'>[</span> <span class='hs-varid'>pretty</span> <span class='hs-varid'>i</span> <span class='hs-keyglyph'>|</span> <span class='hs-layout'>(</span><span class='hs-conid'>L</span> <span class='hs-keyword'>_</span> <span class='hs-layout'>(</span><span class='hs-conid'>InstD</span> <span class='hs-layout'>(</span><span class='hs-conid'>InstDecl</span> <span class='hs-varid'>i</span> <span class='hs-keyword'>_</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>ats</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-keyword'>_</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'>decls</span>
<a name="line-307"></a>                                 <span class='hs-layout'>,</span> <span class='hs-varid'>not</span> <span class='hs-layout'>(</span><span class='hs-varid'>null</span> <span class='hs-varid'>ats</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>]</span>
<a name="line-308"></a>
<a name="line-309"></a>  <span class='hs-varid'>unless</span> <span class='hs-layout'>(</span><span class='hs-varid'>null</span> <span class='hs-varid'>instances</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span>
<a name="line-310"></a>    <span class='hs-varid'>tell</span> <span class='hs-keyglyph'>[</span>
<a name="line-311"></a>      <span class='hs-str'>"Warning: "</span> <span class='hs-varop'>++</span> <span class='hs-varid'>modStr</span> <span class='hs-varop'>++</span> <span class='hs-str'>": We do not support associated types in instances yet. "</span>
<a name="line-312"></a>      <span class='hs-varop'>++</span> <span class='hs-str'>"These instances are affected:\n"</span> <span class='hs-varop'>++</span> <span class='hs-varid'>concat</span> <span class='hs-layout'>(</span><span class='hs-varid'>intersperse</span> <span class='hs-str'>", "</span> <span class='hs-varid'>instances</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>]</span>
<a name="line-313"></a>
<a name="line-314"></a>
<a name="line-315"></a><span class='hs-comment'>--------------------------------------------------------------------------------</span>
<a name="line-316"></a><span class='hs-comment'>-- Filtering of declarations</span>
<a name="line-317"></a><span class='hs-comment'>--</span>
<a name="line-318"></a><span class='hs-comment'>-- We filter out declarations that we don't intend to handle later.</span>
<a name="line-319"></a><span class='hs-comment'>--------------------------------------------------------------------------------</span>
<a name="line-320"></a>
<a name="line-321"></a>
<a name="line-322"></a><a name="filterDecls"></a><span class='hs-comment'>-- | Filter out declarations that we don't handle in Haddock</span>
<a name="line-323"></a><span class='hs-definition'>filterDecls</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>Decl</span><span class='hs-layout'>,</span> <span class='hs-varid'>doc</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>Decl</span><span class='hs-layout'>,</span> <span class='hs-varid'>doc</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-324"></a><span class='hs-definition'>filterDecls</span> <span class='hs-varid'>decls</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>filter</span> <span class='hs-layout'>(</span><span class='hs-varid'>isHandled</span> <span class='hs-varop'>.</span> <span class='hs-varid'>unL</span> <span class='hs-varop'>.</span> <span class='hs-varid'>fst</span><span class='hs-layout'>)</span> <span class='hs-varid'>decls</span>
<a name="line-325"></a>  <span class='hs-keyword'>where</span>
<a name="line-326"></a>    <span class='hs-varid'>isHandled</span> <span class='hs-layout'>(</span><span class='hs-conid'>ForD</span> <span class='hs-layout'>(</span><span class='hs-conid'>ForeignImport</span> <span class='hs-layout'>{</span><span class='hs-layout'>}</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>True</span>
<a name="line-327"></a>    <span class='hs-varid'>isHandled</span> <span class='hs-layout'>(</span><span class='hs-conid'>TyClD</span> <span class='hs-layout'>{</span><span class='hs-layout'>}</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>True</span>
<a name="line-328"></a>    <span class='hs-varid'>isHandled</span> <span class='hs-layout'>(</span><span class='hs-conid'>InstD</span> <span class='hs-layout'>{</span><span class='hs-layout'>}</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>True</span>
<a name="line-329"></a>    <span class='hs-varid'>isHandled</span> <span class='hs-layout'>(</span><span class='hs-conid'>SigD</span> <span class='hs-varid'>d</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>isVanillaLSig</span> <span class='hs-layout'>(</span><span class='hs-varid'>reL</span> <span class='hs-varid'>d</span><span class='hs-layout'>)</span>
<a name="line-330"></a>    <span class='hs-comment'>-- we keep doc declarations to be able to get at named docs</span>
<a name="line-331"></a>    <span class='hs-varid'>isHandled</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocD</span> <span class='hs-keyword'>_</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>True</span>
<a name="line-332"></a>    <span class='hs-varid'>isHandled</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>False</span>
<a name="line-333"></a>
<a name="line-334"></a>
<a name="line-335"></a><a name="filterClasses"></a><span class='hs-comment'>-- | Go through all class declarations and filter their sub-declarations</span>
<a name="line-336"></a><span class='hs-definition'>filterClasses</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>Decl</span><span class='hs-layout'>,</span> <span class='hs-varid'>doc</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>Decl</span><span class='hs-layout'>,</span> <span class='hs-varid'>doc</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-337"></a><span class='hs-definition'>filterClasses</span> <span class='hs-varid'>decls</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>[</span> <span class='hs-keyword'>if</span> <span class='hs-varid'>isClassD</span> <span class='hs-varid'>d</span> <span class='hs-keyword'>then</span> <span class='hs-layout'>(</span><span class='hs-conid'>L</span> <span class='hs-varid'>loc</span> <span class='hs-layout'>(</span><span class='hs-varid'>filterClass</span> <span class='hs-varid'>d</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>doc</span><span class='hs-layout'>)</span> <span class='hs-keyword'>else</span> <span class='hs-varid'>x</span>
<a name="line-338"></a>                      <span class='hs-keyglyph'>|</span> <span class='hs-varid'>x</span><span class='hs-keyglyph'>@</span><span class='hs-layout'>(</span><span class='hs-conid'>L</span> <span class='hs-varid'>loc</span> <span class='hs-varid'>d</span><span class='hs-layout'>,</span> <span class='hs-varid'>doc</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>decls</span> <span class='hs-keyglyph'>]</span>
<a name="line-339"></a>  <span class='hs-keyword'>where</span>
<a name="line-340"></a>    <span class='hs-varid'>filterClass</span> <span class='hs-layout'>(</span><span class='hs-conid'>TyClD</span> <span class='hs-varid'>c</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span>
<a name="line-341"></a>      <span class='hs-conid'>TyClD</span> <span class='hs-varop'>$</span> <span class='hs-varid'>c</span> <span class='hs-layout'>{</span> <span class='hs-varid'>tcdSigs</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>filter</span> <span class='hs-varid'>isVanillaLSig</span> <span class='hs-varop'>$</span> <span class='hs-varid'>tcdSigs</span> <span class='hs-varid'>c</span> <span class='hs-layout'>}</span>
<a name="line-342"></a>    <span class='hs-varid'>filterClass</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>error</span> <span class='hs-str'>"expected TyClD"</span>
<a name="line-343"></a>
<a name="line-344"></a>
<a name="line-345"></a><span class='hs-comment'>--------------------------------------------------------------------------------</span>
<a name="line-346"></a><span class='hs-comment'>-- Collect docs</span>
<a name="line-347"></a><span class='hs-comment'>--</span>
<a name="line-348"></a><span class='hs-comment'>-- To be able to attach the right Haddock comment to the right declaration,</span>
<a name="line-349"></a><span class='hs-comment'>-- we sort the declarations by their SrcLoc and "collect" the docs for each</span>
<a name="line-350"></a><span class='hs-comment'>-- declaration.</span>
<a name="line-351"></a><span class='hs-comment'>--------------------------------------------------------------------------------</span>
<a name="line-352"></a>
<a name="line-353"></a><a name="MaybeDocStrings"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>MaybeDocStrings</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>HsDocString</span><span class='hs-keyglyph'>]</span>
<a name="line-354"></a><a name="MaybeDocStringsFast"></a><span class='hs-comment'>-- avoid [] because we're appending from the left (quadratic),</span>
<a name="line-355"></a><a name="MaybeDocStringsFast"></a><span class='hs-comment'>-- and avoid adding another package dependency for haddock,</span>
<a name="line-356"></a><a name="MaybeDocStringsFast"></a><span class='hs-comment'>-- so use the difference-list pattern</span>
<a name="line-357"></a><a name="MaybeDocStringsFast"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>MaybeDocStringsFast</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>MaybeDocStrings</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>MaybeDocStrings</span>
<a name="line-358"></a><a name="docStringEmpty"></a><span class='hs-definition'>docStringEmpty</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>MaybeDocStringsFast</span>
<a name="line-359"></a><span class='hs-definition'>docStringEmpty</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>id</span>
<a name="line-360"></a><a name="docStringSingleton"></a><span class='hs-definition'>docStringSingleton</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>HsDocString</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>MaybeDocStringsFast</span>
<a name="line-361"></a><span class='hs-definition'>docStringSingleton</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-conop'>:</span><span class='hs-layout'>)</span>
<a name="line-362"></a><a name="docStringAppend"></a><span class='hs-definition'>docStringAppend</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>MaybeDocStringsFast</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>MaybeDocStringsFast</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>MaybeDocStringsFast</span>
<a name="line-363"></a><span class='hs-definition'>docStringAppend</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varop'>.</span><span class='hs-layout'>)</span>
<a name="line-364"></a><a name="docStringToList"></a><span class='hs-definition'>docStringToList</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>MaybeDocStringsFast</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>MaybeDocStrings</span>
<a name="line-365"></a><span class='hs-definition'>docStringToList</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varop'>$</span> <span class='hs-conid'>[]</span><span class='hs-layout'>)</span>
<a name="line-366"></a>
<a name="line-367"></a><a name="collectDocs"></a><span class='hs-comment'>-- | Collect the docs and attach them to the right declaration.</span>
<a name="line-368"></a><span class='hs-definition'>collectDocs</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Decl</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>Decl</span><span class='hs-layout'>,</span> <span class='hs-conid'>MaybeDocStrings</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-369"></a><span class='hs-definition'>collectDocs</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>collect</span> <span class='hs-conid'>Nothing</span> <span class='hs-varid'>docStringEmpty</span>
<a name="line-370"></a>
<a name="line-371"></a><a name="collect"></a><span class='hs-definition'>collect</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>Decl</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>MaybeDocStringsFast</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Decl</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>Decl</span><span class='hs-layout'>,</span> <span class='hs-conid'>MaybeDocStrings</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-372"></a><span class='hs-definition'>collect</span> <span class='hs-varid'>d</span> <span class='hs-varid'>doc_so_far</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>=</span>
<a name="line-373"></a>   <span class='hs-keyword'>case</span> <span class='hs-varid'>d</span> <span class='hs-keyword'>of</span>
<a name="line-374"></a>        <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>[]</span>
<a name="line-375"></a>        <span class='hs-conid'>Just</span> <span class='hs-varid'>d0</span>  <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>finishedDoc</span> <span class='hs-varid'>d0</span> <span class='hs-varid'>doc_so_far</span> <span class='hs-conid'>[]</span>
<a name="line-376"></a>
<a name="line-377"></a><span class='hs-definition'>collect</span> <span class='hs-varid'>d</span> <span class='hs-varid'>doc_so_far</span> <span class='hs-layout'>(</span><span class='hs-varid'>e</span><span class='hs-conop'>:</span><span class='hs-varid'>es</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span>
<a name="line-378"></a>  <span class='hs-keyword'>case</span> <span class='hs-varid'>e</span> <span class='hs-keyword'>of</span>
<a name="line-379"></a>    <span class='hs-conid'>L</span> <span class='hs-keyword'>_</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocD</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocCommentNext</span> <span class='hs-varid'>str</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-&gt;</span>
<a name="line-380"></a>      <span class='hs-keyword'>case</span> <span class='hs-varid'>d</span> <span class='hs-keyword'>of</span>
<a name="line-381"></a>        <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>collect</span> <span class='hs-varid'>d</span>
<a name="line-382"></a>                     <span class='hs-layout'>(</span><span class='hs-varid'>docStringAppend</span> <span class='hs-varid'>doc_so_far</span> <span class='hs-layout'>(</span><span class='hs-varid'>docStringSingleton</span> <span class='hs-varid'>str</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-383"></a>                     <span class='hs-varid'>es</span>
<a name="line-384"></a>        <span class='hs-conid'>Just</span> <span class='hs-varid'>d0</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>finishedDoc</span> <span class='hs-varid'>d0</span> <span class='hs-varid'>doc_so_far</span> <span class='hs-layout'>(</span><span class='hs-varid'>collect</span> <span class='hs-conid'>Nothing</span>
<a name="line-385"></a>                     <span class='hs-layout'>(</span><span class='hs-varid'>docStringSingleton</span> <span class='hs-varid'>str</span><span class='hs-layout'>)</span>
<a name="line-386"></a>                     <span class='hs-varid'>es</span><span class='hs-layout'>)</span>
<a name="line-387"></a>
<a name="line-388"></a>    <span class='hs-conid'>L</span> <span class='hs-keyword'>_</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocD</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocCommentPrev</span> <span class='hs-varid'>str</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>collect</span> <span class='hs-varid'>d</span>
<a name="line-389"></a>                     <span class='hs-layout'>(</span><span class='hs-varid'>docStringAppend</span> <span class='hs-varid'>doc_so_far</span> <span class='hs-layout'>(</span><span class='hs-varid'>docStringSingleton</span> <span class='hs-varid'>str</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-390"></a>                     <span class='hs-varid'>es</span>
<a name="line-391"></a>
<a name="line-392"></a>    <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>d</span> <span class='hs-keyword'>of</span>
<a name="line-393"></a>      <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>collect</span> <span class='hs-layout'>(</span><span class='hs-conid'>Just</span> <span class='hs-varid'>e</span><span class='hs-layout'>)</span> <span class='hs-varid'>doc_so_far</span> <span class='hs-varid'>es</span>
<a name="line-394"></a>      <span class='hs-conid'>Just</span> <span class='hs-varid'>d0</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>finishedDoc</span> <span class='hs-varid'>d0</span> <span class='hs-varid'>doc_so_far</span> <span class='hs-layout'>(</span><span class='hs-varid'>collect</span> <span class='hs-layout'>(</span><span class='hs-conid'>Just</span> <span class='hs-varid'>e</span><span class='hs-layout'>)</span> <span class='hs-varid'>docStringEmpty</span> <span class='hs-varid'>es</span><span class='hs-layout'>)</span>
<a name="line-395"></a>
<a name="line-396"></a>
<a name="line-397"></a><a name="finishedDoc"></a><span class='hs-comment'>-- This used to delete all DocD:s, unless doc was DocEmpty,</span>
<a name="line-398"></a><span class='hs-comment'>-- which I suppose means you could kill a DocCommentNamed</span>
<a name="line-399"></a><span class='hs-comment'>-- by:</span>
<a name="line-400"></a><span class='hs-comment'>--</span>
<a name="line-401"></a><span class='hs-comment'>-- &gt; -- | killer</span>
<a name="line-402"></a><span class='hs-comment'>-- &gt;</span>
<a name="line-403"></a><span class='hs-comment'>-- &gt; -- $victim</span>
<a name="line-404"></a><span class='hs-comment'>--</span>
<a name="line-405"></a><span class='hs-comment'>-- Anyway I accidentally deleted the DocEmpty condition without</span>
<a name="line-406"></a><span class='hs-comment'>-- realizing it was necessary for retaining some DocDs (at least</span>
<a name="line-407"></a><span class='hs-comment'>-- DocCommentNamed), so I'm going to try just not testing any conditions</span>
<a name="line-408"></a><span class='hs-comment'>-- and see if anything breaks.  It really shouldn't break anything</span>
<a name="line-409"></a><span class='hs-comment'>-- to keep more doc decls around, IMHO.</span>
<a name="line-410"></a><span class='hs-comment'>--</span>
<a name="line-411"></a><span class='hs-comment'>-- -Isaac</span>
<a name="line-412"></a><span class='hs-definition'>finishedDoc</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Decl</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>MaybeDocStringsFast</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>Decl</span><span class='hs-layout'>,</span> <span class='hs-conid'>MaybeDocStrings</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>Decl</span><span class='hs-layout'>,</span> <span class='hs-conid'>MaybeDocStrings</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-413"></a><span class='hs-definition'>finishedDoc</span> <span class='hs-varid'>d</span> <span class='hs-varid'>doc</span> <span class='hs-varid'>rest</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>d</span><span class='hs-layout'>,</span> <span class='hs-varid'>docStringToList</span> <span class='hs-varid'>doc</span><span class='hs-layout'>)</span> <span class='hs-conop'>:</span> <span class='hs-varid'>rest</span>
<a name="line-414"></a>
<a name="line-415"></a>
<a name="line-416"></a><a name="mkExportItems"></a><span class='hs-comment'>-- | Build the list of items that will become the documentation, from the</span>
<a name="line-417"></a><span class='hs-comment'>-- export list.  At this point, the list of ExportItems is in terms of</span>
<a name="line-418"></a><span class='hs-comment'>-- original names.</span>
<a name="line-419"></a><span class='hs-comment'>--</span>
<a name="line-420"></a><span class='hs-comment'>-- We create the export items even if the module is hidden, since they</span>
<a name="line-421"></a><span class='hs-comment'>-- might be useful when creating the export items for other modules.</span>
<a name="line-422"></a><span class='hs-definition'>mkExportItems</span>
<a name="line-423"></a>  <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ModuleMap</span>
<a name="line-424"></a>  <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Module</span>             <span class='hs-comment'>-- this module</span>
<a name="line-425"></a>  <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>GlobalRdrEnv</span>
<a name="line-426"></a>  <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Name</span><span class='hs-keyglyph'>]</span>             <span class='hs-comment'>-- exported names (orig)</span>
<a name="line-427"></a>  <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>DeclInfo</span><span class='hs-keyglyph'>]</span>
<a name="line-428"></a>  <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Map</span> <span class='hs-conid'>Name</span> <span class='hs-conid'>DeclInfo</span>  <span class='hs-comment'>-- maps local names to declarations</span>
<a name="line-429"></a>  <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>DocOption</span><span class='hs-keyglyph'>]</span>
<a name="line-430"></a>  <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Maybe</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>IE</span> <span class='hs-conid'>Name</span><span class='hs-keyglyph'>]</span>
<a name="line-431"></a>  <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Bool</span>               <span class='hs-comment'>-- --ignore-all-exports flag</span>
<a name="line-432"></a>  <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Instance</span><span class='hs-keyglyph'>]</span>
<a name="line-433"></a>  <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>InstIfaceMap</span>
<a name="line-434"></a>  <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>ErrMsgGhc</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>ExportItem</span> <span class='hs-conid'>Name</span><span class='hs-keyglyph'>]</span>
<a name="line-435"></a>
<a name="line-436"></a><span class='hs-definition'>mkExportItems</span> <span class='hs-varid'>modMap</span> <span class='hs-varid'>this_mod</span> <span class='hs-varid'>gre</span> <span class='hs-varid'>exported_names</span> <span class='hs-varid'>decls</span> <span class='hs-varid'>declMap</span>
<a name="line-437"></a>              <span class='hs-varid'>opts</span> <span class='hs-varid'>maybe_exps</span> <span class='hs-varid'>ignore_all_exports</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>instIfaceMap</span>
<a name="line-438"></a>  <span class='hs-keyglyph'>|</span> <span class='hs-varid'>isNothing</span> <span class='hs-varid'>maybe_exps</span> <span class='hs-varop'>||</span> <span class='hs-varid'>ignore_all_exports</span> <span class='hs-varop'>||</span> <span class='hs-conid'>OptIgnoreExports</span> <span class='hs-varop'>`elem`</span> <span class='hs-varid'>opts</span>
<a name="line-439"></a>    <span class='hs-keyglyph'>=</span> <span class='hs-varid'>everything_local_exported</span>
<a name="line-440"></a>  <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>liftM</span> <span class='hs-varid'>concat</span> <span class='hs-varop'>$</span> <span class='hs-varid'>mapM</span> <span class='hs-varid'>lookupExport</span> <span class='hs-layout'>(</span><span class='hs-varid'>fromJust</span> <span class='hs-varid'>maybe_exps</span><span class='hs-layout'>)</span>
<a name="line-441"></a>  <span class='hs-keyword'>where</span>
<a name="line-442"></a>
<a name="line-443"></a>
<a name="line-444"></a>    <span class='hs-varid'>everything_local_exported</span> <span class='hs-keyglyph'>=</span>  <span class='hs-comment'>-- everything exported</span>
<a name="line-445"></a>      <span class='hs-varid'>liftErrMsg</span> <span class='hs-varop'>$</span> <span class='hs-varid'>fullContentsOfThisModule</span> <span class='hs-varid'>gre</span> <span class='hs-varid'>decls</span>
<a name="line-446"></a>
<a name="line-447"></a>
<a name="line-448"></a>    <span class='hs-varid'>lookupExport</span> <span class='hs-layout'>(</span><span class='hs-conid'>IEVar</span> <span class='hs-varid'>x</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>declWith</span> <span class='hs-varid'>x</span>
<a name="line-449"></a>    <span class='hs-varid'>lookupExport</span> <span class='hs-layout'>(</span><span class='hs-conid'>IEThingAbs</span> <span class='hs-varid'>t</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>declWith</span> <span class='hs-varid'>t</span>
<a name="line-450"></a>    <span class='hs-varid'>lookupExport</span> <span class='hs-layout'>(</span><span class='hs-conid'>IEThingAll</span> <span class='hs-varid'>t</span><span class='hs-layout'>)</span>        <span class='hs-keyglyph'>=</span> <span class='hs-varid'>declWith</span> <span class='hs-varid'>t</span>
<a name="line-451"></a>    <span class='hs-varid'>lookupExport</span> <span class='hs-layout'>(</span><span class='hs-conid'>IEThingWith</span> <span class='hs-varid'>t</span> <span class='hs-keyword'>_</span><span class='hs-layout'>)</span>     <span class='hs-keyglyph'>=</span> <span class='hs-varid'>declWith</span> <span class='hs-varid'>t</span>
<a name="line-452"></a>    <span class='hs-varid'>lookupExport</span> <span class='hs-layout'>(</span><span class='hs-conid'>IEModuleContents</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span>  <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fullContentsOf</span> <span class='hs-varid'>m</span>
<a name="line-453"></a>    <span class='hs-varid'>lookupExport</span> <span class='hs-layout'>(</span><span class='hs-conid'>IEGroup</span> <span class='hs-varid'>lev</span> <span class='hs-varid'>docStr</span><span class='hs-layout'>)</span>  <span class='hs-keyglyph'>=</span> <span class='hs-varid'>liftErrMsg</span> <span class='hs-varop'>$</span>
<a name="line-454"></a>      <span class='hs-varid'>ifDoc</span> <span class='hs-layout'>(</span><span class='hs-varid'>lexParseRnHaddockComment</span> <span class='hs-conid'>DocSectionComment</span> <span class='hs-varid'>gre</span> <span class='hs-varid'>docStr</span><span class='hs-layout'>)</span>
<a name="line-455"></a>            <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>doc</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>return</span> <span class='hs-keyglyph'>[</span> <span class='hs-conid'>ExportGroup</span> <span class='hs-varid'>lev</span> <span class='hs-str'>""</span> <span class='hs-varid'>doc</span> <span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span>
<a name="line-456"></a>    <span class='hs-varid'>lookupExport</span> <span class='hs-layout'>(</span><span class='hs-conid'>IEDoc</span> <span class='hs-varid'>docStr</span><span class='hs-layout'>)</span>        <span class='hs-keyglyph'>=</span> <span class='hs-varid'>liftErrMsg</span> <span class='hs-varop'>$</span>
<a name="line-457"></a>      <span class='hs-varid'>ifDoc</span> <span class='hs-layout'>(</span><span class='hs-varid'>lexParseRnHaddockComment</span> <span class='hs-conid'>NormalHaddockComment</span> <span class='hs-varid'>gre</span> <span class='hs-varid'>docStr</span><span class='hs-layout'>)</span>
<a name="line-458"></a>            <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>doc</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>return</span> <span class='hs-keyglyph'>[</span> <span class='hs-conid'>ExportDoc</span> <span class='hs-varid'>doc</span> <span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span>
<a name="line-459"></a>    <span class='hs-varid'>lookupExport</span> <span class='hs-layout'>(</span><span class='hs-conid'>IEDocNamed</span> <span class='hs-varid'>str</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>liftErrMsg</span> <span class='hs-varop'>$</span>
<a name="line-460"></a>      <span class='hs-varid'>ifDoc</span> <span class='hs-layout'>(</span><span class='hs-varid'>findNamedDoc</span> <span class='hs-varid'>str</span> <span class='hs-keyglyph'>[</span> <span class='hs-varid'>unL</span> <span class='hs-varid'>d</span> <span class='hs-keyglyph'>|</span> <span class='hs-layout'>(</span><span class='hs-varid'>d</span><span class='hs-layout'>,</span><span class='hs-keyword'>_</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'>decls</span> <span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span>
<a name="line-461"></a>            <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>docStr</span> <span class='hs-keyglyph'>-&gt;</span>
<a name="line-462"></a>            <span class='hs-varid'>ifDoc</span> <span class='hs-layout'>(</span><span class='hs-varid'>lexParseRnHaddockComment</span> <span class='hs-conid'>NormalHaddockComment</span> <span class='hs-varid'>gre</span> <span class='hs-varid'>docStr</span><span class='hs-layout'>)</span>
<a name="line-463"></a>                  <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>doc</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>return</span> <span class='hs-keyglyph'>[</span> <span class='hs-conid'>ExportDoc</span> <span class='hs-varid'>doc</span> <span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-464"></a>
<a name="line-465"></a>
<a name="line-466"></a>    <span class='hs-varid'>ifDoc</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Monad</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=&gt;</span> <span class='hs-varid'>m</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-layout'>(</span><span class='hs-varid'>a</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>b</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>b</span><span class='hs-keyglyph'>]</span>
<a name="line-467"></a>    <span class='hs-varid'>ifDoc</span> <span class='hs-varid'>parse</span> <span class='hs-varid'>finish</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-468"></a>      <span class='hs-varid'>mbDoc</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>parse</span>
<a name="line-469"></a>      <span class='hs-keyword'>case</span> <span class='hs-varid'>mbDoc</span> <span class='hs-keyword'>of</span> <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>return</span> <span class='hs-conid'>[]</span><span class='hs-layout'>;</span> <span class='hs-conid'>Just</span> <span class='hs-varid'>doc</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>finish</span> <span class='hs-varid'>doc</span>
<a name="line-470"></a>
<a name="line-471"></a>
<a name="line-472"></a>    <span class='hs-varid'>declWith</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Name</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>ErrMsgGhc</span> <span class='hs-keyglyph'>[</span> <span class='hs-conid'>ExportItem</span> <span class='hs-conid'>Name</span> <span class='hs-keyglyph'>]</span>
<a name="line-473"></a>    <span class='hs-varid'>declWith</span> <span class='hs-varid'>t</span> <span class='hs-keyglyph'>=</span>
<a name="line-474"></a>      <span class='hs-keyword'>case</span> <span class='hs-varid'>findDecl</span> <span class='hs-varid'>t</span> <span class='hs-keyword'>of</span>
<a name="line-475"></a>        <span class='hs-conid'>Just</span> <span class='hs-varid'>x</span><span class='hs-keyglyph'>@</span><span class='hs-layout'>(</span><span class='hs-varid'>decl</span><span class='hs-layout'>,</span><span class='hs-keyword'>_</span><span class='hs-layout'>,</span><span class='hs-keyword'>_</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-&gt;</span>
<a name="line-476"></a>          <span class='hs-keyword'>let</span> <span class='hs-varid'>declName_</span> <span class='hs-keyglyph'>=</span>
<a name="line-477"></a>                <span class='hs-keyword'>case</span> <span class='hs-varid'>getMainDeclBinder</span> <span class='hs-layout'>(</span><span class='hs-varid'>unL</span> <span class='hs-varid'>decl</span><span class='hs-layout'>)</span> <span class='hs-keyword'>of</span>
<a name="line-478"></a>                  <span class='hs-conid'>Just</span> <span class='hs-varid'>n</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>n</span>
<a name="line-479"></a>                  <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>error</span> <span class='hs-str'>"declWith: should not happen"</span>
<a name="line-480"></a>          <span class='hs-keyword'>in</span> <span class='hs-keyword'>case</span> <span class='hs-conid'>()</span> <span class='hs-keyword'>of</span>
<a name="line-481"></a>            <span class='hs-keyword'>_</span>
<a name="line-482"></a>              <span class='hs-comment'>-- temp hack: we filter out separately exported ATs, since we haven't decided how</span>
<a name="line-483"></a>              <span class='hs-comment'>-- to handle them yet. We should really give an warning message also, and filter the</span>
<a name="line-484"></a>              <span class='hs-comment'>-- name out in mkVisibleNames...</span>
<a name="line-485"></a>              <span class='hs-keyglyph'>|</span> <span class='hs-varid'>t</span> <span class='hs-varop'>`elem`</span> <span class='hs-varid'>declATs</span> <span class='hs-layout'>(</span><span class='hs-varid'>unL</span> <span class='hs-varid'>decl</span><span class='hs-layout'>)</span>        <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>return</span> <span class='hs-conid'>[]</span>
<a name="line-486"></a>
<a name="line-487"></a>              <span class='hs-comment'>-- We should not show a subordinate by itself if any of its</span>
<a name="line-488"></a>              <span class='hs-comment'>-- parents is also exported. See note [1].</span>
<a name="line-489"></a>              <span class='hs-keyglyph'>|</span> <span class='hs-varid'>t</span> <span class='hs-varop'>/=</span> <span class='hs-varid'>declName_</span><span class='hs-layout'>,</span>
<a name="line-490"></a>                <span class='hs-conid'>Just</span> <span class='hs-varid'>p</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>find</span> <span class='hs-varid'>isExported</span> <span class='hs-layout'>(</span><span class='hs-varid'>parents</span> <span class='hs-varid'>t</span> <span class='hs-varop'>$</span> <span class='hs-varid'>unL</span> <span class='hs-varid'>decl</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-&gt;</span>
<a name="line-491"></a>                <span class='hs-keyword'>do</span> <span class='hs-varid'>liftErrMsg</span> <span class='hs-varop'>$</span> <span class='hs-varid'>tell</span> <span class='hs-keyglyph'>[</span>
<a name="line-492"></a>                     <span class='hs-str'>"Warning: "</span> <span class='hs-varop'>++</span> <span class='hs-varid'>moduleString</span> <span class='hs-varid'>this_mod</span> <span class='hs-varop'>++</span> <span class='hs-str'>": "</span> <span class='hs-varop'>++</span>
<a name="line-493"></a>                     <span class='hs-varid'>pretty</span> <span class='hs-layout'>(</span><span class='hs-varid'>nameOccName</span> <span class='hs-varid'>t</span><span class='hs-layout'>)</span> <span class='hs-varop'>++</span> <span class='hs-str'>" is exported separately but "</span> <span class='hs-varop'>++</span>
<a name="line-494"></a>                     <span class='hs-str'>"will be documented under "</span> <span class='hs-varop'>++</span> <span class='hs-varid'>pretty</span> <span class='hs-layout'>(</span><span class='hs-varid'>nameOccName</span> <span class='hs-varid'>p</span><span class='hs-layout'>)</span> <span class='hs-varop'>++</span>
<a name="line-495"></a>                     <span class='hs-str'>". Consider exporting it together with its parent(s)"</span> <span class='hs-varop'>++</span>
<a name="line-496"></a>                     <span class='hs-str'>" for code clarity."</span> <span class='hs-keyglyph'>]</span>
<a name="line-497"></a>                   <span class='hs-varid'>return</span> <span class='hs-conid'>[]</span>
<a name="line-498"></a>
<a name="line-499"></a>              <span class='hs-comment'>-- normal case</span>
<a name="line-500"></a>              <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span>                          <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>return</span> <span class='hs-keyglyph'>[</span> <span class='hs-varid'>mkExportDecl</span> <span class='hs-varid'>t</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>]</span>
<a name="line-501"></a>        <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyword'>do</span>
<a name="line-502"></a>          <span class='hs-comment'>-- If we can't find the declaration, it must belong to</span>
<a name="line-503"></a>          <span class='hs-comment'>-- another package</span>
<a name="line-504"></a>          <span class='hs-varid'>mbTyThing</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>liftGhcToErrMsgGhc</span> <span class='hs-varop'>$</span> <span class='hs-varid'>lookupName</span> <span class='hs-varid'>t</span>
<a name="line-505"></a>          <span class='hs-comment'>-- show the name as exported as well as the name's</span>
<a name="line-506"></a>          <span class='hs-comment'>-- defining module (because the latter is where we</span>
<a name="line-507"></a>          <span class='hs-comment'>-- looked for the .hi/.haddock).  It's to help people</span>
<a name="line-508"></a>          <span class='hs-comment'>-- debugging after all, so good to show more info.</span>
<a name="line-509"></a>          <span class='hs-keyword'>let</span> <span class='hs-varid'>exportInfoString</span> <span class='hs-keyglyph'>=</span>
<a name="line-510"></a>                         <span class='hs-varid'>moduleString</span> <span class='hs-varid'>this_mod</span> <span class='hs-varop'>++</span> <span class='hs-str'>"."</span> <span class='hs-varop'>++</span> <span class='hs-varid'>getOccString</span> <span class='hs-varid'>t</span>
<a name="line-511"></a>                      <span class='hs-varop'>++</span> <span class='hs-str'>": "</span>
<a name="line-512"></a>                      <span class='hs-varop'>++</span> <span class='hs-varid'>pretty</span> <span class='hs-layout'>(</span><span class='hs-varid'>nameModule</span> <span class='hs-varid'>t</span><span class='hs-layout'>)</span> <span class='hs-varop'>++</span> <span class='hs-str'>"."</span> <span class='hs-varop'>++</span> <span class='hs-varid'>getOccString</span> <span class='hs-varid'>t</span>
<a name="line-513"></a>
<a name="line-514"></a>          <span class='hs-keyword'>case</span> <span class='hs-varid'>mbTyThing</span> <span class='hs-keyword'>of</span>
<a name="line-515"></a>            <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyword'>do</span>
<a name="line-516"></a>              <span class='hs-varid'>liftErrMsg</span> <span class='hs-varop'>$</span> <span class='hs-varid'>tell</span>
<a name="line-517"></a>                 <span class='hs-keyglyph'>[</span><span class='hs-str'>"Warning: Couldn't find TyThing for exported "</span>
<a name="line-518"></a>                 <span class='hs-varop'>++</span> <span class='hs-varid'>exportInfoString</span> <span class='hs-varop'>++</span> <span class='hs-str'>"; not documenting."</span><span class='hs-keyglyph'>]</span>
<a name="line-519"></a>              <span class='hs-comment'>-- Is getting to here a bug in Haddock?</span>
<a name="line-520"></a>              <span class='hs-comment'>-- Aren't the .hi files always present?</span>
<a name="line-521"></a>              <span class='hs-varid'>return</span> <span class='hs-keyglyph'>[</span> <span class='hs-conid'>ExportNoDecl</span> <span class='hs-varid'>t</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>]</span>
<a name="line-522"></a>            <span class='hs-conid'>Just</span> <span class='hs-varid'>tyThing</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyword'>do</span>
<a name="line-523"></a>              <span class='hs-keyword'>let</span> <span class='hs-varid'>hsdecl</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>tyThingToLHsDecl</span> <span class='hs-varid'>tyThing</span>
<a name="line-524"></a>              <span class='hs-comment'>-- This is not the ideal way to implement haddockumentation</span>
<a name="line-525"></a>              <span class='hs-comment'>-- for functions/values without explicit type signatures.</span>
<a name="line-526"></a>              <span class='hs-comment'>--</span>
<a name="line-527"></a>              <span class='hs-comment'>-- However I didn't find an easy way to implement it properly,</span>
<a name="line-528"></a>              <span class='hs-comment'>-- and as long as we're using lookupName it is going to find</span>
<a name="line-529"></a>              <span class='hs-comment'>-- the types of local inferenced binds.  If we don't check for</span>
<a name="line-530"></a>              <span class='hs-comment'>-- this at all, then we'll get the "warning: couldn't find</span>
<a name="line-531"></a>              <span class='hs-comment'>-- .haddock" which is wrong.</span>
<a name="line-532"></a>              <span class='hs-comment'>--</span>
<a name="line-533"></a>              <span class='hs-comment'>-- The reason this is not an ideal implementation</span>
<a name="line-534"></a>              <span class='hs-comment'>-- (besides that we take a trip to desugared syntax and back</span>
<a name="line-535"></a>              <span class='hs-comment'>-- unnecessarily)</span>
<a name="line-536"></a>              <span class='hs-comment'>-- is that Haddock won't be able to detect doc-strings being</span>
<a name="line-537"></a>              <span class='hs-comment'>-- attached to such a function, such as,</span>
<a name="line-538"></a>              <span class='hs-comment'>--</span>
<a name="line-539"></a>              <span class='hs-comment'>-- &gt; -- | this is an identity function</span>
<a name="line-540"></a>              <span class='hs-comment'>-- &gt; id a = a</span>
<a name="line-541"></a>              <span class='hs-comment'>--</span>
<a name="line-542"></a>              <span class='hs-comment'>-- . It's more difficult to say what it ought to mean in cases</span>
<a name="line-543"></a>              <span class='hs-comment'>-- where multiple exports are bound at once, like</span>
<a name="line-544"></a>              <span class='hs-comment'>--</span>
<a name="line-545"></a>              <span class='hs-comment'>-- &gt; -- | comment...</span>
<a name="line-546"></a>              <span class='hs-comment'>-- &gt; (a, b) = ...</span>
<a name="line-547"></a>              <span class='hs-comment'>--</span>
<a name="line-548"></a>              <span class='hs-comment'>-- especially since in the export-list they might not even</span>
<a name="line-549"></a>              <span class='hs-comment'>-- be next to each other.  But a proper implementation would</span>
<a name="line-550"></a>              <span class='hs-comment'>-- really need to find the type of *all* exports as well as</span>
<a name="line-551"></a>              <span class='hs-comment'>-- addressing all these issues.  This implementation works</span>
<a name="line-552"></a>              <span class='hs-comment'>-- adequately.  Do you see a way to improve the situation?</span>
<a name="line-553"></a>              <span class='hs-comment'>-- Please go ahead!  I got stuck trying to figure out how to</span>
<a name="line-554"></a>              <span class='hs-comment'>-- get the 'PostTcType's that we want for all the bindings</span>
<a name="line-555"></a>              <span class='hs-comment'>-- of an HsBind (you get 'LHsBinds' from 'GHC.typecheckedSource'</span>
<a name="line-556"></a>              <span class='hs-comment'>-- for example).</span>
<a name="line-557"></a>              <span class='hs-comment'>--</span>
<a name="line-558"></a>              <span class='hs-comment'>-- But I might be missing something obvious.  What's important</span>
<a name="line-559"></a>              <span class='hs-comment'>-- /here/ is that we behave reasonably when we run into one of</span>
<a name="line-560"></a>              <span class='hs-comment'>-- those exported type-inferenced values.</span>
<a name="line-561"></a>              <span class='hs-varid'>isLocalAndTypeInferenced</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>liftGhcToErrMsgGhc</span> <span class='hs-varop'>$</span>
<a name="line-562"></a>                    <span class='hs-varid'>isLoaded</span> <span class='hs-layout'>(</span><span class='hs-varid'>moduleName</span> <span class='hs-layout'>(</span><span class='hs-varid'>nameModule</span> <span class='hs-varid'>t</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-563"></a>              <span class='hs-keyword'>if</span> <span class='hs-varid'>isLocalAndTypeInferenced</span>
<a name="line-564"></a>               <span class='hs-keyword'>then</span> <span class='hs-keyword'>do</span>
<a name="line-565"></a>                   <span class='hs-comment'>-- I don't think there can be any subs in this case,</span>
<a name="line-566"></a>                   <span class='hs-comment'>-- currently?  But better not to rely on it.</span>
<a name="line-567"></a>                   <span class='hs-keyword'>let</span> <span class='hs-varid'>subs</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>subordinatesWithNoDocs</span> <span class='hs-layout'>(</span><span class='hs-varid'>unLoc</span> <span class='hs-varid'>hsdecl</span><span class='hs-layout'>)</span>
<a name="line-568"></a>                   <span class='hs-varid'>return</span> <span class='hs-keyglyph'>[</span> <span class='hs-varid'>mkExportDecl</span> <span class='hs-varid'>t</span> <span class='hs-layout'>(</span><span class='hs-varid'>hsdecl</span><span class='hs-layout'>,</span> <span class='hs-varid'>noDocForDecl</span><span class='hs-layout'>,</span> <span class='hs-varid'>subs</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>]</span>
<a name="line-569"></a>               <span class='hs-keyword'>else</span>
<a name="line-570"></a>              <span class='hs-comment'>-- We try to get the subs and docs</span>
<a name="line-571"></a>              <span class='hs-comment'>-- from the installed interface of that package.</span>
<a name="line-572"></a>               <span class='hs-keyword'>case</span> <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>lookup</span> <span class='hs-layout'>(</span><span class='hs-varid'>nameModule</span> <span class='hs-varid'>t</span><span class='hs-layout'>)</span> <span class='hs-varid'>instIfaceMap</span> <span class='hs-keyword'>of</span>
<a name="line-573"></a>                <span class='hs-comment'>-- It's Nothing in the cases where I thought</span>
<a name="line-574"></a>                <span class='hs-comment'>-- Haddock has already warned the user: "Warning: The</span>
<a name="line-575"></a>                <span class='hs-comment'>-- documentation for the following packages are not</span>
<a name="line-576"></a>                <span class='hs-comment'>-- installed. No links will be generated to these packages:</span>
<a name="line-577"></a>                <span class='hs-comment'>-- ..."</span>
<a name="line-578"></a>                <span class='hs-comment'>-- But I guess it was Cabal creating that warning. Anyway,</span>
<a name="line-579"></a>                <span class='hs-comment'>-- this is more serious than links: it's exported decls where</span>
<a name="line-580"></a>                <span class='hs-comment'>-- we don't have the docs that they deserve!</span>
<a name="line-581"></a>
<a name="line-582"></a>                <span class='hs-comment'>-- We could use 'subordinates' to find the Names of the subs</span>
<a name="line-583"></a>                <span class='hs-comment'>-- (with no docs). Is that necessary? Yes it is, otherwise</span>
<a name="line-584"></a>                <span class='hs-comment'>-- e.g. classes will be shown without their exported subs.</span>
<a name="line-585"></a>                <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyword'>do</span>
<a name="line-586"></a>                   <span class='hs-varid'>liftErrMsg</span> <span class='hs-varop'>$</span> <span class='hs-varid'>tell</span>
<a name="line-587"></a>                      <span class='hs-keyglyph'>[</span><span class='hs-str'>"Warning: Couldn't find .haddock for exported "</span>
<a name="line-588"></a>                      <span class='hs-varop'>++</span> <span class='hs-varid'>exportInfoString</span><span class='hs-keyglyph'>]</span>
<a name="line-589"></a>                   <span class='hs-keyword'>let</span> <span class='hs-varid'>subs</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>subordinatesWithNoDocs</span> <span class='hs-layout'>(</span><span class='hs-varid'>unLoc</span> <span class='hs-varid'>hsdecl</span><span class='hs-layout'>)</span>
<a name="line-590"></a>                   <span class='hs-varid'>return</span> <span class='hs-keyglyph'>[</span> <span class='hs-varid'>mkExportDecl</span> <span class='hs-varid'>t</span> <span class='hs-layout'>(</span><span class='hs-varid'>hsdecl</span><span class='hs-layout'>,</span> <span class='hs-varid'>noDocForDecl</span><span class='hs-layout'>,</span> <span class='hs-varid'>subs</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>]</span>
<a name="line-591"></a>                <span class='hs-conid'>Just</span> <span class='hs-varid'>iface</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyword'>do</span>
<a name="line-592"></a>                   <span class='hs-keyword'>let</span> <span class='hs-varid'>subs</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>case</span> <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>lookup</span> <span class='hs-varid'>t</span> <span class='hs-layout'>(</span><span class='hs-varid'>instSubMap</span> <span class='hs-varid'>iface</span><span class='hs-layout'>)</span> <span class='hs-keyword'>of</span>
<a name="line-593"></a>                           <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>[]</span>
<a name="line-594"></a>                           <span class='hs-conid'>Just</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>x</span>
<a name="line-595"></a>                   <span class='hs-varid'>return</span> <span class='hs-keyglyph'>[</span> <span class='hs-varid'>mkExportDecl</span> <span class='hs-varid'>t</span>
<a name="line-596"></a>                     <span class='hs-layout'>(</span> <span class='hs-varid'>hsdecl</span>
<a name="line-597"></a>                     <span class='hs-layout'>,</span> <span class='hs-varid'>fromMaybe</span> <span class='hs-varid'>noDocForDecl</span> <span class='hs-varop'>$</span>
<a name="line-598"></a>                          <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>lookup</span> <span class='hs-varid'>t</span> <span class='hs-layout'>(</span><span class='hs-varid'>instDocMap</span> <span class='hs-varid'>iface</span><span class='hs-layout'>)</span>
<a name="line-599"></a>                     <span class='hs-layout'>,</span> <span class='hs-varid'>map</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>subt</span> <span class='hs-keyglyph'>-&gt;</span>
<a name="line-600"></a>                              <span class='hs-layout'>(</span> <span class='hs-varid'>subt</span> <span class='hs-layout'>,</span>
<a name="line-601"></a>                                <span class='hs-varid'>fromMaybe</span> <span class='hs-varid'>noDocForDecl</span> <span class='hs-varop'>$</span>
<a name="line-602"></a>                                   <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>lookup</span> <span class='hs-varid'>subt</span> <span class='hs-layout'>(</span><span class='hs-varid'>instDocMap</span> <span class='hs-varid'>iface</span><span class='hs-layout'>)</span>
<a name="line-603"></a>                              <span class='hs-layout'>)</span>
<a name="line-604"></a>                           <span class='hs-layout'>)</span> <span class='hs-varid'>subs</span>
<a name="line-605"></a>                     <span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-606"></a>
<a name="line-607"></a>
<a name="line-608"></a>    <span class='hs-varid'>mkExportDecl</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Name</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>DeclInfo</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>ExportItem</span> <span class='hs-conid'>Name</span>
<a name="line-609"></a>    <span class='hs-varid'>mkExportDecl</span> <span class='hs-varid'>n</span> <span class='hs-layout'>(</span><span class='hs-varid'>decl</span><span class='hs-layout'>,</span> <span class='hs-varid'>doc</span><span class='hs-layout'>,</span> <span class='hs-varid'>subs</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>decl'</span>
<a name="line-610"></a>      <span class='hs-keyword'>where</span>
<a name="line-611"></a>        <span class='hs-varid'>decl'</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>ExportDecl</span> <span class='hs-layout'>(</span><span class='hs-varid'>restrictTo</span> <span class='hs-varid'>sub_names</span> <span class='hs-layout'>(</span><span class='hs-varid'>extractDecl</span> <span class='hs-varid'>n</span> <span class='hs-varid'>mdl</span> <span class='hs-varid'>decl</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-varid'>doc</span> <span class='hs-varid'>subs'</span> <span class='hs-conid'>[]</span>
<a name="line-612"></a>        <span class='hs-varid'>mdl</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>nameModule</span> <span class='hs-varid'>n</span>
<a name="line-613"></a>        <span class='hs-varid'>subs'</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>filter</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-varop'>`elem`</span> <span class='hs-varid'>exported_names</span><span class='hs-layout'>)</span> <span class='hs-varop'>.</span> <span class='hs-varid'>fst</span><span class='hs-layout'>)</span> <span class='hs-varid'>subs</span>
<a name="line-614"></a>        <span class='hs-varid'>sub_names</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>map</span> <span class='hs-varid'>fst</span> <span class='hs-varid'>subs'</span>
<a name="line-615"></a>
<a name="line-616"></a>
<a name="line-617"></a>    <span class='hs-varid'>isExported</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varop'>`elem`</span> <span class='hs-varid'>exported_names</span><span class='hs-layout'>)</span>
<a name="line-618"></a>
<a name="line-619"></a>
<a name="line-620"></a>    <span class='hs-varid'>fullContentsOf</span> <span class='hs-varid'>modname</span>
<a name="line-621"></a>      <span class='hs-keyglyph'>|</span> <span class='hs-varid'>m</span> <span class='hs-varop'>==</span> <span class='hs-varid'>this_mod</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>liftErrMsg</span> <span class='hs-varop'>$</span> <span class='hs-varid'>fullContentsOfThisModule</span> <span class='hs-varid'>gre</span> <span class='hs-varid'>decls</span>
<a name="line-622"></a>      <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span> <span class='hs-keyglyph'>=</span>
<a name="line-623"></a>          <span class='hs-keyword'>case</span> <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>lookup</span> <span class='hs-varid'>m</span> <span class='hs-varid'>modMap</span> <span class='hs-keyword'>of</span>
<a name="line-624"></a>            <span class='hs-conid'>Just</span> <span class='hs-varid'>iface</span>
<a name="line-625"></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'>-&gt;</span> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-varid'>ifaceExportItems</span> <span class='hs-varid'>iface</span><span class='hs-layout'>)</span>
<a name="line-626"></a>              <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>return</span> <span class='hs-keyglyph'>[</span> <span class='hs-conid'>ExportModule</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>]</span>
<a name="line-627"></a>
<a name="line-628"></a>            <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-comment'>-- we have to try to find it in the installed interfaces</span>
<a name="line-629"></a>                       <span class='hs-comment'>-- (external packages)</span>
<a name="line-630"></a>              <span class='hs-keyword'>case</span> <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>lookup</span> <span class='hs-varid'>modname</span> <span class='hs-layout'>(</span><span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>mapKeys</span> <span class='hs-varid'>moduleName</span> <span class='hs-varid'>instIfaceMap</span><span class='hs-layout'>)</span> <span class='hs-keyword'>of</span>
<a name="line-631"></a>                <span class='hs-conid'>Just</span> <span class='hs-varid'>iface</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>return</span> <span class='hs-keyglyph'>[</span> <span class='hs-conid'>ExportModule</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-keyglyph'>]</span>
<a name="line-632"></a>                <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyword'>do</span>
<a name="line-633"></a>                  <span class='hs-varid'>liftErrMsg</span> <span class='hs-varop'>$</span>
<a name="line-634"></a>                    <span class='hs-varid'>tell</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"Warning: "</span> <span class='hs-varop'>++</span> <span class='hs-varid'>pretty</span> <span class='hs-varid'>this_mod</span> <span class='hs-varop'>++</span> <span class='hs-str'>": Could not find "</span> <span class='hs-varop'>++</span>
<a name="line-635"></a>                          <span class='hs-str'>"documentation for exported module: "</span> <span class='hs-varop'>++</span> <span class='hs-varid'>pretty</span> <span class='hs-varid'>modname</span><span class='hs-keyglyph'>]</span>
<a name="line-636"></a>                  <span class='hs-varid'>return</span> <span class='hs-conid'>[]</span>
<a name="line-637"></a>      <span class='hs-keyword'>where</span>
<a name="line-638"></a>        <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mkModule</span> <span class='hs-varid'>packageId</span> <span class='hs-varid'>modname</span>
<a name="line-639"></a>        <span class='hs-varid'>packageId</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>modulePackageId</span> <span class='hs-varid'>this_mod</span>
<a name="line-640"></a>
<a name="line-641"></a>
<a name="line-642"></a>    <span class='hs-varid'>findDecl</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Name</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>DeclInfo</span>
<a name="line-643"></a>    <span class='hs-varid'>findDecl</span> <span class='hs-varid'>n</span>
<a name="line-644"></a>      <span class='hs-keyglyph'>|</span> <span class='hs-varid'>m</span> <span class='hs-varop'>==</span> <span class='hs-varid'>this_mod</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>lookup</span> <span class='hs-varid'>n</span> <span class='hs-varid'>declMap</span>
<a name="line-645"></a>      <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>case</span> <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>lookup</span> <span class='hs-varid'>m</span> <span class='hs-varid'>modMap</span> <span class='hs-keyword'>of</span>
<a name="line-646"></a>                      <span class='hs-conid'>Just</span> <span class='hs-varid'>iface</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>lookup</span> <span class='hs-varid'>n</span> <span class='hs-layout'>(</span><span class='hs-varid'>ifaceDeclMap</span> <span class='hs-varid'>iface</span><span class='hs-layout'>)</span>
<a name="line-647"></a>                      <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Nothing</span>
<a name="line-648"></a>      <span class='hs-keyword'>where</span>
<a name="line-649"></a>        <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>nameModule</span> <span class='hs-varid'>n</span>
<a name="line-650"></a>
<a name="line-651"></a>
<a name="line-652"></a><span class='hs-comment'>-- Note [1]:</span>
<a name="line-653"></a><span class='hs-comment'>------------</span>
<a name="line-654"></a><span class='hs-comment'>-- It is unnecessary to document a subordinate by itself at the top level if</span>
<a name="line-655"></a><span class='hs-comment'>-- any of its parents is also documented. Furthermore, if the subordinate is a</span>
<a name="line-656"></a><span class='hs-comment'>-- record field or a class method, documenting it under its parent</span>
<a name="line-657"></a><span class='hs-comment'>-- indicates its special status.</span>
<a name="line-658"></a><span class='hs-comment'>--</span>
<a name="line-659"></a><span class='hs-comment'>-- A user might expect that it should show up separately, so we issue a</span>
<a name="line-660"></a><span class='hs-comment'>-- warning. It's a fine opportunity to also tell the user she might want to</span>
<a name="line-661"></a><span class='hs-comment'>-- export the subordinate through the parent export item for clarity.</span>
<a name="line-662"></a><span class='hs-comment'>--</span>
<a name="line-663"></a><span class='hs-comment'>-- The code removes top-level subordinates also when the parent is exported</span>
<a name="line-664"></a><span class='hs-comment'>-- through a 'module' export. I think that is fine.</span>
<a name="line-665"></a><span class='hs-comment'>--</span>
<a name="line-666"></a><span class='hs-comment'>-- (For more information, see Trac #69)</span>
<a name="line-667"></a>
<a name="line-668"></a>
<a name="line-669"></a><a name="fullContentsOfThisModule"></a><span class='hs-definition'>fullContentsOfThisModule</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>GlobalRdrEnv</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>DeclInfo</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>ErrMsgM</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>ExportItem</span> <span class='hs-conid'>Name</span><span class='hs-keyglyph'>]</span>
<a name="line-670"></a><span class='hs-definition'>fullContentsOfThisModule</span> <span class='hs-varid'>gre</span> <span class='hs-varid'>decls</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>liftM</span> <span class='hs-varid'>catMaybes</span> <span class='hs-varop'>$</span> <span class='hs-varid'>mapM</span> <span class='hs-varid'>mkExportItem</span> <span class='hs-varid'>decls</span>
<a name="line-671"></a>  <span class='hs-keyword'>where</span>
<a name="line-672"></a>    <span class='hs-varid'>mkExportItem</span> <span class='hs-layout'>(</span><span class='hs-conid'>L</span> <span class='hs-keyword'>_</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocD</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocGroup</span> <span class='hs-varid'>lev</span> <span class='hs-varid'>docStr</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-keyword'>_</span><span class='hs-layout'>,</span> <span class='hs-keyword'>_</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-673"></a>        <span class='hs-varid'>mbDoc</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>lexParseRnHaddockComment</span> <span class='hs-conid'>DocSectionComment</span> <span class='hs-varid'>gre</span> <span class='hs-varid'>docStr</span>
<a name="line-674"></a>        <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-varid'>fmap</span> <span class='hs-layout'>(</span><span class='hs-conid'>ExportGroup</span> <span class='hs-varid'>lev</span> <span class='hs-str'>""</span><span class='hs-layout'>)</span> <span class='hs-varid'>mbDoc</span>
<a name="line-675"></a>    <span class='hs-varid'>mkExportItem</span> <span class='hs-layout'>(</span><span class='hs-conid'>L</span> <span class='hs-keyword'>_</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocD</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocCommentNamed</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>docStr</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-keyword'>_</span><span class='hs-layout'>,</span> <span class='hs-keyword'>_</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-676"></a>        <span class='hs-varid'>mbDoc</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>lexParseRnHaddockComment</span> <span class='hs-conid'>NormalHaddockComment</span> <span class='hs-varid'>gre</span> <span class='hs-varid'>docStr</span>
<a name="line-677"></a>        <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-varid'>fmap</span> <span class='hs-conid'>ExportDoc</span> <span class='hs-varid'>mbDoc</span>
<a name="line-678"></a>    <span class='hs-varid'>mkExportItem</span> <span class='hs-layout'>(</span><span class='hs-varid'>decl</span><span class='hs-layout'>,</span> <span class='hs-varid'>doc</span><span class='hs-layout'>,</span> <span class='hs-varid'>subs</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Just</span> <span class='hs-varop'>$</span> <span class='hs-conid'>ExportDecl</span> <span class='hs-varid'>decl</span> <span class='hs-varid'>doc</span> <span class='hs-varid'>subs</span> <span class='hs-conid'>[]</span>
<a name="line-679"></a>
<a name="line-680"></a>
<a name="line-681"></a><a name="extractDecl"></a><span class='hs-comment'>-- | Sometimes the declaration we want to export is not the "main" declaration:</span>
<a name="line-682"></a><span class='hs-comment'>-- it might be an individual record selector or a class method.  In these</span>
<a name="line-683"></a><span class='hs-comment'>-- cases we have to extract the required declaration (and somehow cobble</span>
<a name="line-684"></a><span class='hs-comment'>-- together a type signature for it...)</span>
<a name="line-685"></a><span class='hs-definition'>extractDecl</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Name</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Module</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Decl</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Decl</span>
<a name="line-686"></a><span class='hs-definition'>extractDecl</span> <span class='hs-varid'>name</span> <span class='hs-varid'>mdl</span> <span class='hs-varid'>decl</span>
<a name="line-687"></a>  <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Just</span> <span class='hs-varid'>n</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>getMainDeclBinder</span> <span class='hs-layout'>(</span><span class='hs-varid'>unLoc</span> <span class='hs-varid'>decl</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>n</span> <span class='hs-varop'>==</span> <span class='hs-varid'>name</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>decl</span>
<a name="line-688"></a>  <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span>  <span class='hs-keyglyph'>=</span>
<a name="line-689"></a>    <span class='hs-keyword'>case</span> <span class='hs-varid'>unLoc</span> <span class='hs-varid'>decl</span> <span class='hs-keyword'>of</span>
<a name="line-690"></a>      <span class='hs-conid'>TyClD</span> <span class='hs-varid'>d</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>isClassDecl</span> <span class='hs-varid'>d</span> <span class='hs-keyglyph'>-&gt;</span>
<a name="line-691"></a>        <span class='hs-keyword'>let</span> <span class='hs-varid'>matches</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>[</span> <span class='hs-varid'>sig</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>sig</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>tcdSigs</span> <span class='hs-varid'>d</span><span class='hs-layout'>,</span> <span class='hs-varid'>sigName</span> <span class='hs-varid'>sig</span> <span class='hs-varop'>==</span> <span class='hs-conid'>Just</span> <span class='hs-varid'>name</span><span class='hs-layout'>,</span>
<a name="line-692"></a>                        <span class='hs-varid'>isVanillaLSig</span> <span class='hs-varid'>sig</span> <span class='hs-keyglyph'>]</span> <span class='hs-comment'>-- TODO: document fixity</span>
<a name="line-693"></a>        <span class='hs-keyword'>in</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>matches</span> <span class='hs-keyword'>of</span>
<a name="line-694"></a>          <span class='hs-keyglyph'>[</span><span class='hs-varid'>s0</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyword'>let</span> <span class='hs-layout'>(</span><span class='hs-varid'>n</span><span class='hs-layout'>,</span> <span class='hs-varid'>tyvar_names</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>name_and_tyvars</span> <span class='hs-varid'>d</span>
<a name="line-695"></a>                      <span class='hs-conid'>L</span> <span class='hs-varid'>pos</span> <span class='hs-varid'>sig</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>extractClassDecl</span> <span class='hs-varid'>n</span> <span class='hs-varid'>tyvar_names</span> <span class='hs-varid'>s0</span>
<a name="line-696"></a>                  <span class='hs-keyword'>in</span> <span class='hs-conid'>L</span> <span class='hs-varid'>pos</span> <span class='hs-layout'>(</span><span class='hs-conid'>SigD</span> <span class='hs-varid'>sig</span><span class='hs-layout'>)</span>
<a name="line-697"></a>          <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>error</span> <span class='hs-str'>"internal: extractDecl"</span>
<a name="line-698"></a>      <span class='hs-conid'>TyClD</span> <span class='hs-varid'>d</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>isDataDecl</span> <span class='hs-varid'>d</span> <span class='hs-keyglyph'>-&gt;</span>
<a name="line-699"></a>        <span class='hs-keyword'>let</span> <span class='hs-layout'>(</span><span class='hs-varid'>n</span><span class='hs-layout'>,</span> <span class='hs-varid'>tyvar_names</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>name_and_tyvars</span> <span class='hs-varid'>d</span>
<a name="line-700"></a>            <span class='hs-conid'>L</span> <span class='hs-varid'>pos</span> <span class='hs-varid'>sig</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>extractRecSel</span> <span class='hs-varid'>name</span> <span class='hs-varid'>mdl</span> <span class='hs-varid'>n</span> <span class='hs-varid'>tyvar_names</span> <span class='hs-layout'>(</span><span class='hs-varid'>tcdCons</span> <span class='hs-varid'>d</span><span class='hs-layout'>)</span>
<a name="line-701"></a>        <span class='hs-keyword'>in</span> <span class='hs-conid'>L</span> <span class='hs-varid'>pos</span> <span class='hs-layout'>(</span><span class='hs-conid'>SigD</span> <span class='hs-varid'>sig</span><span class='hs-layout'>)</span>
<a name="line-702"></a>      <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>error</span> <span class='hs-str'>"internal: extractDecl"</span>
<a name="line-703"></a>  <span class='hs-keyword'>where</span>
<a name="line-704"></a>    <span class='hs-varid'>name_and_tyvars</span> <span class='hs-varid'>d</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>unLoc</span> <span class='hs-layout'>(</span><span class='hs-varid'>tcdLName</span> <span class='hs-varid'>d</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>hsLTyVarLocNames</span> <span class='hs-layout'>(</span><span class='hs-varid'>tcdTyVars</span> <span class='hs-varid'>d</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-705"></a>
<a name="line-706"></a>
<a name="line-707"></a><a name="toTypeNoLoc"></a><span class='hs-definition'>toTypeNoLoc</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Located</span> <span class='hs-conid'>Name</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>LHsType</span> <span class='hs-conid'>Name</span>
<a name="line-708"></a><span class='hs-definition'>toTypeNoLoc</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>noLoc</span> <span class='hs-varop'>.</span> <span class='hs-conid'>HsTyVar</span> <span class='hs-varop'>.</span> <span class='hs-varid'>unLoc</span>
<a name="line-709"></a>
<a name="line-710"></a>
<a name="line-711"></a><a name="extractClassDecl"></a><span class='hs-definition'>extractClassDecl</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Name</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Located</span> <span class='hs-conid'>Name</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>LSig</span> <span class='hs-conid'>Name</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>LSig</span> <span class='hs-conid'>Name</span>
<a name="line-712"></a><span class='hs-definition'>extractClassDecl</span> <span class='hs-varid'>c</span> <span class='hs-varid'>tvs0</span> <span class='hs-layout'>(</span><span class='hs-conid'>L</span> <span class='hs-varid'>pos</span> <span class='hs-layout'>(</span><span class='hs-conid'>TypeSig</span> <span class='hs-varid'>lname</span> <span class='hs-varid'>ltype</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>ltype</span> <span class='hs-keyword'>of</span>
<a name="line-713"></a>  <span class='hs-conid'>L</span> <span class='hs-keyword'>_</span> <span class='hs-layout'>(</span><span class='hs-conid'>HsForAllTy</span> <span class='hs-varid'>expl</span> <span class='hs-varid'>tvs</span> <span class='hs-layout'>(</span><span class='hs-conid'>L</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>preds</span><span class='hs-layout'>)</span> <span class='hs-varid'>ty</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-&gt;</span>
<a name="line-714"></a>    <span class='hs-conid'>L</span> <span class='hs-varid'>pos</span> <span class='hs-layout'>(</span><span class='hs-conid'>TypeSig</span> <span class='hs-varid'>lname</span> <span class='hs-layout'>(</span><span class='hs-varid'>noLoc</span> <span class='hs-layout'>(</span><span class='hs-conid'>HsForAllTy</span> <span class='hs-varid'>expl</span> <span class='hs-varid'>tvs</span> <span class='hs-layout'>(</span><span class='hs-varid'>lctxt</span> <span class='hs-varid'>preds</span><span class='hs-layout'>)</span> <span class='hs-varid'>ty</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-715"></a>  <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>L</span> <span class='hs-varid'>pos</span> <span class='hs-layout'>(</span><span class='hs-conid'>TypeSig</span> <span class='hs-varid'>lname</span> <span class='hs-layout'>(</span><span class='hs-varid'>noLoc</span> <span class='hs-layout'>(</span><span class='hs-varid'>mkImplicitHsForAllTy</span> <span class='hs-layout'>(</span><span class='hs-varid'>lctxt</span> <span class='hs-conid'>[]</span><span class='hs-layout'>)</span> <span class='hs-varid'>ltype</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-716"></a>  <span class='hs-keyword'>where</span>
<a name="line-717"></a>    <span class='hs-varid'>lctxt</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>noLoc</span> <span class='hs-varop'>.</span> <span class='hs-varid'>ctxt</span>
<a name="line-718"></a>    <span class='hs-varid'>ctxt</span> <span class='hs-varid'>preds</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>noLoc</span> <span class='hs-layout'>(</span><span class='hs-conid'>HsClassP</span> <span class='hs-varid'>c</span> <span class='hs-layout'>(</span><span class='hs-varid'>map</span> <span class='hs-varid'>toTypeNoLoc</span> <span class='hs-varid'>tvs0</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-conop'>:</span> <span class='hs-varid'>preds</span>
<a name="line-719"></a><span class='hs-definition'>extractClassDecl</span> <span class='hs-keyword'>_</span> <span class='hs-keyword'>_</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>error</span> <span class='hs-str'>"extractClassDecl: unexpected decl"</span>
<a name="line-720"></a>
<a name="line-721"></a>
<a name="line-722"></a><a name="extractRecSel"></a><span class='hs-definition'>extractRecSel</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Name</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Module</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Name</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Located</span> <span class='hs-conid'>Name</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>LConDecl</span> <span class='hs-conid'>Name</span><span class='hs-keyglyph'>]</span>
<a name="line-723"></a>              <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>LSig</span> <span class='hs-conid'>Name</span>
<a name="line-724"></a><span class='hs-definition'>extractRecSel</span> <span class='hs-keyword'>_</span> <span class='hs-keyword'>_</span> <span class='hs-keyword'>_</span> <span class='hs-keyword'>_</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>error</span> <span class='hs-str'>"extractRecSel: selector not found"</span>
<a name="line-725"></a>
<a name="line-726"></a><span class='hs-definition'>extractRecSel</span> <span class='hs-varid'>nm</span> <span class='hs-varid'>mdl</span> <span class='hs-varid'>t</span> <span class='hs-varid'>tvs</span> <span class='hs-layout'>(</span><span class='hs-conid'>L</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>con</span> <span class='hs-conop'>:</span> <span class='hs-varid'>rest</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span>
<a name="line-727"></a>  <span class='hs-keyword'>case</span> <span class='hs-varid'>con_details</span> <span class='hs-varid'>con</span> <span class='hs-keyword'>of</span>
<a name="line-728"></a>    <span class='hs-conid'>RecCon</span> <span class='hs-varid'>fields</span> <span class='hs-keyglyph'>|</span> <span class='hs-layout'>(</span><span class='hs-conid'>ConDeclField</span> <span class='hs-varid'>n</span> <span class='hs-varid'>ty</span> <span class='hs-keyword'>_</span> <span class='hs-conop'>:</span> <span class='hs-keyword'>_</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>matching_fields</span> <span class='hs-varid'>fields</span> <span class='hs-keyglyph'>-&gt;</span>
<a name="line-729"></a>      <span class='hs-conid'>L</span> <span class='hs-layout'>(</span><span class='hs-varid'>getLoc</span> <span class='hs-varid'>n</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>TypeSig</span> <span class='hs-layout'>(</span><span class='hs-varid'>noLoc</span> <span class='hs-varid'>nm</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>noLoc</span> <span class='hs-layout'>(</span><span class='hs-conid'>HsFunTy</span> <span class='hs-varid'>data_ty</span> <span class='hs-layout'>(</span><span class='hs-varid'>getBangType</span> <span class='hs-varid'>ty</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-730"></a>    <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>extractRecSel</span> <span class='hs-varid'>nm</span> <span class='hs-varid'>mdl</span> <span class='hs-varid'>t</span> <span class='hs-varid'>tvs</span> <span class='hs-varid'>rest</span>
<a name="line-731"></a> <span class='hs-keyword'>where</span>
<a name="line-732"></a>  <span class='hs-varid'>matching_fields</span> <span class='hs-varid'>flds</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>[</span> <span class='hs-varid'>f</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>f</span><span class='hs-keyglyph'>@</span><span class='hs-layout'>(</span><span class='hs-conid'>ConDeclField</span> <span class='hs-varid'>n</span> <span class='hs-keyword'>_</span> <span class='hs-keyword'>_</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>flds</span><span class='hs-layout'>,</span> <span class='hs-varid'>unLoc</span> <span class='hs-varid'>n</span> <span class='hs-varop'>==</span> <span class='hs-varid'>nm</span> <span class='hs-keyglyph'>]</span>
<a name="line-733"></a>  <span class='hs-varid'>data_ty</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>foldl</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>x</span> <span class='hs-varid'>y</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>noLoc</span> <span class='hs-layout'>(</span><span class='hs-conid'>HsAppTy</span> <span class='hs-varid'>x</span> <span class='hs-varid'>y</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>noLoc</span> <span class='hs-layout'>(</span><span class='hs-conid'>HsTyVar</span> <span class='hs-varid'>t</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>map</span> <span class='hs-varid'>toTypeNoLoc</span> <span class='hs-varid'>tvs</span><span class='hs-layout'>)</span>
<a name="line-734"></a>
<a name="line-735"></a>
<a name="line-736"></a><a name="pruneExportItems"></a><span class='hs-comment'>-- Pruning</span>
<a name="line-737"></a><span class='hs-definition'>pruneExportItems</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>ExportItem</span> <span class='hs-conid'>Name</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>ExportItem</span> <span class='hs-conid'>Name</span><span class='hs-keyglyph'>]</span>
<a name="line-738"></a><span class='hs-definition'>pruneExportItems</span> <span class='hs-varid'>items</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>filter</span> <span class='hs-varid'>hasDoc</span> <span class='hs-varid'>items</span>
<a name="line-739"></a>  <span class='hs-keyword'>where</span>
<a name="line-740"></a>    <span class='hs-varid'>hasDoc</span> <span class='hs-layout'>(</span><span class='hs-conid'>ExportDecl</span><span class='hs-layout'>{</span><span class='hs-varid'>expItemMbDoc</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>d</span><span class='hs-layout'>,</span> <span class='hs-keyword'>_</span><span class='hs-layout'>)</span><span class='hs-layout'>}</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>isJust</span> <span class='hs-varid'>d</span>
<a name="line-741"></a>    <span class='hs-varid'>hasDoc</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>True</span>
<a name="line-742"></a>
<a name="line-743"></a>
<a name="line-744"></a><a name="mkVisibleNames"></a><span class='hs-definition'>mkVisibleNames</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>ExportItem</span> <span class='hs-conid'>Name</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>DocOption</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Name</span><span class='hs-keyglyph'>]</span>
<a name="line-745"></a><span class='hs-definition'>mkVisibleNames</span> <span class='hs-varid'>exports</span> <span class='hs-varid'>opts</span>
<a name="line-746"></a>  <span class='hs-keyglyph'>|</span> <span class='hs-conid'>OptHide</span> <span class='hs-varop'>`elem`</span> <span class='hs-varid'>opts</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>[]</span>
<a name="line-747"></a>  <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>concatMap</span> <span class='hs-varid'>exportName</span> <span class='hs-varid'>exports</span>
<a name="line-748"></a>  <span class='hs-keyword'>where</span>
<a name="line-749"></a>    <span class='hs-varid'>exportName</span> <span class='hs-varid'>e</span><span class='hs-keyglyph'>@</span><span class='hs-conid'>ExportDecl</span> <span class='hs-layout'>{</span><span class='hs-layout'>}</span> <span class='hs-keyglyph'>=</span>
<a name="line-750"></a>      <span class='hs-keyword'>case</span> <span class='hs-varid'>getMainDeclBinder</span> <span class='hs-varop'>$</span> <span class='hs-varid'>unL</span> <span class='hs-varop'>$</span> <span class='hs-varid'>expItemDecl</span> <span class='hs-varid'>e</span> <span class='hs-keyword'>of</span>
<a name="line-751"></a>        <span class='hs-conid'>Just</span> <span class='hs-varid'>n</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>n</span> <span class='hs-conop'>:</span> <span class='hs-varid'>subs</span>
<a name="line-752"></a>        <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>subs</span>
<a name="line-753"></a>      <span class='hs-keyword'>where</span> <span class='hs-varid'>subs</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>map</span> <span class='hs-varid'>fst</span> <span class='hs-layout'>(</span><span class='hs-varid'>expItemSubDocs</span> <span class='hs-varid'>e</span><span class='hs-layout'>)</span>
<a name="line-754"></a>    <span class='hs-varid'>exportName</span> <span class='hs-conid'>ExportNoDecl</span> <span class='hs-layout'>{</span><span class='hs-layout'>}</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>[]</span> <span class='hs-comment'>-- we don't count these as visible, since</span>
<a name="line-755"></a>                                    <span class='hs-comment'>-- we don't want links to go to them.</span>
<a name="line-756"></a>    <span class='hs-varid'>exportName</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>[]</span>
<a name="line-757"></a>
<a name="line-758"></a>
<a name="line-759"></a><a name="findNamedDoc"></a><span class='hs-comment'>-- | Find a stand-alone documentation comment by its name</span>
<a name="line-760"></a><span class='hs-definition'>findNamedDoc</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>HsDecl</span> <span class='hs-conid'>Name</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>ErrMsgM</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-conid'>HsDocString</span><span class='hs-layout'>)</span>
<a name="line-761"></a><span class='hs-definition'>findNamedDoc</span> <span class='hs-varid'>name</span> <span class='hs-varid'>decls</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>search</span> <span class='hs-varid'>decls</span>
<a name="line-762"></a>  <span class='hs-keyword'>where</span>
<a name="line-763"></a>    <span class='hs-varid'>search</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-764"></a>      <span class='hs-varid'>tell</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"Cannot find documentation for: $"</span> <span class='hs-varop'>++</span> <span class='hs-varid'>name</span><span class='hs-keyglyph'>]</span>
<a name="line-765"></a>      <span class='hs-varid'>return</span> <span class='hs-conid'>Nothing</span>
<a name="line-766"></a>    <span class='hs-varid'>search</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>DocD</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocCommentNamed</span> <span class='hs-varid'>name'</span> <span class='hs-varid'>doc</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-conop'>:</span><span class='hs-varid'>rest</span><span class='hs-layout'>)</span>
<a name="line-767"></a>      <span class='hs-keyglyph'>|</span> <span class='hs-varid'>name</span> <span class='hs-varop'>==</span> <span class='hs-varid'>name'</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-conid'>Just</span> <span class='hs-varid'>doc</span><span class='hs-layout'>)</span>
<a name="line-768"></a>      <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>search</span> <span class='hs-varid'>rest</span>
<a name="line-769"></a>    <span class='hs-varid'>search</span> <span class='hs-layout'>(</span><span class='hs-sel'>_other_decl</span> <span class='hs-conop'>:</span> <span class='hs-varid'>rest</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>search</span> <span class='hs-varid'>rest</span>
</pre></body>
</html>