<!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>Data.ConfigFile.Types</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_Data-ConfigFile-Types.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Data-ConfigFile-Types.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">ConfigFile-1.0.6: Configuration file reading & writing</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>provisional</td></tr><tr><th>Maintainer</th><td>John Goerzen <jgoerzen@complete.org></td></tr></table><p class="caption">Data.ConfigFile.Types</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Internal types for <a href="Data-ConfigFile.html">Data.ConfigFile</a>. This module is not intended to be
used directly by your programs.
</p><p>Copyright (c) 2004-2008 John Goerzen, jgoerzen@complete.org
</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">type</span> <a href="#t:CPOptions">CPOptions</a> = <a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Map.html#t:Map">Map</a> <a href="Data-ConfigFile-Types.html#t:OptionSpec">OptionSpec</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li class="src short"><span class="keyword">type</span> <a href="#t:CPData">CPData</a> = <a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Map.html#t:Map">Map</a> <a href="Data-ConfigFile-Types.html#t:SectionSpec">SectionSpec</a> <a href="Data-ConfigFile-Types.html#t:CPOptions">CPOptions</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:CPErrorData">CPErrorData</a> <ul class="subs"><li>= <a href="#v:ParseError">ParseError</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> </li><li>| <a href="#v:SectionAlreadyExists">SectionAlreadyExists</a> <a href="Data-ConfigFile-Types.html#t:SectionSpec">SectionSpec</a> </li><li>| <a href="#v:NoSection">NoSection</a> <a href="Data-ConfigFile-Types.html#t:SectionSpec">SectionSpec</a> </li><li>| <a href="#v:NoOption">NoOption</a> <a href="Data-ConfigFile-Types.html#t:OptionSpec">OptionSpec</a> </li><li>| <a href="#v:OtherProblem">OtherProblem</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> </li><li>| <a href="#v:InterpolationError">InterpolationError</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> </li></ul></li><li class="src short"><span class="keyword">type</span> <a href="#t:CPError">CPError</a> = (<a href="Data-ConfigFile-Types.html#t:CPErrorData">CPErrorData</a>, <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>)</li><li class="src short"><span class="keyword">data</span> <a href="#t:ConfigParser">ConfigParser</a> = <a href="#v:ConfigParser">ConfigParser</a> {<ul class="subs"><li><a href="#v:content">content</a> :: <a href="Data-ConfigFile-Types.html#t:CPData">CPData</a></li><li><a href="#v:optionxform">optionxform</a> :: <a href="Data-ConfigFile-Types.html#t:OptionSpec">OptionSpec</a> -> <a href="Data-ConfigFile-Types.html#t:OptionSpec">OptionSpec</a></li><li><a href="#v:defaulthandler">defaulthandler</a> :: <a href="Data-ConfigFile-Types.html#t:ConfigParser">ConfigParser</a> -> <a href="Data-ConfigFile-Types.html#t:SectionSpec">SectionSpec</a> -> <a href="Data-ConfigFile-Types.html#t:OptionSpec">OptionSpec</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Either.html#t:Either">Either</a> <a href="Data-ConfigFile-Types.html#t:CPError">CPError</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li><a href="#v:usedefault">usedefault</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li><a href="#v:accessfunc">accessfunc</a> :: <a href="Data-ConfigFile-Types.html#t:ConfigParser">ConfigParser</a> -> <a href="Data-ConfigFile-Types.html#t:SectionSpec">SectionSpec</a> -> <a href="Data-ConfigFile-Types.html#t:OptionSpec">OptionSpec</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Either.html#t:Either">Either</a> <a href="Data-ConfigFile-Types.html#t:CPError">CPError</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li></ul>}</li><li class="src short"><span class="keyword">type</span> <a href="#t:SectionSpec">SectionSpec</a> = <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li class="src short"><span class="keyword">type</span> <a href="#t:OptionSpec">OptionSpec</a> = <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li class="src short"><span class="keyword">type</span> <a href="#t:ParseOutput">ParseOutput</a> = [(<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>, [(<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>, <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>)])]</li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:CPOptions" class="def">CPOptions</a> = <a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Map.html#t:Map">Map</a> <a href="Data-ConfigFile-Types.html#t:OptionSpec">OptionSpec</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a><a href="src/Data-ConfigFile-Types.html#CPOptions" class="link">Source</a></p><div class="doc"><p>Storage of options.
</p></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:CPData" class="def">CPData</a> = <a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Map.html#t:Map">Map</a> <a href="Data-ConfigFile-Types.html#t:SectionSpec">SectionSpec</a> <a href="Data-ConfigFile-Types.html#t:CPOptions">CPOptions</a><a href="src/Data-ConfigFile-Types.html#CPData" class="link">Source</a></p><div class="doc"><p>The main data storage type (storage of sections).
</p><p>PLEASE NOTE: This type is exported only for use by other modules under
Data.ConfigFile. You should NEVER access the FiniteMap in a ConfigParser
directly. This type may change in future releases of MissingH, which could
break your programs. Please retrict yourself to the interface in
<code>Data.ConfigFile</code>.
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:CPErrorData" class="def">CPErrorData</a> <a href="src/Data-ConfigFile-Types.html#CPErrorData" class="link">Source</a></p><div class="doc"><p>Possible ConfigParser errors.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:ParseError" class="def">ParseError</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc"><p>Parse error
</p></td></tr><tr><td class="src"><a name="v:SectionAlreadyExists" class="def">SectionAlreadyExists</a> <a href="Data-ConfigFile-Types.html#t:SectionSpec">SectionSpec</a></td><td class="doc"><p>Attempt to create an already-existing ection
</p></td></tr><tr><td class="src"><a name="v:NoSection" class="def">NoSection</a> <a href="Data-ConfigFile-Types.html#t:SectionSpec">SectionSpec</a></td><td class="doc"><p>The section does not exist
</p></td></tr><tr><td class="src"><a name="v:NoOption" class="def">NoOption</a> <a href="Data-ConfigFile-Types.html#t:OptionSpec">OptionSpec</a></td><td class="doc"><p>The option does not exist
</p></td></tr><tr><td class="src"><a name="v:OtherProblem" class="def">OtherProblem</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc"><p>Miscellaneous error
</p></td></tr><tr><td class="src"><a name="v:InterpolationError" class="def">InterpolationError</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc"><p>Raised by <code>Data.ConfigFile.interpolatingAccess</code> if a request was made for a non-existant option
</p></td></tr></table></div><div class="subs instances"><p id="control.i:CPErrorData" class="caption collapser" onclick="toggleSection('i:CPErrorData')">Instances</p><div id="section.i:CPErrorData" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Data-ConfigFile-Types.html#t:CPErrorData">CPErrorData</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Ord.html#t:Ord">Ord</a> <a href="Data-ConfigFile-Types.html#t:CPErrorData">CPErrorData</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Show.html#t:Show">Show</a> <a href="Data-ConfigFile-Types.html#t:CPErrorData">CPErrorData</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/mtl-2.0.1.0/Control-Monad-Error-Class.html#t:Error">Error</a> <a href="Data-ConfigFile-Types.html#t:CPError">CPError</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:CPError" class="def">CPError</a> = (<a href="Data-ConfigFile-Types.html#t:CPErrorData">CPErrorData</a>, <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>)<a href="src/Data-ConfigFile-Types.html#CPError" class="link">Source</a></p><div class="doc"><p>Indicates an error occurred. The String is an explanation of the location
of the error.
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:ConfigParser" class="def">ConfigParser</a> <a href="src/Data-ConfigFile-Types.html#ConfigParser" class="link">Source</a></p><div class="doc"><p>This is the main record that is used by <code>Data.ConfigFile</code>.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:ConfigParser" class="def">ConfigParser</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:content" class="def">content</a> :: <a href="Data-ConfigFile-Types.html#t:CPData">CPData</a></dt><dd class="doc"><p>The data itself
</p></dd><dt class="src"><a name="v:optionxform" class="def">optionxform</a> :: <a href="Data-ConfigFile-Types.html#t:OptionSpec">OptionSpec</a> -> <a href="Data-ConfigFile-Types.html#t:OptionSpec">OptionSpec</a></dt><dd class="doc"><p>How to transform an option into a standard representation
</p></dd><dt class="src"><a name="v:defaulthandler" class="def">defaulthandler</a> :: <a href="Data-ConfigFile-Types.html#t:ConfigParser">ConfigParser</a> -> <a href="Data-ConfigFile-Types.html#t:SectionSpec">SectionSpec</a> -> <a href="Data-ConfigFile-Types.html#t:OptionSpec">OptionSpec</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Either.html#t:Either">Either</a> <a href="Data-ConfigFile-Types.html#t:CPError">CPError</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></dt><dd class="doc"><p>Function to look up an option, considering a default value
if <code><a href="Data-ConfigFile-Types.html#v:usedefault">usedefault</a></code> is True; or ignoring a default value otherwise.
The option specification is assumed to be already transformed.
</p></dd><dt class="src"><a name="v:usedefault" class="def">usedefault</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></dt><dd class="doc"><p>Whether or not to seek out a default action when no match
is found.
</p></dd><dt class="src"><a name="v:accessfunc" class="def">accessfunc</a> :: <a href="Data-ConfigFile-Types.html#t:ConfigParser">ConfigParser</a> -> <a href="Data-ConfigFile-Types.html#t:SectionSpec">SectionSpec</a> -> <a href="Data-ConfigFile-Types.html#t:OptionSpec">OptionSpec</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Either.html#t:Either">Either</a> <a href="Data-ConfigFile-Types.html#t:CPError">CPError</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></dt><dd class="doc"><p>Function that is used to perform lookups, do optional
interpolation, etc. It is assumed that accessfunc
will internally call defaulthandler to do the underlying lookup.
The option value is not assumed to be transformed.
</p></dd></dl><div class="clear"></div></div></td></tr></table></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:SectionSpec" class="def">SectionSpec</a> = <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a><a href="src/Data-ConfigFile-Types.html#SectionSpec" class="link">Source</a></p><div class="doc"><p>Names of sections
</p></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:OptionSpec" class="def">OptionSpec</a> = <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a><a href="src/Data-ConfigFile-Types.html#OptionSpec" class="link">Source</a></p><div class="doc"><p>Names of options
</p></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:ParseOutput" class="def">ParseOutput</a> = [(<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>, [(<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>, <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>)])]<a href="src/Data-ConfigFile-Types.html#ParseOutput" class="link">Source</a></p><div class="doc"><p>Internal output from parser
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
