/usr/share/doc/libghc-hxt-doc/html/Text-XML-HXT-Arrow-XmlState-URIHandling.html is in libghc-hxt-doc 9.3.1.4-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Text.XML.HXT.Arrow.XmlState.URIHandling</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Text-XML-HXT-Arrow-XmlState-URIHandling.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Text-XML-HXT-Arrow-XmlState-URIHandling.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">hxt-9.3.1.4: A collection of tools for processing XML with Haskell.</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>portable</td></tr><tr><th>Stability</th><td>stable</td></tr><tr><th>Maintainer</th><td>Uwe Schmidt (uwe@fh-wedel.de)</td></tr><tr><th>Safe Haskell</th><td>None</td></tr></table><p class="caption">Text.XML.HXT.Arrow.XmlState.URIHandling</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>the basic state arrows for URI handling
</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><a href="#v:setBaseURI">setBaseURI</a> :: <a href="Text-XML-HXT-Arrow-XmlState-TypeDefs.html#t:IOStateArrow">IOStateArrow</a> s <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:getBaseURI">getBaseURI</a> :: <a href="Text-XML-HXT-Arrow-XmlState-TypeDefs.html#t:IOStateArrow">IOStateArrow</a> s b <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:changeBaseURI">changeBaseURI</a> :: <a href="Text-XML-HXT-Arrow-XmlState-TypeDefs.html#t:IOStateArrow">IOStateArrow</a> s <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:setDefaultBaseURI">setDefaultBaseURI</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> -> <a href="Text-XML-HXT-Arrow-XmlState-TypeDefs.html#t:IOStateArrow">IOStateArrow</a> s b <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:getDefaultBaseURI">getDefaultBaseURI</a> :: <a href="Text-XML-HXT-Arrow-XmlState-TypeDefs.html#t:IOStateArrow">IOStateArrow</a> s b <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:runInLocalURIContext">runInLocalURIContext</a> :: <a href="Text-XML-HXT-Arrow-XmlState-TypeDefs.html#t:IOStateArrow">IOStateArrow</a> s b c -> <a href="Text-XML-HXT-Arrow-XmlState-TypeDefs.html#t:IOStateArrow">IOStateArrow</a> s b c</li><li class="src short"><a href="#v:parseURIReference-39-">parseURIReference'</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/libghc-network-doc/html/Network-URI.html#t:URI">URI</a></li><li class="src short"><a href="#v:expandURIString">expandURIString</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:expandURI">expandURI</a> :: <a href="Text-XML-HXT-Arrow-XmlArrow.html#t:ArrowXml">ArrowXml</a> a => a (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a>, <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a>) <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:mkAbsURI">mkAbsURI</a> :: <a href="Text-XML-HXT-Arrow-XmlState-TypeDefs.html#t:IOStateArrow">IOStateArrow</a> s <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:getSchemeFromURI">getSchemeFromURI</a> :: <a href="Control-Arrow-ArrowList.html#t:ArrowList">ArrowList</a> a => a <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:getRegNameFromURI">getRegNameFromURI</a> :: <a href="Control-Arrow-ArrowList.html#t:ArrowList">ArrowList</a> a => a <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:getPortFromURI">getPortFromURI</a> :: <a href="Control-Arrow-ArrowList.html#t:ArrowList">ArrowList</a> a => a <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:getUserInfoFromURI">getUserInfoFromURI</a> :: <a href="Control-Arrow-ArrowList.html#t:ArrowList">ArrowList</a> a => a <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:getPathFromURI">getPathFromURI</a> :: <a href="Control-Arrow-ArrowList.html#t:ArrowList">ArrowList</a> a => a <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:getQueryFromURI">getQueryFromURI</a> :: <a href="Control-Arrow-ArrowList.html#t:ArrowList">ArrowList</a> a => a <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:getFragmentFromURI">getFragmentFromURI</a> :: <a href="Control-Arrow-ArrowList.html#t:ArrowList">ArrowList</a> a => a <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:getPartFromURI">getPartFromURI</a> :: <a href="Control-Arrow-ArrowList.html#t:ArrowList">ArrowList</a> a => (<a href="/usr/share/doc/libghc-network-doc/html/Network-URI.html#t:URI">URI</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a>) -> a <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a name="v:setBaseURI" class="def">setBaseURI</a> :: <a href="Text-XML-HXT-Arrow-XmlState-TypeDefs.html#t:IOStateArrow">IOStateArrow</a> s <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a><a href="src/Text-XML-HXT-Arrow-XmlState-URIHandling.html#setBaseURI" class="link">Source</a></p><div class="doc"><p>set the base URI of a document, used e.g. for reading includes, e.g. external entities,
the input must be an absolute URI
</p></div></div><div class="top"><p class="src"><a name="v:getBaseURI" class="def">getBaseURI</a> :: <a href="Text-XML-HXT-Arrow-XmlState-TypeDefs.html#t:IOStateArrow">IOStateArrow</a> s b <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a><a href="src/Text-XML-HXT-Arrow-XmlState-URIHandling.html#getBaseURI" class="link">Source</a></p><div class="doc"><p>read the base URI from the globale state
</p></div></div><div class="top"><p class="src"><a name="v:changeBaseURI" class="def">changeBaseURI</a> :: <a href="Text-XML-HXT-Arrow-XmlState-TypeDefs.html#t:IOStateArrow">IOStateArrow</a> s <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a><a href="src/Text-XML-HXT-Arrow-XmlState-URIHandling.html#changeBaseURI" class="link">Source</a></p><div class="doc"><p>change the base URI with a possibly relative URI, can be used for
evaluating the xml:base attribute. Returns the new absolute base URI.
Fails, if input is not parsable with parseURIReference
</p><p>see also: <code><a href="Text-XML-HXT-Arrow-XmlState-URIHandling.html#v:setBaseURI">setBaseURI</a></code>, <code><a href="Text-XML-HXT-Arrow-XmlState-URIHandling.html#v:mkAbsURI">mkAbsURI</a></code>
</p></div></div><div class="top"><p class="src"><a name="v:setDefaultBaseURI" class="def">setDefaultBaseURI</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> -> <a href="Text-XML-HXT-Arrow-XmlState-TypeDefs.html#t:IOStateArrow">IOStateArrow</a> s b <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a><a href="src/Text-XML-HXT-Arrow-XmlState-URIHandling.html#setDefaultBaseURI" class="link">Source</a></p><div class="doc"><p>set the default base URI, if parameter is null, the system base (<code> file:///<cwd>/ </code>) is used,
else the parameter, must be called before any document is read
</p></div></div><div class="top"><p class="src"><a name="v:getDefaultBaseURI" class="def">getDefaultBaseURI</a> :: <a href="Text-XML-HXT-Arrow-XmlState-TypeDefs.html#t:IOStateArrow">IOStateArrow</a> s b <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a><a href="src/Text-XML-HXT-Arrow-XmlState-URIHandling.html#getDefaultBaseURI" class="link">Source</a></p><div class="doc"><p>get the default base URI
</p></div></div><div class="top"><p class="src"><a name="v:runInLocalURIContext" class="def">runInLocalURIContext</a> :: <a href="Text-XML-HXT-Arrow-XmlState-TypeDefs.html#t:IOStateArrow">IOStateArrow</a> s b c -> <a href="Text-XML-HXT-Arrow-XmlState-TypeDefs.html#t:IOStateArrow">IOStateArrow</a> s b c<a href="src/Text-XML-HXT-Arrow-XmlState-URIHandling.html#runInLocalURIContext" class="link">Source</a></p><div class="doc"><p>remember base uri, run an arrow and restore the base URI, used with external entity substitution
</p></div></div><div class="top"><p class="src"><a name="v:parseURIReference-39-" class="def">parseURIReference'</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/libghc-network-doc/html/Network-URI.html#t:URI">URI</a><a href="src/Text-XML-HXT-Arrow-XmlState-URIHandling.html#parseURIReference%27" class="link">Source</a></p><div class="doc"><p>parse a URI reference, in case of a failure,
try to escape unescaped chars, convert backslashes to slashes for windows paths,
and try parsing again
</p></div></div><div class="top"><p class="src"><a name="v:expandURIString" class="def">expandURIString</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a><a href="src/Text-XML-HXT-Arrow-XmlState-URIHandling.html#expandURIString" class="link">Source</a></p><div class="doc"><p>compute the absolut URI for a given URI and a base URI
</p></div></div><div class="top"><p class="src"><a name="v:expandURI" class="def">expandURI</a> :: <a href="Text-XML-HXT-Arrow-XmlArrow.html#t:ArrowXml">ArrowXml</a> a => a (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a>, <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a>) <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a><a href="src/Text-XML-HXT-Arrow-XmlState-URIHandling.html#expandURI" class="link">Source</a></p><div class="doc"><p>arrow variant of <code><a href="Text-XML-HXT-Arrow-XmlState-URIHandling.html#v:expandURIString">expandURIString</a></code>, fails if <code><a href="Text-XML-HXT-Arrow-XmlState-URIHandling.html#v:expandURIString">expandURIString</a></code> returns Nothing
</p></div></div><div class="top"><p class="src"><a name="v:mkAbsURI" class="def">mkAbsURI</a> :: <a href="Text-XML-HXT-Arrow-XmlState-TypeDefs.html#t:IOStateArrow">IOStateArrow</a> s <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a><a href="src/Text-XML-HXT-Arrow-XmlState-URIHandling.html#mkAbsURI" class="link">Source</a></p><div class="doc"><p>arrow for expanding an input URI into an absolute URI using global base URI, fails if input is not a legal URI
</p></div></div><div class="top"><p class="src"><a name="v:getSchemeFromURI" class="def">getSchemeFromURI</a> :: <a href="Control-Arrow-ArrowList.html#t:ArrowList">ArrowList</a> a => a <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a><a href="src/Text-XML-HXT-Arrow-XmlState-URIHandling.html#getSchemeFromURI" class="link">Source</a></p><div class="doc"><p>arrow for selecting the scheme (protocol) of the URI, fails if input is not a legal URI.
</p><p>See Network.URI for URI components
</p></div></div><div class="top"><p class="src"><a name="v:getRegNameFromURI" class="def">getRegNameFromURI</a> :: <a href="Control-Arrow-ArrowList.html#t:ArrowList">ArrowList</a> a => a <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a><a href="src/Text-XML-HXT-Arrow-XmlState-URIHandling.html#getRegNameFromURI" class="link">Source</a></p><div class="doc"><p>arrow for selecting the registered name (host) of the URI, fails if input is not a legal URI
</p></div></div><div class="top"><p class="src"><a name="v:getPortFromURI" class="def">getPortFromURI</a> :: <a href="Control-Arrow-ArrowList.html#t:ArrowList">ArrowList</a> a => a <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a><a href="src/Text-XML-HXT-Arrow-XmlState-URIHandling.html#getPortFromURI" class="link">Source</a></p><div class="doc"><p>arrow for selecting the port number of the URI without leading ':', fails if input is not a legal URI
</p></div></div><div class="top"><p class="src"><a name="v:getUserInfoFromURI" class="def">getUserInfoFromURI</a> :: <a href="Control-Arrow-ArrowList.html#t:ArrowList">ArrowList</a> a => a <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a><a href="src/Text-XML-HXT-Arrow-XmlState-URIHandling.html#getUserInfoFromURI" class="link">Source</a></p><div class="doc"><p>arrow for selecting the user info of the URI without trailing '@', fails if input is not a legal URI
</p></div></div><div class="top"><p class="src"><a name="v:getPathFromURI" class="def">getPathFromURI</a> :: <a href="Control-Arrow-ArrowList.html#t:ArrowList">ArrowList</a> a => a <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a><a href="src/Text-XML-HXT-Arrow-XmlState-URIHandling.html#getPathFromURI" class="link">Source</a></p><div class="doc"><p>arrow for computing the path component of an URI, fails if input is not a legal URI
</p></div></div><div class="top"><p class="src"><a name="v:getQueryFromURI" class="def">getQueryFromURI</a> :: <a href="Control-Arrow-ArrowList.html#t:ArrowList">ArrowList</a> a => a <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a><a href="src/Text-XML-HXT-Arrow-XmlState-URIHandling.html#getQueryFromURI" class="link">Source</a></p><div class="doc"><p>arrow for computing the query component of an URI, fails if input is not a legal URI
</p></div></div><div class="top"><p class="src"><a name="v:getFragmentFromURI" class="def">getFragmentFromURI</a> :: <a href="Control-Arrow-ArrowList.html#t:ArrowList">ArrowList</a> a => a <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a><a href="src/Text-XML-HXT-Arrow-XmlState-URIHandling.html#getFragmentFromURI" class="link">Source</a></p><div class="doc"><p>arrow for computing the fragment component of an URI, fails if input is not a legal URI
</p></div></div><div class="top"><p class="src"><a name="v:getPartFromURI" class="def">getPartFromURI</a> :: <a href="Control-Arrow-ArrowList.html#t:ArrowList">ArrowList</a> a => (<a href="/usr/share/doc/libghc-network-doc/html/Network-URI.html#t:URI">URI</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a>) -> a <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-String.html#t:String">String</a><a href="src/Text-XML-HXT-Arrow-XmlState-URIHandling.html#getPartFromURI" class="link">Source</a></p><div class="doc"><p>arrow for computing the path component of an URI, fails if input is not a legal URI
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.13.2</p></div></body></html>
|