<?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>Data/Text/Encoding.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'>-- Module : Data.Text.Encoding</span> <a name="line-3"></a><span class='hs-comment'>-- Copyright : (c) Tom Harper 2008-2009,</span> <a name="line-4"></a><span class='hs-comment'>-- (c) Bryan O'Sullivan 2009,</span> <a name="line-5"></a><span class='hs-comment'>-- (c) Duncan Coutts 2009</span> <a name="line-6"></a><span class='hs-comment'>--</span> <a name="line-7"></a><span class='hs-comment'>-- License : BSD-style</span> <a name="line-8"></a><span class='hs-comment'>-- Maintainer : bos@serpentine.com, rtomharper@googlemail.com,</span> <a name="line-9"></a><span class='hs-comment'>-- duncan@haskell.org</span> <a name="line-10"></a><span class='hs-comment'>-- Stability : experimental</span> <a name="line-11"></a><span class='hs-comment'>-- Portability : portable</span> <a name="line-12"></a><span class='hs-comment'>--</span> <a name="line-13"></a><span class='hs-comment'>-- Functions for converting 'Text' values to and from 'ByteString',</span> <a name="line-14"></a><span class='hs-comment'>-- using several standard encodings.</span> <a name="line-15"></a><span class='hs-comment'>--</span> <a name="line-16"></a><span class='hs-comment'>-- To make use of a much larger variety of encodings, use the @text-icu@</span> <a name="line-17"></a><span class='hs-comment'>-- package.</span> <a name="line-18"></a> <a name="line-19"></a><span class='hs-keyword'>module</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'>Encoding</span> <a name="line-20"></a> <span class='hs-layout'>(</span> <a name="line-21"></a> <span class='hs-comment'>-- * Decoding ByteStrings to Text</span> <a name="line-22"></a> <span class='hs-varid'>decodeASCII</span> <a name="line-23"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>decodeUtf8</span> <a name="line-24"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>decodeUtf16LE</span> <a name="line-25"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>decodeUtf16BE</span> <a name="line-26"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>decodeUtf32LE</span> <a name="line-27"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>decodeUtf32BE</span> <a name="line-28"></a> <span class='hs-comment'>-- ** Controllable error handling</span> <a name="line-29"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>decodeUtf8With</span> <a name="line-30"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>decodeUtf16LEWith</span> <a name="line-31"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>decodeUtf16BEWith</span> <a name="line-32"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>decodeUtf32LEWith</span> <a name="line-33"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>decodeUtf32BEWith</span> <a name="line-34"></a> <a name="line-35"></a> <span class='hs-comment'>-- * Encoding Text to ByteStrings</span> <a name="line-36"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>encodeUtf8</span> <a name="line-37"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>encodeUtf16LE</span> <a name="line-38"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>encodeUtf16BE</span> <a name="line-39"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>encodeUtf32LE</span> <a name="line-40"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>encodeUtf32BE</span> <a name="line-41"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span> <a name="line-42"></a> <a name="line-43"></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-layout'>(</span><span class='hs-conid'>ByteString</span><span class='hs-layout'>)</span> <a name="line-44"></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'>Fusion</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>F</span> <a name="line-45"></a><span class='hs-keyword'>import</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'>Encoding</span><span class='hs-varop'>.</span><span class='hs-conid'>Error</span> <span class='hs-layout'>(</span><span class='hs-conid'>OnDecodeError</span><span class='hs-layout'>,</span> <span class='hs-varid'>strictDecode</span><span class='hs-layout'>)</span> <a name="line-46"></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'>Encoding</span><span class='hs-varop'>.</span><span class='hs-conid'>Fusion</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>E</span> <a name="line-47"></a><span class='hs-keyword'>import</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'>Internal</span> <span class='hs-layout'>(</span><span class='hs-conid'>Text</span><span class='hs-layout'>)</span> <a name="line-48"></a> <a name="line-49"></a><a name="decodeASCII"></a><span class='hs-comment'>-- | Decode a 'ByteString' containing 7-bit ASCII encoded text.</span> <a name="line-50"></a><span class='hs-definition'>decodeASCII</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ByteString</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Text</span> <a name="line-51"></a><span class='hs-definition'>decodeASCII</span> <span class='hs-varid'>bs</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>F</span><span class='hs-varop'>.</span><span class='hs-varid'>unstream</span> <span class='hs-layout'>(</span><span class='hs-conid'>E</span><span class='hs-varop'>.</span><span class='hs-varid'>streamASCII</span> <span class='hs-varid'>bs</span><span class='hs-layout'>)</span> <a name="line-52"></a><span class='hs-comment'>{-# INLINE decodeASCII #-}</span> <a name="line-53"></a> <a name="line-54"></a><a name="decodeUtf8With"></a><span class='hs-comment'>-- | Decode a 'ByteString' containing UTF-8 encoded text.</span> <a name="line-55"></a><span class='hs-definition'>decodeUtf8With</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>OnDecodeError</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ByteString</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Text</span> <a name="line-56"></a><span class='hs-definition'>decodeUtf8With</span> <span class='hs-varid'>onErr</span> <span class='hs-varid'>bs</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>F</span><span class='hs-varop'>.</span><span class='hs-varid'>unstream</span> <span class='hs-layout'>(</span><span class='hs-conid'>E</span><span class='hs-varop'>.</span><span class='hs-varid'>streamUtf8</span> <span class='hs-varid'>onErr</span> <span class='hs-varid'>bs</span><span class='hs-layout'>)</span> <a name="line-57"></a><span class='hs-comment'>{-# INLINE decodeUtf8With #-}</span> <a name="line-58"></a> <a name="line-59"></a><a name="decodeUtf8"></a><span class='hs-comment'>-- | Decode a 'ByteString' containing UTF-8 encoded text.</span> <a name="line-60"></a><span class='hs-definition'>decodeUtf8</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ByteString</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Text</span> <a name="line-61"></a><span class='hs-definition'>decodeUtf8</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>decodeUtf8With</span> <span class='hs-varid'>strictDecode</span> <a name="line-62"></a><span class='hs-comment'>{-# INLINE decodeUtf8 #-}</span> <a name="line-63"></a> <a name="line-64"></a><a name="encodeUtf8"></a><span class='hs-comment'>-- | Encode text using UTF-8 encoding.</span> <a name="line-65"></a><span class='hs-definition'>encodeUtf8</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Text</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ByteString</span> <a name="line-66"></a><span class='hs-definition'>encodeUtf8</span> <span class='hs-varid'>txt</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>E</span><span class='hs-varop'>.</span><span class='hs-varid'>unstream</span> <span class='hs-layout'>(</span><span class='hs-conid'>E</span><span class='hs-varop'>.</span><span class='hs-varid'>restreamUtf8</span> <span class='hs-layout'>(</span><span class='hs-conid'>F</span><span class='hs-varop'>.</span><span class='hs-varid'>stream</span> <span class='hs-varid'>txt</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <a name="line-67"></a><span class='hs-comment'>{-# INLINE encodeUtf8 #-}</span> <a name="line-68"></a> <a name="line-69"></a><a name="decodeUtf16LEWith"></a><span class='hs-comment'>-- | Decode text from little endian UTF-16 encoding.</span> <a name="line-70"></a><span class='hs-definition'>decodeUtf16LEWith</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>OnDecodeError</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ByteString</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Text</span> <a name="line-71"></a><span class='hs-definition'>decodeUtf16LEWith</span> <span class='hs-varid'>onErr</span> <span class='hs-varid'>bs</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>F</span><span class='hs-varop'>.</span><span class='hs-varid'>unstream</span> <span class='hs-layout'>(</span><span class='hs-conid'>E</span><span class='hs-varop'>.</span><span class='hs-varid'>streamUtf16LE</span> <span class='hs-varid'>onErr</span> <span class='hs-varid'>bs</span><span class='hs-layout'>)</span> <a name="line-72"></a><span class='hs-comment'>{-# INLINE decodeUtf16LEWith #-}</span> <a name="line-73"></a> <a name="line-74"></a><a name="decodeUtf16LE"></a><span class='hs-comment'>-- | Decode text from little endian UTF-16 encoding.</span> <a name="line-75"></a><span class='hs-definition'>decodeUtf16LE</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ByteString</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Text</span> <a name="line-76"></a><span class='hs-definition'>decodeUtf16LE</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>decodeUtf16LEWith</span> <span class='hs-varid'>strictDecode</span> <a name="line-77"></a><span class='hs-comment'>{-# INLINE decodeUtf16LE #-}</span> <a name="line-78"></a> <a name="line-79"></a><a name="decodeUtf16BEWith"></a><span class='hs-comment'>-- | Decode text from big endian UTF-16 encoding.</span> <a name="line-80"></a><span class='hs-definition'>decodeUtf16BEWith</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>OnDecodeError</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ByteString</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Text</span> <a name="line-81"></a><span class='hs-definition'>decodeUtf16BEWith</span> <span class='hs-varid'>onErr</span> <span class='hs-varid'>bs</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>F</span><span class='hs-varop'>.</span><span class='hs-varid'>unstream</span> <span class='hs-layout'>(</span><span class='hs-conid'>E</span><span class='hs-varop'>.</span><span class='hs-varid'>streamUtf16BE</span> <span class='hs-varid'>onErr</span> <span class='hs-varid'>bs</span><span class='hs-layout'>)</span> <a name="line-82"></a><span class='hs-comment'>{-# INLINE decodeUtf16BEWith #-}</span> <a name="line-83"></a> <a name="line-84"></a><a name="decodeUtf16BE"></a><span class='hs-comment'>-- | Decode text from big endian UTF-16 encoding.</span> <a name="line-85"></a><span class='hs-definition'>decodeUtf16BE</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ByteString</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Text</span> <a name="line-86"></a><span class='hs-definition'>decodeUtf16BE</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>decodeUtf16BEWith</span> <span class='hs-varid'>strictDecode</span> <a name="line-87"></a><span class='hs-comment'>{-# INLINE decodeUtf16BE #-}</span> <a name="line-88"></a> <a name="line-89"></a><a name="encodeUtf16LE"></a><span class='hs-comment'>-- | Encode text using little endian UTF-16 encoding.</span> <a name="line-90"></a><span class='hs-definition'>encodeUtf16LE</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Text</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ByteString</span> <a name="line-91"></a><span class='hs-definition'>encodeUtf16LE</span> <span class='hs-varid'>txt</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>E</span><span class='hs-varop'>.</span><span class='hs-varid'>unstream</span> <span class='hs-layout'>(</span><span class='hs-conid'>E</span><span class='hs-varop'>.</span><span class='hs-varid'>restreamUtf16LE</span> <span class='hs-layout'>(</span><span class='hs-conid'>F</span><span class='hs-varop'>.</span><span class='hs-varid'>stream</span> <span class='hs-varid'>txt</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <a name="line-92"></a><span class='hs-comment'>{-# INLINE encodeUtf16LE #-}</span> <a name="line-93"></a> <a name="line-94"></a><a name="encodeUtf16BE"></a><span class='hs-comment'>-- | Encode text using big endian UTF-16 encoding.</span> <a name="line-95"></a><span class='hs-definition'>encodeUtf16BE</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Text</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ByteString</span> <a name="line-96"></a><span class='hs-definition'>encodeUtf16BE</span> <span class='hs-varid'>txt</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>E</span><span class='hs-varop'>.</span><span class='hs-varid'>unstream</span> <span class='hs-layout'>(</span><span class='hs-conid'>E</span><span class='hs-varop'>.</span><span class='hs-varid'>restreamUtf16BE</span> <span class='hs-layout'>(</span><span class='hs-conid'>F</span><span class='hs-varop'>.</span><span class='hs-varid'>stream</span> <span class='hs-varid'>txt</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <a name="line-97"></a><span class='hs-comment'>{-# INLINE encodeUtf16BE #-}</span> <a name="line-98"></a> <a name="line-99"></a><a name="decodeUtf32LEWith"></a><span class='hs-comment'>-- | Decode text from little endian UTF-32 encoding.</span> <a name="line-100"></a><span class='hs-definition'>decodeUtf32LEWith</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>OnDecodeError</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ByteString</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Text</span> <a name="line-101"></a><span class='hs-definition'>decodeUtf32LEWith</span> <span class='hs-varid'>onErr</span> <span class='hs-varid'>bs</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>F</span><span class='hs-varop'>.</span><span class='hs-varid'>unstream</span> <span class='hs-layout'>(</span><span class='hs-conid'>E</span><span class='hs-varop'>.</span><span class='hs-varid'>streamUtf32LE</span> <span class='hs-varid'>onErr</span> <span class='hs-varid'>bs</span><span class='hs-layout'>)</span> <a name="line-102"></a><span class='hs-comment'>{-# INLINE decodeUtf32LEWith #-}</span> <a name="line-103"></a> <a name="line-104"></a><a name="decodeUtf32LE"></a><span class='hs-comment'>-- | Decode text from little endian UTF-32 encoding.</span> <a name="line-105"></a><span class='hs-definition'>decodeUtf32LE</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ByteString</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Text</span> <a name="line-106"></a><span class='hs-definition'>decodeUtf32LE</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>decodeUtf32LEWith</span> <span class='hs-varid'>strictDecode</span> <a name="line-107"></a><span class='hs-comment'>{-# INLINE decodeUtf32LE #-}</span> <a name="line-108"></a> <a name="line-109"></a><a name="decodeUtf32BEWith"></a><span class='hs-comment'>-- | Decode text from big endian UTF-32 encoding.</span> <a name="line-110"></a><span class='hs-definition'>decodeUtf32BEWith</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>OnDecodeError</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ByteString</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Text</span> <a name="line-111"></a><span class='hs-definition'>decodeUtf32BEWith</span> <span class='hs-varid'>onErr</span> <span class='hs-varid'>bs</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>F</span><span class='hs-varop'>.</span><span class='hs-varid'>unstream</span> <span class='hs-layout'>(</span><span class='hs-conid'>E</span><span class='hs-varop'>.</span><span class='hs-varid'>streamUtf32BE</span> <span class='hs-varid'>onErr</span> <span class='hs-varid'>bs</span><span class='hs-layout'>)</span> <a name="line-112"></a><span class='hs-comment'>{-# INLINE decodeUtf32BEWith #-}</span> <a name="line-113"></a> <a name="line-114"></a><a name="decodeUtf32BE"></a><span class='hs-comment'>-- | Decode text from big endian UTF-32 encoding.</span> <a name="line-115"></a><span class='hs-definition'>decodeUtf32BE</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ByteString</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Text</span> <a name="line-116"></a><span class='hs-definition'>decodeUtf32BE</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>decodeUtf32BEWith</span> <span class='hs-varid'>strictDecode</span> <a name="line-117"></a><span class='hs-comment'>{-# INLINE decodeUtf32BE #-}</span> <a name="line-118"></a> <a name="line-119"></a><a name="encodeUtf32LE"></a><span class='hs-comment'>-- | Encode text using little endian UTF-32 encoding.</span> <a name="line-120"></a><span class='hs-definition'>encodeUtf32LE</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Text</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ByteString</span> <a name="line-121"></a><span class='hs-definition'>encodeUtf32LE</span> <span class='hs-varid'>txt</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>E</span><span class='hs-varop'>.</span><span class='hs-varid'>unstream</span> <span class='hs-layout'>(</span><span class='hs-conid'>E</span><span class='hs-varop'>.</span><span class='hs-varid'>restreamUtf32LE</span> <span class='hs-layout'>(</span><span class='hs-conid'>F</span><span class='hs-varop'>.</span><span class='hs-varid'>stream</span> <span class='hs-varid'>txt</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <a name="line-122"></a><span class='hs-comment'>{-# INLINE encodeUtf32LE #-}</span> <a name="line-123"></a> <a name="line-124"></a><a name="encodeUtf32BE"></a><span class='hs-comment'>-- | Encode text using big endian UTF-32 encoding.</span> <a name="line-125"></a><span class='hs-definition'>encodeUtf32BE</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Text</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ByteString</span> <a name="line-126"></a><span class='hs-definition'>encodeUtf32BE</span> <span class='hs-varid'>txt</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>E</span><span class='hs-varop'>.</span><span class='hs-varid'>unstream</span> <span class='hs-layout'>(</span><span class='hs-conid'>E</span><span class='hs-varop'>.</span><span class='hs-varid'>restreamUtf32BE</span> <span class='hs-layout'>(</span><span class='hs-conid'>F</span><span class='hs-varop'>.</span><span class='hs-varid'>stream</span> <span class='hs-varid'>txt</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <a name="line-127"></a><span class='hs-comment'>{-# INLINE encodeUtf32BE #-}</span> </pre></body> </html>