<?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/Types.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# OPTIONS_HADDOCK hide #-}</span>
<a name="line-2"></a><span class='hs-comment'>{-# LANGUAGE DeriveDataTypeable, DeriveFunctor #-}</span>
<a name="line-3"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-4"></a><span class='hs-comment'>-- |</span>
<a name="line-5"></a><span class='hs-comment'>-- Module : Haddock.Types</span>
<a name="line-6"></a><span class='hs-comment'>-- Copyright : (c) Simon Marlow 2003-2006,</span>
<a name="line-7"></a><span class='hs-comment'>-- David Waern 2006-2009</span>
<a name="line-8"></a><span class='hs-comment'>-- License : BSD-like</span>
<a name="line-9"></a><span class='hs-comment'>--</span>
<a name="line-10"></a><span class='hs-comment'>-- Maintainer : haddock@projects.haskellorg</span>
<a name="line-11"></a><span class='hs-comment'>-- Stability : experimental</span>
<a name="line-12"></a><span class='hs-comment'>-- Portability : portable</span>
<a name="line-13"></a><span class='hs-comment'>--</span>
<a name="line-14"></a><span class='hs-comment'>-- Types that are commonly used through-out Haddock. Some of the most</span>
<a name="line-15"></a><span class='hs-comment'>-- important types are defined here, like 'Interface' and 'DocName'.</span>
<a name="line-16"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-17"></a>
<a name="line-18"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Haddock</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span> <span class='hs-layout'>(</span>
<a name="line-19"></a> <span class='hs-keyword'>module</span> <span class='hs-conid'>Haddock</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span>
<a name="line-20"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>HsDocString</span><span class='hs-layout'>,</span> <span class='hs-conid'>LHsDocString</span>
<a name="line-21"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-22"></a>
<a name="line-23"></a>
<a name="line-24"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Exception</span>
<a name="line-25"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Arrow</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'>Typeable</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'>Map</span> <span class='hs-layout'>(</span><span class='hs-conid'>Map</span><span class='hs-layout'>)</span>
<a name="line-28"></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-29"></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-conid'>NoLink</span><span class='hs-layout'>)</span>
<a name="line-30"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Name</span>
<a name="line-31"></a>
<a name="line-32"></a><span class='hs-cpp'>#ifdef TEST</span>
<a name="line-33"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Test</span><span class='hs-varop'>.</span><span class='hs-conid'>QuickCheck</span>
<a name="line-34"></a><span class='hs-cpp'>#endif</span>
<a name="line-35"></a>
<a name="line-36"></a><a name="Decl"></a><span class='hs-comment'>-- convenient short-hands</span>
<a name="line-37"></a><a name="Decl"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>Decl</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>LHsDecl</span> <span class='hs-conid'>Name</span>
<a name="line-38"></a>
<a name="line-39"></a>
<a name="line-40"></a><a name="DocInstance"></a><span class='hs-comment'>-- | An instance head that may have documentation.</span>
<a name="line-41"></a><a name="DocInstance"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>DocInstance</span> <span class='hs-varid'>name</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-conid'>InstHead</span> <span class='hs-varid'>name</span><span class='hs-layout'>,</span> <span class='hs-conid'>Maybe</span> <span class='hs-layout'>(</span><span class='hs-conid'>Doc</span> <span class='hs-varid'>name</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-42"></a>
<a name="line-43"></a>
<a name="line-44"></a><a name="FnArgsDoc"></a><span class='hs-comment'>-- | Arguments and result are indexed by Int, zero-based from the left,</span>
<a name="line-45"></a><a name="FnArgsDoc"></a><span class='hs-comment'>-- because that's the easiest to use when recursing over types.</span>
<a name="line-46"></a><a name="FnArgsDoc"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>FnArgsDoc</span> <span class='hs-varid'>name</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Map</span> <span class='hs-conid'>Int</span> <span class='hs-layout'>(</span><span class='hs-conid'>Doc</span> <span class='hs-varid'>name</span><span class='hs-layout'>)</span>
<a name="line-47"></a><a name="DocForDecl"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>DocForDecl</span> <span class='hs-varid'>name</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-layout'>(</span><span class='hs-conid'>Doc</span> <span class='hs-varid'>name</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-conid'>FnArgsDoc</span> <span class='hs-varid'>name</span><span class='hs-layout'>)</span>
<a name="line-48"></a>
<a name="line-49"></a><a name="noDocForDecl"></a><span class='hs-definition'>noDocForDecl</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>DocForDecl</span> <span class='hs-varid'>name</span>
<a name="line-50"></a><span class='hs-definition'>noDocForDecl</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-conid'>Nothing</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-51"></a>
<a name="line-52"></a><a name="DeclInfo"></a><span class='hs-comment'>-- | A declaration that may have documentation, including its subordinates,</span>
<a name="line-53"></a><a name="DeclInfo"></a><span class='hs-comment'>-- which may also have documentation</span>
<a name="line-54"></a><a name="DeclInfo"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>DeclInfo</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'>DocForDecl</span> <span class='hs-conid'>Name</span><span class='hs-layout'>,</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><span class='hs-layout'>)</span>
<a name="line-55"></a>
<a name="line-56"></a>
<a name="line-57"></a><a name="DocName"></a><span class='hs-comment'>-- | An extension of 'Name' that may contain the preferred place to link to in</span>
<a name="line-58"></a><a name="DocName"></a><span class='hs-comment'>-- the documentation.</span>
<a name="line-59"></a><a name="DocName"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>DocName</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Documented</span> <span class='hs-conid'>Name</span> <span class='hs-conid'>Module</span> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Undocumented</span> <span class='hs-conid'>Name</span> <span class='hs-keyword'>deriving</span> <span class='hs-conid'>Eq</span>
<a name="line-60"></a><span class='hs-comment'>-- TODO: simplify to data DocName = DocName Name (Maybe Module)</span>
<a name="line-61"></a>
<a name="line-62"></a>
<a name="line-63"></a><a name="docNameOcc"></a><span class='hs-comment'>-- | The 'OccName' of this name.</span>
<a name="line-64"></a><span class='hs-definition'>docNameOcc</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>DocName</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>OccName</span>
<a name="line-65"></a><span class='hs-definition'>docNameOcc</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>nameOccName</span> <span class='hs-varop'>.</span> <span class='hs-varid'>getName</span>
<a name="line-66"></a>
<a name="line-67"></a>
<a name="line-68"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>NamedThing</span> <span class='hs-conid'>DocName</span> <span class='hs-keyword'>where</span>
<a name="line-69"></a> <span class='hs-varid'>getName</span> <span class='hs-layout'>(</span><span class='hs-conid'>Documented</span> <span class='hs-varid'>name</span> <span class='hs-keyword'>_</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>name</span>
<a name="line-70"></a> <span class='hs-varid'>getName</span> <span class='hs-layout'>(</span><span class='hs-conid'>Undocumented</span> <span class='hs-varid'>name</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>name</span>
<a name="line-71"></a>
<a name="line-72"></a>
<a name="line-73"></a><a name="DocOption"></a><span class='hs-comment'>{-! for DocOption derive: Binary !-}</span>
<a name="line-74"></a><a name="DocOption"></a><span class='hs-comment'>-- | Source-level options for controlling the documentation.</span>
<a name="line-75"></a><a name="DocOption"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>DocOption</span>
<a name="line-76"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>OptHide</span> <span class='hs-comment'>-- ^ This module should not appear in the docs</span>
<a name="line-77"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>OptPrune</span>
<a name="line-78"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>OptIgnoreExports</span> <span class='hs-comment'>-- ^ Pretend everything is exported</span>
<a name="line-79"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>OptNotHome</span> <span class='hs-comment'>-- ^ Not the best place to get docs for things</span>
<a name="line-80"></a> <span class='hs-comment'>-- exported by this module.</span>
<a name="line-81"></a> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Eq</span><span class='hs-layout'>,</span> <span class='hs-conid'>Show</span><span class='hs-layout'>)</span>
<a name="line-82"></a>
<a name="line-83"></a>
<a name="line-84"></a><a name="ExportItem"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>ExportItem</span> <span class='hs-varid'>name</span>
<a name="line-85"></a>
<a name="line-86"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>ExportDecl</span> <span class='hs-layout'>{</span>
<a name="line-87"></a>
<a name="line-88"></a> <span class='hs-comment'>-- | A declaration</span>
<a name="line-89"></a> <span class='hs-varid'>expItemDecl</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>LHsDecl</span> <span class='hs-varid'>name</span><span class='hs-layout'>,</span>
<a name="line-90"></a>
<a name="line-91"></a> <span class='hs-comment'>-- | Maybe a doc comment, and possibly docs for arguments (if this</span>
<a name="line-92"></a> <span class='hs-comment'>-- decl is a function or type-synonym)</span>
<a name="line-93"></a> <span class='hs-varid'>expItemMbDoc</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>DocForDecl</span> <span class='hs-varid'>name</span><span class='hs-layout'>,</span>
<a name="line-94"></a>
<a name="line-95"></a> <span class='hs-comment'>-- | Subordinate names, possibly with documentation</span>
<a name="line-96"></a> <span class='hs-varid'>expItemSubDocs</span> <span class='hs-keyglyph'>::</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-conid'>DocForDecl</span> <span class='hs-varid'>name</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>,</span>
<a name="line-97"></a>
<a name="line-98"></a> <span class='hs-comment'>-- | Instances relevant to this declaration, possibly with documentation</span>
<a name="line-99"></a> <span class='hs-varid'>expItemInstances</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>DocInstance</span> <span class='hs-varid'>name</span><span class='hs-keyglyph'>]</span>
<a name="line-100"></a>
<a name="line-101"></a> <span class='hs-layout'>}</span> <span class='hs-comment'>-- ^ An exported declaration</span>
<a name="line-102"></a>
<a name="line-103"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>ExportNoDecl</span> <span class='hs-layout'>{</span>
<a name="line-104"></a> <span class='hs-varid'>expItemName</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>name</span><span class='hs-layout'>,</span>
<a name="line-105"></a>
<a name="line-106"></a> <span class='hs-comment'>-- | Subordinate names</span>
<a name="line-107"></a> <span class='hs-varid'>expItemSubs</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>name</span><span class='hs-keyglyph'>]</span>
<a name="line-108"></a>
<a name="line-109"></a> <span class='hs-layout'>}</span> <span class='hs-comment'>-- ^ An exported entity for which we have no</span>
<a name="line-110"></a> <span class='hs-comment'>-- documentation (perhaps because it resides in</span>
<a name="line-111"></a> <span class='hs-comment'>-- another package)</span>
<a name="line-112"></a>
<a name="line-113"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>ExportGroup</span> <span class='hs-layout'>{</span>
<a name="line-114"></a>
<a name="line-115"></a> <span class='hs-comment'>-- | Section level (1, 2, 3, ... )</span>
<a name="line-116"></a> <span class='hs-varid'>expItemSectionLevel</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Int</span><span class='hs-layout'>,</span>
<a name="line-117"></a>
<a name="line-118"></a> <span class='hs-comment'>-- | Section id (for hyperlinks)</span>
<a name="line-119"></a> <span class='hs-varid'>expItemSectionId</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span><span class='hs-layout'>,</span>
<a name="line-120"></a>
<a name="line-121"></a> <span class='hs-comment'>-- | Section heading text</span>
<a name="line-122"></a> <span class='hs-varid'>expItemSectionText</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Doc</span> <span class='hs-varid'>name</span>
<a name="line-123"></a>
<a name="line-124"></a> <span class='hs-layout'>}</span> <span class='hs-comment'>-- ^ A section heading</span>
<a name="line-125"></a>
<a name="line-126"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>ExportDoc</span> <span class='hs-layout'>(</span><span class='hs-conid'>Doc</span> <span class='hs-varid'>name</span><span class='hs-layout'>)</span> <span class='hs-comment'>-- ^ Some documentation</span>
<a name="line-127"></a>
<a name="line-128"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>ExportModule</span> <span class='hs-conid'>Module</span> <span class='hs-comment'>-- ^ A cross-reference to another module</span>
<a name="line-129"></a>
<a name="line-130"></a>
<a name="line-131"></a><a name="InstHead"></a><span class='hs-comment'>-- | The head of an instance. Consists of a context, a class name and a list of</span>
<a name="line-132"></a><a name="InstHead"></a><span class='hs-comment'>-- instance types.</span>
<a name="line-133"></a><a name="InstHead"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>InstHead</span> <span class='hs-varid'>name</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>[</span><span class='hs-conid'>HsPred</span> <span class='hs-varid'>name</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-keyglyph'>[</span><span class='hs-conid'>HsType</span> <span class='hs-varid'>name</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span>
<a name="line-134"></a>
<a name="line-135"></a>
<a name="line-136"></a><a name="ModuleMap"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>ModuleMap</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Map</span> <span class='hs-conid'>Module</span> <span class='hs-conid'>Interface</span>
<a name="line-137"></a><a name="InstIfaceMap"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>InstIfaceMap</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Map</span> <span class='hs-conid'>Module</span> <span class='hs-conid'>InstalledInterface</span>
<a name="line-138"></a><a name="DocMap"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>DocMap</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Map</span> <span class='hs-conid'>Name</span> <span class='hs-layout'>(</span><span class='hs-conid'>Doc</span> <span class='hs-conid'>DocName</span><span class='hs-layout'>)</span>
<a name="line-139"></a>
<a name="line-140"></a><a name="LinkEnv"></a><span class='hs-comment'>-- | An environment used to create hyper-linked syntax.</span>
<a name="line-141"></a><a name="LinkEnv"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>LinkEnv</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Map</span> <span class='hs-conid'>Name</span> <span class='hs-conid'>Module</span>
<a name="line-142"></a>
<a name="line-143"></a>
<a name="line-144"></a><a name="GhcDocHdr"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>GhcDocHdr</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>LHsDocString</span>
<a name="line-145"></a>
<a name="line-146"></a>
<a name="line-147"></a><a name="GhcModule"></a><span class='hs-comment'>-- | This structure holds the module information we get from GHC's</span>
<a name="line-148"></a><a name="GhcModule"></a><span class='hs-comment'>-- type checking phase</span>
<a name="line-149"></a><a name="GhcModule"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>GhcModule</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>GhcModule</span> <span class='hs-layout'>{</span>
<a name="line-150"></a> <span class='hs-varid'>ghcModule</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Module</span><span class='hs-layout'>,</span>
<a name="line-151"></a> <span class='hs-varid'>ghcFilename</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>FilePath</span><span class='hs-layout'>,</span>
<a name="line-152"></a> <span class='hs-varid'>ghcMbDocOpts</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>String</span><span class='hs-layout'>,</span>
<a name="line-153"></a> <span class='hs-varid'>ghcMbDocHdr</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>GhcDocHdr</span><span class='hs-layout'>,</span>
<a name="line-154"></a> <span class='hs-varid'>ghcGroup</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>HsGroup</span> <span class='hs-conid'>Name</span><span class='hs-layout'>,</span>
<a name="line-155"></a> <span class='hs-varid'>ghcMbExports</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Maybe</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>LIE</span> <span class='hs-conid'>Name</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>,</span>
<a name="line-156"></a> <span class='hs-varid'>ghcExportedNames</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Name</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>,</span>
<a name="line-157"></a> <span class='hs-varid'>ghcDefinedNames</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Name</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>,</span>
<a name="line-158"></a> <span class='hs-varid'>ghcNamesInScope</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Name</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>,</span>
<a name="line-159"></a> <span class='hs-varid'>ghcInstances</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Instance</span><span class='hs-keyglyph'>]</span>
<a name="line-160"></a><span class='hs-layout'>}</span>
<a name="line-161"></a>
<a name="line-162"></a>
<a name="line-163"></a><a name="Interface"></a><span class='hs-comment'>-- | The data structure used to render a Haddock page for a module - it is</span>
<a name="line-164"></a><a name="Interface"></a><span class='hs-comment'>-- the interface of the module. The core of Haddock lies in creating this</span>
<a name="line-165"></a><a name="Interface"></a><span class='hs-comment'>-- structure (see Haddock.Interface). The structure also holds intermediate</span>
<a name="line-166"></a><a name="Interface"></a><span class='hs-comment'>-- data needed during its creation.</span>
<a name="line-167"></a><a name="Interface"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>Interface</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Interface</span> <span class='hs-layout'>{</span>
<a name="line-168"></a>
<a name="line-169"></a> <span class='hs-comment'>-- | The module represented by this interface.</span>
<a name="line-170"></a> <span class='hs-varid'>ifaceMod</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Module</span><span class='hs-layout'>,</span>
<a name="line-171"></a>
<a name="line-172"></a> <span class='hs-comment'>-- | Original file name of the module.</span>
<a name="line-173"></a> <span class='hs-varid'>ifaceOrigFilename</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>FilePath</span><span class='hs-layout'>,</span>
<a name="line-174"></a>
<a name="line-175"></a> <span class='hs-comment'>-- | Textual information about the module.</span>
<a name="line-176"></a> <span class='hs-varid'>ifaceInfo</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>!</span><span class='hs-layout'>(</span><span class='hs-conid'>HaddockModInfo</span> <span class='hs-conid'>Name</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-177"></a>
<a name="line-178"></a> <span class='hs-comment'>-- | Documentation header.</span>
<a name="line-179"></a> <span class='hs-varid'>ifaceDoc</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>!</span><span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-layout'>(</span><span class='hs-conid'>Doc</span> <span class='hs-conid'>Name</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-180"></a>
<a name="line-181"></a> <span class='hs-comment'>-- | Documentation header with link information.</span>
<a name="line-182"></a> <span class='hs-varid'>ifaceRnDoc</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Maybe</span> <span class='hs-layout'>(</span><span class='hs-conid'>Doc</span> <span class='hs-conid'>DocName</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-183"></a>
<a name="line-184"></a> <span class='hs-comment'>-- | Haddock options for this module (prune, ignore-exports, etc).</span>
<a name="line-185"></a> <span class='hs-varid'>ifaceOptions</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>!</span><span class='hs-keyglyph'>[</span><span class='hs-conid'>DocOption</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>,</span>
<a name="line-186"></a>
<a name="line-187"></a> <span class='hs-comment'>-- | Declarations originating from the module. Excludes declarations without</span>
<a name="line-188"></a> <span class='hs-comment'>-- names (instances and stand-alone documentation comments). Includes</span>
<a name="line-189"></a> <span class='hs-comment'>-- names of subordinate declarations mapped to their parent declarations.</span>
<a name="line-190"></a> <span class='hs-varid'>ifaceDeclMap</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-layout'>,</span>
<a name="line-191"></a>
<a name="line-192"></a> <span class='hs-comment'>-- | Documentation of declarations originating from the module (including</span>
<a name="line-193"></a> <span class='hs-comment'>-- subordinates).</span>
<a name="line-194"></a> <span class='hs-varid'>ifaceRnDocMap</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Map</span> <span class='hs-conid'>Name</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocForDecl</span> <span class='hs-conid'>DocName</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-195"></a>
<a name="line-196"></a> <span class='hs-varid'>ifaceSubMap</span> <span class='hs-keyglyph'>::</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><span class='hs-layout'>,</span>
<a name="line-197"></a>
<a name="line-198"></a> <span class='hs-varid'>ifaceExportItems</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>!</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-layout'>,</span>
<a name="line-199"></a> <span class='hs-varid'>ifaceRnExportItems</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>ExportItem</span> <span class='hs-conid'>DocName</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>,</span>
<a name="line-200"></a>
<a name="line-201"></a> <span class='hs-comment'>-- | All names exported by the module.</span>
<a name="line-202"></a> <span class='hs-varid'>ifaceExports</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>!</span><span class='hs-keyglyph'>[</span><span class='hs-conid'>Name</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>,</span>
<a name="line-203"></a>
<a name="line-204"></a> <span class='hs-comment'>-- | All \"visible\" names exported by the module.</span>
<a name="line-205"></a> <span class='hs-comment'>-- A visible name is a name that will show up in the documentation of the</span>
<a name="line-206"></a> <span class='hs-comment'>-- module.</span>
<a name="line-207"></a> <span class='hs-varid'>ifaceVisibleExports</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>!</span><span class='hs-keyglyph'>[</span><span class='hs-conid'>Name</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>,</span>
<a name="line-208"></a>
<a name="line-209"></a> <span class='hs-comment'>-- | Instances exported by the module.</span>
<a name="line-210"></a> <span class='hs-varid'>ifaceInstances</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>!</span><span class='hs-keyglyph'>[</span><span class='hs-conid'>Instance</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>,</span>
<a name="line-211"></a>
<a name="line-212"></a> <span class='hs-comment'>-- | Documentation of instances defined in the module.</span>
<a name="line-213"></a> <span class='hs-varid'>ifaceInstanceDocMap</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Map</span> <span class='hs-conid'>Name</span> <span class='hs-layout'>(</span><span class='hs-conid'>Doc</span> <span class='hs-conid'>Name</span><span class='hs-layout'>)</span>
<a name="line-214"></a><span class='hs-layout'>}</span>
<a name="line-215"></a>
<a name="line-216"></a>
<a name="line-217"></a><a name="InstalledInterface"></a><span class='hs-comment'>-- | A smaller version of 'Interface' that can be created from Haddock's</span>
<a name="line-218"></a><a name="InstalledInterface"></a><span class='hs-comment'>-- interface files ('InterfaceFile').</span>
<a name="line-219"></a><a name="InstalledInterface"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>InstalledInterface</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>InstalledInterface</span> <span class='hs-layout'>{</span>
<a name="line-220"></a>
<a name="line-221"></a> <span class='hs-comment'>-- | The module represented by this interface.</span>
<a name="line-222"></a> <span class='hs-varid'>instMod</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Module</span><span class='hs-layout'>,</span>
<a name="line-223"></a>
<a name="line-224"></a> <span class='hs-comment'>-- | Textual information about the module.</span>
<a name="line-225"></a> <span class='hs-varid'>instInfo</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>HaddockModInfo</span> <span class='hs-conid'>Name</span><span class='hs-layout'>,</span>
<a name="line-226"></a>
<a name="line-227"></a> <span class='hs-comment'>-- | Documentation of declarations originating from the module (including</span>
<a name="line-228"></a> <span class='hs-comment'>-- subordinates).</span>
<a name="line-229"></a> <span class='hs-varid'>instDocMap</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Map</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-layout'>,</span>
<a name="line-230"></a>
<a name="line-231"></a> <span class='hs-comment'>-- | All names exported by this module.</span>
<a name="line-232"></a> <span class='hs-varid'>instExports</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Name</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>,</span>
<a name="line-233"></a>
<a name="line-234"></a> <span class='hs-comment'>-- | All \"visible\" names exported by the module.</span>
<a name="line-235"></a> <span class='hs-comment'>-- A visible name is a name that will show up in the documentation of the</span>
<a name="line-236"></a> <span class='hs-comment'>-- module.</span>
<a name="line-237"></a> <span class='hs-varid'>instVisibleExports</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Name</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>,</span>
<a name="line-238"></a>
<a name="line-239"></a> <span class='hs-comment'>-- | Haddock options for this module (prune, ignore-exports, etc).</span>
<a name="line-240"></a> <span class='hs-varid'>instOptions</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>DocOption</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>,</span>
<a name="line-241"></a>
<a name="line-242"></a> <span class='hs-varid'>instSubMap</span> <span class='hs-keyglyph'>::</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-243"></a><span class='hs-layout'>}</span>
<a name="line-244"></a>
<a name="line-245"></a>
<a name="line-246"></a><a name="toInstalledIface"></a><span class='hs-comment'>-- | Convert an 'Interface' to an 'InstalledInterface'</span>
<a name="line-247"></a><span class='hs-definition'>toInstalledIface</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Interface</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>InstalledInterface</span>
<a name="line-248"></a><span class='hs-definition'>toInstalledIface</span> <span class='hs-varid'>interface</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>InstalledInterface</span> <span class='hs-layout'>{</span>
<a name="line-249"></a> <span class='hs-varid'>instMod</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ifaceMod</span> <span class='hs-varid'>interface</span><span class='hs-layout'>,</span>
<a name="line-250"></a> <span class='hs-varid'>instInfo</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ifaceInfo</span> <span class='hs-varid'>interface</span><span class='hs-layout'>,</span>
<a name="line-251"></a> <span class='hs-varid'>instDocMap</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fmap</span> <span class='hs-varid'>unrenameDocForDecl</span> <span class='hs-varop'>$</span> <span class='hs-varid'>ifaceRnDocMap</span> <span class='hs-varid'>interface</span><span class='hs-layout'>,</span>
<a name="line-252"></a> <span class='hs-varid'>instExports</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ifaceExports</span> <span class='hs-varid'>interface</span><span class='hs-layout'>,</span>
<a name="line-253"></a> <span class='hs-varid'>instVisibleExports</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ifaceVisibleExports</span> <span class='hs-varid'>interface</span><span class='hs-layout'>,</span>
<a name="line-254"></a> <span class='hs-varid'>instOptions</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ifaceOptions</span> <span class='hs-varid'>interface</span><span class='hs-layout'>,</span>
<a name="line-255"></a> <span class='hs-varid'>instSubMap</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ifaceSubMap</span> <span class='hs-varid'>interface</span>
<a name="line-256"></a><span class='hs-layout'>}</span>
<a name="line-257"></a>
<a name="line-258"></a><a name="unrenameDoc"></a><span class='hs-definition'>unrenameDoc</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Doc</span> <span class='hs-conid'>DocName</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <span class='hs-conid'>Name</span>
<a name="line-259"></a><span class='hs-definition'>unrenameDoc</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fmap</span> <span class='hs-varid'>getName</span>
<a name="line-260"></a><a name="unrenameDocForDecl"></a><span class='hs-definition'>unrenameDocForDecl</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>DocForDecl</span> <span class='hs-conid'>DocName</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>DocForDecl</span> <span class='hs-conid'>Name</span>
<a name="line-261"></a><span class='hs-definition'>unrenameDocForDecl</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-keyglyph'>=</span>
<a name="line-262"></a> <span class='hs-layout'>(</span><span class='hs-varid'>fmap</span> <span class='hs-varid'>unrenameDoc</span> <span class='hs-varid'>mbDoc</span><span class='hs-layout'>,</span> <span class='hs-varid'>fmap</span> <span class='hs-varid'>unrenameDoc</span> <span class='hs-varid'>fnArgsDoc</span><span class='hs-layout'>)</span>
<a name="line-263"></a>
<a name="line-264"></a>
<a name="line-265"></a><a name="Doc"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>Doc</span> <span class='hs-varid'>id</span>
<a name="line-266"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>DocEmpty</span>
<a name="line-267"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>DocAppend</span> <span class='hs-layout'>(</span><span class='hs-conid'>Doc</span> <span class='hs-varid'>id</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>Doc</span> <span class='hs-varid'>id</span><span class='hs-layout'>)</span>
<a name="line-268"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>DocString</span> <span class='hs-conid'>String</span>
<a name="line-269"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>DocParagraph</span> <span class='hs-layout'>(</span><span class='hs-conid'>Doc</span> <span class='hs-varid'>id</span><span class='hs-layout'>)</span>
<a name="line-270"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>DocIdentifier</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>id</span><span class='hs-keyglyph'>]</span>
<a name="line-271"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>DocModule</span> <span class='hs-conid'>String</span>
<a name="line-272"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>DocEmphasis</span> <span class='hs-layout'>(</span><span class='hs-conid'>Doc</span> <span class='hs-varid'>id</span><span class='hs-layout'>)</span>
<a name="line-273"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>DocMonospaced</span> <span class='hs-layout'>(</span><span class='hs-conid'>Doc</span> <span class='hs-varid'>id</span><span class='hs-layout'>)</span>
<a name="line-274"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>DocUnorderedList</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Doc</span> <span class='hs-varid'>id</span><span class='hs-keyglyph'>]</span>
<a name="line-275"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>DocOrderedList</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Doc</span> <span class='hs-varid'>id</span><span class='hs-keyglyph'>]</span>
<a name="line-276"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>DocDefList</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>Doc</span> <span class='hs-varid'>id</span><span class='hs-layout'>,</span> <span class='hs-conid'>Doc</span> <span class='hs-varid'>id</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-277"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>DocCodeBlock</span> <span class='hs-layout'>(</span><span class='hs-conid'>Doc</span> <span class='hs-varid'>id</span><span class='hs-layout'>)</span>
<a name="line-278"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>DocURL</span> <span class='hs-conid'>String</span>
<a name="line-279"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>DocPic</span> <span class='hs-conid'>String</span>
<a name="line-280"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>DocAName</span> <span class='hs-conid'>String</span>
<a name="line-281"></a> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Eq</span><span class='hs-layout'>,</span> <span class='hs-conid'>Show</span><span class='hs-layout'>,</span> <span class='hs-conid'>Functor</span><span class='hs-layout'>)</span>
<a name="line-282"></a>
<a name="line-283"></a>
<a name="line-284"></a><span class='hs-cpp'>#ifdef TEST</span>
<a name="line-285"></a><span class='hs-comment'>-- TODO: use derive</span>
<a name="line-286"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Arbitrary</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Arbitrary</span> <span class='hs-layout'>(</span><span class='hs-conid'>Doc</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-287"></a> <span class='hs-varid'>arbitrary</span> <span class='hs-keyglyph'>=</span>
<a name="line-288"></a> <span class='hs-varid'>oneof</span> <span class='hs-keyglyph'>[</span> <span class='hs-varid'>return</span> <span class='hs-conid'>DocEmpty</span>
<a name="line-289"></a> <span class='hs-layout'>,</span> <span class='hs-keyword'>do</span> <span class='hs-layout'>{</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>arbitrary</span><span class='hs-layout'>;</span> <span class='hs-varid'>b</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>arbitrary</span><span class='hs-layout'>;</span> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocAppend</span> <span class='hs-varid'>a</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-layout'>}</span>
<a name="line-290"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fmap</span> <span class='hs-conid'>DocString</span> <span class='hs-varid'>arbitrary</span>
<a name="line-291"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fmap</span> <span class='hs-conid'>DocParagraph</span> <span class='hs-varid'>arbitrary</span>
<a name="line-292"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fmap</span> <span class='hs-conid'>DocIdentifier</span> <span class='hs-varid'>arbitrary</span>
<a name="line-293"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fmap</span> <span class='hs-conid'>DocModule</span> <span class='hs-varid'>arbitrary</span>
<a name="line-294"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fmap</span> <span class='hs-conid'>DocEmphasis</span> <span class='hs-varid'>arbitrary</span>
<a name="line-295"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fmap</span> <span class='hs-conid'>DocMonospaced</span> <span class='hs-varid'>arbitrary</span>
<a name="line-296"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fmap</span> <span class='hs-conid'>DocUnorderedList</span> <span class='hs-varid'>arbitrary</span>
<a name="line-297"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fmap</span> <span class='hs-conid'>DocOrderedList</span> <span class='hs-varid'>arbitrary</span>
<a name="line-298"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fmap</span> <span class='hs-conid'>DocDefList</span> <span class='hs-varid'>arbitrary</span>
<a name="line-299"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fmap</span> <span class='hs-conid'>DocCodeBlock</span> <span class='hs-varid'>arbitrary</span>
<a name="line-300"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fmap</span> <span class='hs-conid'>DocURL</span> <span class='hs-varid'>arbitrary</span>
<a name="line-301"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fmap</span> <span class='hs-conid'>DocPic</span> <span class='hs-varid'>arbitrary</span>
<a name="line-302"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fmap</span> <span class='hs-conid'>DocAName</span> <span class='hs-varid'>arbitrary</span> <span class='hs-keyglyph'>]</span>
<a name="line-303"></a><span class='hs-cpp'>#endif</span>
<a name="line-304"></a>
<a name="line-305"></a>
<a name="line-306"></a><a name="LDoc"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>LDoc</span> <span class='hs-varid'>id</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Located</span> <span class='hs-layout'>(</span><span class='hs-conid'>Doc</span> <span class='hs-varid'>id</span><span class='hs-layout'>)</span>
<a name="line-307"></a>
<a name="line-308"></a>
<a name="line-309"></a><a name="DocMarkup"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>DocMarkup</span> <span class='hs-varid'>id</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Markup</span> <span class='hs-layout'>{</span>
<a name="line-310"></a> <span class='hs-varid'>markupEmpty</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span>
<a name="line-311"></a> <span class='hs-varid'>markupString</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span>
<a name="line-312"></a> <span class='hs-varid'>markupParagraph</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span>
<a name="line-313"></a> <span class='hs-varid'>markupAppend</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span>
<a name="line-314"></a> <span class='hs-varid'>markupIdentifier</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>id</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span>
<a name="line-315"></a> <span class='hs-varid'>markupModule</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span>
<a name="line-316"></a> <span class='hs-varid'>markupEmphasis</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span>
<a name="line-317"></a> <span class='hs-varid'>markupMonospaced</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span>
<a name="line-318"></a> <span class='hs-varid'>markupUnorderedList</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>a</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span>
<a name="line-319"></a> <span class='hs-varid'>markupOrderedList</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>a</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span>
<a name="line-320"></a> <span class='hs-varid'>markupDefList</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-varid'>a</span><span class='hs-layout'>,</span><span class='hs-varid'>a</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span>
<a name="line-321"></a> <span class='hs-varid'>markupCodeBlock</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span>
<a name="line-322"></a> <span class='hs-varid'>markupURL</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span>
<a name="line-323"></a> <span class='hs-varid'>markupAName</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span>
<a name="line-324"></a> <span class='hs-varid'>markupPic</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span>
<a name="line-325"></a><span class='hs-layout'>}</span>
<a name="line-326"></a>
<a name="line-327"></a>
<a name="line-328"></a><a name="HaddockModInfo"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>HaddockModInfo</span> <span class='hs-varid'>name</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>HaddockModInfo</span> <span class='hs-layout'>{</span>
<a name="line-329"></a> <span class='hs-varid'>hmi_description</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Maybe</span> <span class='hs-layout'>(</span><span class='hs-conid'>Doc</span> <span class='hs-varid'>name</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-330"></a> <span class='hs-varid'>hmi_portability</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>String</span><span class='hs-layout'>,</span>
<a name="line-331"></a> <span class='hs-varid'>hmi_stability</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>String</span><span class='hs-layout'>,</span>
<a name="line-332"></a> <span class='hs-varid'>hmi_maintainer</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>String</span>
<a name="line-333"></a><span class='hs-layout'>}</span>
<a name="line-334"></a>
<a name="line-335"></a>
<a name="line-336"></a><a name="emptyHaddockModInfo"></a><span class='hs-definition'>emptyHaddockModInfo</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>HaddockModInfo</span> <span class='hs-varid'>a</span>
<a name="line-337"></a><span class='hs-definition'>emptyHaddockModInfo</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>HaddockModInfo</span> <span class='hs-layout'>{</span>
<a name="line-338"></a> <span class='hs-varid'>hmi_description</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Nothing</span><span class='hs-layout'>,</span>
<a name="line-339"></a> <span class='hs-varid'>hmi_portability</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Nothing</span><span class='hs-layout'>,</span>
<a name="line-340"></a> <span class='hs-varid'>hmi_stability</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Nothing</span><span class='hs-layout'>,</span>
<a name="line-341"></a> <span class='hs-varid'>hmi_maintainer</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Nothing</span>
<a name="line-342"></a><span class='hs-layout'>}</span>
<a name="line-343"></a>
<a name="line-344"></a>
<a name="line-345"></a><span class='hs-comment'>-- A monad which collects error messages, locally defined to avoid a dep on mtl</span>
<a name="line-346"></a>
<a name="line-347"></a><a name="ErrMsg"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>ErrMsg</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>String</span>
<a name="line-348"></a>
<a name="line-349"></a><a name="ErrMsgM"></a><span class='hs-keyword'>newtype</span> <span class='hs-conid'>ErrMsgM</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Writer</span> <span class='hs-layout'>{</span> <span class='hs-varid'>runWriter</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>ErrMsg</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span> <span class='hs-layout'>}</span>
<a name="line-350"></a>
<a name="line-351"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Functor</span> <span class='hs-conid'>ErrMsgM</span> <span class='hs-keyword'>where</span>
<a name="line-352"></a> <span class='hs-varid'>fmap</span> <span class='hs-varid'>f</span> <span class='hs-layout'>(</span><span class='hs-conid'>Writer</span> <span class='hs-layout'>(</span><span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-varid'>msgs</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Writer</span> <span class='hs-layout'>(</span><span class='hs-varid'>f</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-varid'>msgs</span><span class='hs-layout'>)</span>
<a name="line-353"></a>
<a name="line-354"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Monad</span> <span class='hs-conid'>ErrMsgM</span> <span class='hs-keyword'>where</span>
<a name="line-355"></a> <span class='hs-varid'>return</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Writer</span> <span class='hs-layout'>(</span><span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>[]</span><span class='hs-layout'>)</span>
<a name="line-356"></a> <span class='hs-varid'>m</span> <span class='hs-varop'>>>=</span> <span class='hs-varid'>k</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Writer</span> <span class='hs-varop'>$</span> <span class='hs-keyword'>let</span>
<a name="line-357"></a> <span class='hs-layout'>(</span><span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-varid'>w</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>runWriter</span> <span class='hs-varid'>m</span>
<a name="line-358"></a> <span class='hs-layout'>(</span><span class='hs-varid'>b</span><span class='hs-layout'>,</span> <span class='hs-varid'>w'</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>runWriter</span> <span class='hs-layout'>(</span><span class='hs-varid'>k</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span>
<a name="line-359"></a> <span class='hs-keyword'>in</span> <span class='hs-layout'>(</span><span class='hs-varid'>b</span><span class='hs-layout'>,</span> <span class='hs-varid'>w</span> <span class='hs-varop'>++</span> <span class='hs-varid'>w'</span><span class='hs-layout'>)</span>
<a name="line-360"></a>
<a name="line-361"></a><a name="tell"></a><span class='hs-definition'>tell</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>ErrMsg</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ErrMsgM</span> <span class='hs-conid'>()</span>
<a name="line-362"></a><span class='hs-definition'>tell</span> <span class='hs-varid'>w</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Writer</span> <span class='hs-layout'>(</span><span class='hs-conid'>()</span><span class='hs-layout'>,</span> <span class='hs-varid'>w</span><span class='hs-layout'>)</span>
<a name="line-363"></a>
<a name="line-364"></a>
<a name="line-365"></a><span class='hs-comment'>-- Exceptions</span>
<a name="line-366"></a>
<a name="line-367"></a><a name="HaddockException"></a><span class='hs-comment'>-- | Haddock's own exception type</span>
<a name="line-368"></a><a name="HaddockException"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>HaddockException</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>HaddockException</span> <span class='hs-conid'>String</span> <span class='hs-keyword'>deriving</span> <span class='hs-conid'>Typeable</span>
<a name="line-369"></a>
<a name="line-370"></a>
<a name="line-371"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Show</span> <span class='hs-conid'>HaddockException</span> <span class='hs-keyword'>where</span>
<a name="line-372"></a> <span class='hs-varid'>show</span> <span class='hs-layout'>(</span><span class='hs-conid'>HaddockException</span> <span class='hs-varid'>str</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>str</span>
<a name="line-373"></a>
<a name="line-374"></a>
<a name="line-375"></a><a name="throwE"></a><span class='hs-definition'>throwE</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span>
<a name="line-376"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Exception</span> <span class='hs-conid'>HaddockException</span>
<a name="line-377"></a><span class='hs-definition'>throwE</span> <span class='hs-varid'>str</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>throw</span> <span class='hs-layout'>(</span><span class='hs-conid'>HaddockException</span> <span class='hs-varid'>str</span><span class='hs-layout'>)</span>
<a name="line-378"></a>
<a name="line-379"></a><a name="ErrMsgGhc"></a><span class='hs-comment'>-- In "Haddock.Interface.Create", we need to gather</span>
<a name="line-380"></a><a name="ErrMsgGhc"></a><span class='hs-comment'>-- @Haddock.Types.ErrMsg@s a lot, like @ErrMsgM@ does,</span>
<a name="line-381"></a><a name="ErrMsgGhc"></a><span class='hs-comment'>-- but we can't just use @GhcT ErrMsgM@ because GhcT requires the</span>
<a name="line-382"></a><a name="ErrMsgGhc"></a><span class='hs-comment'>-- transformed monad to be MonadIO.</span>
<a name="line-383"></a><a name="ErrMsgGhc"></a><span class='hs-keyword'>newtype</span> <span class='hs-conid'>ErrMsgGhc</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>WriterGhc</span> <span class='hs-layout'>{</span> <span class='hs-varid'>runWriterGhc</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Ghc</span> <span class='hs-layout'>(</span><span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>ErrMsg</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-layout'>}</span>
<a name="line-384"></a><a name="liftGhcToErrMsgGhc"></a><span class='hs-comment'>--instance MonadIO ErrMsgGhc where</span>
<a name="line-385"></a><span class='hs-comment'>-- liftIO = WriterGhc . fmap (\a->(a,[])) liftIO</span>
<a name="line-386"></a><span class='hs-comment'>--er, implementing GhcMonad involves annoying ExceptionMonad and</span>
<a name="line-387"></a><span class='hs-comment'>--WarnLogMonad classes, so don't bother.</span>
<a name="line-388"></a><span class='hs-definition'>liftGhcToErrMsgGhc</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Ghc</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ErrMsgGhc</span> <span class='hs-varid'>a</span>
<a name="line-389"></a><span class='hs-definition'>liftGhcToErrMsgGhc</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>WriterGhc</span> <span class='hs-varop'>.</span> <span class='hs-varid'>fmap</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>a</span><span class='hs-keyglyph'>-></span><span class='hs-layout'>(</span><span class='hs-varid'>a</span><span class='hs-layout'>,</span><span class='hs-conid'>[]</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-390"></a><a name="liftErrMsg"></a><span class='hs-definition'>liftErrMsg</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ErrMsgM</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ErrMsgGhc</span> <span class='hs-varid'>a</span>
<a name="line-391"></a><span class='hs-definition'>liftErrMsg</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>WriterGhc</span> <span class='hs-varop'>.</span> <span class='hs-varid'>return</span> <span class='hs-varop'>.</span> <span class='hs-varid'>runWriter</span>
<a name="line-392"></a><span class='hs-comment'>-- for now, use (liftErrMsg . tell) for this</span>
<a name="line-393"></a><span class='hs-comment'>--tell :: [ErrMsg] -> ErrMsgGhc ()</span>
<a name="line-394"></a><span class='hs-comment'>--tell msgs = WriterGhc $ return ( (), msgs )</span>
<a name="line-395"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Functor</span> <span class='hs-conid'>ErrMsgGhc</span> <span class='hs-keyword'>where</span>
<a name="line-396"></a> <span class='hs-varid'>fmap</span> <span class='hs-varid'>f</span> <span class='hs-layout'>(</span><span class='hs-conid'>WriterGhc</span> <span class='hs-varid'>x</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>WriterGhc</span> <span class='hs-layout'>(</span><span class='hs-varid'>fmap</span> <span class='hs-layout'>(</span><span class='hs-varid'>first</span> <span class='hs-varid'>f</span><span class='hs-layout'>)</span> <span class='hs-varid'>x</span><span class='hs-layout'>)</span>
<a name="line-397"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Monad</span> <span class='hs-conid'>ErrMsgGhc</span> <span class='hs-keyword'>where</span>
<a name="line-398"></a> <span class='hs-varid'>return</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>WriterGhc</span> <span class='hs-layout'>(</span><span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>[]</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-399"></a> <span class='hs-varid'>m</span> <span class='hs-varop'>>>=</span> <span class='hs-varid'>k</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>WriterGhc</span> <span class='hs-varop'>$</span> <span class='hs-varid'>runWriterGhc</span> <span class='hs-varid'>m</span> <span class='hs-varop'>>>=</span> <span class='hs-keyglyph'>\</span> <span class='hs-layout'>(</span><span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-varid'>msgs1</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span>
<a name="line-400"></a> <span class='hs-varid'>fmap</span> <span class='hs-layout'>(</span><span class='hs-varid'>second</span> <span class='hs-layout'>(</span><span class='hs-varid'>msgs1</span> <span class='hs-varop'>++</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>runWriterGhc</span> <span class='hs-layout'>(</span><span class='hs-varid'>k</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
</pre></body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
33ad064c4b642ed30353356a1d094330
>
files
>
105
