hxt-8.3.0: doc/hdoc/src/Text-XML-HXT-Arrow-DocumentOutput.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.DocumentOutput
<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> State arrows for document output
<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'>DocumentOutput</span>
<a name="line-19"></a> <span class='layout'>(</span> <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'>DocumentOutput</span> <span class='layout'>)</span>
<a name="line-20"></a><span class='keyword'>where</span>
<a name="line-21"></a>
<a name="line-22"></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-23"></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-24"></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-25"></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-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'>ArrowIO</span>
<a name="line-27"></a>
<a name="line-28"></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'>Unicode</span>
<a name="line-29"></a> <span class='layout'>(</span> <span class='varid'>getOutputEncodingFct</span> <span class='layout'>)</span>
<a name="line-30"></a>
<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'>DOM</span><span class='varop'>.</span><span class='conid'>Interface</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'>XmlArrow</span>
<a name="line-33"></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-34"></a>
<a name="line-35"></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>
<a name="line-36"></a> <span class='layout'>(</span> <span class='varid'>addHeadlineToXmlDoc</span>
<a name="line-37"></a> <span class='layout'>,</span> <span class='varid'>addXmlPi</span>
<a name="line-38"></a> <span class='layout'>,</span> <span class='varid'>addXmlPiEncoding</span>
<a name="line-39"></a> <span class='layout'>,</span> <span class='varid'>indentDoc</span>
<a name="line-40"></a> <span class='layout'>,</span> <span class='varid'>numberLinesInXmlDoc</span>
<a name="line-41"></a> <span class='layout'>,</span> <span class='varid'>treeRepOfXmlDoc</span>
<a name="line-42"></a> <span class='layout'>)</span>
<a name="line-43"></a>
<a name="line-44"></a><span class='keyword'>import</span> <span class='conid'>Data</span><span class='varop'>.</span><span class='conid'>Maybe</span>
<a name="line-45"></a>
<a name="line-46"></a><span class='keyword'>import</span> <span class='conid'>System</span><span class='varop'>.</span><span class='conid'>IO</span>
<a name="line-47"></a> <span class='layout'>(</span> <span class='conid'>Handle</span>
<a name="line-48"></a> <span class='layout'>,</span> <span class='conid'>IOMode</span><span class='layout'>(</span><span class='keyglyph'>..</span><span class='layout'>)</span>
<a name="line-49"></a> <span class='layout'>,</span> <span class='varid'>openFile</span>
<a name="line-50"></a> <span class='layout'>,</span> <span class='varid'>hPutStrLn</span>
<a name="line-51"></a> <span class='layout'>,</span> <span class='varid'>hClose</span>
<a name="line-52"></a> <span class='layout'>,</span> <span class='varid'>stdout</span>
<a name="line-53"></a> <span class='layout'>)</span>
<a name="line-54"></a>
<a name="line-55"></a><span class='keyword'>import</span> <span class='conid'>System</span><span class='varop'>.</span><span class='conid'>IO</span><span class='varop'>.</span><span class='conid'>Error</span>
<a name="line-56"></a> <span class='layout'>(</span> <span class='varid'>try</span> <span class='layout'>)</span>
<a name="line-57"></a>
<a name="line-58"></a><span class='comment'>-- ------------------------------------------------------------</span>
<a name="line-59"></a><span class='comment'>--</span>
<a name="line-60"></a><span class='comment'>-- output arrows</span>
<a name="line-61"></a>
<a name="line-62"></a><a name="putXmlDocument"></a><span class='definition'>putXmlDocument</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-63"></a><span class='definition'>putXmlDocument</span> <span class='varid'>dst</span>
<a name="line-64"></a> <span class='keyglyph'>=</span> <span class='varid'>perform</span> <span class='layout'>(</span> <span class='varid'>xshow</span> <span class='varid'>getChildren</span>
<a name="line-65"></a> <span class='varop'>>>></span>
<a name="line-66"></a> <span class='varid'>arrIO</span> <span class='layout'>(</span><span class='keyglyph'>\</span> <span class='varid'>s</span> <span class='keyglyph'>-></span> <span class='varid'>try</span> <span class='layout'>(</span> <span class='varid'>hPutDocument</span> <span class='layout'>(</span><span class='keyglyph'>\</span><span class='varid'>h</span> <span class='keyglyph'>-></span> <span class='varid'>hPutStrLn</span> <span class='varid'>h</span> <span class='varid'>s</span><span class='layout'>)</span><span class='layout'>)</span><span class='layout'>)</span>
<a name="line-67"></a> <span class='varop'>>>></span>
<a name="line-68"></a> <span class='layout'>(</span> <span class='layout'>(</span> <span class='varid'>traceMsg</span> <span class='num'>1</span> <span class='layout'>(</span><span class='str'>"io error, document not written to "</span> <span class='varop'>++</span> <span class='varid'>outFile</span><span class='layout'>)</span>
<a name="line-69"></a> <span class='varop'>>>></span>
<a name="line-70"></a> <span class='varid'>arr</span> <span class='varid'>show</span> <span class='varop'>>>></span> <span class='varid'>mkError</span> <span class='varid'>c_fatal</span>
<a name="line-71"></a> <span class='varop'>>>></span>
<a name="line-72"></a> <span class='varid'>filterErrorMsg</span>
<a name="line-73"></a> <span class='layout'>)</span>
<a name="line-74"></a> <span class='varop'>|||</span>
<a name="line-75"></a> <span class='layout'>(</span> <span class='varid'>traceMsg</span> <span class='num'>2</span> <span class='layout'>(</span><span class='str'>"document written to "</span> <span class='varop'>++</span> <span class='varid'>outFile</span><span class='layout'>)</span>
<a name="line-76"></a> <span class='varop'>>>></span>
<a name="line-77"></a> <span class='varid'>none</span>
<a name="line-78"></a> <span class='layout'>)</span>
<a name="line-79"></a> <span class='layout'>)</span>
<a name="line-80"></a> <span class='layout'>)</span>
<a name="line-81"></a> <span class='keyword'>where</span>
<a name="line-82"></a> <span class='varid'>isStdout</span> <span class='keyglyph'>=</span> <span class='varid'>null</span> <span class='varid'>dst</span> <span class='varop'>||</span> <span class='varid'>dst</span> <span class='varop'>==</span> <span class='str'>"-"</span>
<a name="line-83"></a>
<a name="line-84"></a> <span class='varid'>outFile</span> <span class='keyglyph'>=</span> <span class='keyword'>if</span> <span class='varid'>isStdout</span>
<a name="line-85"></a> <span class='keyword'>then</span> <span class='str'>"stdout"</span>
<a name="line-86"></a> <span class='keyword'>else</span> <span class='varid'>show</span> <span class='varid'>dst</span>
<a name="line-87"></a>
<a name="line-88"></a> <span class='varid'>hPutDocument</span> <span class='keyglyph'>::</span> <span class='layout'>(</span><span class='conid'>Handle</span> <span class='keyglyph'>-></span> <span class='conid'>IO</span><span class='conid'>()</span><span class='layout'>)</span> <span class='keyglyph'>-></span> <span class='conid'>IO</span><span class='conid'>()</span>
<a name="line-89"></a> <span class='varid'>hPutDocument</span> <span class='varid'>action</span>
<a name="line-90"></a> <span class='keyglyph'>|</span> <span class='varid'>isStdout</span>
<a name="line-91"></a> <span class='keyglyph'>=</span> <span class='varid'>action</span> <span class='varid'>stdout</span>
<a name="line-92"></a> <span class='keyglyph'>|</span> <span class='varid'>otherwise</span>
<a name="line-93"></a> <span class='keyglyph'>=</span> <span class='keyword'>do</span>
<a name="line-94"></a> <span class='varid'>handle</span> <span class='keyglyph'><-</span> <span class='varid'>openFile</span> <span class='varid'>dst</span> <span class='conid'>WriteMode</span>
<a name="line-95"></a> <span class='varid'>action</span> <span class='varid'>handle</span>
<a name="line-96"></a> <span class='varid'>hClose</span> <span class='varid'>handle</span>
<a name="line-97"></a>
<a name="line-98"></a><span class='comment'>-- |</span>
<a name="line-99"></a><span class='comment'>-- write the tree representation of a document to a file</span>
<a name="line-100"></a>
<a name="line-101"></a><a name="putXmlTree"></a><span class='definition'>putXmlTree</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-102"></a><span class='definition'>putXmlTree</span> <span class='varid'>dst</span>
<a name="line-103"></a> <span class='keyglyph'>=</span> <span class='varid'>perform</span> <span class='layout'>(</span> <span class='varid'>treeRepOfXmlDoc</span>
<a name="line-104"></a> <span class='varop'>>>></span>
<a name="line-105"></a> <span class='varid'>addHeadlineToXmlDoc</span>
<a name="line-106"></a> <span class='varop'>>>></span>
<a name="line-107"></a> <span class='varid'>putXmlDocument</span> <span class='varid'>dst</span>
<a name="line-108"></a> <span class='layout'>)</span>
<a name="line-109"></a>
<a name="line-110"></a><span class='comment'>-- |</span>
<a name="line-111"></a><span class='comment'>-- write a document with indentaion and line numers</span>
<a name="line-112"></a>
<a name="line-113"></a><a name="putXmlSource"></a><span class='definition'>putXmlSource</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-114"></a><span class='definition'>putXmlSource</span> <span class='varid'>dst</span>
<a name="line-115"></a> <span class='keyglyph'>=</span> <span class='varid'>perform</span> <span class='layout'>(</span> <span class='layout'>(</span><span class='varid'>this</span> <span class='layout'>)</span> <span class='varop'>`whenNot`</span> <span class='varid'>isRoot</span>
<a name="line-116"></a> <span class='varop'>>>></span>
<a name="line-117"></a> <span class='varid'>indentDoc</span>
<a name="line-118"></a> <span class='varop'>>>></span>
<a name="line-119"></a> <span class='varid'>numberLinesInXmlDoc</span>
<a name="line-120"></a> <span class='varop'>>>></span>
<a name="line-121"></a> <span class='varid'>addHeadlineToXmlDoc</span>
<a name="line-122"></a> <span class='varop'>>>></span>
<a name="line-123"></a> <span class='varid'>putXmlDocument</span> <span class='varid'>dst</span>
<a name="line-124"></a> <span class='layout'>)</span>
<a name="line-125"></a>
<a name="line-126"></a><span class='comment'>-- ------------------------------------------------------------</span>
<a name="line-127"></a>
<a name="line-128"></a><a name="getOutputEncoding"></a><span class='definition'>getOutputEncoding</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'>String</span>
<a name="line-129"></a><span class='definition'>getOutputEncoding</span> <span class='varid'>defaultEnc</span>
<a name="line-130"></a> <span class='keyglyph'>=</span> <span class='varid'>catA</span> <span class='keyglyph'>[</span> <span class='varid'>getChildren</span> <span class='comment'>-- 1. guess: evaluate <?xml ... encoding="..."?></span>
<a name="line-131"></a> <span class='varop'>>>></span>
<a name="line-132"></a> <span class='layout'>(</span> <span class='layout'>(</span> <span class='varid'>isPi</span> <span class='varop'>>>></span> <span class='varid'>hasName</span> <span class='varid'>t_xml</span> <span class='layout'>)</span>
<a name="line-133"></a> <span class='varop'>`guards`</span>
<a name="line-134"></a> <span class='varid'>getAttrValue</span> <span class='varid'>a_encoding</span>
<a name="line-135"></a> <span class='layout'>)</span>
<a name="line-136"></a> <span class='layout'>,</span> <span class='varid'>constA</span> <span class='varid'>defaultEnc</span> <span class='comment'>-- 2. guess: explicit parameter, may be ""</span>
<a name="line-137"></a> <span class='layout'>,</span> <span class='varid'>getAttrValue</span> <span class='varid'>a_output_encoding</span> <span class='comment'>-- 3. guess: take output encoding parameter in root node</span>
<a name="line-138"></a> <span class='layout'>,</span> <span class='varid'>getParamString</span> <span class='varid'>a_output_encoding</span> <span class='comment'>-- 4. guess: take output encoding parameter in global state</span>
<a name="line-139"></a> <span class='layout'>,</span> <span class='varid'>getParamString</span> <span class='varid'>a_encoding</span> <span class='comment'>-- 5. guess: take encoding parameter in global state</span>
<a name="line-140"></a> <span class='layout'>,</span> <span class='varid'>constA</span> <span class='varid'>utf8</span> <span class='comment'>-- default : utf8</span>
<a name="line-141"></a> <span class='keyglyph'>]</span>
<a name="line-142"></a> <span class='varop'>>.</span> <span class='layout'>(</span><span class='varid'>head</span> <span class='varop'>.</span> <span class='varid'>filter</span> <span class='layout'>(</span><span class='varid'>not</span> <span class='varop'>.</span> <span class='varid'>null</span><span class='layout'>)</span><span class='layout'>)</span> <span class='comment'>-- make the filter deterministic: take 1. entry from list of guesses</span>
<a name="line-143"></a>
<a name="line-144"></a><a name="encodeDocument"></a><span class='definition'>encodeDocument</span> <span class='keyglyph'>::</span> <span class='conid'>Bool</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-145"></a><span class='definition'>encodeDocument</span> <span class='varid'>supressXmlPi</span> <span class='varid'>defaultEnc</span>
<a name="line-146"></a> <span class='keyglyph'>=</span> <span class='varid'>applyA</span> <span class='layout'>(</span> <span class='varid'>getOutputEncoding</span> <span class='varid'>defaultEnc</span>
<a name="line-147"></a> <span class='varop'>>>></span>
<a name="line-148"></a> <span class='varid'>arr</span> <span class='varid'>encArr</span>
<a name="line-149"></a> <span class='layout'>)</span>
<a name="line-150"></a> <span class='varop'>`when`</span>
<a name="line-151"></a> <span class='varid'>isRoot</span>
<a name="line-152"></a> <span class='keyword'>where</span>
<a name="line-153"></a> <span class='varid'>encArr</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-154"></a> <span class='varid'>encArr</span> <span class='varid'>enc</span> <span class='keyglyph'>=</span> <span class='varid'>maybe</span> <span class='varid'>notFound</span> <span class='varid'>found</span> <span class='varop'>.</span> <span class='varid'>getOutputEncodingFct</span> <span class='varop'>$</span> <span class='varid'>enc</span>
<a name="line-155"></a> <span class='keyword'>where</span>
<a name="line-156"></a> <span class='varid'>found</span> <span class='varid'>ef</span> <span class='keyglyph'>=</span> <span class='varid'>traceMsg</span> <span class='num'>2</span> <span class='layout'>(</span><span class='str'>"encodeDocument: encoding is "</span> <span class='varop'>++</span> <span class='varid'>show</span> <span class='varid'>enc</span><span class='layout'>)</span>
<a name="line-157"></a> <span class='varop'>>>></span>
<a name="line-158"></a> <span class='layout'>(</span> <span class='keyword'>if</span> <span class='varid'>supressXmlPi</span>
<a name="line-159"></a> <span class='keyword'>then</span> <span class='varid'>processChildren</span> <span class='layout'>(</span><span class='varid'>none</span> <span class='varop'>`when`</span> <span class='varid'>isXmlPi</span><span class='layout'>)</span>
<a name="line-160"></a> <span class='keyword'>else</span> <span class='layout'>(</span> <span class='varid'>addXmlPi</span>
<a name="line-161"></a> <span class='varop'>>>></span>
<a name="line-162"></a> <span class='varid'>addXmlPiEncoding</span> <span class='varid'>enc</span>
<a name="line-163"></a> <span class='layout'>)</span>
<a name="line-164"></a> <span class='layout'>)</span>
<a name="line-165"></a> <span class='varop'>>>></span>
<a name="line-166"></a> <span class='varid'>replaceChildren</span> <span class='layout'>(</span> <span class='varid'>xshow</span> <span class='varid'>getChildren</span>
<a name="line-167"></a> <span class='varop'>>>></span>
<a name="line-168"></a> <span class='varid'>arr</span> <span class='varid'>ef</span>
<a name="line-169"></a> <span class='varop'>>>></span>
<a name="line-170"></a> <span class='varid'>mkText</span>
<a name="line-171"></a> <span class='layout'>)</span>
<a name="line-172"></a> <span class='varop'>>>></span>
<a name="line-173"></a> <span class='varid'>addAttr</span> <span class='varid'>a_output_encoding</span> <span class='varid'>enc</span>
<a name="line-174"></a>
<a name="line-175"></a> <span class='varid'>notFound</span> <span class='keyglyph'>=</span> <span class='varid'>issueFatal</span> <span class='layout'>(</span><span class='str'>"encoding scheme not supported: "</span> <span class='varop'>++</span> <span class='varid'>show</span> <span class='varid'>enc</span><span class='layout'>)</span>
<a name="line-176"></a> <span class='varop'>>>></span>
<a name="line-177"></a> <span class='varid'>setDocumentStatusFromSystemState</span> <span class='str'>"encoding document"</span>
<a name="line-178"></a>
<a name="line-179"></a><span class='comment'>-- ------------------------------------------------------------</span>
</pre></body>
</html>