/usr/share/doc/libghc-haxml-doc/html/Text-XML-HaXml-DtdToHaskell-TypeDef.html is in libghc-haxml-doc 1:1.22.5-2.
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 32 33 34 | <!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.HaXml.DtdToHaskell.TypeDef</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-HaXml-DtdToHaskell-TypeDef.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Text-XML-HaXml-DtdToHaskell-TypeDef.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">HaXml-1.22.5: Utilities for manipulating XML documents</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">Text.XML.HaXml.DtdToHaskell.TypeDef</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Internal representation of types
</a></li><li><a href="#g:2">Pretty-print a TypeDef
</a></li><li><a href="#g:3">Name mangling
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Defines an internal representation of Haskell data/newtype definitions
that correspond to the XML DTD types, and provides pretty-printers to
convert these types into the <code><a href="/usr/share/doc/ghc-doc/html/libraries/pretty-1.1.1.0/Text-PrettyPrint.html#t:Doc">Doc</a></code> type of <a href="/usr/share/doc/ghc-doc/html/libraries/pretty-1.1.1.0/Text-PrettyPrint-HughesPJ.html">Text.PrettyPrint.HughesPJ</a>.
</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"><span class="keyword">data</span> <a href="#t:TypeDef">TypeDef</a> <ul class="subs"><li>= <a href="#v:DataDef">DataDef</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:Name">Name</a> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:AttrFields">AttrFields</a> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:Constructors">Constructors</a> </li><li>| <a href="#v:EnumDef">EnumDef</a> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:Name">Name</a> [<a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:Name">Name</a>] </li></ul></li><li class="src short"><span class="keyword">type</span> <a href="#t:Constructors">Constructors</a> = [(<a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:Name">Name</a>, [<a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:StructType">StructType</a>])]</li><li class="src short"><span class="keyword">type</span> <a href="#t:AttrFields">AttrFields</a> = [(<a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:Name">Name</a>, <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:StructType">StructType</a>)]</li><li class="src short"><span class="keyword">data</span> <a href="#t:StructType">StructType</a> <ul class="subs"><li>= <a href="#v:Maybe">Maybe</a> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:StructType">StructType</a> </li><li>| <a href="#v:Defaultable">Defaultable</a> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:StructType">StructType</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> </li><li>| <a href="#v:List">List</a> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:StructType">StructType</a> </li><li>| <a href="#v:List1">List1</a> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:StructType">StructType</a> </li><li>| <a href="#v:Tuple">Tuple</a> [<a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:StructType">StructType</a>] </li><li>| <a href="#v:OneOf">OneOf</a> [<a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:StructType">StructType</a>] </li><li>| <a href="#v:Any">Any</a> </li><li>| <a href="#v:StringMixed">StringMixed</a> </li><li>| <a href="#v:String">String</a> </li><li>| <a href="#v:Defined">Defined</a> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:Name">Name</a> </li></ul></li><li class="src short"><a href="#v:ppTypeDef">ppTypeDef</a> :: <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:TypeDef">TypeDef</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/pretty-1.1.1.0/Text-PrettyPrint.html#t:Doc">Doc</a></li><li class="src short"><a href="#v:ppHName">ppHName</a> :: <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:Name">Name</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/pretty-1.1.1.0/Text-PrettyPrint.html#t:Doc">Doc</a></li><li class="src short"><a href="#v:ppXName">ppXName</a> :: <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:Name">Name</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/pretty-1.1.1.0/Text-PrettyPrint.html#t:Doc">Doc</a></li><li class="src short"><a href="#v:ppAName">ppAName</a> :: <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:Name">Name</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/pretty-1.1.1.0/Text-PrettyPrint.html#t:Doc">Doc</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:Name">Name</a> = <a href="#v:Name">Name</a> {<ul class="subs"><li><a href="#v:xName">xName</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></li><li><a href="#v:hName">hName</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></li></ul>}</li><li class="src short"><a href="#v:name">name</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:Name">Name</a></li><li class="src short"><a href="#v:name_">name_</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:Name">Name</a></li><li class="src short"><a href="#v:name_a">name_a</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:Name">Name</a></li><li class="src short"><a href="#v:name_ac">name_ac</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:Name">Name</a></li><li class="src short"><a href="#v:name_f">name_f</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:Name">Name</a></li><li class="src short"><a href="#v:mangle">mangle</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:manglef">manglef</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></li></ul></div><div id="interface"><h1 id="g:1">Internal representation of types
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:TypeDef" class="def">TypeDef</a> <a href="src/Text-XML-HaXml-DtdToHaskell-TypeDef.html#TypeDef" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:DataDef" class="def">DataDef</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:Name">Name</a> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:AttrFields">AttrFields</a> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:Constructors">Constructors</a></td><td class="doc"><p>Bool for main/aux.
</p></td></tr><tr><td class="src"><a name="v:EnumDef" class="def">EnumDef</a> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:Name">Name</a> [<a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:Name">Name</a>]</td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:TypeDef" class="caption collapser" onclick="toggleSection('i:TypeDef')">Instances</p><div id="section.i:TypeDef" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:TypeDef">TypeDef</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:Constructors" class="def">Constructors</a> = [(<a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:Name">Name</a>, [<a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:StructType">StructType</a>])]<a href="src/Text-XML-HaXml-DtdToHaskell-TypeDef.html#Constructors" class="link">Source</a></p></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:AttrFields" class="def">AttrFields</a> = [(<a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:Name">Name</a>, <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:StructType">StructType</a>)]<a href="src/Text-XML-HaXml-DtdToHaskell-TypeDef.html#AttrFields" class="link">Source</a></p></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:StructType" class="def">StructType</a> <a href="src/Text-XML-HaXml-DtdToHaskell-TypeDef.html#StructType" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Maybe" class="def">Maybe</a> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:StructType">StructType</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Defaultable" class="def">Defaultable</a> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:StructType">StructType</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></td><td class="doc"><p>String holds default value.
</p></td></tr><tr><td class="src"><a name="v:List" class="def">List</a> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:StructType">StructType</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:List1" class="def">List1</a> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:StructType">StructType</a></td><td class="doc"><p>Non-empty lists.
</p></td></tr><tr><td class="src"><a name="v:Tuple" class="def">Tuple</a> [<a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:StructType">StructType</a>]</td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:OneOf" class="def">OneOf</a> [<a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:StructType">StructType</a>]</td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Any" class="def">Any</a></td><td class="doc"><p>XML's contentspec allows ANY
</p></td></tr><tr><td class="src"><a name="v:StringMixed" class="def">StringMixed</a></td><td class="doc"><p>mixed (#PCDATA | ... )*
</p></td></tr><tr><td class="src"><a name="v:String" class="def">String</a></td><td class="doc"><p>string only (#PCDATA)
</p></td></tr><tr><td class="src"><a name="v:Defined" class="def">Defined</a> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:Name">Name</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:StructType" class="caption collapser" onclick="toggleSection('i:StructType')">Instances</p><div id="section.i:StructType" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:StructType">StructType</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:StructType">StructType</a></td><td class="doc empty"> </td></tr></table></div></div></div><h1 id="g:2">Pretty-print a TypeDef
</h1><div class="top"><p class="src"><a name="v:ppTypeDef" class="def">ppTypeDef</a> :: <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:TypeDef">TypeDef</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/pretty-1.1.1.0/Text-PrettyPrint.html#t:Doc">Doc</a><a href="src/Text-XML-HaXml-DtdToHaskell-TypeDef.html#ppTypeDef" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:ppHName" class="def">ppHName</a> :: <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:Name">Name</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/pretty-1.1.1.0/Text-PrettyPrint.html#t:Doc">Doc</a><a href="src/Text-XML-HaXml-DtdToHaskell-TypeDef.html#ppHName" class="link">Source</a></p><div class="doc"><p>Pretty print Haskell name.
</p></div></div><div class="top"><p class="src"><a name="v:ppXName" class="def">ppXName</a> :: <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:Name">Name</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/pretty-1.1.1.0/Text-PrettyPrint.html#t:Doc">Doc</a><a href="src/Text-XML-HaXml-DtdToHaskell-TypeDef.html#ppXName" class="link">Source</a></p><div class="doc"><p>Pretty print XML name.
</p></div></div><div class="top"><p class="src"><a name="v:ppAName" class="def">ppAName</a> :: <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:Name">Name</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/pretty-1.1.1.0/Text-PrettyPrint.html#t:Doc">Doc</a><a href="src/Text-XML-HaXml-DtdToHaskell-TypeDef.html#ppAName" class="link">Source</a></p><div class="doc"><p>Pretty print Haskell attributes name.
</p></div></div><h1 id="g:3">Name mangling
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Name" class="def">Name</a> <a href="src/Text-XML-HaXml-DtdToHaskell-TypeDef.html#Name" class="link">Source</a></p><div class="doc"><p>Need to keep both the XML and Haskell versions of a name.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Name" class="def">Name</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:xName" class="def">xName</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></dt><dd class="doc"><p>original XML name
</p></dd><dt class="src"><a name="v:hName" class="def">hName</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></dt><dd class="doc"><p>mangled Haskell name
</p></dd></dl><div class="clear"></div></div></td></tr></table></div><div class="subs instances"><p id="control.i:Name" class="caption collapser" onclick="toggleSection('i:Name')">Instances</p><div id="section.i:Name" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:Name">Name</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:name" class="def">name</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:Name">Name</a><a href="src/Text-XML-HaXml-DtdToHaskell-TypeDef.html#name" class="link">Source</a></p><div class="doc"><p>Make a type name valid in both XML and Haskell.
</p></div></div><div class="top"><p class="src"><a name="v:name_" class="def">name_</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:Name">Name</a><a href="src/Text-XML-HaXml-DtdToHaskell-TypeDef.html#name_" class="link">Source</a></p><div class="doc"><p>Append an underscore to the Haskell version of the name.
</p></div></div><div class="top"><p class="src"><a name="v:name_a" class="def">name_a</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:Name">Name</a><a href="src/Text-XML-HaXml-DtdToHaskell-TypeDef.html#name_a" class="link">Source</a></p><div class="doc"><p>Prefix an attribute enumeration type name with its containing element
name.
</p></div></div><div class="top"><p class="src"><a name="v:name_ac" class="def">name_ac</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:Name">Name</a><a href="src/Text-XML-HaXml-DtdToHaskell-TypeDef.html#name_ac" class="link">Source</a></p><div class="doc"><p>Prefix an attribute enumeration constructor with its element-tag name,
and its enumeration type name.
</p></div></div><div class="top"><p class="src"><a name="v:name_f" class="def">name_f</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="Text-XML-HaXml-DtdToHaskell-TypeDef.html#t:Name">Name</a><a href="src/Text-XML-HaXml-DtdToHaskell-TypeDef.html#name_f" class="link">Source</a></p><div class="doc"><p>Prefix a field name with its enclosing element name.
</p></div></div><div class="top"><p class="src"><a name="v:mangle" class="def">mangle</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a><a href="src/Text-XML-HaXml-DtdToHaskell-TypeDef.html#mangle" class="link">Source</a></p><div class="doc"><p>Convert an XML name to a Haskell conid.
</p></div></div><div class="top"><p class="src"><a name="v:manglef" class="def">manglef</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a><a href="src/Text-XML-HaXml-DtdToHaskell-TypeDef.html#manglef" class="link">Source</a></p><div class="doc"><p>Convert an XML name to a Haskell varid.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.10.0</p></div></body></html>
|