<?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/ForSyDe/Backend/Ppr.hs</title> <link type='text/css' rel='stylesheet' href='hscolour.css' /> </head> <body> <pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE MultiParamTypeClasses, FunctionalDependencies #-}</span> <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 : ForSyDe.Backend.VHDL.Ppr</span> <a name="line-5"></a><span class='hs-comment'>-- Copyright : (c) SAM Group, KTH/ICT/ECS 2007-2008</span> <a name="line-6"></a><span class='hs-comment'>-- License : BSD-style (see the file LICENSE)</span> <a name="line-7"></a><span class='hs-comment'>-- </span> <a name="line-8"></a><span class='hs-comment'>-- Maintainer : forsyde-dev@ict.kth.se</span> <a name="line-9"></a><span class='hs-comment'>-- Stability : experimental</span> <a name="line-10"></a><span class='hs-comment'>-- Portability : non-portable (Template Haskell)</span> <a name="line-11"></a><span class='hs-comment'>--</span> <a name="line-12"></a><span class='hs-comment'>-- ForSyDe pretty-printing class and auxiliar functions.</span> <a name="line-13"></a><span class='hs-comment'>--</span> <a name="line-14"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span> <a name="line-15"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>ForSyDe</span><span class='hs-varop'>.</span><span class='hs-conid'>Backend</span><span class='hs-varop'>.</span><span class='hs-conid'>Ppr</span> <span class='hs-keyword'>where</span> <a name="line-16"></a> <a name="line-17"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>PrettyPrint</span><span class='hs-varop'>.</span><span class='hs-conid'>HughesPJ</span> <a name="line-18"></a> <a name="line-19"></a><a name="Ppr"></a><span class='hs-comment'>-- | Pretty printing class</span> <a name="line-20"></a><a name="Ppr"></a><span class='hs-keyword'>class</span> <span class='hs-conid'>Ppr</span> <span class='hs-varid'>a</span> <span class='hs-keyword'>where</span> <a name="line-21"></a> <span class='hs-varid'>ppr</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <a name="line-22"></a> <a name="line-23"></a><span class='hs-comment'>-- identity instantiation</span> <a name="line-24"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Ppr</span> <span class='hs-conid'>Doc</span> <span class='hs-keyword'>where</span> <a name="line-25"></a> <span class='hs-varid'>ppr</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>id</span> <a name="line-26"></a> <a name="line-27"></a><a name="PprOps"></a><span class='hs-comment'>-- | Pretty printing class with associated printing options</span> <a name="line-28"></a><a name="PprOps"></a><span class='hs-keyword'>class</span> <span class='hs-conid'>PprOps</span> <span class='hs-varid'>ops</span> <span class='hs-varid'>toPpr</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>toPpr</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>ops</span> <span class='hs-keyword'>where</span> <a name="line-29"></a> <span class='hs-comment'>-- NOTE: Would it be better to use a State Monad?</span> <a name="line-30"></a> <span class='hs-comment'>-- i.e. pprOps :: toPpr -> State ops Doc</span> <a name="line-31"></a> <span class='hs-varid'>pprOps</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>ops</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>toPpr</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <a name="line-32"></a> <a name="line-33"></a> <a name="line-34"></a><a name="dot"></a><span class='hs-comment'>-- dot</span> <a name="line-35"></a><span class='hs-definition'>dot</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Doc</span> <a name="line-36"></a><span class='hs-definition'>dot</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>char</span> <span class='hs-chr'>'.'</span> <a name="line-37"></a> <a name="line-38"></a><a name="vSpace"></a><span class='hs-comment'>-- One line vertical space</span> <a name="line-39"></a><span class='hs-definition'>vSpace</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Doc</span> <a name="line-40"></a><span class='hs-definition'>vSpace</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>text</span> <span class='hs-str'>""</span> <a name="line-41"></a> <a name="line-42"></a><a name="multiVSpace"></a><span class='hs-comment'>-- Multi-line vertical space</span> <a name="line-43"></a><span class='hs-definition'>multiVSpace</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <a name="line-44"></a><span class='hs-definition'>multiVSpace</span> <span class='hs-varid'>n</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>vcat</span> <span class='hs-layout'>(</span><span class='hs-varid'>replicate</span> <span class='hs-varid'>n</span> <span class='hs-layout'>(</span><span class='hs-varid'>text</span> <span class='hs-str'>""</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <a name="line-45"></a> <a name="line-46"></a><a name="ppr_list"></a><span class='hs-comment'>-- Pretty-print a list supplying the document joining function</span> <a name="line-47"></a><span class='hs-definition'>ppr_list</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Ppr</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=></span> <span class='hs-layout'>(</span><span class='hs-conid'>Doc</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</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-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <a name="line-48"></a><span class='hs-definition'>ppr_list</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-49"></a><span class='hs-definition'>ppr_list</span> <span class='hs-varid'>join</span> <span class='hs-layout'>(</span><span class='hs-varid'>a1</span><span class='hs-conop'>:</span><span class='hs-varid'>rest</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>go</span> <span class='hs-varid'>a1</span> <span class='hs-varid'>rest</span> <a name="line-50"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>go</span> <span class='hs-varid'>a1</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ppr</span> <span class='hs-varid'>a1</span> <a name="line-51"></a> <span class='hs-varid'>go</span> <span class='hs-varid'>a1</span> <span class='hs-layout'>(</span><span class='hs-varid'>a2</span><span class='hs-conop'>:</span><span class='hs-varid'>rest</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ppr</span> <span class='hs-varid'>a1</span> <span class='hs-varop'>`join`</span> <span class='hs-varid'>go</span> <span class='hs-varid'>a2</span> <span class='hs-varid'>rest</span> <a name="line-52"></a> <a name="line-53"></a><a name="pprOps_list"></a><span class='hs-comment'>-- Pretty-print a list supplying the document joining function</span> <a name="line-54"></a><span class='hs-comment'>-- (PprOps version)</span> <a name="line-55"></a><span class='hs-definition'>pprOps_list</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PprOps</span> <span class='hs-varid'>ops</span> <span class='hs-varid'>toPpr</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>ops</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>Doc</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>toPpr</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <a name="line-56"></a><span class='hs-definition'>pprOps_list</span> <span class='hs-keyword'>_</span> <span class='hs-keyword'>_</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>empty</span> <a name="line-57"></a><span class='hs-definition'>pprOps_list</span> <span class='hs-varid'>ops</span> <span class='hs-varid'>join</span> <span class='hs-layout'>(</span><span class='hs-varid'>a1</span><span class='hs-conop'>:</span><span class='hs-varid'>rest</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>go</span> <span class='hs-varid'>a1</span> <span class='hs-varid'>rest</span> <a name="line-58"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>go</span> <span class='hs-varid'>a1</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>pprOps</span> <span class='hs-varid'>ops</span> <span class='hs-varid'>a1</span> <a name="line-59"></a> <span class='hs-varid'>go</span> <span class='hs-varid'>a1</span> <span class='hs-layout'>(</span><span class='hs-varid'>a2</span><span class='hs-conop'>:</span><span class='hs-varid'>rest</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>pprOps</span> <span class='hs-varid'>ops</span> <span class='hs-varid'>a1</span> <span class='hs-varop'>`join`</span> <span class='hs-varid'>go</span> <span class='hs-varid'>a2</span> <span class='hs-varid'>rest</span> <a name="line-60"></a> <a name="line-61"></a><a name="vNSpaces"></a><span class='hs-comment'>-- | Join two documents vertically leaving n vertical spaces between them</span> <a name="line-62"></a><span class='hs-definition'>vNSpaces</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <a name="line-63"></a><span class='hs-definition'>vNSpaces</span> <span class='hs-varid'>n</span> <span class='hs-varid'>doc1</span> <span class='hs-varid'>doc2</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>doc1</span> <span class='hs-varop'>$+$</span> <a name="line-64"></a> <span class='hs-varid'>multiVSpace</span> <span class='hs-varid'>n</span> <span class='hs-varop'>$+$</span> <a name="line-65"></a> <span class='hs-varid'>doc2</span> <a name="line-66"></a> <a name="line-67"></a><a name="vSemi"></a><span class='hs-comment'>-- Join two documents vertically putting a semicolon in the middle</span> <a name="line-68"></a><span class='hs-definition'>vSemi</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Doc</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <a name="line-69"></a><span class='hs-definition'>vSemi</span> <span class='hs-varid'>doc1</span> <span class='hs-varid'>doc2</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>doc1</span> <span class='hs-varop'><></span> <span class='hs-varid'>semi</span> <span class='hs-varop'>$+$</span> <span class='hs-varid'>doc2</span> <a name="line-70"></a> <a name="line-71"></a> <a name="line-72"></a><a name="vComma"></a><span class='hs-comment'>-- Join two documents vertically putting a comma in the middle</span> <a name="line-73"></a><span class='hs-definition'>vComma</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Doc</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <a name="line-74"></a><span class='hs-definition'>vComma</span> <span class='hs-varid'>doc1</span> <span class='hs-varid'>doc2</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>doc1</span> <span class='hs-varop'><></span> <span class='hs-varid'>comma</span> <span class='hs-varop'>$+$</span> <span class='hs-varid'>doc2</span> <a name="line-75"></a> <a name="line-76"></a><a name="hComma"></a><span class='hs-comment'>-- Join two documents horizontally putting a comma in the middle</span> <a name="line-77"></a><span class='hs-definition'>hComma</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Doc</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <a name="line-78"></a><span class='hs-definition'>hComma</span> <span class='hs-varid'>doc1</span> <span class='hs-varid'>doc2</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>doc1</span> <span class='hs-varop'><></span> <span class='hs-varid'>comma</span> <span class='hs-varop'><+></span> <span class='hs-varid'>doc2</span> <a name="line-79"></a> <a name="line-80"></a> <a name="line-81"></a><a name="commaSep"></a><span class='hs-comment'>-- | apply sep to a list of prettyprintable elements, </span> <a name="line-82"></a><span class='hs-comment'>-- previously interspersing commas</span> <a name="line-83"></a><span class='hs-definition'>commaSep</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Ppr</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-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <a name="line-84"></a><span class='hs-definition'>commaSep</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>sep</span><span class='hs-varop'>.</span><span class='hs-layout'>(</span><span class='hs-varid'>punctuate</span> <span class='hs-varid'>comma</span><span class='hs-layout'>)</span><span class='hs-varop'>.</span><span class='hs-layout'>(</span><span class='hs-varid'>map</span> <span class='hs-varid'>ppr</span><span class='hs-layout'>)</span> <a name="line-85"></a> <a name="line-86"></a> <a name="line-87"></a><a name="$++$"></a><span class='hs-comment'>-- | Only append if both of the documents are non-empty</span> <a name="line-88"></a><span class='hs-layout'>(</span><span class='hs-varop'>$++$</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Doc</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <a name="line-89"></a><a name="d1"></a><span class='hs-definition'>d1</span> <span class='hs-varop'>$++$</span> <span class='hs-varid'>d2</span> <a name="line-90"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>isEmpty</span> <span class='hs-varid'>d1</span> <span class='hs-varop'>||</span> <span class='hs-varid'>isEmpty</span> <span class='hs-varid'>d2</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>empty</span> <a name="line-91"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>d1</span> <span class='hs-varop'>$+$</span> <span class='hs-varid'>d2</span> <a name="line-92"></a> <a name="line-93"></a> <a name="line-94"></a><a name="<++>"></a><span class='hs-comment'>-- | Only append if both of the documents are non-empty</span> <a name="line-95"></a><span class='hs-layout'>(</span><span class='hs-varop'><++></span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Doc</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <a name="line-96"></a><span class='hs-definition'>d1</span> <span class='hs-varop'><++></span> <span class='hs-varid'>d2</span> <a name="line-97"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>isEmpty</span> <span class='hs-varid'>d1</span> <span class='hs-varop'>||</span> <span class='hs-varid'>isEmpty</span> <span class='hs-varid'>d2</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>empty</span> <a name="line-98"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>d1</span> <span class='hs-varop'><+></span> <span class='hs-varid'>d2</span> <a name="line-99"></a> <a name="line-100"></a><a name="parensNonEmpty"></a><span class='hs-comment'>-- | Enclose in parenthesis only if the document is non-empty</span> <a name="line-101"></a><span class='hs-definition'>parensNonEmpty</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Doc</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <a name="line-102"></a><span class='hs-definition'>parensNonEmpty</span> <span class='hs-varid'>doc</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>isEmpty</span> <span class='hs-varid'>doc</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>empty</span> <a name="line-103"></a><span class='hs-definition'>parensNonEmpty</span> <span class='hs-varid'>doc</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>parens</span> <span class='hs-varid'>doc</span> <a name="line-104"></a> <a name="line-105"></a><a name="parensIf"></a><span class='hs-comment'>-- | Enclose in parenthesis only if the predicate is True</span> <a name="line-106"></a><span class='hs-definition'>parensIf</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Bool</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <a name="line-107"></a><span class='hs-definition'>parensIf</span> <span class='hs-varid'>p</span> <span class='hs-varid'>d</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>if</span> <span class='hs-varid'>p</span> <span class='hs-keyword'>then</span> <span class='hs-varid'>parens</span> <span class='hs-varid'>d</span> <span class='hs-keyword'>else</span> <span class='hs-varid'>d</span> </pre></body> </html>