Sophie: haskell-hxt-8.3.2-1mdv2010.1 x86

haskell-hxt-8.3.2-1mdv2010.1.x86_64.rpm

<!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.XPath.XPathFct</TITLE
><LINK HREF="haddock.css" REL="stylesheet" TYPE="text/css"
><SCRIPT SRC="haddock-util.js" TYPE="text/javascript"
></SCRIPT
><SCRIPT TYPE="text/javascript"
>window.onload = function () {setSynopsis("mini_Text-XML-HXT-XPath-XPathFct.html")};</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"
>hxt-8.3.2: A collection of tools for processing XML with Haskell.</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.XPath.XPathFct</FONT
></TD
><TD ALIGN="right"
><TABLE CLASS="narrow" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="infohead"
>Portability</TD
><TD CLASS="infoval"
>portable</TD
></TR
><TR
><TD CLASS="infohead"
>Stability</TD
><TD CLASS="infoval"
>experimental</TD
></TR
><TR
><TD CLASS="infohead"
>Maintainer</TD
><TD CLASS="infoval"
>Uwe Schmidt (uwe@fh-wedel.de)</TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Description</TD
></TR
><TR
><TD CLASS="doc"
>The module contains the core-functions of the XPath function library.
   All functions are implemented as XFct. Each XFct contains the evaluation context,
   the variable environment and the function arguments.
</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"
><SPAN CLASS="keyword"
>type</SPAN
> <A HREF="#t%3AXFct"
>XFct</A
> = <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AContext"
>Context</A
> -&gt; <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AEnv"
>Env</A
> -&gt; [<A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AXPathValue"
>XPathValue</A
>] -&gt; <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AXPathValue"
>XPathValue</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AevalFct"
>evalFct</A
> :: <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AFctName"
>FctName</A
> -&gt; <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AEnv"
>Env</A
> -&gt; <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AContext"
>Context</A
> -&gt; [<A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AXPathValue"
>XPathValue</A
>] -&gt; <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AXPathValue"
>XPathValue</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AtoXValue"
>toXValue</A
> :: <A HREF="Text-XML-HXT-XPath-XPathFct.html#t%3AXFct"
>XFct</A
> -&gt; <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AContext"
>Context</A
> -&gt; <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AEnv"
>Env</A
> -&gt; [<A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AXPathValue"
>XPathValue</A
>] -&gt; [<A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AXPathValue"
>XPathValue</A
>]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Axnumber"
>xnumber</A
> :: <A HREF="Text-XML-HXT-XPath-XPathFct.html#t%3AXFct"
>XFct</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Axboolean"
>xboolean</A
> :: <A HREF="Text-XML-HXT-XPath-XPathFct.html#t%3AXFct"
>XFct</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Axstring"
>xstring</A
> :: <A HREF="Text-XML-HXT-XPath-XPathFct.html#t%3AXFct"
>XFct</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AgetConvFct"
>getConvFct</A
> :: <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AXPathValue"
>XPathValue</A
> -&gt; <A HREF="/usr/share/doc/ghc/libraries/base/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="Text-XML-HXT-XPath-XPathFct.html#t%3AXFct"
>XFct</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AstringValue"
>stringValue</A
> :: <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3ANavXmlTree"
>NavXmlTree</A
> -&gt; <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AXPathValue"
>XPathValue</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AremDups"
>remDups</A
> :: <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AXPathFilter"
>XPathFilter</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AisNotInNodeList"
>isNotInNodeList</A
> :: <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3ANavXmlTree"
>NavXmlTree</A
> -&gt; [<A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3ANavXmlTree"
>NavXmlTree</A
>] -&gt; <A HREF="/usr/share/doc/ghc/libraries/ghc-prim/GHC-Bool.html#t%3ABool"
>Bool</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AcreateDocumentOrder"
>createDocumentOrder</A
> :: <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AXPathFilter"
>XPathFilter</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AcreateDocumentOrderReverse"
>createDocumentOrderReverse</A
> :: <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AXPathFilter"
>XPathFilter</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AgetVarTab"
>getVarTab</A
> :: <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AEnv"
>Env</A
> -&gt; <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AVarTab"
>VarTab</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AgetKeyTab"
>getKeyTab</A
> :: <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AEnv"
>Env</A
> -&gt; <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AKeyTab"
>KeyTab</A
></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"
><SPAN CLASS="keyword"
>type</SPAN
> <A NAME="t:XFct"
><A NAME="t%3AXFct"
></A
></A
><B
>XFct</B
> = <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AContext"
>Context</A
> -&gt; <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AEnv"
>Env</A
> -&gt; [<A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AXPathValue"
>XPathValue</A
>] -&gt; <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AXPathValue"
>XPathValue</A
></TD
></TR
><TR
><TD CLASS="doc"
>Type signature for all functions which can be used in the XPath module.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:evalFct"
><A NAME="v%3AevalFct"
></A
></A
><B
>evalFct</B
> :: <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AFctName"
>FctName</A
> -&gt; <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AEnv"
>Env</A
> -&gt; <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AContext"
>Context</A
> -&gt; [<A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AXPathValue"
>XPathValue</A
>] -&gt; <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AXPathValue"
>XPathValue</A
></TD
></TR
><TR
><TD CLASS="doc"
><P
>Evaluates a function.
 Calculation of the function value is done by looking up the function name in the function table,
 check the number of arguments and calculate the funtion, if no
 argument evaluation returns an error.
</P
><UL
><LI
> returns : the function value as <TT
><A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AXPathValue"
>XPathValue</A
></TT
>
</LI
></UL
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:toXValue"
><A NAME="v%3AtoXValue"
></A
></A
><B
>toXValue</B
> :: <A HREF="Text-XML-HXT-XPath-XPathFct.html#t%3AXFct"
>XFct</A
> -&gt; <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AContext"
>Context</A
> -&gt; <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AEnv"
>Env</A
> -&gt; [<A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AXPathValue"
>XPathValue</A
>] -&gt; [<A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AXPathValue"
>XPathValue</A
>]</TD
></TR
><TR
><TD CLASS="doc"
><P
>Converts a list of different <TT
><A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AXPathValue"
>XPathValue</A
></TT
> types in a list of one <TT
><A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AXPathValue"
>XPathValue</A
></TT
> type.
</P
><UL
><LI
> 1.parameter fct :  the conversion function
</LI
></UL
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:xnumber"
><A NAME="v%3Axnumber"
></A
></A
><B
>xnumber</B
> :: <A HREF="Text-XML-HXT-XPath-XPathFct.html#t%3AXFct"
>XFct</A
></TD
></TR
><TR
><TD CLASS="doc"
>number number(object?): converts its argument to a number
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:xboolean"
><A NAME="v%3Axboolean"
></A
></A
><B
>xboolean</B
> :: <A HREF="Text-XML-HXT-XPath-XPathFct.html#t%3AXFct"
>XFct</A
></TD
></TR
><TR
><TD CLASS="doc"
>boolean boolean(object): converts its argument to a boolean value
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:xstring"
><A NAME="v%3Axstring"
></A
></A
><B
>xstring</B
> :: <A HREF="Text-XML-HXT-XPath-XPathFct.html#t%3AXFct"
>XFct</A
></TD
></TR
><TR
><TD CLASS="doc"
>string string(object?): converts an object to a string
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:getConvFct"
><A NAME="v%3AgetConvFct"
></A
></A
><B
>getConvFct</B
> :: <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AXPathValue"
>XPathValue</A
> -&gt; <A HREF="/usr/share/doc/ghc/libraries/base/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="Text-XML-HXT-XPath-XPathFct.html#t%3AXFct"
>XFct</A
></TD
></TR
><TR
><TD CLASS="doc"
>Returns the conversion function for the XPath results: string, boolean and number
 A nodeset can not be converted.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:stringValue"
><A NAME="v%3AstringValue"
></A
></A
><B
>stringValue</B
> :: <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3ANavXmlTree"
>NavXmlTree</A
> -&gt; <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AXPathValue"
>XPathValue</A
></TD
></TR
><TR
><TD CLASS="doc"
>Returns the string-value of a node,
 the value of a namespace node is not supported
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:remDups"
><A NAME="v%3AremDups"
></A
></A
><B
>remDups</B
> :: <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AXPathFilter"
>XPathFilter</A
></TD
></TR
><TR
><TD CLASS="doc"
>Filter for removing identical fragment trees in a nodeset
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:isNotInNodeList"
><A NAME="v%3AisNotInNodeList"
></A
></A
><B
>isNotInNodeList</B
> :: <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3ANavXmlTree"
>NavXmlTree</A
> -&gt; [<A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3ANavXmlTree"
>NavXmlTree</A
>] -&gt; <A HREF="/usr/share/doc/ghc/libraries/ghc-prim/GHC-Bool.html#t%3ABool"
>Bool</A
></TD
></TR
><TR
><TD CLASS="doc"
>Check whether a node is not a part of a node list. Needed to implement matching &amp; testing in xslt.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:createDocumentOrder"
><A NAME="v%3AcreateDocumentOrder"
></A
></A
><B
>createDocumentOrder</B
> :: <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AXPathFilter"
>XPathFilter</A
></TD
></TR
><TR
><TD CLASS="doc"
>Filter for ordering a list of Nodes in document order
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:createDocumentOrderReverse"
><A NAME="v%3AcreateDocumentOrderReverse"
></A
></A
><B
>createDocumentOrderReverse</B
> :: <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AXPathFilter"
>XPathFilter</A
></TD
></TR
><TR
><TD CLASS="doc"
>Filter for ordering a list of Nodes in reverse document order
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:getVarTab"
><A NAME="v%3AgetVarTab"
></A
></A
><B
>getVarTab</B
> :: <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AEnv"
>Env</A
> -&gt; <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AVarTab"
>VarTab</A
></TD
></TR
><TR
><TD CLASS="doc"
>Returns the table of variables from the environment
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:getKeyTab"
><A NAME="v%3AgetKeyTab"
></A
></A
><B
>getKeyTab</B
> :: <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AEnv"
>Env</A
> -&gt; <A HREF="Text-XML-HXT-XPath-XPathDataTypes.html#t%3AKeyTab"
>KeyTab</A
></TD
></TR
><TR
><TD CLASS="doc"
>Returns the table of keys, needed by xslt, from the environment
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="botbar"
>Produced by <A HREF="http://www.haskell.org/haddock/"
>Haddock</A
> version 2.5.0</TD
></TR
></TABLE
></BODY
></HTML
>