hxt-8.3.0: doc/hdoc/src/Text-XML-HXT-DOM-XmlOptions.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'>-- Common useful options</span>
<a name="line-3"></a><span class='comment'>--</span>
<a name="line-4"></a><span class='comment'>-- Version : $Id: XmlOptions.hs,v 1.1 2006/11/09 20:27:42 hxml Exp $</span>
<a name="line-5"></a><span class='comment'>--</span>
<a name="line-6"></a><span class='comment'>--</span>
<a name="line-7"></a>
<a name="line-8"></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'>DOM</span><span class='varop'>.</span><span class='conid'>XmlOptions</span>
<a name="line-9"></a> <span class='layout'>(</span> <span class='varid'>inputOptions</span>
<a name="line-10"></a> <span class='layout'>,</span> <span class='varid'>relaxOptions</span>
<a name="line-11"></a> <span class='layout'>,</span> <span class='varid'>outputOptions</span>
<a name="line-12"></a> <span class='layout'>,</span> <span class='varid'>generalOptions</span>
<a name="line-13"></a> <span class='layout'>,</span> <span class='varid'>versionOptions</span>
<a name="line-14"></a> <span class='layout'>,</span> <span class='varid'>showOptions</span>
<a name="line-15"></a>
<a name="line-16"></a> <span class='layout'>,</span> <span class='varid'>selectOptions</span>
<a name="line-17"></a> <span class='layout'>,</span> <span class='varid'>removeOptions</span>
<a name="line-18"></a> <span class='layout'>,</span> <span class='varid'>optionIsSet</span>
<a name="line-19"></a> <span class='layout'>,</span> <span class='varid'>isTrueValue</span>
<a name="line-20"></a> <span class='layout'>)</span>
<a name="line-21"></a><span class='keyword'>where</span>
<a name="line-22"></a>
<a name="line-23"></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'>XmlKeywords</span>
<a name="line-24"></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'>TypeDefs</span>
<a name="line-25"></a>
<a name="line-26"></a><span class='keyword'>import</span> <span class='conid'>Data</span><span class='varop'>.</span><span class='conid'>Maybe</span>
<a name="line-27"></a>
<a name="line-28"></a><span class='keyword'>import</span> <span class='conid'>System</span><span class='varop'>.</span><span class='conid'>Console</span><span class='varop'>.</span><span class='conid'>GetOpt</span>
<a name="line-29"></a>
<a name="line-30"></a><span class='comment'>-- ------------------------------------------------------------</span>
<a name="line-31"></a><span class='comment'>--</span>
<a name="line-32"></a>
<a name="line-33"></a><span class='comment'>-- |</span>
<a name="line-34"></a><span class='comment'>-- commonly useful options for XML input</span>
<a name="line-35"></a><span class='comment'>--</span>
<a name="line-36"></a><span class='comment'>-- can be used for option definition with haskell getopt</span>
<a name="line-37"></a><span class='comment'>--</span>
<a name="line-38"></a><span class='comment'>-- defines options: 'a_trace', 'a_proxy', 'a_use_curl', 'a_do_not_use_curl', 'a_options_curl', 'a_encoding',</span>
<a name="line-39"></a><span class='comment'>-- 'a_issue_errors', 'a_do_not_issue_errors', 'a_parse_html', 'a_parse_by_mimetype', 'a_tagsoup' 'a_issue_warnings', 'a_do_not_issue_warnings',</span>
<a name="line-40"></a><span class='comment'>-- 'a_parse_xml', 'a_validate', 'a_do_not_validate', 'a_canonicalize', 'a_do_not_canonicalize',</span>
<a name="line-41"></a><span class='comment'>--- 'a_preserve_comment', 'a_do_not_preserve_comment', 'a_check_namespaces', 'a_do_not_check_namespaces',</span>
<a name="line-42"></a><span class='comment'>-- 'a_remove_whitespace', 'a_do_not_remove_whitespace'</span>
<a name="line-43"></a>
<a name="line-44"></a><a name="inputOptions"></a><span class='definition'>inputOptions</span> <span class='keyglyph'>::</span> <span class='keyglyph'>[</span><span class='conid'>OptDescr</span> <span class='layout'>(</span><span class='conid'>String</span><span class='layout'>,</span> <span class='conid'>String</span><span class='layout'>)</span><span class='keyglyph'>]</span>
<a name="line-45"></a><span class='definition'>inputOptions</span>
<a name="line-46"></a> <span class='keyglyph'>=</span> <span class='keyglyph'>[</span> <span class='conid'>Option</span> <span class='str'>"t"</span> <span class='keyglyph'>[</span><span class='varid'>a_trace</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>OptArg</span> <span class='varid'>trc</span> <span class='str'>"LEVEL"</span><span class='layout'>)</span> <span class='str'>"trace level (0-4), default 1"</span>
<a name="line-47"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>"p"</span> <span class='keyglyph'>[</span><span class='varid'>a_proxy</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>ReqArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_proxy</span><span class='layout'>)</span> <span class='str'>"PROXY"</span><span class='layout'>)</span> <span class='str'>"proxy for http access (e.g. \"www-cache:3128\")"</span>
<a name="line-48"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>""</span> <span class='keyglyph'>[</span><span class='varid'>a_use_curl</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_use_curl</span> <span class='varid'>v_1</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"obsolete, since hxt-8.1 HTTP access is always done with curl bindings"</span>
<a name="line-49"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>""</span> <span class='keyglyph'>[</span><span class='varid'>a_do_not_use_curl</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_use_curl</span> <span class='varid'>v_0</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"obsolete, since hxt-8.1 HTTP access is always done with curl bindings"</span>
<a name="line-50"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>""</span> <span class='keyglyph'>[</span><span class='varid'>a_options_curl</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>ReqArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_options_curl</span><span class='layout'>)</span> <span class='str'>"STR"</span><span class='layout'>)</span> <span class='str'>"additional curl options, e.g. for timeout, ..."</span>
<a name="line-51"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>""</span> <span class='keyglyph'>[</span><span class='varid'>a_default_baseuri</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>ReqArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>transferURI</span><span class='layout'>)</span> <span class='str'>"URI"</span><span class='layout'>)</span> <span class='str'>"default base URI, default: \"file:///<cwd>/\""</span>
<a name="line-52"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>"e"</span> <span class='keyglyph'>[</span><span class='varid'>a_encoding</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>ReqArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_encoding</span><span class='layout'>)</span> <span class='str'>"CHARSET"</span><span class='layout'>)</span> <span class='layout'>(</span> <span class='str'>"default document encoding ("</span> <span class='varop'>++</span> <span class='varid'>utf8</span> <span class='varop'>++</span> <span class='str'>", "</span> <span class='varop'>++</span> <span class='varid'>isoLatin1</span> <span class='varop'>++</span> <span class='str'>", "</span> <span class='varop'>++</span> <span class='varid'>usAscii</span> <span class='varop'>++</span> <span class='str'>", ...)"</span> <span class='layout'>)</span>
<a name="line-53"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>""</span> <span class='keyglyph'>[</span><span class='varid'>a_mime_types</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>ReqArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_mime_types</span><span class='layout'>)</span> <span class='str'>"FILE"</span><span class='layout'>)</span> <span class='str'>"set mime type configuration file, e.g. \"/etc/mime.types\""</span>
<a name="line-54"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>""</span> <span class='keyglyph'>[</span><span class='varid'>a_issue_errors</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_issue_errors</span> <span class='varid'>v_1</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"issue all errorr messages on stderr (default)"</span>
<a name="line-55"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>""</span> <span class='keyglyph'>[</span><span class='varid'>a_do_not_issue_errors</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_issue_errors</span> <span class='varid'>v_0</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"ignore all error messages"</span>
<a name="line-56"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>""</span> <span class='keyglyph'>[</span><span class='varid'>a_ignore_encoding_errors</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_ignore_encoding_errors</span> <span class='varid'>v_1</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"ignore encoding errors"</span>
<a name="line-57"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>""</span> <span class='keyglyph'>[</span><span class='varid'>a_ignore_none_xml_contents</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_ignore_none_xml_contents</span> <span class='varid'>v_1</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"discards all contents of none XML/HTML documents, only the meta info remains stays in the doc tree"</span>
<a name="line-58"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>"H"</span> <span class='keyglyph'>[</span><span class='varid'>a_parse_html</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_parse_html</span> <span class='varid'>v_1</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"parse input as HTML, try to interprete everything as HTML, no validation"</span>
<a name="line-59"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>"M"</span> <span class='keyglyph'>[</span><span class='varid'>a_parse_by_mimetype</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_parse_by_mimetype</span> <span class='varid'>v_1</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"parse dependent on mime type: text/html as HTML, text/xml and text/xhtml and others as XML, else no parse"</span>
<a name="line-60"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>""</span> <span class='keyglyph'>[</span><span class='varid'>a_parse_xml</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_parse_html</span> <span class='varid'>v_0</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"parse input as XML, (default)"</span>
<a name="line-61"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>""</span> <span class='keyglyph'>[</span><span class='varid'>a_strict_input</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_strict_input</span> <span class='varid'>v_1</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"read input files strictly, this ensures closing the files correctly even if not read completely"</span>
<a name="line-62"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>"T"</span> <span class='keyglyph'>[</span><span class='varid'>a_tagsoup</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_tagsoup</span> <span class='varid'>v_1</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"lasy tagsoup parser, for HTML and XML, no DTD, no validation, no PIs, only XHTML entityrefs"</span>
<a name="line-63"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>""</span> <span class='keyglyph'>[</span><span class='varid'>a_issue_warnings</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_issue_warnings</span> <span class='varid'>v_1</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"issue warnings, when parsing HTML (default)"</span>
<a name="line-64"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>"Q"</span> <span class='keyglyph'>[</span><span class='varid'>a_do_not_issue_warnings</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_issue_warnings</span> <span class='varid'>v_0</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"ignore warnings, when parsing HTML"</span>
<a name="line-65"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>""</span> <span class='keyglyph'>[</span><span class='varid'>a_validate</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_validate</span> <span class='varid'>v_1</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"document validation when parsing XML (default)"</span>
<a name="line-66"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>"w"</span> <span class='keyglyph'>[</span><span class='varid'>a_do_not_validate</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_validate</span> <span class='varid'>v_0</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"only wellformed check, no validation"</span>
<a name="line-67"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>""</span> <span class='keyglyph'>[</span><span class='varid'>a_canonicalize</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_canonicalize</span> <span class='varid'>v_1</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"canonicalize document, remove DTD, comment, transform CDATA, CharRef's, ... (default)"</span>
<a name="line-68"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>"c"</span> <span class='keyglyph'>[</span><span class='varid'>a_do_not_canonicalize</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_canonicalize</span> <span class='varid'>v_0</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"do not canonicalize document, don't remove DTD, comment, don't transform CDATA, CharRef's, ..."</span>
<a name="line-69"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>"C"</span> <span class='keyglyph'>[</span><span class='varid'>a_preserve_comment</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_preserve_comment</span> <span class='varid'>v_1</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"don't remove comments during canonicalisation"</span>
<a name="line-70"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>""</span> <span class='keyglyph'>[</span><span class='varid'>a_do_not_preserve_comment</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_preserve_comment</span> <span class='varid'>v_0</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"remove comments during canonicalisation (default)"</span>
<a name="line-71"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>"n"</span> <span class='keyglyph'>[</span><span class='varid'>a_check_namespaces</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_check_namespaces</span> <span class='varid'>v_1</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"tag tree with namespace information and check namespaces"</span>
<a name="line-72"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>""</span> <span class='keyglyph'>[</span><span class='varid'>a_do_not_check_namespaces</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_check_namespaces</span> <span class='varid'>v_0</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"ignore namespaces (default)"</span>
<a name="line-73"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>"r"</span> <span class='keyglyph'>[</span><span class='varid'>a_remove_whitespace</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_remove_whitespace</span> <span class='varid'>v_1</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"remove redundant whitespace, simplifies tree and processing"</span>
<a name="line-74"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>""</span> <span class='keyglyph'>[</span><span class='varid'>a_do_not_remove_whitespace</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_remove_whitespace</span> <span class='varid'>v_0</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"don't remove redundant whitespace (default)"</span>
<a name="line-75"></a> <span class='keyglyph'>]</span>
<a name="line-76"></a> <span class='keyword'>where</span>
<a name="line-77"></a> <span class='varid'>att</span> <span class='varid'>n</span> <span class='varid'>v</span> <span class='keyglyph'>=</span> <span class='layout'>(</span><span class='varid'>n</span><span class='layout'>,</span> <span class='varid'>v</span><span class='layout'>)</span>
<a name="line-78"></a> <span class='varid'>trc</span> <span class='keyglyph'>=</span> <span class='varid'>att</span> <span class='varid'>a_trace</span> <span class='varop'>.</span> <span class='varid'>show</span> <span class='varop'>.</span> <span class='varid'>max</span> <span class='num'>0</span> <span class='varop'>.</span> <span class='varid'>min</span> <span class='num'>9</span> <span class='varop'>.</span> <span class='layout'>(</span><span class='varid'>read</span> <span class='keyglyph'>::</span> <span class='conid'>String</span> <span class='keyglyph'>-></span> <span class='conid'>Int</span><span class='layout'>)</span> <span class='varop'>.</span> <span class='layout'>(</span><span class='chr'>'0'</span><span class='conop'>:</span><span class='layout'>)</span> <span class='varop'>.</span> <span class='varid'>filter</span> <span class='layout'>(</span><span class='varop'>`elem`</span> <span class='str'>"0123456789"</span><span class='layout'>)</span> <span class='varop'>.</span> <span class='varid'>fromMaybe</span> <span class='varid'>v_1</span>
<a name="line-79"></a>
<a name="line-80"></a>
<a name="line-81"></a><span class='comment'>-- | available Relax NG validation options</span>
<a name="line-82"></a><span class='comment'>--</span>
<a name="line-83"></a><span class='comment'>-- defines options</span>
<a name="line-84"></a><span class='comment'>-- 'a_check_restrictions', 'a_validate_externalRef', 'a_validate_include', 'a_do_not_check_restrictions', </span>
<a name="line-85"></a><span class='comment'>-- 'a_do_not_validate_externalRef', 'a_do_not_validate_include'</span>
<a name="line-86"></a>
<a name="line-87"></a><a name="relaxOptions"></a><span class='definition'>relaxOptions</span> <span class='keyglyph'>::</span> <span class='keyglyph'>[</span><span class='conid'>OptDescr</span> <span class='layout'>(</span><span class='conid'>String</span><span class='layout'>,</span> <span class='conid'>String</span><span class='layout'>)</span><span class='keyglyph'>]</span>
<a name="line-88"></a><span class='definition'>relaxOptions</span>
<a name="line-89"></a> <span class='keyglyph'>=</span> <span class='keyglyph'>[</span> <span class='conid'>Option</span> <span class='str'>"X"</span> <span class='keyglyph'>[</span><span class='varid'>a_relax_schema</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>ReqArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_relax_schema</span><span class='layout'>)</span> <span class='str'>"SCHEMA"</span><span class='layout'>)</span> <span class='str'>"validation with Relax NG, SCHEMA is the URI for the Relax NG schema"</span>
<a name="line-90"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>""</span> <span class='keyglyph'>[</span><span class='varid'>a_check_restrictions</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>a_check_restrictions</span><span class='layout'>,</span> <span class='varid'>v_1</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"check Relax NG schema restrictions during schema simplification (default)"</span>
<a name="line-91"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>""</span> <span class='keyglyph'>[</span><span class='varid'>a_do_not_check_restrictions</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>a_check_restrictions</span><span class='layout'>,</span> <span class='varid'>v_0</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"do not check Relax NG schema restrictions"</span>
<a name="line-92"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>""</span> <span class='keyglyph'>[</span><span class='varid'>a_validate_externalRef</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>a_validate_externalRef</span><span class='layout'>,</span> <span class='varid'>v_1</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"validate a Relax NG schema referenced by a externalRef-Pattern (default)"</span>
<a name="line-93"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>""</span> <span class='keyglyph'>[</span><span class='varid'>a_do_not_validate_externalRef</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>a_validate_externalRef</span><span class='layout'>,</span> <span class='varid'>v_0</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"do not validate a Relax NG schema referenced by an externalRef-Pattern"</span>
<a name="line-94"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>""</span> <span class='keyglyph'>[</span><span class='varid'>a_validate_include</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>a_validate_include</span><span class='layout'>,</span> <span class='varid'>v_1</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"validate a Relax NG schema referenced by an include-Pattern (default)"</span>
<a name="line-95"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>""</span> <span class='keyglyph'>[</span><span class='varid'>a_do_not_validate_include</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>a_validate_include</span><span class='layout'>,</span> <span class='varid'>v_0</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"do not validate a Relax NG schema referenced by an include-Pattern"</span>
<a name="line-96"></a> <span class='comment'>{-
<a name="line-97"></a> , Option "" [a_output_changes] (NoArg (a_output_changes, v_1)) "output Pattern transformations in case of an error"
<a name="line-98"></a> , Option "" [a_do_not_collect_errors] (NoArg (a_do_not_collect_errors, v_1)) "stop Relax NG simplification after the first error has occurred"
<a name="line-99"></a> -}</span>
<a name="line-100"></a> <span class='keyglyph'>]</span>
<a name="line-101"></a> <span class='keyword'>where</span>
<a name="line-102"></a> <span class='varid'>att</span> <span class='varid'>n</span> <span class='varid'>v</span> <span class='keyglyph'>=</span> <span class='layout'>(</span><span class='varid'>n</span><span class='layout'>,</span> <span class='varid'>v</span><span class='layout'>)</span>
<a name="line-103"></a>
<a name="line-104"></a><span class='comment'>-- |</span>
<a name="line-105"></a><span class='comment'>-- commonly useful options for XML output</span>
<a name="line-106"></a><span class='comment'>--</span>
<a name="line-107"></a><span class='comment'>-- defines options: 'a_indent', 'a_output_encoding', 'a_output_file', 'a_output_html'</span>
<a name="line-108"></a>
<a name="line-109"></a><a name="outputOptions"></a><span class='definition'>outputOptions</span> <span class='keyglyph'>::</span> <span class='keyglyph'>[</span><span class='conid'>OptDescr</span> <span class='layout'>(</span><span class='conid'>String</span><span class='layout'>,</span> <span class='conid'>String</span><span class='layout'>)</span><span class='keyglyph'>]</span>
<a name="line-110"></a><span class='definition'>outputOptions</span>
<a name="line-111"></a> <span class='keyglyph'>=</span> <span class='keyglyph'>[</span> <span class='conid'>Option</span> <span class='str'>"i"</span> <span class='keyglyph'>[</span><span class='varid'>a_indent</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_indent</span> <span class='varid'>v_1</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"indent XML output for readability"</span>
<a name="line-112"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>"o"</span> <span class='keyglyph'>[</span><span class='varid'>a_output_encoding</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>ReqArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_output_encoding</span><span class='layout'>)</span> <span class='str'>"CHARSET"</span><span class='layout'>)</span> <span class='layout'>(</span> <span class='str'>"encoding of output ("</span> <span class='varop'>++</span> <span class='varid'>utf8</span> <span class='varop'>++</span> <span class='str'>", "</span> <span class='varop'>++</span> <span class='varid'>isoLatin1</span> <span class='varop'>++</span> <span class='str'>", "</span> <span class='varop'>++</span> <span class='varid'>usAscii</span> <span class='varop'>++</span> <span class='str'>")"</span> <span class='layout'>)</span>
<a name="line-113"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>"f"</span> <span class='keyglyph'>[</span><span class='varid'>a_output_file</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>ReqArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_output_file</span><span class='layout'>)</span> <span class='str'>"FILE"</span><span class='layout'>)</span> <span class='str'>"output file for resulting document (default: stdout)"</span>
<a name="line-114"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>""</span> <span class='keyglyph'>[</span><span class='varid'>a_output_html</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_output_html</span> <span class='varid'>v_1</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"output of none ASCII chars as HTMl entity references"</span>
<a name="line-115"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>""</span> <span class='keyglyph'>[</span><span class='varid'>a_no_xml_pi</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_no_xml_pi</span> <span class='varid'>v_1</span><span class='layout'>)</span><span class='layout'>)</span> <span class='layout'>(</span><span class='str'>"output without <?xml ...?> processing instruction, useful in combination with --"</span> <span class='varop'>++</span> <span class='varid'>show</span> <span class='varid'>a_output_html</span><span class='layout'>)</span>
<a name="line-116"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>""</span> <span class='keyglyph'>[</span><span class='varid'>a_no_empty_elements</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>att</span> <span class='varid'>a_no_empty_elements</span> <span class='varid'>v_1</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"output of empty elements done in format <elem...></elem> instead of <elem/>"</span>
<a name="line-117"></a> <span class='keyglyph'>]</span>
<a name="line-118"></a> <span class='keyword'>where</span>
<a name="line-119"></a> <span class='varid'>att</span> <span class='varid'>n</span> <span class='varid'>v</span> <span class='keyglyph'>=</span> <span class='layout'>(</span><span class='varid'>n</span><span class='layout'>,</span> <span class='varid'>v</span><span class='layout'>)</span>
<a name="line-120"></a>
<a name="line-121"></a><span class='comment'>-- |</span>
<a name="line-122"></a><span class='comment'>-- commonly useful options</span>
<a name="line-123"></a><span class='comment'>--</span>
<a name="line-124"></a><span class='comment'>-- defines options: 'a_verbose', 'a_help'</span>
<a name="line-125"></a>
<a name="line-126"></a><a name="generalOptions"></a><span class='definition'>generalOptions</span> <span class='keyglyph'>::</span> <span class='keyglyph'>[</span><span class='conid'>OptDescr</span> <span class='layout'>(</span><span class='conid'>String</span><span class='layout'>,</span> <span class='conid'>String</span><span class='layout'>)</span><span class='keyglyph'>]</span>
<a name="line-127"></a><span class='definition'>generalOptions</span>
<a name="line-128"></a> <span class='keyglyph'>=</span> <span class='keyglyph'>[</span> <span class='conid'>Option</span> <span class='str'>"v"</span> <span class='keyglyph'>[</span><span class='varid'>a_verbose</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>a_verbose</span><span class='layout'>,</span> <span class='varid'>v_1</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"verbose output"</span>
<a name="line-129"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>"h?"</span> <span class='keyglyph'>[</span><span class='varid'>a_help</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>a_help</span><span class='layout'>,</span> <span class='varid'>v_1</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"this message"</span>
<a name="line-130"></a> <span class='keyglyph'>]</span>
<a name="line-131"></a>
<a name="line-132"></a><span class='comment'>-- |</span>
<a name="line-133"></a><span class='comment'>-- defines 'a_version' option</span>
<a name="line-134"></a>
<a name="line-135"></a><a name="versionOptions"></a><span class='definition'>versionOptions</span> <span class='keyglyph'>::</span> <span class='keyglyph'>[</span><span class='conid'>OptDescr</span> <span class='layout'>(</span><span class='conid'>String</span><span class='layout'>,</span> <span class='conid'>String</span><span class='layout'>)</span><span class='keyglyph'>]</span>
<a name="line-136"></a><span class='definition'>versionOptions</span>
<a name="line-137"></a> <span class='keyglyph'>=</span> <span class='keyglyph'>[</span> <span class='conid'>Option</span> <span class='str'>"V"</span> <span class='keyglyph'>[</span><span class='varid'>a_version</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>a_version</span><span class='layout'>,</span> <span class='varid'>v_1</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"show program version"</span>
<a name="line-138"></a> <span class='keyglyph'>]</span>
<a name="line-139"></a>
<a name="line-140"></a><span class='comment'>-- |</span>
<a name="line-141"></a><span class='comment'>-- debug output options</span>
<a name="line-142"></a>
<a name="line-143"></a><a name="showOptions"></a><span class='definition'>showOptions</span> <span class='keyglyph'>::</span> <span class='keyglyph'>[</span><span class='conid'>OptDescr</span> <span class='layout'>(</span><span class='conid'>String</span><span class='layout'>,</span> <span class='conid'>String</span><span class='layout'>)</span><span class='keyglyph'>]</span>
<a name="line-144"></a><span class='definition'>showOptions</span>
<a name="line-145"></a> <span class='keyglyph'>=</span> <span class='keyglyph'>[</span> <span class='conid'>Option</span> <span class='str'>""</span> <span class='keyglyph'>[</span><span class='varid'>a_show_tree</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>a_show_tree</span><span class='layout'>,</span> <span class='varid'>v_1</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"output tree representation instead of document source"</span>
<a name="line-146"></a> <span class='layout'>,</span> <span class='conid'>Option</span> <span class='str'>""</span> <span class='keyglyph'>[</span><span class='varid'>a_show_haskell</span><span class='keyglyph'>]</span> <span class='layout'>(</span><span class='conid'>NoArg</span> <span class='layout'>(</span><span class='varid'>a_show_haskell</span><span class='layout'>,</span> <span class='varid'>v_1</span><span class='layout'>)</span><span class='layout'>)</span> <span class='str'>"output internal Haskell representation instead of document source"</span>
<a name="line-147"></a> <span class='keyglyph'>]</span>
<a name="line-148"></a>
<a name="line-149"></a><span class='comment'>-- ------------------------------------------------------------</span>
<a name="line-150"></a>
<a name="line-151"></a><span class='comment'>-- |</span>
<a name="line-152"></a><span class='comment'>-- select options from a predefined list of option desciptions</span>
<a name="line-153"></a>
<a name="line-154"></a><a name="selectOptions"></a><span class='definition'>selectOptions</span> <span class='keyglyph'>::</span> <span class='keyglyph'>[</span><span class='conid'>String</span><span class='keyglyph'>]</span> <span class='keyglyph'>-></span> <span class='keyglyph'>[</span><span class='conid'>OptDescr</span> <span class='layout'>(</span><span class='conid'>String</span><span class='layout'>,</span> <span class='conid'>String</span><span class='layout'>)</span><span class='keyglyph'>]</span> <span class='keyglyph'>-></span> <span class='keyglyph'>[</span><span class='conid'>OptDescr</span> <span class='layout'>(</span><span class='conid'>String</span><span class='layout'>,</span> <span class='conid'>String</span><span class='layout'>)</span><span class='keyglyph'>]</span>
<a name="line-155"></a><span class='definition'>selectOptions</span> <span class='varid'>ol</span> <span class='varid'>os</span>
<a name="line-156"></a> <span class='keyglyph'>=</span> <span class='varid'>concat</span> <span class='varop'>.</span> <span class='varid'>map</span> <span class='layout'>(</span><span class='keyglyph'>\</span> <span class='varid'>on</span> <span class='keyglyph'>-></span> <span class='varid'>filter</span> <span class='layout'>(</span><span class='keyglyph'>\</span> <span class='layout'>(</span><span class='conid'>Option</span> <span class='keyword'>_</span> <span class='varid'>ons</span> <span class='keyword'>_</span> <span class='keyword'>_</span><span class='layout'>)</span> <span class='keyglyph'>-></span> <span class='varid'>on</span> <span class='varop'>`elem`</span> <span class='varid'>ons</span><span class='layout'>)</span> <span class='varid'>os</span><span class='layout'>)</span> <span class='varop'>$</span> <span class='varid'>ol</span>
<a name="line-157"></a>
<a name="line-158"></a><a name="removeOptions"></a><span class='definition'>removeOptions</span> <span class='keyglyph'>::</span> <span class='keyglyph'>[</span><span class='conid'>String</span><span class='keyglyph'>]</span> <span class='keyglyph'>-></span> <span class='keyglyph'>[</span><span class='conid'>OptDescr</span> <span class='layout'>(</span><span class='conid'>String</span><span class='layout'>,</span> <span class='conid'>String</span><span class='layout'>)</span><span class='keyglyph'>]</span> <span class='keyglyph'>-></span> <span class='keyglyph'>[</span><span class='conid'>OptDescr</span> <span class='layout'>(</span><span class='conid'>String</span><span class='layout'>,</span> <span class='conid'>String</span><span class='layout'>)</span><span class='keyglyph'>]</span>
<a name="line-159"></a><span class='definition'>removeOptions</span> <span class='varid'>ol</span> <span class='varid'>os</span>
<a name="line-160"></a> <span class='keyglyph'>=</span> <span class='varid'>filter</span> <span class='layout'>(</span><span class='keyglyph'>\</span> <span class='layout'>(</span><span class='conid'>Option</span> <span class='keyword'>_</span> <span class='varid'>ons</span> <span class='keyword'>_</span> <span class='keyword'>_</span><span class='layout'>)</span> <span class='keyglyph'>-></span> <span class='varid'>not</span> <span class='varop'>.</span> <span class='varid'>any</span> <span class='layout'>(</span><span class='varop'>`elem`</span> <span class='varid'>ol</span><span class='layout'>)</span> <span class='varop'>$</span> <span class='varid'>ons</span> <span class='layout'>)</span> <span class='varid'>os</span>
<a name="line-161"></a>
<a name="line-162"></a><span class='comment'>-- |</span>
<a name="line-163"></a><span class='comment'>-- check whether an option is set</span>
<a name="line-164"></a><span class='comment'>--</span>
<a name="line-165"></a><span class='comment'>-- reads the value of an attribute, usually applied to a document root node,</span>
<a name="line-166"></a><span class='comment'>-- and checks if the value represents True. The following strings are interpreted</span>
<a name="line-167"></a><span class='comment'>-- as true: \"1\", \"True\", \"true\", \"yes\", \"Yes\".</span>
<a name="line-168"></a>
<a name="line-169"></a><a name="optionIsSet"></a><span class='definition'>optionIsSet</span> <span class='keyglyph'>::</span> <span class='conid'>String</span> <span class='keyglyph'>-></span> <span class='conid'>Attributes</span> <span class='keyglyph'>-></span> <span class='conid'>Bool</span>
<a name="line-170"></a><span class='definition'>optionIsSet</span> <span class='varid'>n</span> <span class='keyglyph'>=</span> <span class='varid'>isTrueValue</span> <span class='varop'>.</span> <span class='varid'>lookupDef</span> <span class='str'>""</span> <span class='varid'>n</span>
<a name="line-171"></a>
<a name="line-172"></a><span class='comment'>-- | check whether a string represents True</span>
<a name="line-173"></a><span class='comment'>--</span>
<a name="line-174"></a><span class='comment'>-- definition:</span>
<a name="line-175"></a><span class='comment'>--</span>
<a name="line-176"></a><span class='comment'>-- > isTrueValue = (`elem` ["1", "True", "true", "Yes", "yes"])</span>
<a name="line-177"></a>
<a name="line-178"></a><a name="isTrueValue"></a><span class='definition'>isTrueValue</span> <span class='keyglyph'>::</span> <span class='conid'>String</span> <span class='keyglyph'>-></span> <span class='conid'>Bool</span>
<a name="line-179"></a><span class='definition'>isTrueValue</span> <span class='keyglyph'>=</span> <span class='layout'>(</span><span class='varop'>`elem`</span> <span class='keyglyph'>[</span><span class='str'>"1"</span><span class='layout'>,</span> <span class='str'>"True"</span><span class='layout'>,</span> <span class='str'>"true"</span><span class='layout'>,</span> <span class='str'>"Yes"</span><span class='layout'>,</span> <span class='str'>"yes"</span><span class='keyglyph'>]</span><span class='layout'>)</span>
<a name="line-180"></a>
<a name="line-181"></a><span class='comment'>-- ------------------------------------------------------------</span>
</pre></body>
</html>