Text-XML-HaXml-XmlContent.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.HaXml.XmlContent</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"
>HaXml</TD
><TD CLASS="topbut"
><A HREF="src/Text/XML/HaXml/XmlContent.html"
>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.HaXml.XmlContent</FONT
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="section4"
><B
>Contents</B
></TD
></TR
><TR
><TD
><DL
><DT
><A HREF="#1"
>Re-export everything from Text.XML.HaXml.XmlContent.Parser.
</A
></DT
><DT
><A HREF="#2"
>Contains instances of the XmlContent classes,
</A
></DT
><DT
><A HREF="#3"
>Whole-document conversion functions
</A
></DT
></DL
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Description</TD
></TR
><TR
><TD CLASS="doc"
><P
>The class <TT
><A HREF="Text-XML-HaXml-XmlContent-Parser.html#t%3AXmlContent"
>XmlContent</A
></TT
> is a kind of replacement for Read and Show:
   it provides conversions between a generic XML tree representation
   and your own more specialised typeful Haskell data trees.
</P
><P
>If you are starting with an XML DTD, use HaXml's tool DtdToHaskell
   to generate both the Haskell types and the corresponding instances.
</P
><P
>If you are starting with a set of Haskell datatypes, use DrIFT to
   derive instances of this class for you:
       http://repetae.net/john/computer/haskell/DrIFT
   and _do_not_ use the current module, but rather
   Text.XML.HaXml.XmlContent.Haskell, for the correct matching
   instances for standard Haskell datatypes.
</P
></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"
>module <A HREF="Text-XML-HaXml-XmlContent-Parser.html"
>Text.XML.HaXml.XmlContent.Parser</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AtoXml"
>toXml</A
> :: <A HREF="Text-XML-HaXml-XmlContent-Parser.html#t%3AXmlContent"
>XmlContent</A
> a =&gt; Bool -&gt; a -&gt; <A HREF="Text-XML-HaXml-Types.html#t%3ADocument"
>Document</A
> ()</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AfromXml"
>fromXml</A
> :: <A HREF="Text-XML-HaXml-XmlContent-Parser.html#t%3AXmlContent"
>XmlContent</A
> a =&gt; <A HREF="Text-XML-HaXml-Types.html#t%3ADocument"
>Document</A
> <A HREF="Text-XML-HaXml-Posn.html#t%3APosn"
>Posn</A
> -&gt; Either String a</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AreadXml"
>readXml</A
> :: <A HREF="Text-XML-HaXml-XmlContent-Parser.html#t%3AXmlContent"
>XmlContent</A
> a =&gt; String -&gt; Either String a</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AshowXml"
>showXml</A
> :: <A HREF="Text-XML-HaXml-XmlContent-Parser.html#t%3AXmlContent"
>XmlContent</A
> a =&gt; Bool -&gt; a -&gt; String</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AfpsShowXml"
>fpsShowXml</A
> :: <A HREF="Text-XML-HaXml-XmlContent-Parser.html#t%3AXmlContent"
>XmlContent</A
> a =&gt; Bool -&gt; a -&gt; ByteString</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AfReadXml"
>fReadXml</A
> :: <A HREF="Text-XML-HaXml-XmlContent-Parser.html#t%3AXmlContent"
>XmlContent</A
> a =&gt; FilePath -&gt; IO a</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AfWriteXml"
>fWriteXml</A
> :: <A HREF="Text-XML-HaXml-XmlContent-Parser.html#t%3AXmlContent"
>XmlContent</A
> a =&gt; FilePath -&gt; a -&gt; IO ()</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AfpsWriteXml"
>fpsWriteXml</A
> :: <A HREF="Text-XML-HaXml-XmlContent-Parser.html#t%3AXmlContent"
>XmlContent</A
> a =&gt; FilePath -&gt; a -&gt; IO ()</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AhGetXml"
>hGetXml</A
> :: <A HREF="Text-XML-HaXml-XmlContent-Parser.html#t%3AXmlContent"
>XmlContent</A
> a =&gt; Handle -&gt; IO a</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AhPutXml"
>hPutXml</A
> :: <A HREF="Text-XML-HaXml-XmlContent-Parser.html#t%3AXmlContent"
>XmlContent</A
> a =&gt; Handle -&gt; Bool -&gt; a -&gt; IO ()</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AfpsHPutXml"
>fpsHPutXml</A
> :: <A HREF="Text-XML-HaXml-XmlContent-Parser.html#t%3AXmlContent"
>XmlContent</A
> a =&gt; Handle -&gt; Bool -&gt; a -&gt; IO ()</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
><A NAME="1"
>Re-export everything from Text.XML.HaXml.XmlContent.Parser.
</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
>module <A HREF="Text-XML-HaXml-XmlContent-Parser.html"
>Text.XML.HaXml.XmlContent.Parser</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
><A NAME="2"
>Contains instances of the XmlContent classes,
</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
><A NAME="3"
>Whole-document conversion functions
</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AtoXml"
></A
><B
>toXml</B
> :: <A HREF="Text-XML-HaXml-XmlContent-Parser.html#t%3AXmlContent"
>XmlContent</A
> a =&gt; Bool -&gt; a -&gt; <A HREF="Text-XML-HaXml-Types.html#t%3ADocument"
>Document</A
> ()</TD
><TD CLASS="declbut"
><A HREF="src/Text/XML/HaXml/XmlContent.html#toXml"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Convert a fully-typed XML document to a string (with or without DTD).
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AfromXml"
></A
><B
>fromXml</B
> :: <A HREF="Text-XML-HaXml-XmlContent-Parser.html#t%3AXmlContent"
>XmlContent</A
> a =&gt; <A HREF="Text-XML-HaXml-Types.html#t%3ADocument"
>Document</A
> <A HREF="Text-XML-HaXml-Posn.html#t%3APosn"
>Posn</A
> -&gt; Either String a</TD
><TD CLASS="declbut"
><A HREF="src/Text/XML/HaXml/XmlContent.html#fromXml"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Read a Haskell value from an XML document, ignoring the DTD and
   using the Haskell result type to determine how to parse it.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AreadXml"
></A
><B
>readXml</B
> :: <A HREF="Text-XML-HaXml-XmlContent-Parser.html#t%3AXmlContent"
>XmlContent</A
> a =&gt; String -&gt; Either String a</TD
><TD CLASS="declbut"
><A HREF="src/Text/XML/HaXml/XmlContent.html#readXml"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Read a fully-typed XML document from a string.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AshowXml"
></A
><B
>showXml</B
> :: <A HREF="Text-XML-HaXml-XmlContent-Parser.html#t%3AXmlContent"
>XmlContent</A
> a =&gt; Bool -&gt; a -&gt; String</TD
><TD CLASS="declbut"
><A HREF="src/Text/XML/HaXml/XmlContent.html#showXml"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Convert a fully-typed XML document to a string (without DTD).
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AfpsShowXml"
></A
><B
>fpsShowXml</B
> :: <A HREF="Text-XML-HaXml-XmlContent-Parser.html#t%3AXmlContent"
>XmlContent</A
> a =&gt; Bool -&gt; a -&gt; ByteString</TD
><TD CLASS="declbut"
><A HREF="src/Text/XML/HaXml/XmlContent.html#fpsShowXml"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Convert a fully-typed XML document to a ByteString (without DTD).
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AfReadXml"
></A
><B
>fReadXml</B
> :: <A HREF="Text-XML-HaXml-XmlContent-Parser.html#t%3AXmlContent"
>XmlContent</A
> a =&gt; FilePath -&gt; IO a</TD
><TD CLASS="declbut"
><A HREF="src/Text/XML/HaXml/XmlContent.html#fReadXml"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Read an XML document from a file and convert it to a fully-typed
   Haskell value.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AfWriteXml"
></A
><B
>fWriteXml</B
> :: <A HREF="Text-XML-HaXml-XmlContent-Parser.html#t%3AXmlContent"
>XmlContent</A
> a =&gt; FilePath -&gt; a -&gt; IO ()</TD
><TD CLASS="declbut"
><A HREF="src/Text/XML/HaXml/XmlContent.html#fWriteXml"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Write a fully-typed Haskell value to the given file as an XML
   document.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AfpsWriteXml"
></A
><B
>fpsWriteXml</B
> :: <A HREF="Text-XML-HaXml-XmlContent-Parser.html#t%3AXmlContent"
>XmlContent</A
> a =&gt; FilePath -&gt; a -&gt; IO ()</TD
><TD CLASS="declbut"
><A HREF="src/Text/XML/HaXml/XmlContent.html#fpsWriteXml"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Write any Haskell value to the given file as an XML document,
   using the FastPackedString interface (output will not be prettified).
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AhGetXml"
></A
><B
>hGetXml</B
> :: <A HREF="Text-XML-HaXml-XmlContent-Parser.html#t%3AXmlContent"
>XmlContent</A
> a =&gt; Handle -&gt; IO a</TD
><TD CLASS="declbut"
><A HREF="src/Text/XML/HaXml/XmlContent.html#hGetXml"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Read a fully-typed XML document from a file handle.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AhPutXml"
></A
><B
>hPutXml</B
> :: <A HREF="Text-XML-HaXml-XmlContent-Parser.html#t%3AXmlContent"
>XmlContent</A
> a =&gt; Handle -&gt; Bool -&gt; a -&gt; IO ()</TD
><TD CLASS="declbut"
><A HREF="src/Text/XML/HaXml/XmlContent.html#hPutXml"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Write a fully-typed XML document to a file handle.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AfpsHPutXml"
></A
><B
>fpsHPutXml</B
> :: <A HREF="Text-XML-HaXml-XmlContent-Parser.html#t%3AXmlContent"
>XmlContent</A
> a =&gt; Handle -&gt; Bool -&gt; a -&gt; IO ()</TD
><TD CLASS="declbut"
><A HREF="src/Text/XML/HaXml/XmlContent.html#fpsHPutXml"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Write a fully-typed XML document to a file handle, using the
   FastPackedString interface (output will not be prettified).
</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.8</TD
></TR
></TABLE
></BODY
></HTML
>