hxt-8.0.0: doc/hdoc/src/Text-XML-HXT-RelaxNG-DataTypeLibraries.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'>-- | This modul exports the list of supported datatype libraries.</span>
<a name="line-2"></a><span class='comment'>-- It also exports the main functions to validate an XML instance value</span>
<a name="line-3"></a><span class='comment'>-- with respect to a datatype.</span>
<a name="line-4"></a>
<a name="line-5"></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'>RelaxNG</span><span class='varop'>.</span><span class='conid'>DataTypeLibraries</span>
<a name="line-6"></a> <span class='layout'>(</span> <span class='varid'>datatypeLibraries</span>
<a name="line-7"></a> <span class='layout'>,</span> <span class='varid'>datatypeEqual</span>
<a name="line-8"></a> <span class='layout'>,</span> <span class='varid'>datatypeAllows</span>
<a name="line-9"></a> <span class='layout'>)</span>
<a name="line-10"></a><span class='keyword'>where</span>
<a name="line-11"></a>
<a name="line-12"></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-13"></a> <span class='layout'>(</span> <span class='varid'>relaxNamespace</span>
<a name="line-14"></a> <span class='layout'>)</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'>RelaxNG</span><span class='varop'>.</span><span class='conid'>DataTypeLibUtils</span>
<a name="line-17"></a>
<a name="line-18"></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'>DataTypeLibMysql</span>
<a name="line-19"></a> <span class='layout'>(</span> <span class='varid'>mysqlDatatypeLib</span> <span class='layout'>)</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'>RelaxNG</span><span class='varop'>.</span><span class='conid'>XmlSchema</span><span class='varop'>.</span><span class='conid'>DataTypeLibW3C</span>
<a name="line-22"></a> <span class='layout'>(</span> <span class='varid'>w3cDatatypeLib</span> <span class='layout'>)</span>
<a name="line-23"></a>
<a name="line-24"></a><span class='keyword'>import</span> <span class='conid'>Data</span><span class='varop'>.</span><span class='conid'>Maybe</span>
<a name="line-25"></a> <span class='layout'>(</span> <span class='varid'>fromJust</span> <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>
<a name="line-30"></a><span class='comment'>-- | List of all supported datatype libraries which can be </span>
<a name="line-31"></a><span class='comment'>-- used within the Relax NG validator modul.</span>
<a name="line-32"></a>
<a name="line-33"></a><a name="datatypeLibraries"></a><span class='definition'>datatypeLibraries</span> <span class='keyglyph'>::</span> <span class='conid'>DatatypeLibraries</span>
<a name="line-34"></a><span class='definition'>datatypeLibraries</span>
<a name="line-35"></a> <span class='keyglyph'>=</span> <span class='keyglyph'>[</span> <span class='varid'>relaxDatatypeLib</span>
<a name="line-36"></a> <span class='layout'>,</span> <span class='varid'>relaxDatatypeLib'</span>
<a name="line-37"></a> <span class='layout'>,</span> <span class='varid'>mysqlDatatypeLib</span>
<a name="line-38"></a> <span class='layout'>,</span> <span class='varid'>w3cDatatypeLib</span>
<a name="line-39"></a> <span class='keyglyph'>]</span>
<a name="line-40"></a>
<a name="line-41"></a>
<a name="line-42"></a><span class='comment'>{- |
<a name="line-43"></a>Tests whether a XML instance value matches a value-pattern.
<a name="line-44"></a>
<a name="line-45"></a>The following tests are performed:
<a name="line-46"></a>
<a name="line-47"></a> * 1. : does the uri exist in the list of supported datatype libraries
<a name="line-48"></a>
<a name="line-49"></a> - 2. : does the library support the datatype
<a name="line-50"></a>
<a name="line-51"></a> - 3. : does the XML instance value match the value-pattern
<a name="line-52"></a>
<a name="line-53"></a>The hard work is done by the specialized 'DatatypeEqual' function
<a name="line-54"></a>(see also: 'DatatypeCheck') of the datatype library.
<a name="line-55"></a>-}</span>
<a name="line-56"></a>
<a name="line-57"></a><a name="datatypeEqual"></a><span class='definition'>datatypeEqual</span> <span class='keyglyph'>::</span> <span class='conid'>Uri</span> <span class='keyglyph'>-></span> <span class='conid'>DatatypeEqual</span>
<a name="line-58"></a><span class='definition'>datatypeEqual</span> <span class='varid'>uri</span> <span class='varid'>d</span> <span class='varid'>s1</span> <span class='varid'>c1</span> <span class='varid'>s2</span> <span class='varid'>c2</span>
<a name="line-59"></a> <span class='keyglyph'>=</span> <span class='keyword'>if</span> <span class='varid'>elem</span> <span class='varid'>uri</span> <span class='layout'>(</span><span class='varid'>map</span> <span class='varid'>fst</span> <span class='varid'>datatypeLibraries</span><span class='layout'>)</span>
<a name="line-60"></a> <span class='keyword'>then</span> <span class='varid'>dtEqFct</span> <span class='varid'>d</span> <span class='varid'>s1</span> <span class='varid'>c1</span> <span class='varid'>s2</span> <span class='varid'>c2</span>
<a name="line-61"></a> <span class='keyword'>else</span> <span class='conid'>Just</span> <span class='layout'>(</span> <span class='str'>"Unknown DatatypeLibrary "</span> <span class='varop'>++</span> <span class='varid'>show</span> <span class='varid'>uri</span> <span class='layout'>)</span>
<a name="line-62"></a> <span class='keyword'>where</span>
<a name="line-63"></a> <span class='conid'>DTC</span> <span class='keyword'>_</span> <span class='varid'>dtEqFct</span> <span class='keyword'>_</span> <span class='keyglyph'>=</span> <span class='varid'>fromJust</span> <span class='varop'>$</span> <span class='varid'>lookup</span> <span class='varid'>uri</span> <span class='varid'>datatypeLibraries</span>
<a name="line-64"></a>
<a name="line-65"></a><span class='comment'>{- |
<a name="line-66"></a>Tests whether a XML instance value matches a data-pattern.
<a name="line-67"></a>
<a name="line-68"></a>The following tests are performed:
<a name="line-69"></a>
<a name="line-70"></a> * 1. : does the uri exist in the list of supported datatype libraries
<a name="line-71"></a>
<a name="line-72"></a> - 2. : does the library support the datatype
<a name="line-73"></a>
<a name="line-74"></a> - 3. : does the XML instance value match the data-pattern
<a name="line-75"></a>
<a name="line-76"></a> - 4. : does the XML instance value match all params
<a name="line-77"></a>
<a name="line-78"></a>The hard work is done by the specialized 'DatatypeAllows' function
<a name="line-79"></a>(see also: 'DatatypeCheck') of the datatype library.
<a name="line-80"></a>
<a name="line-81"></a>-}</span>
<a name="line-82"></a>
<a name="line-83"></a><a name="datatypeAllows"></a><span class='definition'>datatypeAllows</span> <span class='keyglyph'>::</span> <span class='conid'>Uri</span> <span class='keyglyph'>-></span> <span class='conid'>DatatypeAllows</span>
<a name="line-84"></a><span class='definition'>datatypeAllows</span> <span class='varid'>uri</span> <span class='varid'>d</span> <span class='varid'>params</span> <span class='varid'>s1</span> <span class='varid'>c1</span>
<a name="line-85"></a> <span class='keyglyph'>=</span> <span class='keyword'>if</span> <span class='varid'>elem</span> <span class='varid'>uri</span> <span class='layout'>(</span><span class='varid'>map</span> <span class='varid'>fst</span> <span class='varid'>datatypeLibraries</span><span class='layout'>)</span>
<a name="line-86"></a> <span class='keyword'>then</span> <span class='varid'>dtAllowFct</span> <span class='varid'>d</span> <span class='varid'>params</span> <span class='varid'>s1</span> <span class='varid'>c1</span>
<a name="line-87"></a> <span class='keyword'>else</span> <span class='conid'>Just</span> <span class='layout'>(</span> <span class='str'>"Unknown DatatypeLibrary "</span> <span class='varop'>++</span> <span class='varid'>show</span> <span class='varid'>uri</span> <span class='layout'>)</span>
<a name="line-88"></a> <span class='keyword'>where</span>
<a name="line-89"></a> <span class='conid'>DTC</span> <span class='varid'>dtAllowFct</span> <span class='keyword'>_</span> <span class='keyword'>_</span> <span class='keyglyph'>=</span> <span class='varid'>fromJust</span> <span class='varop'>$</span> <span class='varid'>lookup</span> <span class='varid'>uri</span> <span class='varid'>datatypeLibraries</span>
<a name="line-90"></a>
<a name="line-91"></a>
<a name="line-92"></a><span class='comment'>-- -------------------------------------------------------------------------------------- </span>
<a name="line-93"></a><span class='comment'>-- Relax NG build in datatype library</span>
<a name="line-94"></a>
<a name="line-95"></a><a name="relaxDatatypeLib"></a><span class='definition'>relaxDatatypeLib</span> <span class='keyglyph'>::</span> <span class='conid'>DatatypeLibrary</span>
<a name="line-96"></a><span class='definition'>relaxDatatypeLib</span> <span class='keyglyph'>=</span> <span class='layout'>(</span><span class='varid'>relaxNamespace</span><span class='layout'>,</span> <span class='conid'>DTC</span> <span class='varid'>datatypeAllowsRelax</span> <span class='varid'>datatypeEqualRelax</span> <span class='varid'>relaxDatatypes</span><span class='layout'>)</span>
<a name="line-97"></a>
<a name="line-98"></a><a name="relaxDatatypeLib'"></a><span class='comment'>-- | if there is no datatype uri, the built in datatype library is used</span>
<a name="line-99"></a><span class='definition'>relaxDatatypeLib'</span> <span class='keyglyph'>::</span> <span class='conid'>DatatypeLibrary</span>
<a name="line-100"></a><span class='definition'>relaxDatatypeLib'</span> <span class='keyglyph'>=</span> <span class='layout'>(</span><span class='str'>""</span><span class='layout'>,</span> <span class='conid'>DTC</span> <span class='varid'>datatypeAllowsRelax</span> <span class='varid'>datatypeEqualRelax</span> <span class='varid'>relaxDatatypes</span><span class='layout'>)</span>
<a name="line-101"></a>
<a name="line-102"></a><span class='comment'>-- | The build in Relax NG datatype lib supportes only the token and string datatype,</span>
<a name="line-103"></a><span class='comment'>-- without any params.</span>
<a name="line-104"></a>
<a name="line-105"></a><a name="relaxDatatypes"></a><span class='definition'>relaxDatatypes</span> <span class='keyglyph'>::</span> <span class='conid'>AllowedDatatypes</span>
<a name="line-106"></a><span class='definition'>relaxDatatypes</span>
<a name="line-107"></a> <span class='keyglyph'>=</span> <span class='varid'>map</span> <span class='layout'>(</span> <span class='layout'>(</span><span class='keyglyph'>\</span> <span class='varid'>x</span> <span class='keyglyph'>-></span> <span class='layout'>(</span><span class='varid'>x</span><span class='layout'>,</span> <span class='conid'>[]</span><span class='layout'>)</span><span class='layout'>)</span> <span class='varop'>.</span> <span class='varid'>fst</span> <span class='layout'>)</span> <span class='varid'>relaxDatatypeTable</span>
<a name="line-108"></a>
<a name="line-109"></a><a name="datatypeAllowsRelax"></a><span class='definition'>datatypeAllowsRelax</span> <span class='keyglyph'>::</span> <span class='conid'>DatatypeAllows</span>
<a name="line-110"></a><span class='definition'>datatypeAllowsRelax</span> <span class='varid'>d</span> <span class='varid'>p</span> <span class='varid'>v</span> <span class='keyword'>_</span>
<a name="line-111"></a> <span class='keyglyph'>=</span> <span class='varid'>maybe</span> <span class='varid'>notAllowed'</span> <span class='varid'>allowed</span> <span class='varop'>.</span> <span class='varid'>lookup</span> <span class='varid'>d</span> <span class='varop'>$</span> <span class='varid'>relaxDatatypeTable</span>
<a name="line-112"></a> <span class='keyword'>where</span>
<a name="line-113"></a> <span class='varid'>notAllowed'</span>
<a name="line-114"></a> <span class='keyglyph'>=</span> <span class='conid'>Just</span> <span class='varop'>$</span> <span class='varid'>errorMsgDataTypeNotAllowed</span> <span class='varid'>relaxNamespace</span> <span class='varid'>d</span> <span class='varid'>p</span> <span class='varid'>v</span>
<a name="line-115"></a> <span class='varid'>allowed</span> <span class='keyword'>_</span>
<a name="line-116"></a> <span class='keyglyph'>=</span> <span class='conid'>Nothing</span>
<a name="line-117"></a>
<a name="line-118"></a><span class='comment'>-- | If the token datatype is used, the values have to be normalized</span>
<a name="line-119"></a><span class='comment'>-- (trailing and leading whitespaces are removed).</span>
<a name="line-120"></a><span class='comment'>-- token does not perform any changes to the values.</span>
<a name="line-121"></a>
<a name="line-122"></a><a name="datatypeEqualRelax"></a><span class='definition'>datatypeEqualRelax</span> <span class='keyglyph'>::</span> <span class='conid'>DatatypeEqual</span>
<a name="line-123"></a><span class='definition'>datatypeEqualRelax</span> <span class='varid'>d</span> <span class='varid'>s1</span> <span class='keyword'>_</span> <span class='varid'>s2</span> <span class='keyword'>_</span>
<a name="line-124"></a> <span class='keyglyph'>=</span> <span class='varid'>maybe</span> <span class='varid'>notAllowed'</span> <span class='varid'>checkValues</span> <span class='varop'>.</span> <span class='varid'>lookup</span> <span class='varid'>d</span> <span class='varop'>$</span> <span class='varid'>relaxDatatypeTable</span>
<a name="line-125"></a> <span class='keyword'>where</span>
<a name="line-126"></a> <span class='varid'>notAllowed'</span>
<a name="line-127"></a> <span class='keyglyph'>=</span> <span class='conid'>Just</span> <span class='varop'>$</span> <span class='varid'>errorMsgDataTypeNotAllowed2</span> <span class='varid'>relaxNamespace</span> <span class='varid'>d</span> <span class='varid'>s1</span> <span class='varid'>s2</span>
<a name="line-128"></a> <span class='varid'>checkValues</span> <span class='varid'>predicate</span>
<a name="line-129"></a> <span class='keyglyph'>=</span> <span class='keyword'>if</span> <span class='varid'>predicate</span> <span class='varid'>s1</span> <span class='varid'>s2</span>
<a name="line-130"></a> <span class='keyword'>then</span> <span class='conid'>Nothing</span>
<a name="line-131"></a> <span class='keyword'>else</span> <span class='conid'>Just</span> <span class='varop'>$</span> <span class='varid'>errorMsgEqual</span> <span class='varid'>d</span> <span class='varid'>s1</span> <span class='varid'>s2</span>
<a name="line-132"></a>
<a name="line-133"></a><a name="relaxDatatypeTable"></a><span class='definition'>relaxDatatypeTable</span> <span class='keyglyph'>::</span> <span class='keyglyph'>[</span><span class='layout'>(</span><span class='conid'>String</span><span class='layout'>,</span> <span class='conid'>String</span> <span class='keyglyph'>-></span> <span class='conid'>String</span> <span class='keyglyph'>-></span> <span class='conid'>Bool</span><span class='layout'>)</span><span class='keyglyph'>]</span>
<a name="line-134"></a><span class='definition'>relaxDatatypeTable</span>
<a name="line-135"></a> <span class='keyglyph'>=</span> <span class='keyglyph'>[</span> <span class='layout'>(</span><span class='str'>"string"</span><span class='layout'>,</span> <span class='layout'>(</span><span class='varop'>==</span><span class='layout'>)</span><span class='layout'>)</span>
<a name="line-136"></a> <span class='layout'>,</span> <span class='layout'>(</span><span class='str'>"token"</span><span class='layout'>,</span> <span class='keyglyph'>\</span> <span class='varid'>s1</span> <span class='varid'>s2</span> <span class='keyglyph'>-></span> <span class='varid'>normalizeWhitespace</span> <span class='varid'>s1</span> <span class='varop'>==</span> <span class='varid'>normalizeWhitespace</span> <span class='varid'>s2</span> <span class='layout'>)</span>
<a name="line-137"></a> <span class='keyglyph'>]</span>
<a name="line-138"></a>
<a name="line-139"></a>
<a name="line-140"></a><span class='comment'>-- -------------------------------------------------------------------------------------- </span>
</pre></body>
</html>