<?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>Blaze/ByteString/Builder/Html/Utf8.hs</title> <link type='text/css' rel='stylesheet' href='hscolour.css' /> </head> <body> <pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE OverloadedStrings #-}</span> <a name="line-2"></a><span class='hs-comment'>-- |</span> <a name="line-3"></a><span class='hs-comment'>-- Module : Blaze.ByteString.Builder.Html.Utf8</span> <a name="line-4"></a><span class='hs-comment'>-- Copyright : (c) 2010 Jasper Van der Jeugt & Simon Meier</span> <a name="line-5"></a><span class='hs-comment'>-- License : BSD3-style (see LICENSE)</span> <a name="line-6"></a><span class='hs-comment'>-- </span> <a name="line-7"></a><span class='hs-comment'>-- Maintainer : Simon Meier <iridcode@gmail.com></span> <a name="line-8"></a><span class='hs-comment'>-- Stability : experimental</span> <a name="line-9"></a><span class='hs-comment'>-- Portability : tested on GHC only</span> <a name="line-10"></a><span class='hs-comment'>--</span> <a name="line-11"></a><span class='hs-comment'>-- 'Write's and 'Builder's for serializing HTML escaped and UTF-8 encoded</span> <a name="line-12"></a><span class='hs-comment'>-- characters.</span> <a name="line-13"></a><span class='hs-comment'>--</span> <a name="line-14"></a><span class='hs-comment'>-- This module is used by both the 'blaze-html' and the \'hamlet\' HTML</span> <a name="line-15"></a><span class='hs-comment'>-- templating libraries. If the 'Builder' from 'blaze-builder' replaces the</span> <a name="line-16"></a><span class='hs-comment'>-- 'Data.Binary.Builder' implementation, this module will most likely keep its</span> <a name="line-17"></a><span class='hs-comment'>-- place, as it provides a set of very specialized functions.</span> <a name="line-18"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Blaze</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-varop'>.</span><span class='hs-conid'>Builder</span><span class='hs-varop'>.</span><span class='hs-conid'>Html</span><span class='hs-varop'>.</span><span class='hs-conid'>Utf8</span> <a name="line-19"></a> <span class='hs-layout'>(</span> <a name="line-20"></a> <span class='hs-keyword'>module</span> <span class='hs-conid'>Blaze</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-varop'>.</span><span class='hs-conid'>Builder</span><span class='hs-varop'>.</span><span class='hs-conid'>Char</span><span class='hs-varop'>.</span><span class='hs-conid'>Utf8</span> <a name="line-21"></a> <a name="line-22"></a> <span class='hs-comment'>-- * Writing HTML escaped and UTF-8 encoded characters to a buffer</span> <a name="line-23"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>writeHtmlEscapedChar</span> <a name="line-24"></a> <a name="line-25"></a> <span class='hs-comment'>-- * Creating Builders from HTML escaped and UTF-8 encoded characters</span> <a name="line-26"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fromHtmlEscapedChar</span> <a name="line-27"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fromHtmlEscapedString</span> <a name="line-28"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fromHtmlEscapedShow</span> <a name="line-29"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fromHtmlEscapedText</span> <a name="line-30"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fromHtmlEscapedLazyText</span> <a name="line-31"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span> <a name="line-32"></a> <a name="line-33"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-varop'>.</span><span class='hs-conid'>Char8</span> <span class='hs-conid'>()</span> <span class='hs-comment'>-- for the 'IsString' instance of bytesrings</span> <a name="line-34"></a> <a name="line-35"></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'>Text</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>TS</span> <a name="line-36"></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'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>Lazy</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>TL</span> <a name="line-37"></a> <a name="line-38"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Blaze</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-varop'>.</span><span class='hs-conid'>Builder</span> <a name="line-39"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Blaze</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-varop'>.</span><span class='hs-conid'>Builder</span><span class='hs-varop'>.</span><span class='hs-conid'>Internal</span> <a name="line-40"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Blaze</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-varop'>.</span><span class='hs-conid'>Builder</span><span class='hs-varop'>.</span><span class='hs-conid'>Char</span><span class='hs-varop'>.</span><span class='hs-conid'>Utf8</span> <a name="line-41"></a> <a name="line-42"></a><a name="writeHtmlEscapedChar"></a><span class='hs-comment'>-- | Write a HTML escaped and UTF-8 encoded Unicode character to a bufffer.</span> <a name="line-43"></a><span class='hs-comment'>--</span> <a name="line-44"></a><span class='hs-definition'>writeHtmlEscapedChar</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Char</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Write</span> <a name="line-45"></a><span class='hs-definition'>writeHtmlEscapedChar</span> <span class='hs-varid'>c0</span> <span class='hs-keyglyph'>=</span> <a name="line-46"></a> <span class='hs-varid'>boundedWrite</span> <span class='hs-num'>6</span> <span class='hs-layout'>(</span><span class='hs-varid'>io</span> <span class='hs-varid'>c0</span><span class='hs-layout'>)</span> <a name="line-47"></a> <span class='hs-comment'>-- WARNING: Don't forget to change the bound if you change the bytestrings.</span> <a name="line-48"></a> <span class='hs-keyword'>where</span> <a name="line-49"></a> <span class='hs-varid'>io</span> <span class='hs-chr'>'<'</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>runWrite</span> <span class='hs-varop'>$</span> <span class='hs-varid'>writeByteString</span> <span class='hs-str'>"&lt;"</span> <a name="line-50"></a> <span class='hs-varid'>io</span> <span class='hs-chr'>'>'</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>runWrite</span> <span class='hs-varop'>$</span> <span class='hs-varid'>writeByteString</span> <span class='hs-str'>"&gt;"</span> <a name="line-51"></a> <span class='hs-varid'>io</span> <span class='hs-chr'>'&'</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>runWrite</span> <span class='hs-varop'>$</span> <span class='hs-varid'>writeByteString</span> <span class='hs-str'>"&amp;"</span> <a name="line-52"></a> <span class='hs-varid'>io</span> <span class='hs-chr'>'"'</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>runWrite</span> <span class='hs-varop'>$</span> <span class='hs-varid'>writeByteString</span> <span class='hs-str'>"&quot;"</span> <a name="line-53"></a> <span class='hs-varid'>io</span> <span class='hs-chr'>'\''</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>runWrite</span> <span class='hs-varop'>$</span> <span class='hs-varid'>writeByteString</span> <span class='hs-str'>"&#39;"</span> <a name="line-54"></a> <span class='hs-varid'>io</span> <span class='hs-varid'>c</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>runWrite</span> <span class='hs-varop'>$</span> <span class='hs-varid'>writeChar</span> <span class='hs-varid'>c</span> <a name="line-55"></a><span class='hs-comment'>{-# INLINE writeHtmlEscapedChar #-}</span> <a name="line-56"></a> <a name="line-57"></a><a name="fromHtmlEscapedChar"></a><span class='hs-comment'>-- | /O(1)./ Serialize a HTML escaped Unicode character using the UTF-8</span> <a name="line-58"></a><span class='hs-comment'>-- encoding.</span> <a name="line-59"></a><span class='hs-comment'>--</span> <a name="line-60"></a><span class='hs-definition'>fromHtmlEscapedChar</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Char</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Builder</span> <a name="line-61"></a><span class='hs-definition'>fromHtmlEscapedChar</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fromWriteSingleton</span> <span class='hs-varid'>writeHtmlEscapedChar</span> <a name="line-62"></a> <a name="line-63"></a><a name="fromHtmlEscapedString"></a><span class='hs-comment'>-- | /O(n)/. Serialize a HTML escaped Unicode 'String' using the UTF-8</span> <a name="line-64"></a><span class='hs-comment'>-- encoding.</span> <a name="line-65"></a><span class='hs-comment'>--</span> <a name="line-66"></a><span class='hs-definition'>fromHtmlEscapedString</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Builder</span> <a name="line-67"></a><span class='hs-definition'>fromHtmlEscapedString</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fromWriteList</span> <span class='hs-varid'>writeHtmlEscapedChar</span> <a name="line-68"></a> <a name="line-69"></a><a name="fromHtmlEscapedShow"></a><span class='hs-comment'>-- | /O(n)/. Serialize a value by 'Show'ing it and then, HTML escaping and</span> <a name="line-70"></a><span class='hs-comment'>-- UTF-8 encoding the resulting 'String'.</span> <a name="line-71"></a><span class='hs-comment'>--</span> <a name="line-72"></a><span class='hs-definition'>fromHtmlEscapedShow</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Show</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Builder</span> <a name="line-73"></a><span class='hs-definition'>fromHtmlEscapedShow</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fromHtmlEscapedString</span> <span class='hs-varop'>.</span> <span class='hs-varid'>show</span> <a name="line-74"></a> <a name="line-75"></a> <a name="line-76"></a><a name="fromHtmlEscapedText"></a><span class='hs-comment'>-- | /O(n)/. Serialize a HTML escaped strict Unicode 'TS.Text' value using the</span> <a name="line-77"></a><span class='hs-comment'>-- UTF-8 encoding.</span> <a name="line-78"></a><span class='hs-comment'>--</span> <a name="line-79"></a><span class='hs-definition'>fromHtmlEscapedText</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>TS</span><span class='hs-varop'>.</span><span class='hs-conid'>Text</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Builder</span> <a name="line-80"></a><span class='hs-definition'>fromHtmlEscapedText</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fromHtmlEscapedString</span> <span class='hs-varop'>.</span> <span class='hs-conid'>TS</span><span class='hs-varop'>.</span><span class='hs-varid'>unpack</span> <a name="line-81"></a> <a name="line-82"></a><a name="fromHtmlEscapedLazyText"></a><span class='hs-comment'>-- | /O(n)/. Serialize a HTML escaped Unicode 'TL.Text' using the UTF-8 encoding.</span> <a name="line-83"></a><span class='hs-comment'>--</span> <a name="line-84"></a><span class='hs-definition'>fromHtmlEscapedLazyText</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>TL</span><span class='hs-varop'>.</span><span class='hs-conid'>Text</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Builder</span> <a name="line-85"></a><span class='hs-definition'>fromHtmlEscapedLazyText</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fromHtmlEscapedString</span> <span class='hs-varop'>.</span> <span class='hs-conid'>TL</span><span class='hs-varop'>.</span><span class='hs-varid'>unpack</span> <a name="line-86"></a> </pre></body> </html>