<?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>Text/Highlighting/Kate/Format.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{- |
<a name="line-2"></a> Module : Text.Highlighting.Kate.Format
<a name="line-3"></a> Copyright : Copyright (C) 2008 John MacFarlane
<a name="line-4"></a> License : GNU GPL, version 2 or above
<a name="line-5"></a>
<a name="line-6"></a> Maintainer : John MacFarlane <jgm@berkeley.edu>
<a name="line-7"></a> Stability : alpha
<a name="line-8"></a> Portability : portable
<a name="line-9"></a>
<a name="line-10"></a>Formatters that convert a list of annotated source lines to various output formats.
<a name="line-11"></a>-}</span>
<a name="line-12"></a>
<a name="line-13"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>Highlighting</span><span class='hs-varop'>.</span><span class='hs-conid'>Kate</span><span class='hs-varop'>.</span><span class='hs-conid'>Format</span> <span class='hs-layout'>(</span> <span class='hs-varid'>formatAsXHtml</span><span class='hs-layout'>,</span> <span class='hs-conid'>FormatOption</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>defaultHighlightingCss</span> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-14"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>Highlighting</span><span class='hs-varop'>.</span><span class='hs-conid'>Kate</span><span class='hs-varop'>.</span><span class='hs-conid'>Definitions</span>
<a name="line-15"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>XHtml</span><span class='hs-varop'>.</span><span class='hs-conid'>Transitional</span>
<a name="line-16"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>List</span> <span class='hs-layout'>(</span><span class='hs-varid'>intersperse</span><span class='hs-layout'>)</span>
<a name="line-17"></a>
<a name="line-18"></a><a name="FormatOption"></a><span class='hs-comment'>-- | Options for formatters.</span>
<a name="line-19"></a><a name="FormatOption"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>FormatOption</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>OptNumberLines</span> <span class='hs-comment'>-- ^ Number lines</span>
<a name="line-20"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>OptNumberFrom</span> <span class='hs-conid'>Int</span> <span class='hs-comment'>-- ^ Number of first line</span>
<a name="line-21"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>OptLineAnchors</span> <span class='hs-comment'>-- ^ Anchors on each line number </span>
<a name="line-22"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>OptTitleAttributes</span> <span class='hs-comment'>-- ^ Include title attributes</span>
<a name="line-23"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>OptDetailed</span> <span class='hs-comment'>-- ^ Include detailed lexical information in classes.</span>
<a name="line-24"></a> <span class='hs-comment'>-- (By default, only the default style is included. This</span>
<a name="line-25"></a> <span class='hs-comment'>-- option causes output to be more verbose.)</span>
<a name="line-26"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>OptInline</span> <span class='hs-comment'>-- ^ Format as span-level, not block-level element</span>
<a name="line-27"></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'>Read</span><span class='hs-layout'>)</span>
<a name="line-28"></a>
<a name="line-29"></a><a name="formatAsXHtml"></a><span class='hs-comment'>-- | Format a list of highlighted @SourceLine@s as XHtml.</span>
<a name="line-30"></a><span class='hs-definition'>formatAsXHtml</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>FormatOption</span><span class='hs-keyglyph'>]</span> <span class='hs-comment'>-- ^ Options</span>
<a name="line-31"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ Language</span>
<a name="line-32"></a> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>SourceLine</span><span class='hs-keyglyph'>]</span> <span class='hs-comment'>-- ^ Source lines to format</span>
<a name="line-33"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Html</span>
<a name="line-34"></a><span class='hs-definition'>formatAsXHtml</span> <span class='hs-varid'>opts</span> <span class='hs-varid'>lang</span> <span class='hs-varid'>lines</span> <span class='hs-keyglyph'>=</span>
<a name="line-35"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>startNum</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>getStartNum</span> <span class='hs-varid'>opts</span>
<a name="line-36"></a> <span class='hs-varid'>numberOfLines</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>length</span> <span class='hs-varid'>lines</span>
<a name="line-37"></a> <span class='hs-varid'>code</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>thecode</span> <span class='hs-varop'>!</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>theclass</span> <span class='hs-varop'>$</span> <span class='hs-varid'>unwords</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"sourceCode"</span><span class='hs-layout'>,</span> <span class='hs-varid'>lang</span><span class='hs-keyglyph'>]</span><span class='hs-keyglyph'>]</span> <span class='hs-varop'><<</span> <span class='hs-varid'>intersperse</span> <span class='hs-varid'>br</span> <span class='hs-layout'>(</span><span class='hs-varid'>map</span> <span class='hs-layout'>(</span><span class='hs-varid'>sourceLineToHtml</span> <span class='hs-varid'>opts</span><span class='hs-layout'>)</span> <span class='hs-varid'>lines</span><span class='hs-layout'>)</span>
<a name="line-38"></a> <span class='hs-keyword'>in</span> <span class='hs-keyword'>if</span> <span class='hs-conid'>OptInline</span> <span class='hs-varop'>`elem`</span> <span class='hs-varid'>opts</span>
<a name="line-39"></a> <span class='hs-keyword'>then</span> <span class='hs-varid'>code</span>
<a name="line-40"></a> <span class='hs-keyword'>else</span> <span class='hs-keyword'>if</span> <span class='hs-conid'>OptNumberLines</span> <span class='hs-varop'>`elem`</span> <span class='hs-varid'>opts</span>
<a name="line-41"></a> <span class='hs-keyword'>then</span> <span class='hs-keyword'>let</span> <span class='hs-varid'>lnTitle</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>title</span> <span class='hs-str'>"Click to toggle line numbers"</span>
<a name="line-42"></a> <span class='hs-varid'>lnOnClick</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>strAttr</span> <span class='hs-str'>"onclick"</span> <span class='hs-str'>"with (this.firstChild.style) { display = (display == '') ? 'none' : '' }"</span>
<a name="line-43"></a> <span class='hs-varid'>nums</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>td</span> <span class='hs-varop'>!</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>theclass</span> <span class='hs-str'>"nums"</span><span class='hs-layout'>,</span> <span class='hs-varid'>lnTitle</span><span class='hs-layout'>,</span> <span class='hs-varid'>lnOnClick</span><span class='hs-keyglyph'>]</span> <span class='hs-varop'>$</span> <span class='hs-varid'>pre</span> <span class='hs-varop'><<</span>
<a name="line-44"></a> <span class='hs-layout'>(</span><span class='hs-varid'>intersperse</span> <span class='hs-varid'>br</span> <span class='hs-varop'>$</span> <span class='hs-varid'>map</span> <span class='hs-varid'>lineNum</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>startNum</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>(</span><span class='hs-varid'>startNum</span> <span class='hs-varop'>+</span> <span class='hs-varid'>numberOfLines</span> <span class='hs-comment'>-</span> <span class='hs-num'>1</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span>
<a name="line-45"></a> <span class='hs-varid'>lineNum</span> <span class='hs-varid'>n</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>if</span> <span class='hs-conid'>OptLineAnchors</span> <span class='hs-varop'>`elem`</span> <span class='hs-varid'>opts</span>
<a name="line-46"></a> <span class='hs-keyword'>then</span> <span class='hs-varid'>anchor</span> <span class='hs-varop'>!</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>identifier</span> <span class='hs-varop'>$</span> <span class='hs-varid'>show</span> <span class='hs-varid'>n</span><span class='hs-keyglyph'>]</span> <span class='hs-varop'><<</span> <span class='hs-varid'>show</span> <span class='hs-varid'>n</span>
<a name="line-47"></a> <span class='hs-keyword'>else</span> <span class='hs-varid'>stringToHtml</span> <span class='hs-varop'>$</span> <span class='hs-varid'>show</span> <span class='hs-varid'>n</span>
<a name="line-48"></a> <span class='hs-varid'>sourceCode</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>td</span> <span class='hs-varop'>!</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>theclass</span> <span class='hs-str'>"sourceCode"</span><span class='hs-keyglyph'>]</span> <span class='hs-varop'>$</span> <span class='hs-varid'>pre</span> <span class='hs-varop'>!</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>theclass</span> <span class='hs-str'>"sourceCode"</span><span class='hs-keyglyph'>]</span> <span class='hs-varop'><<</span> <span class='hs-varid'>code</span>
<a name="line-49"></a> <span class='hs-keyword'>in</span> <span class='hs-varid'>table</span> <span class='hs-varop'>!</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>theclass</span> <span class='hs-str'>"sourceCode"</span><span class='hs-keyglyph'>]</span> <span class='hs-varop'>$</span> <span class='hs-varid'>tr</span> <span class='hs-varop'><<</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>nums</span><span class='hs-layout'>,</span> <span class='hs-varid'>sourceCode</span><span class='hs-keyglyph'>]</span>
<a name="line-50"></a> <span class='hs-keyword'>else</span> <span class='hs-varid'>pre</span> <span class='hs-varop'>!</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>theclass</span> <span class='hs-str'>"sourceCode"</span><span class='hs-keyglyph'>]</span> <span class='hs-varop'><<</span> <span class='hs-varid'>code</span>
<a name="line-51"></a>
<a name="line-52"></a><a name="labeledSourceToHtml"></a><span class='hs-definition'>labeledSourceToHtml</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>FormatOption</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>LabeledSource</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Html</span>
<a name="line-53"></a><span class='hs-definition'>labeledSourceToHtml</span> <span class='hs-keyword'>_</span> <span class='hs-layout'>(</span><span class='hs-conid'>[]</span><span class='hs-layout'>,</span> <span class='hs-varid'>txt</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>toHtml</span> <span class='hs-varid'>txt</span>
<a name="line-54"></a><span class='hs-definition'>labeledSourceToHtml</span> <span class='hs-varid'>opts</span> <span class='hs-layout'>(</span><span class='hs-varid'>labs</span><span class='hs-layout'>,</span> <span class='hs-varid'>txt</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span>
<a name="line-55"></a> <span class='hs-keyword'>if</span> <span class='hs-varid'>null</span> <span class='hs-varid'>attribs</span>
<a name="line-56"></a> <span class='hs-keyword'>then</span> <span class='hs-varid'>toHtml</span> <span class='hs-varid'>txt</span>
<a name="line-57"></a> <span class='hs-keyword'>else</span> <span class='hs-varid'>thespan</span> <span class='hs-varop'>!</span> <span class='hs-varid'>attribs</span> <span class='hs-varop'><<</span> <span class='hs-varid'>txt</span>
<a name="line-58"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>classes</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>unwords</span> <span class='hs-varop'>$</span>
<a name="line-59"></a> <span class='hs-keyword'>if</span> <span class='hs-conid'>OptDetailed</span> <span class='hs-varop'>`elem`</span> <span class='hs-varid'>opts</span>
<a name="line-60"></a> <span class='hs-keyword'>then</span> <span class='hs-varid'>map</span> <span class='hs-varid'>removeSpaces</span> <span class='hs-varid'>labs</span>
<a name="line-61"></a> <span class='hs-keyword'>else</span> <span class='hs-varid'>drop</span> <span class='hs-num'>1</span> <span class='hs-varid'>labs</span> <span class='hs-comment'>-- first is specific</span>
<a name="line-62"></a> <span class='hs-varid'>attribs</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>theclass</span> <span class='hs-varid'>classes</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>not</span> <span class='hs-layout'>(</span><span class='hs-varid'>null</span> <span class='hs-varid'>classes</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span> <span class='hs-varop'>++</span>
<a name="line-63"></a> <span class='hs-keyglyph'>[</span><span class='hs-varid'>title</span> <span class='hs-varid'>classes</span> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>OptTitleAttributes</span> <span class='hs-varop'>`elem`</span> <span class='hs-varid'>opts</span><span class='hs-keyglyph'>]</span>
<a name="line-64"></a>
<a name="line-65"></a><a name="sourceLineToHtml"></a><span class='hs-definition'>sourceLineToHtml</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>FormatOption</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SourceLine</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Html</span>
<a name="line-66"></a><span class='hs-definition'>sourceLineToHtml</span> <span class='hs-varid'>opts</span> <span class='hs-varid'>contents</span> <span class='hs-keyglyph'>=</span>
<a name="line-67"></a> <span class='hs-varid'>concatHtml</span> <span class='hs-varop'>$</span> <span class='hs-varid'>map</span> <span class='hs-layout'>(</span><span class='hs-varid'>labeledSourceToHtml</span> <span class='hs-varid'>opts</span><span class='hs-layout'>)</span> <span class='hs-varid'>contents</span>
<a name="line-68"></a>
<a name="line-69"></a><a name="removeSpaces"></a><span class='hs-definition'>removeSpaces</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span>
<a name="line-70"></a><span class='hs-definition'>removeSpaces</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>filter</span> <span class='hs-layout'>(</span><span class='hs-varop'>/=</span> <span class='hs-chr'>' '</span><span class='hs-layout'>)</span>
<a name="line-71"></a>
<a name="line-72"></a><a name="getStartNum"></a><span class='hs-definition'>getStartNum</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>FormatOption</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Int</span>
<a name="line-73"></a><span class='hs-definition'>getStartNum</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>=</span> <span class='hs-num'>1</span>
<a name="line-74"></a><span class='hs-definition'>getStartNum</span> <span class='hs-layout'>(</span><span class='hs-conid'>OptNumberFrom</span> <span class='hs-varid'>n</span> <span class='hs-conop'>:</span> <span class='hs-keyword'>_</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>n</span>
<a name="line-75"></a><span class='hs-definition'>getStartNum</span> <span class='hs-layout'>(</span><span class='hs-keyword'>_</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'>getStartNum</span> <span class='hs-varid'>xs</span>
<a name="line-76"></a>
<a name="line-77"></a><a name="defaultHighlightingCss"></a><span class='hs-definition'>defaultHighlightingCss</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span>
<a name="line-78"></a><span class='hs-definition'>defaultHighlightingCss</span> <span class='hs-keyglyph'>=</span>
<a name="line-79"></a> <span class='hs-str'>"table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode, table.sourceCode pre \n\
<a name="line-80"></a> \ { margin: 0; padding: 0; border: 0; vertical-align: baseline; border: none; }\n\
<a name="line-81"></a> \td.lineNumbers { border-right: 1px solid #AAAAAA; text-align: right; color: #AAAAAA; padding-right: 5px; padding-left: 5px; }\n\
<a name="line-82"></a> \td.sourceCode { padding-left: 5px; }\n\
<a name="line-83"></a> \code.sourceCode span.kw { color: #007020; font-weight: bold; } \n\
<a name="line-84"></a> \code.sourceCode span.dt { color: #902000; }\n\
<a name="line-85"></a> \code.sourceCode span.dv { color: #40a070; }\n\
<a name="line-86"></a> \code.sourceCode span.bn { color: #40a070; }\n\
<a name="line-87"></a> \code.sourceCode span.fl { color: #40a070; }\n\
<a name="line-88"></a> \code.sourceCode span.ch { color: #4070a0; }\n\
<a name="line-89"></a> \code.sourceCode span.st { color: #4070a0; }\n\
<a name="line-90"></a> \code.sourceCode span.co { color: #60a0b0; font-style: italic; }\n\
<a name="line-91"></a> \code.sourceCode span.ot { color: #007020; }\n\
<a name="line-92"></a> \code.sourceCode span.al { color: red; font-weight: bold; }\n\
<a name="line-93"></a> \code.sourceCode span.fu { color: #06287e; }\n\
<a name="line-94"></a> \code.sourceCode span.re { }\n\
<a name="line-95"></a> \code.sourceCode span.er { color: red; font-weight: bold; }"</span>
</pre></body>
</html>
