hxt-8.2.0: doc/hdoc/src/Text-XML-HXT-Arrow-ReadDocument.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.ReadDocument
<a name="line-5"></a> Copyright : Copyright (C) 2005 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> Version : $Id: ReadDocument.hs,v 1.10 2006/11/24 07:41:37 hxml Exp $
<a name="line-12"></a>
<a name="line-13"></a>Compound arrows for reading an XML\/HTML document or an XML\/HTML string
<a name="line-14"></a>
<a name="line-15"></a>-}</span>
<a name="line-16"></a>
<a name="line-17"></a><span class='comment'>-- ------------------------------------------------------------</span>
<a name="line-18"></a>
<a name="line-19"></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'>ReadDocument</span>
<a name="line-20"></a> <span class='layout'>(</span> <span class='varid'>readDocument</span>
<a name="line-21"></a> <span class='layout'>,</span> <span class='varid'>readFromDocument</span>
<a name="line-22"></a> <span class='layout'>,</span> <span class='varid'>readString</span>
<a name="line-23"></a> <span class='layout'>,</span> <span class='varid'>readFromString</span>
<a name="line-24"></a> <span class='layout'>,</span> <span class='varid'>hread</span>
<a name="line-25"></a> <span class='layout'>,</span> <span class='varid'>xread</span>
<a name="line-26"></a> <span class='layout'>)</span>
<a name="line-27"></a><span class='keyword'>where</span>
<a name="line-28"></a>
<a name="line-29"></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'>ListArrows</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'>canonicalizeAllNodes</span>
<a name="line-37"></a> <span class='layout'>,</span> <span class='varid'>canonicalizeForXPath</span>
<a name="line-38"></a> <span class='layout'>,</span> <span class='varid'>canonicalizeContents</span>
<a name="line-39"></a> <span class='layout'>,</span> <span class='varid'>removeDocWhiteSpace</span>
<a name="line-40"></a> <span class='layout'>)</span>
<a name="line-41"></a>
<a name="line-42"></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'>ParserInterface</span>
<a name="line-43"></a>
<a name="line-44"></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'>ProcessDocument</span>
<a name="line-45"></a> <span class='layout'>(</span> <span class='varid'>getDocumentContents</span>
<a name="line-46"></a> <span class='layout'>,</span> <span class='varid'>parseXmlDocument</span>
<a name="line-47"></a> <span class='layout'>,</span> <span class='varid'>parseHtmlDocument</span>
<a name="line-48"></a> <span class='layout'>,</span> <span class='varid'>propagateAndValidateNamespaces</span>
<a name="line-49"></a> <span class='layout'>)</span>
<a name="line-50"></a>
<a name="line-51"></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'>RelaxNG</span><span class='varop'>.</span><span class='conid'>Validator</span>
<a name="line-52"></a> <span class='layout'>(</span> <span class='varid'>validateDocumentWithRelaxSchema</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'>Data</span><span class='varop'>.</span><span class='conid'>Char</span>
<a name="line-56"></a> <span class='layout'>(</span> <span class='varid'>toLower</span>
<a name="line-57"></a> <span class='layout'>)</span>
<a name="line-58"></a>
<a name="line-59"></a><span class='comment'>-- ------------------------------------------------------------</span>
<a name="line-60"></a>
<a name="line-61"></a><span class='comment'>{- |
<a name="line-62"></a>the main document input filter
<a name="line-63"></a>
<a name="line-64"></a>this filter can be configured by an option list, a value of type "Attributes"
<a name="line-65"></a>
<a name="line-66"></a>available options:
<a name="line-67"></a>
<a name="line-68"></a>* 'a_parse_html': use HTML parser, else use XML parser (default)
<a name="line-69"></a>
<a name="line-70"></a>- 'a_tagsoup' : use light weight and lasy parser based on tagsoup lib
<a name="line-71"></a>
<a name="line-72"></a>- 'a_parse_by_mimetype' : select the parser by the mime type of the document
<a name="line-73"></a> (pulled out of the HTTP header). When the mime type is set to \"text\/html\"
<a name="line-74"></a> the HTML parser (parsec or tagsoup) is taken, when it\'s set to
<a name="line-75"></a> \"text\/xml\" or \"text\/xhtml\" the XML parser (parsec or tagsoup) is taken.
<a name="line-76"></a> If the mime type is something else no further processing is performed,
<a name="line-77"></a> the contents is given back to the application in form of a single text node.
<a name="line-78"></a> If the default document encoding ('a_encoding') is set to isoLatin1, this even enables processing
<a name="line-79"></a> of arbitray binary data.
<a name="line-80"></a>
<a name="line-81"></a>- 'a_validate' : validate document againsd DTD (default), else skip validation
<a name="line-82"></a>
<a name="line-83"></a>- 'a_relax_schema' : validate document with Relax NG, the options value is the schema URI
<a name="line-84"></a> this implies using XML parser, no validation against DTD, and canonicalisation
<a name="line-85"></a>
<a name="line-86"></a>- 'a_check_namespaces' : check namespaces, else skip namespace processing (default)
<a name="line-87"></a>
<a name="line-88"></a>- 'a_canonicalize' : canonicalize document (default), else skip canonicalization
<a name="line-89"></a>
<a name="line-90"></a>- 'a_preserve_comment' : preserve comments during canonicalization, else remove comments (default)
<a name="line-91"></a>
<a name="line-92"></a>- 'a_remove_whitespace' : remove all whitespace, used for document indentation, else skip this step (default)
<a name="line-93"></a>
<a name="line-94"></a>- 'a_indent' : indent document by inserting whitespace, else skip this step (default)
<a name="line-95"></a>
<a name="line-96"></a>- 'a_issue_warnings' : issue warnings, when parsing HTML (default), else ignore HTML parser warnings
<a name="line-97"></a>
<a name="line-98"></a>- 'a_issue_errors' : issue all error messages on stderr (default), or ignore all error messages
<a name="line-99"></a>
<a name="line-100"></a>- 'a_ignore_encoding_errors': ignore all encoding errors, default is issue all encoding errors
<a name="line-101"></a>
<a name="line-102"></a>- 'a_ignore_none_xml_contents': ignore document contents of none XML\/HTML documents.
<a name="line-103"></a> This option can be useful for implementing crawler like applications, e.g. an URL checker.
<a name="line-104"></a> In those cases net traffic can be reduced.
<a name="line-105"></a>
<a name="line-106"></a>- 'a_trace' : trace level: values: 0 - 4
<a name="line-107"></a>
<a name="line-108"></a>- 'a_proxy' : proxy for http access, e.g. www-cache:3128
<a name="line-109"></a>
<a name="line-110"></a>- 'a_use_curl' : obsolete and ignored, HTTP acccess is always done with curl bindings for libcurl
<a name="line-111"></a>
<a name="line-112"></a>- 'a_options_curl' : deprecated but for compatibility reasons still supported.
<a name="line-113"></a> More options passed to the curl binding.
<a name="line-114"></a> Instead of using this option to set a whole bunch of options at once for curl
<a name="line-115"></a> it is recomended to use the @curl-.*@ options syntax described below.
<a name="line-116"></a>
<a name="line-117"></a>- 'a_encoding' : default document encoding ('utf8', 'isoLatin1', 'usAscii', 'iso8859_2', ... , 'iso8859_16', ...).
<a name="line-118"></a> Only XML and HTML documents are decoded, documents with none XML\/HTML mime types are not decoded. The whole content is returned in a single text node
<a name="line-119"></a>
<a name="line-120"></a>- 'a_mime_types' : set the mime type table for file input with given file. The format of this config file must be in the syntax of a debian linux \"mime.types\" config file
<a name="line-121"></a>
<a name="line-122"></a>- curl options : the HTTP interface with libcurl can be configured with a lot of options. To support these options in an easy way, there is a naming convetion:
<a name="line-123"></a> Every option, which has the prefix @curl@ and the rest of the name forms an option as described in the curl man page, is passed to the curl binding lib.
<a name="line-124"></a> See 'Text.XML.HXT.IO.GetHTTPLibCurl.getCont' for examples. Currently most of the options concerning HTTP requests are implemented.
<a name="line-125"></a>
<a name="line-126"></a>All attributes not evaluated by readDocument are stored in the created document root node for easy access of the various
<a name="line-127"></a>options in e.g. the input\/output modules
<a name="line-128"></a>
<a name="line-129"></a>If the document name is the empty string or an uri of the form \"stdin:\", the document is read from standard input.
<a name="line-130"></a>
<a name="line-131"></a>examples:
<a name="line-132"></a>
<a name="line-133"></a>> readDocument [ ] "test.xml"
<a name="line-134"></a>
<a name="line-135"></a>reads and validates a document \"test.xml\", no namespace propagation, only canonicalization is performed
<a name="line-136"></a>
<a name="line-137"></a>> readDocument [ (a_validate, "0")
<a name="line-138"></a>> , (a_encoding, isoLatin1)
<a name="line-139"></a>> , (a_parse_by_mimetype, "1")
<a name="line-140"></a>> ] "<a href="http://localhost/test.php">http://localhost/test.php</a>"
<a name="line-141"></a>
<a name="line-142"></a>reads document \"test.php\", parses it as HTML or XML depending on the mimetype given from the server, but without validation, default encoding 'isoLatin1'.
<a name="line-143"></a>
<a name="line-144"></a>
<a name="line-145"></a>> readDocument [ (a_parse_html, "1")
<a name="line-146"></a>> , (a_encoding, isoLatin1)
<a name="line-147"></a>> ] ""
<a name="line-148"></a>
<a name="line-149"></a>reads a HTML document from standard input, no validation is done when parsing HTML, default encoding is 'isoLatin1',
<a name="line-150"></a>parsing is done with tagsoup parser
<a name="line-151"></a>
<a name="line-152"></a>> readDocument [ (a_encoding, isoLatin1)
<a name="line-153"></a>> , (a_mime_type, "/etc/mime.types")
<a name="line-154"></a>> , (a_tagsoup, "1")
<a name="line-155"></a>> ] "test.svg"
<a name="line-156"></a>
<a name="line-157"></a>reads an SVG document from standard input, sets the mime type by looking in the system mimetype config file, default encoding is 'isoLatin1',
<a name="line-158"></a>parsing is done with the lightweight tagsoup parser, which implies no validation.
<a name="line-159"></a>
<a name="line-160"></a>> readDocument [ (a_parse_html, "1")
<a name="line-161"></a>> , (a_proxy, "www-cache:3128")
<a name="line-162"></a>> , (a_curl, "1")
<a name="line-163"></a>> , (a_issue_warnings, "0")
<a name="line-164"></a>> ] "<a href="http://www.haskell.org/">http://www.haskell.org/</a>"
<a name="line-165"></a>
<a name="line-166"></a>reads Haskell homepage with HTML parser ignoring any warnings, with http access via external program curl and proxy \"www-cache\" at port 3128
<a name="line-167"></a>
<a name="line-168"></a>> readDocument [ (a_validate, "1")
<a name="line-169"></a>> , (a_check_namespace, "1")
<a name="line-170"></a>> , (a_remove_whitespace, "1")
<a name="line-171"></a>> , (a_trace, "2")
<a name="line-172"></a>> ] "<a href="http://www.w3c.org/">http://www.w3c.org/</a>"
<a name="line-173"></a>
<a name="line-174"></a>read w3c home page (xhtml), validate and check namespaces, remove whitespace between tags, trace activities with level 2
<a name="line-175"></a>
<a name="line-176"></a>for minimal complete examples see 'Text.XML.HXT.Arrow.WriteDocument.writeDocument' and 'runX', the main starting point for running an XML arrow.
<a name="line-177"></a>-}</span>
<a name="line-178"></a>
<a name="line-179"></a><a name="readDocument"></a><span class='definition'>readDocument</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='varid'>b</span> <span class='conid'>XmlTree</span>
<a name="line-180"></a><span class='definition'>readDocument</span> <span class='varid'>userOptions</span> <span class='varid'>src</span>
<a name="line-181"></a> <span class='keyglyph'>=</span> <span class='varid'>traceLevel</span>
<a name="line-182"></a> <span class='varop'>>>></span>
<a name="line-183"></a> <span class='varid'>addInputOptionsToSystemState</span>
<a name="line-184"></a> <span class='varop'>>>></span>
<a name="line-185"></a> <span class='varid'>getDocumentContents</span> <span class='varid'>options</span> <span class='varid'>src</span>
<a name="line-186"></a> <span class='varop'>>>></span>
<a name="line-187"></a> <span class='layout'>(</span> <span class='varid'>processDoc</span> <span class='varop'>$<</span> <span class='varid'>getMimeType</span> <span class='layout'>)</span>
<a name="line-188"></a> <span class='varop'>>>></span>
<a name="line-189"></a> <span class='varid'>traceMsg</span> <span class='num'>1</span> <span class='layout'>(</span><span class='str'>"readDocument: "</span> <span class='varop'>++</span> <span class='varid'>show</span> <span class='varid'>src</span> <span class='varop'>++</span> <span class='str'>" processed"</span><span class='layout'>)</span>
<a name="line-190"></a> <span class='varop'>>>></span>
<a name="line-191"></a> <span class='varid'>traceSource</span>
<a name="line-192"></a> <span class='varop'>>>></span>
<a name="line-193"></a> <span class='varid'>traceTree</span>
<a name="line-194"></a> <span class='keyword'>where</span>
<a name="line-195"></a> <span class='varid'>options</span>
<a name="line-196"></a> <span class='keyglyph'>=</span> <span class='varid'>addEntries</span> <span class='varid'>userOptions</span> <span class='varid'>defaultOptions</span>
<a name="line-197"></a>
<a name="line-198"></a> <span class='varid'>defaultOptions</span>
<a name="line-199"></a> <span class='keyglyph'>=</span> <span class='keyglyph'>[</span> <span class='layout'>(</span> <span class='varid'>a_parse_html</span><span class='layout'>,</span> <span class='varid'>v_0</span> <span class='layout'>)</span>
<a name="line-200"></a> <span class='layout'>,</span> <span class='layout'>(</span> <span class='varid'>a_tagsoup</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_validate</span><span class='layout'>,</span> <span class='varid'>v_1</span> <span class='layout'>)</span>
<a name="line-202"></a> <span class='layout'>,</span> <span class='layout'>(</span> <span class='varid'>a_issue_warnings</span><span class='layout'>,</span> <span class='varid'>v_1</span> <span class='layout'>)</span>
<a name="line-203"></a> <span class='layout'>,</span> <span class='layout'>(</span> <span class='varid'>a_check_namespaces</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_canonicalize</span><span class='layout'>,</span> <span class='varid'>v_1</span> <span class='layout'>)</span>
<a name="line-205"></a> <span class='layout'>,</span> <span class='layout'>(</span> <span class='varid'>a_preserve_comment</span><span class='layout'>,</span> <span class='varid'>v_0</span> <span class='layout'>)</span>
<a name="line-206"></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-207"></a> <span class='layout'>,</span> <span class='layout'>(</span> <span class='varid'>a_parse_by_mimetype</span><span class='layout'>,</span> <span class='varid'>v_0</span> <span class='layout'>)</span>
<a name="line-208"></a> <span class='layout'>,</span> <span class='layout'>(</span> <span class='varid'>a_ignore_encoding_errors</span><span class='layout'>,</span> <span class='varid'>v_0</span> <span class='layout'>)</span>
<a name="line-209"></a> <span class='layout'>,</span> <span class='layout'>(</span> <span class='varid'>a_ignore_none_xml_contents</span><span class='layout'>,</span> <span class='varid'>v_0</span> <span class='layout'>)</span>
<a name="line-210"></a> <span class='keyglyph'>]</span>
<a name="line-211"></a>
<a name="line-212"></a> <span class='varid'>traceLevel</span>
<a name="line-213"></a> <span class='keyglyph'>=</span> <span class='varid'>maybe</span> <span class='varid'>this</span> <span class='layout'>(</span><span class='varid'>setTraceLevel</span> <span class='varop'>.</span> <span class='varid'>read</span><span class='layout'>)</span> <span class='varop'>.</span> <span class='varid'>lookup</span> <span class='varid'>a_trace</span> <span class='varop'>$</span> <span class='varid'>options</span>
<a name="line-214"></a>
<a name="line-215"></a> <span class='varid'>addInputOptionsToSystemState</span>
<a name="line-216"></a> <span class='keyglyph'>=</span> <span class='varid'>addSysOptions</span> <span class='varid'>options</span>
<a name="line-217"></a> <span class='varop'>>>></span>
<a name="line-218"></a> <span class='varid'>loadMineTypes</span> <span class='layout'>(</span><span class='varid'>lookup1</span> <span class='varid'>a_mime_types</span> <span class='varid'>userOptions</span><span class='layout'>)</span>
<a name="line-219"></a> <span class='keyword'>where</span>
<a name="line-220"></a> <span class='varid'>addSysOptions</span>
<a name="line-221"></a> <span class='keyglyph'>=</span> <span class='varid'>seqA</span> <span class='varop'>.</span> <span class='varid'>map</span> <span class='layout'>(</span><span class='varid'>uncurry</span> <span class='varid'>setParamString</span><span class='layout'>)</span>
<a name="line-222"></a> <span class='varid'>loadMineTypes</span> <span class='str'>""</span> <span class='keyglyph'>=</span> <span class='varid'>this</span>
<a name="line-223"></a> <span class='varid'>loadMineTypes</span> <span class='varid'>f</span> <span class='keyglyph'>=</span> <span class='varid'>setMimeTypeTableFromFile</span> <span class='varid'>f</span>
<a name="line-224"></a>
<a name="line-225"></a> <span class='varid'>getMimeType</span>
<a name="line-226"></a> <span class='keyglyph'>=</span> <span class='varid'>getAttrValue</span> <span class='varid'>transferMimeType</span> <span class='varop'>>>^</span> <span class='varid'>map</span> <span class='varid'>toLower</span>
<a name="line-227"></a>
<a name="line-228"></a> <span class='varid'>processDoc</span> <span class='varid'>mimeType</span>
<a name="line-229"></a> <span class='keyglyph'>=</span> <span class='varid'>traceMsg</span> <span class='num'>1</span> <span class='layout'>(</span><span class='str'>"readDocument: "</span> <span class='varop'>++</span> <span class='varid'>show</span> <span class='varid'>src</span> <span class='varop'>++</span> <span class='str'>" (mime type: "</span> <span class='varop'>++</span> <span class='varid'>show</span> <span class='varid'>mimeType</span> <span class='varop'>++</span> <span class='str'>") will be processed"</span><span class='layout'>)</span>
<a name="line-230"></a> <span class='varop'>>>></span>
<a name="line-231"></a> <span class='varid'>parse</span>
<a name="line-232"></a> <span class='varop'>>>></span>
<a name="line-233"></a> <span class='layout'>(</span> <span class='keyword'>if</span> <span class='varid'>isXmlOrHtml</span>
<a name="line-234"></a> <span class='keyword'>then</span> <span class='layout'>(</span> <span class='varid'>checknamespaces</span>
<a name="line-235"></a> <span class='varop'>>>></span>
<a name="line-236"></a> <span class='varid'>canonicalize</span>
<a name="line-237"></a> <span class='varop'>>>></span>
<a name="line-238"></a> <span class='varid'>whitespace</span>
<a name="line-239"></a> <span class='varop'>>>></span>
<a name="line-240"></a> <span class='varid'>relax</span>
<a name="line-241"></a> <span class='layout'>)</span>
<a name="line-242"></a> <span class='keyword'>else</span> <span class='varid'>this</span>
<a name="line-243"></a> <span class='layout'>)</span>
<a name="line-244"></a> <span class='keyword'>where</span>
<a name="line-245"></a> <span class='varid'>parse</span>
<a name="line-246"></a> <span class='keyglyph'>|</span> <span class='varid'>isHtml</span>
<a name="line-247"></a> <span class='varop'>||</span>
<a name="line-248"></a> <span class='varid'>withTagSoup</span> <span class='keyglyph'>=</span> <span class='varid'>parseHtmlDocument</span> <span class='comment'>-- parse as HTML or with tagsoup XML</span>
<a name="line-249"></a> <span class='varid'>withTagSoup</span>
<a name="line-250"></a> <span class='varid'>withNamespaces</span>
<a name="line-251"></a> <span class='varid'>issueW</span>
<a name="line-252"></a> <span class='layout'>(</span><span class='varid'>not</span> <span class='layout'>(</span><span class='varid'>hasOption</span> <span class='varid'>a_canonicalize</span><span class='layout'>)</span> <span class='varop'>&&</span> <span class='varid'>preserveCmt</span><span class='layout'>)</span>
<a name="line-253"></a> <span class='varid'>removeWS</span>
<a name="line-254"></a> <span class='varid'>isHtml</span>
<a name="line-255"></a> <span class='keyglyph'>|</span> <span class='varid'>validateWithRelax</span> <span class='keyglyph'>=</span> <span class='varid'>parseXmlDocument</span> <span class='conid'>False</span> <span class='comment'>-- for Relax NG use XML parser without validation</span>
<a name="line-256"></a> <span class='keyglyph'>|</span> <span class='varid'>isXml</span> <span class='keyglyph'>=</span> <span class='varid'>parseXmlDocument</span> <span class='varid'>validate</span> <span class='comment'>-- parse as XML</span>
<a name="line-257"></a> <span class='keyglyph'>|</span> <span class='varid'>removeNoneXml</span> <span class='keyglyph'>=</span> <span class='varid'>replaceChildren</span> <span class='varid'>none</span> <span class='comment'>-- don't parse, if mime type is not XML nore HTML</span>
<a name="line-258"></a> <span class='keyglyph'>|</span> <span class='varid'>otherwise</span> <span class='keyglyph'>=</span> <span class='varid'>this</span> <span class='comment'>-- but remove contents when option is set</span>
<a name="line-259"></a> <span class='varid'>checknamespaces</span>
<a name="line-260"></a> <span class='keyglyph'>|</span> <span class='layout'>(</span><span class='varid'>withNamespaces</span> <span class='varop'>&&</span> <span class='varid'>not</span> <span class='varid'>withTagSoup</span><span class='layout'>)</span>
<a name="line-261"></a> <span class='varop'>||</span>
<a name="line-262"></a> <span class='varid'>validateWithRelax</span> <span class='keyglyph'>=</span> <span class='varid'>propagateAndValidateNamespaces</span>
<a name="line-263"></a> <span class='keyglyph'>|</span> <span class='varid'>otherwise</span> <span class='keyglyph'>=</span> <span class='varid'>this</span>
<a name="line-264"></a> <span class='varid'>canonicalize</span>
<a name="line-265"></a> <span class='keyglyph'>|</span> <span class='varid'>withTagSoup</span> <span class='keyglyph'>=</span> <span class='varid'>this</span> <span class='comment'>-- tagsoup already removes redundant struff</span>
<a name="line-266"></a> <span class='keyglyph'>|</span> <span class='varid'>validateWithRelax</span> <span class='keyglyph'>=</span> <span class='varid'>canonicalizeAllNodes</span>
<a name="line-267"></a> <span class='keyglyph'>|</span> <span class='varid'>hasOption</span> <span class='varid'>a_canonicalize</span>
<a name="line-268"></a> <span class='varop'>&&</span>
<a name="line-269"></a> <span class='varid'>preserveCmt</span> <span class='keyglyph'>=</span> <span class='varid'>canonicalizeForXPath</span>
<a name="line-270"></a> <span class='keyglyph'>|</span> <span class='varid'>hasOption</span> <span class='varid'>a_canonicalize</span> <span class='keyglyph'>=</span> <span class='varid'>canonicalizeAllNodes</span>
<a name="line-271"></a> <span class='keyglyph'>|</span> <span class='varid'>otherwise</span> <span class='keyglyph'>=</span> <span class='varid'>this</span>
<a name="line-272"></a> <span class='varid'>relax</span>
<a name="line-273"></a> <span class='keyglyph'>|</span> <span class='varid'>validateWithRelax</span> <span class='keyglyph'>=</span> <span class='varid'>validateDocumentWithRelaxSchema</span> <span class='varid'>options</span> <span class='varid'>relaxSchema</span>
<a name="line-274"></a> <span class='keyglyph'>|</span> <span class='varid'>otherwise</span> <span class='keyglyph'>=</span> <span class='varid'>this</span>
<a name="line-275"></a> <span class='varid'>whitespace</span>
<a name="line-276"></a> <span class='keyglyph'>|</span> <span class='varid'>removeWS</span>
<a name="line-277"></a> <span class='varop'>&&</span>
<a name="line-278"></a> <span class='varid'>not</span> <span class='varid'>withTagSoup</span> <span class='keyglyph'>=</span> <span class='varid'>removeDocWhiteSpace</span> <span class='comment'>-- tagsoup already removes whitespace</span>
<a name="line-279"></a> <span class='keyglyph'>|</span> <span class='varid'>otherwise</span> <span class='keyglyph'>=</span> <span class='varid'>this</span>
<a name="line-280"></a> <span class='varid'>validateWithRelax</span> <span class='keyglyph'>=</span> <span class='varid'>hasEntry</span> <span class='varid'>a_relax_schema</span> <span class='varid'>options</span>
<a name="line-281"></a> <span class='varid'>relaxSchema</span> <span class='keyglyph'>=</span> <span class='varid'>lookup1</span> <span class='varid'>a_relax_schema</span> <span class='varid'>options</span>
<a name="line-282"></a> <span class='varid'>parseHtml</span> <span class='keyglyph'>=</span> <span class='varid'>hasOption</span> <span class='varid'>a_parse_html</span>
<a name="line-283"></a> <span class='varid'>isHtml</span> <span class='keyglyph'>=</span> <span class='varid'>parseHtml</span> <span class='comment'>-- force HTML</span>
<a name="line-284"></a> <span class='varop'>||</span>
<a name="line-285"></a> <span class='layout'>(</span> <span class='varid'>parseByMimeType</span> <span class='varop'>&&</span> <span class='varid'>isHtmlMimeType</span> <span class='varid'>mimeType</span> <span class='layout'>)</span>
<a name="line-286"></a> <span class='varid'>isXml</span> <span class='keyglyph'>=</span> <span class='layout'>(</span> <span class='varid'>not</span> <span class='varid'>parseByMimeType</span> <span class='varop'>&&</span> <span class='varid'>not</span> <span class='varid'>parseHtml</span> <span class='layout'>)</span>
<a name="line-287"></a> <span class='varop'>||</span>
<a name="line-288"></a> <span class='layout'>(</span> <span class='varid'>parseByMimeType</span>
<a name="line-289"></a> <span class='varop'>&&</span>
<a name="line-290"></a> <span class='layout'>(</span> <span class='varid'>isXmlMimeType</span> <span class='varid'>mimeType</span>
<a name="line-291"></a> <span class='varop'>||</span>
<a name="line-292"></a> <span class='varid'>null</span> <span class='varid'>mimeType</span>
<a name="line-293"></a> <span class='layout'>)</span> <span class='comment'>-- mime type is XML or not known</span>
<a name="line-294"></a> <span class='layout'>)</span>
<a name="line-295"></a> <span class='varid'>isXmlOrHtml</span> <span class='keyglyph'>=</span> <span class='varid'>isHtml</span> <span class='varop'>||</span> <span class='varid'>isXml</span>
<a name="line-296"></a> <span class='varid'>parseByMimeType</span> <span class='keyglyph'>=</span> <span class='varid'>hasOption</span> <span class='varid'>a_parse_by_mimetype</span>
<a name="line-297"></a> <span class='varid'>validate</span> <span class='keyglyph'>=</span> <span class='varid'>hasOption</span> <span class='varid'>a_validate</span>
<a name="line-298"></a> <span class='varid'>withNamespaces</span> <span class='keyglyph'>=</span> <span class='varid'>hasOption</span> <span class='varid'>a_check_namespaces</span>
<a name="line-299"></a> <span class='varid'>withTagSoup</span> <span class='keyglyph'>=</span> <span class='varid'>hasOption</span> <span class='varid'>a_tagsoup</span>
<a name="line-300"></a> <span class='varid'>issueW</span> <span class='keyglyph'>=</span> <span class='varid'>hasOption</span> <span class='varid'>a_issue_warnings</span>
<a name="line-301"></a> <span class='varid'>removeWS</span> <span class='keyglyph'>=</span> <span class='varid'>hasOption</span> <span class='varid'>a_remove_whitespace</span>
<a name="line-302"></a> <span class='varid'>preserveCmt</span> <span class='keyglyph'>=</span> <span class='varid'>hasOption</span> <span class='varid'>a_preserve_comment</span>
<a name="line-303"></a> <span class='varid'>removeNoneXml</span> <span class='keyglyph'>=</span> <span class='varid'>hasOption</span> <span class='varid'>a_ignore_none_xml_contents</span>
<a name="line-304"></a> <span class='varid'>hasOption</span> <span class='varid'>n</span> <span class='keyglyph'>=</span> <span class='varid'>optionIsSet</span> <span class='varid'>n</span> <span class='varid'>options</span>
<a name="line-305"></a>
<a name="line-306"></a><span class='comment'>-- ------------------------------------------------------------</span>
<a name="line-307"></a>
<a name="line-308"></a><span class='comment'>-- |</span>
<a name="line-309"></a><span class='comment'>-- the arrow version of 'readDocument', the arrow input is the source URI</span>
<a name="line-310"></a>
<a name="line-311"></a><a name="readFromDocument"></a><span class='definition'>readFromDocument</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'>String</span> <span class='conid'>XmlTree</span>
<a name="line-312"></a><span class='definition'>readFromDocument</span> <span class='varid'>userOptions</span>
<a name="line-313"></a> <span class='keyglyph'>=</span> <span class='varid'>applyA</span> <span class='layout'>(</span> <span class='varid'>arr</span> <span class='varop'>$</span> <span class='keyglyph'>\</span> <span class='varid'>s</span> <span class='keyglyph'>-></span> <span class='varid'>readDocument</span> <span class='varid'>userOptions</span> <span class='varid'>s</span> <span class='layout'>)</span>
<a name="line-314"></a>
<a name="line-315"></a><span class='comment'>-- ------------------------------------------------------------</span>
<a name="line-316"></a>
<a name="line-317"></a><span class='comment'>-- |</span>
<a name="line-318"></a><span class='comment'>-- read a document that is stored in a normal Haskell String</span>
<a name="line-319"></a><span class='comment'>--</span>
<a name="line-320"></a><span class='comment'>-- the same function as readDocument, but the parameter forms the input.</span>
<a name="line-321"></a><span class='comment'>-- All options available for 'readDocument' are applicable for readString.</span>
<a name="line-322"></a><span class='comment'>--</span>
<a name="line-323"></a><span class='comment'>-- Default encoding: No encoding is done, the String argument is taken as Unicode string</span>
<a name="line-324"></a>
<a name="line-325"></a><a name="readString"></a><span class='definition'>readString</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='varid'>b</span> <span class='conid'>XmlTree</span>
<a name="line-326"></a><span class='definition'>readString</span> <span class='varid'>userOptions</span> <span class='varid'>content</span>
<a name="line-327"></a> <span class='keyglyph'>=</span> <span class='varid'>readDocument</span> <span class='layout'>(</span> <span class='layout'>(</span><span class='varid'>a_encoding</span><span class='layout'>,</span> <span class='varid'>unicodeString</span><span class='layout'>)</span> <span class='conop'>:</span> <span class='varid'>userOptions</span> <span class='layout'>)</span> <span class='layout'>(</span><span class='varid'>stringProtocol</span> <span class='varop'>++</span> <span class='varid'>content</span><span class='layout'>)</span>
<a name="line-328"></a>
<a name="line-329"></a><span class='comment'>-- ------------------------------------------------------------</span>
<a name="line-330"></a>
<a name="line-331"></a><span class='comment'>-- |</span>
<a name="line-332"></a><span class='comment'>-- the arrow version of 'readString', the arrow input is the source URI</span>
<a name="line-333"></a>
<a name="line-334"></a><a name="readFromString"></a><span class='definition'>readFromString</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'>String</span> <span class='conid'>XmlTree</span>
<a name="line-335"></a><span class='definition'>readFromString</span> <span class='varid'>userOptions</span>
<a name="line-336"></a> <span class='keyglyph'>=</span> <span class='varid'>applyA</span> <span class='layout'>(</span> <span class='varid'>arr</span> <span class='varop'>$</span> <span class='keyglyph'>\</span> <span class='varid'>s</span> <span class='keyglyph'>-></span> <span class='varid'>readString</span> <span class='varid'>userOptions</span> <span class='varid'>s</span> <span class='layout'>)</span>
<a name="line-337"></a>
<a name="line-338"></a><span class='comment'>-- ------------------------------------------------------------</span>
<a name="line-339"></a>
<a name="line-340"></a><span class='comment'>-- |</span>
<a name="line-341"></a><span class='comment'>-- parse a string as HTML content, substitute all HTML entity refs and canonicalize tree</span>
<a name="line-342"></a><span class='comment'>-- (substitute char refs, ...). Errors are ignored.</span>
<a name="line-343"></a><span class='comment'>-- </span>
<a name="line-344"></a><span class='comment'>-- A simpler version of 'readFromString' but with less functionality.</span>
<a name="line-345"></a><span class='comment'>-- Does not run in the IO monad</span>
<a name="line-346"></a>
<a name="line-347"></a><a name="hread"></a><span class='definition'>hread</span> <span class='keyglyph'>::</span> <span class='conid'>ArrowXml</span> <span class='varid'>a</span> <span class='keyglyph'>=></span> <span class='varid'>a</span> <span class='conid'>String</span> <span class='conid'>XmlTree</span>
<a name="line-348"></a><span class='definition'>hread</span>
<a name="line-349"></a> <span class='keyglyph'>=</span> <span class='varid'>parseHtmlContent</span>
<a name="line-350"></a> <span class='varop'>>>></span>
<a name="line-351"></a> <span class='varid'>substHtmlEntityRefs</span>
<a name="line-352"></a> <span class='varop'>>>></span>
<a name="line-353"></a> <span class='varid'>processTopDown</span> <span class='layout'>(</span> <span class='varid'>none</span> <span class='varop'>`when`</span> <span class='varid'>isError</span> <span class='layout'>)</span>
<a name="line-354"></a> <span class='varop'>>>></span>
<a name="line-355"></a> <span class='varid'>canonicalizeContents</span>
<a name="line-356"></a>
<a name="line-357"></a><span class='comment'>-- |</span>
<a name="line-358"></a><span class='comment'>-- parse a string as XML content, substitute all predefined XML entity refs and canonicalize tree</span>
<a name="line-359"></a><span class='comment'>-- (substitute char refs, ...)</span>
<a name="line-360"></a>
<a name="line-361"></a><a name="xread"></a><span class='definition'>xread</span> <span class='keyglyph'>::</span> <span class='conid'>ArrowXml</span> <span class='varid'>a</span> <span class='keyglyph'>=></span> <span class='varid'>a</span> <span class='conid'>String</span> <span class='conid'>XmlTree</span>
<a name="line-362"></a><span class='definition'>xread</span>
<a name="line-363"></a> <span class='keyglyph'>=</span> <span class='varid'>parseXmlContent</span>
<a name="line-364"></a> <span class='varop'>>>></span>
<a name="line-365"></a> <span class='varid'>substXmlEntityRefs</span>
<a name="line-366"></a> <span class='varop'>>>></span>
<a name="line-367"></a> <span class='varid'>canonicalizeContents</span>
<a name="line-368"></a>
<a name="line-369"></a><span class='comment'>-- ------------------------------------------------------------</span>
<a name="line-370"></a>
</pre></body>
</html>