<?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/Backends/DevHelp.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.Backends.DevHelp</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</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'>Backends</span><span class='hs-varop'>.</span><span class='hs-conid'>DevHelp</span> <span class='hs-layout'>(</span><span class='hs-varid'>ppDevHelpFile</span><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span> <a name="line-14"></a> <a name="line-15"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Haddock</span><span class='hs-varop'>.</span><span class='hs-conid'>ModuleTree</span> <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> <span class='hs-varid'>hiding</span> <span class='hs-layout'>(</span><span class='hs-conid'>Doc</span><span class='hs-layout'>)</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'>Utils</span> <a name="line-18"></a> <a name="line-19"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Module</span> <a name="line-20"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Name</span> <span class='hs-layout'>(</span> <span class='hs-conid'>Name</span><span class='hs-layout'>,</span> <span class='hs-varid'>nameModule</span><span class='hs-layout'>,</span> <span class='hs-varid'>getOccString</span><span class='hs-layout'>,</span> <span class='hs-varid'>nameOccName</span> <span class='hs-layout'>)</span> <a name="line-21"></a> <a name="line-22"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Maybe</span> <span class='hs-layout'>(</span> <span class='hs-varid'>fromMaybe</span> <span class='hs-layout'>)</span> <a name="line-23"></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-24"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>PrettyPrint</span> <a name="line-25"></a> <a name="line-26"></a><a name="ppDevHelpFile"></a><span class='hs-definition'>ppDevHelpFile</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>FilePath</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Interface</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span> <a name="line-27"></a><span class='hs-definition'>ppDevHelpFile</span> <span class='hs-varid'>odir</span> <span class='hs-varid'>doctitle</span> <span class='hs-varid'>maybe_package</span> <span class='hs-varid'>ifaces</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span> <a name="line-28"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>devHelpFile</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>package</span><span class='hs-varop'>++</span><span class='hs-str'>".devhelp"</span> <a name="line-29"></a> <span class='hs-varid'>tree</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mkModuleTree</span> <span class='hs-conid'>True</span> <span class='hs-keyglyph'>[</span> <span class='hs-layout'>(</span><span class='hs-varid'>ifaceMod</span> <span class='hs-varid'>iface</span><span class='hs-layout'>,</span> <span class='hs-varid'>toDescription</span> <span class='hs-varid'>iface</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>iface</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>ifaces</span> <span class='hs-keyglyph'>]</span> <a name="line-30"></a> <span class='hs-varid'>doc</span> <span class='hs-keyglyph'>=</span> <a name="line-31"></a> <span class='hs-varid'>text</span> <span class='hs-str'>"<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"no\"?>"</span> <span class='hs-varop'>$$</span> <a name="line-32"></a> <span class='hs-layout'>(</span><span class='hs-varid'>text</span> <span class='hs-str'>"<book xmlns=\"http://www.devhelp.net/book\" title=\""</span><span class='hs-varop'><></span><span class='hs-varid'>text</span> <span class='hs-varid'>doctitle</span><span class='hs-varop'><></span> <a name="line-33"></a> <span class='hs-varid'>text</span> <span class='hs-str'>"\" link=\""</span><span class='hs-varop'><></span><span class='hs-varid'>text</span> <span class='hs-varid'>contentsHtmlFile</span><span class='hs-varop'><></span><span class='hs-varid'>text</span><span class='hs-str'>"\" author=\"\" name=\""</span><span class='hs-varop'><></span><span class='hs-varid'>text</span> <span class='hs-varid'>package</span><span class='hs-varop'><></span><span class='hs-varid'>text</span> <span class='hs-str'>"\">"</span><span class='hs-layout'>)</span> <span class='hs-varop'>$$</span> <a name="line-34"></a> <span class='hs-varid'>text</span> <span class='hs-str'>"<chapters>"</span> <span class='hs-varop'>$$</span> <a name="line-35"></a> <span class='hs-varid'>nest</span> <span class='hs-num'>4</span> <span class='hs-layout'>(</span><span class='hs-varid'>ppModuleTree</span> <span class='hs-conid'>[]</span> <span class='hs-varid'>tree</span><span class='hs-layout'>)</span> <span class='hs-varop'>$+$</span> <a name="line-36"></a> <span class='hs-varid'>text</span> <span class='hs-str'>"</chapters>"</span> <span class='hs-varop'>$$</span> <a name="line-37"></a> <span class='hs-varid'>text</span> <span class='hs-str'>"<functions>"</span> <span class='hs-varop'>$$</span> <a name="line-38"></a> <span class='hs-varid'>nest</span> <span class='hs-num'>4</span> <span class='hs-layout'>(</span><span class='hs-varid'>ppList</span> <span class='hs-varid'>index</span><span class='hs-layout'>)</span> <span class='hs-varop'>$+$</span> <a name="line-39"></a> <span class='hs-varid'>text</span> <span class='hs-str'>"</functions>"</span> <span class='hs-varop'>$$</span> <a name="line-40"></a> <span class='hs-varid'>text</span> <span class='hs-str'>"</book>"</span> <a name="line-41"></a> <span class='hs-varid'>writeFile</span> <span class='hs-layout'>(</span><span class='hs-varid'>pathJoin</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>odir</span><span class='hs-layout'>,</span> <span class='hs-varid'>devHelpFile</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>render</span> <span class='hs-varid'>doc</span><span class='hs-layout'>)</span> <a name="line-42"></a> <span class='hs-keyword'>where</span> <a name="line-43"></a> <span class='hs-varid'>package</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fromMaybe</span> <span class='hs-str'>"pkg"</span> <span class='hs-varid'>maybe_package</span> <a name="line-44"></a> <a name="line-45"></a> <span class='hs-varid'>ppModuleTree</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>ModuleTree</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <a name="line-46"></a> <span class='hs-varid'>ppModuleTree</span> <span class='hs-varid'>ss</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>x</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ppNode</span> <span class='hs-varid'>ss</span> <span class='hs-varid'>x</span> <a name="line-47"></a> <span class='hs-varid'>ppModuleTree</span> <span class='hs-varid'>ss</span> <span class='hs-layout'>(</span><span class='hs-varid'>x</span><span class='hs-conop'>:</span><span class='hs-varid'>xs</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ppNode</span> <span class='hs-varid'>ss</span> <span class='hs-varid'>x</span> <span class='hs-varop'>$$</span> <span class='hs-varid'>ppModuleTree</span> <span class='hs-varid'>ss</span> <span class='hs-varid'>xs</span> <a name="line-48"></a> <span class='hs-varid'>ppModuleTree</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'>"HaddockHH.ppHHContents.fn: no module trees given"</span> <a name="line-49"></a> <a name="line-50"></a> <span class='hs-varid'>ppNode</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ModuleTree</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <a name="line-51"></a> <span class='hs-varid'>ppNode</span> <span class='hs-varid'>ss</span> <span class='hs-layout'>(</span><span class='hs-conid'>Node</span> <span class='hs-varid'>s</span> <span class='hs-varid'>leaf</span> <span class='hs-keyword'>_</span> <span class='hs-sel'>_short</span> <span class='hs-varid'>ts</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <a name="line-52"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>ts</span> <span class='hs-keyword'>of</span> <a name="line-53"></a> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>text</span> <span class='hs-str'>"<sub"</span><span class='hs-varop'><+></span><span class='hs-varid'>ppAttribs</span><span class='hs-varop'><></span><span class='hs-varid'>text</span> <span class='hs-str'>"/>"</span> <a name="line-54"></a> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-></span> <a name="line-55"></a> <span class='hs-varid'>text</span> <span class='hs-str'>"<sub"</span><span class='hs-varop'><+></span><span class='hs-varid'>ppAttribs</span><span class='hs-varop'><></span><span class='hs-varid'>text</span> <span class='hs-str'>">"</span> <span class='hs-varop'>$$</span> <a name="line-56"></a> <span class='hs-varid'>nest</span> <span class='hs-num'>4</span> <span class='hs-layout'>(</span><span class='hs-varid'>ppModuleTree</span> <span class='hs-layout'>(</span><span class='hs-varid'>s</span><span class='hs-conop'>:</span><span class='hs-varid'>ss</span><span class='hs-layout'>)</span> <span class='hs-varid'>ts</span><span class='hs-layout'>)</span> <span class='hs-varop'>$+$</span> <a name="line-57"></a> <span class='hs-varid'>text</span> <span class='hs-str'>"</sub>"</span> <a name="line-58"></a> <span class='hs-keyword'>where</span> <a name="line-59"></a> <span class='hs-varid'>ppLink</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>leaf</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>text</span> <span class='hs-layout'>(</span><span class='hs-varid'>moduleHtmlFile</span> <span class='hs-layout'>(</span><span class='hs-varid'>mkModule</span> <span class='hs-layout'>(</span><span class='hs-varid'>stringToPackageId</span> <span class='hs-str'>""</span><span class='hs-layout'>)</span> <a name="line-60"></a> <span class='hs-layout'>(</span><span class='hs-varid'>mkModuleName</span> <span class='hs-varid'>mdl</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <a name="line-61"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>empty</span> <a name="line-62"></a> <a name="line-63"></a> <span class='hs-varid'>ppAttribs</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>text</span> <span class='hs-str'>"name="</span><span class='hs-varop'><></span><span class='hs-varid'>doubleQuotes</span> <span class='hs-layout'>(</span><span class='hs-varid'>text</span> <span class='hs-varid'>s</span><span class='hs-layout'>)</span><span class='hs-varop'><+></span><span class='hs-varid'>text</span> <span class='hs-str'>"link="</span><span class='hs-varop'><></span><span class='hs-varid'>doubleQuotes</span> <span class='hs-varid'>ppLink</span> <a name="line-64"></a> <a name="line-65"></a> <span class='hs-varid'>mdl</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>foldr</span> <span class='hs-layout'>(</span><span class='hs-varop'>++</span><span class='hs-layout'>)</span> <span class='hs-str'>""</span> <span class='hs-layout'>(</span><span class='hs-varid'>s'</span> <span class='hs-conop'>:</span> <span class='hs-varid'>map</span> <span class='hs-layout'>(</span><span class='hs-chr'>'.'</span><span class='hs-conop'>:</span><span class='hs-layout'>)</span> <span class='hs-varid'>ss'</span><span class='hs-layout'>)</span> <a name="line-66"></a> <span class='hs-layout'>(</span><span class='hs-varid'>s'</span><span class='hs-conop'>:</span><span class='hs-varid'>ss'</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>reverse</span> <span class='hs-layout'>(</span><span class='hs-varid'>s</span><span class='hs-conop'>:</span><span class='hs-varid'>ss</span><span class='hs-layout'>)</span> <a name="line-67"></a> <span class='hs-comment'>-- reconstruct the module name</span> <a name="line-68"></a> <a name="line-69"></a> <span class='hs-varid'>index</span> <span class='hs-keyglyph'>::</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-keyglyph'>[</span><span class='hs-conid'>Module</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span> <a name="line-70"></a> <span class='hs-varid'>index</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>toAscList</span> <span class='hs-layout'>(</span><span class='hs-varid'>foldr</span> <span class='hs-varid'>getModuleIndex</span> <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>empty</span> <span class='hs-varid'>ifaces</span><span class='hs-layout'>)</span> <a name="line-71"></a> <a name="line-72"></a> <span class='hs-varid'>getModuleIndex</span> <span class='hs-varid'>iface</span> <span class='hs-varid'>fm</span> <span class='hs-keyglyph'>=</span> <a name="line-73"></a> <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>unionWith</span> <span class='hs-layout'>(</span><span class='hs-varop'>++</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'>fromListWith</span> <span class='hs-layout'>(</span><span class='hs-varid'>flip</span> <span class='hs-layout'>(</span><span class='hs-varop'>++</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'>name</span><span class='hs-layout'>,</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>mdl</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>name</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>ifaceExports</span> <span class='hs-varid'>iface</span><span class='hs-layout'>,</span> <span class='hs-varid'>nameModule</span> <span class='hs-varid'>name</span> <span class='hs-varop'>==</span> <span class='hs-varid'>mdl</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span> <span class='hs-varid'>fm</span> <a name="line-74"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>mdl</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ifaceMod</span> <span class='hs-varid'>iface</span> <a name="line-75"></a> <a name="line-76"></a> <span class='hs-varid'>ppList</span> <span class='hs-keyglyph'>::</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-keyglyph'>[</span><span class='hs-conid'>Module</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <a name="line-77"></a> <span class='hs-varid'>ppList</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>empty</span> <a name="line-78"></a> <span class='hs-varid'>ppList</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-varid'>name</span><span class='hs-layout'>,</span><span class='hs-varid'>refs</span><span class='hs-layout'>)</span><span class='hs-conop'>:</span><span class='hs-varid'>mdls</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <a name="line-79"></a> <span class='hs-varid'>ppReference</span> <span class='hs-varid'>name</span> <span class='hs-varid'>refs</span> <span class='hs-varop'>$$</span> <a name="line-80"></a> <span class='hs-varid'>ppList</span> <span class='hs-varid'>mdls</span> <a name="line-81"></a> <a name="line-82"></a> <span class='hs-varid'>ppReference</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Name</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Module</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <a name="line-83"></a> <span class='hs-varid'>ppReference</span> <span class='hs-keyword'>_</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>empty</span> <a name="line-84"></a> <span class='hs-varid'>ppReference</span> <span class='hs-varid'>name</span> <span class='hs-layout'>(</span><span class='hs-varid'>mdl</span><span class='hs-conop'>:</span><span class='hs-varid'>refs</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <a name="line-85"></a> <span class='hs-varid'>text</span> <span class='hs-str'>"<function name=\""</span><span class='hs-varop'><></span><span class='hs-varid'>text</span> <span class='hs-layout'>(</span><span class='hs-varid'>escapeStr</span> <span class='hs-layout'>(</span><span class='hs-varid'>getOccString</span> <span class='hs-varid'>name</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-varop'><></span><span class='hs-varid'>text</span><span class='hs-str'>"\" link=\""</span><span class='hs-varop'><></span><span class='hs-varid'>text</span> <span class='hs-layout'>(</span><span class='hs-varid'>nameHtmlRef</span> <span class='hs-varid'>mdl</span> <span class='hs-layout'>(</span><span class='hs-varid'>nameOccName</span> <span class='hs-varid'>name</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-varop'><></span><span class='hs-varid'>text</span><span class='hs-str'>"\"/>"</span> <span class='hs-varop'>$$</span> <a name="line-86"></a> <span class='hs-varid'>ppReference</span> <span class='hs-varid'>name</span> <span class='hs-varid'>refs</span> </pre></body> </html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
33ad064c4b642ed30353356a1d094330
>
files
>
83
