<?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://code.haskell.org/~malcolm/hscolour/ -->
<title>System/Console/CmdArgs/Verbosity.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE DeriveDataTypeable #-}</span>
<a name="line-2"></a>
<a name="line-3"></a><span class='hs-comment'>-- | A module to deal with verbosity, how \'chatty\' a program should be.</span>
<a name="line-4"></a><span class='hs-comment'>-- This module defines the 'Verbosity' data type, along with functions</span>
<a name="line-5"></a><span class='hs-comment'>-- for manipulating a global verbosity value.</span>
<a name="line-6"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Console</span><span class='hs-varop'>.</span><span class='hs-conid'>CmdArgs</span><span class='hs-varop'>.</span><span class='hs-conid'>Verbosity</span><span class='hs-layout'>(</span>
<a name="line-7"></a> <span class='hs-conid'>Verbosity</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>setVerbosity</span><span class='hs-layout'>,</span> <span class='hs-varid'>getVerbosity</span><span class='hs-layout'>,</span>
<a name="line-8"></a> <span class='hs-varid'>isNormal</span><span class='hs-layout'>,</span> <span class='hs-varid'>isLoud</span><span class='hs-layout'>,</span>
<a name="line-9"></a> <span class='hs-varid'>whenNormal</span><span class='hs-layout'>,</span> <span class='hs-varid'>whenLoud</span>
<a name="line-10"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-11"></a>
<a name="line-12"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span>
<a name="line-13"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Data</span>
<a name="line-14"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>IORef</span>
<a name="line-15"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>IO</span><span class='hs-varop'>.</span><span class='hs-conid'>Unsafe</span>
<a name="line-16"></a>
<a name="line-17"></a>
<a name="line-18"></a><a name="Verbosity"></a><span class='hs-comment'>-- | The verbosity data type</span>
<a name="line-19"></a><a name="Verbosity"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>Verbosity</span>
<a name="line-20"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Quiet</span> <span class='hs-comment'>-- ^ Only output essential messages (typically errors)</span>
<a name="line-21"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Normal</span> <span class='hs-comment'>-- ^ Output normal messages (typically errors and warnings)</span>
<a name="line-22"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Loud</span> <span class='hs-comment'>-- ^ Output lots of messages (typically errors, warnings and status updates)</span>
<a name="line-23"></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'>Bounded</span><span class='hs-layout'>,</span><span class='hs-conid'>Enum</span><span class='hs-layout'>,</span><span class='hs-conid'>Show</span><span class='hs-layout'>,</span><span class='hs-conid'>Read</span><span class='hs-layout'>,</span><span class='hs-conid'>Data</span><span class='hs-layout'>,</span><span class='hs-conid'>Typeable</span><span class='hs-layout'>)</span>
<a name="line-24"></a>
<a name="line-25"></a>
<a name="line-26"></a><a name="ref"></a><span class='hs-comment'>{-# NOINLINE ref #-}</span>
<a name="line-27"></a><span class='hs-definition'>ref</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IORef</span> <span class='hs-conid'>Verbosity</span>
<a name="line-28"></a><span class='hs-definition'>ref</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>unsafePerformIO</span> <span class='hs-varop'>$</span> <span class='hs-varid'>newIORef</span> <span class='hs-conid'>Normal</span>
<a name="line-29"></a>
<a name="line-30"></a>
<a name="line-31"></a><a name="setVerbosity"></a><span class='hs-comment'>-- | Set the global verbosity.</span>
<a name="line-32"></a><span class='hs-definition'>setVerbosity</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Verbosity</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-33"></a><span class='hs-definition'>setVerbosity</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>writeIORef</span> <span class='hs-varid'>ref</span>
<a name="line-34"></a>
<a name="line-35"></a><a name="getVerbosity"></a><span class='hs-comment'>-- | Get the global verbosity. Initially @Normal@ before any calls to 'setVerbosity'.</span>
<a name="line-36"></a><span class='hs-definition'>getVerbosity</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Verbosity</span>
<a name="line-37"></a><span class='hs-definition'>getVerbosity</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>readIORef</span> <span class='hs-varid'>ref</span>
<a name="line-38"></a>
<a name="line-39"></a><a name="isNormal"></a><span class='hs-comment'>-- | Used to test if warnings should be output to the user.</span>
<a name="line-40"></a><span class='hs-comment'>-- @True@ if the verbosity is set to 'Normal' or 'Loud' (when @--quiet@ is /not/ specified).</span>
<a name="line-41"></a><span class='hs-definition'>isNormal</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Bool</span>
<a name="line-42"></a><span class='hs-definition'>isNormal</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fmap</span> <span class='hs-layout'>(</span><span class='hs-varop'>>=</span><span class='hs-conid'>Normal</span><span class='hs-layout'>)</span> <span class='hs-varid'>getVerbosity</span>
<a name="line-43"></a>
<a name="line-44"></a><a name="isLoud"></a><span class='hs-comment'>-- | Used to test if status updates should be output to the user.</span>
<a name="line-45"></a><span class='hs-comment'>-- @True@ if the verbosity is set to 'Loud' (when @--verbose@ is specified).</span>
<a name="line-46"></a><span class='hs-definition'>isLoud</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Bool</span>
<a name="line-47"></a><span class='hs-definition'>isLoud</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fmap</span> <span class='hs-layout'>(</span><span class='hs-varop'>>=</span><span class='hs-conid'>Loud</span><span class='hs-layout'>)</span> <span class='hs-varid'>getVerbosity</span>
<a name="line-48"></a>
<a name="line-49"></a>
<a name="line-50"></a><a name="whenNormal"></a><span class='hs-comment'>-- | An action to perform if the verbosity is normal or higher, based on 'isNormal'.</span>
<a name="line-51"></a><span class='hs-definition'>whenNormal</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-52"></a><span class='hs-definition'>whenNormal</span> <span class='hs-varid'>act</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-53"></a> <span class='hs-varid'>b</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>isNormal</span>
<a name="line-54"></a> <span class='hs-varid'>when</span> <span class='hs-varid'>b</span> <span class='hs-varid'>act</span>
<a name="line-55"></a>
<a name="line-56"></a><a name="whenLoud"></a><span class='hs-comment'>-- | An action to perform if the verbosity is loud, based on 'isLoud'.</span>
<a name="line-57"></a><span class='hs-definition'>whenLoud</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-58"></a><span class='hs-definition'>whenLoud</span> <span class='hs-varid'>act</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-59"></a> <span class='hs-varid'>b</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>isLoud</span>
<a name="line-60"></a> <span class='hs-varid'>when</span> <span class='hs-varid'>b</span> <span class='hs-varid'>act</span>
</pre></body>
</html>
distrib
>
Fedora
>
17
>
i386
>
media
>
updates
>
by-pkgid
>
a754cb499dfee5e1f453d3b6cc13d4c8
>
files
>
163
