<?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>src/Darcs/MonadProgress.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE TypeSynonymInstances #-}</span>
<a name="line-2"></a><span class='hs-comment'>-- Copyright (C) 2011 Ganesh Sittampalam</span>
<a name="line-3"></a><span class='hs-comment'>--</span>
<a name="line-4"></a><span class='hs-comment'>-- Permission is hereby granted, free of charge, to any person</span>
<a name="line-5"></a><span class='hs-comment'>-- obtaining a copy of this software and associated documentation</span>
<a name="line-6"></a><span class='hs-comment'>-- files (the "Software"), to deal in the Software without</span>
<a name="line-7"></a><span class='hs-comment'>-- restriction, including without limitation the rights to use, copy,</span>
<a name="line-8"></a><span class='hs-comment'>-- modify, merge, publish, distribute, sublicense, and/or sell copies</span>
<a name="line-9"></a><span class='hs-comment'>-- of the Software, and to permit persons to whom the Software is</span>
<a name="line-10"></a><span class='hs-comment'>-- furnished to do so, subject to the following conditions:</span>
<a name="line-11"></a><span class='hs-comment'>--</span>
<a name="line-12"></a><span class='hs-comment'>-- The above copyright notice and this permission notice shall be</span>
<a name="line-13"></a><span class='hs-comment'>-- included in all copies or substantial portions of the Software.</span>
<a name="line-14"></a><span class='hs-comment'>--</span>
<a name="line-15"></a><span class='hs-comment'>-- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span>
<a name="line-16"></a><span class='hs-comment'>-- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
<a name="line-17"></a><span class='hs-comment'>-- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span>
<a name="line-18"></a><span class='hs-comment'>-- NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS</span>
<a name="line-19"></a><span class='hs-comment'>-- BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN</span>
<a name="line-20"></a><span class='hs-comment'>-- ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN</span>
<a name="line-21"></a><span class='hs-comment'>-- CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span>
<a name="line-22"></a><span class='hs-comment'>-- SOFTWARE.</span>
<a name="line-23"></a>
<a name="line-24"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Darcs</span><span class='hs-varop'>.</span><span class='hs-conid'>MonadProgress</span> <span class='hs-layout'>(</span> <span class='hs-conid'>MonadProgress</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'>ProgressAction</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-25"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>silentlyRunProgressActions</span> <span class='hs-layout'>)</span>
<a name="line-26"></a> <span class='hs-keyword'>where</span>
<a name="line-27"></a>
<a name="line-28"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Progress</span> <span class='hs-layout'>(</span> <span class='hs-varid'>beginTedious</span><span class='hs-layout'>,</span> <span class='hs-varid'>endTedious</span><span class='hs-layout'>,</span> <span class='hs-varid'>tediousSize</span><span class='hs-layout'>,</span> <span class='hs-varid'>finishedOneIO</span> <span class='hs-layout'>)</span>
<a name="line-29"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Printer</span> <span class='hs-layout'>(</span> <span class='hs-varid'>hPutDocLn</span><span class='hs-layout'>,</span> <span class='hs-conid'>Doc</span> <span class='hs-layout'>)</span>
<a name="line-30"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Darcs</span><span class='hs-varop'>.</span><span class='hs-conid'>ColorPrinter</span> <span class='hs-conid'>()</span> <span class='hs-comment'>-- for instance Show Doc</span>
<a name="line-31"></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-layout'>(</span> <span class='hs-varid'>stderr</span> <span class='hs-layout'>)</span>
<a name="line-32"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Storage</span><span class='hs-varop'>.</span><span class='hs-conid'>Hashed</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>HSM</span>
<a name="line-33"></a>
<a name="line-34"></a><a name="ProgressAction"></a><span class='hs-comment'>-- |a monadic action, annotated with a progress message that could be printed out</span>
<a name="line-35"></a><a name="ProgressAction"></a><span class='hs-comment'>-- while running the action, and a message that could be printed out on error.</span>
<a name="line-36"></a><a name="ProgressAction"></a><span class='hs-comment'>-- Actually printing out these messages is optional to allow non-IO monads to</span>
<a name="line-37"></a><a name="ProgressAction"></a><span class='hs-comment'>-- just run the action.</span>
<a name="line-38"></a><a name="ProgressAction"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>ProgressAction</span> <span class='hs-varid'>m</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=</span>
<a name="line-39"></a> <span class='hs-conid'>ProgressAction</span>
<a name="line-40"></a> <span class='hs-layout'>{</span><span class='hs-varid'>paAction</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>m</span> <span class='hs-varid'>a</span>
<a name="line-41"></a> <span class='hs-layout'>,</span><span class='hs-varid'>paMessage</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Doc</span>
<a name="line-42"></a> <span class='hs-layout'>,</span><span class='hs-varid'>paOnError</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Doc</span>
<a name="line-43"></a> <span class='hs-layout'>}</span>
<a name="line-44"></a>
<a name="line-45"></a><a name="MonadProgress"></a><span class='hs-keyword'>class</span> <span class='hs-conid'>Monad</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>MonadProgress</span> <span class='hs-varid'>m</span> <span class='hs-keyword'>where</span>
<a name="line-46"></a> <span class='hs-comment'>-- |run a list of 'ProgressAction's. In some monads (typically IO-based ones),</span>
<a name="line-47"></a> <span class='hs-comment'>-- the progress and error messages will be used. In others they will be</span>
<a name="line-48"></a> <span class='hs-comment'>-- ignored and just the actions will be run.</span>
<a name="line-49"></a> <span class='hs-varid'>runProgressActions</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>ProgressAction</span> <span class='hs-varid'>m</span> <span class='hs-conid'>()</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-conid'>()</span>
<a name="line-50"></a>
<a name="line-51"></a><a name="instance%20MonadProgress%20IO"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>MonadProgress</span> <span class='hs-conid'>IO</span> <span class='hs-keyword'>where</span>
<a name="line-52"></a> <span class='hs-varid'>runProgressActions</span> <span class='hs-keyword'>_</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-conid'>()</span>
<a name="line-53"></a> <span class='hs-varid'>runProgressActions</span> <span class='hs-varid'>what</span> <span class='hs-varid'>items</span> <span class='hs-keyglyph'>=</span>
<a name="line-54"></a> <span class='hs-keyword'>do</span> <span class='hs-varid'>beginTedious</span> <span class='hs-varid'>what</span>
<a name="line-55"></a> <span class='hs-varid'>tediousSize</span> <span class='hs-varid'>what</span> <span class='hs-layout'>(</span><span class='hs-varid'>length</span> <span class='hs-varid'>items</span><span class='hs-layout'>)</span>
<a name="line-56"></a> <span class='hs-varid'>mapM_</span> <span class='hs-varid'>go</span> <span class='hs-varid'>items</span>
<a name="line-57"></a> <span class='hs-varid'>endTedious</span> <span class='hs-varid'>what</span>
<a name="line-58"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>go</span> <span class='hs-varid'>item</span> <span class='hs-keyglyph'>=</span>
<a name="line-59"></a> <span class='hs-keyword'>do</span> <span class='hs-varid'>finishedOneIO</span> <span class='hs-varid'>what</span> <span class='hs-layout'>(</span><span class='hs-varid'>show</span> <span class='hs-varop'>$</span> <span class='hs-varid'>paMessage</span> <span class='hs-varid'>item</span><span class='hs-layout'>)</span>
<a name="line-60"></a> <span class='hs-varid'>paAction</span> <span class='hs-varid'>item</span> <span class='hs-varop'>`catch`</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>e</span> <span class='hs-keyglyph'>-></span>
<a name="line-61"></a> <span class='hs-keyword'>do</span> <span class='hs-varid'>hPutDocLn</span> <span class='hs-varid'>stderr</span> <span class='hs-varop'>$</span> <span class='hs-varid'>paOnError</span> <span class='hs-varid'>item</span>
<a name="line-62"></a> <span class='hs-varid'>ioError</span> <span class='hs-varid'>e</span>
<a name="line-63"></a>
<a name="line-64"></a><a name="silentlyRunProgressActions"></a><span class='hs-comment'>-- |run a list of 'ProgressAction's without any feedback messages</span>
<a name="line-65"></a><span class='hs-definition'>silentlyRunProgressActions</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Monad</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>ProgressAction</span> <span class='hs-varid'>m</span> <span class='hs-conid'>()</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-conid'>()</span>
<a name="line-66"></a><span class='hs-definition'>silentlyRunProgressActions</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mapM_</span> <span class='hs-varid'>paAction</span>
<a name="line-67"></a>
<a name="line-68"></a><a name="instance%20MonadProgress%20(HSM.TreeMonad%20m)"></a><span class='hs-keyword'>instance</span> <span class='hs-layout'>(</span><span class='hs-conid'>Functor</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>Monad</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>MonadProgress</span> <span class='hs-layout'>(</span><span class='hs-conid'>HSM</span><span class='hs-varop'>.</span><span class='hs-conid'>TreeMonad</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-69"></a> <span class='hs-varid'>runProgressActions</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>silentlyRunProgressActions</span>
</pre></body>
</html>
