<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://www.cs.york.ac.uk/fp/darcs/hscolour/ -->
<title>src/Data/ConfigFile/Types.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-
<a name="line-2"></a>Copyright (C) 2004-2008 John Goerzen <jgoerzen@complete.org>
<a name="line-3"></a>
<a name="line-4"></a>This program is free software; you can redistribute it and/or modify
<a name="line-5"></a>it under the terms of the GNU Lesser General Public License as published by
<a name="line-6"></a>the Free Software Foundation; either version 2.1 of the License, or
<a name="line-7"></a>(at your option) any later version.
<a name="line-8"></a>
<a name="line-9"></a>This program is distributed in the hope that it will be useful,
<a name="line-10"></a>but WITHOUT ANY WARRANTY; without even the implied warranty of
<a name="line-11"></a>MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
<a name="line-12"></a>GNU Lesser General Public License for more details.
<a name="line-13"></a>
<a name="line-14"></a>You should have received a copy of the GNU Lesser General Public License
<a name="line-15"></a>along with this program; if not, write to the Free Software
<a name="line-16"></a>Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
<a name="line-17"></a>-}</span>
<a name="line-18"></a>
<a name="line-19"></a><span class='hs-comment'>{- |
<a name="line-20"></a> Module : Data.ConfigFile.Types
<a name="line-21"></a> Copyright : Copyright (C) 2004-2008 John Goerzen
<a name="line-22"></a> License : GNU LGPL, version 2.1 or above
<a name="line-23"></a>
<a name="line-24"></a> Maintainer : John Goerzen <jgoerzen@complete.org>
<a name="line-25"></a> Stability : provisional
<a name="line-26"></a> Portability: portable
<a name="line-27"></a>
<a name="line-28"></a>Internal types for "Data.ConfigFile". This module is not intended to be
<a name="line-29"></a>used directly by your programs.
<a name="line-30"></a>
<a name="line-31"></a>Copyright (c) 2004-2008 John Goerzen, jgoerzen\@complete.org
<a name="line-32"></a>-}</span>
<a name="line-33"></a>
<a name="line-34"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>ConfigFile</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span> <span class='hs-layout'>(</span>
<a name="line-35"></a> <span class='hs-conid'>CPOptions</span><span class='hs-layout'>,</span> <span class='hs-conid'>CPData</span><span class='hs-layout'>,</span>
<a name="line-36"></a> <span class='hs-conid'>CPErrorData</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-conid'>CPError</span><span class='hs-layout'>,</span> <span class='hs-comment'>{-CPResult,-}</span>
<a name="line-37"></a> <span class='hs-conid'>ConfigParser</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-38"></a> <span class='hs-conid'>SectionSpec</span><span class='hs-layout'>,</span>
<a name="line-39"></a> <span class='hs-conid'>OptionSpec</span><span class='hs-layout'>,</span>
<a name="line-40"></a> <span class='hs-conid'>ParseOutput</span>
<a name="line-41"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-42"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Map</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>Map</span>
<a name="line-43"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Char</span>
<a name="line-44"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span><span class='hs-varop'>.</span><span class='hs-conid'>Error</span>
<a name="line-45"></a>
<a name="line-46"></a><a name="ParseOutput"></a><span class='hs-comment'>{- | Internal output from parser -}</span>
<a name="line-47"></a><a name="ParseOutput"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>ParseOutput</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>String</span><span class='hs-layout'>,</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>String</span><span class='hs-layout'>,</span> <span class='hs-conid'>String</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-48"></a>
<a name="line-49"></a><a name="SectionSpec"></a><span class='hs-comment'>{- | Names of sections -}</span>
<a name="line-50"></a><a name="SectionSpec"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>SectionSpec</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>String</span>
<a name="line-51"></a>
<a name="line-52"></a><a name="OptionSpec"></a><span class='hs-comment'>{- | Names of options -}</span>
<a name="line-53"></a><a name="OptionSpec"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>OptionSpec</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>String</span>
<a name="line-54"></a>
<a name="line-55"></a><a name="CPOptions"></a><span class='hs-comment'>{- | Storage of options. -}</span>
<a name="line-56"></a><a name="CPOptions"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>CPOptions</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-conid'>Map</span> <span class='hs-conid'>OptionSpec</span> <span class='hs-conid'>String</span>
<a name="line-57"></a>
<a name="line-58"></a><a name="CPData"></a><span class='hs-comment'>{- | The main data storage type (storage of sections).
<a name="line-59"></a>
<a name="line-60"></a>PLEASE NOTE: This type is exported only for use by other modules under
<a name="line-61"></a>Data.ConfigFile. You should NEVER access the FiniteMap in a ConfigParser
<a name="line-62"></a>directly. This type may change in future releases of MissingH, which could
<a name="line-63"></a>break your programs. Please retrict yourself to the interface in
<a name="line-64"></a>'Data.ConfigFile'.
<a name="line-65"></a> -}</span>
<a name="line-66"></a><a name="CPData"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>CPData</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-conid'>Map</span> <span class='hs-conid'>SectionSpec</span> <span class='hs-conid'>CPOptions</span>
<a name="line-67"></a>
<a name="line-68"></a><a name="CPErrorData"></a><span class='hs-comment'>{- | Possible ConfigParser errors. -}</span>
<a name="line-69"></a><a name="CPErrorData"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>CPErrorData</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>ParseError</span> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ Parse error</span>
<a name="line-70"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>SectionAlreadyExists</span> <span class='hs-conid'>SectionSpec</span> <span class='hs-comment'>-- ^ Attempt to create an already-existing ection</span>
<a name="line-71"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>NoSection</span> <span class='hs-conid'>SectionSpec</span> <span class='hs-comment'>-- ^ The section does not exist</span>
<a name="line-72"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>NoOption</span> <span class='hs-conid'>OptionSpec</span> <span class='hs-comment'>-- ^ The option does not exist</span>
<a name="line-73"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>OtherProblem</span> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ Miscellaneous error</span>
<a name="line-74"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>InterpolationError</span> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ Raised by 'Data.ConfigFile.interpolatingAccess' if a request was made for a non-existant option</span>
<a name="line-75"></a> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Eq</span><span class='hs-layout'>,</span> <span class='hs-conid'>Ord</span><span class='hs-layout'>,</span> <span class='hs-conid'>Show</span><span class='hs-layout'>)</span>
<a name="line-76"></a>
<a name="line-77"></a><a name="CPError"></a><span class='hs-comment'>{- | Indicates an error occurred. The String is an explanation of the location
<a name="line-78"></a>of the error. -}</span>
<a name="line-79"></a><a name="CPError"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>CPError</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-conid'>CPErrorData</span><span class='hs-layout'>,</span> <span class='hs-conid'>String</span><span class='hs-layout'>)</span>
<a name="line-80"></a>
<a name="line-81"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Error</span> <span class='hs-conid'>CPError</span> <span class='hs-keyword'>where</span>
<a name="line-82"></a> <span class='hs-varid'>noMsg</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-conid'>OtherProblem</span> <span class='hs-str'>""</span><span class='hs-layout'>,</span> <span class='hs-str'>""</span><span class='hs-layout'>)</span>
<a name="line-83"></a> <span class='hs-varid'>strMsg</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-conid'>OtherProblem</span> <span class='hs-varid'>x</span><span class='hs-layout'>,</span> <span class='hs-str'>""</span><span class='hs-layout'>)</span>
<a name="line-84"></a>
<a name="line-85"></a><span class='hs-comment'>{- Removed due to Hugs incompatibility.
<a name="line-86"></a>
<a name="line-87"></a>| Basic ConfigParser error handling. The Left value indicates
<a name="line-88"></a>an error, while a Right value indicates success.
<a name="line-89"></a>type CPResult a = MonadError CPError m => m a
<a name="line-90"></a>-}</span>
<a name="line-91"></a>
<a name="line-92"></a><a name="ConfigParser"></a><span class='hs-comment'>{- | This is the main record that is used by 'Data.ConfigFile'.
<a name="line-93"></a>-}</span>
<a name="line-94"></a><a name="ConfigParser"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>ConfigParser</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>ConfigParser</span>
<a name="line-95"></a> <span class='hs-layout'>{</span> <span class='hs-comment'>-- | The data itself</span>
<a name="line-96"></a> <span class='hs-varid'>content</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>CPData</span><span class='hs-layout'>,</span>
<a name="line-97"></a> <span class='hs-comment'>-- | How to transform an option into a standard representation</span>
<a name="line-98"></a> <span class='hs-varid'>optionxform</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>OptionSpec</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>OptionSpec</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-99"></a> <span class='hs-comment'>-- | Function to look up an option, considering a default value</span>
<a name="line-100"></a> <span class='hs-comment'>-- if 'usedefault' is True; or ignoring a default value otherwise.</span>
<a name="line-101"></a> <span class='hs-comment'>-- The option specification is assumed to be already transformed.</span>
<a name="line-102"></a> <span class='hs-varid'>defaulthandler</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ConfigParser</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SectionSpec</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>OptionSpec</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Either</span> <span class='hs-conid'>CPError</span> <span class='hs-conid'>String</span><span class='hs-layout'>,</span>
<a name="line-103"></a> <span class='hs-comment'>-- | Whether or not to seek out a default action when no match</span>
<a name="line-104"></a> <span class='hs-comment'>-- is found.</span>
<a name="line-105"></a> <span class='hs-varid'>usedefault</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Bool</span><span class='hs-layout'>,</span>
<a name="line-106"></a> <span class='hs-comment'>-- | Function that is used to perform lookups, do optional</span>
<a name="line-107"></a> <span class='hs-comment'>-- interpolation, etc. It is assumed that accessfunc</span>
<a name="line-108"></a> <span class='hs-comment'>-- will internally call defaulthandler to do the underlying lookup.</span>
<a name="line-109"></a> <span class='hs-comment'>-- The option value is not assumed to be transformed.</span>
<a name="line-110"></a> <span class='hs-varid'>accessfunc</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>ConfigParser</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SectionSpec</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>OptionSpec</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Either</span> <span class='hs-conid'>CPError</span> <span class='hs-conid'>String</span><span class='hs-layout'>)</span>
<a name="line-111"></a> <span class='hs-layout'>}</span>
</pre></body>
</html>
