<?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/Simple.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: Simple log handlers
<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.Simple
<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>Simple log handlers
<a name="line-29"></a>
<a name="line-30"></a>Written by John Goerzen, jgoerzen\@complete.org
<a name="line-31"></a>-}</span>
<a name="line-32"></a>
<a name="line-33"></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-varop'>.</span><span class='hs-conid'>Simple</span><span class='hs-layout'>(</span><span class='hs-varid'>streamHandler</span><span class='hs-layout'>,</span> <span class='hs-varid'>fileHandler</span><span class='hs-layout'>,</span>
<a name="line-34"></a> <span class='hs-conid'>GenericHandler</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-35"></a> <span class='hs-varid'>verboseStreamHandler</span><span class='hs-layout'>)</span>
<a name="line-36"></a> <span class='hs-keyword'>where</span>
<a name="line-37"></a>
<a name="line-38"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Prelude</span> <span class='hs-varid'>hiding</span> <span class='hs-layout'>(</span><span class='hs-varid'>catch</span><span class='hs-layout'>)</span>
<a name="line-39"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Exception</span> <span class='hs-layout'>(</span><span class='hs-conid'>SomeException</span><span class='hs-layout'>,</span> <span class='hs-varid'>catch</span><span class='hs-layout'>)</span>
<a name="line-40"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Char</span> <span class='hs-layout'>(</span><span class='hs-varid'>ord</span><span class='hs-layout'>)</span>
<a name="line-41"></a>
<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'>Handler</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'>Log</span><span class='hs-varop'>.</span><span class='hs-conid'>Formatter</span>
<a name="line-45"></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-46"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Concurrent</span><span class='hs-varop'>.</span><span class='hs-conid'>MVar</span>
<a name="line-47"></a>
<a name="line-48"></a><span class='hs-comment'>{- | A helper data type. -}</span>
<a name="line-49"></a>
<a name="line-50"></a><a name="GenericHandler"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>GenericHandler</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>GenericHandler</span> <span class='hs-layout'>{</span><span class='hs-varid'>priority</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Priority</span><span class='hs-layout'>,</span>
<a name="line-51"></a> <span class='hs-varid'>formatter</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>LogFormatter</span> <span class='hs-layout'>(</span><span class='hs-conid'>GenericHandler</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-52"></a> <span class='hs-varid'>privData</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span>
<a name="line-53"></a> <span class='hs-varid'>writeFunc</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>a</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><span class='hs-layout'>,</span>
<a name="line-54"></a> <span class='hs-varid'>closeFunc</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> <span class='hs-layout'>}</span>
<a name="line-55"></a>
<a name="line-56"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>LogHandler</span> <span class='hs-layout'>(</span><span class='hs-conid'>GenericHandler</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-57"></a> <span class='hs-varid'>setLevel</span> <span class='hs-varid'>sh</span> <span class='hs-varid'>p</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>sh</span><span class='hs-layout'>{</span><span class='hs-varid'>priority</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>p</span><span class='hs-layout'>}</span>
<a name="line-58"></a> <span class='hs-varid'>getLevel</span> <span class='hs-varid'>sh</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>priority</span> <span class='hs-varid'>sh</span>
<a name="line-59"></a> <span class='hs-varid'>setFormatter</span> <span class='hs-varid'>sh</span> <span class='hs-varid'>f</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>sh</span><span class='hs-layout'>{</span><span class='hs-varid'>formatter</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>f</span><span class='hs-layout'>}</span>
<a name="line-60"></a> <span class='hs-varid'>getFormatter</span> <span class='hs-varid'>sh</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>formatter</span> <span class='hs-varid'>sh</span>
<a name="line-61"></a> <span class='hs-varid'>emit</span> <span class='hs-varid'>sh</span> <span class='hs-layout'>(</span><span class='hs-keyword'>_</span><span class='hs-layout'>,</span><span class='hs-varid'>msg</span><span class='hs-layout'>)</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>writeFunc</span> <span class='hs-varid'>sh</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>privData</span> <span class='hs-varid'>sh</span><span class='hs-layout'>)</span> <span class='hs-varid'>msg</span>
<a name="line-62"></a> <span class='hs-varid'>close</span> <span class='hs-varid'>sh</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>closeFunc</span> <span class='hs-varid'>sh</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>privData</span> <span class='hs-varid'>sh</span><span class='hs-layout'>)</span>
<a name="line-63"></a>
<a name="line-64"></a>
<a name="line-65"></a><span class='hs-comment'>{- | Create a stream log handler. Log messages sent to this handler will
<a name="line-66"></a> be sent to the stream used initially. Note that the 'close' method
<a name="line-67"></a> will have no effect on stream handlers; it does not actually close
<a name="line-68"></a> the underlying stream. -}</span>
<a name="line-69"></a>
<a name="line-70"></a><a name="streamHandler"></a><span class='hs-definition'>streamHandler</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Handle</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Priority</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>GenericHandler</span> <span class='hs-conid'>Handle</span><span class='hs-layout'>)</span>
<a name="line-71"></a><span class='hs-definition'>streamHandler</span> <span class='hs-varid'>h</span> <span class='hs-varid'>pri</span> <span class='hs-keyglyph'>=</span>
<a name="line-72"></a> <span class='hs-keyword'>do</span> <span class='hs-varid'>lock</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>newMVar</span> <span class='hs-conid'>()</span>
<a name="line-73"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>mywritefunc</span> <span class='hs-varid'>hdl</span> <span class='hs-varid'>msg</span> <span class='hs-keyglyph'>=</span>
<a name="line-74"></a> <span class='hs-varid'>withMVar</span> <span class='hs-varid'>lock</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span> <span class='hs-varid'>writeToHandle</span> <span class='hs-varid'>hdl</span> <span class='hs-varid'>msg</span>
<a name="line-75"></a> <span class='hs-varid'>hFlush</span> <span class='hs-varid'>hdl</span>
<a name="line-76"></a> <span class='hs-layout'>)</span>
<a name="line-77"></a> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-conid'>GenericHandler</span> <span class='hs-layout'>{</span><span class='hs-varid'>priority</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>pri</span><span class='hs-layout'>,</span>
<a name="line-78"></a> <span class='hs-varid'>formatter</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>nullFormatter</span><span class='hs-layout'>,</span>
<a name="line-79"></a> <span class='hs-varid'>privData</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>h</span><span class='hs-layout'>,</span>
<a name="line-80"></a> <span class='hs-varid'>writeFunc</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mywritefunc</span><span class='hs-layout'>,</span>
<a name="line-81"></a> <span class='hs-varid'>closeFunc</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>x</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-conid'>()</span><span class='hs-layout'>}</span><span class='hs-layout'>)</span>
<a name="line-82"></a> <span class='hs-keyword'>where</span>
<a name="line-83"></a> <span class='hs-varid'>writeToHandle</span> <span class='hs-varid'>hdl</span> <span class='hs-varid'>msg</span> <span class='hs-keyglyph'>=</span>
<a name="line-84"></a> <span class='hs-varid'>hPutStrLn</span> <span class='hs-varid'>hdl</span> <span class='hs-varid'>msg</span> <span class='hs-varop'>`catch`</span> <span class='hs-layout'>(</span><span class='hs-varid'>handleWriteException</span> <span class='hs-varid'>hdl</span> <span class='hs-varid'>msg</span><span class='hs-layout'>)</span>
<a name="line-85"></a> <span class='hs-varid'>handleWriteException</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Handle</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SomeException</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-86"></a> <span class='hs-varid'>handleWriteException</span> <span class='hs-varid'>hdl</span> <span class='hs-varid'>msg</span> <span class='hs-varid'>e</span> <span class='hs-keyglyph'>=</span>
<a name="line-87"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>msg'</span> <span class='hs-keyglyph'>=</span> <span class='hs-str'>"Error writing log message: "</span> <span class='hs-varop'>++</span> <span class='hs-varid'>show</span> <span class='hs-varid'>e</span> <span class='hs-varop'>++</span>
<a name="line-88"></a> <span class='hs-str'>" (original message: "</span> <span class='hs-varop'>++</span> <span class='hs-varid'>msg</span> <span class='hs-varop'>++</span> <span class='hs-str'>")"</span>
<a name="line-89"></a> <span class='hs-keyword'>in</span> <span class='hs-varid'>hPutStrLn</span> <span class='hs-varid'>hdl</span> <span class='hs-layout'>(</span><span class='hs-varid'>encodingSave</span> <span class='hs-varid'>msg'</span><span class='hs-layout'>)</span>
<a name="line-90"></a> <span class='hs-varid'>encodingSave</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>concatMap</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>c</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>if</span> <span class='hs-varid'>ord</span> <span class='hs-varid'>c</span> <span class='hs-varop'>></span> <span class='hs-num'>127</span>
<a name="line-91"></a> <span class='hs-keyword'>then</span> <span class='hs-str'>"\\"</span> <span class='hs-varop'>++</span> <span class='hs-varid'>show</span> <span class='hs-layout'>(</span><span class='hs-varid'>ord</span> <span class='hs-varid'>c</span><span class='hs-layout'>)</span>
<a name="line-92"></a> <span class='hs-keyword'>else</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>c</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span>
<a name="line-93"></a>
<a name="line-94"></a><span class='hs-comment'>{- | Create a file log handler. Log messages sent to this handler
<a name="line-95"></a> will be sent to the filename specified, which will be opened
<a name="line-96"></a> in Append mode. Calling 'close' on the handler will close the file.
<a name="line-97"></a> -}</span>
<a name="line-98"></a>
<a name="line-99"></a><a name="fileHandler"></a><span class='hs-definition'>fileHandler</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>FilePath</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Priority</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>GenericHandler</span> <span class='hs-conid'>Handle</span><span class='hs-layout'>)</span>
<a name="line-100"></a><span class='hs-definition'>fileHandler</span> <span class='hs-varid'>fp</span> <span class='hs-varid'>pri</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-101"></a> <span class='hs-varid'>h</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>openFile</span> <span class='hs-varid'>fp</span> <span class='hs-conid'>AppendMode</span>
<a name="line-102"></a> <span class='hs-varid'>sh</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>streamHandler</span> <span class='hs-varid'>h</span> <span class='hs-varid'>pri</span>
<a name="line-103"></a> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-varid'>sh</span><span class='hs-layout'>{</span><span class='hs-varid'>closeFunc</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>hClose</span><span class='hs-layout'>}</span><span class='hs-layout'>)</span>
<a name="line-104"></a>
<a name="line-105"></a><a name="verboseStreamHandler"></a><span class='hs-comment'>{- | Like 'streamHandler', but note the priority and logger name along
<a name="line-106"></a>with each message. -}</span>
<a name="line-107"></a><span class='hs-definition'>verboseStreamHandler</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Handle</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Priority</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>GenericHandler</span> <span class='hs-conid'>Handle</span><span class='hs-layout'>)</span>
<a name="line-108"></a><span class='hs-definition'>verboseStreamHandler</span> <span class='hs-varid'>h</span> <span class='hs-varid'>pri</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>let</span> <span class='hs-varid'>fmt</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>simpleLogFormatter</span> <span class='hs-str'>"[$loggername/$prio] $msg"</span>
<a name="line-109"></a> <span class='hs-keyword'>in</span> <span class='hs-keyword'>do</span> <span class='hs-varid'>hndlr</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>streamHandler</span> <span class='hs-varid'>h</span> <span class='hs-varid'>pri</span>
<a name="line-110"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-varid'>setFormatter</span> <span class='hs-varid'>hndlr</span> <span class='hs-varid'>fmt</span>
</pre></body>
</html>
