hxt-8.3.0: doc/hdoc/src/Text-XML-HXT-Arrow-WriteDocument.html
<!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>Haskell Code by HsColour</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='comment'>-- ------------------------------------------------------------</span>
<a name="line-2"></a>
<a name="line-3"></a><span class='comment'>{- |
<a name="line-4"></a> Module : Text.XML.HXT.Arrow.WriteDocument
<a name="line-5"></a> Copyright : Copyright (C) 2005-9 Uwe Schmidt
<a name="line-6"></a> License : MIT
<a name="line-7"></a>
<a name="line-8"></a> Maintainer : Uwe Schmidt (uwe@fh-wedel.de)
<a name="line-9"></a> Stability : experimental
<a name="line-10"></a> Portability: portable
<a name="line-11"></a>
<a name="line-12"></a> Compound arrow for writing XML documents
<a name="line-13"></a>
<a name="line-14"></a>-}</span>
<a name="line-15"></a>
<a name="line-16"></a><span class='comment'>-- ------------------------------------------------------------</span>
<a name="line-17"></a>
<a name="line-18"></a><span class='keyword'>module</span> <span class='conid'>Text</span><span class='varop'>.</span><span class='conid'>XML</span><span class='varop'>.</span><span class='conid'>HXT</span><span class='varop'>.</span><span class='conid'>Arrow</span><span class='varop'>.</span><span class='conid'>WriteDocument</span>
<a name="line-19"></a> <span class='layout'>(</span> <span class='varid'>writeDocument</span>
<a name="line-20"></a> <span class='layout'>,</span> <span class='varid'>writeDocumentToString</span>
<a name="line-21"></a> <span class='layout'>,</span> <span class='varid'>prepareContents</span>
<a name="line-22"></a> <span class='layout'>)</span>
<a name="line-23"></a><span class='keyword'>where</span>
<a name="line-24"></a>
<a name="line-25"></a><span class='keyword'>import</span> <span class='conid'>Control</span><span class='varop'>.</span><span class='conid'>Arrow</span> <span class='comment'>-- arrow classes</span>
<a name="line-26"></a><span class='keyword'>import</span> <span class='conid'>Control</span><span class='varop'>.</span><span class='conid'>Arrow</span><span class='varop'>.</span><span class='conid'>ArrowList</span>
<a name="line-27"></a><span class='keyword'>import</span> <span class='conid'>Control</span><span class='varop'>.</span><span class='conid'>Arrow</span><span class='varop'>.</span><span class='conid'>ArrowIf</span>
<a name="line-28"></a><span class='keyword'>import</span> <span class='conid'>Control</span><span class='varop'>.</span><span class='conid'>Arrow</span><span class='varop'>.</span><span class='conid'>ArrowTree</span>
<a name="line-29"></a>
<a name="line-30"></a><span class='keyword'>import</span> <span class='conid'>Text</span><span class='varop'>.</span><span class='conid'>XML</span><span class='varop'>.</span><span class='conid'>HXT</span><span class='varop'>.</span><span class='conid'>DOM</span><span class='varop'>.</span><span class='conid'>Interface</span>
<a name="line-31"></a><span class='keyword'>import</span> <span class='conid'>Text</span><span class='varop'>.</span><span class='conid'>XML</span><span class='varop'>.</span><span class='conid'>HXT</span><span class='varop'>.</span><span class='conid'>Arrow</span><span class='varop'>.</span><span class='conid'>XmlArrow</span>
<a name="line-32"></a><span class='keyword'>import</span> <span class='conid'>Text</span><span class='varop'>.</span><span class='conid'>XML</span><span class='varop'>.</span><span class='conid'>HXT</span><span class='varop'>.</span><span class='conid'>Arrow</span><span class='varop'>.</span><span class='conid'>XmlIOStateArrow</span>
<a name="line-33"></a>
<a name="line-34"></a><span class='keyword'>import</span> <span class='conid'>Text</span><span class='varop'>.</span><span class='conid'>XML</span><span class='varop'>.</span><span class='conid'>HXT</span><span class='varop'>.</span><span class='conid'>Arrow</span><span class='varop'>.</span><span class='conid'>Edit</span> <span class='layout'>(</span> <span class='varid'>escapeHtmlDoc</span>
<a name="line-35"></a> <span class='layout'>,</span> <span class='varid'>escapeXmlDoc</span>
<a name="line-36"></a> <span class='layout'>,</span> <span class='varid'>haskellRepOfXmlDoc</span>
<a name="line-37"></a> <span class='layout'>,</span> <span class='varid'>indentDoc</span>
<a name="line-38"></a> <span class='layout'>,</span> <span class='varid'>preventEmptyElements</span>
<a name="line-39"></a> <span class='layout'>,</span> <span class='varid'>removeDocWhiteSpace</span>
<a name="line-40"></a> <span class='layout'>,</span> <span class='varid'>treeRepOfXmlDoc</span>
<a name="line-41"></a> <span class='layout'>)</span>
<a name="line-42"></a>
<a name="line-43"></a><span class='keyword'>import</span> <span class='conid'>Text</span><span class='varop'>.</span><span class='conid'>XML</span><span class='varop'>.</span><span class='conid'>HXT</span><span class='varop'>.</span><span class='conid'>Arrow</span><span class='varop'>.</span><span class='conid'>DocumentOutput</span> <span class='layout'>(</span> <span class='varid'>putXmlDocument</span>
<a name="line-44"></a> <span class='layout'>,</span> <span class='varid'>encodeDocument</span>
<a name="line-45"></a> <span class='layout'>)</span>
<a name="line-46"></a>
<a name="line-47"></a><span class='comment'>-- ------------------------------------------------------------</span>
<a name="line-48"></a>
<a name="line-49"></a><span class='comment'>{- |
<a name="line-50"></a>the main filter for writing documents
<a name="line-51"></a>
<a name="line-52"></a>this filter can be configured by an option list like 'Text.XML.HXT.Arrow.ReadDocument.readDocument'
<a name="line-53"></a>
<a name="line-54"></a>usage: @ writeDocument optionList destination @
<a name="line-55"></a>
<a name="line-56"></a>if @ destination @ is the empty string or \"-\", stdout is used as output device
<a name="line-57"></a>
<a name="line-58"></a>available options are
<a name="line-59"></a>
<a name="line-60"></a>* 'a_indent' : indent document for readability, (default: no indentation)
<a name="line-61"></a>
<a name="line-62"></a>- 'a_remove_whitespace' : remove all redundant whitespace for shorten text (default: no removal)
<a name="line-63"></a>
<a name="line-64"></a>- 'a_output_encoding' : encoding of document, default is 'a_encoding' or 'utf8'
<a name="line-65"></a>
<a name="line-66"></a>- 'a_output_xml' : (default) issue XML: quote special XML chars \>,\<,\",\',& where neccessary
<a name="line-67"></a> add XML processing instruction
<a name="line-68"></a> and encode document with respect to 'a_output_encoding',
<a name="line-69"></a> if explicitly switched of, the plain text is issued, this is useful
<a name="line-70"></a> for non XML output, e.g. generated Haskell code, LaTex, Java, ...
<a name="line-71"></a>
<a name="line-72"></a>- 'a_output_html' : issue XHTML: quote alle XML chars, use HTML entity refs or char refs for none ASCII chars
<a name="line-73"></a>
<a name="line-74"></a>- 'a_no_empty_elements' : do not write the short form \<name .../\> for empty elements. When 'a_output_html' is set,
<a name="line-75"></a> the always empty HTML elements are still written in short form, but not the others, as e.g. the script element.
<a name="line-76"></a> Empty script elements, like \<script href=\"...\"/\>, are always a problem for firefox and others.
<a name="line-77"></a> When XML output is generated with this option, all empty elements are written in the long form.
<a name="line-78"></a>
<a name="line-79"></a>- 'a_no_xml_pi' : suppress generation of \<?xml ... ?\> processing instruction
<a name="line-80"></a>
<a name="line-81"></a>- 'a_show_tree' : show tree representation of document (for debugging)
<a name="line-82"></a>
<a name="line-83"></a>- 'a_show_haskell' : show Haskell representaion of document (for debugging)
<a name="line-84"></a>
<a name="line-85"></a> a minimal main program for copying a document
<a name="line-86"></a> has the following structure:
<a name="line-87"></a>
<a name="line-88"></a>> module Main
<a name="line-89"></a>> where
<a name="line-90"></a>>
<a name="line-91"></a>> import Text.XML.HXT.Arrow
<a name="line-92"></a>>
<a name="line-93"></a>> main :: IO ()
<a name="line-94"></a>> main
<a name="line-95"></a>> = do
<a name="line-96"></a>> runX ( readDocument [] "hello.xml"
<a name="line-97"></a>> >>>
<a name="line-98"></a>> writeDocument [] "bye.xml"
<a name="line-99"></a>> )
<a name="line-100"></a>> return ()
<a name="line-101"></a>
<a name="line-102"></a>an example for copying a document to standard output with tracing and evaluation of
<a name="line-103"></a>error code is:
<a name="line-104"></a>
<a name="line-105"></a>> module Main
<a name="line-106"></a>> where
<a name="line-107"></a>>
<a name="line-108"></a>> import Text.XML.HXT.Arrow
<a name="line-109"></a>> import System.Exit
<a name="line-110"></a>>
<a name="line-111"></a>> main :: IO ()
<a name="line-112"></a>> main
<a name="line-113"></a>> = do
<a name="line-114"></a>> [rc] <- runX ( readDocument [ (a_trace, "1")
<a name="line-115"></a>> ] "hello.xml"
<a name="line-116"></a>> >>>
<a name="line-117"></a>> writeDocument [ (a_output_encoding, isoLatin1)
<a name="line-118"></a>> ] "-" -- output to stdout
<a name="line-119"></a>> >>>
<a name="line-120"></a>> getErrStatus
<a name="line-121"></a>> )
<a name="line-122"></a>> exitWith ( if rc >= c_err
<a name="line-123"></a>> then ExitFailure 1
<a name="line-124"></a>> else ExitSuccess
<a name="line-125"></a>> )
<a name="line-126"></a>-}</span>
<a name="line-127"></a>
<a name="line-128"></a><a name="writeDocument"></a><span class='definition'>writeDocument</span> <span class='keyglyph'>::</span> <span class='conid'>Attributes</span> <span class='keyglyph'>-></span> <span class='conid'>String</span> <span class='keyglyph'>-></span> <span class='conid'>IOStateArrow</span> <span class='varid'>s</span> <span class='conid'>XmlTree</span> <span class='conid'>XmlTree</span>
<a name="line-129"></a><span class='definition'>writeDocument</span> <span class='varid'>userOptions</span> <span class='varid'>dst</span>
<a name="line-130"></a> <span class='keyglyph'>=</span> <span class='varid'>perform</span> <span class='layout'>(</span> <span class='varid'>traceMsg</span> <span class='num'>1</span> <span class='layout'>(</span><span class='str'>"writeDocument: destination is "</span> <span class='varop'>++</span> <span class='varid'>show</span> <span class='varid'>dst</span><span class='layout'>)</span>
<a name="line-131"></a> <span class='varop'>>>></span>
<a name="line-132"></a> <span class='varid'>prepareContents</span> <span class='varid'>userOptions</span>
<a name="line-133"></a> <span class='varop'>>>></span>
<a name="line-134"></a> <span class='varid'>putXmlDocument</span> <span class='varid'>dst</span>
<a name="line-135"></a> <span class='varop'>>>></span>
<a name="line-136"></a> <span class='varid'>traceMsg</span> <span class='num'>1</span> <span class='str'>"writeDocument: finished"</span>
<a name="line-137"></a> <span class='layout'>)</span>
<a name="line-138"></a> <span class='varop'>`when`</span>
<a name="line-139"></a> <span class='varid'>documentStatusOk</span>
<a name="line-140"></a>
<a name="line-141"></a><span class='comment'>-- ------------------------------------------------------------</span>
<a name="line-142"></a>
<a name="line-143"></a><span class='comment'>-- |</span>
<a name="line-144"></a><span class='comment'>-- Convert a document into a string. Formating is done the same way</span>
<a name="line-145"></a><span class='comment'>-- and with the same options as in 'writeDocument'.</span>
<a name="line-146"></a>
<a name="line-147"></a><a name="writeDocumentToString"></a><span class='definition'>writeDocumentToString</span> <span class='keyglyph'>::</span> <span class='conid'>Attributes</span> <span class='keyglyph'>-></span> <span class='conid'>IOStateArrow</span> <span class='varid'>s</span> <span class='conid'>XmlTree</span> <span class='conid'>String</span>
<a name="line-148"></a><span class='definition'>writeDocumentToString</span> <span class='varid'>userOptions</span>
<a name="line-149"></a> <span class='keyglyph'>=</span> <span class='varid'>prepareContents</span> <span class='varid'>userOptions</span>
<a name="line-150"></a> <span class='varop'>>>></span>
<a name="line-151"></a> <span class='varid'>xshow</span> <span class='varid'>getChildren</span>
<a name="line-152"></a>
<a name="line-153"></a><span class='comment'>-- ------------------------------------------------------------</span>
<a name="line-154"></a>
<a name="line-155"></a><span class='comment'>-- |</span>
<a name="line-156"></a><span class='comment'>-- indent and format output</span>
<a name="line-157"></a>
<a name="line-158"></a><a name="prepareContents"></a><span class='definition'>prepareContents</span> <span class='keyglyph'>::</span> <span class='conid'>Attributes</span> <span class='keyglyph'>-></span> <span class='conid'>IOStateArrow</span> <span class='varid'>s</span> <span class='conid'>XmlTree</span> <span class='conid'>XmlTree</span>
<a name="line-159"></a><span class='definition'>prepareContents</span> <span class='varid'>userOptions</span>
<a name="line-160"></a> <span class='keyglyph'>=</span> <span class='varid'>indent</span>
<a name="line-161"></a> <span class='varop'>>>></span>
<a name="line-162"></a> <span class='varid'>format</span>
<a name="line-163"></a> <span class='keyword'>where</span>
<a name="line-164"></a> <span class='varid'>formatEmptyElems</span>
<a name="line-165"></a> <span class='keyglyph'>|</span> <span class='varid'>hasOption</span> <span class='varid'>a_no_empty_elements</span> <span class='keyglyph'>=</span> <span class='varid'>preventEmptyElements</span>
<a name="line-166"></a> <span class='keyglyph'>|</span> <span class='varid'>otherwise</span> <span class='keyglyph'>=</span> <span class='varid'>const</span> <span class='varid'>this</span>
<a name="line-167"></a> <span class='varid'>indent</span>
<a name="line-168"></a> <span class='keyglyph'>|</span> <span class='varid'>hasOption</span> <span class='varid'>a_indent</span> <span class='keyglyph'>=</span> <span class='varid'>indentDoc</span> <span class='comment'>-- document indentation</span>
<a name="line-169"></a> <span class='keyglyph'>|</span> <span class='varid'>hasOption</span> <span class='varid'>a_remove_whitespace</span> <span class='keyglyph'>=</span> <span class='varid'>removeDocWhiteSpace</span> <span class='comment'>-- remove all whitespace between tags</span>
<a name="line-170"></a> <span class='keyglyph'>|</span> <span class='varid'>otherwise</span> <span class='keyglyph'>=</span> <span class='varid'>this</span>
<a name="line-171"></a>
<a name="line-172"></a> <span class='varid'>format</span>
<a name="line-173"></a> <span class='keyglyph'>|</span> <span class='varid'>hasOption</span> <span class='varid'>a_show_tree</span> <span class='keyglyph'>=</span> <span class='varid'>treeRepOfXmlDoc</span>
<a name="line-174"></a> <span class='keyglyph'>|</span> <span class='varid'>hasOption</span> <span class='varid'>a_show_haskell</span> <span class='keyglyph'>=</span> <span class='varid'>haskellRepOfXmlDoc</span>
<a name="line-175"></a> <span class='keyglyph'>|</span> <span class='varid'>hasOption</span> <span class='varid'>a_output_html</span> <span class='keyglyph'>=</span> <span class='varid'>formatEmptyElems</span> <span class='conid'>True</span>
<a name="line-176"></a> <span class='varop'>>>></span>
<a name="line-177"></a> <span class='varid'>escapeHtmlDoc</span> <span class='comment'>-- escape al XML and HTML chars >= 128</span>
<a name="line-178"></a> <span class='varop'>>>></span>
<a name="line-179"></a> <span class='varid'>encodeDocument</span> <span class='comment'>-- convert doc into text with respect to output encoding with ASCII as default</span>
<a name="line-180"></a> <span class='varid'>suppressXmlPi</span> <span class='layout'>(</span> <span class='varid'>lookupDef</span> <span class='varid'>usAscii</span> <span class='varid'>a_output_encoding</span> <span class='varid'>options</span> <span class='layout'>)</span>
<a name="line-181"></a> <span class='keyglyph'>|</span> <span class='varid'>hasOption</span> <span class='varid'>a_output_xml</span> <span class='keyglyph'>=</span> <span class='varid'>formatEmptyElems</span> <span class='conid'>False</span>
<a name="line-182"></a> <span class='varop'>>>></span>
<a name="line-183"></a> <span class='varid'>escapeXmlDoc</span> <span class='comment'>-- escape lt, gt, amp, quot, </span>
<a name="line-184"></a> <span class='varop'>>>></span>
<a name="line-185"></a> <span class='varid'>encodeDocument</span> <span class='comment'>-- convert doc into text with respect to output encoding</span>
<a name="line-186"></a> <span class='varid'>suppressXmlPi</span> <span class='layout'>(</span> <span class='varid'>lookupDef</span> <span class='str'>""</span> <span class='varid'>a_output_encoding</span> <span class='varid'>options</span> <span class='layout'>)</span>
<a name="line-187"></a> <span class='keyglyph'>|</span> <span class='varid'>otherwise</span> <span class='keyglyph'>=</span> <span class='varid'>this</span>
<a name="line-188"></a>
<a name="line-189"></a> <span class='varid'>suppressXmlPi</span> <span class='comment'>-- remove <?xml ... ?> when set</span>
<a name="line-190"></a> <span class='keyglyph'>=</span> <span class='varid'>hasOption</span> <span class='varid'>a_no_xml_pi</span>
<a name="line-191"></a>
<a name="line-192"></a> <span class='varid'>hasOption</span> <span class='varid'>n</span>
<a name="line-193"></a> <span class='keyglyph'>=</span> <span class='varid'>optionIsSet</span> <span class='varid'>n</span> <span class='varid'>options</span>
<a name="line-194"></a>
<a name="line-195"></a> <span class='varid'>options</span> <span class='keyglyph'>=</span> <span class='varid'>addEntries</span>
<a name="line-196"></a> <span class='varid'>userOptions</span>
<a name="line-197"></a> <span class='keyglyph'>[</span> <span class='layout'>(</span> <span class='varid'>a_indent</span><span class='layout'>,</span> <span class='varid'>v_0</span> <span class='layout'>)</span>
<a name="line-198"></a> <span class='layout'>,</span> <span class='layout'>(</span> <span class='varid'>a_remove_whitespace</span><span class='layout'>,</span> <span class='varid'>v_0</span> <span class='layout'>)</span>
<a name="line-199"></a> <span class='layout'>,</span> <span class='layout'>(</span> <span class='varid'>a_output_xml</span><span class='layout'>,</span> <span class='varid'>v_1</span> <span class='layout'>)</span>
<a name="line-200"></a> <span class='layout'>,</span> <span class='layout'>(</span> <span class='varid'>a_show_tree</span><span class='layout'>,</span> <span class='varid'>v_0</span> <span class='layout'>)</span>
<a name="line-201"></a> <span class='layout'>,</span> <span class='layout'>(</span> <span class='varid'>a_show_haskell</span><span class='layout'>,</span> <span class='varid'>v_0</span> <span class='layout'>)</span>
<a name="line-202"></a> <span class='layout'>,</span> <span class='layout'>(</span> <span class='varid'>a_output_html</span><span class='layout'>,</span> <span class='varid'>v_0</span> <span class='layout'>)</span>
<a name="line-203"></a> <span class='layout'>,</span> <span class='layout'>(</span> <span class='varid'>a_no_xml_pi</span><span class='layout'>,</span> <span class='varid'>v_0</span> <span class='layout'>)</span>
<a name="line-204"></a> <span class='layout'>,</span> <span class='layout'>(</span> <span class='varid'>a_no_empty_elements</span><span class='layout'>,</span> <span class='varid'>v_0</span> <span class='layout'>)</span>
<a name="line-205"></a> <span class='keyglyph'>]</span>
<a name="line-206"></a>
<a name="line-207"></a><span class='comment'>-- ------------------------------------------------------------</span>
</pre></body>
</html>