<?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/System/Log/Handler.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{- arch-tag: Log handlers main definition
<a name="line-2"></a>Copyright (C) 2004-2006 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 : System.Log.Handler
<a name="line-21"></a> Copyright : Copyright (C) 2004-2006 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>Definition of log handler support
<a name="line-29"></a>
<a name="line-30"></a>For some handlers, check out "System.Log.Handler.Simple" and
<a name="line-31"></a>"System.Log.Handler.Syslog".
<a name="line-32"></a>
<a name="line-33"></a>Please see "System.Log.Logger" for extensive documentation on the
<a name="line-34"></a>logging system.
<a name="line-35"></a>
<a name="line-36"></a>Written by John Goerzen, jgoerzen\@complete.org
<a name="line-37"></a>-}</span>
<a name="line-38"></a>
<a name="line-39"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Log</span><span class='hs-varop'>.</span><span class='hs-conid'>Handler</span><span class='hs-layout'>(</span><span class='hs-comment'>-- * Basic Types</span>
<a name="line-40"></a> <span class='hs-conid'>LogHandler</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</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-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Log</span>
<a name="line-43"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Log</span><span class='hs-varop'>.</span><span class='hs-conid'>Formatter</span>
<a name="line-44"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>IO</span>
<a name="line-45"></a>
<a name="line-46"></a><span class='hs-comment'>{- | All log handlers should adhere to this. -}</span>
<a name="line-47"></a>
<a name="line-48"></a><span class='hs-comment'>{- | This is the base class for the various log handlers. They should
<a name="line-49"></a>all adhere to this class. -}</span>
<a name="line-50"></a>
<a name="line-51"></a><a name="LogHandler"></a><span class='hs-keyword'>class</span> <span class='hs-conid'>LogHandler</span> <span class='hs-varid'>a</span> <span class='hs-keyword'>where</span>
<a name="line-52"></a> <span class='hs-comment'>-- | Sets the log level. 'handle' will drop</span>
<a name="line-53"></a> <span class='hs-comment'>-- items beneath this level.</span>
<a name="line-54"></a> <span class='hs-varid'>setLevel</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Priority</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span>
<a name="line-55"></a> <span class='hs-comment'>-- | Gets the current level.</span>
<a name="line-56"></a> <span class='hs-varid'>getLevel</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Priority</span>
<a name="line-57"></a> <span class='hs-comment'>-- | Set a log formatter to customize the log format for this Handler</span>
<a name="line-58"></a> <span class='hs-varid'>setFormatter</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>LogFormatter</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span>
<a name="line-59"></a> <span class='hs-varid'>getFormatter</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>LogFormatter</span> <span class='hs-varid'>a</span>
<a name="line-60"></a> <span class='hs-varid'>getFormatter</span> <span class='hs-varid'>h</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>nullFormatter</span>
<a name="line-61"></a> <span class='hs-comment'>-- | Logs an event if it meets the requirements</span>
<a name="line-62"></a> <span class='hs-comment'>-- given by the most recent call to 'setLevel'.</span>
<a name="line-63"></a> <span class='hs-varid'>handle</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>LogRecord</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span><span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-64"></a>
<a name="line-65"></a> <span class='hs-varid'>handle</span> <span class='hs-varid'>h</span> <span class='hs-layout'>(</span><span class='hs-varid'>pri</span><span class='hs-layout'>,</span> <span class='hs-varid'>msg</span><span class='hs-layout'>)</span> <span class='hs-varid'>logname</span> <span class='hs-keyglyph'>=</span>
<a name="line-66"></a> <span class='hs-keyword'>if</span> <span class='hs-varid'>pri</span> <span class='hs-varop'>>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>getLevel</span> <span class='hs-varid'>h</span><span class='hs-layout'>)</span>
<a name="line-67"></a> <span class='hs-keyword'>then</span> <span class='hs-keyword'>do</span> <span class='hs-varid'>formattedMsg</span> <span class='hs-keyglyph'><-</span> <span class='hs-layout'>(</span><span class='hs-varid'>getFormatter</span> <span class='hs-varid'>h</span><span class='hs-layout'>)</span> <span class='hs-varid'>h</span> <span class='hs-layout'>(</span><span class='hs-varid'>pri</span><span class='hs-layout'>,</span><span class='hs-varid'>msg</span><span class='hs-layout'>)</span> <span class='hs-varid'>logname</span>
<a name="line-68"></a> <span class='hs-varid'>emit</span> <span class='hs-varid'>h</span> <span class='hs-layout'>(</span><span class='hs-varid'>pri</span><span class='hs-layout'>,</span> <span class='hs-varid'>formattedMsg</span><span class='hs-layout'>)</span> <span class='hs-varid'>logname</span>
<a name="line-69"></a> <span class='hs-keyword'>else</span> <span class='hs-varid'>return</span> <span class='hs-conid'>()</span>
<a name="line-70"></a> <span class='hs-comment'>-- | Forces an event to be logged regardless of</span>
<a name="line-71"></a> <span class='hs-comment'>-- the configured level.</span>
<a name="line-72"></a> <span class='hs-varid'>emit</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>LogRecord</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-73"></a> <span class='hs-comment'>-- | Closes the logging system, causing it to close</span>
<a name="line-74"></a> <span class='hs-comment'>-- any open files, etc.</span>
<a name="line-75"></a> <span class='hs-varid'>close</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-76"></a>
<a name="line-77"></a>
<a name="line-78"></a>
<a name="line-79"></a>
</pre></body>
</html>
