/usr/share/doc/libghc-hspec-core-doc/html/src/Test-Hspec-Core-Hooks.html is in libghc-hspec-core-doc 2.2.4-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 | <?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/Test/Hspec/Core/Hooks.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>-- | Stability: provisional</span>
<a name="line-2"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Test</span><span class='hs-varop'>.</span><span class='hs-conid'>Hspec</span><span class='hs-varop'>.</span><span class='hs-conid'>Core</span><span class='hs-varop'>.</span><span class='hs-conid'>Hooks</span> <span class='hs-layout'>(</span>
<a name="line-3"></a> <span class='hs-varid'>before</span>
<a name="line-4"></a><span class='hs-layout'>,</span> <span class='hs-varid'>before_</span>
<a name="line-5"></a><span class='hs-layout'>,</span> <span class='hs-varid'>beforeWith</span>
<a name="line-6"></a><span class='hs-layout'>,</span> <span class='hs-varid'>beforeAll</span>
<a name="line-7"></a><span class='hs-layout'>,</span> <span class='hs-varid'>beforeAll_</span>
<a name="line-8"></a><span class='hs-layout'>,</span> <span class='hs-varid'>after</span>
<a name="line-9"></a><span class='hs-layout'>,</span> <span class='hs-varid'>after_</span>
<a name="line-10"></a><span class='hs-layout'>,</span> <span class='hs-varid'>afterAll</span>
<a name="line-11"></a><span class='hs-layout'>,</span> <span class='hs-varid'>afterAll_</span>
<a name="line-12"></a><span class='hs-layout'>,</span> <span class='hs-varid'>around</span>
<a name="line-13"></a><span class='hs-layout'>,</span> <span class='hs-varid'>around_</span>
<a name="line-14"></a><span class='hs-layout'>,</span> <span class='hs-varid'>aroundWith</span>
<a name="line-15"></a><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-16"></a>
<a name="line-17"></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-varid'>finally</span><span class='hs-layout'>)</span>
<a name="line-18"></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-19"></a>
<a name="line-20"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Test</span><span class='hs-varop'>.</span><span class='hs-conid'>Hspec</span><span class='hs-varop'>.</span><span class='hs-conid'>Core</span><span class='hs-varop'>.</span><span class='hs-conid'>Spec</span>
<a name="line-21"></a>
<a name="line-22"></a><a name="before"></a><span class='hs-comment'>-- | Run a custom action before every spec item.</span>
<a name="line-23"></a><span class='hs-definition'>before</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecWith</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Spec</span>
<a name="line-24"></a><span class='hs-definition'>before</span> <span class='hs-varid'>action</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>around</span> <span class='hs-layout'>(</span><span class='hs-varid'>action</span> <span class='hs-varop'>>>=</span><span class='hs-layout'>)</span>
<a name="line-25"></a>
<a name="line-26"></a><a name="before_"></a><span class='hs-comment'>-- | Run a custom action before every spec item.</span>
<a name="line-27"></a><span class='hs-definition'>before_</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'>SpecWith</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecWith</span> <span class='hs-varid'>a</span>
<a name="line-28"></a><span class='hs-definition'>before_</span> <span class='hs-varid'>action</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>around_</span> <span class='hs-layout'>(</span><span class='hs-varid'>action</span> <span class='hs-varop'>>></span><span class='hs-layout'>)</span>
<a name="line-29"></a>
<a name="line-30"></a><a name="beforeWith"></a><span class='hs-comment'>-- | Run a custom action before every spec item.</span>
<a name="line-31"></a><span class='hs-definition'>beforeWith</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-varid'>b</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecWith</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecWith</span> <span class='hs-varid'>b</span>
<a name="line-32"></a><span class='hs-definition'>beforeWith</span> <span class='hs-varid'>action</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>aroundWith</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>e</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>action</span> <span class='hs-varid'>x</span> <span class='hs-varop'>>>=</span> <span class='hs-varid'>e</span>
<a name="line-33"></a>
<a name="line-34"></a><a name="beforeAll"></a><span class='hs-comment'>-- | Run a custom action before the first spec item.</span>
<a name="line-35"></a><span class='hs-definition'>beforeAll</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecWith</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Spec</span>
<a name="line-36"></a><span class='hs-definition'>beforeAll</span> <span class='hs-varid'>action</span> <span class='hs-varid'>spec</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-37"></a> <span class='hs-varid'>mvar</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>runIO</span> <span class='hs-layout'>(</span><span class='hs-varid'>newMVar</span> <span class='hs-conid'>Nothing</span><span class='hs-layout'>)</span>
<a name="line-38"></a> <span class='hs-varid'>before</span> <span class='hs-layout'>(</span><span class='hs-varid'>memoize</span> <span class='hs-varid'>mvar</span> <span class='hs-varid'>action</span><span class='hs-layout'>)</span> <span class='hs-varid'>spec</span>
<a name="line-39"></a>
<a name="line-40"></a><a name="beforeAll_"></a><span class='hs-comment'>-- | Run a custom action before the first spec item.</span>
<a name="line-41"></a><span class='hs-definition'>beforeAll_</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'>SpecWith</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecWith</span> <span class='hs-varid'>a</span>
<a name="line-42"></a><span class='hs-definition'>beforeAll_</span> <span class='hs-varid'>action</span> <span class='hs-varid'>spec</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-43"></a> <span class='hs-varid'>mvar</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>runIO</span> <span class='hs-layout'>(</span><span class='hs-varid'>newMVar</span> <span class='hs-conid'>Nothing</span><span class='hs-layout'>)</span>
<a name="line-44"></a> <span class='hs-varid'>before_</span> <span class='hs-layout'>(</span><span class='hs-varid'>memoize</span> <span class='hs-varid'>mvar</span> <span class='hs-varid'>action</span><span class='hs-layout'>)</span> <span class='hs-varid'>spec</span>
<a name="line-45"></a>
<a name="line-46"></a><a name="memoize"></a><span class='hs-definition'>memoize</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>MVar</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span>
<a name="line-47"></a><span class='hs-definition'>memoize</span> <span class='hs-varid'>mvar</span> <span class='hs-varid'>action</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>modifyMVar</span> <span class='hs-varid'>mvar</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>ma</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>case</span> <span class='hs-varid'>ma</span> <span class='hs-keyword'>of</span>
<a name="line-48"></a> <span class='hs-conid'>Just</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-varid'>ma</span><span class='hs-layout'>,</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span>
<a name="line-49"></a> <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-50"></a> <span class='hs-varid'>a</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>action</span>
<a name="line-51"></a> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-conid'>Just</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span>
<a name="line-52"></a>
<a name="line-53"></a><a name="after"></a><span class='hs-comment'>-- | Run a custom action after every spec item.</span>
<a name="line-54"></a><span class='hs-definition'>after</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ActionWith</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecWith</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecWith</span> <span class='hs-varid'>a</span>
<a name="line-55"></a><span class='hs-definition'>after</span> <span class='hs-varid'>action</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>aroundWith</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>e</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>e</span> <span class='hs-varid'>x</span> <span class='hs-varop'>`finally`</span> <span class='hs-varid'>action</span> <span class='hs-varid'>x</span>
<a name="line-56"></a>
<a name="line-57"></a><a name="after_"></a><span class='hs-comment'>-- | Run a custom action after every spec item.</span>
<a name="line-58"></a><span class='hs-definition'>after_</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'>SpecWith</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecWith</span> <span class='hs-varid'>a</span>
<a name="line-59"></a><span class='hs-definition'>after_</span> <span class='hs-varid'>action</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>after</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>action</span>
<a name="line-60"></a>
<a name="line-61"></a><a name="around"></a><span class='hs-comment'>-- | Run a custom action before and/or after every spec item.</span>
<a name="line-62"></a><span class='hs-definition'>around</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>ActionWith</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> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecWith</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Spec</span>
<a name="line-63"></a><span class='hs-definition'>around</span> <span class='hs-varid'>action</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>aroundWith</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>e</span> <span class='hs-conid'>()</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>action</span> <span class='hs-varid'>e</span>
<a name="line-64"></a>
<a name="line-65"></a><a name="afterAll"></a><span class='hs-comment'>-- | Run a custom action after the last spec item.</span>
<a name="line-66"></a><span class='hs-definition'>afterAll</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ActionWith</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecWith</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecWith</span> <span class='hs-varid'>a</span>
<a name="line-67"></a><span class='hs-definition'>afterAll</span> <span class='hs-varid'>action</span> <span class='hs-varid'>spec</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>runIO</span> <span class='hs-layout'>(</span><span class='hs-varid'>runSpecM</span> <span class='hs-varid'>spec</span><span class='hs-layout'>)</span> <span class='hs-varop'>>>=</span> <span class='hs-varid'>fromSpecList</span> <span class='hs-varop'>.</span> <span class='hs-varid'>return</span> <span class='hs-varop'>.</span> <span class='hs-conid'>NodeWithCleanup</span> <span class='hs-varid'>action</span>
<a name="line-68"></a>
<a name="line-69"></a><a name="afterAll_"></a><span class='hs-comment'>-- | Run a custom action after the last spec item.</span>
<a name="line-70"></a><span class='hs-definition'>afterAll_</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'>SpecWith</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecWith</span> <span class='hs-varid'>a</span>
<a name="line-71"></a><span class='hs-definition'>afterAll_</span> <span class='hs-varid'>action</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>afterAll</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>action</span><span class='hs-layout'>)</span>
<a name="line-72"></a>
<a name="line-73"></a><a name="around_"></a><span class='hs-comment'>-- | Run a custom action before and/or after every spec item.</span>
<a name="line-74"></a><span class='hs-definition'>around_</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</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><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecWith</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecWith</span> <span class='hs-varid'>a</span>
<a name="line-75"></a><span class='hs-definition'>around_</span> <span class='hs-varid'>action</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>aroundWith</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>e</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>action</span> <span class='hs-layout'>(</span><span class='hs-varid'>e</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span>
<a name="line-76"></a>
<a name="line-77"></a><a name="aroundWith"></a><span class='hs-comment'>-- | Run a custom action before and/or after every spec item.</span>
<a name="line-78"></a><span class='hs-definition'>aroundWith</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>ActionWith</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ActionWith</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecWith</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecWith</span> <span class='hs-varid'>b</span>
<a name="line-79"></a><span class='hs-definition'>aroundWith</span> <span class='hs-varid'>action</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mapAround</span> <span class='hs-layout'>(</span><span class='hs-varop'>.</span> <span class='hs-varid'>action</span><span class='hs-layout'>)</span>
<a name="line-80"></a>
<a name="line-81"></a><a name="mapAround"></a><span class='hs-definition'>mapAround</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>ActionWith</span> <span class='hs-varid'>b</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ActionWith</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> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecWith</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecWith</span> <span class='hs-varid'>b</span>
<a name="line-82"></a><span class='hs-definition'>mapAround</span> <span class='hs-varid'>f</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mapSpecItem</span> <span class='hs-layout'>(</span><span class='hs-varid'>untangle</span> <span class='hs-varid'>f</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>i</span><span class='hs-keyglyph'>@</span><span class='hs-conid'>Item</span><span class='hs-layout'>{</span><span class='hs-varid'>itemExample</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>e</span><span class='hs-layout'>}</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>i</span><span class='hs-layout'>{</span><span class='hs-varid'>itemExample</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varop'>.</span> <span class='hs-varid'>f</span><span class='hs-layout'>)</span> <span class='hs-varop'>.</span> <span class='hs-varid'>e</span><span class='hs-layout'>}</span>
<a name="line-83"></a>
<a name="line-84"></a><a name="untangle"></a><span class='hs-definition'>untangle</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>ActionWith</span> <span class='hs-varid'>b</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ActionWith</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> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ActionWith</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ActionWith</span> <span class='hs-varid'>b</span>
<a name="line-85"></a><span class='hs-definition'>untangle</span> <span class='hs-varid'>f</span> <span class='hs-varid'>g</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>b</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>f</span> <span class='hs-layout'>(</span><span class='hs-varop'>$</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-varid'>g</span>
</pre></body>
</html>
|