<?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/LexParseRn.hs</title> <link type='text/css' rel='stylesheet' href='hscolour.css' /> </head> <body> <pre><a name="line-1"></a> <a name="line-2"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span> <a name="line-3"></a><span class='hs-comment'>-- |</span> <a name="line-4"></a><span class='hs-comment'>-- Module : Haddock.Interface.LexParseRn</span> <a name="line-5"></a><span class='hs-comment'>-- Copyright : (c) Isaac Dupree 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'>LexParseRn</span> <span class='hs-layout'>(</span> <a name="line-14"></a> <span class='hs-conid'>HaddockCommentType</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <a name="line-15"></a> <span class='hs-varid'>lexParseRnHaddockComment</span><span class='hs-layout'>,</span> <a name="line-16"></a> <span class='hs-varid'>lexParseRnHaddockCommentList</span><span class='hs-layout'>,</span> <a name="line-17"></a> <span class='hs-varid'>lexParseRnMbHaddockComment</span><span class='hs-layout'>,</span> <a name="line-18"></a> <span class='hs-varid'>lexParseRnHaddockModHeader</span> <a name="line-19"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span> <a name="line-20"></a> <a name="line-21"></a><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-22"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Haddock</span><span class='hs-varop'>.</span><span class='hs-conid'>Lex</span> <a name="line-23"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Haddock</span><span class='hs-varop'>.</span><span class='hs-conid'>Parse</span> <a name="line-24"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Haddock</span><span class='hs-varop'>.</span><span class='hs-conid'>Interface</span><span class='hs-varop'>.</span><span class='hs-conid'>Rn</span> <a name="line-25"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Haddock</span><span class='hs-varop'>.</span><span class='hs-conid'>Interface</span><span class='hs-varop'>.</span><span class='hs-conid'>ParseModuleHeader</span> <a name="line-26"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Haddock</span><span class='hs-varop'>.</span><span class='hs-conid'>Doc</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'>FastString</span> <a name="line-29"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>GHC</span> <a name="line-30"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>RdrName</span> <a name="line-31"></a> <a name="line-32"></a><a name="HaddockCommentType"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>HaddockCommentType</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>NormalHaddockComment</span> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>DocSectionComment</span> <a name="line-33"></a> <a name="line-34"></a><a name="lexParseRnHaddockCommentList"></a><span class='hs-definition'>lexParseRnHaddockCommentList</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>HaddockCommentType</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>GlobalRdrEnv</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>HsDocString</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ErrMsgM</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> <a name="line-35"></a><span class='hs-definition'>lexParseRnHaddockCommentList</span> <span class='hs-varid'>hty</span> <span class='hs-varid'>gre</span> <span class='hs-varid'>docStrs</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span> <a name="line-36"></a> <span class='hs-varid'>docMbs</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>mapM</span> <span class='hs-layout'>(</span><span class='hs-varid'>lexParseRnHaddockComment</span> <span class='hs-varid'>hty</span> <span class='hs-varid'>gre</span><span class='hs-layout'>)</span> <span class='hs-varid'>docStrs</span> <a name="line-37"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>docs</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>catMaybes</span> <span class='hs-varid'>docMbs</span> <a name="line-38"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>doc</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>foldl</span> <span class='hs-varid'>docAppend</span> <span class='hs-conid'>DocEmpty</span> <span class='hs-varid'>docs</span> <a name="line-39"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>doc</span> <span class='hs-keyword'>of</span> <a name="line-40"></a> <span class='hs-conid'>DocEmpty</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-conid'>Nothing</span> <a name="line-41"></a> <span class='hs-keyword'>_</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-42"></a> <a name="line-43"></a><a name="lexParseRnHaddockComment"></a><span class='hs-definition'>lexParseRnHaddockComment</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>HaddockCommentType</span> <span class='hs-keyglyph'>-></span> <a name="line-44"></a> <span class='hs-conid'>GlobalRdrEnv</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>HsDocString</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ErrMsgM</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> <a name="line-45"></a><span class='hs-definition'>lexParseRnHaddockComment</span> <span class='hs-varid'>hty</span> <span class='hs-varid'>gre</span> <span class='hs-layout'>(</span><span class='hs-conid'>HsDocString</span> <span class='hs-varid'>fs</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span> <a name="line-46"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>str</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>unpackFS</span> <span class='hs-varid'>fs</span> <a name="line-47"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>toks</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>tokenise</span> <span class='hs-varid'>str</span> <a name="line-48"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>parse</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>hty</span> <span class='hs-keyword'>of</span> <a name="line-49"></a> <span class='hs-conid'>NormalHaddockComment</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>parseParas</span> <a name="line-50"></a> <span class='hs-conid'>DocSectionComment</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>parseString</span> <a name="line-51"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>parse</span> <span class='hs-varid'>toks</span> <span class='hs-keyword'>of</span> <a name="line-52"></a> <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span> <a name="line-53"></a> <span class='hs-varid'>tell</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"doc comment parse failed: "</span><span class='hs-varop'>++</span><span class='hs-varid'>str</span><span class='hs-keyglyph'>]</span> <a name="line-54"></a> <span class='hs-varid'>return</span> <span class='hs-conid'>Nothing</span> <a name="line-55"></a> <span class='hs-conid'>Just</span> <span class='hs-varid'>doc</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-layout'>(</span><span class='hs-varid'>rnDoc</span> <span class='hs-varid'>gre</span> <span class='hs-varid'>doc</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <a name="line-56"></a> <a name="line-57"></a><a name="lexParseRnMbHaddockComment"></a><span class='hs-definition'>lexParseRnMbHaddockComment</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>HaddockCommentType</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>GlobalRdrEnv</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>HsDocString</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ErrMsgM</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> <a name="line-58"></a><span class='hs-definition'>lexParseRnMbHaddockComment</span> <span class='hs-keyword'>_</span> <span class='hs-keyword'>_</span> <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-conid'>Nothing</span> <a name="line-59"></a><span class='hs-definition'>lexParseRnMbHaddockComment</span> <span class='hs-varid'>hty</span> <span class='hs-varid'>gre</span> <span class='hs-layout'>(</span><span class='hs-conid'>Just</span> <span class='hs-varid'>d</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>lexParseRnHaddockComment</span> <span class='hs-varid'>hty</span> <span class='hs-varid'>gre</span> <span class='hs-varid'>d</span> <a name="line-60"></a> <a name="line-61"></a><a name="lexParseRnHaddockModHeader"></a><span class='hs-comment'>-- yes, you always get a HaddockModInfo though it might be empty</span> <a name="line-62"></a><span class='hs-definition'>lexParseRnHaddockModHeader</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>GlobalRdrEnv</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>GhcDocHdr</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ErrMsgM</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-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> <a name="line-63"></a><span class='hs-definition'>lexParseRnHaddockModHeader</span> <span class='hs-varid'>gre</span> <span class='hs-varid'>mbStr</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span> <a name="line-64"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>failure</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>emptyHaddockModInfo</span><span class='hs-layout'>,</span> <span class='hs-conid'>Nothing</span><span class='hs-layout'>)</span> <a name="line-65"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>mbStr</span> <span class='hs-keyword'>of</span> <a name="line-66"></a> <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-varid'>failure</span> <a name="line-67"></a> <span class='hs-conid'>Just</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'>HsDocString</span> <span class='hs-varid'>fs</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span> <a name="line-68"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>str</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>unpackFS</span> <span class='hs-varid'>fs</span> <a name="line-69"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>parseModuleHeader</span> <span class='hs-varid'>str</span> <span class='hs-keyword'>of</span> <a name="line-70"></a> <span class='hs-conid'>Left</span> <span class='hs-varid'>mess</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span> <a name="line-71"></a> <span class='hs-varid'>tell</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"haddock module header parse failed: "</span> <span class='hs-varop'>++</span> <span class='hs-varid'>mess</span><span class='hs-keyglyph'>]</span> <a name="line-72"></a> <span class='hs-varid'>return</span> <span class='hs-varid'>failure</span> <a name="line-73"></a> <span class='hs-conid'>Right</span> <span class='hs-layout'>(</span><span class='hs-varid'>info</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-74"></a> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-varid'>rnHaddockModInfo</span> <span class='hs-varid'>gre</span> <span class='hs-varid'>info</span><span class='hs-layout'>,</span> <span class='hs-conid'>Just</span> <span class='hs-layout'>(</span><span class='hs-varid'>rnDoc</span> <span class='hs-varid'>gre</span> <span class='hs-varid'>doc</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
>
95
