hscolour-1.12: docs/hscolour/Language/Haskell/HsColour.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<html>
<head>
<!-- Generated by HsColour, http://www.cs.york.ac.uk/fp/darcs/hscolour/ -->
<title>Language/Haskell/HsColour.hs</title>
</head>
<body>
<pre><a name="line-1"></a><font color=Blue>-- | This is a library which colourises Haskell code.</font>
<a name="line-2"></a><font color=Blue>-- It currently has five output formats:</font>
<a name="line-3"></a><font color=Blue>--</font>
<a name="line-4"></a><font color=Blue>-- * ANSI terminal codes</font>
<a name="line-5"></a><font color=Blue>--</font>
<a name="line-6"></a><font color=Blue>-- * LaTeX macros</font>
<a name="line-7"></a><font color=Blue>--</font>
<a name="line-8"></a><font color=Blue>-- * HTML with font tags</font>
<a name="line-9"></a><font color=Blue>--</font>
<a name="line-10"></a><font color=Blue>-- * HTML with CSS.</font>
<a name="line-11"></a><font color=Blue>--</font>
<a name="line-12"></a><font color=Blue>-- * mIRC chat client colour codes.</font>
<a name="line-13"></a><font color=Blue>--</font>
<a name="line-14"></a><u><font color=Green>module</font></u> Language<font color=Cyan>.</font>Haskell<font color=Cyan>.</font>HsColour <font color=Cyan>(</font>Output<font color=Cyan>(</font><font color=Red>..</font><font color=Cyan>)</font><font color=Cyan>,</font> ColourPrefs<font color=Cyan>(</font><font color=Red>..</font><font color=Cyan>)</font><font color=Cyan>,</font>
<a name="line-15"></a> hscolour<font color=Cyan>)</font> <u><font color=Green>where</font></u>
<a name="line-16"></a>
<a name="line-17"></a><u><font color=Green>import</font></u> Language<font color=Cyan>.</font>Haskell<font color=Cyan>.</font>HsColour<font color=Cyan>.</font>Colourise <font color=Cyan>(</font>ColourPrefs<font color=Cyan>(</font><font color=Red>..</font><font color=Cyan>)</font><font color=Cyan>)</font>
<a name="line-18"></a><u><font color=Green>import</font></u> <u><font color=Green>qualified</font></u> Language<font color=Cyan>.</font>Haskell<font color=Cyan>.</font>HsColour<font color=Cyan>.</font>TTY <u><font color=Green>as</font></u> TTY
<a name="line-19"></a><u><font color=Green>import</font></u> <u><font color=Green>qualified</font></u> Language<font color=Cyan>.</font>Haskell<font color=Cyan>.</font>HsColour<font color=Cyan>.</font>HTML <u><font color=Green>as</font></u> HTML
<a name="line-20"></a><u><font color=Green>import</font></u> <u><font color=Green>qualified</font></u> Language<font color=Cyan>.</font>Haskell<font color=Cyan>.</font>HsColour<font color=Cyan>.</font>CSS <u><font color=Green>as</font></u> CSS
<a name="line-21"></a><u><font color=Green>import</font></u> <u><font color=Green>qualified</font></u> Language<font color=Cyan>.</font>Haskell<font color=Cyan>.</font>HsColour<font color=Cyan>.</font>LaTeX <u><font color=Green>as</font></u> LaTeX
<a name="line-22"></a><u><font color=Green>import</font></u> <u><font color=Green>qualified</font></u> Language<font color=Cyan>.</font>Haskell<font color=Cyan>.</font>HsColour<font color=Cyan>.</font>MIRC <u><font color=Green>as</font></u> MIRC
<a name="line-23"></a><u><font color=Green>import</font></u> Data<font color=Cyan>.</font>List<font color=Cyan>(</font>mapAccumL<font color=Cyan>,</font> isPrefixOf<font color=Cyan>)</font>
<a name="line-24"></a><u><font color=Green>import</font></u> Data<font color=Cyan>.</font>Maybe
<a name="line-25"></a><u><font color=Green>import</font></u> Language<font color=Cyan>.</font>Haskell<font color=Cyan>.</font>HsColour<font color=Cyan>.</font>Output
<a name="line-26"></a><u><font color=Green>import</font></u> Language<font color=Cyan>.</font>Haskell<font color=Cyan>.</font>HsColour<font color=Cyan>.</font>Options <font color=Cyan>(</font>Literate<font color=Cyan>(</font><font color=Red>..</font><font color=Cyan>)</font><font color=Cyan>)</font>
<a name="line-27"></a><u><font color=Green>import</font></u> Debug<font color=Cyan>.</font>Trace
<a name="line-28"></a>
<a name="line-29"></a><a name="hscolour"></a><font color=Blue>-- | Colourise Haskell source code with the given output format.</font>
<a name="line-30"></a>hscolour <font color=Red>::</font> Output <font color=Blue>-- ^ Output format.</font>
<a name="line-31"></a> <font color=Red>-></font> ColourPrefs <font color=Blue>-- ^ Colour preferences (for formats that support them).</font>
<a name="line-32"></a> <font color=Red>-></font> Bool <font color=Blue>-- ^ Whether to include anchors.</font>
<a name="line-33"></a> <font color=Red>-></font> Bool <font color=Blue>-- ^ Whether output document is partial or complete.</font>
<a name="line-34"></a> <font color=Red>-></font> Literate <font color=Blue>-- ^ Whether input document is literate haskell or not</font>
<a name="line-35"></a> <font color=Red>-></font> String <font color=Blue>-- ^ Title for output.</font>
<a name="line-36"></a> <font color=Red>-></font> String <font color=Blue>-- ^ Haskell source code.</font>
<a name="line-37"></a> <font color=Red>-></font> String <font color=Blue>-- ^ Coloured Haskell source code.</font>
<a name="line-38"></a>hscolour output pref anchor partial literate title <font color=Red>=</font>
<a name="line-39"></a> <u><font color=Green>case</font></u> literate <u><font color=Green>of</font></u>
<a name="line-40"></a> NoLit <font color=Red>-></font> hscolour' output pref anchor partial title
<a name="line-41"></a> Bird <font color=Red>-></font> literateHandler <font color=Cyan>(</font>map lhsClassify<font color=Cyan>)</font>
<a name="line-42"></a> TeX <font color=Red>-></font> literateHandler <font color=Cyan>(</font>snd <font color=Cyan>.</font> mapAccumL decideTypeOfLine False<font color=Cyan>)</font>
<a name="line-43"></a> <u><font color=Green>where</font></u>
<a name="line-44"></a> literateHandler f <font color=Red>=</font> concatMap chunk <font color=Cyan>.</font> joinL <font color=Cyan>.</font> f <font color=Cyan>.</font> inlines
<a name="line-45"></a> chunk <font color=Cyan>(</font>Lit c<font color=Cyan>)</font> <font color=Red>=</font> c
<a name="line-46"></a> chunk <font color=Cyan>(</font>Code c<font color=Cyan>)</font> <font color=Red>=</font> hscolour' output pref anchor True title c
<a name="line-47"></a>
<a name="line-48"></a><a name="hscolour'"></a>hscolour' <font color=Red>::</font> Output <font color=Blue>-- ^ Output format.</font>
<a name="line-49"></a> <font color=Red>-></font> ColourPrefs <font color=Blue>-- ^ Colour preferences (for formats that support them).</font>
<a name="line-50"></a> <font color=Red>-></font> Bool <font color=Blue>-- ^ Whether to include anchors.</font>
<a name="line-51"></a> <font color=Red>-></font> Bool <font color=Blue>-- ^ Whether output document is partial or complete.</font>
<a name="line-52"></a> <font color=Red>-></font> String <font color=Blue>-- ^ Title for output.</font>
<a name="line-53"></a> <font color=Red>-></font> String <font color=Blue>-- ^ Haskell source code.</font>
<a name="line-54"></a> <font color=Red>-></font> String <font color=Blue>-- ^ Coloured Haskell source code.</font>
<a name="line-55"></a>hscolour' TTY pref <u><font color=Green>_</font></u> <u><font color=Green>_</font></u> <u><font color=Green>_</font></u> <font color=Red>=</font> TTY<font color=Cyan>.</font>hscolour pref
<a name="line-56"></a>hscolour' MIRC pref <u><font color=Green>_</font></u> <u><font color=Green>_</font></u> <u><font color=Green>_</font></u> <font color=Red>=</font> MIRC<font color=Cyan>.</font>hscolour pref
<a name="line-57"></a>hscolour' LaTeX pref <u><font color=Green>_</font></u> partial <u><font color=Green>_</font></u> <font color=Red>=</font> LaTeX<font color=Cyan>.</font>hscolour pref partial
<a name="line-58"></a>hscolour' HTML pref anchor partial top <font color=Red>=</font> HTML<font color=Cyan>.</font>hscolour pref anchor partial top
<a name="line-59"></a>hscolour' CSS <u><font color=Green>_</font></u> anchor partial top <font color=Red>=</font> CSS<font color=Cyan>.</font>hscolour anchor partial top
<a name="line-60"></a>
<a name="line-61"></a><a name="Lit"></a><font color=Blue>-- | Separating literate files into code\/comment chunks.</font>
<a name="line-62"></a><a name="Lit"></a><u><font color=Green>data</font></u> Lit <font color=Red>=</font> Code <font color=Cyan>{</font>unL <font color=Red>::</font> String<font color=Cyan>}</font> <font color=Red>|</font> Lit <font color=Cyan>{</font>unL <font color=Red>::</font> String<font color=Cyan>}</font> <u><font color=Green>deriving</font></u> <font color=Cyan>(</font>Show<font color=Cyan>)</font>
<a name="line-63"></a>
<a name="line-64"></a><a name="inlines"></a><font color=Blue>-- Re-implementation of 'lines', for better efficiency (but decreased laziness).</font>
<a name="line-65"></a><font color=Blue>-- Also, importantly, accepts non-standard DOS and Mac line ending characters.</font>
<a name="line-66"></a><font color=Blue>-- And retains the trailing '\n' character in each resultant string.</font>
<a name="line-67"></a>inlines <font color=Red>::</font> String <font color=Red>-></font> <font color=Red>[</font>String<font color=Red>]</font>
<a name="line-68"></a>inlines s <font color=Red>=</font> lines' s id
<a name="line-69"></a> <u><font color=Green>where</font></u>
<a name="line-70"></a> lines' [] acc <font color=Red>=</font> <font color=Red>[</font>acc []<font color=Red>]</font>
<a name="line-71"></a> lines' <font color=Cyan>(</font><font color=Magenta>'\^M'</font><b><font color=Red>:</font></b><font color=Magenta>'\n'</font><b><font color=Red>:</font></b>s<font color=Cyan>)</font> acc <font color=Red>=</font> acc <font color=Red>[</font><font color=Magenta>'\n'</font><font color=Red>]</font> <b><font color=Red>:</font></b> lines' s id <font color=Blue>-- DOS</font>
<a name="line-72"></a><font color=Blue>--lines' ('\^M':s) acc = acc ['\n'] : lines' s id -- MacOS</font>
<a name="line-73"></a> lines' <font color=Cyan>(</font><font color=Magenta>'\n'</font><b><font color=Red>:</font></b>s<font color=Cyan>)</font> acc <font color=Red>=</font> acc <font color=Red>[</font><font color=Magenta>'\n'</font><font color=Red>]</font> <b><font color=Red>:</font></b> lines' s id <font color=Blue>-- Unix</font>
<a name="line-74"></a> lines' <font color=Cyan>(</font>c<b><font color=Red>:</font></b>s<font color=Cyan>)</font> acc <font color=Red>=</font> lines' s <font color=Cyan>(</font>acc <font color=Cyan>.</font> <font color=Cyan>(</font>c<b><font color=Red>:</font></b><font color=Cyan>)</font><font color=Cyan>)</font>
<a name="line-75"></a>
<a name="line-76"></a><a name="lhsClassify"></a><font color=Blue>-- Note, I just pass the > symbol to the colouriser, which assumes that</font>
<a name="line-77"></a><font color=Blue>-- it's token based and not parse-based!!!</font>
<a name="line-78"></a>lhsClassify <font color=Red>::</font> String <font color=Red>-></font> Lit
<a name="line-79"></a>lhsClassify <font color=Cyan>(</font><font color=Magenta>'>'</font><b><font color=Red>:</font></b>xs<font color=Cyan>)</font> <font color=Red>=</font> Code <font color=Cyan>(</font><font color=Magenta>'>'</font><b><font color=Red>:</font></b>xs<font color=Cyan>)</font>
<a name="line-80"></a>lhsClassify xs <font color=Red>=</font> Lit xs
<a name="line-81"></a>
<a name="line-82"></a><a name="decideTypeOfLine"></a><font color=Blue>-- texstyle is a bool indicating whether we are currently inside a code block</font>
<a name="line-83"></a>decideTypeOfLine texStyle current_line
<a name="line-84"></a> <font color=Red>|</font> isPrefix <font color=Magenta>"\\begin{code}"</font> <font color=Red>=</font> codeLine
<a name="line-85"></a> <font color=Red>|</font> texStyle <font color=Red>=</font> <u><font color=Green>if</font></u> not is_end <u><font color=Green>then</font></u> codeLine <u><font color=Green>else</font></u> <font color=Cyan>(</font>False<font color=Cyan>,</font> Code <font color=Cyan>(</font>current_line <font color=Cyan>)</font><font color=Cyan>)</font>
<a name="line-86"></a> <font color=Red>|</font> otherwise <font color=Red>=</font> <font color=Cyan>(</font>False<font color=Cyan>,</font> Lit current_line<font color=Cyan>)</font>
<a name="line-87"></a> <u><font color=Green>where</font></u> isPrefix <font color=Red>=</font> flip isPrefixOf current_line
<a name="line-88"></a> codeLine <font color=Red>=</font> <font color=Cyan>(</font>True<font color=Cyan>,</font> Code <font color=Cyan>(</font>current_line<font color=Cyan>)</font><font color=Cyan>)</font>
<a name="line-89"></a> is_end <font color=Red>=</font> isPrefix <font color=Magenta>"\\end{code}"</font>
<a name="line-90"></a>
<a name="line-91"></a><a name="joinL"></a>joinL <font color=Red>::</font> <font color=Red>[</font>Lit<font color=Red>]</font> <font color=Red>-></font> <font color=Red>[</font>Lit<font color=Red>]</font>
<a name="line-92"></a>joinL [] <font color=Red>=</font> []
<a name="line-93"></a>joinL <font color=Cyan>(</font>Code c<b><font color=Red>:</font></b>Code c2<b><font color=Red>:</font></b>xs<font color=Cyan>)</font> <font color=Red>=</font> joinL <font color=Cyan>(</font>Code <font color=Cyan>(</font>c<font color=Cyan>++</font>c2<font color=Cyan>)</font><b><font color=Red>:</font></b>xs<font color=Cyan>)</font>
<a name="line-94"></a>joinL <font color=Cyan>(</font>Lit c <b><font color=Red>:</font></b>Lit c2 <b><font color=Red>:</font></b>xs<font color=Cyan>)</font> <font color=Red>=</font> joinL <font color=Cyan>(</font>Lit <font color=Cyan>(</font>c<font color=Cyan>++</font>c2<font color=Cyan>)</font><b><font color=Red>:</font></b>xs<font color=Cyan>)</font>
<a name="line-95"></a>joinL <font color=Cyan>(</font>any<b><font color=Red>:</font></b>xs<font color=Cyan>)</font> <font color=Red>=</font> any<b><font color=Red>:</font></b> joinL xs
<a name="line-96"></a>
</pre>
</body>
</html>