hxt-8.0.0: doc/hdoc/src/Text-XML-HXT-Validator-Validation.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><span class='comment'>-- This module provides a state filter as a main function for validating XML documents.</span>
<a name="line-3"></a><span class='comment'>--</span>
<a name="line-4"></a><span class='comment'>-- The real validation is done with pure filters from module 'Text.XML.HXT.Validator.ValidationFilter'</span>
<a name="line-5"></a><span class='comment'>--</span>
<a name="line-6"></a><span class='comment'>-- Author : .\\artin Schmidt</span>
<a name="line-7"></a><span class='comment'>-- Version : $Id: Validation.hs,v 1.2 2004/11/23 15:50:23 hxml Exp $</span>
<a name="line-8"></a>
<a name="line-9"></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'>Validator</span><span class='varop'>.</span><span class='conid'>Validation</span>
<a name="line-10"></a> <span class='layout'>(</span> <span class='varid'>getValidatedDoc</span>
<a name="line-11"></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'>Validator</span><span class='varop'>.</span><span class='conid'>ValidationFilter</span>
<a name="line-12"></a> <span class='layout'>)</span>
<a name="line-13"></a>
<a name="line-14"></a><span class='keyword'>where</span>
<a name="line-15"></a>
<a name="line-16"></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'>XmlTree</span>
<a name="line-17"></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'>XmlState</span>
<a name="line-18"></a>
<a name="line-19"></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'>Validator</span><span class='varop'>.</span><span class='conid'>ValidationFilter</span>
<a name="line-20"></a>
<a name="line-21"></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'>Parser</span><span class='varop'>.</span><span class='conid'>XmlOutput</span>
<a name="line-22"></a> <span class='layout'>(</span> <span class='varid'>traceTree</span>
<a name="line-23"></a> <span class='layout'>,</span> <span class='varid'>traceSource</span>
<a name="line-24"></a> <span class='layout'>,</span> <span class='varid'>traceMsg</span>
<a name="line-25"></a> <span class='layout'>)</span>
<a name="line-26"></a>
<a name="line-27"></a><span class='comment'>-- ------------------------------------------------------------</span>
<a name="line-28"></a>
<a name="line-29"></a><span class='comment'>-- |</span>
<a name="line-30"></a><span class='comment'>-- monadic filter for validating and transforming a wellformed document.</span>
<a name="line-31"></a><span class='comment'>--</span>
<a name="line-32"></a><span class='comment'>-- the "main" function for validation.</span>
<a name="line-33"></a><span class='comment'>--</span>
<a name="line-34"></a><span class='comment'>-- the input tree must consist of a root node with a complete document and DTD.</span>
<a name="line-35"></a><span class='comment'>-- Result is the single element list containing same tree but tranformed with respect to the DTD,</span>
<a name="line-36"></a><span class='comment'>-- or, in case of errors, the root with an empty list of children</span>
<a name="line-37"></a>
<a name="line-38"></a><a name="getValidatedDoc"></a><span class='definition'>getValidatedDoc</span> <span class='keyglyph'>::</span> <span class='conid'>XmlStateFilter</span> <span class='varid'>state</span>
<a name="line-39"></a><span class='definition'>getValidatedDoc</span>
<a name="line-40"></a> <span class='keyglyph'>=</span> <span class='varid'>traceMsg</span> <span class='num'>1</span> <span class='str'>"validating document"</span>
<a name="line-41"></a> <span class='varop'>.>></span>
<a name="line-42"></a> <span class='layout'>(</span> <span class='layout'>(</span> <span class='varid'>runValidation</span>
<a name="line-43"></a> <span class='varop'>.>></span>
<a name="line-44"></a> <span class='varid'>traceTree</span>
<a name="line-45"></a> <span class='varop'>.>></span>
<a name="line-46"></a> <span class='varid'>traceSource</span>
<a name="line-47"></a> <span class='layout'>)</span>
<a name="line-48"></a> <span class='varop'>`whenM`</span> <span class='layout'>(</span><span class='varid'>isRoot</span> <span class='varop'>.></span> <span class='varid'>getChildren</span><span class='layout'>)</span>
<a name="line-49"></a> <span class='layout'>)</span>
<a name="line-50"></a> <span class='keyword'>where</span>
<a name="line-51"></a> <span class='varid'>runValidation</span> <span class='varid'>t</span>
<a name="line-52"></a> <span class='keyglyph'>=</span> <span class='keyword'>do</span>
<a name="line-53"></a> <span class='varid'>issueError</span> <span class='varop'>$$<</span> <span class='varid'>res</span>
<a name="line-54"></a> <span class='layout'>(</span> <span class='keyword'>if</span> <span class='varid'>null</span> <span class='varid'>errs</span>
<a name="line-55"></a> <span class='keyword'>then</span> <span class='layout'>(</span> <span class='varid'>traceMsg</span> <span class='num'>1</span> <span class='str'>"transforming validated document"</span>
<a name="line-56"></a> <span class='varop'>.>></span>
<a name="line-57"></a> <span class='varid'>liftMf</span> <span class='varid'>transform</span>
<a name="line-58"></a> <span class='layout'>)</span>
<a name="line-59"></a> <span class='keyword'>else</span> <span class='varid'>liftMf</span> <span class='layout'>(</span><span class='varid'>setStatus</span> <span class='varid'>c_err</span> <span class='str'>"validating document"</span><span class='layout'>)</span>
<a name="line-60"></a> <span class='layout'>)</span> <span class='varid'>t</span>
<a name="line-61"></a> <span class='keyword'>where</span>
<a name="line-62"></a> <span class='varid'>res</span> <span class='keyglyph'>=</span> <span class='varid'>validate</span> <span class='varid'>t</span>
<a name="line-63"></a> <span class='varid'>errs</span> <span class='keyglyph'>=</span> <span class='varid'>isXError</span> <span class='varop'>.></span> <span class='varid'>neg</span> <span class='varid'>isWarning</span> <span class='varop'>$$</span> <span class='varid'>res</span>
<a name="line-64"></a>
<a name="line-65"></a><span class='comment'>-- ------------------------------------------------------------</span>
</pre></body>
</html>