<?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/Text/Pandoc/XML.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>Copyright (C) 2006-2010 John MacFarlane <jgm@berkeley.edu> <a name="line-3"></a> <a name="line-4"></a>This program is free software; you can redistribute it and/or modify <a name="line-5"></a>it under the terms of the GNU General Public License as published by <a name="line-6"></a>the Free Software Foundation; either version 2 of the License, or <a name="line-7"></a>(at your option) any later version. <a name="line-8"></a> <a name="line-9"></a>This program is distributed in the hope that it will be useful, <a name="line-10"></a>but WITHOUT ANY WARRANTY; without even the implied warranty of <a name="line-11"></a>MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the <a name="line-12"></a>GNU General Public License for more details. <a name="line-13"></a> <a name="line-14"></a>You should have received a copy of the GNU General Public License <a name="line-15"></a>along with this program; if not, write to the Free Software <a name="line-16"></a>Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA <a name="line-17"></a>-}</span> <a name="line-18"></a> <a name="line-19"></a><span class='hs-comment'>{- | <a name="line-20"></a> Module : Text.Pandoc.XML <a name="line-21"></a> Copyright : Copyright (C) 2006-2010 John MacFarlane <a name="line-22"></a> License : GNU GPL, version 2 or above <a name="line-23"></a> <a name="line-24"></a> Maintainer : John MacFarlane <jgm@berkeley.edu> <a name="line-25"></a> Stability : alpha <a name="line-26"></a> Portability : portable <a name="line-27"></a> <a name="line-28"></a>Functions for escaping and formatting XML. <a name="line-29"></a>-}</span> <a name="line-30"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>Pandoc</span><span class='hs-varop'>.</span><span class='hs-conid'>XML</span> <span class='hs-layout'>(</span> <span class='hs-varid'>stripTags</span><span class='hs-layout'>,</span> <a name="line-31"></a> <span class='hs-varid'>escapeCharForXML</span><span class='hs-layout'>,</span> <a name="line-32"></a> <span class='hs-varid'>escapeStringForXML</span><span class='hs-layout'>,</span> <a name="line-33"></a> <span class='hs-varid'>inTags</span><span class='hs-layout'>,</span> <a name="line-34"></a> <span class='hs-varid'>selfClosingTag</span><span class='hs-layout'>,</span> <a name="line-35"></a> <span class='hs-varid'>inTagsSimple</span><span class='hs-layout'>,</span> <a name="line-36"></a> <span class='hs-varid'>inTagsIndented</span> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span> <a name="line-37"></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-38"></a> <a name="line-39"></a><a name="stripTags"></a><span class='hs-comment'>-- | Remove everything between <...></span> <a name="line-40"></a><span class='hs-definition'>stripTags</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-41"></a><span class='hs-definition'>stripTags</span> <span class='hs-layout'>(</span><span class='hs-chr'>'<'</span><span class='hs-conop'>:</span><span class='hs-varid'>xs</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <a name="line-42"></a> <span class='hs-keyword'>let</span> <span class='hs-layout'>(</span><span class='hs-keyword'>_</span><span class='hs-layout'>,</span><span class='hs-varid'>rest</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>break</span> <span class='hs-layout'>(</span><span class='hs-varop'>==</span><span class='hs-chr'>'>'</span><span class='hs-layout'>)</span> <span class='hs-varid'>xs</span> <a name="line-43"></a> <span class='hs-keyword'>in</span> <span class='hs-keyword'>if</span> <span class='hs-varid'>null</span> <span class='hs-varid'>rest</span> <a name="line-44"></a> <span class='hs-keyword'>then</span> <span class='hs-str'>""</span> <a name="line-45"></a> <span class='hs-keyword'>else</span> <span class='hs-varid'>stripTags</span> <span class='hs-layout'>(</span><span class='hs-varid'>tail</span> <span class='hs-varid'>rest</span><span class='hs-layout'>)</span> <span class='hs-comment'>-- leave off ></span> <a name="line-46"></a><span class='hs-definition'>stripTags</span> <span class='hs-layout'>(</span><span class='hs-varid'>x</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'>x</span> <span class='hs-conop'>:</span> <span class='hs-varid'>stripTags</span> <span class='hs-varid'>xs</span> <a name="line-47"></a><span class='hs-definition'>stripTags</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>[]</span> <a name="line-48"></a> <a name="line-49"></a><a name="escapeCharForXML"></a><span class='hs-comment'>-- | Escape one character as needed for XML.</span> <a name="line-50"></a><span class='hs-definition'>escapeCharForXML</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Char</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span> <a name="line-51"></a><span class='hs-definition'>escapeCharForXML</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>x</span> <span class='hs-keyword'>of</span> <a name="line-52"></a> <span class='hs-chr'>'&'</span> <span class='hs-keyglyph'>-></span> <span class='hs-str'>"&amp;"</span> <a name="line-53"></a> <span class='hs-chr'>'<'</span> <span class='hs-keyglyph'>-></span> <span class='hs-str'>"&lt;"</span> <a name="line-54"></a> <span class='hs-chr'>'>'</span> <span class='hs-keyglyph'>-></span> <span class='hs-str'>"&gt;"</span> <a name="line-55"></a> <span class='hs-chr'>'"'</span> <span class='hs-keyglyph'>-></span> <span class='hs-str'>"&quot;"</span> <a name="line-56"></a> <span class='hs-varid'>c</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>c</span><span class='hs-keyglyph'>]</span> <a name="line-57"></a> <a name="line-58"></a><a name="needsEscaping"></a><span class='hs-comment'>-- | True if the character needs to be escaped.</span> <a name="line-59"></a><span class='hs-definition'>needsEscaping</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Char</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Bool</span> <a name="line-60"></a><span class='hs-definition'>needsEscaping</span> <span class='hs-varid'>c</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>c</span> <span class='hs-varop'>`elem`</span> <span class='hs-str'>"&<>\""</span> <a name="line-61"></a> <a name="line-62"></a><a name="escapeStringForXML"></a><span class='hs-comment'>-- | Escape string as needed for XML. Entity references are not preserved.</span> <a name="line-63"></a><span class='hs-definition'>escapeStringForXML</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-64"></a><span class='hs-definition'>escapeStringForXML</span> <span class='hs-str'>""</span> <span class='hs-keyglyph'>=</span> <span class='hs-str'>""</span> <a name="line-65"></a><span class='hs-definition'>escapeStringForXML</span> <span class='hs-varid'>str</span> <span class='hs-keyglyph'>=</span> <a name="line-66"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>break</span> <span class='hs-varid'>needsEscaping</span> <span class='hs-varid'>str</span> <span class='hs-keyword'>of</span> <a name="line-67"></a> <span class='hs-layout'>(</span><span class='hs-varid'>okay</span><span class='hs-layout'>,</span> <span class='hs-str'>""</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>okay</span> <a name="line-68"></a> <span class='hs-layout'>(</span><span class='hs-varid'>okay</span><span class='hs-layout'>,</span> <span class='hs-layout'>(</span><span class='hs-varid'>c</span><span class='hs-conop'>:</span><span class='hs-varid'>cs</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>okay</span> <span class='hs-varop'>++</span> <span class='hs-varid'>escapeCharForXML</span> <span class='hs-varid'>c</span> <span class='hs-varop'>++</span> <span class='hs-varid'>escapeStringForXML</span> <span class='hs-varid'>cs</span> <a name="line-69"></a> <a name="line-70"></a><a name="attributeList"></a><span class='hs-comment'>-- | Return a text object with a string of formatted XML attributes.</span> <a name="line-71"></a><span class='hs-definition'>attributeList</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>String</span><span class='hs-layout'>,</span> <span class='hs-conid'>String</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <a name="line-72"></a><span class='hs-definition'>attributeList</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>text</span> <span class='hs-varop'>.</span> <span class='hs-varid'>concatMap</span> <a name="line-73"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-str'>" "</span> <span class='hs-varop'>++</span> <span class='hs-varid'>escapeStringForXML</span> <span class='hs-varid'>a</span> <span class='hs-varop'>++</span> <span class='hs-str'>"=\""</span> <span class='hs-varop'>++</span> <a name="line-74"></a> <span class='hs-varid'>escapeStringForXML</span> <span class='hs-varid'>b</span> <span class='hs-varop'>++</span> <span class='hs-str'>"\""</span><span class='hs-layout'>)</span> <a name="line-75"></a> <a name="line-76"></a><a name="inTags"></a><span class='hs-comment'>-- | Put the supplied contents between start and end tags of tagType,</span> <a name="line-77"></a><span class='hs-comment'>-- with specified attributes and (if specified) indentation.</span> <a name="line-78"></a><span class='hs-definition'>inTags</span><span class='hs-keyglyph'>::</span> <span class='hs-conid'>Bool</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>String</span><span class='hs-layout'>,</span> <span class='hs-conid'>String</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</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-79"></a><span class='hs-definition'>inTags</span> <span class='hs-varid'>isIndented</span> <span class='hs-varid'>tagType</span> <span class='hs-varid'>attribs</span> <span class='hs-varid'>contents</span> <span class='hs-keyglyph'>=</span> <a name="line-80"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>openTag</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>char</span> <span class='hs-chr'>'<'</span> <span class='hs-varop'><></span> <span class='hs-varid'>text</span> <span class='hs-varid'>tagType</span> <span class='hs-varop'><></span> <span class='hs-varid'>attributeList</span> <span class='hs-varid'>attribs</span> <span class='hs-varop'><></span> <a name="line-81"></a> <span class='hs-varid'>char</span> <span class='hs-chr'>'>'</span> <a name="line-82"></a> <span class='hs-varid'>closeTag</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>text</span> <span class='hs-str'>"</"</span> <span class='hs-varop'><></span> <span class='hs-varid'>text</span> <span class='hs-varid'>tagType</span> <span class='hs-varop'><></span> <span class='hs-varid'>char</span> <span class='hs-chr'>'>'</span> <a name="line-83"></a> <span class='hs-keyword'>in</span> <span class='hs-keyword'>if</span> <span class='hs-varid'>isIndented</span> <a name="line-84"></a> <span class='hs-keyword'>then</span> <span class='hs-varid'>openTag</span> <span class='hs-varop'>$$</span> <span class='hs-varid'>nest</span> <span class='hs-num'>2</span> <span class='hs-varid'>contents</span> <span class='hs-varop'>$$</span> <span class='hs-varid'>closeTag</span> <a name="line-85"></a> <span class='hs-keyword'>else</span> <span class='hs-varid'>openTag</span> <span class='hs-varop'><></span> <span class='hs-varid'>contents</span> <span class='hs-varop'><></span> <span class='hs-varid'>closeTag</span> <a name="line-86"></a> <a name="line-87"></a><a name="selfClosingTag"></a><span class='hs-comment'>-- | Return a self-closing tag of tagType with specified attributes</span> <a name="line-88"></a><span class='hs-definition'>selfClosingTag</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>String</span><span class='hs-layout'>,</span> <span class='hs-conid'>String</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <a name="line-89"></a><span class='hs-definition'>selfClosingTag</span> <span class='hs-varid'>tagType</span> <span class='hs-varid'>attribs</span> <span class='hs-keyglyph'>=</span> <a name="line-90"></a> <span class='hs-varid'>char</span> <span class='hs-chr'>'<'</span> <span class='hs-varop'><></span> <span class='hs-varid'>text</span> <span class='hs-varid'>tagType</span> <span class='hs-varop'><></span> <span class='hs-varid'>attributeList</span> <span class='hs-varid'>attribs</span> <span class='hs-varop'><></span> <span class='hs-varid'>text</span> <span class='hs-str'>" />"</span> <a name="line-91"></a> <a name="line-92"></a><a name="inTagsSimple"></a><span class='hs-comment'>-- | Put the supplied contents between start and end tags of tagType.</span> <a name="line-93"></a><span class='hs-definition'>inTagsSimple</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</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-94"></a><span class='hs-definition'>inTagsSimple</span> <span class='hs-varid'>tagType</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>inTags</span> <span class='hs-conid'>False</span> <span class='hs-varid'>tagType</span> <span class='hs-conid'>[]</span> <a name="line-95"></a> <a name="line-96"></a><a name="inTagsIndented"></a><span class='hs-comment'>-- | Put the supplied contents in indented block btw start and end tags.</span> <a name="line-97"></a><span class='hs-definition'>inTagsIndented</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</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-98"></a><span class='hs-definition'>inTagsIndented</span> <span class='hs-varid'>tagType</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>inTags</span> <span class='hs-conid'>True</span> <span class='hs-varid'>tagType</span> <span class='hs-conid'>[]</span> </pre></body> </html>