hxt-7.1: doc/hdoc/Text-XML-HXT-Parser-XmlInput.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--Rendered using the Haskell Html Library v0.2-->
<HTML
><HEAD
><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"
><TITLE
>Text.XML.HXT.Parser.XmlInput</TITLE
><LINK HREF="haddock.css" REL="stylesheet" TYPE="text/css"
><SCRIPT SRC="haddock.js" TYPE="text/javascript"
></SCRIPT
></HEAD
><BODY
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="topbar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><IMG SRC="haskell_icon.gif" WIDTH="16" HEIGHT="16" ALT=" "
></TD
><TD CLASS="title"
>Haskell Xml Toolbox 7.1: The complete API</TD
><TD CLASS="topbut"
><A HREF="http://darcs.fh-wedel.de/hxt/src/./Text/XML/HXT/Parser/XmlInput.hs"
>Source code</A
></TD
><TD CLASS="topbut"
><A HREF="index.html"
>Contents</A
></TD
><TD CLASS="topbut"
><A HREF="doc-index.html"
>Index</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="modulebar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><FONT SIZE="6"
>Text.XML.HXT.Parser.XmlInput</FONT
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Synopsis</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="#v%3AgetXmlContents"
>getXmlContents</A
> :: <A HREF="Text-XML-HXT-DOM-XmlState.html#t%3AXmlStateFilter"
>XmlStateFilter</A
> a</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AgetXmlEntityContents"
>getXmlEntityContents</A
> :: <A HREF="Text-XML-HXT-DOM-XmlState.html#t%3AXmlStateFilter"
>XmlStateFilter</A
> a</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AgetUrlContents"
>getUrlContents</A
> :: <A HREF="Text-XML-HXT-DOM-XmlState.html#t%3AXmlStateFilter"
>XmlStateFilter</A
> a</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AgetContentLength"
>getContentLength</A
> :: <A HREF="Text-XML-HXT-DOM-XmlTreeTypes.html#t%3AXmlFilter"
>XmlFilter</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AguessDocEncoding"
>guessDocEncoding</A
> :: <A HREF="Text-XML-HXT-DOM-XmlState.html#t%3AXmlStateFilter"
>XmlStateFilter</A
> a</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3ArunInLocalURIContext"
>runInLocalURIContext</A
> :: <A HREF="Text-XML-HXT-DOM-XmlState.html#t%3AXmlStateFilter"
>XmlStateFilter</A
> a -> <A HREF="Text-XML-HXT-DOM-XmlState.html#t%3AXmlStateFilter"
>XmlStateFilter</A
> a</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3ArunInNewURIContext"
>runInNewURIContext</A
> :: String -> <A HREF="Text-XML-HXT-DOM-XmlState.html#t%3AXmlStateFilter"
>XmlStateFilter</A
> a -> <A HREF="Text-XML-HXT-DOM-XmlState.html#t%3AXmlStateFilter"
>XmlStateFilter</A
> a</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AgetBaseURI"
>getBaseURI</A
> :: <A HREF="Text-XML-HXT-DOM-XmlState.html#t%3AXState"
>XState</A
> state String</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AsetBaseURI"
>setBaseURI</A
> :: String -> <A HREF="Text-XML-HXT-DOM-XmlState.html#t%3AXState"
>XState</A
> state ()</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AgetAbsolutURI"
>getAbsolutURI</A
> :: String -> <A HREF="Text-XML-HXT-DOM-XmlState.html#t%3AXState"
>XState</A
> state String</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AisStandaloneDocument"
>isStandaloneDocument</A
> :: <A HREF="Text-XML-HXT-DOM-XmlState.html#t%3AXState"
>XState</A
> state Bool</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Documentation</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v%3AgetXmlContents"
></A
><B
>getXmlContents</B
> :: <A HREF="Text-XML-HXT-DOM-XmlState.html#t%3AXmlStateFilter"
>XmlStateFilter</A
> a</TD
></TR
><TR
><TD CLASS="doc"
><P
>filter for reading the content of a XML document
</P
><P
>input is a root node with the source as an attibute
the text is read, the encoding scheme is parsed and selected
and the input is translated into the internal UTF-8 string representation
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v%3AgetXmlEntityContents"
></A
><B
>getXmlEntityContents</B
> :: <A HREF="Text-XML-HXT-DOM-XmlState.html#t%3AXmlStateFilter"
>XmlStateFilter</A
> a</TD
></TR
><TR
><TD CLASS="doc"
><P
>filter for reading the content of an external XML entity
</P
><P
>see also : <TT
><A HREF="Text-XML-HXT-Parser-XmlInput.html#v%3AgetXmlContents"
>getXmlContents</A
></TT
>
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v%3AgetUrlContents"
></A
><B
>getUrlContents</B
> :: <A HREF="Text-XML-HXT-DOM-XmlState.html#t%3AXmlStateFilter"
>XmlStateFilter</A
> a</TD
></TR
><TR
><TD CLASS="doc"
><P
>the hard io operations
</P
><P
>for reading a file or accessing a document via http
input must be a root node with a <TT
>source</TT
> attribute specifying the URI
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v%3AgetContentLength"
></A
><B
>getContentLength</B
> :: <A HREF="Text-XML-HXT-DOM-XmlTreeTypes.html#t%3AXmlFilter"
>XmlFilter</A
></TD
></TR
><TR
><TD CLASS="doc"
>compute the length of the data for a document read previously
by a call of 'getUrlContents. The result is stored as an attribute
value in the document root node. the attribute name is <TT
><A HREF="Text-XML-HXT-DOM-XmlKeywords.html#v%3Aa_contentLength"
>a_contentLength</A
></TT
>
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v%3AguessDocEncoding"
></A
><B
>guessDocEncoding</B
> :: <A HREF="Text-XML-HXT-DOM-XmlState.html#t%3AXmlStateFilter"
>XmlStateFilter</A
> a</TD
></TR
><TR
><TD CLASS="doc"
><P
>guessEncoding uses encoding attribute and content
to determine the encoding scheme.
</P
><P
>it's assumed that an encoding spec has been tried to parse before guessing the encoding.
</P
><P
>UTF-8 is the default encoding
</P
><P
>other supported encodings are ISO-8859-1 (also known as ISO-Latin-1),
US-ASCII, UTF-16 or ISO-10646-UCS-2, UTF-16BE, UTF-16LE
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v%3ArunInLocalURIContext"
></A
><B
>runInLocalURIContext</B
> :: <A HREF="Text-XML-HXT-DOM-XmlState.html#t%3AXmlStateFilter"
>XmlStateFilter</A
> a -> <A HREF="Text-XML-HXT-DOM-XmlState.html#t%3AXmlStateFilter"
>XmlStateFilter</A
> a</TD
></TR
><TR
><TD CLASS="doc"
><P
>filter command for saving and restoring
the base URI
</P
><UL
><LI
> 1.parameter f : the filter that possible changes the base URI
</LI
><LI
> returns : a filter with the same effect as f, that restores the base URI after application of f
</LI
></UL
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v%3ArunInNewURIContext"
></A
><B
>runInNewURIContext</B
> :: String -> <A HREF="Text-XML-HXT-DOM-XmlState.html#t%3AXmlStateFilter"
>XmlStateFilter</A
> a -> <A HREF="Text-XML-HXT-DOM-XmlState.html#t%3AXmlStateFilter"
>XmlStateFilter</A
> a</TD
></TR
><TR
><TD CLASS="doc"
>filter command for running an action in a new URI context
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v%3AgetBaseURI"
></A
><B
>getBaseURI</B
> :: <A HREF="Text-XML-HXT-DOM-XmlState.html#t%3AXState"
>XState</A
> state String</TD
></TR
><TR
><TD CLASS="doc"
><P
>read the current base URI
</P
><P
>see also : <TT
><A HREF="Text-XML-HXT-Parser-XmlInput.html#v%3AsetBaseURI"
>setBaseURI</A
></TT
>
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v%3AsetBaseURI"
></A
><B
>setBaseURI</B
> :: String -> <A HREF="Text-XML-HXT-DOM-XmlState.html#t%3AXState"
>XState</A
> state ()</TD
></TR
><TR
><TD CLASS="doc"
><P
>set the base URI, all other URIs are handled relative to this base URI
</P
><P
>the default base URI is <TT
>file:///<current-working-dir>/</TT
>
</P
><P
>see also : <TT
><A HREF="Text-XML-HXT-Parser-XmlInput.html#v%3AgetBaseURI"
>getBaseURI</A
></TT
>
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v%3AgetAbsolutURI"
></A
><B
>getAbsolutURI</B
> :: String -> <A HREF="Text-XML-HXT-DOM-XmlState.html#t%3AXState"
>XState</A
> state String</TD
></TR
><TR
><TD CLASS="doc"
><P
>transform an URI into an absolut URI using the current base URI
</P
><UL
><LI
> 1.parameter uri : the URI as string
</LI
><LI
> returns : the absolut URI as string or "" in case of an error
</LI
></UL
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v%3AisStandaloneDocument"
></A
><B
>isStandaloneDocument</B
> :: <A HREF="Text-XML-HXT-DOM-XmlState.html#t%3AXState"
>XState</A
> state Bool</TD
></TR
><TR
><TD CLASS="doc"
>predicate for testing the standalone document attribute
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="botbar"
>Produced by <A HREF="http://www.haskell.org/haddock/"
>Haddock</A
> version 0.7</TD
></TR
></TABLE
></BODY
></HTML
>